mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-16 11:15:31 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: fixup appsrc/sink api docs

Browse source
This commit is contained in:
Stefan Kost 2011-05-23 15:02:27 +03:00
parent d6ea8d5cb3
commit 762bb236fa
4 changed files with 65 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/libs/gst-plugins-base-libs-sections.txt
View file

@ -3,7 +3,6 @@
<FILE>gstappsrc</FILE> <FILE>gstappsrc</FILE>
<TITLE>appsrc</TITLE> <TITLE>appsrc</TITLE>
<INCLUDE>gst/app/gstappsrc.h</INCLUDE> <INCLUDE>gst/app/gstappsrc.h</INCLUDE>
GstAppSrc
GstAppStreamType GstAppStreamType
gst_app_src_set_caps gst_app_src_set_caps
gst_app_src_get_caps gst_app_src_get_caps
@ -36,6 +35,7 @@ GST_IS_APP_BUFFER
GST_IS_APP_BUFFER_CLASS GST_IS_APP_BUFFER_CLASS
GST_TYPE_APP_BUFFER GST_TYPE_APP_BUFFER
<SUBSECTION Private> <SUBSECTION Private>
GstAppSrc
GstAppSrcPrivate GstAppSrcPrivate
GstAppBuffer GstAppBuffer
GstAppBufferClass GstAppBufferClass
@ -48,7 +48,6 @@ gst_app_buffer_new
<FILE>gstappsink</FILE> <FILE>gstappsink</FILE>
<TITLE>appsink</TITLE> <TITLE>appsink</TITLE>
<INCLUDE>gst/app/gstappsink.h</INCLUDE> <INCLUDE>gst/app/gstappsink.h</INCLUDE>
GstAppSink
gst_app_sink_set_caps gst_app_sink_set_caps
gst_app_sink_get_caps gst_app_sink_get_caps
gst_app_sink_is_eos gst_app_sink_is_eos
@ -64,6 +63,7 @@ gst_app_sink_pull_buffer_list
GstAppSinkCallbacks GstAppSinkCallbacks
gst_app_sink_set_callbacks gst_app_sink_set_callbacks
<SUBSECTION Standard> <SUBSECTION Standard>
GstAppSink
GstAppSinkPrivate GstAppSinkPrivate
GstAppSinkClass GstAppSinkClass
GST_APP_SINK GST_APP_SINK

54
gst-libs/gst/app/gstappsink.c
View file

