swfdec-swfdecbuffer.html

Swfdec is a decoder/renderer for Macromedia Flash animations. The decoding and rendering engine is

</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607858"></a><h3>
<a name="swfdec-buffer-new-for-data"></a>swfdec_buffer_new_for_data ()</h3>
<a class="indexterm" name="id2607870"></a><pre class="programlisting"><a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a>*       swfdec_buffer_new_for_data          (unsigned char *data,
                                                         guint size);</pre>
<p>
Takes ownership of <em class="parameter"><code>data</code></em> and creates a new buffer managing it.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td> memory region allocated with <code class="function">g_malloc()</code>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> size of <em class="parameter"><code>data</code></em> in bytes
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer"><span class="type">SwfdecBuffer</span></a> pointing to <em class="parameter"><code>data</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609284"></a><h3>
<a name="swfdec-buffer-new-subbuffer"></a>swfdec_buffer_new_subbuffer ()</h3>
<a class="indexterm" name="id2609296"></a><pre class="programlisting"><a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a>*       swfdec_buffer_new_subbuffer         (<a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a> *buffer,
                                                         guint offset,
                                                         guint length);</pre>
<p>
Creates a <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer"><span class="type">SwfdecBuffer</span></a> for managing a partial section of the memory pointed
to by <em class="parameter"><code>buffer</code></em>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>buffer</code></em>&#160;:</span></td>
<td> <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer"><span class="type">SwfdecBuffer</span></a> managing the region of memory
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>offset</code></em>&#160;:</span></td>
<td> starting offset into data
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
<td> amount of bytes to manage
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer"><span class="type">SwfdecBuffer</span></a> managing the indicated region.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609428"></a><h3>
<a name="swfdec-buffer-new-from-file"></a>swfdec_buffer_new_from_file ()</h3>
<a class="indexterm" name="id2609440"></a><pre class="programlisting"><a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a>*       swfdec_buffer_new_from_file         (const char *filename,
                                                         GError **error);</pre>
<p>
Tries to create a buffer for the given <em class="parameter"><code>filename</code></em> using a <span class="type">GMappedFile</span>. If
the creation fails, <code class="literal">NULL</code> is returned and <em class="parameter"><code>error</code></em> is set. The error can be
any of the errors that are valid from <code class="function">g_mapped_file_new()</code>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
<td> file to read
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td> return location for a <span class="type">GError</span> or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer"><span class="type">SwfdecBuffer</span></a> or <code class="literal">NULL</code> on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609594"></a><h3>
<a name="swfdec-buffer-ref"></a>swfdec_buffer_ref ()</h3>
<a class="indexterm" name="id2609607"></a><pre class="programlisting"><a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a>*       swfdec_buffer_ref                   (<a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a> *buffer);</pre>
<p>
increases the reference count of <em class="parameter"><code>buffer</code></em> by one.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>buffer</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer"><span class="type">SwfdecBuffer</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The passed in <em class="parameter"><code>buffer</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609687"></a><h3>
<a name="swfdec-buffer-unref"></a>swfdec_buffer_unref ()</h3>
<a class="indexterm" name="id2609700"></a><pre class="programlisting">void                swfdec_buffer_unref                 (<a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a> *buffer);</pre>
<p>
Decreases the reference count of <em class="parameter"><code>buffer</code></em> by one. If no reference to this
buffer exists anymore, the buffer and the memory it manages are freed.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>buffer</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer"><span class="type">SwfdecBuffer</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609765"></a><h3>
<a name="swfdec-buffer-queue-new"></a>swfdec_buffer_queue_new ()</h3>
<a class="indexterm" name="id2609776"></a><pre class="programlisting"><a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a>*  swfdec_buffer_queue_new             (void);</pre>
<p>
Creates a new empty buffer queue.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new buffer queue. Use <a href="swfdec-SwfdecBuffer.html#swfdec-buffer-queue-unref"><code class="function">swfdec_buffer_queue_unref()</code></a> to free it.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609825"></a><h3>
<a name="swfdec-buffer-queue-clear"></a>swfdec_buffer_queue_clear ()</h3>
<a class="indexterm" name="id2609837"></a><pre class="programlisting">void                swfdec_buffer_queue_clear           (<a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a> *queue);</pre>
<p>
Resets <em class="parameter"><code>queue</code></em> into to initial state. All buffers it contains will be 
released and the offset will be reset to 0.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>queue</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue"><span class="type">SwfdecBufferQueue</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606860"></a><h3>
<a name="swfdec-buffer-queue-ref"></a>swfdec_buffer_queue_ref ()</h3>
<a class="indexterm" name="id2606872"></a><pre class="programlisting"><a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a>*  swfdec_buffer_queue_ref             (<a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a> *queue);</pre>
<p>
increases the reference count of <em class="parameter"><code>queue</code></em> by one.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>queue</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue"><span class="type">SwfdecBufferQueue</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The passed in <em class="parameter"><code>queue</code></em>.