docs/manual/buffers.xml

   1 <chapter id="chapter-buffers">
   2   <title>Buffers</title>
   3   <para>
   4     Buffers contain the data that will flow through the pipeline you have
   5     created. A source element will typically create a new buffer and pass
   6     it through a pad to the next element in the chain.  When using the
   7     GStreamer infrastructure to create a media pipeline you will not have
   8     to deal with buffers yourself; the elements will do that for you.
   9   </para>
  10   <para>
  11     A buffer consists of:
  12
  13     <itemizedlist>
  14       <listitem>
  15         <para>
  16           a pointer to a piece of memory.
  17         </para>
  18       </listitem>
  19       <listitem>
  20         <para>
  21           the size of the memory.
  22         </para>
  23       </listitem>
  24       <listitem>
  25         <para>
  26           a timestamp for the buffer.
  27         </para>
  28       </listitem>
  29       <listitem>
  30         <para>
  31           A refcount that indicates how many elements are using this
  32           buffer. This refcount will be used to destroy the buffer when no
  33           element has a reference to it.
  34         </para>
  35       </listitem>
  36     </itemizedlist>
  37   </para>
  38
  39   <para>
  40     <!-- FIXME: this is outdated, there is no GstBufferPool in gst-0.8.X -->
  41     GStreamer provides functions to create custom buffer create/destroy algorithms, called
  42     a <classname>GstBufferPool</classname>. This makes it possible to efficiently
  43     allocate and destroy buffer memory. It also makes it possible to exchange memory between
  44     elements by passing the <classname>GstBufferPool</classname>. A video element can,
  45     for example, create a custom buffer allocation algorithm that creates buffers with XSHM
  46     as the buffer memory. An element can use this algorithm to create and fill the buffer
  47     with data.
  48   </para>
  49
  50   <para>
  51     The simple case is that a buffer is created, memory allocated, data put
  52     in it, and passed to the next element.  That element reads the data, does
  53     something (like creating a new buffer and decoding into it), and
  54     unreferences the buffer.  This causes the data to be freed and the buffer
  55     to be destroyed. A typical MPEG audio decoder works like this.
  56   </para>
  57
  58   <para>
  59     A more complex case is when the filter modifies the data in place.  It
  60     does so and simply passes on the buffer to the next element.  This is just
  61     as easy to deal with. An element that works in place has to be careful when
  62     the buffer is used in more than one element; a copy on write has to made in this
  63     situation.
  64   </para>
  65
  66 </chapter>