@ -17,22 +17,6 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/**
* SECTION:element-appsink
*
* Appsink is a sink plugin that supports many different methods for making
* the application get a handle on the GStreamer data in a pipeline. Unlike
* most GStreamer elements, Appsink provides external API functions.
*
* For the documentation of the API, please see the
* <link linkend="gst-plugins-base-libs-appsink">libgstapp</link> section in
* the GStreamer Plugins Base Libraries documentation.
*
* Since: 0.10.22
*/
/** /**
* SECTION:gstappsink * SECTION:gstappsink
* @short_description: Easy way for applications to extract buffers from a * @short_description: Easy way for applications to extract buffers from a
@ -303,10 +287,10 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* GstAppSink::new-preroll: * GstAppSink::new-preroll:
* @appsink: the appsink element that emited the signal * @appsink: the appsink element that emited the signal
* *
* Signal that a new preroll buffer is available. * Signal that a new preroll buffer is available.
* *
* This signal is emited from the steaming thread and only when the * This signal is emited from the steaming thread and only when the
* "emit-signals" property is %TRUE. * "emit-signals" property is %TRUE.
* *
* The new preroll buffer can be retrieved with the "pull-preroll" action * The new preroll buffer can be retrieved with the "pull-preroll" action
* signal or gst_app_sink_pull_preroll() either from this signal callback * signal or gst_app_sink_pull_preroll() either from this signal callback
@ -326,7 +310,7 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* Signal that a new buffer is available. * Signal that a new buffer is available.
* *
* This signal is emited from the steaming thread and only when the * This signal is emited from the steaming thread and only when the
* "emit-signals" property is %TRUE. * "emit-signals" property is %TRUE.
* *
* The new buffer can be retrieved with the "pull-buffer" action * The new buffer can be retrieved with the "pull-buffer" action
* signal or gst_app_sink_pull_buffer() either from this signal callback * signal or gst_app_sink_pull_buffer() either from this signal callback
@ -346,7 +330,7 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* Signal that a new bufferlist is available. * Signal that a new bufferlist is available.
* *
* This signal is emited from the steaming thread and only when the * This signal is emited from the steaming thread and only when the
* "emit-signals" property is %TRUE. * "emit-signals" property is %TRUE.
* *
* The new buffer can be retrieved with the "pull-buffer-list" action * The new buffer can be retrieved with the "pull-buffer-list" action
* signal or gst_app_sink_pull_buffer_list() either from this signal callback * signal or gst_app_sink_pull_buffer_list() either from this signal callback
@ -376,10 +360,10 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* when calling gst_app_sink_pull_buffer() or the "pull-buffer" action signal. * when calling gst_app_sink_pull_buffer() or the "pull-buffer" action signal.
* *
* If an EOS event was received before any buffers, this function returns * If an EOS event was received before any buffers, this function returns
* %NULL. Use gst_app_sink_is_eos () to check for the EOS condition. * %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
* *
* This function blocks until a preroll buffer or EOS is received or the appsink * This function blocks until a preroll buffer or EOS is received or the appsink
* element is set to the READY/NULL state. * element is set to the READY/NULL state.
* *
* Returns: a #GstBuffer or NULL when the appsink is stopped or EOS. * Returns: a #GstBuffer or NULL when the appsink is stopped or EOS.
*/ */
@ -393,11 +377,11 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* @appsink: the appsink element to emit this signal on * @appsink: the appsink element to emit this signal on
* *
* This function blocks until a buffer or EOS becomes available or the appsink * This function blocks until a buffer or EOS becomes available or the appsink
* element is set to the READY/NULL state. * element is set to the READY/NULL state.
* *
* This function will only return buffers when the appsink is in the PLAYING * This function will only return buffers when the appsink is in the PLAYING
* state. All rendered buffers will be put in a queue so that the application * state. All rendered buffers will be put in a queue so that the application
* can pull buffers at its own rate. * can pull buffers at its own rate.
* *
* Note that when the application does not pull buffers fast enough, the * Note that when the application does not pull buffers fast enough, the
* queued buffers could consume a lot of memory, especially when dealing with * queued buffers could consume a lot of memory, especially when dealing with
@ -405,7 +389,7 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* the "drop" and "max-buffers" properties. * the "drop" and "max-buffers" properties.
* *
* If an EOS event was received before any buffers, this function returns * If an EOS event was received before any buffers, this function returns
* %NULL. Use gst_app_sink_is_eos () to check for the EOS condition. * %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
* *
* Returns: a #GstBuffer or NULL when the appsink is stopped or EOS. * Returns: a #GstBuffer or NULL when the appsink is stopped or EOS.
*/ */
@ -419,11 +403,11 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* @appsink: the appsink element to emit this signal on * @appsink: the appsink element to emit this signal on
* *
* This function blocks until a buffer list or EOS becomes available or the appsink * This function blocks until a buffer list or EOS becomes available or the appsink
* element is set to the READY/NULL state. * element is set to the READY/NULL state.
* *
* This function will only return bufferlists when the appsink is in the PLAYING * This function will only return bufferlists when the appsink is in the PLAYING
* state. All rendered bufferlists will be put in a queue so that the application * state. All rendered bufferlists will be put in a queue so that the application
* can pull bufferlists at its own rate. * can pull bufferlists at its own rate.
* *
* Note that when the application does not pull bufferlists fast enough, the * Note that when the application does not pull bufferlists fast enough, the
* queued bufferlists could consume a lot of memory, especially when dealing with * queued bufferlists could consume a lot of memory, especially when dealing with
@ -431,7 +415,7 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* the "drop" and "max-buffers" properties. * the "drop" and "max-buffers" properties.
* *
* If an EOS event was received before any buffers, this function returns * If an EOS event was received before any buffers, this function returns
* %NULL. Use gst_app_sink_is_eos () to check for the EOS condition. * %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
* *
* Returns: a #GstBufferList or NULL when the appsink is stopped or EOS. * Returns: a #GstBufferList or NULL when the appsink is stopped or EOS.
*/ */
@ -948,7 +932,7 @@ not_started:
* Set the capabilities on the appsink element. This function takes * Set the capabilities on the appsink element. This function takes
* a copy of the caps structure. After calling this method, the sink will only * a copy of the caps structure. After calling this method, the sink will only
* accept caps that match @caps. If @caps is non-fixed, you must check the caps * accept caps that match @caps. If @caps is non-fixed, you must check the caps
* on the buffers to get the actual used caps. * on the buffers to get the actual used caps.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
@ -1233,10 +1217,10 @@ gst_app_sink_get_drop (GstAppSink * appsink)
* when calling gst_app_sink_pull_buffer(). * when calling gst_app_sink_pull_buffer().
* *
* If an EOS event was received before any buffers, this function returns * If an EOS event was received before any buffers, this function returns
* %NULL. Use gst_app_sink_is_eos () to check for the EOS condition. * %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
* *
* This function blocks until a preroll buffer or EOS is received or the appsink * This function blocks until a preroll buffer or EOS is received or the appsink
* element is set to the READY/NULL state. * element is set to the READY/NULL state.
* *
* Returns: a #GstBuffer or NULL when the appsink is stopped or EOS. * Returns: a #GstBuffer or NULL when the appsink is stopped or EOS.
* *
@ -1295,7 +1279,7 @@ not_started:
* @appsink: a #GstAppSink * @appsink: a #GstAppSink
* *
* This function blocks until a buffer or EOS becomes available or the appsink * This function blocks until a buffer or EOS becomes available or the appsink
* element is set to the READY/NULL state. * element is set to the READY/NULL state.
* *
* This function will only return buffers when the appsink is in the PLAYING * This function will only return buffers when the appsink is in the PLAYING
* state. All rendered buffers will be put in a queue so that the application * state. All rendered buffers will be put in a queue so that the application
@ -1304,7 +1288,7 @@ not_started:
* especially when dealing with raw video frames. * especially when dealing with raw video frames.
* *
* If an EOS event was received before any buffers, this function returns * If an EOS event was received before any buffers, this function returns
* %NULL. Use gst_app_sink_is_eos () to check for the EOS condition. * %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
* *
* Returns: a #GstBuffer or NULL when the appsink is stopped or EOS. * Returns: a #GstBuffer or NULL when the appsink is stopped or EOS.
* *
@ -1323,7 +1307,7 @@ gst_app_sink_pull_buffer (GstAppSink * appsink)
* @appsink: a #GstAppSink * @appsink: a #GstAppSink
* *
* This function blocks until a buffer list or EOS becomes available or the * This function blocks until a buffer list or EOS becomes available or the
* appsink element is set to the READY/NULL state. * appsink element is set to the READY/NULL state.
* *
* This function will only return buffer lists when the appsink is in the * This function will only return buffer lists when the appsink is in the
* PLAYING state. All rendered buffer lists will be put in a queue so that * PLAYING state. All rendered buffer lists will be put in a queue so that
@ -1333,7 +1317,7 @@ gst_app_sink_pull_buffer (GstAppSink * appsink)
* video frames. * video frames.
* *
* If an EOS event was received before any buffer lists, this function returns * If an EOS event was received before any buffer lists, this function returns
* %NULL. Use gst_app_sink_is_eos () to check for the EOS condition. * %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
* *
* Returns: a #GstBufferList or NULL when the appsink is stopped or EOS. * Returns: a #GstBufferList or NULL when the appsink is stopped or EOS.
*/ */

