|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| apache/ | H | 29-Apr-2010 | - | 7 | 6 |
| bash-completion/ | H | 29-Apr-2010 | - | 230 | 193 |
| doc/ | H | 07-May-2022 | - | 6,831 | 5,256 |
| include/ | H | 03-May-2022 | - | 4,016 | 1,301 |
| m4/ | H | 29-Apr-2010 | - | 159 | 143 |
| src/ | H | 03-May-2022 | - | 27,079 | 18,396 |
| symbian/ | H | 29-Apr-2010 | - | 135 | 73 |
| win32/ | H | 29-Apr-2010 | - | 11,937 | 11,517 |
| AUTHORS | H A D | 30-Jan-2010 | 1.2 KiB | 54 | 37 |
| COPYING | H A D | 30-Jan-2010 | 1.5 KiB | 30 | 23 |
| ChangeLog | H A D | 29-Apr-2010 | 22.5 KiB | 568 | 456 |
| INSTALL | H A D | 30-Jan-2010 | 7.6 KiB | 183 | 143 |
| Makefile.am | H A D | 11-Feb-2010 | 4.7 KiB | 122 | 86 |
| Makefile.in | H A D | 03-May-2022 | 29.7 KiB | 918 | 791 |
| PATCHES | H A D | 20-Apr-2010 | 611 | 21 | 13 |
| README | H A D | 20-Apr-2010 | 7.2 KiB | 205 | 149 |
| README.symbian | H A D | 30-Jan-2010 | 247 | 6 | 4 |
| README.win32 | H A D | 30-Jan-2010 | 1.7 KiB | 54 | 39 |
| TODO | H A D | 29-Apr-2010 | 4.8 KiB | 176 | 127 |
| acinclude.m4 | H A D | 30-Jan-2010 | 3.9 KiB | 117 | 106 |
| aclocal.m4 | H A D | 29-Apr-2010 | 315.1 KiB | 9,091 | 8,146 |
| apache-install.sh | H A D | 30-Jan-2010 | 377 | 17 | 12 |
| config.guess | H A D | 23-Jul-2009 | 44.5 KiB | 1,534 | 1,318 |
| config.h.in | H A D | 29-Apr-2010 | 3.6 KiB | 144 | 99 |
| config.sub | H A D | 23-Jul-2009 | 33.3 KiB | 1,694 | 1,549 |
| configure | H A D | 29-Apr-2010 | 440.3 KiB | 15,383 | 12,035 |
| configure.ac | H A D | 29-Apr-2010 | 15.9 KiB | 534 | 436 |
| depcomp | H A D | 18-Jan-2010 | 18.2 KiB | 631 | 407 |
| install-sh | H A D | 18-Jan-2010 | 13.3 KiB | 521 | 344 |
| ltmain.sh | H A D | 09-Dec-2009 | 237.7 KiB | 8,414 | 6,482 |
| missing | H A D | 18-Jan-2010 | 11.2 KiB | 377 | 281 |
| oggz-uninstalled.pc.in | H A D | 30-Jan-2010 | 255 | 12 | 10 |
| oggz.pc.in | H A D | 30-Jan-2010 | 266 | 13 | 11 |
README
1Documentation files for Oggz
2----------------------------
3
4 PATCHES: Instructions for generating patches
5 README: this file
6 README.symbian: Instructions for building for Symbian
7 README.win32: Instructions for building on Win32
8
9Run:
10----
11
12 $ oggz help
13
14for documentation of the various oggz commands.
15
16About Oggz
17==========
18
19Oggz comprises liboggz and the tool oggz, which provides commands to
20inspect, edit and validate Ogg files. The oggz-chop tool can also be
21used to serve time ranges of Ogg media over HTTP by any web server that
22supports CGI.
23
24liboggz is a C library for reading and writing Ogg files and streams.
25It offers various improvements over the reference libogg, including
26support for seeking, validation and timestamp interpretation. Ogg is
27an interleaving data container developed by Monty at Xiph.Org,
28originally to support the Ogg Vorbis audio format but now used for
29many free codecs including Dirac, FLAC, Speex and Theora.
30
31Dependencies
32------------
33
34Oggz depends only on libogg, available in most free software
35distributions, or in source form at: http://xiph.org/downloads/
36
37Support is built-in for parsing the headers of and seeking to time
38positions in Ogg Dirac, FLAC, Speex, Theora and Vorbis. Oggz is also
39compatible with Annodex streams, and supports seeking on all tracks
40described in an Ogg Skeleton track.
41
42Installation
43------------
44
45Release archives can be installed using the conventional commands:
46
47 $ ./configure
48 $ make check
49 $ sudo make install
50
51sequence. Configuration details are in the file INSTALL. If you obtained
52this source by svn, first run "./autogen.sh" to create the configure script,
53then run the above commands.
54
55Read the file README.win32 for installing under MS Windows, and
56README.symbian for information about building for Symbian devices.
57
58Source layout
59-------------
60
61 doc/
62 doc/liboggz autocreated by the doxygen tool from comments
63 contained in the public C header files
64
65 include/ public C header files
66
67 src/
68 src/liboggz/ library source code.
69 src/tools/ command line tools
70 src/examples/ example programs using liboggz
71 src/tests/ unit and functional tests
72
73 symbian/ files necessary to compile the library for Symbian
74 win32/ files necessary to compile the library and tools for
75 Microsoft Windows
76
77Developers
78----------
79
80liboggz is maintained in git at git://git.xiph.org/liboggz.git
81
82A list of outstanding tasks is maintained in the TODO file of this source
83distribution. When implementing anything listed in this file, please update
84it by deleting that entry, and include that as part of the patch or commit
85that implements the fix.
86
87Please send patches to ogg-dev@xiph.org
88
89Programming with liboggz
90------------------------
91
92liboggz supports the flexibility afforded by the Ogg file format while
93presenting the following API niceties:
94
95 * Full API documentation
96
97 * Comprehensive test suite of read, write and seeking behavior.
98 The entire test suite can be run under valgrind if available.
99
100 * Developed and tested on GNU/Linux, Darwin/MacOSX, Win32 and
101 Symbian OS. May work on other Unix-like systems via GNU autoconf.
102 For Win32: nmake Makefiles, Visual Studio .NET 2003, 2005 and 2008
103 solution files are provided in the source distribution.
104
105 * Strict adherence to the formatting requirements of Ogg bitstreams,
106 to ensure that only valid bitstreams are generated; writes can fail
107 if you try to write illegally structured packets.
108
109 * A simple, callback based open/read/close or open/write/close
110 interface to raw Ogg files.
111
112 * Writing automatically interleaves with packet queuing, and provides
113 callback based notification when this queue is empty
114
115 * A customisable seeking abstraction for seeking on multitrack Ogg
116 data. Seeking works easily and reliably on multitrack and multi-codec
117 streams, and can transparently parse Theora, Speex, Vorbis, FLAC,
118 PCM, CMML and Ogg Skeleton headers without requiring linking to those
119 libraries. This allows efficient use on servers and other devices
120 that need to parse and seek within Ogg files, but do not need to do
121 a full media decode.
122
123Full documentation of the liboggz API, customization and installation,
124and mux and demux examples can be read online at:
125
126 http://www.xiph.org/oggz/doc/
127
128oggz tool
129---------
130
131Usage: oggz <subcommand> [options] filename ...
132
133oggz is a commandline tool for manipulating Ogg files. It supports
134multiplexed files conformant with RFC3533. Oggz can parse headers for CELT,
135CMML, Dirac, FLAC, Kate, PCM, Speex, Theora and Vorbis, and can read and write
136Ogg Skeleton logical bitstreams.
137
138Commands:
139 help Display help for a specific subcommand (eg. "oggz help chop")
140
141Reporting:
142 codecs Display the codecs present in an Ogg file
143 diff Hexdump the packets of two Ogg files and output differences.
144 dump Hexdump packets of an Ogg file, or revert an Ogg file from
145 such a hexdump.
146 info Display information about one or more Ogg files and their
147 bitstreams.
148 scan Scan an Ogg file and output characteristic landmarks.
149 validate Validate the Ogg framing of one or more files.
150
151Extraction:
152 rip Extract one or more logical bitstreams from an Ogg file.
153
154Editing:
155 chop Extract the part of an Ogg file between given start and/or
156 end times.
157 comment List or edit comments in an Ogg file.
158 merge Merge Ogg files together, interleaving pages in order of
159 presentation time.
160 sort Sort the pages of an Ogg file in order of presentation time.
161
162Miscellaneous:
163 known-codecs List codecs known by this version of oggz
164
165The script bash-completion/oggz enables completion of tool options and codec
166names when using the bash shell. Source it from your .profile, or install it
167in /etc/bash_completion.d to enable it system-wide.
168
169
170oggz-chop: General usage and CGI installation
171---------------------------------------------
172
173oggz-chop extracts the part of an Ogg file between given start and/or end
174times. The output file contains copies of the headers of the input file, and
175all the codec data required to correctly decode the content between the start
176and end times specified on the commandline. For codecs with data dependencies
177like video keyframes, the keyframe prior to the starting time will be included
178in the output.
179
180An Apache server can be configured to use oggz-chop to handle all Ogg files
181(or, all Ogg files in a particular directory). An example Apache configuration
182is in the liboggz source tree, along with a script for installing it on a
183Debian server.
184
185The oggz-chop binary checks if it is being run as a CGI script (by checking
186some environment variables), and if so acts based on the CGI query parameter
187t=, much like mod_annodex. It accepts all the time specifications that
188mod_annodex accepts (npt and various smpte framerates), and start and end
189times separated by a /.
190
191License
192-------
193
194Oggz is Free Software, available under a BSD style license.
195
196More information is available online at the Oggz homepage:
197
198 http://xiph.org/oggz/
199
200enjoy :)
201
202--
203Conrad Parker
204http://www.annodex.net/
205
README.symbian
1The symbian/ directory contains the following files for Symbian's abuild tool:
2
3 bld.inf Component definition file
4 liboggz.mmp Project specification file
5 config.h Configuration options for both emulator and device builds
6
README.win32
1The /Win32 directory contains everything necessary to compile liboggz
2under windows and create:
3
4- liboggz.dll
5- oggzdump.exe
6- oggzinfo.exe
7- oggzmerge.exe
8- oggzrip.exe
9- oggzscan.exe
10- oggzvalidate.exe
11
12Building with the Makefile
13==========================
14
15Here's what you need to do:
16
171) Install libogg.dll.
18 (you can get it from http://www.xiph.org/ogg/vorbis/ ).
19
202) cd win32 subdirectory
21
223) Use "nmake" to create library and executable.
23
244) Install oggzdump, oggzinfo, oggzed, liboggz.dll and the
25 include files from the /include/oggz/ directory.
26
27
28Visual Studio.NET 2003 Installation
29===================================
30
31IMPORTANT: The solution files were built for VS.NET 2003 and can't be
32opened by VS.NET 2002. If you use VS.NET 2002 you should use the VS6
33workspace files and they will be automatically converted to the new
34format.
35
36Also included in the solution is a setup and deployment project that
37will package and create an installer for the binary output of this
38project.
39
40You will need to install the libogg library separately. If you wish to
41create a debug build and wish to have the debugger load the symbols
42for this library, you should also include the project source files. By
43default the compiler and linker will look for them in the same parent
44directory as liboggz. However you can install them wherever you choose
45and must modify the include directories for the linker and compiler in
46your projects properties.
47
48
49Visual Studio Version 6 Installation
50====================================
51NOTE: For lack of platform, we were not able to keep the Visual
52Studio Version 6 project files up-to-date. Send us an updated version
53if you're using these.
54