fishsound.h

Go to the documentation of this file.
00001 /*
00002    Copyright (C) 2003 Commonwealth Scientific and Industrial Research
00003    Organisation (CSIRO) Australia
00004 
00005    Redistribution and use in source and binary forms, with or without
00006    modification, are permitted provided that the following conditions
00007    are met:
00008 
00009    - Redistributions of source code must retain the above copyright
00010    notice, this list of conditions and the following disclaimer.
00011 
00012    - Redistributions in binary form must reproduce the above copyright
00013    notice, this list of conditions and the following disclaimer in the
00014    documentation and/or other materials provided with the distribution.
00015 
00016    - Neither the name of CSIRO Australia nor the names of its
00017    contributors may be used to endorse or promote products derived from
00018    this software without specific prior written permission.
00019 
00020    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00023    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
00024    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00026    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 */
00032 
00033 #ifndef __FISH_SOUND_H__
00034 #define __FISH_SOUND_H__
00035 
00036 #include <fishsound/constants.h>
00037 
00385 typedef struct {
00387   int samplerate;
00388 
00390   int channels;
00391 
00393   int format;
00394 } FishSoundInfo;
00395 
00399 typedef struct {
00401   int format;
00402 
00404   const char * name;     
00405 
00407   const char * extension;
00408 } FishSoundFormat;
00409 
00414 typedef void * FishSound;
00415 
00416 #ifdef __cplusplus
00417 extern "C" {
00418 #endif
00419 
00436 int
00437 fish_sound_identify (unsigned char * buf, long bytes);
00438 
00445 FishSound * fish_sound_new (int mode, FishSoundInfo * fsinfo);
00446 
00452 long fish_sound_flush (FishSound * fsound);
00453 
00463 int fish_sound_reset (FishSound * fsound);
00464 
00470 int fish_sound_delete (FishSound * fsound);
00471 
00480 int fish_sound_command (FishSound * fsound, int command, void * data,
00481                         int datasize);
00482 
00490 int fish_sound_get_interleave (FishSound * fsound);
00491 
00509 long fish_sound_get_frameno (FishSound * fsound);
00510 
00524 int fish_sound_set_frameno (FishSound * fsound, long frameno);
00525 
00556 int fish_sound_prepare_truncation (FishSound * fsound, long next_granulepos,
00557                                    int next_eos);
00558 
00559 #ifdef __cplusplus
00560 }
00561 #endif
00562 
00563 #include <fishsound/decode.h>
00564 #include <fishsound/encode.h>
00565 #include <fishsound/comments.h>
00566 
00567 #include <fishsound/deprecated.h>
00568 
00569 #endif /* __FISH_SOUND_H__ */

Generated on Sun Jun 3 21:27:50 2007 for libfishsound by  doxygen 1.5.1