constants.h
Go to the documentation of this file.
/*
Copyright (C) 2003 Commonwealth Scientific and Industrial Research
Organisation (CSIRO) Australia
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
- Neither the name of CSIRO Australia nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef __FISH_SOUND_CONSTANTS_H__
#define __FISH_SOUND_CONSTANTS_H__
typedef enum _FishSoundMode {
FISH_SOUND_DECODE = 0x10,
FISH_SOUND_ENCODE = 0x20
} FishSoundMode;
typedef enum _FishSoundCodecID {
FISH_SOUND_UNKNOWN = 0x00,
FISH_SOUND_VORBIS = 0x01,
FISH_SOUND_SPEEX = 0x02,
FISH_SOUND_FLAC = 0x03
} FishSoundCodecID;
typedef enum _FishSoundStopCtl {
FISH_SOUND_CONTINUE = 0,
FISH_SOUND_STOP_OK = 1,
FISH_SOUND_STOP_ERR = -1
} FishSoundStopCtl;
typedef enum _FishSoundCommand {
FISH_SOUND_COMMAND_NOP = 0x0000,
FISH_SOUND_GET_INFO = 0x1000,
FISH_SOUND_GET_INTERLEAVE = 0x2000,
FISH_SOUND_SET_INTERLEAVE = 0x2001,
FISH_SOUND_SET_ENCODE_VBR = 0x4000,
FISH_SOUND_COMMAND_MAX
} FishSoundCommand;
typedef enum _FishSoundError {
FISH_SOUND_OK = 0,
FISH_SOUND_ERR_GENERIC = -1,
FISH_SOUND_ERR_BAD = -2,
FISH_SOUND_ERR_INVALID = -3,
FISH_SOUND_ERR_OUT_OF_MEMORY = -4,
FISH_SOUND_ERR_DISABLED = -10,
FISH_SOUND_ERR_SHORT_IDENTIFY = -20,
FISH_SOUND_ERR_COMMENT_INVALID = -21
} FishSoundError;
#endif /* __FISH_SOUND_CONSTANTS_H__ */
FishSoundCommand
enum _FishSoundCommand FishSoundCommand
Command codes.
FishSoundError
enum _FishSoundError FishSoundError
Error values.
_FishSoundCommand
_FishSoundCommand
Command codes.
Definition constants.h:77
FISH_SOUND_GET_INTERLEAVE
@ FISH_SOUND_GET_INTERLEAVE
Query if multichannel audio should be interpreted as interleaved.
Definition constants.h:85
FISH_SOUND_COMMAND_NOP
@ FISH_SOUND_COMMAND_NOP
No operation.
Definition constants.h:79
FISH_SOUND_GET_INFO
@ FISH_SOUND_GET_INFO
Retrieve the FishSoundInfo.
Definition constants.h:82
FISH_SOUND_SET_INTERLEAVE
@ FISH_SOUND_SET_INTERLEAVE
Set to 1 to interleave, 0 to non-interleave.
Definition constants.h:88
_FishSoundStopCtl
_FishSoundStopCtl
Decode callback return values.
Definition constants.h:65
FISH_SOUND_CONTINUE
@ FISH_SOUND_CONTINUE
Continue calling decode callbacks.
Definition constants.h:67
FISH_SOUND_STOP_ERR
@ FISH_SOUND_STOP_ERR
Stop calling callbacks, and purge buffered data.
Definition constants.h:73
FISH_SOUND_STOP_OK
@ FISH_SOUND_STOP_OK
Stop calling callbacks, but retain buffered data.
Definition constants.h:70
_FishSoundError
_FishSoundError
Error values.
Definition constants.h:96
FISH_SOUND_ERR_SHORT_IDENTIFY
@ FISH_SOUND_ERR_SHORT_IDENTIFY
Too few bytes passed to fish_sound_identify()
Definition constants.h:116
FISH_SOUND_ERR_OUT_OF_MEMORY
@ FISH_SOUND_ERR_OUT_OF_MEMORY
Out of memory.
Definition constants.h:110
FISH_SOUND_ERR_COMMENT_INVALID
@ FISH_SOUND_ERR_COMMENT_INVALID
Comment violates VorbisComment restrictions.
Definition constants.h:119
FISH_SOUND_OK
@ FISH_SOUND_OK
No error.
Definition constants.h:98
FISH_SOUND_ERR_DISABLED
@ FISH_SOUND_ERR_DISABLED
Functionality disabled at build time.
Definition constants.h:113
FISH_SOUND_ERR_BAD
@ FISH_SOUND_ERR_BAD
Not a valid FishSound* handle.
Definition constants.h:104
FISH_SOUND_ERR_GENERIC
@ FISH_SOUND_ERR_GENERIC
generic error
Definition constants.h:101
FISH_SOUND_ERR_INVALID
@ FISH_SOUND_ERR_INVALID
The requested operation is not suitable for this FishSound* handle.
Definition constants.h:107
FishSoundMode
enum _FishSoundMode FishSoundMode
Mode of operation (encode or decode)
_FishSoundMode
_FishSoundMode
Mode of operation (encode or decode)
Definition constants.h:41
FISH_SOUND_ENCODE
@ FISH_SOUND_ENCODE
Encode.
Definition constants.h:46
FISH_SOUND_DECODE
@ FISH_SOUND_DECODE
Decode.
Definition constants.h:43
FishSoundCodecID
enum _FishSoundCodecID FishSoundCodecID
Identifiers for supported codecs.
FishSoundStopCtl
enum _FishSoundStopCtl FishSoundStopCtl
Decode callback return values.
_FishSoundCodecID
_FishSoundCodecID
Identifiers for supported codecs.
Definition constants.h:50
FISH_SOUND_UNKNOWN
@ FISH_SOUND_UNKNOWN
Unknown.
Definition constants.h:52
FISH_SOUND_VORBIS
@ FISH_SOUND_VORBIS
Vorbis.
Definition constants.h:55
FISH_SOUND_FLAC
@ FISH_SOUND_FLAC
Flac.
Definition constants.h:61
FISH_SOUND_SPEEX
@ FISH_SOUND_SPEEX
Speex.
Definition constants.h:58