2 * Copyright (C) 2007 David Schleef <ds@schleef.org>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
20 #ifndef _GST_APP_SINK_H_
21 #define _GST_APP_SINK_H_
24 #include <gst/base/gstbasesink.h>
25 #include <gst/app/app-prelude.h>
29 #define GST_TYPE_APP_SINK \
30 (gst_app_sink_get_type())
31 #define GST_APP_SINK(obj) \
32 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_APP_SINK,GstAppSink))
33 #define GST_APP_SINK_CLASS(klass) \
34 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_APP_SINK,GstAppSinkClass))
35 #define GST_IS_APP_SINK(obj) \
36 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_APP_SINK))
37 #define GST_IS_APP_SINK_CLASS(klass) \
38 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_APP_SINK))
39 #define GST_APP_SINK_CAST(obj) \
42 typedef struct _GstAppSink GstAppSink;
43 typedef struct _GstAppSinkClass GstAppSinkClass;
44 typedef struct _GstAppSinkPrivate GstAppSinkPrivate;
46 /* FIXME 2.0: Make the instance/class struct private */
49 * GstAppSinkCallbacks: (skip)
50 * @eos: Called when the end-of-stream has been reached. This callback
51 * is called from the streaming thread.
52 * @new_preroll: Called when a new preroll sample is available.
53 * This callback is called from the streaming thread.
54 * The new preroll sample can be retrieved with
55 * gst_app_sink_pull_preroll() either from this callback
56 * or from any other thread.
57 * @new_sample: Called when a new sample is available.
58 * This callback is called from the streaming thread.
59 * The new sample can be retrieved with
60 * gst_app_sink_pull_sample() either from this callback
61 * or from any other thread.
63 * A set of callbacks that can be installed on the appsink with
64 * gst_app_sink_set_callbacks().
67 void (*eos) (GstAppSink *appsink, gpointer user_data);
68 GstFlowReturn (*new_preroll) (GstAppSink *appsink, gpointer user_data);
69 GstFlowReturn (*new_sample) (GstAppSink *appsink, gpointer user_data);
72 gpointer _gst_reserved[GST_PADDING];
73 } GstAppSinkCallbacks;
80 GstAppSinkPrivate *priv;
83 gpointer _gst_reserved[GST_PADDING];
86 struct _GstAppSinkClass
88 GstBaseSinkClass basesink_class;
91 void (*eos) (GstAppSink *appsink);
92 GstFlowReturn (*new_preroll) (GstAppSink *appsink);
93 GstFlowReturn (*new_sample) (GstAppSink *appsink);
96 GstSample * (*pull_preroll) (GstAppSink *appsink);
97 GstSample * (*pull_sample) (GstAppSink *appsink);
98 GstSample * (*try_pull_preroll) (GstAppSink *appsink, GstClockTime timeout);
99 GstSample * (*try_pull_sample) (GstAppSink *appsink, GstClockTime timeout);
102 gpointer _gst_reserved[GST_PADDING - 2];
106 GType gst_app_sink_get_type (void);
109 void gst_app_sink_set_caps (GstAppSink *appsink, const GstCaps *caps);
112 GstCaps * gst_app_sink_get_caps (GstAppSink *appsink);
115 gboolean gst_app_sink_is_eos (GstAppSink *appsink);
118 void gst_app_sink_set_emit_signals (GstAppSink *appsink, gboolean emit);
121 gboolean gst_app_sink_get_emit_signals (GstAppSink *appsink);
124 void gst_app_sink_set_max_buffers (GstAppSink *appsink, guint max);
127 guint gst_app_sink_get_max_buffers (GstAppSink *appsink);
130 void gst_app_sink_set_drop (GstAppSink *appsink, gboolean drop);
133 gboolean gst_app_sink_get_drop (GstAppSink *appsink);
136 void gst_app_sink_set_buffer_list_support (GstAppSink *appsink, gboolean enable_lists);
139 gboolean gst_app_sink_get_buffer_list_support (GstAppSink *appsink);
142 void gst_app_sink_set_wait_on_eos (GstAppSink *appsink, gboolean wait);
145 gboolean gst_app_sink_get_wait_on_eos (GstAppSink *appsink);
148 GstSample * gst_app_sink_pull_preroll (GstAppSink *appsink);
151 GstSample * gst_app_sink_pull_sample (GstAppSink *appsink);
154 GstSample * gst_app_sink_try_pull_preroll (GstAppSink *appsink, GstClockTime timeout);
157 GstSample * gst_app_sink_try_pull_sample (GstAppSink *appsink, GstClockTime timeout);
160 void gst_app_sink_set_callbacks (GstAppSink * appsink,
161 GstAppSinkCallbacks *callbacks,
163 GDestroyNotify notify);
165 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
166 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstAppSink, gst_object_unref)