gstreamer/subprojects/gst-plugins-base/gst-libs/gst/app/gstappsink.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

213 lines
7.1 KiB
C
Raw Normal View History

/* GStreamer
* Copyright (C) 2007 David Schleef <ds@schleef.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef _GST_APP_SINK_H_
#define _GST_APP_SINK_H_
#include <gst/gst.h>
#include <gst/base/gstbasesink.h>
#include <gst/app/app-prelude.h>
G_BEGIN_DECLS
#define GST_TYPE_APP_SINK \
(gst_app_sink_get_type())
#define GST_APP_SINK(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_APP_SINK,GstAppSink))
#define GST_APP_SINK_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_APP_SINK,GstAppSinkClass))
#define GST_IS_APP_SINK(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_APP_SINK))
#define GST_IS_APP_SINK_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_APP_SINK))
#define GST_APP_SINK_CAST(obj) \
((GstAppSink*)(obj))
typedef struct _GstAppSink GstAppSink;
typedef struct _GstAppSinkClass GstAppSinkClass;
gst-libs/gst/app/: Move private data into a private instance struct. Add padding to instance and class structures exp... Original commit message from CVS: * gst-libs/gst/app/gstappsink.c: (_GstAppSinkPrivate), (gst_app_sink_class_init), (gst_app_sink_init), (gst_app_sink_dispose), (gst_app_sink_finalize), (gst_app_sink_unlock_start), (gst_app_sink_unlock_stop), (gst_app_sink_flush_unlocked), (gst_app_sink_start), (gst_app_sink_stop), (gst_app_sink_event), (gst_app_sink_preroll), (gst_app_sink_render), (gst_app_sink_getcaps), (gst_app_sink_set_caps), (gst_app_sink_get_caps), (gst_app_sink_is_eos), (gst_app_sink_set_emit_signals), (gst_app_sink_get_emit_signals), (gst_app_sink_set_max_buffers), (gst_app_sink_get_max_buffers), (gst_app_sink_set_drop), (gst_app_sink_get_drop), (gst_app_sink_pull_preroll), (gst_app_sink_pull_buffer):: * gst-libs/gst/app/gstappsink.h: (GstAppSinkPrivate), (_GstAppSink):: * gst-libs/gst/app/gstappsrc.c: (_GstAppSrcPrivate), (gst_app_src_class_init), (gst_app_src_init), (gst_app_src_flush_queued), (gst_app_src_dispose), (gst_app_src_finalize), (gst_app_src_set_property), (gst_app_src_get_property), (gst_app_src_unlock), (gst_app_src_unlock_stop), (gst_app_src_start), (gst_app_src_stop), (gst_app_src_is_seekable), (gst_app_src_check_get_range), (gst_app_src_query), (gst_app_src_do_seek), (gst_app_src_create), (gst_app_src_set_caps), (gst_app_src_get_caps), (gst_app_src_set_size), (gst_app_src_get_size), (gst_app_src_set_stream_type), (gst_app_src_get_stream_type), (gst_app_src_set_max_bytes), (gst_app_src_get_max_bytes), (gst_app_src_set_latencies), (gst_app_src_set_latency), (gst_app_src_get_latency), (gst_app_src_push_buffer_full), (gst_app_src_push_buffer_action), (gst_app_src_end_of_stream):: * gst-libs/gst/app/gstappsrc.h: (GstAppSrcPrivate):: Move private data into a private instance struct. Add padding to instance and class structures exposed in public headers. Add Since markers to the gtk-doc blurbs (#566750).
2009-01-06 10:56:45 +00:00
typedef struct _GstAppSinkPrivate GstAppSinkPrivate;
/* FIXME 2.0: Make the instance/class struct private */
/**
* GstAppSinkCallbacks: (skip)
* @eos: Called when the end-of-stream has been reached. This callback
* is called from the streaming thread.
* @new_preroll: Called when a new preroll sample is available.
* This callback is called from the streaming thread.
* The new preroll sample can be retrieved with
* gst_app_sink_pull_preroll() either from this callback
* or from any other thread.
* @new_sample: Called when a new sample is available.
* This callback is called from the streaming thread.
* The new sample can be retrieved with
* gst_app_sink_pull_sample() either from this callback
* or from any other thread.
* @new_event: Called when a new event is available.
* This callback is called from the streaming thread.
* The new event can be retrieved with
* gst_app_sink_pull_event() either from this callback
* or from any other thread.
* The callback should return %TRUE if the event has been handled,
* %FALSE otherwise.
* Since: 1.20
* @propose_allocation: Called when the propose_allocation query is available.
* This callback is called from the streaming thread.
* The allocation query can be retrieved with
* gst_app_sink_propose_allocation() either from this callback
* or from any other thread.
* Since: 1.24
*
* A set of callbacks that can be installed on the appsink with
* gst_app_sink_set_callbacks().
*/
typedef struct {
void (*eos) (GstAppSink *appsink, gpointer user_data);
GstFlowReturn (*new_preroll) (GstAppSink *appsink, gpointer user_data);
GstFlowReturn (*new_sample) (GstAppSink *appsink, gpointer user_data);
gboolean (*new_event) (GstAppSink *appsink, gpointer user_data);
gboolean (*propose_allocation) (GstAppSink *appsink, GstQuery *query, gpointer user_data);
/*< private >*/
gpointer _gst_reserved[GST_PADDING - 2];
} GstAppSinkCallbacks;
struct _GstAppSink
{
GstBaseSink basesink;
/*< private >*/
gst-libs/gst/app/: Move private data into a private instance struct. Add padding to instance and class structures exp... Original commit message from CVS: * gst-libs/gst/app/gstappsink.c: (_GstAppSinkPrivate), (gst_app_sink_class_init), (gst_app_sink_init), (gst_app_sink_dispose), (gst_app_sink_finalize), (gst_app_sink_unlock_start), (gst_app_sink_unlock_stop), (gst_app_sink_flush_unlocked), (gst_app_sink_start), (gst_app_sink_stop), (gst_app_sink_event), (gst_app_sink_preroll), (gst_app_sink_render), (gst_app_sink_getcaps), (gst_app_sink_set_caps), (gst_app_sink_get_caps), (gst_app_sink_is_eos), (gst_app_sink_set_emit_signals), (gst_app_sink_get_emit_signals), (gst_app_sink_set_max_buffers), (gst_app_sink_get_max_buffers), (gst_app_sink_set_drop), (gst_app_sink_get_drop), (gst_app_sink_pull_preroll), (gst_app_sink_pull_buffer):: * gst-libs/gst/app/gstappsink.h: (GstAppSinkPrivate), (_GstAppSink):: * gst-libs/gst/app/gstappsrc.c: (_GstAppSrcPrivate), (gst_app_src_class_init), (gst_app_src_init), (gst_app_src_flush_queued), (gst_app_src_dispose), (gst_app_src_finalize), (gst_app_src_set_property), (gst_app_src_get_property), (gst_app_src_unlock), (gst_app_src_unlock_stop), (gst_app_src_start), (gst_app_src_stop), (gst_app_src_is_seekable), (gst_app_src_check_get_range), (gst_app_src_query), (gst_app_src_do_seek), (gst_app_src_create), (gst_app_src_set_caps), (gst_app_src_get_caps), (gst_app_src_set_size), (gst_app_src_get_size), (gst_app_src_set_stream_type), (gst_app_src_get_stream_type), (gst_app_src_set_max_bytes), (gst_app_src_get_max_bytes), (gst_app_src_set_latencies), (gst_app_src_set_latency), (gst_app_src_get_latency), (gst_app_src_push_buffer_full), (gst_app_src_push_buffer_action), (gst_app_src_end_of_stream):: * gst-libs/gst/app/gstappsrc.h: (GstAppSrcPrivate):: Move private data into a private instance struct. Add padding to instance and class structures exposed in public headers. Add Since markers to the gtk-doc blurbs (#566750).
2009-01-06 10:56:45 +00:00
GstAppSinkPrivate *priv;
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
struct _GstAppSinkClass
{
GstBaseSinkClass basesink_class;
/* signals */
void (*eos) (GstAppSink *appsink);
GstFlowReturn (*new_preroll) (GstAppSink *appsink);
GstFlowReturn (*new_sample) (GstAppSink *appsink);
/* new_event is missing as we ran out padding */
/* actions */
GstSample * (*pull_preroll) (GstAppSink *appsink);
GstSample * (*pull_sample) (GstAppSink *appsink);
GstSample * (*try_pull_preroll) (GstAppSink *appsink, GstClockTime timeout);
GstSample * (*try_pull_sample) (GstAppSink *appsink, GstClockTime timeout);
/**
* GstAppSinkClass::try_pull_object:
*
* See #GstAppSink::try-pull-object: signal.
*
* Since: 1.20
*/
GstMiniObject * (*try_pull_object) (GstAppSink *appsink, GstClockTime timeout);
gst-libs/gst/app/: Move private data into a private instance struct. Add padding to instance and class structures exp... Original commit message from CVS: * gst-libs/gst/app/gstappsink.c: (_GstAppSinkPrivate), (gst_app_sink_class_init), (gst_app_sink_init), (gst_app_sink_dispose), (gst_app_sink_finalize), (gst_app_sink_unlock_start), (gst_app_sink_unlock_stop), (gst_app_sink_flush_unlocked), (gst_app_sink_start), (gst_app_sink_stop), (gst_app_sink_event), (gst_app_sink_preroll), (gst_app_sink_render), (gst_app_sink_getcaps), (gst_app_sink_set_caps), (gst_app_sink_get_caps), (gst_app_sink_is_eos), (gst_app_sink_set_emit_signals), (gst_app_sink_get_emit_signals), (gst_app_sink_set_max_buffers), (gst_app_sink_get_max_buffers), (gst_app_sink_set_drop), (gst_app_sink_get_drop), (gst_app_sink_pull_preroll), (gst_app_sink_pull_buffer):: * gst-libs/gst/app/gstappsink.h: (GstAppSinkPrivate), (_GstAppSink):: * gst-libs/gst/app/gstappsrc.c: (_GstAppSrcPrivate), (gst_app_src_class_init), (gst_app_src_init), (gst_app_src_flush_queued), (gst_app_src_dispose), (gst_app_src_finalize), (gst_app_src_set_property), (gst_app_src_get_property), (gst_app_src_unlock), (gst_app_src_unlock_stop), (gst_app_src_start), (gst_app_src_stop), (gst_app_src_is_seekable), (gst_app_src_check_get_range), (gst_app_src_query), (gst_app_src_do_seek), (gst_app_src_create), (gst_app_src_set_caps), (gst_app_src_get_caps), (gst_app_src_set_size), (gst_app_src_get_size), (gst_app_src_set_stream_type), (gst_app_src_get_stream_type), (gst_app_src_set_max_bytes), (gst_app_src_get_max_bytes), (gst_app_src_set_latencies), (gst_app_src_set_latency), (gst_app_src_get_latency), (gst_app_src_push_buffer_full), (gst_app_src_push_buffer_action), (gst_app_src_end_of_stream):: * gst-libs/gst/app/gstappsrc.h: (GstAppSrcPrivate):: Move private data into a private instance struct. Add padding to instance and class structures exposed in public headers. Add Since markers to the gtk-doc blurbs (#566750).
2009-01-06 10:56:45 +00:00
/*< private >*/
gpointer _gst_reserved[GST_PADDING - 3];
};
GST_APP_API
GType gst_app_sink_get_type (void);
GST_APP_API
void gst_app_sink_set_caps (GstAppSink *appsink, const GstCaps *caps);
GST_APP_API
GstCaps * gst_app_sink_get_caps (GstAppSink *appsink);
GST_APP_API
gboolean gst_app_sink_is_eos (GstAppSink *appsink);
GST_APP_API
void gst_app_sink_set_emit_signals (GstAppSink *appsink, gboolean emit);
GST_APP_API
gboolean gst_app_sink_get_emit_signals (GstAppSink *appsink);
GST_APP_API
void gst_app_sink_set_max_buffers (GstAppSink *appsink, guint max);
GST_APP_API
guint gst_app_sink_get_max_buffers (GstAppSink *appsink);
GST_APP_API
void gst_app_sink_set_max_time (GstAppSink *appsink, GstClockTime max);
GST_APP_API
GstClockTime gst_app_sink_get_max_time (GstAppSink *appsink);
GST_APP_API
void gst_app_sink_set_max_bytes (GstAppSink *appsink, guint64 max);
GST_APP_API
guint64 gst_app_sink_get_max_bytes (GstAppSink *appsink);
GST_APP_API
void gst_app_sink_set_drop (GstAppSink *appsink, gboolean drop);
GST_APP_API
gboolean gst_app_sink_get_drop (GstAppSink *appsink);
GST_APP_API
void gst_app_sink_set_buffer_list_support (GstAppSink *appsink, gboolean enable_lists);
GST_APP_API
gboolean gst_app_sink_get_buffer_list_support (GstAppSink *appsink);
GST_APP_API
void gst_app_sink_set_wait_on_eos (GstAppSink *appsink, gboolean wait);
GST_APP_API
gboolean gst_app_sink_get_wait_on_eos (GstAppSink *appsink);
GST_APP_API
GstSample * gst_app_sink_pull_preroll (GstAppSink *appsink);
GST_APP_API
GstSample * gst_app_sink_pull_sample (GstAppSink *appsink);
GST_APP_API
GstMiniObject * gst_app_sink_pull_object (GstAppSink *appsink);
GST_APP_API
GstSample * gst_app_sink_try_pull_preroll (GstAppSink *appsink, GstClockTime timeout);
GST_APP_API
GstSample * gst_app_sink_try_pull_sample (GstAppSink *appsink, GstClockTime timeout);
GST_APP_API
GstMiniObject * gst_app_sink_try_pull_object (GstAppSink *appsink, GstClockTime timeout);
GST_APP_API
void gst_app_sink_set_callbacks (GstAppSink * appsink,
GstAppSinkCallbacks *callbacks,
2011-11-11 16:52:36 +00:00
gpointer user_data,
GDestroyNotify notify);
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstAppSink, gst_object_unref)
G_END_DECLS
#endif