gstreamer/gst-libs/gst/app/gstappsink.h
Wim Taymans 3928dbbb45 appsink: add docs and signals
Add docs for the new callback.
Add signals for the new buffer-list support.
2009-06-29 12:14:43 +02:00

141 lines
4.9 KiB
C

/* 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., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef _GST_APP_SINK_H_
#define _GST_APP_SINK_H_
#include <gst/gst.h>
#include <gst/base/gstbasesink.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))
/* Since 0.10.23 */
#define GST_APP_SINK_CAST(obj) \
((GstAppSink*)(obj))
typedef struct _GstAppSink GstAppSink;
typedef struct _GstAppSinkClass GstAppSinkClass;
typedef struct _GstAppSinkPrivate GstAppSinkPrivate;
/**
* GstAppSinkCallbacks:
* @eos: Called when the end-of-stream has been reached. This callback
* is called from the steaming thread.
* @new_preroll: Called when a new preroll buffer is available.
* This callback is called from the steaming thread.
* The new preroll buffer can be retrieved with
* gst_app_sink_pull_preroll() either from this callback
* or from any other thread.
* @new_buffer: Called when a new buffer is available.
* This callback is called from the steaming thread.
* The new buffer can be retrieved with
* gst_app_sink_pull_buffer() either from this callback
* or from any other thread.
* @new_buffer_list: Called when a new bufferlist is available.
* This callback is called from the steaming thread.
* The new bufferlist can be retrieved with
* gst_app_sink_pull_buffer_list() either from this callback
* or from any other thread.
*
* A set of callbacks that can be installed on the appsink with
* gst_app_sink_set_callbacks().
*
* Since: 0.10.23
*/
typedef struct {
void (*eos) (GstAppSink *sink, gpointer user_data);
GstFlowReturn (*new_preroll) (GstAppSink *sink, gpointer user_data);
GstFlowReturn (*new_buffer) (GstAppSink *sink, gpointer user_data);
GstFlowReturn (*new_buffer_list) (GstAppSink *sink, gpointer user_data);
/*< private >*/
gpointer _gst_reserved[GST_PADDING - 1];
} GstAppSinkCallbacks;
struct _GstAppSink
{
GstBaseSink basesink;
/*< private >*/
GstAppSinkPrivate *priv;
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
struct _GstAppSinkClass
{
GstBaseSinkClass basesink_class;
/* signals */
void (*eos) (GstAppSink *sink);
void (*new_preroll) (GstAppSink *sink);
void (*new_buffer) (GstAppSink *sink);
/* actions */
GstBuffer * (*pull_preroll) (GstAppSink *sink);
GstBuffer * (*pull_buffer) (GstAppSink *sink);
/* ABI added */
GstBufferList * (*new_buffer_list) (GstAppSink *sink);
GstBufferList * (*pull_buffer_list) (GstAppSink *sink);
/*< private >*/
gpointer _gst_reserved[GST_PADDING - 2];
};
GType gst_app_sink_get_type(void);
void gst_app_sink_set_caps (GstAppSink *appsink, const GstCaps *caps);
GstCaps * gst_app_sink_get_caps (GstAppSink *appsink);
gboolean gst_app_sink_is_eos (GstAppSink *appsink);
void gst_app_sink_set_emit_signals (GstAppSink *appsink, gboolean emit);
gboolean gst_app_sink_get_emit_signals (GstAppSink *appsink);
void gst_app_sink_set_max_buffers (GstAppSink *appsink, guint max);
guint gst_app_sink_get_max_buffers (GstAppSink *appsink);
void gst_app_sink_set_drop (GstAppSink *appsink, gboolean drop);
gboolean gst_app_sink_get_drop (GstAppSink *appsink);
GstBuffer * gst_app_sink_pull_preroll (GstAppSink *appsink);
GstBuffer * gst_app_sink_pull_buffer (GstAppSink *appsink);
GstBufferList * gst_app_sink_pull_buffer_list (GstAppSink *appsink);
void gst_app_sink_set_callbacks (GstAppSink * appsink,
GstAppSinkCallbacks *callbacks,
gpointer user_data,
GDestroyNotify notify);
G_END_DECLS
#endif