docs/manual/appendix-debugging.xml

   1 <chapter id="cha-debugging">
   2   <title>Debugging</title>
   3   <para>
   4     GStreamer has an extensive set of debugging tools for
   5     plugin developers.
   6   </para>
   7
   8   <sect1>
   9     <title>Command line options</title>
  10     <para>
  11       Applications using the GStreamer libraries accept the following set
  12       of command line argruments to enable the debugging system.
  13     </para>
  14
  15     <para>
  16      <itemizedlist>
  17        <listitem>
  18          <para>
  19           <option>--gst-debug-mask=<replaceable>mask</replaceable></option>
  20           Sets the mask for the debugging output.
  21          </para>
  22        </listitem>
  23        <listitem>
  24          <para>
  25           <option>--gst-info-mask=<replaceable>mask</replaceable></option>
  26           Sets the mask for the info output.
  27          </para>
  28        </listitem>
  29        <listitem>
  30          <para>
  31           <option>--gst-mask=<replaceable>mask</replaceable></option>
  32           Sets the mask for the info *and* the debug output.
  33          </para>
  34        </listitem>
  35        <listitem>
  36          <para>
  37           <option>--gst-mask-help</option>
  38           Print out the meaning of gst-mask-* values.
  39          </para>
  40        </listitem>
  41        <listitem>
  42          <para>
  43           <option>--gst-plugin-spew</option>
  44           Enable printout of errors while loading GST plugins.
  45          </para>
  46        </listitem>
  47        <listitem>
  48          <para>
  49           <option>--gst-plugin-path=<replaceable>PATH</replaceable></option>
  50           Add a directory to the plugin search path.
  51          </para>
  52        </listitem>
  53        <listitem>
  54          <para>
  55            <option>--help</option> Print the a short desciption of the
  56            options
  57          </para>
  58        </listitem>
  59      </itemizedlist>
  60     </para>
  61     <para>
  62       The following table gives an overview of the mask values and their meaning. (enabled) means
  63       that the corresponding flag is set by default. This table is available to any GStreamer
  64       application by the --gst-mask-help option.
  65     </para>
  66     <programlisting>
  67 Mask (to be OR'ed)   info/debug         FLAGS
  68 --------------------------------------------------------
  69 0x00000001     (enabled)/              GST_INIT
  70 0x00000002              /              COTHREADS
  71 0x00000004              /              COTHREAD_SWITCH
  72 0x00000008              /              AUTOPLUG
  73 0x00000010              /              AUTOPLUG_ATTEMPT
  74 0x00000020              /              PARENTAGE
  75 0x00000040              /              STATES
  76 0x00000080              /              PLANING
  77 0x00000100              /              SCHEDULING
  78 0x00000200              /              OPERATION
  79 0x00000400              /              BUFFER
  80 0x00000800              /              CAPS
  81 0x00001000              /              CLOCK
  82 0x00002000              /              ELEMENT_PADS
  83 0x00004000              /              ELEMENT_FACTORY
  84 0x00008000              /              PADS
  85 0x00010000              /              PIPELINE
  86 0x00020000              /              PLUGIN_LOADING
  87 0x00040000              /              PLUGIN_ERRORS
  88 0x00080000              /              PLUGIN_INFO
  89 0x00100000              /              PROPERTIES
  90 0x00200000              /              THREAD
  91 0x00400000              /              TYPES
  92 0x00800000              /              XML
  93 0x01000000              /              NEGOTIATION
  94 0x02000000              /              REFCOUNTING
  95     </programlisting>
  96   </sect1>
  97   <sect1>
  98     <title>Adding a custom debug handler</title>
  99     <para>
 100     </para>
 101   </sect1>
 102
 103 </chapter>