51
gst-libs/gst/app/gstappsrc.c
View file

@ -17,21 +17,6 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/**
* SECTION:element-appsrc
*
* The appsrc element can be used by applications to insert data into a
* GStreamer pipeline. Unlike most GStreamer elements, Appsrc provides
* external API functions.
*
* For the documentation of the API, please see the
* <link linkend="gst-plugins-base-libs-appsrc">libgstapp</link> section in the
* GStreamer Plugins Base Libraries documentation.
*
* Since: 0.10.22
*/
/** /**
* SECTION:gstappsrc * SECTION:gstappsrc
* @short_description: Easy way for applications to inject buffers into a * @short_description: Easy way for applications to inject buffers into a
@ -95,7 +80,7 @@
* For the stream and seekable modes, setting this property is optional but * For the stream and seekable modes, setting this property is optional but
* recommended. * recommended.
* *
* When the application is finished pushing data into appsrc, it should call * When the application is finished pushing data into appsrc, it should call
* gst_app_src_end_of_stream() or emit the end-of-stream action signal. After * gst_app_src_end_of_stream() or emit the end-of-stream action signal. After
* this call, no more buffers can be pushed into appsrc until a flushing seek * this call, no more buffers can be pushed into appsrc until a flushing seek
* happened or the state of the appsrc has gone through READY. * happened or the state of the appsrc has gone through READY.
@ -490,7 +475,7 @@ gst_app_src_class_init (GstAppSrcClass * klass)
* GstAppSrc::end-of-stream: * GstAppSrc::end-of-stream:
* @appsrc: the appsrc * @appsrc: the appsrc
* *
* Notify @appsrc that no more buffer are available. * Notify @appsrc that no more buffer are available.
*/ */
gst_app_src_signals[SIGNAL_END_OF_STREAM] = gst_app_src_signals[SIGNAL_END_OF_STREAM] =
g_signal_new ("end-of-stream", G_TYPE_FROM_CLASS (klass), g_signal_new ("end-of-stream", G_TYPE_FROM_CLASS (klass),
@ -1083,7 +1068,7 @@ seek_error:
* a copy of the caps structure. After calling this method, the source will * a copy of the caps structure. After calling this method, the source will
* only produce caps that match @caps. @caps must be fixed and the caps on the * only produce caps that match @caps. @caps must be fixed and the caps on the
* buffers must match the caps or left NULL. * buffers must match the caps or left NULL.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
void void
@ -1116,7 +1101,7 @@ gst_app_src_set_caps (GstAppSrc * appsrc, const GstCaps * caps)
* Get the configured caps on @appsrc. * Get the configured caps on @appsrc.
* *
* Returns: the #GstCaps produced by the source. gst_caps_unref() after usage. * Returns: the #GstCaps produced by the source. gst_caps_unref() after usage.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
GstCaps * GstCaps *
@ -1144,8 +1129,8 @@ gst_app_src_get_caps (GstAppSrc * appsrc)
* @size: the size to set * @size: the size to set
* *
* Set the size of the stream in bytes. A value of -1 means that the size is * Set the size of the stream in bytes. A value of -1 means that the size is
* not known. * not known.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
void void
@ -1168,10 +1153,10 @@ gst_app_src_set_size (GstAppSrc * appsrc, gint64 size)
* @appsrc: a #GstAppSrc * @appsrc: a #GstAppSrc
* *
* Get the size of the stream in bytes. A value of -1 means that the size is * Get the size of the stream in bytes. A value of -1 means that the size is
* not known. * not known.
* *
* Returns: the size of the stream previously set with gst_app_src_set_size(); * Returns: the size of the stream previously set with gst_app_src_set_size();
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
gint64 gint64
@ -1200,8 +1185,8 @@ gst_app_src_get_size (GstAppSrc * appsrc)
* Set the stream type on @appsrc. For seekable streams, the "seek" signal must * Set the stream type on @appsrc. For seekable streams, the "seek" signal must
* be connected to. * be connected to.
* *
* A stream_type stream * A stream_type stream
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
void void
@ -1227,7 +1212,7 @@ gst_app_src_set_stream_type (GstAppSrc * appsrc, GstAppStreamType type)
* with gst_app_src_set_stream_type(). * with gst_app_src_set_stream_type().
* *
* Returns: the stream type. * Returns: the stream type.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
GstAppStreamType GstAppStreamType
@ -1256,7 +1241,7 @@ gst_app_src_get_stream_type (GstAppSrc * appsrc)
* Set the maximum amount of bytes that can be queued in @appsrc. * Set the maximum amount of bytes that can be queued in @appsrc.
* After the maximum amount of bytes are queued, @appsrc will emit the * After the maximum amount of bytes are queued, @appsrc will emit the
* "enough-data" signal. * "enough-data" signal.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
void void
@ -1285,7 +1270,7 @@ gst_app_src_set_max_bytes (GstAppSrc * appsrc, guint64 max)
* Get the maximum amount of bytes that can be queued in @appsrc. * Get the maximum amount of bytes that can be queued in @appsrc.
* *
* Returns: The maximum amount of bytes that can be queued. * Returns: The maximum amount of bytes that can be queued.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
guint64 guint64
@ -1339,7 +1324,7 @@ gst_app_src_set_latencies (GstAppSrc * appsrc, gboolean do_min, guint64 min,
* *
* Configure the @min and @max latency in @src. If @min is set to -1, the * Configure the @min and @max latency in @src. If @min is set to -1, the
* default latency calculations for pseudo-live sources will be used. * default latency calculations for pseudo-live sources will be used.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
void void
@ -1355,7 +1340,7 @@ gst_app_src_set_latency (GstAppSrc * appsrc, guint64 min, guint64 max)
* @max: the min latency * @max: the min latency
* *
* Retrieve the min and max latencies in @min and @max respectively. * Retrieve the min and max latencies in @min and @max respectively.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
void void
@ -1531,7 +1516,7 @@ eos:
* Returns: #GST_FLOW_OK when the buffer was successfuly queued. * Returns: #GST_FLOW_OK when the buffer was successfuly queued.
* #GST_FLOW_WRONG_STATE when @appsrc is not PAUSED or PLAYING. * #GST_FLOW_WRONG_STATE when @appsrc is not PAUSED or PLAYING.
* #GST_FLOW_UNEXPECTED when EOS occured. * #GST_FLOW_UNEXPECTED when EOS occured.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
GstFlowReturn GstFlowReturn
@ -1557,7 +1542,7 @@ gst_app_src_push_buffer_action (GstAppSrc * appsrc, GstBuffer * buffer)
* *
* Returns: #GST_FLOW_OK when the EOS was successfuly queued. * Returns: #GST_FLOW_OK when the EOS was successfuly queued.
* #GST_FLOW_WRONG_STATE when @appsrc is not PAUSED or PLAYING. * #GST_FLOW_WRONG_STATE when @appsrc is not PAUSED or PLAYING.
* *
* Since: 0.10.22 * Since: 0.10.22
*/ */
GstFlowReturn GstFlowReturn
@ -1570,7 +1555,7 @@ gst_app_src_end_of_stream (GstAppSrc * appsrc)
priv = appsrc->priv; priv = appsrc->priv;
g_mutex_lock (priv->mutex); g_mutex_lock (priv->mutex);
/* can't accept buffers when we are flushing. We can accept them when we are /* can't accept buffers when we are flushing. We can accept them when we are
* EOS although it will not do anything. */ * EOS although it will not do anything. */
if (priv->flushing) if (priv->flushing)
goto flushing; goto flushing;

26
gst/app/gstapp.c
View file

@ -16,6 +16,32 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/**
* SECTION:element-appsrc
*
* The appsrc element can be used by applications to insert data into a
* GStreamer pipeline. Unlike most GStreamer elements, Appsrc provides
* external API functions.
*
* For the documentation of the API, please see the
* <link linkend="gst-plugins-base-libs-appsrc">libgstapp</link> section in the
* GStreamer Plugins Base Libraries documentation.
*
* Since: 0.10.22
*/
/**
* SECTION:element-appsink
*
* Appsink is a sink plugin that supports many different methods for making
* the application get a handle on the GStreamer data in a pipeline. Unlike
* most GStreamer elements, Appsink provides external API functions.
*
* For the documentation of the API, please see the
* <link linkend="gst-plugins-base-libs-appsink">libgstapp</link> section in
* the GStreamer Plugins Base Libraries documentation.
*
* Since: 0.10.22
*/
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "config.h" #include "config.h"