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., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23 /**
  24  * SECTION:element-filesink
  25  * @title: filesink
  26  * @see_also: #GstFileSrc
  27  *
  28  * Write incoming data to a file in the local file system.
  29  *
  30  * ## Example launch line
  31  * |[
  32  * gst-launch-1.0 v4l2src num-buffers=1 ! jpegenc ! filesink location=capture1.jpeg
  33  * ]| Capture one frame from a v4l2 camera and save as jpeg image.
  34  *
  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 #undef ftruncate
  60 #define ftruncate _chsize
  61 #undef fsync
  62 #define fsync _commit
  63 #ifdef _MSC_VER                 /* Check if we are using MSVC, fileno is deprecated in favour */
  64 #define fileno _fileno          /* of _fileno */
  65 #endif
  66 #endif
  67
  68 #include <sys/stat.h>
  69 #ifdef HAVE_UNISTD_H
  70 #include <unistd.h>
  71 #endif
  72
  73 #include "gstelements_private.h"
  74 #include "gstfilesink.h"
  75
  76 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
  77     GST_PAD_SINK,
  78     GST_PAD_ALWAYS,
  79     GST_STATIC_CAPS_ANY);
  80
  81 #define GST_TYPE_FILE_SINK_BUFFER_MODE (gst_file_sink_buffer_mode_get_type ())
  82 static GType
  83 gst_file_sink_buffer_mode_get_type (void)
  84 {
  85   static GType buffer_mode_type = 0;
  86   static const GEnumValue buffer_mode[] = {
  87     {GST_FILE_SINK_BUFFER_MODE_DEFAULT, "Default buffering", "default"},
  88     {GST_FILE_SINK_BUFFER_MODE_FULL, "Fully buffered", "full"},
  89     {GST_FILE_SINK_BUFFER_MODE_LINE, "Line buffered (deprecated, like full)",
  90         "line"},
  91     {GST_FILE_SINK_BUFFER_MODE_UNBUFFERED, "Unbuffered", "unbuffered"},
  92     {0, NULL, NULL},
  93   };
  94
  95   if (!buffer_mode_type) {
  96     buffer_mode_type =
  97         g_enum_register_static ("GstFileSinkBufferMode", buffer_mode);
  98   }
  99   return buffer_mode_type;
 100 }
 101
 102 GST_DEBUG_CATEGORY_STATIC (gst_file_sink_debug);
 103 #define GST_CAT_DEFAULT gst_file_sink_debug
 104
 105 #define DEFAULT_LOCATION        NULL
 106 #define DEFAULT_BUFFER_MODE     GST_FILE_SINK_BUFFER_MODE_DEFAULT
 107 #define DEFAULT_BUFFER_SIZE     64 * 1024
 108 #define DEFAULT_APPEND          FALSE
 109
 110 enum
 111 {
 112   PROP_0,
 113   PROP_LOCATION,
 114   PROP_BUFFER_MODE,
 115   PROP_BUFFER_SIZE,
 116   PROP_APPEND,
 117   PROP_LAST
 118 };
 119
 120 /* Copy of glib's g_fopen due to win32 libc/cross-DLL brokenness: we can't
 121  * use the 'file pointer' opened in glib (and returned from this function)
 122  * in this library, as they may have unrelated C runtimes. */
 123 static FILE *
 124 gst_fopen (const gchar * filename, const gchar * mode)
 125 {
 126 #ifdef G_OS_WIN32
 127   wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
 128   wchar_t *wmode;
 129   FILE *retval;
 130   int save_errno;
 131
 132   if (wfilename == NULL) {
 133     errno = EINVAL;
 134     return NULL;
 135   }
 136
 137   wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
 138
 139   if (wmode == NULL) {
 140     g_free (wfilename);
 141     errno = EINVAL;
 142     return NULL;
 143   }
 144
 145   retval = _wfopen (wfilename, wmode);
 146   save_errno = errno;
 147
 148   g_free (wfilename);
 149   g_free (wmode);
 150
 151   errno = save_errno;
 152   return retval;
 153 #else
 154   return fopen (filename, mode);
 155 #endif
 156 }
 157
 158 static void gst_file_sink_dispose (GObject * object);
 159
 160 static void gst_file_sink_set_property (GObject * object, guint prop_id,
 161     const GValue * value, GParamSpec * pspec);
 162 static void gst_file_sink_get_property (GObject * object, guint prop_id,
 163     GValue * value, GParamSpec * pspec);
 164
 165 static gboolean gst_file_sink_open_file (GstFileSink * sink);
 166 static void gst_file_sink_close_file (GstFileSink * sink);
 167
 168 static gboolean gst_file_sink_start (GstBaseSink * sink);
 169 static gboolean gst_file_sink_stop (GstBaseSink * sink);
 170 static gboolean gst_file_sink_event (GstBaseSink * sink, GstEvent * event);
 171 static GstFlowReturn gst_file_sink_render (GstBaseSink * sink,
 172     GstBuffer * buffer);
 173 static GstFlowReturn gst_file_sink_render_list (GstBaseSink * sink,
 174     GstBufferList * list);
 175
 176 static gboolean gst_file_sink_do_seek (GstFileSink * filesink,
 177     guint64 new_offset);
 178 static gboolean gst_file_sink_get_current_offset (GstFileSink * filesink,
 179     guint64 * p_pos);
 180
 181 static gboolean gst_file_sink_query (GstBaseSink * bsink, GstQuery * query);
 182
 183 static void gst_file_sink_uri_handler_init (gpointer g_iface,
 184     gpointer iface_data);
 185
 186 static GstFlowReturn gst_file_sink_flush_buffer (GstFileSink * filesink);
 187
 188 #define _do_init \
 189   G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_file_sink_uri_handler_init); \
 190   GST_DEBUG_CATEGORY_INIT (gst_file_sink_debug, "filesink", 0, "filesink element");
 191 #define gst_file_sink_parent_class parent_class
 192 G_DEFINE_TYPE_WITH_CODE (GstFileSink, gst_file_sink, GST_TYPE_BASE_SINK,
 193     _do_init);
 194
 195 static void
 196 gst_file_sink_class_init (GstFileSinkClass * klass)
 197 {
 198   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 199   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
 200   GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
 201
 202   gobject_class->dispose = gst_file_sink_dispose;
 203
 204   gobject_class->set_property = gst_file_sink_set_property;
 205   gobject_class->get_property = gst_file_sink_get_property;
 206
 207   g_object_class_install_property (gobject_class, PROP_LOCATION,
 208       g_param_spec_string ("location", "File Location",
 209           "Location of the file to write", NULL,
 210           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 211
 212   g_object_class_install_property (gobject_class, PROP_BUFFER_MODE,
 213       g_param_spec_enum ("buffer-mode", "Buffering mode",
 214           "The buffering mode to use", GST_TYPE_FILE_SINK_BUFFER_MODE,
 215           DEFAULT_BUFFER_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 216
 217   g_object_class_install_property (gobject_class, PROP_BUFFER_SIZE,
 218       g_param_spec_uint ("buffer-size", "Buffering size",
 219           "Size of buffer in number of bytes for line or full buffer-mode", 0,
 220           G_MAXUINT, DEFAULT_BUFFER_SIZE,
 221           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 222
 223   /**
 224    * GstFileSink:append
 225    *
 226    * Append to an already existing file.
 227    */
 228   g_object_class_install_property (gobject_class, PROP_APPEND,
 229       g_param_spec_boolean ("append", "Append",
 230           "Append to an already existing file", DEFAULT_APPEND,
 231           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 232
 233   gst_element_class_set_static_metadata (gstelement_class,
 234       "File Sink",
 235       "Sink/File", "Write stream to a file",
 236       "Thomas Vander Stichele <thomas at apestaart dot org>");
 237   gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
 238
 239   gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_file_sink_start);
 240   gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_file_sink_stop);
 241   gstbasesink_class->query = GST_DEBUG_FUNCPTR (gst_file_sink_query);
 242   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_file_sink_render);
 243   gstbasesink_class->render_list =
 244       GST_DEBUG_FUNCPTR (gst_file_sink_render_list);
 245   gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_file_sink_event);
 246
 247   if (sizeof (off_t) < 8) {
 248     GST_LOG ("No large file support, sizeof (off_t) = %" G_GSIZE_FORMAT "!",
 249         sizeof (off_t));
 250   }
 251 }
 252
 253 static void
 254 gst_file_sink_init (GstFileSink * filesink)
 255 {
 256   filesink->filename = NULL;
 257   filesink->file = NULL;
 258   filesink->current_pos = 0;
 259   filesink->buffer_mode = DEFAULT_BUFFER_MODE;
 260   filesink->buffer_size = DEFAULT_BUFFER_SIZE;
 261   filesink->append = FALSE;
 262
 263   gst_base_sink_set_sync (GST_BASE_SINK (filesink), FALSE);
 264 }
 265
 266 static void
 267 gst_file_sink_dispose (GObject * object)
 268 {
 269   GstFileSink *sink = GST_FILE_SINK (object);
 270
 271   G_OBJECT_CLASS (parent_class)->dispose (object);
 272
 273   g_free (sink->uri);
 274   sink->uri = NULL;
 275   g_free (sink->filename);
 276   sink->filename = NULL;
 277 }
 278
 279 static gboolean
 280 gst_file_sink_set_location (GstFileSink * sink, const gchar * location,
 281     GError ** error)
 282 {
 283   if (sink->file)
 284     goto was_open;
 285
 286   g_free (sink->filename);
 287   g_free (sink->uri);
 288   if (location != NULL) {
 289     /* we store the filename as we received it from the application. On Windows
 290      * this should be in UTF8 */
 291     sink->filename = g_strdup (location);
 292     sink->uri = gst_filename_to_uri (location, NULL);
 293     GST_INFO_OBJECT (sink, "filename : %s", sink->filename);
 294     GST_INFO_OBJECT (sink, "uri      : %s", sink->uri);
 295   } else {
 296     sink->filename = NULL;
 297     sink->uri = NULL;
 298   }
 299
 300   return TRUE;
 301
 302   /* ERRORS */
 303 was_open:
 304   {
 305     g_warning ("Changing the `location' property on filesink when a file is "
 306         "open is not supported.");
 307     g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_STATE,
 308         "Changing the 'location' property on filesink when a file is "
 309         "open is not supported");
 310     return FALSE;
 311   }
 312 }
 313
 314 static void
 315 gst_file_sink_set_property (GObject * object, guint prop_id,
 316     const GValue * value, GParamSpec * pspec)
 317 {
 318   GstFileSink *sink = GST_FILE_SINK (object);
 319
 320   switch (prop_id) {
 321     case PROP_LOCATION:
 322       gst_file_sink_set_location (sink, g_value_get_string (value), NULL);
 323       break;
 324     case PROP_BUFFER_MODE:
 325       sink->buffer_mode = g_value_get_enum (value);
 326       break;
 327     case PROP_BUFFER_SIZE:
 328       sink->buffer_size = g_value_get_uint (value);
 329       break;
 330     case PROP_APPEND:
 331       sink->append = g_value_get_boolean (value);
 332       break;
 333     default:
 334       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 335       break;
 336   }
 337 }
 338
 339 static void
 340 gst_file_sink_get_property (GObject * object, guint prop_id, GValue * value,
 341     GParamSpec * pspec)
 342 {
 343   GstFileSink *sink = GST_FILE_SINK (object);
 344
 345   switch (prop_id) {
 346     case PROP_LOCATION:
 347       g_value_set_string (value, sink->filename);
 348       break;
 349     case PROP_BUFFER_MODE:
 350       g_value_set_enum (value, sink->buffer_mode);
 351       break;
 352     case PROP_BUFFER_SIZE:
 353       g_value_set_uint (value, sink->buffer_size);
 354       break;
 355     case PROP_APPEND:
 356       g_value_set_boolean (value, sink->append);
 357       break;
 358     default:
 359       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 360       break;
 361   }
 362 }
 363
 364 static gboolean
 365 gst_file_sink_open_file (GstFileSink * sink)
 366 {
 367   /* open the file */
 368   if (sink->filename == NULL || sink->filename[0] == '\0')
 369     goto no_filename;
 370
 371   if (sink->append)
 372     sink->file = gst_fopen (sink->filename, "ab");
 373   else
 374     sink->file = gst_fopen (sink->filename, "wb");
 375   if (sink->file == NULL)
 376     goto open_failed;
 377
 378   sink->current_pos = 0;
 379   /* try to seek in the file to figure out if it is seekable */
 380   sink->seekable = gst_file_sink_do_seek (sink, 0);
 381
 382   if (sink->buffer)
 383     gst_buffer_list_unref (sink->buffer);
 384   sink->buffer = NULL;
 385   if (sink->buffer_mode != GST_FILE_SINK_BUFFER_MODE_UNBUFFERED) {
 386     if (sink->buffer_size == 0) {
 387       sink->buffer_size = DEFAULT_BUFFER_SIZE;
 388       g_object_notify (G_OBJECT (sink), "buffer-size");
 389     }
 390
 391     sink->buffer = gst_buffer_list_new ();
 392   }
 393
 394   GST_DEBUG_OBJECT (sink, "opened file %s, seekable %d",
 395       sink->filename, sink->seekable);
 396
 397   return TRUE;
 398
 399   /* ERRORS */
 400 no_filename:
 401   {
 402     GST_ELEMENT_ERROR (sink, RESOURCE, NOT_FOUND,
 403         (_("No file name specified for writing.")), (NULL));
 404     return FALSE;
 405   }
 406 open_failed:
 407   {
 408     GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_WRITE,
 409         (_("Could not open file \"%s\" for writing."), sink->filename),
 410         GST_ERROR_SYSTEM);
 411     return FALSE;
 412   }
 413 }
 414
 415 static void
 416 gst_file_sink_close_file (GstFileSink * sink)
 417 {
 418   if (sink->file) {
 419     if (gst_file_sink_flush_buffer (sink) != GST_FLOW_OK)
 420       GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
 421           (_("Error closing file \"%s\"."), sink->filename), NULL);
 422
 423     if (fclose (sink->file) != 0)
 424       GST_ELEMENT_ERROR (sink, RESOURCE, CLOSE,
 425           (_("Error closing file \"%s\"."), sink->filename), GST_ERROR_SYSTEM);
 426
 427     GST_DEBUG_OBJECT (sink, "closed file");
 428     sink->file = NULL;
 429   }
 430
 431   if (sink->buffer) {
 432     gst_buffer_list_unref (sink->buffer);
 433     sink->buffer = NULL;
 434   }
 435 }
 436
 437 static gboolean
 438 gst_file_sink_query (GstBaseSink * bsink, GstQuery * query)
 439 {
 440   gboolean res;
 441   GstFileSink *self;
 442   GstFormat format;
 443
 444   self = GST_FILE_SINK (bsink);
 445
 446   switch (GST_QUERY_TYPE (query)) {
 447     case GST_QUERY_POSITION:
 448       gst_query_parse_position (query, &format, NULL);
 449
 450       switch (format) {
 451         case GST_FORMAT_DEFAULT:
 452         case GST_FORMAT_BYTES:
 453           gst_query_set_position (query, GST_FORMAT_BYTES, self->current_pos);
 454           res = TRUE;
 455           break;
 456         default:
 457           res = FALSE;
 458           break;
 459       }
 460       break;
 461
 462     case GST_QUERY_FORMATS:
 463       gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
 464       res = TRUE;
 465       break;
 466
 467     case GST_QUERY_URI:
 468       gst_query_set_uri (query, self->uri);
 469       res = TRUE;
 470       break;
 471
 472     case GST_QUERY_SEEKING:
 473       gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
 474       if (format == GST_FORMAT_BYTES || format == GST_FORMAT_DEFAULT) {
 475         gst_query_set_seeking (query, GST_FORMAT_BYTES, self->seekable, 0, -1);
 476       } else {
 477         gst_query_set_seeking (query, format, FALSE, 0, -1);
 478       }
 479       res = TRUE;
 480       break;
 481
 482     default:
 483       res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
 484       break;
 485   }
 486   return res;
 487 }
 488
 489 #ifdef HAVE_FSEEKO
 490 # define __GST_STDIO_SEEK_FUNCTION "fseeko"
 491 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
 492 # define __GST_STDIO_SEEK_FUNCTION "lseek"
 493 #else
 494 # define __GST_STDIO_SEEK_FUNCTION "fseek"
 495 #endif
 496
 497 static gboolean
 498 gst_file_sink_do_seek (GstFileSink * filesink, guint64 new_offset)
 499 {
 500   GST_DEBUG_OBJECT (filesink, "Seeking to offset %" G_GUINT64_FORMAT
 501       " using " __GST_STDIO_SEEK_FUNCTION, new_offset);
 502
 503   if (gst_file_sink_flush_buffer (filesink) != GST_FLOW_OK)
 504     goto flush_buffer_failed;
 505
 506 #ifdef HAVE_FSEEKO
 507   if (fseeko (filesink->file, (off_t) new_offset, SEEK_SET) != 0)
 508     goto seek_failed;
 509 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
 510   if (lseek (fileno (filesink->file), (off_t) new_offset,
 511           SEEK_SET) == (off_t) - 1)
 512     goto seek_failed;
 513 #else
 514   if (fseek (filesink->file, (long) new_offset, SEEK_SET) != 0)
 515     goto seek_failed;
 516 #endif
 517
 518   /* adjust position reporting after seek;
 519    * presumably this should basically yield new_offset */
 520   gst_file_sink_get_current_offset (filesink, &filesink->current_pos);
 521
 522   return TRUE;
 523
 524   /* ERRORS */
 525 flush_buffer_failed:
 526   {
 527     GST_DEBUG_OBJECT (filesink, "Flushing buffer failed");
 528     return FALSE;
 529   }
 530 seek_failed:
 531   {
 532     GST_DEBUG_OBJECT (filesink, "Seeking failed: %s", g_strerror (errno));
 533     return FALSE;
 534   }
 535 }
 536
 537 /* handle events (search) */
 538 static gboolean
 539 gst_file_sink_event (GstBaseSink * sink, GstEvent * event)
 540 {
 541   GstEventType type;
 542   GstFileSink *filesink;
 543
 544   filesink = GST_FILE_SINK (sink);
 545
 546   type = GST_EVENT_TYPE (event);
 547
 548   switch (type) {
 549     case GST_EVENT_SEGMENT:
 550     {
 551       const GstSegment *segment;
 552
 553       gst_event_parse_segment (event, &segment);
 554
 555       if (segment->format == GST_FORMAT_BYTES) {
 556         /* only try to seek and fail when we are going to a different
 557          * position */
 558         if (filesink->current_pos != segment->start) {
 559           /* FIXME, the seek should be performed on the pos field, start/stop are
 560            * just boundaries for valid bytes offsets. We should also fill the file
 561            * with zeroes if the new position extends the current EOF (sparse streams
 562            * and segment accumulation). */
 563           if (!gst_file_sink_do_seek (filesink, (guint64) segment->start))
 564             goto seek_failed;
 565         } else {
 566           GST_DEBUG_OBJECT (filesink, "Ignored SEGMENT, no seek needed");
 567         }
 568       } else {
 569         GST_DEBUG_OBJECT (filesink,
 570             "Ignored SEGMENT event of format %u (%s)", (guint) segment->format,
 571             gst_format_get_name (segment->format));
 572       }
 573       break;
 574     }
 575     case GST_EVENT_FLUSH_STOP:
 576       if (filesink->current_pos != 0 && filesink->seekable) {
 577         gst_file_sink_do_seek (filesink, 0);
 578         if (ftruncate (fileno (filesink->file), 0))
 579           goto truncate_failed;
 580       }
 581       break;
 582     case GST_EVENT_EOS:
 583       if (gst_file_sink_flush_buffer (filesink) != GST_FLOW_OK)
 584         goto flush_buffer_failed;
 585       break;
 586     default:
 587       break;
 588   }
 589
 590   return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
 591
 592   /* ERRORS */
 593 seek_failed:
 594   {
 595     GST_ELEMENT_ERROR (filesink, RESOURCE, SEEK,
 596         (_("Error while seeking in file \"%s\"."), filesink->filename),
 597         GST_ERROR_SYSTEM);
 598     gst_event_unref (event);
 599     return FALSE;
 600   }
 601 flush_buffer_failed:
 602   {
 603     GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
 604         (_("Error while writing to file \"%s\"."), filesink->filename), NULL);
 605     gst_event_unref (event);
 606     return FALSE;
 607   }
 608 truncate_failed:
 609   {
 610     GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
 611         (_("Error while writing to file \"%s\"."), filesink->filename),
 612         GST_ERROR_SYSTEM);
 613     gst_event_unref (event);
 614     return FALSE;
 615   }
 616 }
 617
 618 static gboolean
 619 gst_file_sink_get_current_offset (GstFileSink * filesink, guint64 * p_pos)
 620 {
 621   off_t ret = -1;
 622
 623   /* no need to flush internal buffer here as this is only called right
 624    * after a seek. If this changes then the buffer should be flushed here
 625    * too
 626    */
 627
 628 #ifdef HAVE_FTELLO
 629   ret = ftello (filesink->file);
 630 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
 631   ret = lseek (fileno (filesink->file), 0, SEEK_CUR);
 632 #else
 633   ret = (off_t) ftell (filesink->file);
 634 #endif
 635
 636   if (ret != (off_t) - 1)
 637     *p_pos = (guint64) ret;
 638
 639   return (ret != (off_t) - 1);
 640 }
 641
 642 static GstFlowReturn
 643 gst_file_sink_render_buffers (GstFileSink * sink, GstBuffer ** buffers,
 644     guint num_buffers, guint8 * mem_nums, guint total_mems)
 645 {
 646   GST_DEBUG_OBJECT (sink,
 647       "writing %u buffers (%u memories) at position %" G_GUINT64_FORMAT,
 648       num_buffers, total_mems, sink->current_pos);
 649
 650   return gst_writev_buffers (GST_OBJECT_CAST (sink), fileno (sink->file), NULL,
 651       buffers, num_buffers, mem_nums, total_mems, &sink->current_pos, 0);
 652 }
 653
 654 static GstFlowReturn
 655 gst_file_sink_render_list_internal (GstFileSink * sink,
 656     GstBufferList * buffer_list)
 657 {
 658   GstFlowReturn flow;
 659   GstBuffer **buffers;
 660   guint8 *mem_nums;
 661   guint total_mems;
 662   guint i, num_buffers;
 663
 664   num_buffers = gst_buffer_list_length (buffer_list);
 665   if (num_buffers == 0)
 666     goto no_data;
 667
 668   /* extract buffers from list and count memories */
 669   buffers = g_newa (GstBuffer *, num_buffers);
 670   mem_nums = g_newa (guint8, num_buffers);
 671   for (i = 0, total_mems = 0; i < num_buffers; ++i) {
 672     buffers[i] = gst_buffer_list_get (buffer_list, i);
 673     mem_nums[i] = gst_buffer_n_memory (buffers[i]);
 674     total_mems += mem_nums[i];
 675   }
 676
 677   flow =
 678       gst_file_sink_render_buffers (sink, buffers, num_buffers, mem_nums,
 679       total_mems);
 680
 681   return flow;
 682
 683 no_data:
 684   {
 685     GST_LOG_OBJECT (sink, "empty buffer list");
 686     return GST_FLOW_OK;
 687   }
 688 }
 689
 690 static GstFlowReturn
 691 gst_file_sink_flush_buffer (GstFileSink * filesink)
 692 {
 693   GstFlowReturn flow_ret = GST_FLOW_OK;
 694
 695   if (filesink->buffer) {
 696     guint length;
 697
 698     length = gst_buffer_list_length (filesink->buffer);
 699
 700     if (length > 0) {
 701       GST_DEBUG_OBJECT (filesink, "Flushing out buffer of size %u",
 702           filesink->current_buffer_size);
 703       flow_ret =
 704           gst_file_sink_render_list_internal (filesink, filesink->buffer);
 705       /* Remove all buffers from the list but keep the list. This ensures that
 706        * we don't re-allocate the array storing the buffers all the time */
 707       gst_buffer_list_remove (filesink->buffer, 0, length);
 708       filesink->current_buffer_size = 0;
 709     }
 710   }
 711
 712   return flow_ret;
 713 }
 714
 715 static gboolean
 716 has_sync_after_buffer (GstBuffer ** buffer, guint idx, gpointer user_data)
 717 {
 718   if (GST_BUFFER_FLAG_IS_SET (*buffer, GST_BUFFER_FLAG_SYNC_AFTER)) {
 719     gboolean *sync_after = user_data;
 720
 721     *sync_after = TRUE;
 722     return FALSE;
 723   }
 724
 725   return TRUE;
 726 }
 727
 728 static gboolean
 729 accumulate_size (GstBuffer ** buffer, guint idx, gpointer user_data)
 730 {
 731   guint *size = user_data;
 732
 733   *size += gst_buffer_get_size (*buffer);
 734
 735   return TRUE;
 736 }
 737
 738 static GstFlowReturn
 739 gst_file_sink_render_list (GstBaseSink * bsink, GstBufferList * buffer_list)
 740 {
 741   GstFlowReturn flow;
 742   GstFileSink *sink;
 743   guint i, num_buffers;
 744   gboolean sync_after = FALSE;
 745
 746   sink = GST_FILE_SINK_CAST (bsink);
 747
 748   num_buffers = gst_buffer_list_length (buffer_list);
 749   if (num_buffers == 0)
 750     goto no_data;
 751
 752   gst_buffer_list_foreach (buffer_list, has_sync_after_buffer, &sync_after);
 753
 754   if (sync_after || !sink->buffer) {
 755     flow = gst_file_sink_render_list_internal (sink, buffer_list);
 756   } else {
 757     guint size = 0;
 758     gst_buffer_list_foreach (buffer_list, accumulate_size, &size);
 759
 760     for (i = 0; i < num_buffers; ++i)
 761       gst_buffer_list_add (sink->buffer,
 762           gst_buffer_ref (gst_buffer_list_get (buffer_list, i)));
 763     sink->current_buffer_size += size;
 764
 765     if (sink->current_buffer_size > sink->buffer_size)
 766       flow = gst_file_sink_flush_buffer (sink);
 767     else
 768       flow = GST_FLOW_OK;
 769   }
 770
 771   if (flow == GST_FLOW_OK && sync_after) {
 772     if (fsync (fileno (sink->file))) {
 773       GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
 774           (_("Error while writing to file \"%s\"."), sink->filename),
 775           ("%s", g_strerror (errno)));
 776       flow = GST_FLOW_ERROR;
 777     }
 778   }
 779
 780   return flow;
 781
 782 no_data:
 783   {
 784     GST_LOG_OBJECT (sink, "empty buffer list");
 785     return GST_FLOW_OK;
 786   }
 787 }
 788
 789 static GstFlowReturn
 790 gst_file_sink_render (GstBaseSink * sink, GstBuffer * buffer)
 791 {
 792   GstFileSink *filesink;
 793   GstFlowReturn flow;
 794   guint8 n_mem;
 795   gboolean sync_after;
 796
 797   filesink = GST_FILE_SINK_CAST (sink);
 798
 799   sync_after = GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_SYNC_AFTER);
 800
 801   n_mem = gst_buffer_n_memory (buffer);
 802
 803   if (n_mem > 0 && (sync_after || !filesink->buffer)) {
 804     flow = gst_file_sink_render_buffers (filesink, &buffer, 1, &n_mem, n_mem);
 805   } else if (n_mem > 0) {
 806
 807     filesink->current_buffer_size += gst_buffer_get_size (buffer);
 808     gst_buffer_list_add (filesink->buffer, gst_buffer_ref (buffer));
 809
 810     if (filesink->current_buffer_size > filesink->buffer_size)
 811       flow = gst_file_sink_flush_buffer (filesink);
 812     else
 813       flow = GST_FLOW_OK;
 814   } else {
 815     flow = GST_FLOW_OK;
 816   }
 817
 818   if (flow == GST_FLOW_OK && sync_after) {
 819     if (fsync (fileno (filesink->file))) {
 820       GST_ELEMENT_ERROR (filesink, RESOURCE, WRITE,
 821           (_("Error while writing to file \"%s\"."), filesink->filename),
 822           ("%s", g_strerror (errno)));
 823       flow = GST_FLOW_ERROR;
 824     }
 825   }
 826
 827   return flow;
 828 }
 829
 830 static gboolean
 831 gst_file_sink_start (GstBaseSink * basesink)
 832 {
 833   return gst_file_sink_open_file (GST_FILE_SINK (basesink));
 834 }
 835
 836 static gboolean
 837 gst_file_sink_stop (GstBaseSink * basesink)
 838 {
 839   gst_file_sink_close_file (GST_FILE_SINK (basesink));
 840   return TRUE;
 841 }
 842
 843 /*** GSTURIHANDLER INTERFACE *************************************************/
 844
 845 static GstURIType
 846 gst_file_sink_uri_get_type (GType type)
 847 {
 848   return GST_URI_SINK;
 849 }
 850
 851 static const gchar *const *
 852 gst_file_sink_uri_get_protocols (GType type)
 853 {
 854   static const gchar *protocols[] = { "file", NULL };
 855
 856   return protocols;
 857 }
 858
 859 static gchar *
 860 gst_file_sink_uri_get_uri (GstURIHandler * handler)
 861 {
 862   GstFileSink *sink = GST_FILE_SINK (handler);
 863
 864   /* FIXME: make thread-safe */
 865   return g_strdup (sink->uri);
 866 }
 867
 868 static gboolean
 869 gst_file_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri,
 870     GError ** error)
 871 {
 872   gchar *location;
 873   gboolean ret;
 874   GstFileSink *sink = GST_FILE_SINK (handler);
 875
 876   /* allow file://localhost/foo/bar by stripping localhost but fail
 877    * for every other hostname */
 878   if (g_str_has_prefix (uri, "file://localhost/")) {
 879     char *tmp;
 880
 881     /* 16 == strlen ("file://localhost") */
 882     tmp = g_strconcat ("file://", uri + 16, NULL);
 883     /* we use gst_uri_get_location() although we already have the
 884      * "location" with uri + 16 because it provides unescaping */
 885     location = gst_uri_get_location (tmp);
 886     g_free (tmp);
 887   } else if (strcmp (uri, "file://") == 0) {
 888     /* Special case for "file://" as this is used by some applications
 889      *  to test with gst_element_make_from_uri if there's an element
 890      *  that supports the URI protocol. */
 891     gst_file_sink_set_location (sink, NULL, NULL);
 892     return TRUE;
 893   } else {
 894     location = gst_uri_get_location (uri);
 895   }
 896
 897   if (!location) {
 898     g_set_error_literal (error, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
 899         "File URI without location");
 900     return FALSE;
 901   }
 902
 903   if (!g_path_is_absolute (location)) {
 904     g_set_error_literal (error, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
 905         "File URI location must be an absolute path");
 906     g_free (location);
 907     return FALSE;
 908   }
 909
 910   ret = gst_file_sink_set_location (sink, location, error);
 911   g_free (location);
 912
 913   return ret;
 914 }
 915
 916 static void
 917 gst_file_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
 918 {
 919   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
 920
 921   iface->get_type = gst_file_sink_uri_get_type;
 922   iface->get_protocols = gst_file_sink_uri_get_protocols;
 923   iface->get_uri = gst_file_sink_uri_get_uri;
 924   iface->set_uri = gst_file_sink_uri_set_uri;
 925 }