libfishsound Documentation

1.0.0

FishSound, the sound of fish!

This is the documentation for the FishSound C API. FishSound provides a simple programming interface for decoding and encoding audio data using Xiph.Org codecs (FLAC, Speex and Vorbis).

libfishsound by itself is designed to handle raw codec streams from a lower level layer such as UDP datagrams. When these codecs are used in files, they are commonly encapsulated in Ogg to produce Ogg FLAC, Speex and Ogg Vorbis files. Example C programs using liboggz to read and write these files are provided in the libfishsound sources.

For more information on the design and history of libfishsound, see the About section of this documentation, and the libfishsound homepage.

Contents

• fishsound.h : Documentation of the FishSound API.

• Handling comments : How to add and retrieve name = value metadata in Vorbis and Speex streams.

• Decoding audio data : How to decode audio data with FishSound, including source for a fully working Ogg FLAC, Speex and Ogg Vorbis decoder.

• Encoding audio data : How to encode audio data with FishSound, including source for a fully working Ogg FLAC, Speex and Ogg Vorbis encoder.

• Configuration : Customizing libfishsound to only decode or encode, or to disable support for a particular codec.

• Building : Information related to building software that uses libfishsound.

• About : Design, motivation, history and acknowledgements.

Licensing

libfishsound is provided under the following BSD-style open source license: