libfishsound

# 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:

Copyright (C) 2003 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 the CSIRO 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.