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 GST_BOILERPLATE_FULL (GstGnomeVFSSink, gst_gnome_vfs_sink, GstBaseSink,
127 GST_TYPE_BASE_SINK, gst_gnome_vfs_sink_do_init);
130 gst_gnome_vfs_sink_base_init (gpointer g_class)
132 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
134 gst_element_class_add_static_pad_template (element_class, &sinktemplate);
136 gst_element_class_set_details_simple (element_class,
137 "GnomeVFS Sink", "Sink/File",
138 "Write a stream to a GnomeVFS URI", "Bastien Nocera <hadess@hadess.net>");
142 _gst_boolean_allow_overwrite_accumulator (GSignalInvocationHint * ihint,
143 GValue * return_accu, const GValue * handler_return, gpointer dummy)
145 gboolean allow_overwrite;
147 allow_overwrite = g_value_get_boolean (handler_return);
148 if (!(ihint->run_type & G_SIGNAL_RUN_CLEANUP))
149 g_value_set_boolean (return_accu, allow_overwrite);
151 /* stop emission if signal doesn't allow overwriting */
152 return allow_overwrite;
156 gst_gnome_vfs_sink_class_init (GstGnomeVFSSinkClass * klass)
158 GstBaseSinkClass *basesink_class;
159 GObjectClass *gobject_class;
161 gobject_class = (GObjectClass *) klass;
162 basesink_class = (GstBaseSinkClass *) klass;
164 gobject_class->set_property = gst_gnome_vfs_sink_set_property;
165 gobject_class->get_property = gst_gnome_vfs_sink_get_property;
166 gobject_class->finalize = gst_gnome_vfs_sink_finalize;
168 g_object_class_install_property (gobject_class, ARG_LOCATION,
169 g_param_spec_string ("location", "File Location",
170 "Location of the file to write", NULL,
171 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
172 g_object_class_install_property (gobject_class, ARG_URI,
173 g_param_spec_boxed ("uri", "GnomeVFSURI", "URI for GnomeVFS",
174 GST_TYPE_GNOME_VFS_URI, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
175 g_object_class_install_property (gobject_class, ARG_HANDLE,
176 g_param_spec_boxed ("handle", "GnomeVFSHandle", "Handle for GnomeVFS",
177 GST_TYPE_GNOME_VFS_HANDLE,
178 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
181 * GstGnomeVFSSink::allow-overwrite
182 * @sink: the object which received the signal
183 * @uri: the URI to be overwritten
185 * This signal is fired when gnomevfssink is about to overwrite an
186 * existing resource. The application can connect to this signal and ask
187 * the user if the resource may be overwritten.
189 * Returns: A boolean indicating that the resource may be overwritten.
191 gst_gnome_vfs_sink_signals[SIGNAL_ERASE_ASK] =
192 g_signal_new ("allow-overwrite", G_TYPE_FROM_CLASS (klass),
193 G_SIGNAL_RUN_CLEANUP, G_STRUCT_OFFSET (GstGnomeVFSSinkClass, erase_ask),
194 _gst_boolean_allow_overwrite_accumulator, NULL,
195 gst_marshal_BOOLEAN__POINTER, G_TYPE_BOOLEAN, 1, GST_TYPE_GNOME_VFS_URI);
197 basesink_class->stop = GST_DEBUG_FUNCPTR (gst_gnome_vfs_sink_stop);
198 basesink_class->start = GST_DEBUG_FUNCPTR (gst_gnome_vfs_sink_start);
199 basesink_class->event = GST_DEBUG_FUNCPTR (gst_gnome_vfs_sink_handle_event);
200 basesink_class->render = GST_DEBUG_FUNCPTR (gst_gnome_vfs_sink_render);
201 basesink_class->get_times = NULL;
205 gst_gnome_vfs_sink_finalize (GObject * obj)
207 GstGnomeVFSSink *sink = GST_GNOME_VFS_SINK (obj);
210 gnome_vfs_uri_unref (sink->uri);
214 if (sink->uri_name) {
215 g_free (sink->uri_name);
216 sink->uri_name = NULL;
219 G_OBJECT_CLASS (parent_class)->finalize (obj);
223 gst_gnome_vfs_sink_init (GstGnomeVFSSink * sink, GstGnomeVFSSinkClass * klass)
225 gst_pad_set_query_function (GST_BASE_SINK_PAD (sink),
226 GST_DEBUG_FUNCPTR (gst_gnome_vfs_sink_query));
229 sink->uri_name = NULL;
231 sink->own_handle = FALSE;
232 sink->current_pos = 0;
234 GST_BASE_SINK (sink)->sync = FALSE;
238 gst_gnome_vfs_sink_set_property (GObject * object, guint prop_id,
239 const GValue * value, GParamSpec * pspec)
241 GstGnomeVFSSink *sink;
244 sink = GST_GNOME_VFS_SINK (object);
246 gst_element_get_state (GST_ELEMENT (sink), &cur_state, NULL, 0);
248 if (cur_state == GST_STATE_PLAYING || cur_state == GST_STATE_PAUSED) {
249 GST_WARNING_OBJECT (sink, "cannot set property when PAUSED or PLAYING");
253 GST_OBJECT_LOCK (sink);
257 const gchar *new_location;
260 gnome_vfs_uri_unref (sink->uri);
263 if (sink->uri_name) {
264 g_free (sink->uri_name);
265 sink->uri_name = NULL;
268 new_location = g_value_get_string (value);
270 sink->uri_name = gst_gnome_vfs_location_to_uri_string (new_location);
271 sink->uri = gnome_vfs_uri_new (sink->uri_name);
277 gnome_vfs_uri_unref (sink->uri);
280 if (sink->uri_name) {
281 g_free (sink->uri_name);
282 sink->uri_name = NULL;
284 if (g_value_get_boxed (value)) {
285 sink->uri = (GnomeVFSURI *) g_value_dup_boxed (value);
286 sink->uri_name = gnome_vfs_uri_to_string (sink->uri, 0);
292 gnome_vfs_uri_unref (sink->uri);
295 if (sink->uri_name) {
296 g_free (sink->uri_name);
297 sink->uri_name = NULL;
299 sink->handle = g_value_get_boxed (value);
303 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
307 GST_OBJECT_UNLOCK (sink);
311 gst_gnome_vfs_sink_get_property (GObject * object, guint prop_id,
312 GValue * value, GParamSpec * pspec)
314 GstGnomeVFSSink *sink;
316 sink = GST_GNOME_VFS_SINK (object);
318 GST_OBJECT_LOCK (sink);
322 g_value_set_string (value, sink->uri_name);
325 g_value_set_boxed (value, sink->uri);
328 g_value_set_boxed (value, sink->handle);
331 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
335 GST_OBJECT_UNLOCK (sink);
339 gst_gnome_vfs_sink_open_file (GstGnomeVFSSink * sink)
341 GnomeVFSResult result;
344 /* open the file, all permissions, umask will apply */
345 result = gnome_vfs_create_uri (&(sink->handle), sink->uri,
346 GNOME_VFS_OPEN_WRITE, TRUE,
347 GNOME_VFS_PERM_USER_READ | GNOME_VFS_PERM_USER_WRITE |
348 GNOME_VFS_PERM_GROUP_READ | GNOME_VFS_PERM_GROUP_WRITE |
349 GNOME_VFS_PERM_OTHER_READ | GNOME_VFS_PERM_OTHER_WRITE);
351 /* if the file existed and the property says to ask, then ask! */
352 if (result == GNOME_VFS_ERROR_FILE_EXISTS) {
353 gboolean erase_anyway = FALSE;
355 g_signal_emit (G_OBJECT (sink),
356 gst_gnome_vfs_sink_signals[SIGNAL_ERASE_ASK], 0, sink->uri,
359 result = gnome_vfs_create_uri (&(sink->handle), sink->uri,
360 GNOME_VFS_OPEN_WRITE, FALSE,
361 GNOME_VFS_PERM_USER_READ | GNOME_VFS_PERM_USER_WRITE |
362 GNOME_VFS_PERM_GROUP_READ | GNOME_VFS_PERM_GROUP_WRITE |
363 GNOME_VFS_PERM_OTHER_READ | GNOME_VFS_PERM_OTHER_WRITE);
367 GST_DEBUG_OBJECT (sink, "open: %s", gnome_vfs_result_to_string (result));
369 if (result != GNOME_VFS_OK) {
370 gchar *filename = gnome_vfs_uri_to_string (sink->uri,
371 GNOME_VFS_URI_HIDE_PASSWORD);
373 GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE,
374 (_("Could not open vfs file \"%s\" for writing: %s."),
375 filename, gnome_vfs_result_to_string (result)), GST_ERROR_SYSTEM);
379 sink->own_handle = TRUE;
380 } else if (!sink->handle) {
381 GST_ELEMENT_ERROR (sink, RESOURCE, FAILED, (_("No filename given")),
385 sink->own_handle = FALSE;
388 sink->current_pos = 0;
394 gst_gnome_vfs_sink_close_file (GstGnomeVFSSink * sink)
396 GnomeVFSResult result;
398 if (sink->own_handle) {
400 result = gnome_vfs_close (sink->handle);
402 if (result != GNOME_VFS_OK) {
403 gchar *filename = gnome_vfs_uri_to_string (sink->uri,
404 GNOME_VFS_URI_HIDE_PASSWORD);
406 GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
407 (_("Could not close vfs file \"%s\"."), filename), GST_ERROR_SYSTEM);
411 sink->own_handle = FALSE;
417 gst_gnome_vfs_sink_start (GstBaseSink * basesink)
421 ret = gst_gnome_vfs_sink_open_file (GST_GNOME_VFS_SINK (basesink));
427 gst_gnome_vfs_sink_stop (GstBaseSink * basesink)
429 GST_DEBUG_OBJECT (basesink, "closing ...");
430 gst_gnome_vfs_sink_close_file (GST_GNOME_VFS_SINK (basesink));
435 gst_gnome_vfs_sink_handle_event (GstBaseSink * basesink, GstEvent * event)
437 GstGnomeVFSSink *sink;
440 sink = GST_GNOME_VFS_SINK (basesink);
442 GST_DEBUG_OBJECT (sink, "processing %s event", GST_EVENT_TYPE_NAME (event));
444 switch (GST_EVENT_TYPE (event)) {
445 case GST_EVENT_NEWSEGMENT:{
450 gst_event_parse_new_segment (event, NULL, NULL, &format, &offset,
453 if (format != GST_FORMAT_BYTES) {
454 GST_WARNING_OBJECT (sink, "ignored NEWSEGMENT event in %s format",
455 gst_format_get_name (format));
459 GST_LOG_OBJECT (sink, "seeking to offset %" G_GINT64_FORMAT, offset);
460 res = gnome_vfs_seek (sink->handle, GNOME_VFS_SEEK_START, offset);
462 if (res != GNOME_VFS_OK) {
463 GST_ERROR_OBJECT (sink, "Failed to seek to offset %"
464 G_GINT64_FORMAT ": %s", offset, gnome_vfs_result_to_string (res));
467 sink->current_pos = offset;
473 case GST_EVENT_FLUSH_START:
475 /* No need to flush with GnomeVfs */
486 gst_gnome_vfs_sink_query (GstPad * pad, GstQuery * query)
488 GstGnomeVFSSink *sink;
491 sink = GST_GNOME_VFS_SINK (GST_PAD_PARENT (pad));
493 switch (GST_QUERY_TYPE (query)) {
494 case GST_QUERY_POSITION:
495 gst_query_parse_position (query, &format, NULL);
497 case GST_FORMAT_DEFAULT:
498 case GST_FORMAT_BYTES:
499 gst_query_set_position (query, GST_FORMAT_BYTES, sink->current_pos);
505 case GST_QUERY_FORMATS:
506 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
510 gst_query_set_uri (query, sink->uri_name);
514 return gst_pad_query_default (pad, query);
519 gst_gnome_vfs_sink_render (GstBaseSink * basesink, GstBuffer * buf)
521 GnomeVFSFileSize written, cur_pos;
522 GstGnomeVFSSink *sink;
523 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 result = gnome_vfs_write (sink->handle, GST_BUFFER_DATA (buf),
534 GST_BUFFER_SIZE (buf), &written);
538 GST_DEBUG_OBJECT (sink, "wrote %" G_GINT64_FORMAT " bytes at %"
539 G_GINT64_FORMAT, (gint64) written, (gint64) cur_pos);
541 if (written < GST_BUFFER_SIZE (buf)) {
542 /* FIXME: what to do here? (tpm) */
543 g_warning ("%s: %d bytes should be written, only %"
544 G_GUINT64_FORMAT " bytes written", G_STRLOC,
545 GST_BUFFER_SIZE (buf), written);
548 sink->current_pos += GST_BUFFER_SIZE (buf);
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", GST_BUFFER_SIZE (buf), (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 GST_BUFFER_SIZE (buf), (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;