libfishsound: constants.h Source File

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

# constants.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_CONSTANTS_H__
    00034 #define __FISH_SOUND_CONSTANTS_H__
    00035
    00041 typedef enum _FishSoundMode {
    00043   FISH_SOUND_DECODE = 0x10,
    00044
    00046   FISH_SOUND_ENCODE = 0x20
    00047 } FishSoundMode;
    00048
    00050 typedef enum _FishSoundCodecID {
    00052   FISH_SOUND_UNKNOWN = 0x00,
    00053
    00055   FISH_SOUND_VORBIS  = 0x01,
    00056
    00058   FISH_SOUND_SPEEX   = 0x02,
    00059
    00061   FISH_SOUND_FLAC    = 0x03
    00062 } FishSoundCodecID;
    00063
    00065 typedef enum _FishSoundStopCtl {
    00067   FISH_SOUND_CONTINUE = 0,
    00068
    00070   FISH_SOUND_STOP_OK  = 1,
    00071
    00073   FISH_SOUND_STOP_ERR = -1
    00074 } FishSoundStopCtl;
    00075
    00077 typedef enum _FishSoundCommand {
    00079   FISH_SOUND_COMMAND_NOP                = 0x0000,
    00080
    00082   FISH_SOUND_GET_INFO                   = 0x1000,
    00083
    00085   FISH_SOUND_GET_INTERLEAVE             = 0x2000,
    00086
    00088   FISH_SOUND_SET_INTERLEAVE             = 0x2001,
    00089
    00090   FISH_SOUND_SET_ENCODE_VBR             = 0x4000,
    00091
    00092   FISH_SOUND_COMMAND_MAX
    00093 } FishSoundCommand;
    00094
    00096 typedef enum _FishSoundError {
    00098   FISH_SOUND_OK                         = 0,
    00099
    00101   FISH_SOUND_ERR_GENERIC                = -1,
    00102
    00104   FISH_SOUND_ERR_BAD                    = -2,
    00105
    00107   FISH_SOUND_ERR_INVALID                = -3,
    00108
    00110   FISH_SOUND_ERR_OUT_OF_MEMORY          = -4,
    00111
    00113   FISH_SOUND_ERR_DISABLED               = -10,
    00114
    00116   FISH_SOUND_ERR_SHORT_IDENTIFY         = -20,
    00117
    00119   FISH_SOUND_ERR_COMMENT_INVALID        = -21
    00120 } FishSoundError;
    00121
    00122 #endif /* __FISH_SOUND_CONSTANTS_H__ */