plugins/elements/gstfdsink.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstfdsink.c:
   6  *
   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.
  11  *
  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.
  16  *
  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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 /**
  24  * SECTION:element-fdsink
  25  * @see_also: #GstFdSrc
  26  *
  27  * Write data to a unix file descriptor.
  28  *
  29  * This element will synchronize on the clock before writing the data on the
  30  * socket. For file descriptors where this does not make sense (files, ...) the
  31  * #GstBaseSink:sync property can be used to disable synchronisation.
  32  */
  33
  34 #ifdef HAVE_CONFIG_H
  35 #  include "config.h"
  36 #endif
  37
  38 #include "../../gst/gst-i18n-lib.h"
  39
  40 #include <sys/types.h>
  41
  42 #include <sys/stat.h>
  43 #ifdef HAVE_SYS_SOCKET_H
  44 #include <sys/socket.h>
  45 #endif
  46 #include <fcntl.h>
  47 #include <stdio.h>
  48 #ifdef HAVE_UNISTD_H
  49 #include <unistd.h>
  50 #endif
  51 #ifdef _MSC_VER
  52 #undef stat
  53 #define stat _stat
  54 #define fstat _fstat
  55 #define S_ISREG(m)      (((m)&S_IFREG)==S_IFREG)
  56 #endif
  57 #include <errno.h>
  58 #include <string.h>
  59
  60 #include "gstfdsink.h"
  61 #include "gstelements_private.h"
  62
  63 #ifdef G_OS_WIN32
  64 #include <io.h>                 /* lseek, open, close, read */
  65 #undef lseek
  66 #define lseek _lseeki64
  67 #undef off_t
  68 #define off_t guint64
  69 #endif
  70
  71 #ifdef __BIONIC__               /* Android */
  72 #undef lseek
  73 #define lseek lseek64
  74 #undef fstat
  75 #define fstat fstat64
  76 #undef off_t
  77 #define off_t guint64
  78 #endif
  79
  80 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
  81     GST_PAD_SINK,
  82     GST_PAD_ALWAYS,
  83     GST_STATIC_CAPS_ANY);
  84
  85 GST_DEBUG_CATEGORY_STATIC (gst_fd_sink__debug);
  86 #define GST_CAT_DEFAULT gst_fd_sink__debug
  87
  88
  89 /* FdSink signals and args */
  90 enum
  91 {
  92   /* FILL ME */
  93   LAST_SIGNAL
  94 };
  95
  96 enum
  97 {
  98   ARG_0,
  99   ARG_FD
 100 };
 101
 102 static void gst_fd_sink_uri_handler_init (gpointer g_iface,
 103     gpointer iface_data);
 104
 105 #define _do_init \
 106   G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_fd_sink_uri_handler_init); \
 107   GST_DEBUG_CATEGORY_INIT (gst_fd_sink__debug, "fdsink", 0, "fdsink element");
 108 #define gst_fd_sink_parent_class parent_class
 109 G_DEFINE_TYPE_WITH_CODE (GstFdSink, gst_fd_sink, GST_TYPE_BASE_SINK, _do_init);
 110
 111 static void gst_fd_sink_set_property (GObject * object, guint prop_id,
 112     const GValue * value, GParamSpec * pspec);
 113 static void gst_fd_sink_get_property (GObject * object, guint prop_id,
 114     GValue * value, GParamSpec * pspec);
 115 static void gst_fd_sink_dispose (GObject * obj);
 116
 117 static gboolean gst_fd_sink_query (GstBaseSink * bsink, GstQuery * query);
 118 static GstFlowReturn gst_fd_sink_render (GstBaseSink * sink,
 119     GstBuffer * buffer);
 120 static GstFlowReturn gst_fd_sink_render_list (GstBaseSink * bsink,
 121     GstBufferList * buffer_list);
 122 static gboolean gst_fd_sink_start (GstBaseSink * basesink);
 123 static gboolean gst_fd_sink_stop (GstBaseSink * basesink);
 124 static gboolean gst_fd_sink_unlock (GstBaseSink * basesink);
 125 static gboolean gst_fd_sink_unlock_stop (GstBaseSink * basesink);
 126 static gboolean gst_fd_sink_event (GstBaseSink * sink, GstEvent * event);
 127
 128 static gboolean gst_fd_sink_do_seek (GstFdSink * fdsink, guint64 new_offset);
 129
 130 static void
 131 gst_fd_sink_class_init (GstFdSinkClass * klass)
 132 {
 133   GObjectClass *gobject_class;
 134   GstElementClass *gstelement_class;
 135   GstBaseSinkClass *gstbasesink_class;
 136
 137   gobject_class = G_OBJECT_CLASS (klass);
 138   gstelement_class = GST_ELEMENT_CLASS (klass);
 139   gstbasesink_class = GST_BASE_SINK_CLASS (klass);
 140
 141   gobject_class->set_property = gst_fd_sink_set_property;
 142   gobject_class->get_property = gst_fd_sink_get_property;
 143   gobject_class->dispose = gst_fd_sink_dispose;
 144
 145   gst_element_class_set_static_metadata (gstelement_class,
 146       "Filedescriptor Sink",
 147       "Sink/File",
 148       "Write data to a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
 149   gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
 150
 151   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_fd_sink_render);
 152   gstbasesink_class->render_list = GST_DEBUG_FUNCPTR (gst_fd_sink_render_list);
 153   gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_fd_sink_start);
 154   gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_fd_sink_stop);
 155   gstbasesink_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_sink_unlock);
 156   gstbasesink_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_sink_unlock_stop);
 157   gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_fd_sink_event);
 158   gstbasesink_class->query = GST_DEBUG_FUNCPTR (gst_fd_sink_query);
 159
 160   g_object_class_install_property (gobject_class, ARG_FD,
 161       g_param_spec_int ("fd", "fd", "An open file descriptor to write to",
 162           0, G_MAXINT, 1, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 163 }
 164
 165 static void
 166 gst_fd_sink_init (GstFdSink * fdsink)
 167 {
 168   fdsink->fd = 1;
 169   fdsink->uri = g_strdup_printf ("fd://%d", fdsink->fd);
 170   fdsink->bytes_written = 0;
 171   fdsink->current_pos = 0;
 172
 173   gst_base_sink_set_sync (GST_BASE_SINK (fdsink), FALSE);
 174 }
 175
 176 static void
 177 gst_fd_sink_dispose (GObject * obj)
 178 {
 179   GstFdSink *fdsink = GST_FD_SINK (obj);
 180
 181   g_free (fdsink->uri);
 182   fdsink->uri = NULL;
 183
 184   G_OBJECT_CLASS (parent_class)->dispose (obj);
 185 }
 186
 187 static gboolean
 188 gst_fd_sink_query (GstBaseSink * bsink, GstQuery * query)
 189 {
 190   gboolean res = FALSE;
 191   GstFdSink *fdsink;
 192
 193   fdsink = GST_FD_SINK (bsink);
 194
 195   switch (GST_QUERY_TYPE (query)) {
 196     case GST_QUERY_POSITION:
 197     {
 198       GstFormat format;
 199
 200       gst_query_parse_position (query, &format, NULL);
 201
 202       switch (format) {
 203         case GST_FORMAT_DEFAULT:
 204         case GST_FORMAT_BYTES:
 205           gst_query_set_position (query, GST_FORMAT_BYTES, fdsink->current_pos);
 206           res = TRUE;
 207           break;
 208         default:
 209           break;
 210       }
 211       break;
 212     }
 213     case GST_QUERY_FORMATS:
 214       gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
 215       res = TRUE;
 216       break;
 217     case GST_QUERY_URI:
 218       gst_query_set_uri (query, fdsink->uri);
 219       res = TRUE;
 220       break;
 221     case GST_QUERY_SEEKING:{
 222       GstFormat format;
 223
 224       gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
 225       if (format == GST_FORMAT_BYTES || format == GST_FORMAT_DEFAULT) {
 226         gst_query_set_seeking (query, GST_FORMAT_BYTES, fdsink->seekable, 0,
 227             -1);
 228       } else {
 229         gst_query_set_seeking (query, format, FALSE, 0, -1);
 230       }
 231       res = TRUE;
 232       break;
 233     }
 234     default:
 235       res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
 236       break;
 237
 238   }
 239   return res;
 240 }
 241
 242 static GstFlowReturn
 243 gst_fd_sink_render_buffers (GstFdSink * sink, GstBuffer ** buffers,
 244     guint num_buffers, guint8 * mem_nums, guint total_mems)
 245 {
 246   return gst_writev_buffers (GST_OBJECT_CAST (sink), sink->fd, sink->fdset,
 247       buffers, num_buffers, mem_nums, total_mems, &sink->bytes_written,
 248       &sink->current_pos);
 249 }
 250
 251 static GstFlowReturn
 252 gst_fd_sink_render_list (GstBaseSink * bsink, GstBufferList * buffer_list)
 253 {
 254   GstFlowReturn flow;
 255   GstBuffer **buffers;
 256   GstFdSink *sink;
 257   guint8 *mem_nums;
 258   guint total_mems;
 259   guint i, num_buffers;
 260
 261   sink = GST_FD_SINK_CAST (bsink);
 262
 263   num_buffers = gst_buffer_list_length (buffer_list);
 264   if (num_buffers == 0)
 265     goto no_data;
 266
 267   /* extract buffers from list and count memories */
 268   buffers = g_newa (GstBuffer *, num_buffers);
 269   mem_nums = g_newa (guint8, num_buffers);
 270   for (i = 0, total_mems = 0; i < num_buffers; ++i) {
 271     buffers[i] = gst_buffer_list_get (buffer_list, i);
 272     mem_nums[i] = gst_buffer_n_memory (buffers[i]);
 273     total_mems += mem_nums[i];
 274   }
 275
 276   flow =
 277       gst_fd_sink_render_buffers (sink, buffers, num_buffers, mem_nums,
 278       total_mems);
 279
 280   return flow;
 281
 282 no_data:
 283   {
 284     GST_LOG_OBJECT (sink, "empty buffer list");
 285     return GST_FLOW_OK;
 286   }
 287 }
 288
 289 static GstFlowReturn
 290 gst_fd_sink_render (GstBaseSink * bsink, GstBuffer * buffer)
 291 {
 292   GstFlowReturn flow;
 293   GstFdSink *sink;
 294   guint8 n_mem;
 295
 296   sink = GST_FD_SINK_CAST (bsink);
 297
 298   n_mem = gst_buffer_n_memory (buffer);
 299
 300   if (n_mem > 0)
 301     flow = gst_fd_sink_render_buffers (sink, &buffer, 1, &n_mem, n_mem);
 302   else
 303     flow = GST_FLOW_OK;
 304
 305   return flow;
 306 }
 307
 308 static gboolean
 309 gst_fd_sink_check_fd (GstFdSink * fdsink, int fd, GError ** error)
 310 {
 311   struct stat stat_results;
 312   off_t result;
 313
 314   /* see that it is a valid file descriptor */
 315   if (fstat (fd, &stat_results) < 0)
 316     goto invalid;
 317
 318   if (!S_ISREG (stat_results.st_mode))
 319     goto not_seekable;
 320
 321   /* see if it is a seekable stream */
 322   result = lseek (fd, 0, SEEK_CUR);
 323   if (result == -1) {
 324     switch (errno) {
 325       case EINVAL:
 326       case EBADF:
 327         goto invalid;
 328
 329       case ESPIPE:
 330         goto not_seekable;
 331     }
 332   } else
 333     GST_DEBUG_OBJECT (fdsink, "File descriptor %d is seekable", fd);
 334
 335   return TRUE;
 336
 337 invalid:
 338   {
 339     GST_ELEMENT_ERROR (fdsink, RESOURCE, WRITE, (NULL),
 340         ("File descriptor %d is not valid: %s", fd, g_strerror (errno)));
 341     g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_REFERENCE,
 342         "File descriptor %d is not valid: %s", fd, g_strerror (errno));
 343     return FALSE;
 344   }
 345 not_seekable:
 346   {
 347     GST_DEBUG_OBJECT (fdsink, "File descriptor %d is a pipe", fd);
 348     return TRUE;
 349   }
 350 }
 351
 352 static gboolean
 353 gst_fd_sink_start (GstBaseSink * basesink)
 354 {
 355   GstFdSink *fdsink;
 356   GstPollFD fd = GST_POLL_FD_INIT;
 357
 358   fdsink = GST_FD_SINK (basesink);
 359   if (!gst_fd_sink_check_fd (fdsink, fdsink->fd, NULL))
 360     return FALSE;
 361
 362   if ((fdsink->fdset = gst_poll_new (TRUE)) == NULL)
 363     goto socket_pair;
 364
 365   fd.fd = fdsink->fd;
 366   gst_poll_add_fd (fdsink->fdset, &fd);
 367   gst_poll_fd_ctl_write (fdsink->fdset, &fd, TRUE);
 368
 369   fdsink->bytes_written = 0;
 370   fdsink->current_pos = 0;
 371
 372   fdsink->seekable = gst_fd_sink_do_seek (fdsink, 0);
 373   GST_INFO_OBJECT (fdsink, "seeking supported: %d", fdsink->seekable);
 374
 375   return TRUE;
 376
 377   /* ERRORS */
 378 socket_pair:
 379   {
 380     GST_ELEMENT_ERROR (fdsink, RESOURCE, OPEN_READ_WRITE, (NULL),
 381         GST_ERROR_SYSTEM);
 382     return FALSE;
 383   }
 384 }
 385
 386 static gboolean
 387 gst_fd_sink_stop (GstBaseSink * basesink)
 388 {
 389   GstFdSink *fdsink = GST_FD_SINK (basesink);
 390
 391   if (fdsink->fdset) {
 392     gst_poll_free (fdsink->fdset);
 393     fdsink->fdset = NULL;
 394   }
 395
 396   return TRUE;
 397 }
 398
 399 static gboolean
 400 gst_fd_sink_unlock (GstBaseSink * basesink)
 401 {
 402   GstFdSink *fdsink = GST_FD_SINK (basesink);
 403
 404   GST_LOG_OBJECT (fdsink, "Flushing");
 405   GST_OBJECT_LOCK (fdsink);
 406   gst_poll_set_flushing (fdsink->fdset, TRUE);
 407   GST_OBJECT_UNLOCK (fdsink);
 408
 409   return TRUE;
 410 }
 411
 412 static gboolean
 413 gst_fd_sink_unlock_stop (GstBaseSink * basesink)
 414 {
 415   GstFdSink *fdsink = GST_FD_SINK (basesink);
 416
 417   GST_LOG_OBJECT (fdsink, "No longer flushing");
 418   GST_OBJECT_LOCK (fdsink);
 419   gst_poll_set_flushing (fdsink->fdset, FALSE);
 420   GST_OBJECT_UNLOCK (fdsink);
 421
 422   return TRUE;
 423 }
 424
 425 static gboolean
 426 gst_fd_sink_update_fd (GstFdSink * fdsink, int new_fd, GError ** error)
 427 {
 428   if (new_fd < 0) {
 429     g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_REFERENCE,
 430         "File descriptor %d is not valid", new_fd);
 431     return FALSE;
 432   }
 433
 434   if (!gst_fd_sink_check_fd (fdsink, new_fd, error))
 435     goto invalid;
 436
 437   /* assign the fd */
 438   GST_OBJECT_LOCK (fdsink);
 439   if (fdsink->fdset) {
 440     GstPollFD fd = GST_POLL_FD_INIT;
 441
 442     fd.fd = fdsink->fd;
 443     gst_poll_remove_fd (fdsink->fdset, &fd);
 444
 445     fd.fd = new_fd;
 446     gst_poll_add_fd (fdsink->fdset, &fd);
 447     gst_poll_fd_ctl_write (fdsink->fdset, &fd, TRUE);
 448   }
 449   fdsink->fd = new_fd;
 450   g_free (fdsink->uri);
 451   fdsink->uri = g_strdup_printf ("fd://%d", fdsink->fd);
 452
 453   GST_OBJECT_UNLOCK (fdsink);
 454
 455   return TRUE;
 456
 457 invalid:
 458   {
 459     return FALSE;
 460   }
 461 }
 462
 463 static void
 464 gst_fd_sink_set_property (GObject * object, guint prop_id,
 465     const GValue * value, GParamSpec * pspec)
 466 {
 467   GstFdSink *fdsink;
 468
 469   fdsink = GST_FD_SINK (object);
 470
 471   switch (prop_id) {
 472     case ARG_FD:{
 473       int fd;
 474
 475       fd = g_value_get_int (value);
 476       gst_fd_sink_update_fd (fdsink, fd, NULL);
 477       break;
 478     }
 479     default:
 480       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 481       break;
 482   }
 483 }
 484
 485 static void
 486 gst_fd_sink_get_property (GObject * object, guint prop_id, GValue * value,
 487     GParamSpec * pspec)
 488 {
 489   GstFdSink *fdsink;
 490
 491   fdsink = GST_FD_SINK (object);
 492
 493   switch (prop_id) {
 494     case ARG_FD:
 495       g_value_set_int (value, fdsink->fd);
 496       break;
 497     default:
 498       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 499       break;
 500   }
 501 }
 502
 503 static gboolean
 504 gst_fd_sink_do_seek (GstFdSink * fdsink, guint64 new_offset)
 505 {
 506   off_t result;
 507
 508   result = lseek (fdsink->fd, new_offset, SEEK_SET);
 509
 510   if (result == -1)
 511     goto seek_failed;
 512
 513   fdsink->current_pos = new_offset;
 514
 515   GST_DEBUG_OBJECT (fdsink, "File descriptor %d to seek to position "
 516       "%" G_GUINT64_FORMAT, fdsink->fd, fdsink->current_pos);
 517
 518   return TRUE;
 519
 520   /* ERRORS */
 521 seek_failed:
 522   {
 523     GST_DEBUG_OBJECT (fdsink, "File descriptor %d failed to seek to position "
 524         "%" G_GUINT64_FORMAT, fdsink->fd, new_offset);
 525     return FALSE;
 526   }
 527 }
 528
 529 static gboolean
 530 gst_fd_sink_event (GstBaseSink * sink, GstEvent * event)
 531 {
 532   GstEventType type;
 533   GstFdSink *fdsink;
 534
 535   fdsink = GST_FD_SINK (sink);
 536
 537   type = GST_EVENT_TYPE (event);
 538
 539   switch (type) {
 540     case GST_EVENT_SEGMENT:
 541     {
 542       const GstSegment *segment;
 543
 544       gst_event_parse_segment (event, &segment);
 545
 546       if (segment->format == GST_FORMAT_BYTES) {
 547         /* only try to seek and fail when we are going to a different
 548          * position */
 549         if (fdsink->current_pos != segment->start) {
 550           /* FIXME, the seek should be performed on the pos field, start/stop are
 551            * just boundaries for valid bytes offsets. We should also fill the file
 552            * with zeroes if the new position extends the current EOF (sparse streams
 553            * and segment accumulation). */
 554           if (!gst_fd_sink_do_seek (fdsink, (guint64) segment->start))
 555             goto seek_failed;
 556         }
 557       } else {
 558         GST_DEBUG_OBJECT (fdsink,
 559             "Ignored SEGMENT event of format %u (%s)", (guint) segment->format,
 560             gst_format_get_name (segment->format));
 561       }
 562       break;
 563     }
 564     default:
 565       break;
 566   }
 567
 568   return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
 569
 570 seek_failed:
 571   {
 572     GST_ELEMENT_ERROR (fdsink, RESOURCE, SEEK, (NULL),
 573         ("Error while seeking on file descriptor %d: %s",
 574             fdsink->fd, g_strerror (errno)));
 575     gst_event_unref (event);
 576     return FALSE;
 577   }
 578
 579 }
 580
 581 /*** GSTURIHANDLER INTERFACE *************************************************/
 582
 583 static GstURIType
 584 gst_fd_sink_uri_get_type (GType type)
 585 {
 586   return GST_URI_SINK;
 587 }
 588
 589 static const gchar *const *
 590 gst_fd_sink_uri_get_protocols (GType type)
 591 {
 592   static const gchar *protocols[] = { "fd", NULL };
 593
 594   return protocols;
 595 }
 596
 597 static gchar *
 598 gst_fd_sink_uri_get_uri (GstURIHandler * handler)
 599 {
 600   GstFdSink *sink = GST_FD_SINK (handler);
 601
 602   /* FIXME: make thread-safe */
 603   return g_strdup (sink->uri);
 604 }
 605
 606 static gboolean
 607 gst_fd_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri,
 608     GError ** error)
 609 {
 610   GstFdSink *sink = GST_FD_SINK (handler);
 611   gint fd;
 612
 613   if (sscanf (uri, "fd://%d", &fd) != 1) {
 614     g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
 615         "File descriptor URI could not be parsed");
 616     return FALSE;
 617   }
 618
 619   return gst_fd_sink_update_fd (sink, fd, error);
 620 }
 621
 622 static void
 623 gst_fd_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
 624 {
 625   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
 626
 627   iface->get_type = gst_fd_sink_uri_get_type;
 628   iface->get_protocols = gst_fd_sink_uri_get_protocols;
 629   iface->get_uri = gst_fd_sink_uri_get_uri;
 630   iface->set_uri = gst_fd_sink_uri_set_uri;
 631 }