Main Page | Modules | Data Structures | File List | Data Fields | Globals

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 
00384 typedef struct {
00386   int samplerate;
00387 
00389   int channels;
00390 
00392   int format;
00393 } FishSoundInfo;
00394 
00398 typedef struct {
00400   int format;
00401 
00403   const char * name;     
00404 
00406   const char * extension;
00407 } FishSoundFormat;
00408 
00413 typedef void * FishSound;
00414 
00426 typedef int (*FishSoundDecoded) (FishSound * fsound, float ** pcm,
00427                                  long frames, void * user_data);
00428 
00440 typedef int (*FishSoundEncoded) (FishSound * fsound, unsigned char * buf,
00441                                  long bytes, void * user_data);
00442 
00459 int
00460 fish_sound_identify (unsigned char * buf, long bytes);
00461 
00468 FishSound * fish_sound_new (int mode, FishSoundInfo * fsinfo);
00469 
00478 int fish_sound_set_decoded_callback (FishSound * fsound,
00479                                      FishSoundDecoded decoded,
00480                                      void * user_data);
00481 
00490 int fish_sound_set_encoded_callback (FishSound * fsound,
00491                                      FishSoundEncoded encoded,
00492                                      void * user_data);
00493 
00501 long fish_sound_decode (FishSound * fsound, unsigned char * buf, long bytes);
00502 
00512 long fish_sound_encode (FishSound * fsound, float ** pcm, long frames);
00513 
00519 long fish_sound_flush (FishSound * fsound);
00520 
00526 int fish_sound_reset (FishSound * fsound);
00527 
00533 int fish_sound_delete (FishSound * fsound);
00534 
00543 int fish_sound_command (FishSound * fsound, int command, void * data,
00544                         int datasize);
00545 
00553 int fish_sound_get_interleave (FishSound * fsound);
00554 
00564 int fish_sound_set_interleave (FishSound * fsound, int interleave);
00565 
00566 #endif /* __FISH_SOUND_H__ */

Generated on Wed Mar 24 19:38:27 2004 for libfishsound by doxygen 1.3.6-20040222