blob: eeb6ce7dd2f2efd7259c50cd8e6161d04f6c8f16 [file] [log] [blame]
/* 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;
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.
*
* 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);
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
} GstAppSinkCallbacks;
struct _GstAppSink
{
GstBaseSink basesink;
/*< private >*/
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);
/* 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);
/*< private >*/
gpointer _gst_reserved[GST_PADDING - 2];
};
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_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
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
void gst_app_sink_set_callbacks (GstAppSink * appsink,
GstAppSinkCallbacks *callbacks,
gpointer user_data,
GDestroyNotify notify);
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstAppSink, gst_object_unref)
#endif
G_END_DECLS
#endif