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.
216 g_object_class_install_property (gobject_class, PROP_APPEND,
217 g_param_spec_boolean ("append", "Append",
218 "Append to an already existing file", DEFAULT_APPEND,
219 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
221 gst_element_class_set_static_metadata (gstelement_class,
223 "Sink/File", "Write stream to a file",
224 "Thomas Vander Stichele <thomas at apestaart dot org>");
225 gst_element_class_add_pad_template (gstelement_class,
226 gst_static_pad_template_get (&sinktemplate));
228 gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_file_sink_start);
229 gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_file_sink_stop);
230 gstbasesink_class->query = GST_DEBUG_FUNCPTR (gst_file_sink_query);
231 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_file_sink_render);
232 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_file_sink_event);
234 if (sizeof (off_t) < 8) {
235 GST_LOG ("No large file support, sizeof (off_t) = %" G_GSIZE_FORMAT "!",
241 gst_file_sink_init (GstFileSink * filesink)
243 filesink->filename = NULL;
244 filesink->file = NULL;
245 filesink->buffer_mode = DEFAULT_BUFFER_MODE;
246 filesink->buffer_size = DEFAULT_BUFFER_SIZE;
247 filesink->buffer = NULL;
248 filesink->append = FALSE;
250 gst_base_sink_set_sync (GST_BASE_SINK (filesink), FALSE);
254 gst_file_sink_dispose (GObject * object)
256 GstFileSink *sink = GST_FILE_SINK (object);
258 G_OBJECT_CLASS (parent_class)->dispose (object);
262 g_free (sink->filename);
263 sink->filename = NULL;
264 g_free (sink->buffer);
266 sink->buffer_size = 0;
270 gst_file_sink_set_location (GstFileSink * sink, const gchar * location,
276 g_free (sink->filename);
278 if (location != NULL) {
279 /* we store the filename as we received it from the application. On Windows
280 * this should be in UTF8 */
281 sink->filename = g_strdup (location);
282 sink->uri = gst_filename_to_uri (location, NULL);
283 GST_INFO ("filename : %s", sink->filename);
284 GST_INFO ("uri : %s", sink->uri);
286 sink->filename = NULL;
295 g_warning ("Changing the `location' property on filesink when a file is "
296 "open is not supported.");
297 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_STATE,
298 "Changing the 'location' property on filesink when a file is "
299 "open is not supported");
305 gst_file_sink_set_property (GObject * object, guint prop_id,
306 const GValue * value, GParamSpec * pspec)
308 GstFileSink *sink = GST_FILE_SINK (object);
312 gst_file_sink_set_location (sink, g_value_get_string (value), NULL);
314 case PROP_BUFFER_MODE:
315 sink->buffer_mode = g_value_get_enum (value);
317 case PROP_BUFFER_SIZE:
318 sink->buffer_size = g_value_get_uint (value);
321 sink->append = g_value_get_boolean (value);
324 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
330 gst_file_sink_get_property (GObject * object, guint prop_id, GValue * value,
333 GstFileSink *sink = GST_FILE_SINK (object);
337 g_value_set_string (value, sink->filename);
339 case PROP_BUFFER_MODE:
340 g_value_set_enum (value, sink->buffer_mode);
342 case PROP_BUFFER_SIZE:
343 g_value_set_uint (value, sink->buffer_size);
346 g_value_set_boolean (value, sink->append);
349 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
355 gst_file_sink_open_file (GstFileSink * sink)
360 if (sink->filename == NULL || sink->filename[0] == '\0')
364 sink->file = gst_fopen (sink->filename, "ab");
366 sink->file = gst_fopen (sink->filename, "wb");
367 if (sink->file == NULL)
370 /* see if we are asked to perform a specific kind of buffering */
371 if ((mode = sink->buffer_mode) != -1) {
374 /* free previous buffer if any */
375 g_free (sink->buffer);
377 if (mode == _IONBF) {
382 /* allocate buffer */
383 sink->buffer = g_malloc (sink->buffer_size);
384 buffer_size = sink->buffer_size;
386 #ifdef HAVE_STDIO_EXT_H
387 GST_DEBUG_OBJECT (sink, "change buffer size %u to %u, mode %d",
388 (guint) __fbufsize (sink->file), buffer_size, mode);
390 GST_DEBUG_OBJECT (sink, "change buffer size to %u, mode %d",
391 sink->buffer_size, mode);
393 if (setvbuf (sink->file, sink->buffer, mode, buffer_size) != 0) {
394 GST_WARNING_OBJECT (sink, "warning: setvbuf failed: %s",
399 sink->current_pos = 0;
400 /* try to seek in the file to figure out if it is seekable */
401 sink->seekable = gst_file_sink_do_seek (sink, 0);
403 GST_DEBUG_OBJECT (sink, "opened file %s, seekable %d",
404 sink->filename, sink->seekable);
411 GST_ELEMENT_ERROR (sink, RESOURCE, NOT_FOUND,
412 (_("No file name specified for writing.")), (NULL));
417 GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE,
418 (_("Could not open file \"%s\" for writing."), sink->filename),
425 gst_file_sink_close_file (GstFileSink * sink)
428 if (fclose (sink->file) != 0)
431 GST_DEBUG_OBJECT (sink, "closed file");
434 g_free (sink->buffer);
442 GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
443 (_("Error closing file \"%s\"."), sink->filename), GST_ERROR_SYSTEM);
449 gst_file_sink_query (GstBaseSink * bsink, GstQuery * query)
455 self = GST_FILE_SINK (bsink);
457 switch (GST_QUERY_TYPE (query)) {
458 case GST_QUERY_POSITION:
459 gst_query_parse_position (query, &format, NULL);
462 case GST_FORMAT_DEFAULT:
463 case GST_FORMAT_BYTES:
464 gst_query_set_position (query, GST_FORMAT_BYTES, self->current_pos);
473 case GST_QUERY_FORMATS:
474 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
479 gst_query_set_uri (query, self->uri);
483 case GST_QUERY_SEEKING:
484 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
485 if (format == GST_FORMAT_BYTES || format == GST_FORMAT_DEFAULT) {
486 gst_query_set_seeking (query, GST_FORMAT_BYTES, self->seekable, 0, -1);
488 gst_query_set_seeking (query, format, FALSE, 0, -1);
494 res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
501 # define __GST_STDIO_SEEK_FUNCTION "fseeko"
502 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
503 # define __GST_STDIO_SEEK_FUNCTION "lseek"
505 # define __GST_STDIO_SEEK_FUNCTION "fseek"
509 gst_file_sink_do_seek (GstFileSink * filesink, guint64 new_offset)
511 GST_DEBUG_OBJECT (filesink, "Seeking to offset %" G_GUINT64_FORMAT
512 " using " __GST_STDIO_SEEK_FUNCTION, new_offset);
514 if (fflush (filesink->file))
518 if (fseeko (filesink->file, (off_t) new_offset, SEEK_SET) != 0)
520 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
521 if (lseek (fileno (filesink->file), (off_t) new_offset,
522 SEEK_SET) == (off_t) - 1)
525 if (fseek (filesink->file, (long) new_offset, SEEK_SET) != 0)
529 /* adjust position reporting after seek;
530 * presumably this should basically yield new_offset */
531 gst_file_sink_get_current_offset (filesink, &filesink->current_pos);
538 GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
543 GST_DEBUG_OBJECT (filesink, "Seeking failed: %s", g_strerror (errno));
548 /* handle events (search) */
550 gst_file_sink_event (GstBaseSink * sink, GstEvent * event)
553 GstFileSink *filesink;
555 filesink = GST_FILE_SINK (sink);
557 type = GST_EVENT_TYPE (event);
560 case GST_EVENT_SEGMENT:
562 const GstSegment *segment;
564 gst_event_parse_segment (event, &segment);
566 if (segment->format == GST_FORMAT_BYTES) {
567 /* only try to seek and fail when we are going to a different
569 if (filesink->current_pos != segment->start) {
570 /* FIXME, the seek should be performed on the pos field, start/stop are
571 * just boundaries for valid bytes offsets. We should also fill the file
572 * with zeroes if the new position extends the current EOF (sparse streams
573 * and segment accumulation). */
574 if (!gst_file_sink_do_seek (filesink, (guint64) segment->start))
577 GST_DEBUG_OBJECT (filesink, "Ignored SEGMENT, no seek needed");
580 GST_DEBUG_OBJECT (filesink,
581 "Ignored SEGMENT event of format %u (%s)", (guint) segment->format,
582 gst_format_get_name (segment->format));
587 if (fflush (filesink->file))
594 return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
599 GST_ELEMENT_ERROR (filesink, RESOURCE, SEEK,
600 (_("Error while seeking in file \"%s\"."), filesink->filename),
602 gst_event_unref (event);
607 GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
608 (_("Error while writing to file \"%s\"."), filesink->filename),
610 gst_event_unref (event);
616 gst_file_sink_get_current_offset (GstFileSink * filesink, guint64 * p_pos)
621 ret = ftello (filesink->file);
622 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
623 if (fflush (filesink->file)) {
624 GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
625 /* ignore and continue */
627 ret = lseek (fileno (filesink->file), 0, SEEK_CUR);
629 ret = (off_t) ftell (filesink->file);
632 if (ret != (off_t) - 1)
633 *p_pos = (guint64) ret;
635 return (ret != (off_t) - 1);
639 gst_file_sink_render (GstBaseSink * sink, GstBuffer * buffer)
641 GstFileSink *filesink;
644 filesink = GST_FILE_SINK (sink);
646 gst_buffer_map (buffer, &info, GST_MAP_READ);
648 GST_DEBUG_OBJECT (filesink,
649 "writing %" G_GSIZE_FORMAT " bytes at %" G_GUINT64_FORMAT,
650 info.size, filesink->current_pos);
652 if (info.size > 0 && info.data != NULL) {
653 if (fwrite (info.data, info.size, 1, filesink->file) != 1)
656 filesink->current_pos += info.size;
658 gst_buffer_unmap (buffer, &info);
666 GST_ELEMENT_ERROR (filesink, RESOURCE, NO_SPACE_LEFT, (NULL), (NULL));
670 GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
671 (_("Error while writing to file \"%s\"."), filesink->filename),
672 ("%s", g_strerror (errno)));
675 gst_buffer_unmap (buffer, &info);
676 return GST_FLOW_ERROR;
681 gst_file_sink_start (GstBaseSink * basesink)
683 return gst_file_sink_open_file (GST_FILE_SINK (basesink));
687 gst_file_sink_stop (GstBaseSink * basesink)
689 gst_file_sink_close_file (GST_FILE_SINK (basesink));
693 /*** GSTURIHANDLER INTERFACE *************************************************/
696 gst_file_sink_uri_get_type (GType type)
701 static const gchar *const *
702 gst_file_sink_uri_get_protocols (GType type)
704 static const gchar *protocols[] = { "file", NULL };
710 gst_file_sink_uri_get_uri (GstURIHandler * handler)
712 GstFileSink *sink = GST_FILE_SINK (handler);
714 /* FIXME: make thread-safe */
715 return g_strdup (sink->uri);
719 gst_file_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri,
724 GstFileSink *sink = GST_FILE_SINK (handler);
726 /* allow file://localhost/foo/bar by stripping localhost but fail
727 * for every other hostname */
728 if (g_str_has_prefix (uri, "file://localhost/")) {
731 /* 16 == strlen ("file://localhost") */
732 tmp = g_strconcat ("file://", uri + 16, NULL);
733 /* we use gst_uri_get_location() although we already have the
734 * "location" with uri + 16 because it provides unescaping */
735 location = gst_uri_get_location (tmp);
737 } else if (strcmp (uri, "file://") == 0) {
738 /* Special case for "file://" as this is used by some applications
739 * to test with gst_element_make_from_uri if there's an element
740 * that supports the URI protocol. */
741 gst_file_sink_set_location (sink, NULL, NULL);
744 location = gst_uri_get_location (uri);
748 g_set_error_literal (error, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
749 "File URI without location");
753 if (!g_path_is_absolute (location)) {
754 g_set_error_literal (error, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
755 "File URI location must be an absolute path");
760 ret = gst_file_sink_set_location (sink, location, error);
767 gst_file_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
769 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
771 iface->get_type = gst_file_sink_uri_get_type;
772 iface->get_protocols = gst_file_sink_uri_get_protocols;
773 iface->get_uri = gst_file_sink_uri_get_uri;
774 iface->set_uri = gst_file_sink_uri_set_uri;