libfishsound  1.0.0
fishsound.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 Commonwealth Scientific and Industrial Research
3  Organisation (CSIRO) Australia
4 
5  Redistribution and use in source and binary forms, with or without
6  modification, are permitted provided that the following conditions
7  are met:
8 
9  - Redistributions of source code must retain the above copyright
10  notice, this list of conditions and the following disclaimer.
11 
12  - Redistributions in binary form must reproduce the above copyright
13  notice, this list of conditions and the following disclaimer in the
14  documentation and/or other materials provided with the distribution.
15 
16  - Neither the name of CSIRO Australia nor the names of its
17  contributors may be used to endorse or promote products derived from
18  this software without specific prior written permission.
19 
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23  PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR
24  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32 
33 #ifndef __FISH_SOUND_H__
34 #define __FISH_SOUND_H__
35 
36 #include <fishsound/constants.h>
37 
404 typedef struct {
407 
409  int channels;
410 
412  int format;
413 } FishSoundInfo;
414 
418 typedef struct {
420  int format;
421 
423  const char * name;
424 
426  const char * extension;
428 
433 typedef void * FishSound;
434 
435 #ifdef __cplusplus
436 extern "C" {
437 #endif
438 
456 int
457 fish_sound_identify (unsigned char * buf, long bytes);
458 
465 FishSound * fish_sound_new (int mode, FishSoundInfo * fsinfo);
466 
472 long fish_sound_flush (FishSound * fsound);
473 
484 
491 
500 int fish_sound_command (FishSound * fsound, int command, void * data,
501  int datasize);
502 
511 
530 
544 int fish_sound_set_frameno (FishSound * fsound, long frameno);
545 
576 int fish_sound_prepare_truncation (FishSound * fsound, long next_granulepos,
577  int next_eos);
578 
579 #ifdef __cplusplus
580 }
581 #endif
582 
583 #include <fishsound/decode.h>
584 #include <fishsound/encode.h>
585 #include <fishsound/comments.h>
586 
587 #include <fishsound/deprecated.h>
588 
589 #endif /* __FISH_SOUND_H__ */
FishSound
void * FishSound
An opaque handle to a FishSound.
Definition: fishsound.h:433
FISH_SOUND_FLAC
@ FISH_SOUND_FLAC
Flac.
Definition: constants.h:61
FISH_SOUND_UNKNOWN
@ FISH_SOUND_UNKNOWN
Unknown.
Definition: constants.h:52
fish_sound_command
int fish_sound_command(FishSound *fsound, int command, void *data, int datasize)
Command interface.
encode.h
FISH_SOUND_VORBIS
@ FISH_SOUND_VORBIS
Vorbis.
Definition: constants.h:55
FISH_SOUND_ENCODE
@ FISH_SOUND_ENCODE
Encode.
Definition: constants.h:46
FISH_SOUND_GET_INFO
@ FISH_SOUND_GET_INFO
Retrieve the FishSoundInfo.
Definition: constants.h:82
fish_sound_comment_next
const FishSoundComment * fish_sound_comment_next(FishSound *fsound, const FishSoundComment *comment)
Retrieve the next comment.
FishSoundInfo
Info about a particular encoder/decoder instance.
Definition: fishsound.h:404
fish_sound_encode
long fish_sound_encode(FishSound *fsound, float **pcm, long frames)
DEPRECATED FUNCTION.
decode.h
fish_sound_set_encoded_callback
int fish_sound_set_encoded_callback(FishSound *fsound, FishSoundEncoded encoded, void *user_data)
Set the callback for libfishsound to call when it has a block of encoded data ready.
FishSoundFormat
Info about a particular sound format.
Definition: fishsound.h:418
FishSoundFormat::name
const char * name
Printable name.
Definition: fishsound.h:423
fish_sound_comment_get_vendor
const char * fish_sound_comment_get_vendor(FishSound *fsound)
Retrieve the vendor string.
fish_sound_comment_first
const FishSoundComment * fish_sound_comment_first(FishSound *fsound)
Retrieve the first comment.
FishSoundFormat::extension
const char * extension
Commonly used file extension.
Definition: fishsound.h:426
fish_sound_reset
int fish_sound_reset(FishSound *fsound)
Reset the codec state of a FishSound object.
fish_sound_set_interleave
int fish_sound_set_interleave(FishSound *fsound, int interleave)
DEPRECATED FUNCTION.
FishSoundInfo::channels
int channels
Count of channels.
Definition: fishsound.h:409
FishSoundFormat::format
int format
FISH_SOUND_VORBIS, FISH_SOUND_SPEEX, FISH_SOUND_FLAC etc.
Definition: fishsound.h:420
FS_EncDec
Definition: fishsound-encdec.c:42
FishSoundComment::name
char * name
The name of the comment, eg.
Definition: comments.h:94
fish_sound_prepare_truncation
int fish_sound_prepare_truncation(FishSound *fsound, long next_granulepos, int next_eos)
Prepare truncation details for the next block of data.
fish_sound_flush
long fish_sound_flush(FishSound *fsound)
Flush any internally buffered data, forcing encode.
FishSoundComment::value
char * value
The value of the comment, as UTF-8.
Definition: comments.h:97
fish_sound_new
FishSound * fish_sound_new(int mode, FishSoundInfo *fsinfo)
Instantiate a new FishSound* handle.
FISH_SOUND_SPEEX
@ FISH_SOUND_SPEEX
Speex.
Definition: constants.h:58
deprecated.h
fish_sound_set_frameno
int fish_sound_set_frameno(FishSound *fsound, long frameno)
Set the current frame number of a FishSound object.
fish_sound_delete
int fish_sound_delete(FishSound *fsound)
Delete a FishSound object.
constants.h
FishSoundInfo::samplerate
int samplerate
Sample rate of audio data in Hz.
Definition: fishsound.h:406
FishSoundInfo::format
int format
FISH_SOUND_VORBIS, FISH_SOUND_SPEEX, FISH_SOUND_FLAC etc.
Definition: fishsound.h:412
FishSoundComment
A comment.
Definition: comments.h:92
fish_sound_decode
long fish_sound_decode(FishSound *fsound, unsigned char *buf, long bytes)
Decode a block of compressed data.
fishsound.h
fish_sound_set_decoded_float_ilv
int fish_sound_set_decoded_float_ilv(FishSound *fsound, FishSoundDecoded_FloatIlv decoded, void *user_data)
Set the callback for libfishsound to call when it has a block of decoded PCM audio ready,...
fish_sound_comment_add_byname
int fish_sound_comment_add_byname(FishSound *fsound, const char *name, const char *value)
Add a comment by name and value.
FISH_SOUND_DECODE
@ FISH_SOUND_DECODE
Decode.
Definition: constants.h:43
FS_DecEnc
Definition: fishsound-decenc.c:42
fish_sound_get_frameno
long fish_sound_get_frameno(FishSound *fsound)
Query the current frame number of a FishSound object.
fish_sound_get_interleave
int fish_sound_get_interleave(FishSound *fsound)
Query whether a FishSound object is using interleaved PCM.
fish_sound_identify
int fish_sound_identify(unsigned char *buf, long bytes)
Identify a codec based on the first few bytes of data.
comments.h