Commit 314d5c61 authored by conrad's avatar conrad

update README with tool names, and info about oggz-chop


git-svn-id: http://svn.annodex.net/liboggz/trunk@3770 8158c8cd-e7e1-0310-9fa4-c5954c97daef
parent 6b9b91fe
......@@ -2,7 +2,9 @@ About Oggz
----------
Oggz comprises liboggz and the command-line tools oggzinfo, oggzdump,
oggzdiff, oggzmerge, oggzrip, oggz-comment, oggz-scan and oggz-validate.
oggzdiff, oggzmerge, oggzrip, oggz-chop, oggz-comment, oggz-scan, oggz-sort
and oggz-validate. oggz-chop can be used to serve time ranges of Ogg media
over HTTP by any web server that supports CGI.
liboggz is a C library providing a simple programming interface for reading
and writing Ogg files and streams. Ogg is an interleaving data container
......@@ -104,30 +106,57 @@ Tools
The Oggz source tarball also contains the following command-line tools,
which are useful for debugging and testing Ogg bitstreams:
* oggzinfo: Display information about one or more Ogg files and
their bitstreams.
* oggz-chop: Extract the part of an Ogg file between given start
and/or end times.
* oggzdump: Hexdump packets of an Ogg file, or revert an Ogg file
from such a hexdump.
* oggz-comment: List or edit comments in an Ogg file.
* oggzdiff: Hexdump the packets of two Ogg files and output
* oggz-diff: Hexdump the packets of two Ogg files and output
differences.
* oggzmerge: Merge Ogg files together, interleaving pages in order
of presentation time.
* oggz-dump: Hexdump packets of an Ogg file, or revert an Ogg file
from such a hexdump.
* oggzrip: Extract one or more logical bitstreams from an Ogg file.
* oggz-info: Display information about one or more Ogg files and
their bitstreams.
* oggz-comment: List or edit comments in an Ogg file.
* oggz-merge: Merge Ogg files together, interleaving pages in order
of presentation time.
* oggz-rip: Extract one or more logical bitstreams from an Ogg file.
* oggz-scan: Scan an Ogg file and output characteristic landmarks.
* oggz-sort: Sort the pages of an Ogg file in order of presentation time.
* oggz-validate: Validate the Ogg framing of one or more files.
The script bash-completion/oggz enables completion of tool options and codec
names when using the bash shell. Source it from your .profile, or install it
in /etc/bash_completion.d to enable it system-wide.
oggz-chop: General usage and CGI installation
---------------------------------------------
oggz-chop extracts the part of an Ogg file between given start and/or end
times. The output file contains copies of the headers of the input file, and
all the codec data required to correctly decode the content between the start
and end times specified on the commandline. For codecs with data dependencies
like video keyframes, the keyframe prior to the starting time will be included
in the output.
An Apache server can be configured to use oggz-chop to handle all Ogg files
(or, all Ogg files in a particular directory). An example Apache configuration
is in the liboggz source tree, along with a script for installing it on a
Debian server.
The oggz-chop binary checks if it is being run as a CGI script (by checking
some environment variables), and if so acts based on the CGI query parameter
t=, much like mod_annodex. It accepts all the time specifications that
mod_annodex accepts (npt and various smpte framerates), and start and end
times separated by a /.
License
-------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment