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.
30 * <title>Example launch line</title>
32 * gst-launch v4l2src num-buffers=1 ! jpegenc ! filesink location=capture1.jpeg
33 * ]| Capture one frame from a v4l2 camera and save as jpeg image.
41 #include "../../gst/gst-i18n-lib.h"
44 #include <stdio.h> /* for fseeko() */
45 #ifdef HAVE_STDIO_EXT_H
46 #include <stdio_ext.h> /* for __fbufsize, for debugging */
49 #include "gstfilesink.h"
51 #include <sys/types.h>
54 #include <io.h> /* lseek, open, close, read */
56 #define lseek _lseeki64
59 #ifdef _MSC_VER /* Check if we are using MSVC, fileno is deprecated in favour */
60 #define fileno _fileno /* of _fileno */
69 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
74 #define GST_TYPE_BUFFER_MODE (buffer_mode_get_type ())
76 buffer_mode_get_type (void)
78 static GType buffer_mode_type = 0;
79 static const GEnumValue buffer_mode[] = {
80 {-1, "Default buffering", "default"},
81 {_IOFBF, "Fully buffered", "full"},
82 {_IOLBF, "Line buffered", "line"},
83 {_IONBF, "Unbuffered", "unbuffered"},
87 if (!buffer_mode_type) {
89 g_enum_register_static ("GstFileSinkBufferMode", buffer_mode);
91 return buffer_mode_type;
94 GST_DEBUG_CATEGORY_STATIC (gst_file_sink_debug);
95 #define GST_CAT_DEFAULT gst_file_sink_debug
97 #define DEFAULT_LOCATION NULL
98 #define DEFAULT_BUFFER_MODE -1
99 #define DEFAULT_BUFFER_SIZE 64 * 1024
100 #define DEFAULT_APPEND FALSE
112 /* Copy of glib's g_fopen due to win32 libc/cross-DLL brokenness: we can't
113 * use the 'file pointer' opened in glib (and returned from this function)
114 * in this library, as they may have unrelated C runtimes. */
116 gst_fopen (const gchar * filename, const gchar * mode)
119 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
124 if (wfilename == NULL) {
129 wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
137 retval = _wfopen (wfilename, wmode);
146 return fopen (filename, mode);
150 static void gst_file_sink_dispose (GObject * object);
152 static void gst_file_sink_set_property (GObject * object, guint prop_id,
153 const GValue * value, GParamSpec * pspec);
154 static void gst_file_sink_get_property (GObject * object, guint prop_id,
155 GValue * value, GParamSpec * pspec);
157 static gboolean gst_file_sink_open_file (GstFileSink * sink);
158 static void gst_file_sink_close_file (GstFileSink * sink);
160 static gboolean gst_file_sink_start (GstBaseSink * sink);
161 static gboolean gst_file_sink_stop (GstBaseSink * sink);
162 static gboolean gst_file_sink_event (GstBaseSink * sink, GstEvent * event);
163 static GstFlowReturn gst_file_sink_render (GstBaseSink * sink,
166 static gboolean gst_file_sink_do_seek (GstFileSink * filesink,
168 static gboolean gst_file_sink_get_current_offset (GstFileSink * filesink,
171 static gboolean gst_file_sink_query (GstBaseSink * bsink, GstQuery * query);
173 static void gst_file_sink_uri_handler_init (gpointer g_iface,
174 gpointer iface_data);
177 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_file_sink_uri_handler_init); \
178 GST_DEBUG_CATEGORY_INIT (gst_file_sink_debug, "filesink", 0, "filesink element");
179 #define gst_file_sink_parent_class parent_class
180 G_DEFINE_TYPE_WITH_CODE (GstFileSink, gst_file_sink, GST_TYPE_BASE_SINK,
184 gst_file_sink_class_init (GstFileSinkClass * klass)
186 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
187 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
188 GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
190 gobject_class->dispose = gst_file_sink_dispose;
192 gobject_class->set_property = gst_file_sink_set_property;
193 gobject_class->get_property = gst_file_sink_get_property;
195 g_object_class_install_property (gobject_class, PROP_LOCATION,
196 g_param_spec_string ("location", "File Location",
197 "Location of the file to write", NULL,
198 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
200 g_object_class_install_property (gobject_class, PROP_BUFFER_MODE,
201 g_param_spec_enum ("buffer-mode", "Buffering mode",
202 "The buffering mode to use", GST_TYPE_BUFFER_MODE,
203 DEFAULT_BUFFER_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
205 g_object_class_install_property (gobject_class, PROP_BUFFER_SIZE,
206 g_param_spec_uint ("buffer-size", "Buffering size",
207 "Size of buffer in number of bytes for line or full buffer-mode", 0,
208 G_MAXUINT, DEFAULT_BUFFER_SIZE,
209 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
214 * Append to an already existing file.
218 g_object_class_install_property (gobject_class, PROP_APPEND,
219 g_param_spec_boolean ("append", "Append",
220 "Append to an already existing file", DEFAULT_APPEND,
221 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
223 gst_element_class_set_details_simple (gstelement_class,
225 "Sink/File", "Write stream to a file",
226 "Thomas Vander Stichele <thomas at apestaart dot org>");
227 gst_element_class_add_pad_template (gstelement_class,
228 gst_static_pad_template_get (&sinktemplate));
230 gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_file_sink_start);
231 gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_file_sink_stop);
232 gstbasesink_class->query = GST_DEBUG_FUNCPTR (gst_file_sink_query);
233 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_file_sink_render);
234 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_file_sink_event);
236 if (sizeof (off_t) < 8) {
237 GST_LOG ("No large file support, sizeof (off_t) = %" G_GSIZE_FORMAT "!",
243 gst_file_sink_init (GstFileSink * filesink)
245 filesink->filename = NULL;
246 filesink->file = NULL;
247 filesink->buffer_mode = DEFAULT_BUFFER_MODE;
248 filesink->buffer_size = DEFAULT_BUFFER_SIZE;
249 filesink->buffer = NULL;
250 filesink->append = FALSE;
252 gst_base_sink_set_sync (GST_BASE_SINK (filesink), FALSE);
256 gst_file_sink_dispose (GObject * object)
258 GstFileSink *sink = GST_FILE_SINK (object);
260 G_OBJECT_CLASS (parent_class)->dispose (object);
264 g_free (sink->filename);
265 sink->filename = NULL;
266 g_free (sink->buffer);
268 sink->buffer_size = 0;
272 gst_file_sink_set_location (GstFileSink * sink, const gchar * location)
277 g_free (sink->filename);
279 if (location != NULL) {
280 /* we store the filename as we received it from the application. On Windows
281 * this should be in UTF8 */
282 sink->filename = g_strdup (location);
283 sink->uri = gst_filename_to_uri (location, NULL);
284 GST_INFO ("filename : %s", sink->filename);
285 GST_INFO ("uri : %s", sink->uri);
287 sink->filename = NULL;
296 g_warning ("Changing the `location' property on filesink when a file is "
297 "open is not supported.");
303 gst_file_sink_set_property (GObject * object, guint prop_id,
304 const GValue * value, GParamSpec * pspec)
306 GstFileSink *sink = GST_FILE_SINK (object);
310 gst_file_sink_set_location (sink, g_value_get_string (value));
312 case PROP_BUFFER_MODE:
313 sink->buffer_mode = g_value_get_enum (value);
315 case PROP_BUFFER_SIZE:
316 sink->buffer_size = g_value_get_uint (value);
319 sink->append = g_value_get_boolean (value);
322 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
328 gst_file_sink_get_property (GObject * object, guint prop_id, GValue * value,
331 GstFileSink *sink = GST_FILE_SINK (object);
335 g_value_set_string (value, sink->filename);
337 case PROP_BUFFER_MODE:
338 g_value_set_enum (value, sink->buffer_mode);
340 case PROP_BUFFER_SIZE:
341 g_value_set_uint (value, sink->buffer_size);
344 g_value_set_boolean (value, sink->append);
347 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
353 gst_file_sink_open_file (GstFileSink * sink)
358 if (sink->filename == NULL || sink->filename[0] == '\0')
362 sink->file = gst_fopen (sink->filename, "ab");
364 sink->file = gst_fopen (sink->filename, "wb");
365 if (sink->file == NULL)
368 /* see if we are asked to perform a specific kind of buffering */
369 if ((mode = sink->buffer_mode) != -1) {
372 /* free previous buffer if any */
373 g_free (sink->buffer);
375 if (mode == _IONBF) {
380 /* allocate buffer */
381 sink->buffer = g_malloc (sink->buffer_size);
382 buffer_size = sink->buffer_size;
384 #ifdef HAVE_STDIO_EXT_H
385 GST_DEBUG_OBJECT (sink, "change buffer size %u to %u, mode %d",
386 (guint) __fbufsize (sink->file), buffer_size, mode);
388 GST_DEBUG_OBJECT (sink, "change buffer size to %u, mode %d",
389 sink->buffer_size, mode);
391 if (setvbuf (sink->file, sink->buffer, mode, buffer_size) != 0) {
392 GST_WARNING_OBJECT (sink, "warning: setvbuf failed: %s",
397 sink->current_pos = 0;
398 /* try to seek in the file to figure out if it is seekable */
399 sink->seekable = gst_file_sink_do_seek (sink, 0);
401 GST_DEBUG_OBJECT (sink, "opened file %s, seekable %d",
402 sink->filename, sink->seekable);
409 GST_ELEMENT_ERROR (sink, RESOURCE, NOT_FOUND,
410 (_("No file name specified for writing.")), (NULL));
415 GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE,
416 (_("Could not open file \"%s\" for writing."), sink->filename),
423 gst_file_sink_close_file (GstFileSink * sink)
426 if (fclose (sink->file) != 0)
429 GST_DEBUG_OBJECT (sink, "closed file");
432 g_free (sink->buffer);
440 GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
441 (_("Error closing file \"%s\"."), sink->filename), GST_ERROR_SYSTEM);
447 gst_file_sink_query (GstBaseSink * bsink, GstQuery * query)
453 self = GST_FILE_SINK (bsink);
455 switch (GST_QUERY_TYPE (query)) {
456 case GST_QUERY_POSITION:
457 gst_query_parse_position (query, &format, NULL);
460 case GST_FORMAT_DEFAULT:
461 case GST_FORMAT_BYTES:
462 gst_query_set_position (query, GST_FORMAT_BYTES, self->current_pos);
471 case GST_QUERY_FORMATS:
472 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
477 gst_query_set_uri (query, self->uri);
482 res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
489 # define __GST_STDIO_SEEK_FUNCTION "fseeko"
490 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
491 # define __GST_STDIO_SEEK_FUNCTION "lseek"
493 # define __GST_STDIO_SEEK_FUNCTION "fseek"
497 gst_file_sink_do_seek (GstFileSink * filesink, guint64 new_offset)
499 GST_DEBUG_OBJECT (filesink, "Seeking to offset %" G_GUINT64_FORMAT
500 " using " __GST_STDIO_SEEK_FUNCTION, new_offset);
502 if (fflush (filesink->file))
506 if (fseeko (filesink->file, (off_t) new_offset, SEEK_SET) != 0)
508 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
509 if (lseek (fileno (filesink->file), (off_t) new_offset,
510 SEEK_SET) == (off_t) - 1)
513 if (fseek (filesink->file, (long) new_offset, SEEK_SET) != 0)
517 /* adjust position reporting after seek;
518 * presumably this should basically yield new_offset */
519 gst_file_sink_get_current_offset (filesink, &filesink->current_pos);
526 GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
531 GST_DEBUG_OBJECT (filesink, "Seeking failed: %s", g_strerror (errno));
536 /* handle events (search) */
538 gst_file_sink_event (GstBaseSink * sink, GstEvent * event)
541 GstFileSink *filesink;
543 filesink = GST_FILE_SINK (sink);
545 type = GST_EVENT_TYPE (event);
548 case GST_EVENT_SEGMENT:
550 const GstSegment *segment;
552 gst_event_parse_segment (event, &segment);
554 if (segment->format == GST_FORMAT_BYTES) {
555 /* only try to seek and fail when we are going to a different
557 if (filesink->current_pos != segment->start) {
558 /* FIXME, the seek should be performed on the pos field, start/stop are
559 * just boundaries for valid bytes offsets. We should also fill the file
560 * with zeroes if the new position extends the current EOF (sparse streams
561 * and segment accumulation). */
562 if (!gst_file_sink_do_seek (filesink, (guint64) segment->start))
565 GST_DEBUG_OBJECT (filesink, "Ignored SEGMENT, no seek needed");
568 GST_DEBUG_OBJECT (filesink,
569 "Ignored SEGMENT event of format %u (%s)", (guint) segment->format,
570 gst_format_get_name (segment->format));
575 if (fflush (filesink->file))
587 GST_ELEMENT_ERROR (filesink, RESOURCE, SEEK,
588 (_("Error while seeking in file \"%s\"."), filesink->filename),
594 GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
595 (_("Error while writing to file \"%s\"."), filesink->filename),
602 gst_file_sink_get_current_offset (GstFileSink * filesink, guint64 * p_pos)
607 ret = ftello (filesink->file);
608 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
609 if (fflush (filesink->file)) {
610 GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
611 /* ignore and continue */
613 ret = lseek (fileno (filesink->file), 0, SEEK_CUR);
615 ret = (off_t) ftell (filesink->file);
618 if (ret != (off_t) - 1)
619 *p_pos = (guint64) ret;
621 return (ret != (off_t) - 1);
625 gst_file_sink_render (GstBaseSink * sink, GstBuffer * buffer)
627 GstFileSink *filesink;
631 filesink = GST_FILE_SINK (sink);
633 data = gst_buffer_map (buffer, &size, NULL, GST_MAP_READ);
635 GST_DEBUG_OBJECT (filesink,
636 "writing %" G_GSIZE_FORMAT " bytes at %" G_GUINT64_FORMAT,
637 size, filesink->current_pos);
639 if (size > 0 && data != NULL) {
640 if (fwrite (data, size, 1, filesink->file) != 1)
643 filesink->current_pos += size;
645 gst_buffer_unmap (buffer, data, size);
653 GST_ELEMENT_ERROR (filesink, RESOURCE, NO_SPACE_LEFT, (NULL), (NULL));
657 GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
658 (_("Error while writing to file \"%s\"."), filesink->filename),
659 ("%s", g_strerror (errno)));
662 gst_buffer_unmap (buffer, data, size);
663 return GST_FLOW_ERROR;
668 gst_file_sink_start (GstBaseSink * basesink)
670 return gst_file_sink_open_file (GST_FILE_SINK (basesink));
674 gst_file_sink_stop (GstBaseSink * basesink)
676 gst_file_sink_close_file (GST_FILE_SINK (basesink));
680 /*** GSTURIHANDLER INTERFACE *************************************************/
683 gst_file_sink_uri_get_type (GType type)
689 gst_file_sink_uri_get_protocols (GType type)
691 static gchar *protocols[] = { (char *) "file", NULL };
697 gst_file_sink_uri_get_uri (GstURIHandler * handler)
699 GstFileSink *sink = GST_FILE_SINK (handler);
705 gst_file_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri)
707 gchar *protocol, *location;
709 GstFileSink *sink = GST_FILE_SINK (handler);
711 protocol = gst_uri_get_protocol (uri);
712 if (strcmp (protocol, "file") != 0) {
718 /* allow file://localhost/foo/bar by stripping localhost but fail
719 * for every other hostname */
720 if (g_str_has_prefix (uri, "file://localhost/")) {
723 /* 16 == strlen ("file://localhost") */
724 tmp = g_strconcat ("file://", uri + 16, NULL);
725 /* we use gst_uri_get_location() although we already have the
726 * "location" with uri + 16 because it provides unescaping */
727 location = gst_uri_get_location (tmp);
729 } else if (strcmp (uri, "file://") == 0) {
730 /* Special case for "file://" as this is used by some applications
731 * to test with gst_element_make_from_uri if there's an element
732 * that supports the URI protocol. */
733 gst_file_sink_set_location (sink, NULL);
736 location = gst_uri_get_location (uri);
741 if (!g_path_is_absolute (location)) {
746 ret = gst_file_sink_set_location (sink, location);
753 gst_file_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
755 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
757 iface->get_type = gst_file_sink_uri_get_type;
758 iface->get_protocols = gst_file_sink_uri_get_protocols;
759 iface->get_uri = gst_file_sink_uri_get_uri;
760 iface->set_uri = gst_file_sink_uri_set_uri;