mobile/docs/gst/html/gstreamer-GstTrace.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GstTrace</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer 0.10 Core Reference Manual">
   8 <link rel="up" href="gstreamer-support.html" title="GStreamer Core Support">
   9 <link rel="prev" href="gstreamer-GstInfo.html" title="GstInfo">
  10 <link rel="next" href="gstreamer-hierarchy.html" title="Object Hierarchy">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gstreamer-GstInfo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-support.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer 0.10 Core Reference Manual</th>
  21 <td><a accesskey="n" href="gstreamer-hierarchy.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gstreamer-GstTrace.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gstreamer-GstTrace.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gstreamer-GstTrace"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gstreamer-GstTrace.top_of_page"></a>GstTrace</span></h2>
  34 <p>GstTrace — Tracing functionality</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gstreamer-GstTrace.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/gst.h&gt;
  42
  43 struct              <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace">GstTrace</a>;
  44 <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="returnvalue">GstTrace</span></a> *          <a class="link" href="gstreamer-GstTrace.html#gst-trace-new" title="gst_trace_new ()">gst_trace_new</a>                       (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
  45                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstTrace.html#gst-trace-destroy" title="gst_trace_destroy ()">gst_trace_destroy</a>                   (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> *trace</code></em>);
  47 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstTrace.html#gst-trace-flush" title="gst_trace_flush ()">gst_trace_flush</a>                     (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> *trace</code></em>);
  48 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstTrace.html#gst-trace-text-flush" title="gst_trace_text_flush ()">gst_trace_text_flush</a>                (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> *trace</code></em>);
  49 #define             <a class="link" href="gstreamer-GstTrace.html#gst-trace-add-entry" title="gst_trace_add_entry()">gst_trace_add_entry</a>                 (trace,
  50                                                          seq,
  51                                                          data,
  52                                                          msg)
  53 #define             <a class="link" href="gstreamer-GstTrace.html#gst-trace-get-size" title="gst_trace_get_size()">gst_trace_get_size</a>                  (trace)
  54 #define             <a class="link" href="gstreamer-GstTrace.html#gst-trace-get-offset" title="gst_trace_get_offset()">gst_trace_get_offset</a>                (trace)
  55 #define             <a class="link" href="gstreamer-GstTrace.html#gst-trace-get-remaining" title="gst_trace_get_remaining()">gst_trace_get_remaining</a>             (trace)
  56 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstTrace.html#gst-trace-set-default" title="gst_trace_set_default ()">gst_trace_set_default</a>               (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> *trace</code></em>);
  57 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstTrace.html#gst-trace-read-tsc" title="gst_trace_read_tsc ()">gst_trace_read_tsc</a>                  (<em class="parameter"><code><span class="type">gint64</span> *dst</code></em>);
  58 enum                <a class="link" href="gstreamer-GstTrace.html#GstAllocTraceFlags" title="enum GstAllocTraceFlags">GstAllocTraceFlags</a>;
  59 struct              <a class="link" href="gstreamer-GstTrace.html#GstAllocTrace" title="struct GstAllocTrace">GstAllocTrace</a>;
  60 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-available" title="gst_alloc_trace_available ()">gst_alloc_trace_available</a>           (<em class="parameter"><code><span class="type">void</span></code></em>);
  61 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-list" title="gst_alloc_trace_list ()">gst_alloc_trace_list</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
  62 <span class="returnvalue">int</span>                 <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-live-all" title="gst_alloc_trace_live_all ()">gst_alloc_trace_live_all</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
  63 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-print-all" title="gst_alloc_trace_print_all ()">gst_alloc_trace_print_all</a>           (<em class="parameter"><code><span class="type">void</span></code></em>);
  64 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-set-flags-all" title="gst_alloc_trace_set_flags_all ()">gst_alloc_trace_set_flags_all</a>       (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstAllocTraceFlags" title="enum GstAllocTraceFlags"><span class="type">GstAllocTraceFlags</span></a> flags</code></em>);
  65 <a class="link" href="gstreamer-GstTrace.html#GstAllocTrace" title="struct GstAllocTrace"><span class="returnvalue">GstAllocTrace</span></a> *     <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-get" title="gst_alloc_trace_get ()">gst_alloc_trace_get</a>                 (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
  66 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-print" title="gst_alloc_trace_print ()">gst_alloc_trace_print</a>               (<em class="parameter"><code>const <a class="link" href="gstreamer-GstTrace.html#GstAllocTrace" title="struct GstAllocTrace"><span class="type">GstAllocTrace</span></a> *trace</code></em>);
  67 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-print-live" title="gst_alloc_trace_print_live ()">gst_alloc_trace_print_live</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
  68 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-set-flags" title="gst_alloc_trace_set_flags ()">gst_alloc_trace_set_flags</a>           (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstAllocTrace" title="struct GstAllocTrace"><span class="type">GstAllocTrace</span></a> *trace</code></em>,
  69                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstAllocTraceFlags" title="enum GstAllocTraceFlags"><span class="type">GstAllocTraceFlags</span></a> flags</code></em>);
  70 #define             <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-register" title="gst_alloc_trace_register()">gst_alloc_trace_register</a>            (name)
  71 #define             <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-new" title="gst_alloc_trace_new()">gst_alloc_trace_new</a>                 (trace,
  72                                                          mem)
  73 #define             <a class="link" href="gstreamer-GstTrace.html#gst-alloc-trace-free" title="gst_alloc_trace_free()">gst_alloc_trace_free</a>                (trace,
  74                                                          mem)
  75 </pre>
  76 </div>
  77 <div class="refsect1">
  78 <a name="gstreamer-GstTrace.description"></a><h2>Description</h2>
  79 <p>
  80 Traces allows to track object allocation. They provide a instance counter per
  81 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>. The counter is incremented for each object allocated and decremented
  82 it when it's freed.
  83 </p>
  84 <p>
  85 </p>
  86 <div class="example">
  87 <a name="idp30456512"></a><p class="title"><b>Example 18. Tracing object instances</b></p>
  88 <div class="example-contents">
  89   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  90     <tbody>
  91       <tr>
  92         <td class="listing_lines" align="right"><pre>1
  93 2
  94 3
  95 4
  96 5
  97 6
  98 7
  99 8</pre></td>
 100         <td class="listing_code"><pre class="programlisting"><span class="gtkdoc slc">// trace un-freed object instances</span>
 101 <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTrace.html#gst-alloc-trace-set-flags-all">gst_alloc_trace_set_flags_all</a></span> <span class="gtkdoc opt">(</span>GST_ALLOC_TRACE_LIVE<span class="gtkdoc opt">);</span>
 102 <span class="keyword">if</span> <span class="gtkdoc opt">(!</span><span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTrace.html#gst-alloc-trace-available">gst_alloc_trace_available</a></span> <span class="gtkdoc opt">()) {</span>
 103   <span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Message-Logging.html#g-warning">g_warning</a></span> <span class="gtkdoc opt">(</span><span class="string">&quot;Trace not available (recompile with trace enabled).&quot;</span><span class="gtkdoc opt">);</span>
 104 <span class="gtkdoc opt">}</span>
 105 <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTrace.html#gst-alloc-trace-print-live">gst_alloc_trace_print_live</a></span> <span class="gtkdoc opt">();</span>
 106 <span class="gtkdoc slc">// do something here</span>
 107 <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTrace.html#gst-alloc-trace-print-live">gst_alloc_trace_print_live</a></span> <span class="gtkdoc opt">();</span></pre></td>
 108       </tr>
 109     </tbody>
 110   </table>
 111 </div>
 112
 113 </div>
 114 <p><br class="example-break">
 115 </p>
 116 <p>
 117 Last reviewed on 2005-11-21 (0.9.5)
 118 </p>
 119 </div>
 120 <div class="refsect1">
 121 <a name="gstreamer-GstTrace.details"></a><h2>Details</h2>
 122 <div class="refsect2">
 123 <a name="GstTrace"></a><h3>struct GstTrace</h3>
 124 <pre class="programlisting">struct GstTrace {
 125 };
 126 </pre>
 127 <p>
 128 Opaque <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> structure.
 129 </p>
 130 </div>
 131 <hr>
 132 <div class="refsect2">
 133 <a name="gst-trace-new"></a><h3>gst_trace_new ()</h3>
 134 <pre class="programlisting"><a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="returnvalue">GstTrace</span></a> *          gst_trace_new                       (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
 135                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>);</pre>
 136 <p>
 137 Create a ringbuffer of <em class="parameter"><code>size</code></em> in the file with <em class="parameter"><code>filename</code></em> to
 138 store trace results in.
 139 </p>
 140 <p>
 141 Free-function: gst_trace_destroy
 142 </p>
 143 <div class="variablelist"><table border="0">
 144 <col align="left" valign="top">
 145 <tbody>
 146 <tr>
 147 <td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
 148 <td>a filename</td>
 149 </tr>
 150 <tr>
 151 <td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
 152 <td>the max size of the file</td>
 153 </tr>
 154 <tr>
 155 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 156 <td>a new <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 157 </td>
 158 </tr>
 159 </tbody>
 160 </table></div>
 161 </div>
 162 <hr>
 163 <div class="refsect2">
 164 <a name="gst-trace-destroy"></a><h3>gst_trace_destroy ()</h3>
 165 <pre class="programlisting"><span class="returnvalue">void</span>                gst_trace_destroy                   (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> *trace</code></em>);</pre>
 166 <p>
 167 Flush an close the previously allocated <em class="parameter"><code>trace</code></em>.
 168 </p>
 169 <div class="variablelist"><table border="0">
 170 <col align="left" valign="top">
 171 <tbody><tr>
 172 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 173 <td>the <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> to destroy. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 174 </td>
 175 </tr></tbody>
 176 </table></div>
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="gst-trace-flush"></a><h3>gst_trace_flush ()</h3>
 181 <pre class="programlisting"><span class="returnvalue">void</span>                gst_trace_flush                     (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> *trace</code></em>);</pre>
 182 <p>
 183 Flush any pending trace entries in <em class="parameter"><code>trace</code></em> to the trace file.
 184 <em class="parameter"><code>trace</code></em> can be NULL in which case the default <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> will be
 185 flushed.
 186 </p>
 187 <div class="variablelist"><table border="0">
 188 <col align="left" valign="top">
 189 <tbody><tr>
 190 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 191 <td>the <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> to flush.</td>
 192 </tr></tbody>
 193 </table></div>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="gst-trace-text-flush"></a><h3>gst_trace_text_flush ()</h3>
 198 <pre class="programlisting"><span class="returnvalue">void</span>                gst_trace_text_flush                (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> *trace</code></em>);</pre>
 199 <p>
 200 Flush any pending trace entries in <em class="parameter"><code>trace</code></em> to the trace file,
 201 formatted as a text line with timestamp and sequence numbers.
 202 <em class="parameter"><code>trace</code></em> can be NULL in which case the default <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> will be
 203 flushed.
 204 </p>
 205 <div class="variablelist"><table border="0">
 206 <col align="left" valign="top">
 207 <tbody><tr>
 208 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 209 <td>the <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> to flush.</td>
 210 </tr></tbody>
 211 </table></div>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="gst-trace-add-entry"></a><h3>gst_trace_add_entry()</h3>
 216 <pre class="programlisting">#define             gst_trace_add_entry(trace,seq,data,msg)</pre>
 217 <p>
 218 Add an entry to <em class="parameter"><code>trace</code></em> with sequence number <em class="parameter"><code>seq</code></em>, <em class="parameter"><code>data</code></em> and <em class="parameter"><code>msg</code></em>.
 219 If <em class="parameter"><code>trace</code></em> is NULL, the entry will be added to the default <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a>.
 220 </p>
 221 <div class="variablelist"><table border="0">
 222 <col align="left" valign="top">
 223 <tbody>
 224 <tr>
 225 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 226 <td>a <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a>
 227 </td>
 228 </tr>
 229 <tr>
 230 <td><p><span class="term"><em class="parameter"><code>seq</code></em> :</span></p></td>
 231 <td>a sequence number</td>
 232 </tr>
 233 <tr>
 234 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 235 <td>the data to trace</td>
 236 </tr>
 237 <tr>
 238 <td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
 239 <td>the trace message</td>
 240 </tr>
 241 </tbody>
 242 </table></div>
 243 </div>
 244 <hr>
 245 <div class="refsect2">
 246 <a name="gst-trace-get-size"></a><h3>gst_trace_get_size()</h3>
 247 <pre class="programlisting">#define     gst_trace_get_size(trace)       ((trace)-&gt;bufsize)
 248 </pre>
 249 <p>
 250 Retrieve the buffer size of <em class="parameter"><code>trace</code></em>.
 251 </p>
 252 <div class="variablelist"><table border="0">
 253 <col align="left" valign="top">
 254 <tbody><tr>
 255 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 256 <td>a <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a>
 257 </td>
 258 </tr></tbody>
 259 </table></div>
 260 </div>
 261 <hr>
 262 <div class="refsect2">
 263 <a name="gst-trace-get-offset"></a><h3>gst_trace_get_offset()</h3>
 264 <pre class="programlisting">#define     gst_trace_get_offset(trace)     ((trace)-&gt;bufoffset)
 265 </pre>
 266 <p>
 267 Retrieve the current buffer offset of <em class="parameter"><code>trace</code></em>.
 268 </p>
 269 <div class="variablelist"><table border="0">
 270 <col align="left" valign="top">
 271 <tbody><tr>
 272 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 273 <td>a <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a>
 274 </td>
 275 </tr></tbody>
 276 </table></div>
 277 </div>
 278 <hr>
 279 <div class="refsect2">
 280 <a name="gst-trace-get-remaining"></a><h3>gst_trace_get_remaining()</h3>
 281 <pre class="programlisting">#define     gst_trace_get_remaining(trace)  ((trace)-&gt;bufsize - (trace)-&gt;bufoffset)
 282 </pre>
 283 <p>
 284 Retrieve the remaining size in the <em class="parameter"><code>trace</code></em> buffer.
 285 </p>
 286 <div class="variablelist"><table border="0">
 287 <col align="left" valign="top">
 288 <tbody><tr>
 289 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 290 <td>a <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a>
 291 </td>
 292 </tr></tbody>
 293 </table></div>
 294 </div>
 295 <hr>
 296 <div class="refsect2">
 297 <a name="gst-trace-set-default"></a><h3>gst_trace_set_default ()</h3>
 298 <pre class="programlisting"><span class="returnvalue">void</span>                gst_trace_set_default               (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> *trace</code></em>);</pre>
 299 <p>
 300 Set the default <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> to <em class="parameter"><code>trace</code></em>.
 301 </p>
 302 <div class="variablelist"><table border="0">
 303 <col align="left" valign="top">
 304 <tbody><tr>
 305 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 306 <td>the <a class="link" href="gstreamer-GstTrace.html#GstTrace" title="struct GstTrace"><span class="type">GstTrace</span></a> to set as the default.</td>
 307 </tr></tbody>
 308 </table></div>
 309 </div>
 310 <hr>
 311 <div class="refsect2">
 312 <a name="gst-trace-read-tsc"></a><h3>gst_trace_read_tsc ()</h3>
 313 <pre class="programlisting"><span class="returnvalue">void</span>                gst_trace_read_tsc                  (<em class="parameter"><code><span class="type">gint64</span> *dst</code></em>);</pre>
 314 <p>
 315 Read a platform independent timer value that can be used in
 316 benchmarks.
 317 </p>
 318 <div class="variablelist"><table border="0">
 319 <col align="left" valign="top">
 320 <tbody><tr>
 321 <td><p><span class="term"><em class="parameter"><code>dst</code></em> :</span></p></td>
 322 <td>(out) pointer to hold the result.</td>
 323 </tr></tbody>
 324 </table></div>
 325 </div>
 326 <hr>
 327 <div class="refsect2">
 328 <a name="GstAllocTraceFlags"></a><h3>enum GstAllocTraceFlags</h3>
 329 <pre class="programlisting">typedef enum {
 330   GST_ALLOC_TRACE_NONE      = 0,
 331   GST_ALLOC_TRACE_LIVE      = (1 &lt;&lt; 0),
 332   GST_ALLOC_TRACE_MEM_LIVE = (1 &lt;&lt; 1)
 333 } GstAllocTraceFlags;
 334 </pre>
 335 <p>
 336 Flags indicating which tracing feature to enable.
 337 </p>
 338 <div class="variablelist"><table border="0">
 339 <col align="left" valign="top">
 340 <tbody>
 341 <tr>
 342 <td><p><a name="GST-ALLOC-TRACE-NONE:CAPS"></a><span class="term"><code class="literal">GST_ALLOC_TRACE_NONE</code></span></p></td>
 343 <td>No tracing specified or desired. Since 0.10.36.
 344 </td>
 345 </tr>
 346 <tr>
 347 <td><p><a name="GST-ALLOC-TRACE-LIVE:CAPS"></a><span class="term"><code class="literal">GST_ALLOC_TRACE_LIVE</code></span></p></td>
 348 <td>Trace number of non-freed memory.
 349 </td>
 350 </tr>
 351 <tr>
 352 <td><p><a name="GST-ALLOC-TRACE-MEM-LIVE:CAPS"></a><span class="term"><code class="literal">GST_ALLOC_TRACE_MEM_LIVE</code></span></p></td>
 353 <td>Trace pointers of unfreed memory.
 354 </td>
 355 </tr>
 356 </tbody>
 357 </table></div>
 358 </div>
 359 <hr>
 360 <div class="refsect2">
 361 <a name="GstAllocTrace"></a><h3>struct GstAllocTrace</h3>
 362 <pre class="programlisting">struct GstAllocTrace {
 363   gchar         *name;
 364   gint           flags;
 365
 366   gint           live;
 367   GSList *mem_live;
 368 };
 369 </pre>
 370 <p>
 371 The main tracing object
 372 </p>
 373 <div class="variablelist"><table border="0">
 374 <col align="left" valign="top">
 375 <tbody>
 376 <tr>
 377 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstAllocTrace.name"></a>name</code></em>;</span></p></td>
 378 <td>The name of the tracing object</td>
 379 </tr>
 380 <tr>
 381 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAllocTrace.flags"></a>flags</code></em>;</span></p></td>
 382 <td>Flags for this object</td>
 383 </tr>
 384 <tr>
 385 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAllocTrace.live"></a>live</code></em>;</span></p></td>
 386 <td>counter for live memory</td>
 387 </tr>
 388 <tr>
 389 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *<em class="structfield"><code><a name="GstAllocTrace.mem-live"></a>mem_live</code></em>;</span></p></td>
 390 <td>list with pointers to unfreed memory</td>
 391 </tr>
 392 </tbody>
 393 </table></div>
 394 </div>
 395 <hr>
 396 <div class="refsect2">
 397 <a name="gst-alloc-trace-available"></a><h3>gst_alloc_trace_available ()</h3>
 398 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_alloc_trace_available           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 399 <p>
 400 Check if alloc tracing was compiled into the core
 401 </p>
 402 <div class="variablelist"><table border="0">
 403 <col align="left" valign="top">
 404 <tbody><tr>
 405 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 406 <td>TRUE if the core was compiled with alloc
 407 tracing enabled.</td>
 408 </tr></tbody>
 409 </table></div>
 410 </div>
 411 <hr>
 412 <div class="refsect2">
 413 <a name="gst-alloc-trace-list"></a><h3>gst_alloc_trace_list ()</h3>
 414 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       gst_alloc_trace_list                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 415 <p>
 416 Get a list of all registered alloc trace objects.
 417 </p>
 418 <div class="variablelist"><table border="0">
 419 <col align="left" valign="top">
 420 <tbody><tr>
 421 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 422 <td>a GList of GstAllocTrace objects.</td>
 423 </tr></tbody>
 424 </table></div>
 425 </div>
 426 <hr>
 427 <div class="refsect2">
 428 <a name="gst-alloc-trace-live-all"></a><h3>gst_alloc_trace_live_all ()</h3>
 429 <pre class="programlisting"><span class="returnvalue">int</span>                 gst_alloc_trace_live_all            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 430 <p>
 431 Get the total number of live registered alloc trace objects.
 432 </p>
 433 <div class="variablelist"><table border="0">
 434 <col align="left" valign="top">
 435 <tbody><tr>
 436 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 437 <td>the total number of live registered alloc trace objects.</td>
 438 </tr></tbody>
 439 </table></div>
 440 </div>
 441 <hr>
 442 <div class="refsect2">
 443 <a name="gst-alloc-trace-print-all"></a><h3>gst_alloc_trace_print_all ()</h3>
 444 <pre class="programlisting"><span class="returnvalue">void</span>                gst_alloc_trace_print_all           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 445 <p>
 446 Print the status of all registered alloc trace objects.
 447 </p>
 448 </div>
 449 <hr>
 450 <div class="refsect2">
 451 <a name="gst-alloc-trace-set-flags-all"></a><h3>gst_alloc_trace_set_flags_all ()</h3>
 452 <pre class="programlisting"><span class="returnvalue">void</span>                gst_alloc_trace_set_flags_all       (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstAllocTraceFlags" title="enum GstAllocTraceFlags"><span class="type">GstAllocTraceFlags</span></a> flags</code></em>);</pre>
 453 <p>
 454 Enable the specified options on all registered alloc trace
 455 objects.
 456 </p>
 457 <div class="variablelist"><table border="0">
 458 <col align="left" valign="top">
 459 <tbody><tr>
 460 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
 461 <td>the options to enable</td>
 462 </tr></tbody>
 463 </table></div>
 464 </div>
 465 <hr>
 466 <div class="refsect2">
 467 <a name="gst-alloc-trace-get"></a><h3>gst_alloc_trace_get ()</h3>
 468 <pre class="programlisting"><a class="link" href="gstreamer-GstTrace.html#GstAllocTrace" title="struct GstAllocTrace"><span class="returnvalue">GstAllocTrace</span></a> *     gst_alloc_trace_get                 (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 469 <p>
 470 Get the named alloc trace object.
 471 </p>
 472 <div class="variablelist"><table border="0">
 473 <col align="left" valign="top">
 474 <tbody>
 475 <tr>
 476 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 477 <td>the name of the alloc trace object</td>
 478 </tr>
 479 <tr>
 480 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 481 <td>a GstAllocTrace with the given name or NULL when
 482 no alloc tracer was registered with that name.</td>
 483 </tr>
 484 </tbody>
 485 </table></div>
 486 </div>
 487 <hr>
 488 <div class="refsect2">
 489 <a name="gst-alloc-trace-print"></a><h3>gst_alloc_trace_print ()</h3>
 490 <pre class="programlisting"><span class="returnvalue">void</span>                gst_alloc_trace_print               (<em class="parameter"><code>const <a class="link" href="gstreamer-GstTrace.html#GstAllocTrace" title="struct GstAllocTrace"><span class="type">GstAllocTrace</span></a> *trace</code></em>);</pre>
 491 <p>
 492 Print the status of the given GstAllocTrace.
 493 </p>
 494 <div class="variablelist"><table border="0">
 495 <col align="left" valign="top">
 496 <tbody><tr>
 497 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 498 <td>the GstAllocTrace to print</td>
 499 </tr></tbody>
 500 </table></div>
 501 </div>
 502 <hr>
 503 <div class="refsect2">
 504 <a name="gst-alloc-trace-print-live"></a><h3>gst_alloc_trace_print_live ()</h3>
 505 <pre class="programlisting"><span class="returnvalue">void</span>                gst_alloc_trace_print_live          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 506 <p>
 507 Print the status of all registered alloc trace objects, ignoring those
 508 without live objects.
 509 </p>
 510 </div>
 511 <hr>
 512 <div class="refsect2">
 513 <a name="gst-alloc-trace-set-flags"></a><h3>gst_alloc_trace_set_flags ()</h3>
 514 <pre class="programlisting"><span class="returnvalue">void</span>                gst_alloc_trace_set_flags           (<em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstAllocTrace" title="struct GstAllocTrace"><span class="type">GstAllocTrace</span></a> *trace</code></em>,
 515                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstTrace.html#GstAllocTraceFlags" title="enum GstAllocTraceFlags"><span class="type">GstAllocTraceFlags</span></a> flags</code></em>);</pre>
 516 <p>
 517 Enable the given features on the given GstAllocTrace object.
 518 </p>
 519 <div class="variablelist"><table border="0">
 520 <col align="left" valign="top">
 521 <tbody>
 522 <tr>
 523 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 524 <td>the GstAllocTrace</td>
 525 </tr>
 526 <tr>
 527 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
 528 <td>flags to set</td>
 529 </tr>
 530 </tbody>
 531 </table></div>
 532 </div>
 533 <hr>
 534 <div class="refsect2">
 535 <a name="gst-alloc-trace-register"></a><h3>gst_alloc_trace_register()</h3>
 536 <pre class="programlisting">#define gst_alloc_trace_register(name) _gst_alloc_trace_register (name);
 537 </pre>
 538 <p>
 539 Register a new alloc tracer with the given name
 540 </p>
 541 <div class="variablelist"><table border="0">
 542 <col align="left" valign="top">
 543 <tbody><tr>
 544 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 545 <td>The name of the tracer object</td>
 546 </tr></tbody>
 547 </table></div>
 548 </div>
 549 <hr>
 550 <div class="refsect2">
 551 <a name="gst-alloc-trace-new"></a><h3>gst_alloc_trace_new()</h3>
 552 <pre class="programlisting">#define             gst_alloc_trace_new(trace, mem)</pre>
 553 <p>
 554 Use the tracer to trace a new memory allocation
 555 </p>
 556 <div class="variablelist"><table border="0">
 557 <col align="left" valign="top">
 558 <tbody>
 559 <tr>
 560 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 561 <td>The tracer to use</td>
 562 </tr>
 563 <tr>
 564 <td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
 565 <td>The memory allocated</td>
 566 </tr>
 567 </tbody>
 568 </table></div>
 569 </div>
 570 <hr>
 571 <div class="refsect2">
 572 <a name="gst-alloc-trace-free"></a><h3>gst_alloc_trace_free()</h3>
 573 <pre class="programlisting">#define             gst_alloc_trace_free(trace, mem)</pre>
 574 <p>
 575 Trace a memory free operation
 576 </p>
 577 <div class="variablelist"><table border="0">
 578 <col align="left" valign="top">
 579 <tbody>
 580 <tr>
 581 <td><p><span class="term"><em class="parameter"><code>trace</code></em> :</span></p></td>
 582 <td>The tracer to use</td>
 583 </tr>
 584 <tr>
 585 <td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
 586 <td>The memory that is freed</td>
 587 </tr>
 588 </tbody>
 589 </table></div>
 590 </div>
 591 </div>
 592 </div>
 593 <div class="footer">
 594 <hr>
 595           Generated by GTK-Doc V1.18</div>
 596 </body>
 597 </html>