git.maemo.org Git - mafwsubrenderer/blob - gst-plugins-base-subtitles0.10/ext/gio/gstgiobasesink.c

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2007 Rene Stadler <mail@renestadler.de>
   4  * Copyright (C) 2007-2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include "gstgiobasesink.h"
  27
  28 GST_DEBUG_CATEGORY_STATIC (gst_gio_base_sink_debug);
  29 #define GST_CAT_DEFAULT gst_gio_base_sink_debug
  30
  31 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
  32     GST_PAD_SINK,
  33     GST_PAD_ALWAYS,
  34     GST_STATIC_CAPS_ANY);
  35
  36 GST_BOILERPLATE (GstGioBaseSink, gst_gio_base_sink, GstBaseSink,
  37     GST_TYPE_BASE_SINK);
  38
  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,
  45     GstEvent * event);
  46 static GstFlowReturn gst_gio_base_sink_render (GstBaseSink * base_sink,
  47     GstBuffer * buffer);
  48 static gboolean gst_gio_base_sink_query (GstPad * pad, GstQuery * query);
  49
  50 static void
  51 gst_gio_base_sink_base_init (gpointer gclass)
  52 {
  53   GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
  54
  55   GST_DEBUG_CATEGORY_INIT (gst_gio_base_sink_debug, "gio_base_sink", 0,
  56       "GIO base sink");
  57
  58   gst_element_class_add_pad_template (element_class,
  59       gst_static_pad_template_get (&sink_factory));
  60 }
  61
  62 static void
  63 gst_gio_base_sink_class_init (GstGioBaseSinkClass * klass)
  64 {
  65   GObjectClass *gobject_class = (GObjectClass *) klass;
  66   GstBaseSinkClass *gstbasesink_class = (GstBaseSinkClass *) klass;
  67
  68   gobject_class->finalize = gst_gio_base_sink_finalize;
  69
  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);
  77 }
  78
  79 static void
  80 gst_gio_base_sink_init (GstGioBaseSink * sink, GstGioBaseSinkClass * gclass)
  81 {
  82   gst_pad_set_query_function (GST_BASE_SINK_PAD (sink),
  83       GST_DEBUG_FUNCPTR (gst_gio_base_sink_query));
  84
  85   gst_base_sink_set_sync (GST_BASE_SINK (sink), FALSE);
  86
  87   sink->cancel = g_cancellable_new ();
  88 }
  89
  90 static void
  91 gst_gio_base_sink_finalize (GObject * object)
  92 {
  93   GstGioBaseSink *sink = GST_GIO_BASE_SINK (object);
  94
  95   if (sink->cancel) {
  96     g_object_unref (sink->cancel);
  97     sink->cancel = NULL;
  98   }
  99
 100   if (sink->stream) {
 101     g_object_unref (sink->stream);
 102     sink->stream = NULL;
 103   }
 104
 105   GST_CALL_PARENT (G_OBJECT_CLASS, finalize, (object));
 106 }
 107
 108 static gboolean
 109 gst_gio_base_sink_start (GstBaseSink * base_sink)
 110 {
 111   GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
 112   GstGioBaseSinkClass *gbsink_class = GST_GIO_BASE_SINK_GET_CLASS (sink);
 113
 114   sink->position = 0;
 115
 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"));
 121     return FALSE;
 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"));
 125     return FALSE;
 126   }
 127
 128   GST_DEBUG_OBJECT (sink, "started sink");
 129
 130   return TRUE;
 131 }
 132
 133 static gboolean
 134 gst_gio_base_sink_stop (GstBaseSink * base_sink)
 135 {
 136   GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
 137   GstGioBaseSinkClass *klass = GST_GIO_BASE_SINK_GET_CLASS (sink);
 138   gboolean success;
 139   GError *err = NULL;
 140
 141   if (klass->close_on_stop && G_IS_OUTPUT_STREAM (sink->stream)) {
 142     GST_DEBUG_OBJECT (sink, "closing stream");
 143
 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);
 147
 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"));
 155     } else {
 156       GST_DEBUG_OBJECT (sink, "g_outut_stream_close succeeded");
 157     }
 158
 159     g_object_unref (sink->stream);
 160     sink->stream = NULL;
 161   } else {
 162     success = g_output_stream_flush (sink->stream, sink->cancel, &err);
 163
 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"));
 171     } else {
 172       GST_DEBUG_OBJECT (sink, "g_outut_stream_flush succeeded");
 173     }
 174
 175     g_object_unref (sink->stream);
 176     sink->stream = NULL;
 177   }
 178
 179   return TRUE;
 180 }
 181
 182 static gboolean
 183 gst_gio_base_sink_unlock (GstBaseSink * base_sink)
 184 {
 185   GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
 186
 187   GST_LOG_OBJECT (sink, "triggering cancellation");
 188
 189   g_cancellable_cancel (sink->cancel);
 190
 191   return TRUE;
 192 }
 193
 194 static gboolean
 195 gst_gio_base_sink_unlock_stop (GstBaseSink * base_sink)
 196 {
 197   GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
 198
 199   GST_LOG_OBJECT (sink, "resetting cancellable");
 200
 201   g_cancellable_reset (sink->cancel);
 202
 203   return TRUE;
 204 }
 205
 206 static gboolean
 207 gst_gio_base_sink_event (GstBaseSink * base_sink, GstEvent * event)
 208 {
 209   GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
 210   GstFlowReturn ret = GST_FLOW_OK;
 211
 212   if (sink->stream == NULL)
 213     return TRUE;
 214
 215   switch (GST_EVENT_TYPE (event)) {
 216     case GST_EVENT_NEWSEGMENT:
 217       if (G_IS_OUTPUT_STREAM (sink->stream)) {
 218         GstFormat format;
 219         gint64 offset;
 220
 221         gst_event_parse_new_segment (event, NULL, NULL, &format, &offset, NULL,
 222             NULL);
 223
 224         if (format != GST_FORMAT_BYTES) {
 225           GST_WARNING_OBJECT (sink, "ignored NEWSEGMENT event in %s format",
 226               gst_format_get_name (format));
 227           break;
 228         }
 229
 230         if (GST_GIO_STREAM_IS_SEEKABLE (sink->stream)) {
 231           ret = gst_gio_seek (sink, G_SEEKABLE (sink->stream), offset,
 232               sink->cancel);
 233           if (ret == GST_FLOW_OK)
 234             sink->position = offset;
 235         } else {
 236           ret = GST_FLOW_NOT_SUPPORTED;
 237         }
 238       }
 239       break;
 240
 241     case GST_EVENT_EOS:
 242     case GST_EVENT_FLUSH_START:
 243       if (G_IS_OUTPUT_STREAM (sink->stream)) {
 244         gboolean success;
 245         GError *err = NULL;
 246
 247         success = g_output_stream_flush (sink->stream, sink->cancel, &err);
 248
 249         if (!success && !gst_gio_error (sink, "g_output_stream_flush", &err,
 250                 &ret)) {
 251           GST_ELEMENT_ERROR (sink, RESOURCE, WRITE, (NULL),
 252               ("flush failed: %s", err->message));
 253           g_clear_error (&err);
 254         }
 255       }
 256       break;
 257
 258     default:
 259       break;
 260   }
 261
 262   return (ret == GST_FLOW_OK);
 263 }
 264
 265 static GstFlowReturn
 266 gst_gio_base_sink_render (GstBaseSink * base_sink, GstBuffer * buffer)
 267 {
 268   GstGioBaseSink *sink = GST_GIO_BASE_SINK (base_sink);
 269   gssize written;
 270   gboolean success;
 271   GError *err = NULL;
 272
 273   g_return_val_if_fail (G_IS_OUTPUT_STREAM (sink->stream), GST_FLOW_ERROR);
 274
 275   GST_LOG_OBJECT (sink, "writing %u bytes to offset %" G_GUINT64_FORMAT,
 276       GST_BUFFER_SIZE (buffer), sink->position);
 277
 278   written = g_output_stream_write (sink->stream,
 279       GST_BUFFER_DATA (buffer), GST_BUFFER_SIZE (buffer), sink->cancel, &err);
 280
 281   success = (written >= 0);
 282
 283   if (G_UNLIKELY (success && written < GST_BUFFER_SIZE (buffer))) {
 284     /* FIXME: Can this happen?  Should we handle it gracefully?  gnomevfssink
 285      * doesn't... */
 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;
 291   }
 292
 293   if (success) {
 294     sink->position += written;
 295     return GST_FLOW_OK;
 296
 297   } else {
 298     GstFlowReturn ret;
 299
 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));
 304       } else {
 305         GST_ELEMENT_ERROR (sink, RESOURCE, WRITE, (NULL),
 306             ("Could not write to stream: %s", err->message));
 307       }
 308       g_clear_error (&err);
 309     }
 310
 311     return ret;
 312   }
 313 }
 314
 315 static gboolean
 316 gst_gio_base_sink_query (GstPad * pad, GstQuery * query)
 317 {
 318   GstGioBaseSink *sink = GST_GIO_BASE_SINK (GST_PAD_PARENT (pad));
 319   GstFormat format;
 320
 321   switch (GST_QUERY_TYPE (query)) {
 322     case GST_QUERY_POSITION:
 323       gst_query_parse_position (query, &format, NULL);
 324       switch (format) {
 325         case GST_FORMAT_BYTES:
 326         case GST_FORMAT_DEFAULT:
 327           gst_query_set_position (query, GST_FORMAT_BYTES, sink->position);
 328           return TRUE;
 329         default:
 330           return FALSE;
 331       }
 332     case GST_QUERY_FORMATS:
 333       gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
 334       return TRUE;
 335     case GST_QUERY_URI:
 336       if (GST_IS_URI_HANDLER (sink)) {
 337         const gchar *uri;
 338
 339         uri = gst_uri_handler_get_uri (GST_URI_HANDLER (sink));
 340         gst_query_set_uri (query, uri);
 341         return TRUE;
 342       }
 343       return FALSE;
 344     default:
 345       return gst_pad_query_default (pad, query);
 346   }
 347 }