home *** CD-ROM | disk | FTP | other *** search
/ Chip 2005 June / ccd0605.iso / LINUX / gopchop-1.1.7.tar.tar / gopchop-1.1.7.tar / gopchop-1.1.7 / docs / mpegcat.sgml < prev    next >
SGML Document  |  2005-05-02  |  11KB
  1. <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
  2.  
  3. <!-- Process this file with docbook-to-man to generate an nroff manual
  4.      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
  5.      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
  6.      less'.  A typical entry in a Makefile or Makefile.am is:
  7.  
  8. manpage.1: manpage.sgml
  9.     docbook-to-man $< > $@
  10.   -->
  11.  
  12. <!-- This is based on an example constructed by Colin Watson
  13.      <email>cjwatson@debian.org</email>, based on a man page template
  14.      provided by Tom Christiansen <email>tchrist@jhereg.perl.com</email>
  15.      and a DocBook man page example by Craig Small
  16.      <email>csmall@debian.org</email>.
  17.   -->
  18.  
  19.   <!-- Fill in the various UPPER CASE things here. -->
  20.   <!ENTITY manfirstname "<firstname>Kees</firstname>">
  21.   <!ENTITY mansurname   "<surname>Cook</surname>">
  22.   <!-- Please adjust the date whenever revising the manpage. -->
  23.   <!ENTITY mandate      "<date>February 17, 2004</date>">
  24.   <!-- SECTION should be 1-8, maybe with subsection. Other parameters are
  25.        allowed: see man(7), man(1). -->
  26.   <!ENTITY mansection   "<manvolnum>1</manvolnum>">
  27.   <!ENTITY manemail     "<email>kees@outflux.net</email>">
  28.   <!ENTITY manusername  "kees">
  29.   <!ENTITY manucpackage "<refentrytitle>mpegcat</refentrytitle>">
  30.   <!ENTITY manpackage   "mpegcat">
  31. ]>
  32.  
  33. <refentry>
  34.   <refentryinfo>
  35.     <address>
  36.       &manemail;
  37.     </address>
  38.     <author>
  39.       &manfirstname;
  40.       &mansurname;
  41.     </author>
  42.     <copyright>
  43.       <year>2001-2005</year>
  44.       <holder>&manusername;</holder>
  45.     </copyright>
  46.     &mandate;
  47.   </refentryinfo>
  48.   <refmeta>
  49.     &manucpackage;
  50.  
  51.     &mansection;
  52.   </refmeta>
  53.   <refnamediv>
  54.     <refname>&manpackage;</refname>
  55.     <refpurpose>
  56.       Extracts structural information and PES streams from an MPEG2 video file
  57.     </refpurpose>
  58.   </refnamediv>
  59.   <refsynopsisdiv>
  60.     <cmdsynopsis>
  61.       <command>&manpackage;</command>
  62.       <group choice="req"><arg><replaceable>options</replaceable></arg></group>
  63.       <group choice="req"><arg><replaceable>file</replaceable></arg></group>
  64.     </cmdsynopsis>
  65.   </refsynopsisdiv>
  66.   <refsect1>
  67.     <title>DESCRIPTION</title>
  68.      <para>
  69.      <command>&manpackage;</command> dumps detailed textual information about
  70.      an MPEG2 file. It also has an option for writing out a particular
  71.      Packetized Elementary Stream (PES) given its id.
  72.      </para>
  73.      <para>
  74.      The original purpose of <command>&manpackage;</command> was for debugging stream parsing issues
  75.      in the gopchop cuts-only MPEG2 video editor, but it has more general utility.
  76.      </para>
  77.   </refsect1>
  78.   <refsect1>
  79.     <title>OPTIONS</title>
  80.     <refsect2>
  81.       <title>General Options</title>
  82.       <variablelist>
  83.         <varlistentry>
  84.           <term><option>-d</option>,<option>--debug</option></term>
  85.           <listitem>
  86.             <para>
  87.                 Report debug info
  88.               </para>
  89.           </listitem>
  90.         </varlistentry>
  91.         <varlistentry>
  92.           <term><option>-D</option>,<option>--dvd-format</option></term>
  93.           <listitem>
  94.             <para>
  95.                 Enable DVD packet extensions
  96.               </para>
  97.           </listitem>
  98.         </varlistentry>
  99.         <varlistentry>
  100.           <term><option>-h</option>,<option>-?</option>,<option>--help</option></term>
  101.           <listitem>
  102.             <para>
  103.                 Help
  104.               </para>
  105.           </listitem>
  106.         </varlistentry>
  107.         <varlistentry>
  108.           <term><option>-w</option>,<option>--write <replaceable>FILE</replaceable>,<replaceable>0xID</replaceable>[,<replaceable>0xSID</replaceable>]</option></term>
  109.           <listitem>
  110.             <para>
  111.                 Write <replaceable>PES</replaceable> with id <replaceable>ID</replaceable>
  112.               (and subid <replaceable>SID</replaceable>) to <replaceable>FILE</replaceable>.
  113.               Sub Picture Unit (SPU) streams such
  114.               as overlays, subtitles and DVD menus extracted using this option
  115.               can be displayed using the companion
  116.               <command>gtkspu</command> utility.
  117.               </para>
  118.             <para>
  119.               To find SPU streams in a .VOB ripped from a DVD:
  120.             </para>
  121.             <screen>
  122.                 <prompt>$ </prompt><userinput><command>&manpackage;</command> -iDa VTS_01_0.VOB | grep SPU</userinput>
  123.                    131086: 0xBD:  DVD Audio 0x20 (SPU 0): 2028 bytes (next marker @ 133120)
  124.                    133134: 0xBD:  DVD Audio 0x20 (SPU 0): 2028 bytes (next marker @ 135168)
  125.                    137230: 0xBD:  DVD Audio 0x20 (SPU 0): 190 bytes (next marker @ 137426)
  126.                    ...
  127.             </screen>
  128.             <para>
  129.               To save a given stream:
  130.             </para>
  131.             <screen>
  132.                 <prompt>$ </prompt><userinput><command>&manpackage;</command> -iDaw dump.spu,0xBD,0x20 VTS_01_0.VOB > /dev/null</userinput>
  133.             </screen>
  134.             <para>
  135.               (And to view the stream)
  136.             </para>
  137.             <screen>
  138.                 <prompt>$ </prompt><userinput><command>gtkspu</command> dump.spu 1</userinput>
  139.                 <prompt>$ </prompt><userinput><command>gtkspu</command> dump.spu 2</userinput>
  140.                 <prompt>$ </prompt><userinput><command>gtkspu</command> dump.spu 3</userinput>
  141.                 ...
  142.             </screen>
  143.           </listitem>
  144.         </varlistentry>
  145.       </variablelist>
  146.     </refsect2>
  147.     <refsect2>
  148.       <title>Processing Toggles</title>
  149.       <variablelist>
  150.         <varlistentry>
  151.           <term><option>-V</option>,<option>--enter-video</option></term>
  152.           <listitem>
  153.             <para>
  154.                 Process video packets (forced by -t option)
  155.               </para>
  156.           </listitem>
  157.         </varlistentry>
  158.       </variablelist>
  159.     </refsect2>
  160.     <refsect2>
  161.       <title>General Display Toggles</title>
  162.       <variablelist>
  163.         <varlistentry>
  164.           <term><option>-p</option>,<option>--pack</option></term>
  165.           <listitem>
  166.             <para>
  167.                 Toggle Pack packet start display
  168.               </para>
  169.           </listitem>
  170.         </varlistentry>
  171.         <varlistentry>
  172.           <term><option>-v</option>,<option>--video</option></term>
  173.           <listitem>
  174.             <para>
  175.                 Toggle video ES packet start display
  176.               </para>
  177.           </listitem>
  178.         </varlistentry>
  179.         <varlistentry>
  180.           <term><option>-a</option>,<option>--audio</option></term>
  181.           <listitem>
  182.             <para>
  183.                 Toggle audio ES packet start display
  184.               </para>
  185.           </listitem>
  186.         </varlistentry>
  187.         <varlistentry>
  188.           <term><option>-o</option>,<option>--other</option></term>
  189.           <listitem>
  190.             <para>
  191.                 Toggle other stream display (only show video & audio)
  192.               </para>
  193.           </listitem>
  194.         </varlistentry>
  195.         <varlistentry>
  196.           <term><option>-y</option>,<option>--system</option></term>
  197.           <listitem>
  198.             <para>
  199.                 Toggle system header display
  200.               </para>
  201.           </listitem>
  202.         </varlistentry>
  203.         <varlistentry>
  204.           <term><option>-e</option>,<option>--errors</option></term>
  205.           <listitem>
  206.             <para>
  207.                 Toggle packet errors
  208.               </para>
  209.           </listitem>
  210.         </varlistentry>
  211.         <varlistentry>
  212.           <term><option>-i</option>,<option>--invert</option></term>
  213.           <listitem>
  214.             <para>
  215.                 Invert all display toggles
  216.               </para>
  217.           </listitem>
  218.         </varlistentry>
  219.       </variablelist>
  220.     </refsect2>
  221.     <refsect2>
  222.       <title>Video Display Toggles</title>
  223.       <variablelist>
  224.         <varlistentry>
  225.           <term><option>-s</option>,<option>--slices</option></term>
  226.           <listitem>
  227.             <para>
  228.                 Toggle slice starts (default off)
  229.               </para>
  230.           </listitem>
  231.         </varlistentry>
  232.         <varlistentry>
  233.           <term><option>-q</option>,<option>--sequence</option></term>
  234.           <listitem>
  235.             <para>
  236.                 Toggle sequence header display
  237.               </para>
  238.           </listitem>
  239.         </varlistentry>
  240.         <varlistentry>
  241.           <term><option>-g</option>,<option>--GOPs</option></term>
  242.           <listitem>
  243.             <para>
  244.                 Toggle GOP header display
  245.               </para>
  246.           </listitem>
  247.         </varlistentry>
  248.         <varlistentry>
  249.           <term><option>-f</option>,<option>--frames</option></term>
  250.           <listitem>
  251.             <para>
  252.                 Toggle Picture header display
  253.               </para>
  254.           </listitem>
  255.         </varlistentry>
  256.       </variablelist>
  257.     </refsect2>
  258.     <refsect2>
  259.       <title>Short Cuts</title>
  260.       <variablelist>
  261.         <varlistentry>
  262.           <term><option>-F</option>,<option>--just-frames</option></term>
  263.           <listitem>
  264.             <para>
  265.                 Show only video frames (same as '-Vepvaoyq')
  266.               </para>
  267.           </listitem>
  268.         </varlistentry>
  269.       </variablelist>
  270.     </refsect2>
  271.     <refsect2>
  272.       <title>File Offset Options</title>
  273.       <variablelist>
  274.         <varlistentry>
  275.           <term><option>-b</option>,<option>--begin=<replaceable>NUM</replaceable></option></term>
  276.           <listitem>
  277.             <para>
  278.                 Start reading at offset <replaceable>NUM</replaceable>  
  279.               </para>
  280.           </listitem>
  281.         </varlistentry>
  282.         <varlistentry>
  283.           <term><option>-n</option>,<option>--num=<replaceable>NUM</replaceable></option></term>
  284.           <listitem>
  285.             <para>
  286.                 Stop after reading <replaceable>NUM</replaceable> bytes
  287.               </para>
  288.           </listitem>
  289.         </varlistentry>
  290.         <varlistentry>
  291.           <term><option>-t</option>,<option>--scan-stream</option></term>
  292.           <listitem>
  293.             <para>Scan every byte of the stream instead of using PES offsets
  294.             (this can show erroneous 'start code emulation' codes)</para>
  295.           </listitem>
  296.         </varlistentry>
  297.       </variablelist>
  298.     </refsect2>
  299.   </refsect1>
  300.  
  301.   <refsect1>
  302.     <title>AUTHOR</title>
  303.     <para><author>&manfirstname;</author> <author>&mansurname;</author>, &manemail;</para>
  304.   </refsect1>
  305.  
  306.   <refsect1>
  307.     <title>SEE ALSO</title>
  308.     <para>gopchop(1), gtkspu(1)</para>
  309.   </refsect1>
  310. </refentry>
  311.  
  312. <!-- Keep this comment at the end of the file
  313. Local variables:
  314. mode: sgml
  315. sgml-omittag:t
  316. sgml-shorttag:t
  317. sgml-minimize-attributes:nil
  318. sgml-always-quote-attributes:t
  319. sgml-indent-step:2
  320. sgml-indent-data:t
  321. sgml-parent-document:nil
  322. sgml-default-dtd-file:nil
  323. sgml-exposed-tags:nil
  324. sgml-local-catalogs:nil
  325. sgml-local-ecat-files:nil
  326. End:
  327. -->
  328.