2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2006 Wim Taymans <wim@fluendo.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 * SECTION:element-filesink
25 * @see_also: #GstFileSrc
27 * Write incoming data to a file in the local file system.
34 #include "../../gst/gst-i18n-lib.h"
37 #include <stdio.h> /* for fseeko() */
38 #ifdef HAVE_STDIO_EXT_H
39 #include <stdio_ext.h> /* for __fbufsize, for debugging */
42 #include "gstfilesink.h"
44 #include <sys/types.h>
47 #include <io.h> /* lseek, open, close, read */
49 #define lseek _lseeki64
52 #ifdef _MSC_VER /* Check if we are using MSVC, fileno is deprecated in favour */
53 #define fileno _fileno /* of _fileno */
62 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
67 #define GST_TYPE_BUFFER_MODE (buffer_mode_get_type ())
69 buffer_mode_get_type (void)
71 static GType buffer_mode_type = 0;
72 static const GEnumValue buffer_mode[] = {
73 {-1, "Default buffering", "default"},
74 {_IOFBF, "Fully buffered", "full"},
75 {_IOLBF, "Line buffered", "line"},
76 {_IONBF, "Unbuffered", "unbuffered"},
80 if (!buffer_mode_type) {
82 g_enum_register_static ("GstFileSinkBufferMode", buffer_mode);
84 return buffer_mode_type;
87 GST_DEBUG_CATEGORY_STATIC (gst_file_sink_debug);
88 #define GST_CAT_DEFAULT gst_file_sink_debug
90 #define DEFAULT_LOCATION NULL
91 #define DEFAULT_BUFFER_MODE -1
92 #define DEFAULT_BUFFER_SIZE 64 * 1024
93 #define DEFAULT_APPEND FALSE
105 /* Copy of glib's g_fopen due to win32 libc/cross-DLL brokenness: we can't
106 * use the 'file pointer' opened in glib (and returned from this function)
107 * in this library, as they may have unrelated C runtimes. */
109 gst_fopen (const gchar * filename, const gchar * mode)
112 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
117 if (wfilename == NULL) {
122 wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
130 retval = _wfopen (wfilename, wmode);
139 return fopen (filename, mode);
143 static void gst_file_sink_dispose (GObject * object);
145 static void gst_file_sink_set_property (GObject * object, guint prop_id,
146 const GValue * value, GParamSpec * pspec);
147 static void gst_file_sink_get_property (GObject * object, guint prop_id,
148 GValue * value, GParamSpec * pspec);
150 static gboolean gst_file_sink_open_file (GstFileSink * sink);
151 static void gst_file_sink_close_file (GstFileSink * sink);
153 static gboolean gst_file_sink_start (GstBaseSink * sink);
154 static gboolean gst_file_sink_stop (GstBaseSink * sink);
155 static gboolean gst_file_sink_event (GstBaseSink * sink, GstEvent * event);
156 static GstFlowReturn gst_file_sink_render (GstBaseSink * sink,
159 static gboolean gst_file_sink_do_seek (GstFileSink * filesink,
161 static gboolean gst_file_sink_get_current_offset (GstFileSink * filesink,
164 static gboolean gst_file_sink_query (GstPad * pad, GstQuery * query);
166 static void gst_file_sink_uri_handler_init (gpointer g_iface,
167 gpointer iface_data);
171 _do_init (GType filesink_type)
173 static const GInterfaceInfo urihandler_info = {
174 gst_file_sink_uri_handler_init,
179 g_type_add_interface_static (filesink_type, GST_TYPE_URI_HANDLER,
181 GST_DEBUG_CATEGORY_INIT (gst_file_sink_debug, "filesink", 0,
185 GST_BOILERPLATE_FULL (GstFileSink, gst_file_sink, GstBaseSink,
186 GST_TYPE_BASE_SINK, _do_init);
189 gst_file_sink_base_init (gpointer g_class)
191 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
193 gst_element_class_set_details_simple (gstelement_class,
195 "Sink/File", "Write stream to a file",
196 "Thomas Vander Stichele <thomas at apestaart dot org>");
197 gst_element_class_add_pad_template (gstelement_class,
198 gst_static_pad_template_get (&sinktemplate));
202 gst_file_sink_class_init (GstFileSinkClass * klass)
204 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
205 GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
207 gobject_class->dispose = gst_file_sink_dispose;
209 gobject_class->set_property = gst_file_sink_set_property;
210 gobject_class->get_property = gst_file_sink_get_property;
212 g_object_class_install_property (gobject_class, PROP_LOCATION,
213 g_param_spec_string ("location", "File Location",
214 "Location of the file to write", NULL,
215 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
217 g_object_class_install_property (gobject_class, PROP_BUFFER_MODE,
218 g_param_spec_enum ("buffer-mode", "Buffering mode",
219 "The buffering mode to use", GST_TYPE_BUFFER_MODE,
220 DEFAULT_BUFFER_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
222 g_object_class_install_property (gobject_class, PROP_BUFFER_SIZE,
223 g_param_spec_uint ("buffer-size", "Buffering size",
224 "Size of buffer in number of bytes for line or full buffer-mode", 0,
225 G_MAXUINT, DEFAULT_BUFFER_SIZE,
226 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
231 * Append to an already existing file.
235 g_object_class_install_property (gobject_class, PROP_APPEND,
236 g_param_spec_boolean ("append", "Append",
237 "Append to an already existing file", DEFAULT_APPEND,
238 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
240 gstbasesink_class->get_times = NULL;
241 gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_file_sink_start);
242 gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_file_sink_stop);
243 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_file_sink_render);
244 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_file_sink_event);
246 if (sizeof (off_t) < 8) {
247 GST_LOG ("No large file support, sizeof (off_t) = %" G_GSIZE_FORMAT "!",
253 gst_file_sink_init (GstFileSink * filesink, GstFileSinkClass * g_class)
257 pad = GST_BASE_SINK_PAD (filesink);
259 gst_pad_set_query_function (pad, GST_DEBUG_FUNCPTR (gst_file_sink_query));
261 filesink->filename = NULL;
262 filesink->file = NULL;
263 filesink->buffer_mode = DEFAULT_BUFFER_MODE;
264 filesink->buffer_size = DEFAULT_BUFFER_SIZE;
265 filesink->buffer = NULL;
266 filesink->append = FALSE;
268 gst_base_sink_set_sync (GST_BASE_SINK (filesink), FALSE);
272 gst_file_sink_dispose (GObject * object)
274 GstFileSink *sink = GST_FILE_SINK (object);
276 G_OBJECT_CLASS (parent_class)->dispose (object);
280 g_free (sink->filename);
281 sink->filename = NULL;
282 g_free (sink->buffer);
284 sink->buffer_size = 0;
288 gst_file_sink_set_location (GstFileSink * sink, const gchar * location)
293 g_free (sink->filename);
295 if (location != NULL) {
296 /* we store the filename as we received it from the application. On Windows
297 * this should be in UTF8 */
298 sink->filename = g_strdup (location);
299 sink->uri = gst_uri_construct ("file", sink->filename);
301 sink->filename = NULL;
310 g_warning ("Changing the `location' property on filesink when a file is "
311 "open is not supported.");
317 gst_file_sink_set_property (GObject * object, guint prop_id,
318 const GValue * value, GParamSpec * pspec)
320 GstFileSink *sink = GST_FILE_SINK (object);
324 gst_file_sink_set_location (sink, g_value_get_string (value));
326 case PROP_BUFFER_MODE:
327 sink->buffer_mode = g_value_get_enum (value);
329 case PROP_BUFFER_SIZE:
330 sink->buffer_size = g_value_get_uint (value);
333 sink->append = g_value_get_boolean (value);
336 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
342 gst_file_sink_get_property (GObject * object, guint prop_id, GValue * value,
345 GstFileSink *sink = GST_FILE_SINK (object);
349 g_value_set_string (value, sink->filename);
351 case PROP_BUFFER_MODE:
352 g_value_set_enum (value, sink->buffer_mode);
354 case PROP_BUFFER_SIZE:
355 g_value_set_uint (value, sink->buffer_size);
358 g_value_set_boolean (value, sink->append);
361 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
367 gst_file_sink_open_file (GstFileSink * sink)
372 if (sink->filename == NULL || sink->filename[0] == '\0')
376 sink->file = gst_fopen (sink->filename, "ab");
378 sink->file = gst_fopen (sink->filename, "wb");
379 if (sink->file == NULL)
382 /* see if we are asked to perform a specific kind of buffering */
383 if ((mode = sink->buffer_mode) != -1) {
386 /* free previous buffer if any */
387 g_free (sink->buffer);
389 if (mode == _IONBF) {
394 /* allocate buffer */
395 sink->buffer = g_malloc (sink->buffer_size);
396 buffer_size = sink->buffer_size;
398 #ifdef HAVE_STDIO_EXT_H
399 GST_DEBUG_OBJECT (sink, "change buffer size %u to %u, mode %d",
400 (guint) __fbufsize (sink->file), buffer_size, mode);
402 GST_DEBUG_OBJECT (sink, "change buffer size to %u, mode %d",
403 sink->buffer_size, mode);
405 if (setvbuf (sink->file, sink->buffer, mode, buffer_size) != 0) {
406 GST_WARNING_OBJECT (sink, "warning: setvbuf failed: %s",
411 sink->current_pos = 0;
412 /* try to seek in the file to figure out if it is seekable */
413 sink->seekable = gst_file_sink_do_seek (sink, 0);
415 GST_DEBUG_OBJECT (sink, "opened file %s, seekable %d",
416 sink->filename, sink->seekable);
423 GST_ELEMENT_ERROR (sink, RESOURCE, NOT_FOUND,
424 (_("No file name specified for writing.")), (NULL));
429 GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE,
430 (_("Could not open file \"%s\" for writing."), sink->filename),
437 gst_file_sink_close_file (GstFileSink * sink)
440 if (fclose (sink->file) != 0)
443 GST_DEBUG_OBJECT (sink, "closed file");
446 g_free (sink->buffer);
454 GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
455 (_("Error closing file \"%s\"."), sink->filename), GST_ERROR_SYSTEM);
461 gst_file_sink_query (GstPad * pad, GstQuery * query)
466 self = GST_FILE_SINK (GST_PAD_PARENT (pad));
468 switch (GST_QUERY_TYPE (query)) {
469 case GST_QUERY_POSITION:
470 gst_query_parse_position (query, &format, NULL);
472 case GST_FORMAT_DEFAULT:
473 case GST_FORMAT_BYTES:
474 gst_query_set_position (query, GST_FORMAT_BYTES, self->current_pos);
480 case GST_QUERY_FORMATS:
481 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
485 gst_query_set_uri (query, self->uri);
489 return gst_pad_query_default (pad, query);
494 # define __GST_STDIO_SEEK_FUNCTION "fseeko"
495 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
496 # define __GST_STDIO_SEEK_FUNCTION "lseek"
498 # define __GST_STDIO_SEEK_FUNCTION "fseek"
502 gst_file_sink_do_seek (GstFileSink * filesink, guint64 new_offset)
504 GST_DEBUG_OBJECT (filesink, "Seeking to offset %" G_GUINT64_FORMAT
505 " using " __GST_STDIO_SEEK_FUNCTION, new_offset);
507 if (fflush (filesink->file))
511 if (fseeko (filesink->file, (off_t) new_offset, SEEK_SET) != 0)
513 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
514 if (lseek (fileno (filesink->file), (off_t) new_offset,
515 SEEK_SET) == (off_t) - 1)
518 if (fseek (filesink->file, (long) new_offset, SEEK_SET) != 0)
522 /* adjust position reporting after seek;
523 * presumably this should basically yield new_offset */
524 gst_file_sink_get_current_offset (filesink, &filesink->current_pos);
531 GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
536 GST_DEBUG_OBJECT (filesink, "Seeking failed: %s", g_strerror (errno));
541 /* handle events (search) */
543 gst_file_sink_event (GstBaseSink * sink, GstEvent * event)
546 GstFileSink *filesink;
548 filesink = GST_FILE_SINK (sink);
550 type = GST_EVENT_TYPE (event);
553 case GST_EVENT_NEWSEGMENT:
555 gint64 start, stop, pos;
558 gst_event_parse_new_segment (event, NULL, NULL, &format, &start,
561 if (format == GST_FORMAT_BYTES) {
562 /* only try to seek and fail when we are going to a different
564 if (filesink->current_pos != start) {
565 /* FIXME, the seek should be performed on the pos field, start/stop are
566 * just boundaries for valid bytes offsets. We should also fill the file
567 * with zeroes if the new position extends the current EOF (sparse streams
568 * and segment accumulation). */
569 if (!gst_file_sink_do_seek (filesink, (guint64) start))
572 GST_DEBUG_OBJECT (filesink, "Ignored NEWSEGMENT, no seek needed");
575 GST_DEBUG_OBJECT (filesink,
576 "Ignored NEWSEGMENT event of format %u (%s)", (guint) format,
577 gst_format_get_name (format));
582 if (fflush (filesink->file))
594 GST_ELEMENT_ERROR (filesink, RESOURCE, SEEK,
595 (_("Error while seeking in file \"%s\"."), filesink->filename),
601 GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
602 (_("Error while writing to file \"%s\"."), filesink->filename),
609 gst_file_sink_get_current_offset (GstFileSink * filesink, guint64 * p_pos)
614 ret = ftello (filesink->file);
615 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
616 if (fflush (filesink->file)) {
617 GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
618 /* ignore and continue */
620 ret = lseek (fileno (filesink->file), 0, SEEK_CUR);
622 ret = (off_t) ftell (filesink->file);
625 if (ret != (off_t) - 1)
626 *p_pos = (guint64) ret;
628 return (ret != (off_t) - 1);
632 gst_file_sink_render (GstBaseSink * sink, GstBuffer * buffer)
634 GstFileSink *filesink;
638 filesink = GST_FILE_SINK (sink);
640 size = GST_BUFFER_SIZE (buffer);
641 data = GST_BUFFER_DATA (buffer);
643 GST_DEBUG_OBJECT (filesink, "writing %u bytes at %" G_GUINT64_FORMAT,
644 size, filesink->current_pos);
646 if (size > 0 && data != NULL) {
647 if (fwrite (data, size, 1, filesink->file) != 1)
650 filesink->current_pos += size;
659 GST_ELEMENT_ERROR (filesink, RESOURCE, NO_SPACE_LEFT, (NULL), (NULL));
663 GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
664 (_("Error while writing to file \"%s\"."), filesink->filename),
665 ("%s", g_strerror (errno)));
668 return GST_FLOW_ERROR;
673 gst_file_sink_start (GstBaseSink * basesink)
675 return gst_file_sink_open_file (GST_FILE_SINK (basesink));
679 gst_file_sink_stop (GstBaseSink * basesink)
681 gst_file_sink_close_file (GST_FILE_SINK (basesink));
685 /*** GSTURIHANDLER INTERFACE *************************************************/
688 gst_file_sink_uri_get_type (void)
694 gst_file_sink_uri_get_protocols (void)
696 static gchar *protocols[] = { (char *) "file", NULL };
702 gst_file_sink_uri_get_uri (GstURIHandler * handler)
704 GstFileSink *sink = GST_FILE_SINK (handler);
710 gst_file_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri)
712 gchar *protocol, *location;
714 GstFileSink *sink = GST_FILE_SINK (handler);
716 protocol = gst_uri_get_protocol (uri);
717 if (strcmp (protocol, "file") != 0) {
723 /* allow file://localhost/foo/bar by stripping localhost but fail
724 * for every other hostname */
725 if (g_str_has_prefix (uri, "file://localhost/")) {
728 /* 16 == strlen ("file://localhost") */
729 tmp = g_strconcat ("file://", uri + 16, NULL);
730 /* we use gst_uri_get_location() although we already have the
731 * "location" with uri + 16 because it provides unescaping */
732 location = gst_uri_get_location (tmp);
734 } else if (strcmp (uri, "file://") == 0) {
735 /* Special case for "file://" as this is used by some applications
736 * to test with gst_element_make_from_uri if there's an element
737 * that supports the URI protocol. */
738 gst_file_sink_set_location (sink, NULL);
741 location = gst_uri_get_location (uri);
746 if (!g_path_is_absolute (location)) {
751 ret = gst_file_sink_set_location (sink, location);
758 gst_file_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
760 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
762 iface->get_type = gst_file_sink_uri_get_type;
763 iface->get_protocols = gst_file_sink_uri_get_protocols;
764 iface->get_uri = gst_file_sink_uri_get_uri;
765 iface->set_uri = gst_file_sink_uri_set_uri;