libfishsound: fishsound.h Source File

- Main Page
- Modules
- Data Structures
- Files

- File List
- 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
    00404 typedef struct {
    00406   int samplerate;
    00407
    00409   int channels;
    00410
    00412   int format;
    00413 } FishSoundInfo;
    00414
    00418 typedef struct {
    00420   int format;
    00421
    00423   const char * name;
    00424
    00426   const char * extension;
    00427 } FishSoundFormat;
    00428
    00433 typedef void * FishSound;
    00434
    00435 #ifdef __cplusplus
    00436 extern "C" {
    00437 #endif
    00438
    00456 int
    00457 fish_sound_identify (unsigned char * buf, long bytes);
    00458
    00465 FishSound * fish_sound_new (int mode, FishSoundInfo * fsinfo);
    00466
    00472 long fish_sound_flush (FishSound * fsound);
    00473
    00483 int fish_sound_reset (FishSound * fsound);
    00484
    00490 int fish_sound_delete (FishSound * fsound);
    00491
    00500 int fish_sound_command (FishSound * fsound, int command, void * data,
    00501                         int datasize);
    00502
    00510 int fish_sound_get_interleave (FishSound * fsound);
    00511
    00529 long fish_sound_get_frameno (FishSound * fsound);
    00530
    00544 int fish_sound_set_frameno (FishSound * fsound, long frameno);
    00545
    00576 int fish_sound_prepare_truncation (FishSound * fsound, long next_granulepos,
    00577                                    int next_eos);
    00578
    00579 #ifdef __cplusplus
    00580 }
    00581 #endif
    00582
    00583 #include <fishsound/decode.h>
    00584 #include <fishsound/encode.h>
    00585 #include <fishsound/comments.h>
    00586
    00587 #include <fishsound/deprecated.h>
    00588
    00589 #endif /* __FISH_SOUND_H__ */