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
59 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
64 #define GST_TYPE_BUFFER_MODE (buffer_mode_get_type ())
66 buffer_mode_get_type (void)
68 static GType buffer_mode_type = 0;
69 static const GEnumValue buffer_mode[] = {
70 {-1, "Default buffering", "default"},
71 {_IOFBF, "Fully buffered", "full"},
72 {_IOLBF, "Line buffered", "line"},
73 {_IONBF, "Unbuffered", "unbuffered"},
77 if (!buffer_mode_type) {
79 g_enum_register_static ("GstFileSinkBufferMode", buffer_mode);
81 return buffer_mode_type;
84 GST_DEBUG_CATEGORY_STATIC (gst_file_sink_debug);
85 #define GST_CAT_DEFAULT gst_file_sink_debug
87 #define DEFAULT_LOCATION NULL
88 #define DEFAULT_BUFFER_MODE -1
89 #define DEFAULT_BUFFER_SIZE 64 * 1024
100 static void gst_file_sink_dispose (GObject * object);
102 static void gst_file_sink_set_property (GObject * object, guint prop_id,
103 const GValue * value, GParamSpec * pspec);
104 static void gst_file_sink_get_property (GObject * object, guint prop_id,
105 GValue * value, GParamSpec * pspec);
107 static gboolean gst_file_sink_open_file (GstFileSink * sink);
108 static void gst_file_sink_close_file (GstFileSink * sink);
110 static gboolean gst_file_sink_start (GstBaseSink * sink);
111 static gboolean gst_file_sink_stop (GstBaseSink * sink);
112 static gboolean gst_file_sink_event (GstBaseSink * sink, GstEvent * event);
113 static GstFlowReturn gst_file_sink_render (GstBaseSink * sink,
116 static gboolean gst_file_sink_do_seek (GstFileSink * filesink,
118 static gboolean gst_file_sink_get_current_offset (GstFileSink * filesink,
121 static gboolean gst_file_sink_query (GstPad * pad, GstQuery * query);
123 static void gst_file_sink_uri_handler_init (gpointer g_iface,
124 gpointer iface_data);
128 _do_init (GType filesink_type)
130 static const GInterfaceInfo urihandler_info = {
131 gst_file_sink_uri_handler_init,
136 g_type_add_interface_static (filesink_type, GST_TYPE_URI_HANDLER,
138 GST_DEBUG_CATEGORY_INIT (gst_file_sink_debug, "filesink", 0,
142 GST_BOILERPLATE_FULL (GstFileSink, gst_file_sink, GstBaseSink,
143 GST_TYPE_BASE_SINK, _do_init);
146 gst_file_sink_base_init (gpointer g_class)
148 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
150 gst_element_class_set_details_simple (gstelement_class,
152 "Sink/File", "Write stream to a file",
153 "Thomas Vander Stichele <thomas at apestaart dot org>");
154 gst_element_class_add_pad_template (gstelement_class,
155 gst_static_pad_template_get (&sinktemplate));
159 gst_file_sink_class_init (GstFileSinkClass * klass)
161 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
162 GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
164 gobject_class->dispose = gst_file_sink_dispose;
166 gobject_class->set_property = gst_file_sink_set_property;
167 gobject_class->get_property = gst_file_sink_get_property;
169 g_object_class_install_property (gobject_class, PROP_LOCATION,
170 g_param_spec_string ("location", "File Location",
171 "Location of the file to write", NULL,
172 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
174 g_object_class_install_property (gobject_class, PROP_BUFFER_MODE,
175 g_param_spec_enum ("buffer-mode", "Buffering mode",
176 "The buffering mode to use", GST_TYPE_BUFFER_MODE,
177 DEFAULT_BUFFER_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
179 g_object_class_install_property (gobject_class, PROP_BUFFER_SIZE,
180 g_param_spec_uint ("buffer-size", "Buffering size",
181 "Size of buffer in number of bytes for line or full buffer-mode", 0,
182 G_MAXUINT, DEFAULT_BUFFER_SIZE,
183 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
185 gstbasesink_class->get_times = NULL;
186 gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_file_sink_start);
187 gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_file_sink_stop);
188 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_file_sink_render);
189 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_file_sink_event);
191 if (sizeof (off_t) < 8) {
192 GST_LOG ("No large file support, sizeof (off_t) = %" G_GSIZE_FORMAT "!",
198 gst_file_sink_init (GstFileSink * filesink, GstFileSinkClass * g_class)
202 pad = GST_BASE_SINK_PAD (filesink);
204 gst_pad_set_query_function (pad, GST_DEBUG_FUNCPTR (gst_file_sink_query));
206 filesink->filename = NULL;
207 filesink->file = NULL;
208 filesink->buffer_mode = DEFAULT_BUFFER_MODE;
209 filesink->buffer_size = DEFAULT_BUFFER_SIZE;
210 filesink->buffer = NULL;
212 gst_base_sink_set_sync (GST_BASE_SINK (filesink), FALSE);
216 gst_file_sink_dispose (GObject * object)
218 GstFileSink *sink = GST_FILE_SINK (object);
220 G_OBJECT_CLASS (parent_class)->dispose (object);
224 g_free (sink->filename);
225 sink->filename = NULL;
226 g_free (sink->buffer);
228 sink->buffer_size = 0;
232 gst_file_sink_set_location (GstFileSink * sink, const gchar * location)
237 g_free (sink->filename);
239 if (location != NULL) {
240 /* we store the filename as we received it from the application. On Windows
241 * this should be in UTF8 */
242 sink->filename = g_strdup (location);
243 sink->uri = gst_uri_construct ("file", sink->filename);
245 sink->filename = NULL;
254 g_warning ("Changing the `location' property on filesink when "
255 "a file is open not supported.");
261 gst_file_sink_set_property (GObject * object, guint prop_id,
262 const GValue * value, GParamSpec * pspec)
264 GstFileSink *sink = GST_FILE_SINK (object);
268 gst_file_sink_set_location (sink, g_value_get_string (value));
270 case PROP_BUFFER_MODE:
271 sink->buffer_mode = g_value_get_enum (value);
273 case PROP_BUFFER_SIZE:
274 sink->buffer_size = g_value_get_uint (value);
277 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
283 gst_file_sink_get_property (GObject * object, guint prop_id, GValue * value,
286 GstFileSink *sink = GST_FILE_SINK (object);
290 g_value_set_string (value, sink->filename);
292 case PROP_BUFFER_MODE:
293 g_value_set_enum (value, sink->buffer_mode);
295 case PROP_BUFFER_SIZE:
296 g_value_set_uint (value, sink->buffer_size);
299 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
305 gst_file_sink_open_file (GstFileSink * sink)
310 if (sink->filename == NULL || sink->filename[0] == '\0')
313 /* FIXME, can we use g_fopen here? some people say that the FILE object is
314 * local to the .so that performed the fopen call, which would not be us when
316 sink->file = fopen (sink->filename, "wb");
317 if (sink->file == NULL)
320 /* see if we are asked to perform a specific kind of buffering */
321 if ((mode = sink->buffer_mode) != -1) {
324 /* free previous buffer if any */
325 g_free (sink->buffer);
327 if (mode == _IONBF) {
332 /* allocate buffer */
333 sink->buffer = g_malloc (sink->buffer_size);
334 buffer_size = sink->buffer_size;
336 #ifdef HAVE_STDIO_EXT_H
337 GST_DEBUG_OBJECT (sink, "change buffer size %d to %d, mode %d",
338 __fbufsize (sink->file), buffer_size, mode);
340 GST_DEBUG_OBJECT (sink, "change buffer size to %d, mode %d",
341 sink->buffer_size, mode);
343 if (setvbuf (sink->file, sink->buffer, mode, buffer_size) != 0) {
344 GST_WARNING_OBJECT (sink, "warning: setvbuf failed: %s",
349 sink->current_pos = 0;
350 /* try to seek in the file to figure out if it is seekable */
351 sink->seekable = gst_file_sink_do_seek (sink, 0);
353 GST_DEBUG_OBJECT (sink, "opened file %s, seekable %d",
354 sink->filename, sink->seekable);
361 GST_ELEMENT_ERROR (sink, RESOURCE, NOT_FOUND,
362 (_("No file name specified for writing.")), (NULL));
367 GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE,
368 (_("Could not open file \"%s\" for writing."), sink->filename),
375 gst_file_sink_close_file (GstFileSink * sink)
378 if (fclose (sink->file) != 0)
381 GST_DEBUG_OBJECT (sink, "closed file");
384 g_free (sink->buffer);
392 GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
393 (_("Error closing file \"%s\"."), sink->filename), GST_ERROR_SYSTEM);
399 gst_file_sink_query (GstPad * pad, GstQuery * query)
404 self = GST_FILE_SINK (GST_PAD_PARENT (pad));
406 switch (GST_QUERY_TYPE (query)) {
407 case GST_QUERY_POSITION:
408 gst_query_parse_position (query, &format, NULL);
410 case GST_FORMAT_DEFAULT:
411 case GST_FORMAT_BYTES:
412 gst_query_set_position (query, GST_FORMAT_BYTES, self->current_pos);
418 case GST_QUERY_FORMATS:
419 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
423 gst_query_set_uri (query, self->uri);
427 return gst_pad_query_default (pad, query);
432 # define __GST_STDIO_SEEK_FUNCTION "fseeko"
433 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
434 # define __GST_STDIO_SEEK_FUNCTION "lseek"
436 # define __GST_STDIO_SEEK_FUNCTION "fseek"
440 gst_file_sink_do_seek (GstFileSink * filesink, guint64 new_offset)
442 GST_DEBUG_OBJECT (filesink, "Seeking to offset %" G_GUINT64_FORMAT
443 " using " __GST_STDIO_SEEK_FUNCTION, new_offset);
445 if (fflush (filesink->file))
449 if (fseeko (filesink->file, (off_t) new_offset, SEEK_SET) != 0)
451 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
452 if (lseek (fileno (filesink->file), (off_t) new_offset,
453 SEEK_SET) == (off_t) - 1)
456 if (fseek (filesink->file, (long) new_offset, SEEK_SET) != 0)
460 /* adjust position reporting after seek;
461 * presumably this should basically yield new_offset */
462 gst_file_sink_get_current_offset (filesink, &filesink->current_pos);
469 GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
474 GST_DEBUG_OBJECT (filesink, "Seeking failed: %s", g_strerror (errno));
479 /* handle events (search) */
481 gst_file_sink_event (GstBaseSink * sink, GstEvent * event)
484 GstFileSink *filesink;
486 filesink = GST_FILE_SINK (sink);
488 type = GST_EVENT_TYPE (event);
491 case GST_EVENT_NEWSEGMENT:
493 gint64 start, stop, pos;
496 gst_event_parse_new_segment (event, NULL, NULL, &format, &start,
499 if (format == GST_FORMAT_BYTES) {
500 /* only try to seek and fail when we are going to a different
502 if (filesink->current_pos != start) {
503 /* FIXME, the seek should be performed on the pos field, start/stop are
504 * just boundaries for valid bytes offsets. We should also fill the file
505 * with zeroes if the new position extends the current EOF (sparse streams
506 * and segment accumulation). */
507 if (!gst_file_sink_do_seek (filesink, (guint64) start))
510 GST_DEBUG_OBJECT (filesink, "Ignored NEWSEGMENT, no seek needed");
513 GST_DEBUG_OBJECT (filesink,
514 "Ignored NEWSEGMENT event of format %u (%s)", (guint) format,
515 gst_format_get_name (format));
520 if (fflush (filesink->file))
532 GST_ELEMENT_ERROR (filesink, RESOURCE, SEEK,
533 (_("Error while seeking in file \"%s\"."), filesink->filename),
539 GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
540 (_("Error while writing to file \"%s\"."), filesink->filename),
547 gst_file_sink_get_current_offset (GstFileSink * filesink, guint64 * p_pos)
552 ret = ftello (filesink->file);
553 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
554 if (fflush (filesink->file)) {
555 GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
556 /* ignore and continue */
558 ret = lseek (fileno (filesink->file), 0, SEEK_CUR);
560 ret = (off_t) ftell (filesink->file);
563 if (ret != (off_t) - 1)
564 *p_pos = (guint64) ret;
566 return (ret != (off_t) - 1);
570 gst_file_sink_render (GstBaseSink * sink, GstBuffer * buffer)
572 GstFileSink *filesink;
576 filesink = GST_FILE_SINK (sink);
578 size = GST_BUFFER_SIZE (buffer);
579 data = GST_BUFFER_DATA (buffer);
581 GST_DEBUG_OBJECT (filesink, "writing %u bytes at %" G_GUINT64_FORMAT,
582 size, filesink->current_pos);
584 if (size > 0 && data != NULL) {
585 if (fwrite (data, size, 1, filesink->file) != 1)
588 filesink->current_pos += size;
597 GST_ELEMENT_ERROR (filesink, RESOURCE, NO_SPACE_LEFT, (NULL), (NULL));
601 GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
602 (_("Error while writing to file \"%s\"."), filesink->filename),
603 ("%s", g_strerror (errno)));
606 return GST_FLOW_ERROR;
611 gst_file_sink_start (GstBaseSink * basesink)
613 return gst_file_sink_open_file (GST_FILE_SINK (basesink));
617 gst_file_sink_stop (GstBaseSink * basesink)
619 gst_file_sink_close_file (GST_FILE_SINK (basesink));
623 /*** GSTURIHANDLER INTERFACE *************************************************/
626 gst_file_sink_uri_get_type (void)
632 gst_file_sink_uri_get_protocols (void)
634 static gchar *protocols[] = { "file", NULL };
640 gst_file_sink_uri_get_uri (GstURIHandler * handler)
642 GstFileSink *sink = GST_FILE_SINK (handler);
648 gst_file_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri)
650 gchar *protocol, *location;
652 GstFileSink *sink = GST_FILE_SINK (handler);
654 protocol = gst_uri_get_protocol (uri);
655 if (strcmp (protocol, "file") != 0) {
661 /* allow file://localhost/foo/bar by stripping localhost but fail
662 * for every other hostname */
663 if (g_str_has_prefix (uri, "file://localhost/")) {
666 /* 16 == strlen ("file://localhost") */
667 tmp = g_strconcat ("file://", uri + 16, NULL);
668 /* we use gst_uri_get_location() although we already have the
669 * "location" with uri + 16 because it provides unescaping */
670 location = gst_uri_get_location (tmp);
672 } else if (strcmp (uri, "file://") == 0) {
673 /* Special case for "file://" as this is used by some applications
674 * to test with gst_element_make_from_uri if there's an element
675 * that supports the URI protocol. */
676 gst_file_sink_set_location (sink, NULL);
679 location = gst_uri_get_location (uri);
684 if (!g_path_is_absolute (location)) {
689 ret = gst_file_sink_set_location (sink, location);
696 gst_file_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
698 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
700 iface->get_type = gst_file_sink_uri_get_type;
701 iface->get_protocols = gst_file_sink_uri_get_protocols;
702 iface->get_uri = gst_file_sink_uri_get_uri;
703 iface->set_uri = gst_file_sink_uri_set_uri;