3 * Copyright (C) 2007 Rene Stadler <mail@renestadler.de>
4 * Copyright (C) 2007-2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
26 #include "gstgiobasesink.h"
28 GST_DEBUG_CATEGORY_STATIC (gst_gio_base_sink_debug);
29 #define GST_CAT_DEFAULT gst_gio_base_sink_debug
31 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
36 GST_BOILERPLATE (GstGioBaseSink, gst_gio_base_sink, GstBaseSink,
39 static void gst_gio_base_sink_finalize (GObject * object);
40 static gboolean gst_gio_base_sink_start (GstBaseSink * base_sink);
41 static gboolean gst_gio_base_sink_stop (GstBaseSink * base_sink);
42 static gboolean gst_gio_base_sink_unlock (GstBaseSink * base_sink);
43 static gboolean gst_gio_base_sink_unlock_stop (GstBaseSink * base_sink);
44 static gboolean gst_gio_base_sink_event (GstBaseSink * base_sink,
46 static GstFlowReturn gst_gio_base_sink_render (GstBaseSink * base_sink,
48 static gboolean gst_gio_base_sink_query (GstPad * pad, GstQuery * query);
51 gst_gio_base_sink_base_init (gpointer gclass)
53 GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
55 GST_DEBUG_CATEGORY_INIT (gst_gio_base_sink_debug, "gio_base_sink", 0,
58 gst_element_class_add_pad_template (element_class,
59 gst_static_pad_template_get (&sink_factory));
63 gst_gio_base_sink_class_init (GstGioBaseSinkClass * klass)
65 GObjectClass *gobject_class = (GObjectClass *) klass;
66 GstBaseSinkClass *gstbasesink_class = (GstBaseSinkClass *) klass;
68 gobject_class->finalize = gst_gio_base_sink_finalize;
70 gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_gio_base_sink_start);
71 gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_gio_base_sink_stop);
72 gstbasesink_class->unlock = GST_DEBUG_FUNCPTR (gst_gio_base_sink_unlock);
73 gstbasesink_class->unlock_stop =
74 GST_DEBUG_FUNCPTR (gst_gio_base_sink_unlock_stop);
75 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_gio_base_sink_event);
76 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_gio_base_sink_render);
80 gst_gio_base_sink_init (GstGioBaseSink * sink, GstGioBaseSinkClass * gclass)
82 gst_pad_set_query_function (GST_BASE_SINK_PAD (sink),
83 GST_DEBUG_FUNCPTR (gst_gio_base_sink_query));
85 gst_base_sink_set_sync (GST_BASE_SINK (sink), FALSE);
87 sink->cancel = g_cancellable_new ();
91 gst_gio_base_sink_finalize (GObject * object)
93 GstGioBaseSink *sink = GST_GIO_BASE_SINK (object);
96 g_object_unref (sink->cancel);
101 g_object_unref (sink->stream);
105 GST_CALL_PARENT (G_OBJECT_CLASS, finalize, (object));
109 gst_gio_base_sink_start (GstBaseSink * base_sink)
111 GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
112 GstGioBaseSinkClass *gbsink_class = GST_GIO_BASE_SINK_GET_CLASS (sink);
116 /* FIXME: This will likely block */
117 sink->stream = gbsink_class->get_stream (sink);
118 if (G_UNLIKELY (!G_IS_OUTPUT_STREAM (sink->stream))) {
119 GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE, (NULL),
120 ("No output stream provided by subclass"));
122 } else if (G_UNLIKELY (g_output_stream_is_closed (sink->stream))) {
123 GST_ELEMENT_ERROR (sink, LIBRARY, FAILED, (NULL),
124 ("Output stream is already closed"));
128 GST_DEBUG_OBJECT (sink, "started sink");
134 gst_gio_base_sink_stop (GstBaseSink * base_sink)
136 GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
137 GstGioBaseSinkClass *klass = GST_GIO_BASE_SINK_GET_CLASS (sink);
141 if (klass->close_on_stop && G_IS_OUTPUT_STREAM (sink->stream)) {
142 GST_DEBUG_OBJECT (sink, "closing stream");
144 /* FIXME: can block but unfortunately we can't use async operations
145 * here because they require a running main loop */
146 success = g_output_stream_close (sink->stream, sink->cancel, &err);
148 if (!success && !gst_gio_error (sink, "g_output_stream_close", &err, NULL)) {
149 GST_ELEMENT_WARNING (sink, RESOURCE, CLOSE, (NULL),
150 ("gio_output_stream_close failed: %s", err->message));
151 g_clear_error (&err);
152 } else if (!success) {
153 GST_ELEMENT_WARNING (sink, RESOURCE, CLOSE, (NULL),
154 ("g_output_stream_close failed"));
156 GST_DEBUG_OBJECT (sink, "g_outut_stream_close succeeded");
159 g_object_unref (sink->stream);
162 success = g_output_stream_flush (sink->stream, sink->cancel, &err);
164 if (!success && !gst_gio_error (sink, "g_output_stream_flush", &err, NULL)) {
165 GST_ELEMENT_WARNING (sink, RESOURCE, CLOSE, (NULL),
166 ("gio_output_stream_flush failed: %s", err->message));
167 g_clear_error (&err);
168 } else if (!success) {
169 GST_ELEMENT_WARNING (sink, RESOURCE, CLOSE, (NULL),
170 ("g_output_stream_flush failed"));
172 GST_DEBUG_OBJECT (sink, "g_outut_stream_flush succeeded");
175 g_object_unref (sink->stream);
183 gst_gio_base_sink_unlock (GstBaseSink * base_sink)
185 GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
187 GST_LOG_OBJECT (sink, "triggering cancellation");
189 g_cancellable_cancel (sink->cancel);
195 gst_gio_base_sink_unlock_stop (GstBaseSink * base_sink)
197 GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
199 GST_LOG_OBJECT (sink, "resetting cancellable");
201 g_cancellable_reset (sink->cancel);
207 gst_gio_base_sink_event (GstBaseSink * base_sink, GstEvent * event)
209 GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
210 GstFlowReturn ret = GST_FLOW_OK;
212 if (sink->stream == NULL)
215 switch (GST_EVENT_TYPE (event)) {
216 case GST_EVENT_NEWSEGMENT:
217 if (G_IS_OUTPUT_STREAM (sink->stream)) {
221 gst_event_parse_new_segment (event, NULL, NULL, &format, &offset, NULL,
224 if (format != GST_FORMAT_BYTES) {
225 GST_WARNING_OBJECT (sink, "ignored NEWSEGMENT event in %s format",
226 gst_format_get_name (format));
230 if (GST_GIO_STREAM_IS_SEEKABLE (sink->stream)) {
231 ret = gst_gio_seek (sink, G_SEEKABLE (sink->stream), offset,
233 if (ret == GST_FLOW_OK)
234 sink->position = offset;
236 ret = GST_FLOW_NOT_SUPPORTED;
242 case GST_EVENT_FLUSH_START:
243 if (G_IS_OUTPUT_STREAM (sink->stream)) {
247 success = g_output_stream_flush (sink->stream, sink->cancel, &err);
249 if (!success && !gst_gio_error (sink, "g_output_stream_flush", &err,
251 GST_ELEMENT_ERROR (sink, RESOURCE, WRITE, (NULL),
252 ("flush failed: %s", err->message));
253 g_clear_error (&err);
262 return (ret == GST_FLOW_OK);
266 gst_gio_base_sink_render (GstBaseSink * base_sink, GstBuffer * buffer)
268 GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
273 g_return_val_if_fail (G_IS_OUTPUT_STREAM (sink->stream), GST_FLOW_ERROR);
275 GST_LOG_OBJECT (sink, "writing %u bytes to offset %" G_GUINT64_FORMAT,
276 GST_BUFFER_SIZE (buffer), sink->position);
278 written = g_output_stream_write (sink->stream,
279 GST_BUFFER_DATA (buffer), GST_BUFFER_SIZE (buffer), sink->cancel, &err);
281 success = (written >= 0);
283 if (G_UNLIKELY (success && written < GST_BUFFER_SIZE (buffer))) {
284 /* FIXME: Can this happen? Should we handle it gracefully? gnomevfssink
286 GST_ELEMENT_ERROR (sink, RESOURCE, WRITE, (NULL),
287 ("Could not write to stream: (short write, only %"
288 G_GSSIZE_FORMAT " bytes of %d bytes written)",
289 written, GST_BUFFER_SIZE (buffer)));
290 return GST_FLOW_ERROR;
294 sink->position += written;
300 if (!gst_gio_error (sink, "g_output_stream_write", &err, &ret)) {
301 if (GST_GIO_ERROR_MATCHES (err, NO_SPACE)) {
302 GST_ELEMENT_ERROR (sink, RESOURCE, NO_SPACE_LEFT, (NULL),
303 ("Could not write to stream: %s", err->message));
305 GST_ELEMENT_ERROR (sink, RESOURCE, WRITE, (NULL),
306 ("Could not write to stream: %s", err->message));
308 g_clear_error (&err);
316 gst_gio_base_sink_query (GstPad * pad, GstQuery * query)
318 GstGioBaseSink *sink = GST_GIO_BASE_SINK (GST_PAD_PARENT (pad));
321 switch (GST_QUERY_TYPE (query)) {
322 case GST_QUERY_POSITION:
323 gst_query_parse_position (query, &format, NULL);
325 case GST_FORMAT_BYTES:
326 case GST_FORMAT_DEFAULT:
327 gst_query_set_position (query, GST_FORMAT_BYTES, sink->position);
332 case GST_QUERY_FORMATS:
333 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
336 if (GST_IS_URI_HANDLER (sink)) {
339 uri = gst_uri_handler_get_uri (GST_URI_HANDLER (sink));
340 gst_query_set_uri (query, uri);
345 return gst_pad_query_default (pad, query);