2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 * SECTION:element-filesink
24 * @short_description: write stream to a file
25 * @see_also: #GstFileSrc
27 * Write incoming data to a file in the local file system.
34 #include "../../gst/gst-i18n-lib.h"
38 #include "gstfilesink.h"
41 #include <sys/types.h>
47 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
52 GST_DEBUG_CATEGORY_STATIC (gst_file_sink_debug);
53 #define GST_CAT_DEFAULT gst_file_sink_debug
55 static GstElementDetails gst_file_sink_details =
56 GST_ELEMENT_DETAILS ("File Sink",
58 "Write stream to a file",
59 "Thomas <thomas@apestaart.org>");
67 static void gst_file_sink_dispose (GObject * object);
69 static void gst_file_sink_set_property (GObject * object, guint prop_id,
70 const GValue * value, GParamSpec * pspec);
71 static void gst_file_sink_get_property (GObject * object, guint prop_id,
72 GValue * value, GParamSpec * pspec);
74 static gboolean gst_file_sink_open_file (GstFileSink * sink);
75 static void gst_file_sink_close_file (GstFileSink * sink);
77 static gboolean gst_file_sink_start (GstBaseSink * sink);
78 static gboolean gst_file_sink_stop (GstBaseSink * sink);
79 static gboolean gst_file_sink_event (GstBaseSink * sink, GstEvent * event);
80 static GstFlowReturn gst_file_sink_render (GstBaseSink * sink,
83 static gboolean gst_file_sink_query (GstPad * pad, GstQuery * query);
85 static void gst_file_sink_uri_handler_init (gpointer g_iface,
90 _do_init (GType filesink_type)
92 static const GInterfaceInfo urihandler_info = {
93 gst_file_sink_uri_handler_init,
98 g_type_add_interface_static (filesink_type, GST_TYPE_URI_HANDLER,
100 GST_DEBUG_CATEGORY_INIT (gst_file_sink_debug, "filesink", 0,
104 GST_BOILERPLATE_FULL (GstFileSink, gst_file_sink, GstBaseSink,
105 GST_TYPE_BASE_SINK, _do_init);
108 gst_file_sink_base_init (gpointer g_class)
110 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
112 gst_element_class_add_pad_template (gstelement_class,
113 gst_static_pad_template_get (&sinktemplate));
114 gst_element_class_set_details (gstelement_class, &gst_file_sink_details);
118 gst_file_sink_class_init (GstFileSinkClass * klass)
120 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
121 GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
123 gobject_class->set_property = gst_file_sink_set_property;
124 gobject_class->get_property = gst_file_sink_get_property;
126 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LOCATION,
127 g_param_spec_string ("location", "File Location",
128 "Location of the file to write", NULL, G_PARAM_READWRITE));
130 gobject_class->dispose = gst_file_sink_dispose;
132 gstbasesink_class->get_times = NULL;
133 gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_file_sink_start);
134 gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_file_sink_stop);
135 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_file_sink_render);
136 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_file_sink_event);
138 if (sizeof (off_t) < 8) {
139 GST_LOG ("No large file support, sizeof (off_t) = %u", sizeof (off_t));
144 gst_file_sink_init (GstFileSink * filesink, GstFileSinkClass * g_class)
148 pad = GST_BASE_SINK_PAD (filesink);
150 gst_pad_set_query_function (pad, GST_DEBUG_FUNCPTR (gst_file_sink_query));
152 filesink->filename = NULL;
153 filesink->file = NULL;
155 GST_BASE_SINK (filesink)->sync = FALSE;
159 gst_file_sink_dispose (GObject * object)
161 GstFileSink *sink = GST_FILE_SINK (object);
163 G_OBJECT_CLASS (parent_class)->dispose (object);
167 g_free (sink->filename);
168 sink->filename = NULL;
172 gst_file_sink_set_location (GstFileSink * sink, const gchar * location)
175 g_warning ("Changing the `location' property on filesink when "
176 "a file is open not supported.");
180 g_free (sink->filename);
182 if (location != NULL) {
183 sink->filename = g_strdup (location);
184 sink->uri = gst_uri_construct ("file", location);
186 sink->filename = NULL;
193 gst_file_sink_set_property (GObject * object, guint prop_id,
194 const GValue * value, GParamSpec * pspec)
196 GstFileSink *sink = GST_FILE_SINK (object);
200 gst_file_sink_set_location (sink, g_value_get_string (value));
203 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
209 gst_file_sink_get_property (GObject * object, guint prop_id, GValue * value,
212 GstFileSink *sink = GST_FILE_SINK (object);
216 g_value_set_string (value, sink->filename);
219 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
225 gst_file_sink_open_file (GstFileSink * sink)
228 if (sink->filename == NULL || sink->filename[0] == '\0') {
229 GST_ELEMENT_ERROR (sink, RESOURCE, NOT_FOUND,
230 (_("No file name specified for writing.")), (NULL));
234 sink->file = fopen (sink->filename, "wb");
235 if (sink->file == NULL) {
236 GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE,
237 (_("Could not open file \"%s\" for writing."), sink->filename),
242 sink->data_written = 0;
248 gst_file_sink_close_file (GstFileSink * sink)
251 if (fclose (sink->file) != 0) {
252 GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
253 (_("Error closing file \"%s\"."), sink->filename), GST_ERROR_SYSTEM);
259 gst_file_sink_query (GstPad * pad, GstQuery * query)
264 self = GST_FILE_SINK (GST_PAD_PARENT (pad));
266 switch (GST_QUERY_TYPE (query)) {
267 case GST_QUERY_POSITION:
268 gst_query_parse_position (query, &format, NULL);
270 case GST_FORMAT_DEFAULT:
271 case GST_FORMAT_BYTES:
272 gst_query_set_position (query, GST_FORMAT_BYTES, self->data_written);
278 case GST_QUERY_FORMATS:
279 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
283 return gst_pad_query_default (pad, query);
288 # define __GST_STDIO_SEEK_FUNCTION "fseeko"
290 # define __GST_STDIO_SEEK_FUNCTION "lseek"
292 # define __GST_STDIO_SEEK_FUNCTION "fseek"
296 gst_file_sink_do_seek (GstFileSink * filesink, guint64 new_offset)
298 GST_DEBUG_OBJECT (filesink, "Seeking to offset %" G_GUINT64_FORMAT
299 " using " __GST_STDIO_SEEK_FUNCTION, new_offset);
301 if (fflush (filesink->file))
305 if (fseeko (filesink->file, (off_t) new_offset, SEEK_SET) != 0)
308 if (lseek (fileno (filesink->file), (off_t) new_offset,
309 SEEK_SET) == (off_t) - 1)
312 if (fseek (filesink->file, (long) new_offset, SEEK_SET) != 0)
321 GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
326 GST_DEBUG_OBJECT (filesink, "Seeking failed: %s", g_strerror (errno));
331 /* handle events (search) */
333 gst_file_sink_event (GstBaseSink * sink, GstEvent * event)
336 GstFileSink *filesink;
338 filesink = GST_FILE_SINK (sink);
340 type = GST_EVENT_TYPE (event);
343 case GST_EVENT_NEWSEGMENT:
345 gint64 soffset, eoffset;
348 gst_event_parse_new_segment (event, NULL, NULL, &format, &soffset,
351 if (format == GST_FORMAT_BYTES) {
352 gst_file_sink_do_seek (filesink, (guint64) soffset);
354 GST_DEBUG ("Ignored NEWSEGMENT event of format %u", (guint) format);
359 if (fflush (filesink->file)) {
360 GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
361 (_("Error while writing to file \"%s\"."), filesink->filename),
373 gst_file_sink_get_current_offset (GstFileSink * filesink, guint64 * p_pos)
378 ret = ftello (filesink->file);
380 if (fflush (filesink->file)) {
381 GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
382 /* ignore and continue */
384 ret = lseek (fileno (filesink->file), 0, SEEK_CUR);
386 ret = (off_t) ftell (filesink->file);
389 *p_pos = (guint64) ret;
391 return (ret != (off_t) - 1);
395 gst_file_sink_render (GstBaseSink * sink, GstBuffer * buffer)
397 GstFileSink *filesink;
400 guint64 back_pending = 0;
402 size = GST_BUFFER_SIZE (buffer);
404 filesink = GST_FILE_SINK (sink);
406 if (!gst_file_sink_get_current_offset (filesink, &cur_pos))
409 if (cur_pos < filesink->data_written)
410 back_pending = filesink->data_written - cur_pos;
412 GST_DEBUG_OBJECT (filesink, "writing %u bytes at %" G_GUINT64_FORMAT,
415 if (fwrite (GST_BUFFER_DATA (buffer), size, 1, filesink->file) != 1)
418 filesink->data_written += size - back_pending;
424 GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
425 (_("Error while writing to file \"%s\"."), filesink->filename),
426 ("%s", g_strerror (errno)));
428 return GST_FLOW_ERROR;
432 gst_file_sink_start (GstBaseSink * basesink)
434 return gst_file_sink_open_file (GST_FILE_SINK (basesink));
438 gst_file_sink_stop (GstBaseSink * basesink)
440 gst_file_sink_close_file (GST_FILE_SINK (basesink));
444 /*** GSTURIHANDLER INTERFACE *************************************************/
447 gst_file_sink_uri_get_type (void)
452 gst_file_sink_uri_get_protocols (void)
454 static gchar *protocols[] = { "file", NULL };
459 gst_file_sink_uri_get_uri (GstURIHandler * handler)
461 GstFileSink *sink = GST_FILE_SINK (handler);
467 gst_file_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri)
469 gchar *protocol, *location;
471 GstFileSink *sink = GST_FILE_SINK (handler);
473 protocol = gst_uri_get_protocol (uri);
474 if (strcmp (protocol, "file") != 0) {
479 location = gst_uri_get_location (uri);
480 ret = gst_file_sink_set_location (sink, location);
487 gst_file_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
489 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
491 iface->get_type = gst_file_sink_uri_get_type;
492 iface->get_protocols = gst_file_sink_uri_get_protocols;
493 iface->get_uri = gst_file_sink_uri_get_uri;
494 iface->set_uri = gst_file_sink_uri_set_uri;