2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2001 Bastien Nocera <hadess@hadess.net>
5 * 2003 Colin Walters <walters@verbum.org>
6 * 2005 Tim-Philipp Müller <tim centricular net>
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Library General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Library General Public License for more details.
20 * You should have received a copy of the GNU Library General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 02111-1307, USA.
27 * SECTION:element-gnomevfssink
28 * @see_also: #GstFileSink, #GstGnomeVFSSrc
30 * This plugin writes incoming data to a local or remote location specified
31 * by an URI. This location can be specified using any protocol supported by
32 * the GnomeVFS library. Common protocols are 'file', 'ftp', or 'smb'.
34 * Applications can connect to the #GstGnomeVFSSink::allow-overwrite signal to
35 * receive a callback when an existing file will be overwritten. The return
36 * value of the signal will determine if gnomevfssink will overwrite the
37 * resource or abort with an error.
40 * <title>Example launch lines</title>
42 * gst-launch -v filesrc location=input.xyz ! gnomevfssink location=file:///home/joe/out.xyz
43 * ]| The above pipeline will simply copy a local file. Instead of gnomevfssink,
44 * we could just as well have used the filesink element here.
46 * gst-launch -v filesrc location=foo.mp3 ! mad ! flacenc ! gnomevfssink location=smb://othercomputer/foo.flac
47 * ]| The above pipeline will re-encode an mp3 file into FLAC format and store
48 * it on a remote host using the Samba protocol.
51 * Last reviewed on 2006-02-28 (0.10.4)
58 #include "gstgnomevfssink.h"
60 #include "gst/gst-i18n-plugin.h"
63 #include <libgnomevfs/gnome-vfs.h>
81 static void gst_gnome_vfs_sink_finalize (GObject * obj);
83 static void gst_gnome_vfs_sink_uri_handler_init (gpointer g_iface,
86 static void gst_gnome_vfs_sink_set_property (GObject * object, guint prop_id,
87 const GValue * value, GParamSpec * pspec);
88 static void gst_gnome_vfs_sink_get_property (GObject * object, guint prop_id,
89 GValue * value, GParamSpec * pspec);
91 static gboolean gst_gnome_vfs_sink_open_file (GstGnomeVFSSink * sink);
92 static void gst_gnome_vfs_sink_close_file (GstGnomeVFSSink * sink);
93 static gboolean gst_gnome_vfs_sink_start (GstBaseSink * basesink);
94 static gboolean gst_gnome_vfs_sink_stop (GstBaseSink * basesink);
95 static GstFlowReturn gst_gnome_vfs_sink_render (GstBaseSink * basesink,
97 static gboolean gst_gnome_vfs_sink_handle_event (GstBaseSink * basesink,
99 static gboolean gst_gnome_vfs_sink_query (GstPad * pad, GstQuery * query);
101 static guint gst_gnome_vfs_sink_signals[LAST_SIGNAL]; /* all 0 */
103 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
106 GST_STATIC_CAPS_ANY);
108 GST_DEBUG_CATEGORY_STATIC (gst_gnome_vfs_sink_debug);
109 #define GST_CAT_DEFAULT gst_gnome_vfs_sink_debug
112 gst_gnome_vfs_sink_do_init (GType type)
114 static const GInterfaceInfo urihandler_info = {
115 gst_gnome_vfs_sink_uri_handler_init,
120 g_type_add_interface_static (type, GST_TYPE_URI_HANDLER, &urihandler_info);
122 GST_DEBUG_CATEGORY_INIT (gst_gnome_vfs_sink_debug, "gnomevfssink", 0,
123 "Gnome VFS sink element");
126 #define gst_gnome_vfs_sink_parent_class parent_class
127 G_DEFINE_TYPE_WITH_CODE (GstGnomeVFSSink, gst_gnome_vfs_sink,
128 GST_TYPE_BASE_SINK, gst_gnome_vfs_sink_do_init (g_define_type_id));
131 _gst_boolean_allow_overwrite_accumulator (GSignalInvocationHint * ihint,
132 GValue * return_accu, const GValue * handler_return, gpointer dummy)
134 gboolean allow_overwrite;
136 allow_overwrite = g_value_get_boolean (handler_return);
137 if (!(ihint->run_type & G_SIGNAL_RUN_CLEANUP))
138 g_value_set_boolean (return_accu, allow_overwrite);
140 /* stop emission if signal doesn't allow overwriting */
141 return allow_overwrite;
145 gst_gnome_vfs_sink_class_init (GstGnomeVFSSinkClass * klass)
147 GstBaseSinkClass *basesink_class;
148 GstElementClass *gstelement_class;
149 GObjectClass *gobject_class;
151 gobject_class = (GObjectClass *) klass;
152 gstelement_class = (GstElementClass *) klass;
153 basesink_class = (GstBaseSinkClass *) klass;
155 gobject_class->set_property = gst_gnome_vfs_sink_set_property;
156 gobject_class->get_property = gst_gnome_vfs_sink_get_property;
157 gobject_class->finalize = gst_gnome_vfs_sink_finalize;
159 g_object_class_install_property (gobject_class, ARG_LOCATION,
160 g_param_spec_string ("location", "File Location",
161 "Location of the file to write", NULL,
162 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
163 g_object_class_install_property (gobject_class, ARG_URI,
164 g_param_spec_boxed ("uri", "GnomeVFSURI", "URI for GnomeVFS",
165 GST_TYPE_GNOME_VFS_URI, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
166 g_object_class_install_property (gobject_class, ARG_HANDLE,
167 g_param_spec_boxed ("handle", "GnomeVFSHandle", "Handle for GnomeVFS",
168 GST_TYPE_GNOME_VFS_HANDLE,
169 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
172 * GstGnomeVFSSink::allow-overwrite
173 * @sink: the object which received the signal
174 * @uri: the URI to be overwritten
176 * This signal is fired when gnomevfssink is about to overwrite an
177 * existing resource. The application can connect to this signal and ask
178 * the user if the resource may be overwritten.
180 * Returns: A boolean indicating that the resource may be overwritten.
182 gst_gnome_vfs_sink_signals[SIGNAL_ERASE_ASK] =
183 g_signal_new ("allow-overwrite", G_TYPE_FROM_CLASS (klass),
184 G_SIGNAL_RUN_CLEANUP, G_STRUCT_OFFSET (GstGnomeVFSSinkClass, erase_ask),
185 _gst_boolean_allow_overwrite_accumulator, NULL,
186 gst_marshal_BOOLEAN__POINTER, G_TYPE_BOOLEAN, 1, GST_TYPE_GNOME_VFS_URI);
188 gst_element_class_add_pad_template (gstelement_class,
189 gst_static_pad_template_get (&sinktemplate));
191 gst_element_class_set_details_simple (gstelement_class,
192 "GnomeVFS Sink", "Sink/File",
193 "Write a stream to a GnomeVFS URI", "Bastien Nocera <hadess@hadess.net>");
195 basesink_class->stop = GST_DEBUG_FUNCPTR (gst_gnome_vfs_sink_stop);
196 basesink_class->start = GST_DEBUG_FUNCPTR (gst_gnome_vfs_sink_start);
197 basesink_class->event = GST_DEBUG_FUNCPTR (gst_gnome_vfs_sink_handle_event);
198 basesink_class->render = GST_DEBUG_FUNCPTR (gst_gnome_vfs_sink_render);
199 basesink_class->get_times = NULL;
203 gst_gnome_vfs_sink_finalize (GObject * obj)
205 GstGnomeVFSSink *sink = GST_GNOME_VFS_SINK (obj);
208 gnome_vfs_uri_unref (sink->uri);
212 if (sink->uri_name) {
213 g_free (sink->uri_name);
214 sink->uri_name = NULL;
217 G_OBJECT_CLASS (parent_class)->finalize (obj);
221 gst_gnome_vfs_sink_init (GstGnomeVFSSink * sink)
223 gst_pad_set_query_function (GST_BASE_SINK_PAD (sink),
224 GST_DEBUG_FUNCPTR (gst_gnome_vfs_sink_query));
227 sink->uri_name = NULL;
229 sink->own_handle = FALSE;
230 sink->current_pos = 0;
232 GST_BASE_SINK (sink)->sync = FALSE;
236 gst_gnome_vfs_sink_set_property (GObject * object, guint prop_id,
237 const GValue * value, GParamSpec * pspec)
239 GstGnomeVFSSink *sink;
242 sink = GST_GNOME_VFS_SINK (object);
244 gst_element_get_state (GST_ELEMENT (sink), &cur_state, NULL, 0);
246 if (cur_state == GST_STATE_PLAYING || cur_state == GST_STATE_PAUSED) {
247 GST_WARNING_OBJECT (sink, "cannot set property when PAUSED or PLAYING");
251 GST_OBJECT_LOCK (sink);
255 const gchar *new_location;
258 gnome_vfs_uri_unref (sink->uri);
261 if (sink->uri_name) {
262 g_free (sink->uri_name);
263 sink->uri_name = NULL;
266 new_location = g_value_get_string (value);
268 sink->uri_name = gst_gnome_vfs_location_to_uri_string (new_location);
269 sink->uri = gnome_vfs_uri_new (sink->uri_name);
275 gnome_vfs_uri_unref (sink->uri);
278 if (sink->uri_name) {
279 g_free (sink->uri_name);
280 sink->uri_name = NULL;
282 if (g_value_get_boxed (value)) {
283 sink->uri = (GnomeVFSURI *) g_value_dup_boxed (value);
284 sink->uri_name = gnome_vfs_uri_to_string (sink->uri, 0);
290 gnome_vfs_uri_unref (sink->uri);
293 if (sink->uri_name) {
294 g_free (sink->uri_name);
295 sink->uri_name = NULL;
297 sink->handle = g_value_get_boxed (value);
301 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
305 GST_OBJECT_UNLOCK (sink);
309 gst_gnome_vfs_sink_get_property (GObject * object, guint prop_id,
310 GValue * value, GParamSpec * pspec)
312 GstGnomeVFSSink *sink;
314 sink = GST_GNOME_VFS_SINK (object);
316 GST_OBJECT_LOCK (sink);
320 g_value_set_string (value, sink->uri_name);
323 g_value_set_boxed (value, sink->uri);
326 g_value_set_boxed (value, sink->handle);
329 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
333 GST_OBJECT_UNLOCK (sink);
337 gst_gnome_vfs_sink_open_file (GstGnomeVFSSink * sink)
339 GnomeVFSResult result;
342 /* open the file, all permissions, umask will apply */
343 result = gnome_vfs_create_uri (&(sink->handle), sink->uri,
344 GNOME_VFS_OPEN_WRITE, TRUE,
345 GNOME_VFS_PERM_USER_READ | GNOME_VFS_PERM_USER_WRITE |
346 GNOME_VFS_PERM_GROUP_READ | GNOME_VFS_PERM_GROUP_WRITE |
347 GNOME_VFS_PERM_OTHER_READ | GNOME_VFS_PERM_OTHER_WRITE);
349 /* if the file existed and the property says to ask, then ask! */
350 if (result == GNOME_VFS_ERROR_FILE_EXISTS) {
351 gboolean erase_anyway = FALSE;
353 g_signal_emit (G_OBJECT (sink),
354 gst_gnome_vfs_sink_signals[SIGNAL_ERASE_ASK], 0, sink->uri,
357 result = gnome_vfs_create_uri (&(sink->handle), sink->uri,
358 GNOME_VFS_OPEN_WRITE, FALSE,
359 GNOME_VFS_PERM_USER_READ | GNOME_VFS_PERM_USER_WRITE |
360 GNOME_VFS_PERM_GROUP_READ | GNOME_VFS_PERM_GROUP_WRITE |
361 GNOME_VFS_PERM_OTHER_READ | GNOME_VFS_PERM_OTHER_WRITE);
365 GST_DEBUG_OBJECT (sink, "open: %s", gnome_vfs_result_to_string (result));
367 if (result != GNOME_VFS_OK) {
368 gchar *filename = gnome_vfs_uri_to_string (sink->uri,
369 GNOME_VFS_URI_HIDE_PASSWORD);
371 GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE,
372 (_("Could not open vfs file \"%s\" for writing: %s."),
373 filename, gnome_vfs_result_to_string (result)), GST_ERROR_SYSTEM);
377 sink->own_handle = TRUE;
378 } else if (!sink->handle) {
379 GST_ELEMENT_ERROR (sink, RESOURCE, FAILED, (_("No filename given")),
383 sink->own_handle = FALSE;
386 sink->current_pos = 0;
392 gst_gnome_vfs_sink_close_file (GstGnomeVFSSink * sink)
394 GnomeVFSResult result;
396 if (sink->own_handle) {
398 result = gnome_vfs_close (sink->handle);
400 if (result != GNOME_VFS_OK) {
401 gchar *filename = gnome_vfs_uri_to_string (sink->uri,
402 GNOME_VFS_URI_HIDE_PASSWORD);
404 GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
405 (_("Could not close vfs file \"%s\"."), filename), GST_ERROR_SYSTEM);
409 sink->own_handle = FALSE;
415 gst_gnome_vfs_sink_start (GstBaseSink * basesink)
419 ret = gst_gnome_vfs_sink_open_file (GST_GNOME_VFS_SINK (basesink));
425 gst_gnome_vfs_sink_stop (GstBaseSink * basesink)
427 GST_DEBUG_OBJECT (basesink, "closing ...");
428 gst_gnome_vfs_sink_close_file (GST_GNOME_VFS_SINK (basesink));
433 gst_gnome_vfs_sink_handle_event (GstBaseSink * basesink, GstEvent * event)
435 GstGnomeVFSSink *sink;
438 sink = GST_GNOME_VFS_SINK (basesink);
440 GST_DEBUG_OBJECT (sink, "processing %s event", GST_EVENT_TYPE_NAME (event));
442 switch (GST_EVENT_TYPE (event)) {
443 case GST_EVENT_SEGMENT:{
445 const GstSegment *segment;
447 gst_event_parse_segment (event, &segment);
449 if (segment->format != GST_FORMAT_BYTES) {
450 GST_WARNING_OBJECT (sink, "ignored NEWSEGMENT event in %s format",
451 gst_format_get_name (segment->format));
455 GST_LOG_OBJECT (sink, "seeking to offset %" G_GINT64_FORMAT,
457 res = gnome_vfs_seek (sink->handle, GNOME_VFS_SEEK_START, segment->start);
459 if (res != GNOME_VFS_OK) {
460 GST_ERROR_OBJECT (sink, "Failed to seek to offset %"
461 G_GINT64_FORMAT ": %s", segment->start,
462 gnome_vfs_result_to_string (res));
465 sink->current_pos = segment->start;
471 case GST_EVENT_FLUSH_START:
473 /* No need to flush with GnomeVfs */
484 gst_gnome_vfs_sink_query (GstPad * pad, GstQuery * query)
486 GstGnomeVFSSink *sink;
489 sink = GST_GNOME_VFS_SINK (GST_PAD_PARENT (pad));
491 switch (GST_QUERY_TYPE (query)) {
492 case GST_QUERY_POSITION:
493 gst_query_parse_position (query, &format, NULL);
495 case GST_FORMAT_DEFAULT:
496 case GST_FORMAT_BYTES:
497 gst_query_set_position (query, GST_FORMAT_BYTES, sink->current_pos);
503 case GST_QUERY_FORMATS:
504 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
508 gst_query_set_uri (query, sink->uri_name);
512 return gst_pad_query_default (pad, query);
517 gst_gnome_vfs_sink_render (GstBaseSink * basesink, GstBuffer * buf)
519 GnomeVFSFileSize written, cur_pos;
520 GstGnomeVFSSink *sink;
521 GnomeVFSResult result;
526 sink = GST_GNOME_VFS_SINK (basesink);
528 if (gnome_vfs_tell (sink->handle, &cur_pos) == GNOME_VFS_OK) {
529 /* bring up to date with current position for proper reporting */
530 sink->current_pos = cur_pos;
533 data = gst_buffer_map (buf, &size, NULL, GST_MAP_READ);
534 result = gnome_vfs_write (sink->handle, data, size, &written);
535 gst_buffer_unmap (buf, data, size);
539 GST_DEBUG_OBJECT (sink, "wrote %" G_GINT64_FORMAT " bytes at %"
540 G_GINT64_FORMAT, (gint64) written, (gint64) cur_pos);
542 if (written < size) {
543 /* FIXME: what to do here? (tpm) */
544 g_warning ("%s: %" G_GSIZE_FORMAT " bytes should be written, only %"
545 G_GUINT64_FORMAT " bytes written", G_STRLOC, size, written);
548 sink->current_pos += size;
552 case GNOME_VFS_ERROR_NO_SPACE:{
553 /* TODO: emit signal/send msg on out-of-diskspace and
554 * handle this gracefully (see open bug) (tpm) */
555 GST_ELEMENT_ERROR (sink, RESOURCE, NO_SPACE_LEFT, (NULL),
556 ("bufsize=%u, written=%u", size, (guint) written));
557 ret = GST_FLOW_ERROR;
561 gchar *filename = gnome_vfs_uri_to_string (sink->uri,
562 GNOME_VFS_URI_HIDE_PASSWORD);
564 GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
565 (_("Error while writing to file \"%s\"."), filename),
566 ("%s, bufsize=%u, written=%u", gnome_vfs_result_to_string (result),
567 size, (guint) written));
570 ret = GST_FLOW_ERROR;
578 /*** GSTURIHANDLER INTERFACE *************************************************/
581 gst_gnome_vfs_sink_uri_get_type (void)
587 gst_gnome_vfs_sink_uri_get_protocols (void)
589 return gst_gnomevfs_get_supported_uris ();
593 gst_gnome_vfs_sink_uri_get_uri (GstURIHandler * handler)
595 GstGnomeVFSSink *sink = GST_GNOME_VFS_SINK (handler);
597 return sink->uri_name;
601 gst_gnome_vfs_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri)
603 GstGnomeVFSSink *sink = GST_GNOME_VFS_SINK (handler);
606 gst_element_get_state (GST_ELEMENT (sink), &cur_state, NULL, 0);
608 if (cur_state == GST_STATE_PLAYING || cur_state == GST_STATE_PAUSED) {
609 GST_WARNING_OBJECT (sink, "cannot set uri when PAUSED or PLAYING");
613 g_object_set (sink, "location", uri, NULL);
619 gst_gnome_vfs_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
621 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
623 iface->get_type = gst_gnome_vfs_sink_uri_get_type;
624 iface->get_protocols = gst_gnome_vfs_sink_uri_get_protocols;
625 iface->get_uri = gst_gnome_vfs_sink_uri_get_uri;
626 iface->set_uri = gst_gnome_vfs_sink_uri_set_uri;