Fix potential integer overflow.
[liboggz.git] / release_notes / liboggz-0.8.4.txt
1 Oggz 0.8.4 Release
2 ------------------
3
4 liboggz is a C library providing a simple programming interface for reading
5 and writing Ogg files and streams. Ogg is an interleaving data container
6 developed by Monty at Xiph.Org, originally to support the Ogg Vorbis audio
7 format.
8
9 This release is available as a source tarball at:
10
11 http://www.annodex.net/software/liboggz/download/liboggz-0.8.4.tar.gz
12
13 New in this release:
14
15         * added support for building on Symbian OS (by Colin Ward)
16         * new OGGZ_ERR_IO_AGAIN handling for network reads
17         * added test for reading packets one-by-one
18         * expanded --help output for oggzdump tool
19         * added option to run test suite under valgrind
20
21 Additionally, a thorough audit of memory leaks has been completed and
22 various minor bugs have been fixed.
23
24 About Oggz
25 ----------
26
27 Oggz comprises liboggz and the command-line tools oggzdump and oggzdiff.
28
29 liboggz supports the flexibility afforded by the Ogg file format while
30 presenting the following API niceties:
31
32         * Full API documentation.
33
34         * Comprehensive test suite of read, write and seeking behavior.
35
36         * Developed and tested on GNU/Linux, Darwin/MacOSX, Win32 and
37         Symbian OS. May work on other Unix-like systems via GNU autoconf.
38         For Win32: nmake Makefiles, Visual Studio .NET 2003 solution files
39         and Visual C++ 6.0 workspace files are provided in the source
40         distribution.
41
42         * Strict adherence to the formatting requirements of Ogg bitstreams,
43         to ensure that only valid bitstreams are generated; writes can fail
44         if you try to write illegally structured packets.
45
46         * A simple, callback based open/read/close or open/write/close
47         interface to raw Ogg files.
48
49         * Writing automatically interleaves with packet queuing, and provides   
50         callback based notification when this queue is empty
51
52         * A customisable seeking abstraction for seeking on multitrack Ogg
53         data. Seeking works easily and reliably on multitrack and multi-codec
54         streams, and can transparently parse Theora, Speex, Vorbis and Annodex
55         headers  without requiring linking to those libraries. This allows
56         efficient use on servers and other devices that need to parse and
57         seek within Ogg files, but do not need to do a full media decode.
58
59 Full documentation of the liboggz API, customization and installation,
60 and mux and demux examples can be read online at:
61
62     http://www.annodex.net/software/liboggz/html/
63
64 Tools
65 -----
66
67 The Oggz source tarball also contains the following command-line tools,
68 which are useful for debugging and testing Ogg bitstreams:
69
70         * oggzdump: Hexdump packets of an Ogg file, or revert an Ogg file
71         from such a hexdump.
72
73         * oggzdiff: Hexdump the packets of two Ogg files and output
74         differences Oggz is Free Software, available under a BSD-style
75         license.
76
77 License
78 -------
79
80 Oggz is Free Software, available under a BSD style license.
81
82 More information is available online at the Oggz homepage:
83
84     http://www.annodex.net/software/liboggz/
85
86 enjoy :)
87
88 --
89 Conrad Parker
90 Senior Software Engineer, Continuous Media Web, CSIRO Australia
91 http://www.annodex.net/   http://www.ict.csiro.au/cmweb/