/* GStreamer
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2000 Wim Taymans <wtay@chello.be>
+ * 2006 Wim Taymans <wim@fluendo.com>
*
- * gstfilesink.c:
+ * gstfilesink.c:
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
-
+/**
+ * SECTION:element-filesink
+ * @see_also: #GstFileSrc
+ *
+ * Write incoming data to a file in the local file system.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch v4l2src num-buffers=1 ! jpegenc ! filesink location=capture1.jpeg
+ * ]| Capture one frame from a v4l2 camera and save as jpeg image.
+ * </refsect2>
+ */
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
-#include "../gst-i18n-lib.h"
+#include "../../gst/gst-i18n-lib.h"
#include <gst/gst.h>
+#include <stdio.h> /* for fseeko() */
+#ifdef HAVE_STDIO_EXT_H
+#include <stdio_ext.h> /* for __fbufsize, for debugging */
+#endif
#include <errno.h>
#include "gstfilesink.h"
#include <string.h>
-#include <sys/stat.h>
#include <sys/types.h>
+
+#ifdef G_OS_WIN32
+#include <io.h> /* lseek, open, close, read */
+#undef lseek
+#define lseek _lseeki64
+#undef off_t
+#define off_t guint64
+#ifdef _MSC_VER /* Check if we are using MSVC, fileno is deprecated in favour */
+#define fileno _fileno /* of _fileno */
+#endif
+#endif
+
+#include <sys/stat.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
+static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
+ GST_PAD_SINK,
+ GST_PAD_ALWAYS,
+ GST_STATIC_CAPS_ANY);
-GST_DEBUG_CATEGORY_STATIC (gst_filesink_debug);
-#define GST_CAT_DEFAULT gst_filesink_debug
+#define GST_TYPE_BUFFER_MODE (buffer_mode_get_type ())
+static GType
+buffer_mode_get_type (void)
+{
+ static GType buffer_mode_type = 0;
+ static const GEnumValue buffer_mode[] = {
+ {-1, "Default buffering", "default"},
+ {_IOFBF, "Fully buffered", "full"},
+ {_IOLBF, "Line buffered", "line"},
+ {_IONBF, "Unbuffered", "unbuffered"},
+ {0, NULL, NULL},
+ };
-GstElementDetails gst_filesink_details = GST_ELEMENT_DETAILS ("File Sink",
- "Sink/File",
- "Write stream to a file",
- "Thomas <thomas@apestaart.org>");
+ if (!buffer_mode_type) {
+ buffer_mode_type =
+ g_enum_register_static ("GstFileSinkBufferMode", buffer_mode);
+ }
+ return buffer_mode_type;
+}
+GST_DEBUG_CATEGORY_STATIC (gst_file_sink_debug);
+#define GST_CAT_DEFAULT gst_file_sink_debug
-/* FileSink signals and args */
-enum
-{
- /* FILL ME */
- SIGNAL_HANDOFF,
- LAST_SIGNAL
-};
+#define DEFAULT_LOCATION NULL
+#define DEFAULT_BUFFER_MODE -1
+#define DEFAULT_BUFFER_SIZE 64 * 1024
+#define DEFAULT_APPEND FALSE
enum
{
- ARG_0,
- ARG_LOCATION
+ PROP_0,
+ PROP_LOCATION,
+ PROP_BUFFER_MODE,
+ PROP_BUFFER_SIZE,
+ PROP_APPEND,
+ PROP_LAST
};
-static const GstFormat *
-gst_filesink_get_formats (GstPad * pad)
+/* Copy of glib's g_fopen due to win32 libc/cross-DLL brokenness: we can't
+ * use the 'file pointer' opened in glib (and returned from this function)
+ * in this library, as they may have unrelated C runtimes. */
+static FILE *
+gst_fopen (const gchar * filename, const gchar * mode)
{
- static const GstFormat formats[] = {
- GST_FORMAT_BYTES,
- 0,
- };
+#ifdef G_OS_WIN32
+ wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
+ wchar_t *wmode;
+ FILE *retval;
+ int save_errno;
+
+ if (wfilename == NULL) {
+ errno = EINVAL;
+ return NULL;
+ }
- return formats;
-}
+ wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
-static const GstQueryType *
-gst_filesink_get_query_types (GstPad * pad)
-{
- static const GstQueryType types[] = {
- GST_QUERY_TOTAL,
- GST_QUERY_POSITION,
- 0
- };
+ if (wmode == NULL) {
+ g_free (wfilename);
+ errno = EINVAL;
+ return NULL;
+ }
+
+ retval = _wfopen (wfilename, wmode);
+ save_errno = errno;
- return types;
+ g_free (wfilename);
+ g_free (wmode);
+
+ errno = save_errno;
+ return retval;
+#else
+ return fopen (filename, mode);
+#endif
}
-static void gst_filesink_dispose (GObject * object);
+static void gst_file_sink_dispose (GObject * object);
-static void gst_filesink_set_property (GObject * object, guint prop_id,
+static void gst_file_sink_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
-static void gst_filesink_get_property (GObject * object, guint prop_id,
+static void gst_file_sink_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
-static gboolean gst_filesink_open_file (GstFileSink * sink);
-static void gst_filesink_close_file (GstFileSink * sink);
+static gboolean gst_file_sink_open_file (GstFileSink * sink);
+static void gst_file_sink_close_file (GstFileSink * sink);
-static gboolean gst_filesink_handle_event (GstPad * pad, GstEvent * event);
-static gboolean gst_filesink_pad_query (GstPad * pad, GstQueryType type,
- GstFormat * format, gint64 * value);
-static void gst_filesink_chain (GstPad * pad, GstData * _data);
+static gboolean gst_file_sink_start (GstBaseSink * sink);
+static gboolean gst_file_sink_stop (GstBaseSink * sink);
+static gboolean gst_file_sink_event (GstBaseSink * sink, GstEvent * event);
+static GstFlowReturn gst_file_sink_render (GstBaseSink * sink,
+ GstBuffer * buffer);
-static void gst_filesink_uri_handler_init (gpointer g_iface,
- gpointer iface_data);
+static gboolean gst_file_sink_do_seek (GstFileSink * filesink,
+ guint64 new_offset);
+static gboolean gst_file_sink_get_current_offset (GstFileSink * filesink,
+ guint64 * p_pos);
-static GstElementStateReturn gst_filesink_change_state (GstElement * element);
-
-static guint gst_filesink_signals[LAST_SIGNAL] = { 0 };
-
-static void
-_do_init (GType filesink_type)
-{
- static const GInterfaceInfo urihandler_info = {
- gst_filesink_uri_handler_init,
- NULL,
- NULL
- };
+static gboolean gst_file_sink_query (GstPad * pad, GstQuery ** query);
- g_type_add_interface_static (filesink_type, GST_TYPE_URI_HANDLER,
- &urihandler_info);
- GST_DEBUG_CATEGORY_INIT (gst_filesink_debug, "filesink", 0,
- "filesink element");
-}
+static void gst_file_sink_uri_handler_init (gpointer g_iface,
+ gpointer iface_data);
-GST_BOILERPLATE_FULL (GstFileSink, gst_filesink, GstElement, GST_TYPE_ELEMENT,
+#define _do_init \
+ G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_file_sink_uri_handler_init); \
+ GST_DEBUG_CATEGORY_INIT (gst_file_sink_debug, "filesink", 0, "filesink element");
+#define gst_file_sink_parent_class parent_class
+G_DEFINE_TYPE_WITH_CODE (GstFileSink, gst_file_sink, GST_TYPE_BASE_SINK,
_do_init);
-
static void
-gst_filesink_base_init (gpointer g_class)
-{
- GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
-
- gstelement_class->change_state = gst_filesink_change_state;
- gst_element_class_set_details (gstelement_class, &gst_filesink_details);
-}
-static void
-gst_filesink_class_init (GstFileSinkClass * klass)
+gst_file_sink_class_init (GstFileSinkClass * klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+ GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
+ GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
+ gobject_class->dispose = gst_file_sink_dispose;
- g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LOCATION,
- g_param_spec_string ("location", "File Location",
- "Location of the file to write", NULL, G_PARAM_READWRITE));
-
- gst_filesink_signals[SIGNAL_HANDOFF] =
- g_signal_new ("handoff", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
- G_STRUCT_OFFSET (GstFileSinkClass, handoff), NULL, NULL,
- g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
+ gobject_class->set_property = gst_file_sink_set_property;
+ gobject_class->get_property = gst_file_sink_get_property;
- gobject_class->set_property = gst_filesink_set_property;
- gobject_class->get_property = gst_filesink_get_property;
- gobject_class->dispose = gst_filesink_dispose;
+ g_object_class_install_property (gobject_class, PROP_LOCATION,
+ g_param_spec_string ("location", "File Location",
+ "Location of the file to write", NULL,
+ G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+ g_object_class_install_property (gobject_class, PROP_BUFFER_MODE,
+ g_param_spec_enum ("buffer-mode", "Buffering mode",
+ "The buffering mode to use", GST_TYPE_BUFFER_MODE,
+ DEFAULT_BUFFER_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+ g_object_class_install_property (gobject_class, PROP_BUFFER_SIZE,
+ g_param_spec_uint ("buffer-size", "Buffering size",
+ "Size of buffer in number of bytes for line or full buffer-mode", 0,
+ G_MAXUINT, DEFAULT_BUFFER_SIZE,
+ G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GstFileSink:append
+ *
+ * Append to an already existing file.
+ *
+ * Since: 0.10.25
+ */
+ g_object_class_install_property (gobject_class, PROP_APPEND,
+ g_param_spec_boolean ("append", "Append",
+ "Append to an already existing file", DEFAULT_APPEND,
+ G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+ gst_element_class_set_details_simple (gstelement_class,
+ "File Sink",
+ "Sink/File", "Write stream to a file",
+ "Thomas Vander Stichele <thomas at apestaart dot org>");
+ gst_element_class_add_pad_template (gstelement_class,
+ gst_static_pad_template_get (&sinktemplate));
+
+ gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_file_sink_start);
+ gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_file_sink_stop);
+ gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_file_sink_render);
+ gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_file_sink_event);
+
+ if (sizeof (off_t) < 8) {
+ GST_LOG ("No large file support, sizeof (off_t) = %" G_GSIZE_FORMAT "!",
+ sizeof (off_t));
+ }
}
+
static void
-gst_filesink_init (GstFileSink * filesink)
+gst_file_sink_init (GstFileSink * filesink)
{
GstPad *pad;
- pad = gst_pad_new ("sink", GST_PAD_SINK);
- gst_element_add_pad (GST_ELEMENT (filesink), pad);
- gst_pad_set_chain_function (pad, gst_filesink_chain);
-
- GST_FLAG_SET (GST_ELEMENT (filesink), GST_ELEMENT_EVENT_AWARE);
+ pad = GST_BASE_SINK_PAD (filesink);
- gst_pad_set_query_function (pad, gst_filesink_pad_query);
- gst_pad_set_query_type_function (pad, gst_filesink_get_query_types);
- gst_pad_set_formats_function (pad, gst_filesink_get_formats);
+ gst_pad_set_query_function (pad, GST_DEBUG_FUNCPTR (gst_file_sink_query));
filesink->filename = NULL;
filesink->file = NULL;
+ filesink->buffer_mode = DEFAULT_BUFFER_MODE;
+ filesink->buffer_size = DEFAULT_BUFFER_SIZE;
+ filesink->buffer = NULL;
+ filesink->append = FALSE;
+
+ gst_base_sink_set_sync (GST_BASE_SINK (filesink), FALSE);
}
+
static void
-gst_filesink_dispose (GObject * object)
+gst_file_sink_dispose (GObject * object)
{
- GstFileSink *sink = GST_FILESINK (object);
+ GstFileSink *sink = GST_FILE_SINK (object);
G_OBJECT_CLASS (parent_class)->dispose (object);
sink->uri = NULL;
g_free (sink->filename);
sink->filename = NULL;
+ g_free (sink->buffer);
+ sink->buffer = NULL;
+ sink->buffer_size = 0;
}
static gboolean
-gst_filesink_set_location (GstFileSink * sink, const gchar * location)
+gst_file_sink_set_location (GstFileSink * sink, const gchar * location)
{
- /* the element must be stopped or paused in order to do this */
- if (GST_STATE (sink) > GST_STATE_PAUSED)
- return FALSE;
- if (GST_STATE (sink) == GST_STATE_PAUSED &&
- GST_FLAG_IS_SET (sink, GST_FILESINK_OPEN))
- return FALSE;
+ if (sink->file)
+ goto was_open;
g_free (sink->filename);
g_free (sink->uri);
if (location != NULL) {
+ /* we store the filename as we received it from the application. On Windows
+ * this should be in UTF8 */
sink->filename = g_strdup (location);
- sink->uri = gst_uri_construct ("file", location);
+ sink->uri = gst_filename_to_uri (location, NULL);
+ GST_INFO ("filename : %s", sink->filename);
+ GST_INFO ("uri : %s", sink->uri);
} else {
sink->filename = NULL;
sink->uri = NULL;
}
- if (GST_STATE (sink) == GST_STATE_PAUSED)
- gst_filesink_open_file (sink);
-
return TRUE;
+
+ /* ERRORS */
+was_open:
+ {
+ g_warning ("Changing the `location' property on filesink when a file is "
+ "open is not supported.");
+ return FALSE;
+ }
}
+
static void
-gst_filesink_set_property (GObject * object, guint prop_id,
+gst_file_sink_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
{
- GstFileSink *sink;
-
- /* it's not null if we got it, but it might not be ours */
- sink = GST_FILESINK (object);
+ GstFileSink *sink = GST_FILE_SINK (object);
switch (prop_id) {
- case ARG_LOCATION:
- gst_filesink_set_location (sink, g_value_get_string (value));
+ case PROP_LOCATION:
+ gst_file_sink_set_location (sink, g_value_get_string (value));
+ break;
+ case PROP_BUFFER_MODE:
+ sink->buffer_mode = g_value_get_enum (value);
+ break;
+ case PROP_BUFFER_SIZE:
+ sink->buffer_size = g_value_get_uint (value);
+ break;
+ case PROP_APPEND:
+ sink->append = g_value_get_boolean (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
static void
-gst_filesink_get_property (GObject * object, guint prop_id, GValue * value,
+gst_file_sink_get_property (GObject * object, guint prop_id, GValue * value,
GParamSpec * pspec)
{
- GstFileSink *sink;
-
- /* it's not null if we got it, but it might not be ours */
- g_return_if_fail (GST_IS_FILESINK (object));
-
- sink = GST_FILESINK (object);
+ GstFileSink *sink = GST_FILE_SINK (object);
switch (prop_id) {
- case ARG_LOCATION:
+ case PROP_LOCATION:
g_value_set_string (value, sink->filename);
break;
+ case PROP_BUFFER_MODE:
+ g_value_set_enum (value, sink->buffer_mode);
+ break;
+ case PROP_BUFFER_SIZE:
+ g_value_set_uint (value, sink->buffer_size);
+ break;
+ case PROP_APPEND:
+ g_value_set_boolean (value, sink->append);
+ break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
static gboolean
-gst_filesink_open_file (GstFileSink * sink)
+gst_file_sink_open_file (GstFileSink * sink)
{
- g_return_val_if_fail (!GST_FLAG_IS_SET (sink, GST_FILESINK_OPEN), FALSE);
+ gint mode;
/* open the file */
- if (sink->filename == NULL || sink->filename[0] == '\0') {
+ if (sink->filename == NULL || sink->filename[0] == '\0')
+ goto no_filename;
+
+ if (sink->append)
+ sink->file = gst_fopen (sink->filename, "ab");
+ else
+ sink->file = gst_fopen (sink->filename, "wb");
+ if (sink->file == NULL)
+ goto open_failed;
+
+ /* see if we are asked to perform a specific kind of buffering */
+ if ((mode = sink->buffer_mode) != -1) {
+ guint buffer_size;
+
+ /* free previous buffer if any */
+ g_free (sink->buffer);
+
+ if (mode == _IONBF) {
+ /* no buffering */
+ sink->buffer = NULL;
+ buffer_size = 0;
+ } else {
+ /* allocate buffer */
+ sink->buffer = g_malloc (sink->buffer_size);
+ buffer_size = sink->buffer_size;
+ }
+#ifdef HAVE_STDIO_EXT_H
+ GST_DEBUG_OBJECT (sink, "change buffer size %u to %u, mode %d",
+ (guint) __fbufsize (sink->file), buffer_size, mode);
+#else
+ GST_DEBUG_OBJECT (sink, "change buffer size to %u, mode %d",
+ sink->buffer_size, mode);
+#endif
+ if (setvbuf (sink->file, sink->buffer, mode, buffer_size) != 0) {
+ GST_WARNING_OBJECT (sink, "warning: setvbuf failed: %s",
+ g_strerror (errno));
+ }
+ }
+
+ sink->current_pos = 0;
+ /* try to seek in the file to figure out if it is seekable */
+ sink->seekable = gst_file_sink_do_seek (sink, 0);
+
+ GST_DEBUG_OBJECT (sink, "opened file %s, seekable %d",
+ sink->filename, sink->seekable);
+
+ return TRUE;
+
+ /* ERRORS */
+no_filename:
+ {
GST_ELEMENT_ERROR (sink, RESOURCE, NOT_FOUND,
(_("No file name specified for writing.")), (NULL));
return FALSE;
}
-
- sink->file = fopen (sink->filename, "w");
- if (sink->file == NULL) {
+open_failed:
+ {
GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE,
(_("Could not open file \"%s\" for writing."), sink->filename),
GST_ERROR_SYSTEM);
return FALSE;
}
-
- GST_FLAG_SET (sink, GST_FILESINK_OPEN);
-
- sink->data_written = 0;
-
- return TRUE;
}
static void
-gst_filesink_close_file (GstFileSink * sink)
+gst_file_sink_close_file (GstFileSink * sink)
{
- g_return_if_fail (GST_FLAG_IS_SET (sink, GST_FILESINK_OPEN));
+ if (sink->file) {
+ if (fclose (sink->file) != 0)
+ goto close_failed;
+
+ GST_DEBUG_OBJECT (sink, "closed file");
+ sink->file = NULL;
+
+ g_free (sink->buffer);
+ sink->buffer = NULL;
+ }
+ return;
- if (fclose (sink->file) != 0) {
+ /* ERRORS */
+close_failed:
+ {
GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
(_("Error closing file \"%s\"."), sink->filename), GST_ERROR_SYSTEM);
- } else {
- GST_FLAG_UNSET (sink, GST_FILESINK_OPEN);
+ return;
}
}
static gboolean
-gst_filesink_pad_query (GstPad * pad, GstQueryType type,
- GstFormat * format, gint64 * value)
+gst_file_sink_query (GstPad * pad, GstQuery ** query)
{
- GstFileSink *sink = GST_FILESINK (GST_PAD_PARENT (pad));
+ GstFileSink *self;
+ GstFormat format;
- switch (type) {
- case GST_QUERY_TOTAL:
- switch (*format) {
- case GST_FORMAT_BYTES:
- if (GST_FLAG_IS_SET (GST_ELEMENT (sink), GST_FILESINK_OPEN)) {
- *value = sink->data_written; /* FIXME - doesn't the kernel provide
- such a function? */
- break;
- }
- default:
- return FALSE;
- }
- break;
+ self = GST_FILE_SINK (GST_PAD_PARENT (pad));
+
+ switch (GST_QUERY_TYPE (*query)) {
case GST_QUERY_POSITION:
- switch (*format) {
+ gst_query_parse_position (*query, &format, NULL);
+ switch (format) {
+ case GST_FORMAT_DEFAULT:
case GST_FORMAT_BYTES:
- if (GST_FLAG_IS_SET (GST_ELEMENT (sink), GST_FILESINK_OPEN)) {
- *value = ftell (sink->file);
- break;
- }
+ gst_query_set_position (*query, GST_FORMAT_BYTES, self->current_pos);
+ return TRUE;
default:
return FALSE;
}
- break;
+
+ case GST_QUERY_FORMATS:
+ gst_query_set_formats (*query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
+ return TRUE;
+
+ case GST_QUERY_URI:
+ gst_query_set_uri (*query, self->uri);
+ return TRUE;
+
default:
- return FALSE;
+ return gst_pad_query_default (pad, query);
}
-
- return TRUE;
}
-/* handle events (search) */
+#ifdef HAVE_FSEEKO
+# define __GST_STDIO_SEEK_FUNCTION "fseeko"
+#elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
+# define __GST_STDIO_SEEK_FUNCTION "lseek"
+#else
+# define __GST_STDIO_SEEK_FUNCTION "fseek"
+#endif
+
static gboolean
-gst_filesink_handle_event (GstPad * pad, GstEvent * event)
+gst_file_sink_do_seek (GstFileSink * filesink, guint64 new_offset)
{
- GstEventType type;
- GstFileSink *filesink;
+ GST_DEBUG_OBJECT (filesink, "Seeking to offset %" G_GUINT64_FORMAT
+ " using " __GST_STDIO_SEEK_FUNCTION, new_offset);
+
+ if (fflush (filesink->file))
+ goto flush_failed;
+
+#ifdef HAVE_FSEEKO
+ if (fseeko (filesink->file, (off_t) new_offset, SEEK_SET) != 0)
+ goto seek_failed;
+#elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
+ if (lseek (fileno (filesink->file), (off_t) new_offset,
+ SEEK_SET) == (off_t) - 1)
+ goto seek_failed;
+#else
+ if (fseek (filesink->file, (long) new_offset, SEEK_SET) != 0)
+ goto seek_failed;
+#endif
- filesink = GST_FILESINK (gst_pad_get_parent (pad));
+ /* adjust position reporting after seek;
+ * presumably this should basically yield new_offset */
+ gst_file_sink_get_current_offset (filesink, &filesink->current_pos);
+ return TRUE;
- if (!(GST_FLAG_IS_SET (filesink, GST_FILESINK_OPEN))) {
- gst_event_unref (event);
+ /* ERRORS */
+flush_failed:
+ {
+ GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
return FALSE;
}
+seek_failed:
+ {
+ GST_DEBUG_OBJECT (filesink, "Seeking failed: %s", g_strerror (errno));
+ return FALSE;
+ }
+}
+/* handle events (search) */
+static gboolean
+gst_file_sink_event (GstBaseSink * sink, GstEvent * event)
+{
+ GstEventType type;
+ GstFileSink *filesink;
- type = event ? GST_EVENT_TYPE (event) : GST_EVENT_UNKNOWN;
+ filesink = GST_FILE_SINK (sink);
- switch (type) {
- case GST_EVENT_SEEK:
- if (GST_EVENT_SEEK_FORMAT (event) != GST_FORMAT_BYTES) {
- gst_event_unref (event);
- return FALSE;
- }
+ type = GST_EVENT_TYPE (event);
- if (GST_EVENT_SEEK_FLAGS (event) & GST_SEEK_FLAG_FLUSH) {
- if (fflush (filesink->file)) {
- gst_event_unref (event);
- GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
- (_("Error while writing to file \"%s\"."), filesink->filename),
- GST_ERROR_SYSTEM);
+ switch (type) {
+ case GST_EVENT_SEGMENT:
+ {
+ GstSegment segment;
+
+ gst_event_parse_segment (event, &segment);
+
+ if (segment.format == GST_FORMAT_BYTES) {
+ /* only try to seek and fail when we are going to a different
+ * position */
+ if (filesink->current_pos != segment.start) {
+ /* FIXME, the seek should be performed on the pos field, start/stop are
+ * just boundaries for valid bytes offsets. We should also fill the file
+ * with zeroes if the new position extends the current EOF (sparse streams
+ * and segment accumulation). */
+ if (!gst_file_sink_do_seek (filesink, (guint64) segment.start))
+ goto seek_failed;
+ } else {
+ GST_DEBUG_OBJECT (filesink, "Ignored SEGMENT, no seek needed");
}
+ } else {
+ GST_DEBUG_OBJECT (filesink,
+ "Ignored SEGMENT event of format %u (%s)", (guint) segment.format,
+ gst_format_get_name (segment.format));
}
-
- switch (GST_EVENT_SEEK_METHOD (event)) {
- case GST_SEEK_METHOD_SET:
- fseek (filesink->file, GST_EVENT_SEEK_OFFSET (event), SEEK_SET);
- break;
- case GST_SEEK_METHOD_CUR:
- fseek (filesink->file, GST_EVENT_SEEK_OFFSET (event), SEEK_CUR);
- break;
- case GST_SEEK_METHOD_END:
- fseek (filesink->file, GST_EVENT_SEEK_OFFSET (event), SEEK_END);
- break;
- default:
- g_warning ("unknown seek method!");
- break;
- }
- gst_event_unref (event);
- break;
- case GST_EVENT_DISCONTINUOUS:
- {
- gint64 offset;
-
- if (gst_event_discont_get_value (event, GST_FORMAT_BYTES, &offset))
- fseek (filesink->file, offset, SEEK_SET);
-
- gst_event_unref (event);
break;
}
- case GST_EVENT_FLUSH:
- if (fflush (filesink->file)) {
- gst_event_unref (event);
- GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
- (_("Error while writing to file \"%s\"."), filesink->filename),
- GST_ERROR_SYSTEM);
- }
- break;
case GST_EVENT_EOS:
- gst_event_unref (event);
- gst_filesink_close_file (filesink);
- gst_element_set_eos (GST_ELEMENT (filesink));
+ if (fflush (filesink->file))
+ goto flush_failed;
break;
default:
- gst_pad_event_default (pad, event);
break;
}
return TRUE;
+
+ /* ERRORS */
+seek_failed:
+ {
+ GST_ELEMENT_ERROR (filesink, RESOURCE, SEEK,
+ (_("Error while seeking in file \"%s\"."), filesink->filename),
+ GST_ERROR_SYSTEM);
+ return FALSE;
+ }
+flush_failed:
+ {
+ GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
+ (_("Error while writing to file \"%s\"."), filesink->filename),
+ GST_ERROR_SYSTEM);
+ return FALSE;
+ }
}
-/**
- * gst_filesink_chain:
- * @pad: the pad this filesink is connected to
- * @buf: the buffer that has to be absorbed
- *
- * take the buffer from the pad and write to file if it's open
- */
-static void
-gst_filesink_chain (GstPad * pad, GstData * _data)
+static gboolean
+gst_file_sink_get_current_offset (GstFileSink * filesink, guint64 * p_pos)
+{
+ off_t ret = -1;
+
+#ifdef HAVE_FTELLO
+ ret = ftello (filesink->file);
+#elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
+ if (fflush (filesink->file)) {
+ GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
+ /* ignore and continue */
+ }
+ ret = lseek (fileno (filesink->file), 0, SEEK_CUR);
+#else
+ ret = (off_t) ftell (filesink->file);
+#endif
+
+ if (ret != (off_t) - 1)
+ *p_pos = (guint64) ret;
+
+ return (ret != (off_t) - 1);
+}
+
+static GstFlowReturn
+gst_file_sink_render (GstBaseSink * sink, GstBuffer * buffer)
{
- GstBuffer *buf = GST_BUFFER (_data);
GstFileSink *filesink;
+ gsize size;
+ guint8 *data;
- g_return_if_fail (pad != NULL);
- g_return_if_fail (GST_IS_PAD (pad));
- g_return_if_fail (buf != NULL);
+ filesink = GST_FILE_SINK (sink);
- filesink = GST_FILESINK (gst_pad_get_parent (pad));
+ data = gst_buffer_map (buffer, &size, NULL, GST_MAP_READ);
- if (GST_IS_EVENT (buf)) {
- gst_filesink_handle_event (pad, GST_EVENT (buf));
- return;
- }
+ GST_DEBUG_OBJECT (filesink, "writing %u bytes at %" G_GUINT64_FORMAT,
+ size, filesink->current_pos);
- if (GST_FLAG_IS_SET (filesink, GST_FILESINK_OPEN)) {
- guint bytes_written = 0, back_pending = 0;
+ if (size > 0 && data != NULL) {
+ if (fwrite (data, size, 1, filesink->file) != 1)
+ goto handle_error;
- if (ftell (filesink->file) < filesink->data_written)
- back_pending = filesink->data_written - ftell (filesink->file);
- while (bytes_written < GST_BUFFER_SIZE (buf)) {
- size_t wrote = fwrite (GST_BUFFER_DATA (buf) + bytes_written, 1,
- GST_BUFFER_SIZE (buf) - bytes_written,
- filesink->file);
+ filesink->current_pos += size;
+ }
+ gst_buffer_unmap (buffer, data, size);
+
+ return GST_FLOW_OK;
- if (wrote <= 0) {
+handle_error:
+ {
+ switch (errno) {
+ case ENOSPC:{
+ GST_ELEMENT_ERROR (filesink, RESOURCE, NO_SPACE_LEFT, (NULL), (NULL));
+ break;
+ }
+ default:{
GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
(_("Error while writing to file \"%s\"."), filesink->filename),
- ("Only %d of %d bytes written: %s",
- bytes_written, GST_BUFFER_SIZE (buf), strerror (errno)));
- break;
+ ("%s", g_strerror (errno)));
}
- bytes_written += wrote;
}
-
- filesink->data_written += bytes_written - back_pending;
+ gst_buffer_unmap (buffer, data, size);
+ return GST_FLOW_ERROR;
}
-
- gst_buffer_unref (buf);
-
- g_signal_emit (G_OBJECT (filesink),
- gst_filesink_signals[SIGNAL_HANDOFF], 0, filesink);
}
-static GstElementStateReturn
-gst_filesink_change_state (GstElement * element)
+static gboolean
+gst_file_sink_start (GstBaseSink * basesink)
{
- g_return_val_if_fail (GST_IS_FILESINK (element), GST_STATE_FAILURE);
-
- switch (GST_STATE_TRANSITION (element)) {
- case GST_STATE_PAUSED_TO_READY:
- if (GST_FLAG_IS_SET (element, GST_FILESINK_OPEN))
- gst_filesink_close_file (GST_FILESINK (element));
- break;
-
- case GST_STATE_READY_TO_PAUSED:
- if (!GST_FLAG_IS_SET (element, GST_FILESINK_OPEN)) {
- if (!gst_filesink_open_file (GST_FILESINK (element)))
- return GST_STATE_FAILURE;
- }
- break;
- }
-
- if (GST_ELEMENT_CLASS (parent_class)->change_state)
- return GST_ELEMENT_CLASS (parent_class)->change_state (element);
+ return gst_file_sink_open_file (GST_FILE_SINK (basesink));
+}
- return GST_STATE_SUCCESS;
+static gboolean
+gst_file_sink_stop (GstBaseSink * basesink)
+{
+ gst_file_sink_close_file (GST_FILE_SINK (basesink));
+ return TRUE;
}
/*** GSTURIHANDLER INTERFACE *************************************************/
-static guint
-gst_filesink_uri_get_type (void)
+static GstURIType
+gst_file_sink_uri_get_type (void)
{
return GST_URI_SINK;
}
+
static gchar **
-gst_filesink_uri_get_protocols (void)
+gst_file_sink_uri_get_protocols (void)
{
- static gchar *protocols[] = { "file", NULL };
+ static gchar *protocols[] = { (char *) "file", NULL };
return protocols;
}
+
static const gchar *
-gst_filesink_uri_get_uri (GstURIHandler * handler)
+gst_file_sink_uri_get_uri (GstURIHandler * handler)
{
- GstFileSink *sink = GST_FILESINK (handler);
+ GstFileSink *sink = GST_FILE_SINK (handler);
return sink->uri;
}
static gboolean
-gst_filesink_uri_set_uri (GstURIHandler * handler, const gchar * uri)
+gst_file_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri)
{
gchar *protocol, *location;
gboolean ret;
- GstFileSink *sink = GST_FILESINK (handler);
+ GstFileSink *sink = GST_FILE_SINK (handler);
protocol = gst_uri_get_protocol (uri);
if (strcmp (protocol, "file") != 0) {
return FALSE;
}
g_free (protocol);
- location = gst_uri_get_location (uri);
- ret = gst_filesink_set_location (sink, location);
+
+ /* allow file://localhost/foo/bar by stripping localhost but fail
+ * for every other hostname */
+ if (g_str_has_prefix (uri, "file://localhost/")) {
+ char *tmp;
+
+ /* 16 == strlen ("file://localhost") */
+ tmp = g_strconcat ("file://", uri + 16, NULL);
+ /* we use gst_uri_get_location() although we already have the
+ * "location" with uri + 16 because it provides unescaping */
+ location = gst_uri_get_location (tmp);
+ g_free (tmp);
+ } else if (strcmp (uri, "file://") == 0) {
+ /* Special case for "file://" as this is used by some applications
+ * to test with gst_element_make_from_uri if there's an element
+ * that supports the URI protocol. */
+ gst_file_sink_set_location (sink, NULL);
+ return TRUE;
+ } else {
+ location = gst_uri_get_location (uri);
+ }
+
+ if (!location)
+ return FALSE;
+ if (!g_path_is_absolute (location)) {
+ g_free (location);
+ return FALSE;
+ }
+
+ ret = gst_file_sink_set_location (sink, location);
g_free (location);
return ret;
}
static void
-gst_filesink_uri_handler_init (gpointer g_iface, gpointer iface_data)
+gst_file_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
{
GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
- iface->get_type = gst_filesink_uri_get_type;
- iface->get_protocols = gst_filesink_uri_get_protocols;
- iface->get_uri = gst_filesink_uri_get_uri;
- iface->set_uri = gst_filesink_uri_set_uri;
+ iface->get_type = gst_file_sink_uri_get_type;
+ iface->get_protocols = gst_file_sink_uri_get_protocols;
+ iface->get_uri = gst_file_sink_uri_get_uri;
+ iface->set_uri = gst_file_sink_uri_set_uri;
}
projects / platform / upstream / gstreamer.git / blobdiff