[xiph-commits] r3770 - liboggz/trunk

[conrad at svn.annodex.net]

Author: conrad
Date: 2008-11-05 17:08:26 -0800 (Wed, 05 Nov 2008)
New Revision: 3770

Modified:
   liboggz/trunk/README
Log:
update README with tool names, and info about oggz-chop


Modified: liboggz/trunk/README
===================================================================
--- liboggz/trunk/README	2008-11-06 00:58:30 UTC (rev 3769)
+++ liboggz/trunk/README	2008-11-06 01:08:26 UTC (rev 3770)
@@ -2,7 +2,9 @@
 ----------
 
 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 @@
 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
+    * oggz-dump: Hexdump packets of an Ogg file, or revert an Ogg file
+    from such a hexdump.
+
+    * oggz-info: Display information about one or more Ogg files and
+    their bitstreams.
+
+    * oggz-merge: Merge Ogg files together, interleaving pages in order
     of presentation time.
 
-    * oggzrip: Extract one or more logical bitstreams from an Ogg file.
+    * oggz-rip: Extract one or more logical bitstreams from an Ogg file.
 
-    * oggz-comment: List or edit comments in 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
 -------