libfishsound 1.0.1
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_INCLUDED
34#define FISH_SOUND_H_INCLUDED
35
36#include <fishsound/constants.h>
37
404typedef struct {
407
410
414
418typedef struct {
421
423 const char * name;
424
426 const char * extension;
428
433typedef void * FishSound;
434
435#ifdef __cplusplus
436extern "C" {
437#endif
438
456int
457fish_sound_identify (unsigned char * buf, long bytes);
458
466
473
484
491
500int fish_sound_command (FishSound * fsound, int command, void * data,
501 int datasize);
502
511
530
544int fish_sound_set_frameno (FishSound * fsound, long frameno);
545
576int 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_INCLUDED */
Encoding and decoding of comments.
Constants used by libfishsound.
Decode functions and callback prototypes.
Deprecated interfaces.
Encode functions and callback prototypes.
int fish_sound_delete(FishSound *fsound)
Delete a FishSound object.
int fish_sound_set_frameno(FishSound *fsound, long frameno)
Set the current frame number of a FishSound object.
int fish_sound_identify(unsigned char *buf, long bytes)
Identify a codec based on the first few bytes of data.
int fish_sound_command(FishSound *fsound, int command, void *data, int datasize)
Command interface.
FishSound * fish_sound_new(int mode, FishSoundInfo *fsinfo)
Instantiate a new FishSound* handle.
int fish_sound_reset(FishSound *fsound)
Reset the codec state of a FishSound object.
int fish_sound_prepare_truncation(FishSound *fsound, long next_granulepos, int next_eos)
Prepare truncation details for the next block of data.
int fish_sound_get_interleave(FishSound *fsound)
Query whether a FishSound object is using interleaved PCM.
void * FishSound
An opaque handle to a FishSound.
Definition: fishsound.h:433
long fish_sound_flush(FishSound *fsound)
Flush any internally buffered data, forcing encode.
long fish_sound_get_frameno(FishSound *fsound)
Query the current frame number of a FishSound object.
Info about a particular sound format.
Definition: fishsound.h:418
const char * name
Printable name.
Definition: fishsound.h:423
int format
FISH_SOUND_VORBIS, FISH_SOUND_SPEEX, FISH_SOUND_FLAC etc.
Definition: fishsound.h:420
const char * extension
Commonly used file extension.
Definition: fishsound.h:426
Info about a particular encoder/decoder instance.
Definition: fishsound.h:404
int format
FISH_SOUND_VORBIS, FISH_SOUND_SPEEX, FISH_SOUND_FLAC etc.
Definition: fishsound.h:412
int samplerate
Sample rate of audio data in Hz.
Definition: fishsound.h:406
int channels
Count of channels.
Definition: fishsound.h:409