diff options
Diffstat (limited to 'docs/gst/html/GstBufferPool.html')
| -rw-r--r-- | docs/gst/html/GstBufferPool.html | 140 |
1 files changed, 107 insertions, 33 deletions
diff --git a/docs/gst/html/GstBufferPool.html b/docs/gst/html/GstBufferPool.html index bf42fdc..992011a 100644 --- a/docs/gst/html/GstBufferPool.html +++ b/docs/gst/html/GstBufferPool.html @@ -75,6 +75,14 @@ <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> +<a class="link" href="GstBufferPool.html#gst-buffer-pool-config-validate-params" title="gst_buffer_pool_config_validate_params ()">gst_buffer_pool_config_validate_params</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> <a class="link" href="GstBufferPool.html#gst-buffer-pool-config-get-allocator" title="gst_buffer_pool_config_get_allocator ()">gst_buffer_pool_config_get_allocator</a> <span class="c_punctuation">()</span> </td> </tr> @@ -395,17 +403,81 @@ gst_buffer_pool_config_set_params (<em class="parameter"><code><a class="link" h </div> <hr> <div class="refsect2"> +<a name="gst-buffer-pool-config-validate-params"></a><h3>gst_buffer_pool_config_validate_params ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +gst_buffer_pool_config_validate_params + (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *config</code></em>, + <em class="parameter"><code><a class="link" href="GstCaps.html" title="GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> min_buffers</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> max_buffers</code></em>);</pre> +<p>Validate that changes made to <em class="parameter"><code>config</code></em> + are still valid in the context of the +expected parameters. This function is a helper that can be used to validate +changes made by a pool to a config when <a class="link" href="GstBufferPool.html#gst-buffer-pool-set-config" title="gst_buffer_pool_set_config ()"><code class="function">gst_buffer_pool_set_config()</code></a> +returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>. This expects that <em class="parameter"><code>caps</code></em> + and <em class="parameter"><code>size</code></em> + haven't changed, and that +<em class="parameter"><code>min_buffers</code></em> + aren't lower then what we initially expected. This does not check +if options or allocator parameters.</p> +<div class="refsect3"> +<a name="id-1.3.9.8.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>config</p></td> +<td class="parameter_description"><p> a <a class="link" href="GstBufferPool.html" title="GstBufferPool"><span class="type">GstBufferPool</span></a> configuration. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>caps</p></td> +<td class="parameter_description"><p> the excepted caps of buffers. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>the expected size of each buffer, not including prefix and padding</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>min_buffers</p></td> +<td class="parameter_description"><p>the expected minimum amount of buffers to allocate.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>max_buffers</p></td> +<td class="parameter_description"><p>the expect maximum amount of buffers to allocate or 0 for unlimited.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.9.8.6.6"></a><h4>Returns</h4> +<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if the parameters are valid in this context.</p> +<p></p> +</div> +<p class="since">Since 1.4</p> +</div> +<hr> +<div class="refsect2"> <a name="gst-buffer-pool-config-get-allocator"></a><h3>gst_buffer_pool_config_get_allocator ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_buffer_pool_config_get_allocator (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *config</code></em>, <em class="parameter"><code><a class="link" href="GstAllocator.html" title="GstAllocator"><span class="type">GstAllocator</span></a> **allocator</code></em>, - <em class="parameter"><code><a class="link" href="GstAllocator.html#GstAllocationParams" title="struct GstAllocationParams"><span class="type">GstAllocationParams</span></a> *params</code></em>);</pre> + <em class="parameter"><code><a class="link" href="GstAllocator.html#GstAllocationParams"><span class="type">GstAllocationParams</span></a> *params</code></em>);</pre> <p>Get the <em class="parameter"><code>allocator</code></em> and <em class="parameter"><code>params</code></em> from <em class="parameter"><code>config</code></em> .</p> <div class="refsect3"> -<a name="id-1.3.9.8.6.5"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.7.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -425,14 +497,14 @@ gst_buffer_pool_config_get_allocator (<em class="parameter"><code><a class="link </tr> <tr> <td class="parameter_name"><p>params</p></td> -<td class="parameter_description"><p><a class="link" href="GstAllocator.html#GstAllocationParams" title="struct GstAllocationParams"><span class="type">GstAllocationParams</span></a></p></td> +<td class="parameter_description"><p><a class="link" href="GstAllocator.html#GstAllocationParams"><span class="type">GstAllocationParams</span></a></p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.6.6"></a><h4>Returns</h4> +<a name="id-1.3.9.8.7.6"></a><h4>Returns</h4> <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if the values are set. </p> <p></p> </div> @@ -443,7 +515,7 @@ gst_buffer_pool_config_get_allocator (<em class="parameter"><code><a class="link <pre class="programlisting"><span class="returnvalue">void</span> gst_buffer_pool_config_set_allocator (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *config</code></em>, <em class="parameter"><code><a class="link" href="GstAllocator.html" title="GstAllocator"><span class="type">GstAllocator</span></a> *allocator</code></em>, - <em class="parameter"><code>const <a class="link" href="GstAllocator.html#GstAllocationParams" title="struct GstAllocationParams"><span class="type">GstAllocationParams</span></a> *params</code></em>);</pre> + <em class="parameter"><code>const <a class="link" href="GstAllocator.html#GstAllocationParams"><span class="type">GstAllocationParams</span></a> *params</code></em>);</pre> <p>Set the <em class="parameter"><code>allocator</code></em> and <em class="parameter"><code>params</code></em> on <em class="parameter"><code>config</code></em> @@ -457,7 +529,7 @@ is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.ht to perform its allocation. When <em class="parameter"><code>param</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the pool will use the provided <em class="parameter"><code>allocator</code></em> - with its default <a class="link" href="GstAllocator.html#GstAllocationParams" title="struct GstAllocationParams"><span class="type">GstAllocationParams</span></a>.</p> + with its default <a class="link" href="GstAllocator.html#GstAllocationParams"><span class="type">GstAllocationParams</span></a>.</p> <p>A call to <a class="link" href="GstBufferPool.html#gst-buffer-pool-set-config" title="gst_buffer_pool_set_config ()"><code class="function">gst_buffer_pool_set_config()</code></a> can update the allocator and params with the values that it is able to do. Some pools are, for example, not able to operate with different allocators or cannot allocate with the values @@ -465,7 +537,7 @@ specified in <em class="parameter"><code>params</code></em> . Use <a class="link" href="GstBufferPool.html#gst-buffer-pool-get-config" title="gst_buffer_pool_get_config ()"><code class="function">gst_buffer_pool_get_config()</code></a> to get the currently used values.</p> <div class="refsect3"> -<a name="id-1.3.9.8.7.7"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.8.7"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -485,7 +557,7 @@ used values.</p> </tr> <tr> <td class="parameter_name"><p>params</p></td> -<td class="parameter_description"><p><a class="link" href="GstAllocator.html#GstAllocationParams" title="struct GstAllocationParams"><span class="type">GstAllocationParams</span></a></p></td> +<td class="parameter_description"><p><a class="link" href="GstAllocator.html#GstAllocationParams"><span class="type">GstAllocationParams</span></a></p></td> <td class="parameter_annotations"> </td> </tr> </tbody> @@ -501,7 +573,7 @@ gst_buffer_pool_config_n_options (<em class="parameter"><code><a class="link" hr <em class="parameter"><code>config</code></em> structure.</p> <div class="refsect3"> -<a name="id-1.3.9.8.8.5"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.9.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -516,7 +588,7 @@ gst_buffer_pool_config_n_options (<em class="parameter"><code><a class="link" hr </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.8.6"></a><h4>Returns</h4> +<a name="id-1.3.9.8.9.6"></a><h4>Returns</h4> <p> the options array size as a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>.</p> <p></p> </div> @@ -534,7 +606,7 @@ the specified option on the buffers that it allocates.</p> <p>The supported options by <em class="parameter"><code>pool</code></em> can be retrieved with <a class="link" href="GstBufferPool.html#gst-buffer-pool-get-options" title="gst_buffer_pool_get_options ()"><code class="function">gst_buffer_pool_get_options()</code></a>.</p> <div class="refsect3"> -<a name="id-1.3.9.8.9.6"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.10.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -567,7 +639,7 @@ gst_buffer_pool_config_get_option (<em class="parameter"><code><a class="link" h of the options API array.</p> <div class="refsect3"> -<a name="id-1.3.9.8.10.5"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.11.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -589,7 +661,7 @@ array.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.10.6"></a><h4>Returns</h4> +<a name="id-1.3.9.8.11.6"></a><h4>Returns</h4> <p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> of the option at <em class="parameter"><code>index</code></em> .</p> <p></p> @@ -605,7 +677,7 @@ gst_buffer_pool_config_has_option (<em class="parameter"><code><a class="link" h contains <em class="parameter"><code>option</code></em> .</p> <div class="refsect3"> -<a name="id-1.3.9.8.11.5"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.12.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -627,7 +699,7 @@ gst_buffer_pool_config_has_option (<em class="parameter"><code><a class="link" h </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.11.6"></a><h4>Returns</h4> +<a name="id-1.3.9.8.12.6"></a><h4>Returns</h4> <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the options array contains <em class="parameter"><code>option</code></em> .</p> <p></p> @@ -643,7 +715,7 @@ gst_buffer_pool_get_options (<em class="parameter"><code><a class="link" href="G . An option would typically be enabled with <a class="link" href="GstBufferPool.html#gst-buffer-pool-config-add-option" title="gst_buffer_pool_config_add_option ()"><code class="function">gst_buffer_pool_config_add_option()</code></a>.</p> <div class="refsect3"> -<a name="id-1.3.9.8.12.5"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.13.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -658,7 +730,7 @@ gst_buffer_pool_get_options (<em class="parameter"><code><a class="link" href="G </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.12.6"></a><h4>Returns</h4> +<a name="id-1.3.9.8.13.6"></a><h4>Returns</h4> <p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of strings. </p> <p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> @@ -673,7 +745,7 @@ gst_buffer_pool_has_option (<em class="parameter"><code><a class="link" href="Gs <p>Check if the bufferpool supports <em class="parameter"><code>option</code></em> .</p> <div class="refsect3"> -<a name="id-1.3.9.8.13.5"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.14.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -695,7 +767,7 @@ gst_buffer_pool_has_option (<em class="parameter"><code><a class="link" href="Gs </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.13.6"></a><h4>Returns</h4> +<a name="id-1.3.9.8.14.6"></a><h4>Returns</h4> <p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of strings.</p> <p></p> </div> @@ -709,7 +781,7 @@ gst_buffer_pool_get_config (<em class="parameter"><code><a class="link" href="Gs can either be modified and used for the <a class="link" href="GstBufferPool.html#gst-buffer-pool-set-config" title="gst_buffer_pool_set_config ()"><code class="function">gst_buffer_pool_set_config()</code></a> call or it must be freed after usage.</p> <div class="refsect3"> -<a name="id-1.3.9.8.14.5"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.15.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -724,7 +796,7 @@ or it must be freed after usage.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.14.6"></a><h4>Returns</h4> +<a name="id-1.3.9.8.15.6"></a><h4>Returns</h4> <p> a copy of the current configuration of <em class="parameter"><code>pool</code></em> . use <a class="link" href="GstStructure.html#gst-structure-free" title="gst_structure_free ()"><code class="function">gst_structure_free()</code></a> after usage or <a class="link" href="GstBufferPool.html#gst-buffer-pool-set-config" title="gst_buffer_pool_set_config ()"><code class="function">gst_buffer_pool_set_config()</code></a>. </p> @@ -737,9 +809,11 @@ or it must be freed after usage.</p> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_buffer_pool_set_config (<em class="parameter"><code><a class="link" href="GstBufferPool.html" title="GstBufferPool"><span class="type">GstBufferPool</span></a> *pool</code></em>, <em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *config</code></em>);</pre> -<p>Set the configuration of the pool. The pool must be inactive and all buffers -allocated form this pool must be returned or else this function will do -nothing and return FALSE.</p> +<p>Set the configuration of the pool. If the pool is already configured, and +the configuration haven't change, this function will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. If the +pool is active, this function will try deactivating it. Buffers allocated +form this pool must be returned or else this function will do nothing and +return FALSE.</p> <p><em class="parameter"><code>config</code></em> is a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> that contains the configuration parameters for the pool. A default and mandatory set of parameters can be configured with @@ -752,7 +826,7 @@ then be retrieved and refined with <a class="link" href="GstBufferPool.html#gst- <p>This function takes ownership of <em class="parameter"><code>config</code></em> .</p> <div class="refsect3"> -<a name="id-1.3.9.8.15.8"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.16.8"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -774,7 +848,7 @@ then be retrieved and refined with <a class="link" href="GstBufferPool.html#gst- </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.15.9"></a><h4>Returns</h4> +<a name="id-1.3.9.8.16.9"></a><h4>Returns</h4> <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when the configuration could be set.</p> <p></p> </div> @@ -794,7 +868,7 @@ the configuration of the pool.</p> buffers. When there are outstanding buffers, they will be freed as soon as they are all returned to the pool.</p> <div class="refsect3"> -<a name="id-1.3.9.8.16.7"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.17.7"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -816,7 +890,7 @@ they are all returned to the pool.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.16.8"></a><h4>Returns</h4> +<a name="id-1.3.9.8.17.8"></a><h4>Returns</h4> <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> when the pool was not configured or when preallocation of the buffers failed.</p> <p></p> @@ -831,7 +905,7 @@ gst_buffer_pool_is_active (<em class="parameter"><code><a class="link" href="Gst is active. A pool can be activated with the <a class="link" href="GstBufferPool.html#gst-buffer-pool-set-active" title="gst_buffer_pool_set_active ()"><code class="function">gst_buffer_pool_set_active()</code></a> call.</p> <div class="refsect3"> -<a name="id-1.3.9.8.17.5"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.18.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -846,7 +920,7 @@ gst_buffer_pool_is_active (<em class="parameter"><code><a class="link" href="Gst </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.17.6"></a><h4>Returns</h4> +<a name="id-1.3.9.8.18.6"></a><h4>Returns</h4> <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when the pool is active.</p> <p></p> </div> @@ -866,7 +940,7 @@ can hold a pointer to the new buffer.</p> can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or contain optional parameters to influence the allocation.</p> <div class="refsect3"> -<a name="id-1.3.9.8.18.6"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.19.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -893,7 +967,7 @@ allocation.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.3.9.8.18.7"></a><h4>Returns</h4> +<a name="id-1.3.9.8.19.7"></a><h4>Returns</h4> <p> a <a class="link" href="GstPad.html#GstFlowReturn" title="enum GstFlowReturn"><span class="type">GstFlowReturn</span></a> such as <a class="link" href="GstPad.html#GST-FLOW-FLUSHING:CAPS"><code class="literal">GST_FLOW_FLUSHING</code></a> when the pool is inactive.</p> <p></p> @@ -915,7 +989,7 @@ gst_buffer_pool_release_buffer (<em class="parameter"><code><a class="link" href disappears.</p> <div class="refsect3"> -<a name="id-1.3.9.8.19.6"></a><h4>Parameters</h4> +<a name="id-1.3.9.8.20.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> |