Remove 0.10-related documentation and "Since" markers
[platform/upstream/gstreamer.git] / plugins / elements / gstfilesink.c
1 /* GStreamer
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>
5  *
6  * gstfilesink.c:
7  *
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.
12  *
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.
17  *
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.
22  */
23 /**
24  * SECTION:element-filesink
25  * @see_also: #GstFileSrc
26  *
27  * Write incoming data to a file in the local file system.
28  *
29  * <refsect2>
30  * <title>Example launch line</title>
31  * |[
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.
34  * </refsect2>
35  */
36
37 #ifdef HAVE_CONFIG_H
38 #  include "config.h"
39 #endif
40
41 #include "../../gst/gst-i18n-lib.h"
42
43 #include <gst/gst.h>
44 #include <stdio.h>              /* for fseeko() */
45 #ifdef HAVE_STDIO_EXT_H
46 #include <stdio_ext.h>          /* for __fbufsize, for debugging */
47 #endif
48 #include <errno.h>
49 #include "gstfilesink.h"
50 #include <string.h>
51 #include <sys/types.h>
52
53 #ifdef G_OS_WIN32
54 #include <io.h>                 /* lseek, open, close, read */
55 #undef lseek
56 #define lseek _lseeki64
57 #undef off_t
58 #define off_t guint64
59 #ifdef _MSC_VER                 /* Check if we are using MSVC, fileno is deprecated in favour */
60 #define fileno _fileno          /* of _fileno */
61 #endif
62 #endif
63
64 #include <sys/stat.h>
65 #ifdef HAVE_UNISTD_H
66 #include <unistd.h>
67 #endif
68
69 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
70     GST_PAD_SINK,
71     GST_PAD_ALWAYS,
72     GST_STATIC_CAPS_ANY);
73
74 #define GST_TYPE_BUFFER_MODE (buffer_mode_get_type ())
75 static GType
76 buffer_mode_get_type (void)
77 {
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"},
84     {0, NULL, NULL},
85   };
86
87   if (!buffer_mode_type) {
88     buffer_mode_type =
89         g_enum_register_static ("GstFileSinkBufferMode", buffer_mode);
90   }
91   return buffer_mode_type;
92 }
93
94 GST_DEBUG_CATEGORY_STATIC (gst_file_sink_debug);
95 #define GST_CAT_DEFAULT gst_file_sink_debug
96
97 #define DEFAULT_LOCATION        NULL
98 #define DEFAULT_BUFFER_MODE     -1
99 #define DEFAULT_BUFFER_SIZE     64 * 1024
100 #define DEFAULT_APPEND          FALSE
101
102 enum
103 {
104   PROP_0,
105   PROP_LOCATION,
106   PROP_BUFFER_MODE,
107   PROP_BUFFER_SIZE,
108   PROP_APPEND,
109   PROP_LAST
110 };
111
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. */
115 static FILE *
116 gst_fopen (const gchar * filename, const gchar * mode)
117 {
118 #ifdef G_OS_WIN32
119   wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
120   wchar_t *wmode;
121   FILE *retval;
122   int save_errno;
123
124   if (wfilename == NULL) {
125     errno = EINVAL;
126     return NULL;
127   }
128
129   wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
130
131   if (wmode == NULL) {
132     g_free (wfilename);
133     errno = EINVAL;
134     return NULL;
135   }
136
137   retval = _wfopen (wfilename, wmode);
138   save_errno = errno;
139
140   g_free (wfilename);
141   g_free (wmode);
142
143   errno = save_errno;
144   return retval;
145 #else
146   return fopen (filename, mode);
147 #endif
148 }
149
150 static void gst_file_sink_dispose (GObject * object);
151
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);
156
157 static gboolean gst_file_sink_open_file (GstFileSink * sink);
158 static void gst_file_sink_close_file (GstFileSink * sink);
159
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,
164     GstBuffer * buffer);
165
166 static gboolean gst_file_sink_do_seek (GstFileSink * filesink,
167     guint64 new_offset);
168 static gboolean gst_file_sink_get_current_offset (GstFileSink * filesink,
169     guint64 * p_pos);
170
171 static gboolean gst_file_sink_query (GstBaseSink * bsink, GstQuery * query);
172
173 static void gst_file_sink_uri_handler_init (gpointer g_iface,
174     gpointer iface_data);
175
176 #define _do_init \
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,
181     _do_init);
182
183 static void
184 gst_file_sink_class_init (GstFileSinkClass * klass)
185 {
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);
189
190   gobject_class->dispose = gst_file_sink_dispose;
191
192   gobject_class->set_property = gst_file_sink_set_property;
193   gobject_class->get_property = gst_file_sink_get_property;
194
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));
199
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));
204
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));
210
211   /**
212    * GstFileSink:append
213    * 
214    * Append to an already existing file.
215    */
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));
220
221   gst_element_class_set_static_metadata (gstelement_class,
222       "File Sink",
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));
227
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);
233
234   if (sizeof (off_t) < 8) {
235     GST_LOG ("No large file support, sizeof (off_t) = %" G_GSIZE_FORMAT "!",
236         sizeof (off_t));
237   }
238 }
239
240 static void
241 gst_file_sink_init (GstFileSink * filesink)
242 {
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;
249
250   gst_base_sink_set_sync (GST_BASE_SINK (filesink), FALSE);
251 }
252
253 static void
254 gst_file_sink_dispose (GObject * object)
255 {
256   GstFileSink *sink = GST_FILE_SINK (object);
257
258   G_OBJECT_CLASS (parent_class)->dispose (object);
259
260   g_free (sink->uri);
261   sink->uri = NULL;
262   g_free (sink->filename);
263   sink->filename = NULL;
264   g_free (sink->buffer);
265   sink->buffer = NULL;
266   sink->buffer_size = 0;
267 }
268
269 static gboolean
270 gst_file_sink_set_location (GstFileSink * sink, const gchar * location,
271     GError ** error)
272 {
273   if (sink->file)
274     goto was_open;
275
276   g_free (sink->filename);
277   g_free (sink->uri);
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);
285   } else {
286     sink->filename = NULL;
287     sink->uri = NULL;
288   }
289
290   return TRUE;
291
292   /* ERRORS */
293 was_open:
294   {
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");
300     return FALSE;
301   }
302 }
303
304 static void
305 gst_file_sink_set_property (GObject * object, guint prop_id,
306     const GValue * value, GParamSpec * pspec)
307 {
308   GstFileSink *sink = GST_FILE_SINK (object);
309
310   switch (prop_id) {
311     case PROP_LOCATION:
312       gst_file_sink_set_location (sink, g_value_get_string (value), NULL);
313       break;
314     case PROP_BUFFER_MODE:
315       sink->buffer_mode = g_value_get_enum (value);
316       break;
317     case PROP_BUFFER_SIZE:
318       sink->buffer_size = g_value_get_uint (value);
319       break;
320     case PROP_APPEND:
321       sink->append = g_value_get_boolean (value);
322       break;
323     default:
324       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
325       break;
326   }
327 }
328
329 static void
330 gst_file_sink_get_property (GObject * object, guint prop_id, GValue * value,
331     GParamSpec * pspec)
332 {
333   GstFileSink *sink = GST_FILE_SINK (object);
334
335   switch (prop_id) {
336     case PROP_LOCATION:
337       g_value_set_string (value, sink->filename);
338       break;
339     case PROP_BUFFER_MODE:
340       g_value_set_enum (value, sink->buffer_mode);
341       break;
342     case PROP_BUFFER_SIZE:
343       g_value_set_uint (value, sink->buffer_size);
344       break;
345     case PROP_APPEND:
346       g_value_set_boolean (value, sink->append);
347       break;
348     default:
349       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
350       break;
351   }
352 }
353
354 static gboolean
355 gst_file_sink_open_file (GstFileSink * sink)
356 {
357   gint mode;
358
359   /* open the file */
360   if (sink->filename == NULL || sink->filename[0] == '\0')
361     goto no_filename;
362
363   if (sink->append)
364     sink->file = gst_fopen (sink->filename, "ab");
365   else
366     sink->file = gst_fopen (sink->filename, "wb");
367   if (sink->file == NULL)
368     goto open_failed;
369
370   /* see if we are asked to perform a specific kind of buffering */
371   if ((mode = sink->buffer_mode) != -1) {
372     guint buffer_size;
373
374     /* free previous buffer if any */
375     g_free (sink->buffer);
376
377     if (mode == _IONBF) {
378       /* no buffering */
379       sink->buffer = NULL;
380       buffer_size = 0;
381     } else {
382       /* allocate buffer */
383       sink->buffer = g_malloc (sink->buffer_size);
384       buffer_size = sink->buffer_size;
385     }
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);
389 #else
390     GST_DEBUG_OBJECT (sink, "change  buffer size to %u, mode %d",
391         sink->buffer_size, mode);
392 #endif
393     if (setvbuf (sink->file, sink->buffer, mode, buffer_size) != 0) {
394       GST_WARNING_OBJECT (sink, "warning: setvbuf failed: %s",
395           g_strerror (errno));
396     }
397   }
398
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);
402
403   GST_DEBUG_OBJECT (sink, "opened file %s, seekable %d",
404       sink->filename, sink->seekable);
405
406   return TRUE;
407
408   /* ERRORS */
409 no_filename:
410   {
411     GST_ELEMENT_ERROR (sink, RESOURCE, NOT_FOUND,
412         (_("No file name specified for writing.")), (NULL));
413     return FALSE;
414   }
415 open_failed:
416   {
417     GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE,
418         (_("Could not open file \"%s\" for writing."), sink->filename),
419         GST_ERROR_SYSTEM);
420     return FALSE;
421   }
422 }
423
424 static void
425 gst_file_sink_close_file (GstFileSink * sink)
426 {
427   if (sink->file) {
428     if (fclose (sink->file) != 0)
429       goto close_failed;
430
431     GST_DEBUG_OBJECT (sink, "closed file");
432     sink->file = NULL;
433
434     g_free (sink->buffer);
435     sink->buffer = NULL;
436   }
437   return;
438
439   /* ERRORS */
440 close_failed:
441   {
442     GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
443         (_("Error closing file \"%s\"."), sink->filename), GST_ERROR_SYSTEM);
444     return;
445   }
446 }
447
448 static gboolean
449 gst_file_sink_query (GstBaseSink * bsink, GstQuery * query)
450 {
451   gboolean res;
452   GstFileSink *self;
453   GstFormat format;
454
455   self = GST_FILE_SINK (bsink);
456
457   switch (GST_QUERY_TYPE (query)) {
458     case GST_QUERY_POSITION:
459       gst_query_parse_position (query, &format, NULL);
460
461       switch (format) {
462         case GST_FORMAT_DEFAULT:
463         case GST_FORMAT_BYTES:
464           gst_query_set_position (query, GST_FORMAT_BYTES, self->current_pos);
465           res = TRUE;
466           break;
467         default:
468           res = FALSE;
469           break;
470       }
471       break;
472
473     case GST_QUERY_FORMATS:
474       gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
475       res = TRUE;
476       break;
477
478     case GST_QUERY_URI:
479       gst_query_set_uri (query, self->uri);
480       res = TRUE;
481       break;
482
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);
487       } else {
488         gst_query_set_seeking (query, format, FALSE, 0, -1);
489       }
490       res = TRUE;
491       break;
492
493     default:
494       res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
495       break;
496   }
497   return res;
498 }
499
500 #ifdef HAVE_FSEEKO
501 # define __GST_STDIO_SEEK_FUNCTION "fseeko"
502 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
503 # define __GST_STDIO_SEEK_FUNCTION "lseek"
504 #else
505 # define __GST_STDIO_SEEK_FUNCTION "fseek"
506 #endif
507
508 static gboolean
509 gst_file_sink_do_seek (GstFileSink * filesink, guint64 new_offset)
510 {
511   GST_DEBUG_OBJECT (filesink, "Seeking to offset %" G_GUINT64_FORMAT
512       " using " __GST_STDIO_SEEK_FUNCTION, new_offset);
513
514   if (fflush (filesink->file))
515     goto flush_failed;
516
517 #ifdef HAVE_FSEEKO
518   if (fseeko (filesink->file, (off_t) new_offset, SEEK_SET) != 0)
519     goto seek_failed;
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)
523     goto seek_failed;
524 #else
525   if (fseek (filesink->file, (long) new_offset, SEEK_SET) != 0)
526     goto seek_failed;
527 #endif
528
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);
532
533   return TRUE;
534
535   /* ERRORS */
536 flush_failed:
537   {
538     GST_DEBUG_OBJECT (filesink, "Flush failed: %s", g_strerror (errno));
539     return FALSE;
540   }
541 seek_failed:
542   {
543     GST_DEBUG_OBJECT (filesink, "Seeking failed: %s", g_strerror (errno));
544     return FALSE;
545   }
546 }
547
548 /* handle events (search) */
549 static gboolean
550 gst_file_sink_event (GstBaseSink * sink, GstEvent * event)
551 {
552   GstEventType type;
553   GstFileSink *filesink;
554
555   filesink = GST_FILE_SINK (sink);
556
557   type = GST_EVENT_TYPE (event);
558
559   switch (type) {
560     case GST_EVENT_SEGMENT:
561     {
562       const GstSegment *segment;
563
564       gst_event_parse_segment (event, &segment);
565
566       if (segment->format == GST_FORMAT_BYTES) {
567         /* only try to seek and fail when we are going to a different
568          * position */
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))
575             goto seek_failed;
576         } else {
577           GST_DEBUG_OBJECT (filesink, "Ignored SEGMENT, no seek needed");
578         }
579       } else {
580         GST_DEBUG_OBJECT (filesink,
581             "Ignored SEGMENT event of format %u (%s)", (guint) segment->format,
582             gst_format_get_name (segment->format));
583       }
584       break;
585     }
586     case GST_EVENT_EOS:
587       if (fflush (filesink->file))
588         goto flush_failed;
589       break;
590     default:
591       break;
592   }
593
594   return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
595
596   /* ERRORS */
597 seek_failed:
598   {
599     GST_ELEMENT_ERROR (filesink, RESOURCE, SEEK,
600         (_("Error while seeking in file \"%s\"."), filesink->filename),
601         GST_ERROR_SYSTEM);
602     gst_event_unref (event);
603     return FALSE;
604   }
605 flush_failed:
606   {
607     GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
608         (_("Error while writing to file \"%s\"."), filesink->filename),
609         GST_ERROR_SYSTEM);
610     gst_event_unref (event);
611     return FALSE;
612   }
613 }
614
615 static gboolean
616 gst_file_sink_get_current_offset (GstFileSink * filesink, guint64 * p_pos)
617 {
618   off_t ret = -1;
619
620 #ifdef HAVE_FTELLO
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 */
626   }
627   ret = lseek (fileno (filesink->file), 0, SEEK_CUR);
628 #else
629   ret = (off_t) ftell (filesink->file);
630 #endif
631
632   if (ret != (off_t) - 1)
633     *p_pos = (guint64) ret;
634
635   return (ret != (off_t) - 1);
636 }
637
638 static GstFlowReturn
639 gst_file_sink_render (GstBaseSink * sink, GstBuffer * buffer)
640 {
641   GstFileSink *filesink;
642   GstMapInfo info;
643
644   filesink = GST_FILE_SINK (sink);
645
646   gst_buffer_map (buffer, &info, GST_MAP_READ);
647
648   GST_DEBUG_OBJECT (filesink,
649       "writing %" G_GSIZE_FORMAT " bytes at %" G_GUINT64_FORMAT,
650       info.size, filesink->current_pos);
651
652   if (info.size > 0 && info.data != NULL) {
653     if (fwrite (info.data, info.size, 1, filesink->file) != 1)
654       goto handle_error;
655
656     filesink->current_pos += info.size;
657   }
658   gst_buffer_unmap (buffer, &info);
659
660   return GST_FLOW_OK;
661
662 handle_error:
663   {
664     switch (errno) {
665       case ENOSPC:{
666         GST_ELEMENT_ERROR (filesink, RESOURCE, NO_SPACE_LEFT, (NULL), (NULL));
667         break;
668       }
669       default:{
670         GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
671             (_("Error while writing to file \"%s\"."), filesink->filename),
672             ("%s", g_strerror (errno)));
673       }
674     }
675     gst_buffer_unmap (buffer, &info);
676     return GST_FLOW_ERROR;
677   }
678 }
679
680 static gboolean
681 gst_file_sink_start (GstBaseSink * basesink)
682 {
683   return gst_file_sink_open_file (GST_FILE_SINK (basesink));
684 }
685
686 static gboolean
687 gst_file_sink_stop (GstBaseSink * basesink)
688 {
689   gst_file_sink_close_file (GST_FILE_SINK (basesink));
690   return TRUE;
691 }
692
693 /*** GSTURIHANDLER INTERFACE *************************************************/
694
695 static GstURIType
696 gst_file_sink_uri_get_type (GType type)
697 {
698   return GST_URI_SINK;
699 }
700
701 static const gchar *const *
702 gst_file_sink_uri_get_protocols (GType type)
703 {
704   static const gchar *protocols[] = { "file", NULL };
705
706   return protocols;
707 }
708
709 static gchar *
710 gst_file_sink_uri_get_uri (GstURIHandler * handler)
711 {
712   GstFileSink *sink = GST_FILE_SINK (handler);
713
714   /* FIXME: make thread-safe */
715   return g_strdup (sink->uri);
716 }
717
718 static gboolean
719 gst_file_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri,
720     GError ** error)
721 {
722   gchar *location;
723   gboolean ret;
724   GstFileSink *sink = GST_FILE_SINK (handler);
725
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/")) {
729     char *tmp;
730
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);
736     g_free (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);
742     return TRUE;
743   } else {
744     location = gst_uri_get_location (uri);
745   }
746
747   if (!location) {
748     g_set_error_literal (error, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
749         "File URI without location");
750     return FALSE;
751   }
752
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");
756     g_free (location);
757     return FALSE;
758   }
759
760   ret = gst_file_sink_set_location (sink, location, error);
761   g_free (location);
762
763   return ret;
764 }
765
766 static void
767 gst_file_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
768 {
769   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
770
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;
775 }