*/
/**
* SECTION:element-filesink
- * @short_description: write stream to a file
* @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 <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
GST_PAD_ALWAYS,
GST_STATIC_CAPS_ANY);
+#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},
+ };
+
+ 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
-static const GstElementDetails gst_file_sink_details =
-GST_ELEMENT_DETAILS ("File Sink",
- "Sink/File",
- "Write stream to a file",
- "Thomas <thomas@apestaart.org>");
+#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
};
+/* 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)
+{
+#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;
+ }
+
+ wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
+
+ if (wmode == NULL) {
+ g_free (wfilename);
+ errno = EINVAL;
+ return NULL;
+ }
+
+ retval = _wfopen (wfilename, wmode);
+ save_errno = errno;
+
+ g_free (wfilename);
+ g_free (wmode);
+
+ errno = save_errno;
+ return retval;
+#else
+ return fopen (filename, mode);
+#endif
+}
+
static void gst_file_sink_dispose (GObject * object);
static void gst_file_sink_set_property (GObject * object, guint prop_id,
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 gboolean gst_file_sink_query (GstPad * pad, GstQuery * query);
+static gboolean gst_file_sink_query (GstPad * pad, GstQuery ** query);
static void gst_file_sink_uri_handler_init (gpointer g_iface,
gpointer iface_data);
-
-static void
-_do_init (GType filesink_type)
-{
- static const GInterfaceInfo urihandler_info = {
- gst_file_sink_uri_handler_init,
- NULL,
- NULL
- };
-
- g_type_add_interface_static (filesink_type, GST_TYPE_URI_HANDLER,
- &urihandler_info);
- GST_DEBUG_CATEGORY_INIT (gst_file_sink_debug, "filesink", 0,
- "filesink element");
-}
-
-GST_BOILERPLATE_FULL (GstFileSink, gst_file_sink, GstBaseSink,
- GST_TYPE_BASE_SINK, _do_init);
-
-static void
-gst_file_sink_base_init (gpointer g_class)
-{
- GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
-
- gst_element_class_add_pad_template (gstelement_class,
- gst_static_pad_template_get (&sinktemplate));
- gst_element_class_set_details (gstelement_class, &gst_file_sink_details);
-}
+#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_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;
+
gobject_class->set_property = gst_file_sink_set_property;
gobject_class->get_property = gst_file_sink_get_property;
- g_object_class_install_property (gobject_class, ARG_LOCATION,
+ 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));
-
- gobject_class->dispose = gst_file_sink_dispose;
+ "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->get_times = NULL;
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);
}
static void
-gst_file_sink_init (GstFileSink * filesink, GstFileSinkClass * g_class)
+gst_file_sink_init (GstFileSink * filesink)
{
GstPad *pad;
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);
}
sink->uri = NULL;
g_free (sink->filename);
sink->filename = NULL;
+ g_free (sink->buffer);
+ sink->buffer = NULL;
+ sink->buffer_size = 0;
}
static gboolean
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;
/* ERRORS */
was_open:
{
- g_warning ("Changing the `location' property on filesink when "
- "a file is open not supported.");
+ g_warning ("Changing the `location' property on filesink when a file is "
+ "open is not supported.");
return FALSE;
}
}
+
static void
gst_file_sink_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
GstFileSink *sink = GST_FILE_SINK (object);
switch (prop_id) {
- case ARG_LOCATION:
+ 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);
break;
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_file_sink_open_file (GstFileSink * sink)
{
+ gint mode;
+
/* open the file */
if (sink->filename == NULL || sink->filename[0] == '\0')
goto no_filename;
- sink->file = fopen (sink->filename, "wb");
+ 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;
- sink->data_written = 0;
+ /* 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, "closed file");
sink->file = NULL;
+
+ g_free (sink->buffer);
+ sink->buffer = NULL;
}
return;
}
static gboolean
-gst_file_sink_query (GstPad * pad, GstQuery * query)
+gst_file_sink_query (GstPad * pad, GstQuery ** query)
{
GstFileSink *self;
GstFormat format;
self = GST_FILE_SINK (GST_PAD_PARENT (pad));
- switch (GST_QUERY_TYPE (query)) {
+ switch (GST_QUERY_TYPE (*query)) {
case GST_QUERY_POSITION:
- gst_query_parse_position (query, &format, NULL);
+ gst_query_parse_position (*query, &format, NULL);
switch (format) {
case GST_FORMAT_DEFAULT:
case GST_FORMAT_BYTES:
- gst_query_set_position (query, GST_FORMAT_BYTES, self->data_written);
+ gst_query_set_position (*query, GST_FORMAT_BYTES, self->current_pos);
return TRUE;
default:
return FALSE;
}
case GST_QUERY_FORMATS:
- gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
+ 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:
}
}
-#if HAVE_FSEEKO
+#ifdef HAVE_FSEEKO
# define __GST_STDIO_SEEK_FUNCTION "fseeko"
-#elif G_OS_UNIX
+#elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
# define __GST_STDIO_SEEK_FUNCTION "lseek"
#else
# define __GST_STDIO_SEEK_FUNCTION "fseek"
if (fflush (filesink->file))
goto flush_failed;
-#if HAVE_FSEEKO
+#ifdef HAVE_FSEEKO
if (fseeko (filesink->file, (off_t) new_offset, SEEK_SET) != 0)
goto seek_failed;
-#elif G_OS_UNIX
+#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;
goto seek_failed;
#endif
+ /* adjust position reporting after seek;
+ * presumably this should basically yield new_offset */
+ gst_file_sink_get_current_offset (filesink, &filesink->current_pos);
+
return TRUE;
/* ERRORS */
type = GST_EVENT_TYPE (event);
switch (type) {
- case GST_EVENT_NEWSEGMENT:
+ case GST_EVENT_SEGMENT:
{
- gint64 start, stop, pos;
- GstFormat format;
-
- gst_event_parse_new_segment (event, NULL, NULL, &format, &start,
- &stop, &pos);
-
- if (format == GST_FORMAT_BYTES) {
- /* 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) start))
- goto seek_failed;
+ 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 ("Ignored NEWSEGMENT event of format %u (%s)",
- (guint) format, gst_format_get_name (format));
+ GST_DEBUG_OBJECT (filesink,
+ "Ignored SEGMENT event of format %u (%s)", (guint) segment.format,
+ gst_format_get_name (segment.format));
}
break;
}
static gboolean
gst_file_sink_get_current_offset (GstFileSink * filesink, guint64 * p_pos)
{
- off_t ret;
+ off_t ret = -1;
-#if HAVE_FTELLO
+#ifdef HAVE_FTELLO
ret = ftello (filesink->file);
-#elif G_OS_UNIX
+#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 = (off_t) ftell (filesink->file);
#endif
- *p_pos = (guint64) ret;
+ if (ret != (off_t) - 1)
+ *p_pos = (guint64) ret;
return (ret != (off_t) - 1);
}
gst_file_sink_render (GstBaseSink * sink, GstBuffer * buffer)
{
GstFileSink *filesink;
- guint64 cur_pos;
- guint size;
- guint64 back_pending = 0;
-
- size = GST_BUFFER_SIZE (buffer);
+ gsize size;
+ guint8 *data;
filesink = GST_FILE_SINK (sink);
- if (filesink->seekable) {
- if (!gst_file_sink_get_current_offset (filesink, &cur_pos))
- goto handle_error;
- } else {
- cur_pos = filesink->data_written;
- }
-
- if (cur_pos < filesink->data_written)
- back_pending = filesink->data_written - cur_pos;
+ data = gst_buffer_map (buffer, &size, NULL, GST_MAP_READ);
GST_DEBUG_OBJECT (filesink, "writing %u bytes at %" G_GUINT64_FORMAT,
- size, cur_pos);
+ size, filesink->current_pos);
- if (size > 0 && GST_BUFFER_DATA (buffer) != NULL) {
- if (fwrite (GST_BUFFER_DATA (buffer), size, 1, filesink->file) != 1)
+ if (size > 0 && data != NULL) {
+ if (fwrite (data, size, 1, filesink->file) != 1)
goto handle_error;
- filesink->data_written += size - back_pending;
+ filesink->current_pos += size;
}
+ gst_buffer_unmap (buffer, data, size);
return GST_FLOW_OK;
("%s", g_strerror (errno)));
}
}
+ gst_buffer_unmap (buffer, data, size);
return GST_FLOW_ERROR;
}
}
{
return GST_URI_SINK;
}
+
static gchar **
gst_file_sink_uri_get_protocols (void)
{
- static gchar *protocols[] = { "file", NULL };
+ static gchar *protocols[] = { (char *) "file", NULL };
return protocols;
}
+
static const gchar *
gst_file_sink_uri_get_uri (GstURIHandler * handler)
{
* "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;
- }
+ }
+
+ if (!location)
+ return FALSE;
+ if (!g_path_is_absolute (location)) {
+ g_free (location);
+ return FALSE;
}
ret = gst_file_sink_set_location (sink, location);
projects / platform / upstream / gstreamer.git / blobdiff