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