Fix potential integer overflow.
[liboggz.git] / release_notes / liboggz-0.9.6.txt
1 Oggz 0.9.6 Release
2 ------------------
3
4 Oggz comprises liboggz and the command-line tools oggzinfo, oggzdump,
5 oggzdiff, oggzmerge, oggzrip, oggz-comment, oggz-scan and oggz-validate.
6
7 liboggz is a C library providing a simple programming interface for reading
8 and writing Ogg files and streams. Ogg is an interleaving data container
9 developed by Monty at Xiph.Org, originally to support the Ogg Vorbis audio
10 format.
11
12 This release is available as a source tarball at:
13
14 http://www.annodex.net/software/liboggz/download/liboggz-0.9.6.tar.gz
15
16 New in this release:
17 --------------------
18
19 This release adds a new oggz-comment tool, and improvements to liboggz's
20 determination of timestamps and seeking. Specifically, liboggz now inspects
21 the encoded data in order reconstruct the expected granulepos (corresponding
22 to a timestamp) for every packet in an Ogg stream. This allows applications
23 to use reliable timestamps, even though these are only sparsely recorded in
24 most Ogg streams.
25
26 Details:
27 --------
28
29 Tools:
30         * Added new oggz-comment tool (Kangyuan Niu)
31         * Added Skeleton support to oggzinfo (Tahseen Mohammad)
32         * Report FLAC samplerate, channels in oggzinfo (Conrad Parker)
33
34 Documentation:
35
36         * Improved oggzmerge documentation (Debian bug #280550)
37
38 liboggz API:
39
40         * Added content type detection and retrieval functions
41           oggz_stream_get_content(), oggz_stream_get_content_type()
42           (Shane Stephens)
43         * Added oggz_tell_granulepos function to query liboggz for
44           granulepos values. (Shane Stephens)
45         * Added Vorbiscomment API oggz_comment_*() for manipulating comments
46           in Ogg Vorbis, Speex, Theora, FLAC files (Conrad Parker, Ian Malone)
47         * Added oggz_get_numtracks() (Conrad Parker)
48
49 Internal:
50
51         * Added automatic calculation of missing granulepos values
52           in Vorbis, Speex, Theora (Shane Stephens) and FLAC (Conrad Parker)
53         * Seeking improvements (Shane Stephens)
54         * Corrections for C standards support (Erik de Castro Lopo)
55         * GNU Autotools build system updates (Ralph Giles, Thomas van der
56           Stichele)
57         * Updated Win32 build system (Alex Krumm-Heller, Marcin Lubonski)
58         * libtool shared version info updated to 4:0:3
59
60 About Oggz
61 ----------
62
63 Oggz comprises liboggz and the command-line tools oggzinfo, oggzdump,
64 oggzdiff, oggzmerge, oggzrip, oggz-comment, oggz-scan and oggz-validate.
65
66 liboggz supports the flexibility afforded by the Ogg file format while
67 presenting the following API niceties:
68
69         * Full API documentation
70
71         * Comprehensive test suite of read, write and seeking behavior.
72         The entire test suite can be run under valgrind if available.
73
74         * Developed and tested on GNU/Linux, Darwin/MacOSX, Win32 and
75         Symbian OS. May work on other Unix-like systems via GNU autoconf.
76         For Win32: nmake Makefiles, Visual Studio .NET 2003 solution files
77         and Visual C++ 6.0 workspace files are provided in the source
78         distribution.
79
80         * Strict adherence to the formatting requirements of Ogg bitstreams,
81         to ensure that only valid bitstreams are generated; writes can fail
82         if you try to write illegally structured packets.
83
84         * A simple, callback based open/read/close or open/write/close
85         interface to raw Ogg files.
86
87         * Writing automatically interleaves with packet queuing, and provides   
88         callback based notification when this queue is empty
89
90         * A customisable seeking abstraction for seeking on multitrack Ogg
91         data. Seeking works easily and reliably on multitrack and multi-codec
92         streams, and can transparently parse Theora, Speex, Vorbis, FLAC,
93         CMML and Ogg Skeleton headers  without requiring linking to those
94         libraries. This allows efficient use on servers and other devices
95         that need to parse and seek within Ogg files, but do not need to do
96         a full media decode.
97
98 Full documentation of the liboggz API, customization and installation,
99 and mux and demux examples can be read online at:
100
101     http://www.annodex.net/software/liboggz/html/
102
103 Tools
104 -----
105
106 The Oggz source tarball also contains the following command-line tools,
107 which are useful for debugging and testing Ogg bitstreams:
108
109         * oggzinfo: Display information about one or more Ogg files and
110         their bitstreams.
111
112         * oggzdump: Hexdump packets of an Ogg file, or revert an Ogg file
113         from such a hexdump.
114
115         * oggzdiff: Hexdump the packets of two Ogg files and output
116         differences.
117
118         * oggzmerge: Merge Ogg files together, interleaving pages in order
119         of presentation time.
120
121         * oggzrip: Extract one or more logical bitstreams from an Ogg file.
122
123         * oggz-comment: List or edit comments in an Ogg file.
124
125         * oggz-scan: Scan an Ogg file and output characteristic landmarks.
126
127         * oggz-validate: Validate the Ogg framing of one or more files.
128
129 License
130 -------
131
132 Oggz is Free Software, available under a BSD style license.
133
134 More information is available online at the Oggz homepage:
135
136     http://www.annodex.net/software/liboggz/
137
138 enjoy :)
139
140 --
141 Conrad Parker, Annodex Association
142 http://www.annodex.net/