Fix potential integer overflow.
[liboggz.git] / release_notes / liboggz-0.9.2.txt
1 Oggz 0.9.2 Release
2 ------------------
3
4 Oggz comprises liboggz and the command-line tools oggzinfo, oggzdump,
5 oggzdiff, oggzmerge, oggzrip 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.2.tar.gz
15
16 New in this release:
17
18         * New and improved examples:
19
20         rewrite-pages: example code stub to build tools from
21         fix-eos: new example tool to fix missing EOS flags (MikeS)
22
23         * Build system improvements (thomasvs)
24
25         * Bugfixes / closed tickets:
26
27         oggzinfo: Fix calculation of content duration. (ticket:117)
28         oggzmerge: Fix an interleaving error in oggzmerge. (ticket:121)
29         oggzrip: fix memory corruption detected by glibc on Fedora Core
30                  (reported/fixed by thomasvs)
31         oggz-validate: report streams with missing *** eos (ticket:146)
32         oggz-validate: report and fail on non-Ogg files (ticket:147)
33
34         * Removed need for ./configure --disable-shared when running tests
35         under valgrind
36
37 Special thanks to Fluendo (http://www.fluendo.com/) for their contributions
38 to this release, and for their compassion and forebearance in indulging the
39 peculiarities of Ogg.
40
41  
42 About Oggz
43 ----------
44
45 Oggz comprises liboggz and the command-line tools oggzinfo, oggzdump,
46 oggzdiff, oggzmerge, oggzrip and oggz-validate.
47
48 liboggz supports the flexibility afforded by the Ogg file format while
49 presenting the following API niceties:
50
51         * Full API documentation
52
53         * Comprehensive test suite of read, write and seeking behavior.
54         The entire test suite can be run under valgrind if available.
55
56         * Developed and tested on GNU/Linux, Darwin/MacOSX, Win32 and
57         Symbian OS. May work on other Unix-like systems via GNU autoconf.
58         For Win32: nmake Makefiles, Visual Studio .NET 2003 solution files
59         and Visual C++ 6.0 workspace files are provided in the source
60         distribution.
61
62         * Strict adherence to the formatting requirements of Ogg bitstreams,
63         to ensure that only valid bitstreams are generated; writes can fail
64         if you try to write illegally structured packets.
65
66         * A simple, callback based open/read/close or open/write/close
67         interface to raw Ogg files.
68
69         * Writing automatically interleaves with packet queuing, and provides   
70         callback based notification when this queue is empty
71
72         * A customisable seeking abstraction for seeking on multitrack Ogg
73         data. Seeking works easily and reliably on multitrack and multi-codec
74         streams, and can transparently parse Theora, Speex, Vorbis, FLAC,
75         CMML and Ogg Skeleton headers  without requiring linking to those
76         libraries. This allows efficient use on servers and other devices
77         that need to parse and seek within Ogg files, but do not need to do
78         a full media decode.
79
80 Full documentation of the liboggz API, customization and installation,
81 and mux and demux examples can be read online at:
82
83     http://www.annodex.net/software/liboggz/html/
84
85 Tools
86 -----
87
88 The Oggz source tarball also contains the following command-line tools,
89 which are useful for debugging and testing Ogg bitstreams:
90
91         * oggzinfo: Display information about one or more Ogg files and
92         their bitstreams.
93
94         * oggzdump: Hexdump packets of an Ogg file, or revert an Ogg file
95         from such a hexdump.
96
97         * oggzdiff: Hexdump the packets of two Ogg files and output
98         differences.
99
100         * oggzmerge: Merge Ogg files together, interleaving pages in order
101         of presentation time.
102
103         * oggzrip: Extract one or more logical bitstreams from an Ogg file.
104
105         * oggz-validate: Validate the Ogg framing of one or more files.
106
107 License
108 -------
109
110 Oggz is Free Software, available under a BSD style license.
111
112 More information is available online at the Oggz homepage:
113
114     http://www.annodex.net/software/liboggz/
115
116 enjoy :)
117
118 --
119 Conrad Parker
120 Senior Software Engineer, Continuous Media Web, CSIRO Australia
121 http://www.annodex.net/   http://www.ict.csiro.au/cmweb/