2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2005 Philippe Khalaf <burger@speedy.org>
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.
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.
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., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 * SECTION:element-fdsrc
25 * @short_description: read from a unix file descriptor
26 * @see_also: #GstFdSink
28 * Read data from a unix file descriptor.
35 #include "gst/gst_private.h"
37 #include <sys/types.h>
39 #include <sys/socket.h>
53 /* the select call is also performed on the control sockets, that way
54 * we can send special commands to unblock the select call */
55 #define CONTROL_STOP 'S' /* stop the select call */
56 #define CONTROL_SOCKETS(src) src->control_sock
57 #define WRITE_SOCKET(src) src->control_sock[1]
58 #define READ_SOCKET(src) src->control_sock[0]
60 #define SEND_COMMAND(src, command) \
62 unsigned char c; c = command; \
63 write (WRITE_SOCKET(src), &c, 1); \
66 #define READ_COMMAND(src, command, res) \
68 res = read(READ_SOCKET(src), &command, 1); \
71 #define DEFAULT_BLOCKSIZE 4096
73 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
78 GST_DEBUG_CATEGORY_STATIC (gst_fd_src_debug);
79 #define GST_CAT_DEFAULT gst_fd_src_debug
81 static const GstElementDetails gst_fd_src_details =
82 GST_ELEMENT_DETAILS ("Disk Source",
84 "Synchronous read from a file",
85 "Erik Walthinsen <omega@cse.ogi.edu>");
93 static void gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data);
96 _do_init (GType fd_src_type)
98 static const GInterfaceInfo urihandler_info = {
99 gst_fd_src_uri_handler_init,
104 g_type_add_interface_static (fd_src_type, GST_TYPE_URI_HANDLER,
107 GST_DEBUG_CATEGORY_INIT (gst_fd_src_debug, "fdsrc", 0, "fdsrc element");
110 GST_BOILERPLATE_FULL (GstFdSrc, gst_fd_src, GstElement, GST_TYPE_PUSH_SRC,
113 static void gst_fd_src_set_property (GObject * object, guint prop_id,
114 const GValue * value, GParamSpec * pspec);
115 static void gst_fd_src_get_property (GObject * object, guint prop_id,
116 GValue * value, GParamSpec * pspec);
117 static void gst_fd_src_dispose (GObject * obj);
119 static gboolean gst_fd_src_start (GstBaseSrc * bsrc);
120 static gboolean gst_fd_src_stop (GstBaseSrc * bsrc);
121 static gboolean gst_fd_src_unlock (GstBaseSrc * bsrc);
122 static gboolean gst_fd_src_is_seekable (GstBaseSrc * bsrc);
123 static gboolean gst_fd_src_get_size (GstBaseSrc * src, guint64 * size);
125 static GstFlowReturn gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf);
128 gst_fd_src_base_init (gpointer g_class)
130 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
132 gst_element_class_add_pad_template (gstelement_class,
133 gst_static_pad_template_get (&srctemplate));
134 gst_element_class_set_details (gstelement_class, &gst_fd_src_details);
138 gst_fd_src_class_init (GstFdSrcClass * klass)
140 GObjectClass *gobject_class;
141 GstBaseSrcClass *gstbasesrc_class;
142 GstElementClass *gstelement_class;
143 GstPushSrcClass *gstpush_src_class;
145 gobject_class = G_OBJECT_CLASS (klass);
146 gstelement_class = GST_ELEMENT_CLASS (klass);
147 gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
148 gstpush_src_class = GST_PUSH_SRC_CLASS (klass);
150 parent_class = g_type_class_peek_parent (klass);
152 gobject_class->set_property = gst_fd_src_set_property;
153 gobject_class->get_property = gst_fd_src_get_property;
154 gobject_class->dispose = gst_fd_src_dispose;
156 g_object_class_install_property (gobject_class, PROP_FD,
157 g_param_spec_int ("fd", "fd", "An open file descriptor to read from",
158 0, G_MAXINT, 0, G_PARAM_READWRITE));
160 gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_fd_src_start);
161 gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_fd_src_stop);
162 gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_src_unlock);
163 gstbasesrc_class->is_seekable = GST_DEBUG_FUNCPTR (gst_fd_src_is_seekable);
164 gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_fd_src_get_size);
166 gstpush_src_class->create = GST_DEBUG_FUNCPTR (gst_fd_src_create);
170 gst_fd_src_init (GstFdSrc * fdsrc, GstFdSrcClass * klass)
174 fdsrc->seekable_fd = FALSE;
175 fdsrc->uri = g_strdup_printf ("fd://%d", fdsrc->fd);
176 fdsrc->curoffset = 0;
180 gst_fd_src_dispose (GObject * obj)
182 GstFdSrc *src = GST_FD_SRC (obj);
187 G_OBJECT_CLASS (parent_class)->dispose (obj);
191 gst_fd_src_update_fd (GstFdSrc * src)
193 struct stat stat_results;
195 if (src->fd != src->new_fd) {
196 GST_INFO_OBJECT (src, "Updating to fd %d", src->new_fd);
198 src->fd = src->new_fd;
201 src->uri = g_strdup_printf ("fd://%d", src->fd);
203 if (fstat (src->fd, &stat_results) < 0)
206 if (!S_ISREG (stat_results.st_mode))
209 /* Try a seek of 0 bytes offset to check for seekability */
210 if (lseek (src->fd, 0, SEEK_CUR) < 0)
213 GST_INFO_OBJECT (src, "marking fd %d as seekable", src->fd);
214 src->seekable_fd = TRUE;
220 GST_INFO_OBJECT (src, "marking fd %d as NOT seekable", src->fd);
221 src->seekable_fd = FALSE;
226 gst_fd_src_start (GstBaseSrc * bsrc)
228 GstFdSrc *src = GST_FD_SRC (bsrc);
229 gint control_sock[2];
233 gst_fd_src_update_fd (src);
235 if (socketpair (PF_UNIX, SOCK_STREAM, 0, control_sock) < 0)
238 READ_SOCKET (src) = control_sock[0];
239 WRITE_SOCKET (src) = control_sock[1];
241 fcntl (READ_SOCKET (src), F_SETFL, O_NONBLOCK);
242 fcntl (WRITE_SOCKET (src), F_SETFL, O_NONBLOCK);
249 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
256 gst_fd_src_stop (GstBaseSrc * bsrc)
258 GstFdSrc *src = GST_FD_SRC (bsrc);
260 close (READ_SOCKET (src));
261 close (WRITE_SOCKET (src));
267 gst_fd_src_unlock (GstBaseSrc * bsrc)
269 GstFdSrc *src = GST_FD_SRC (bsrc);
271 SEND_COMMAND (src, CONTROL_STOP);
277 gst_fd_src_set_property (GObject * object, guint prop_id, const GValue * value,
280 GstFdSrc *src = GST_FD_SRC (object);
284 src->new_fd = g_value_get_int (value);
286 /* If state is ready or below, update the current fd immediately
287 * so it is reflected in get_properties and uri */
288 GST_OBJECT_LOCK (object);
289 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
290 GST_DEBUG_OBJECT (src, "state ready or lower, updating to use new fd");
291 gst_fd_src_update_fd (src);
293 GST_DEBUG_OBJECT (src, "state above ready, not updating to new fd yet");
295 GST_OBJECT_UNLOCK (object);
298 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
304 gst_fd_src_get_property (GObject * object, guint prop_id, GValue * value,
307 GstFdSrc *src = GST_FD_SRC (object);
311 g_value_set_int (value, src->fd);
314 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
320 gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
332 src = GST_FD_SRC (psrc);
336 FD_SET (src->fd, &readfds);
337 FD_SET (READ_SOCKET (src), &readfds);
340 retval = select (FD_SETSIZE, &readfds, NULL, NULL, NULL);
341 } while ((retval == -1 && errno == EINTR));
346 if (FD_ISSET (READ_SOCKET (src), &readfds)) {
347 /* read all stop commands */
352 GST_LOG_OBJECT (src, "reading command");
354 READ_COMMAND (src, command, res);
356 GST_LOG_OBJECT (src, "no more commands");
357 /* no more commands */
365 blocksize = GST_BASE_SRC (src)->blocksize;
367 /* create the buffer */
368 buf = gst_buffer_new_and_alloc (blocksize);
371 readbytes = read (src->fd, GST_BUFFER_DATA (buf), blocksize);
372 GST_LOG_OBJECT (src, "read %" G_GSSIZE_FORMAT, readbytes);
373 } while (readbytes == -1 && errno == EINTR); /* retry if interrupted */
381 GST_BUFFER_OFFSET (buf) = src->curoffset;
382 GST_BUFFER_SIZE (buf) = readbytes;
383 GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
384 src->curoffset += readbytes;
386 GST_LOG_OBJECT (psrc, "Read buffer of size %ld", readbytes);
388 /* we're done, return the buffer */
397 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
398 ("select on file descriptor: %s.", g_strerror (errno)));
399 GST_DEBUG_OBJECT (psrc, "Error during select");
400 return GST_FLOW_ERROR;
404 GST_DEBUG_OBJECT (psrc, "Select stopped");
405 return GST_FLOW_WRONG_STATE;
410 GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
411 gst_buffer_unref (buf);
412 return GST_FLOW_UNEXPECTED;
416 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
417 ("read on file descriptor: %s.", g_strerror (errno)));
418 GST_DEBUG_OBJECT (psrc, "Error reading from fd");
419 gst_buffer_unref (buf);
420 return GST_FLOW_ERROR;
425 gst_fd_src_is_seekable (GstBaseSrc * bsrc)
427 GstFdSrc *src = GST_FD_SRC (bsrc);
429 return src->seekable_fd;
433 gst_fd_src_get_size (GstBaseSrc * bsrc, guint64 * size)
435 GstFdSrc *src = GST_FD_SRC (bsrc);
436 struct stat stat_results;
438 if (!src->seekable_fd) {
439 /* If it isn't seekable, we won't know the length (but fstat will still
440 * succeed, and wrongly say our length is zero. */
444 if (fstat (src->fd, &stat_results) < 0)
447 *size = stat_results.st_size;
459 /*** GSTURIHANDLER INTERFACE *************************************************/
462 gst_fd_src_uri_get_type (void)
467 gst_fd_src_uri_get_protocols (void)
469 static gchar *protocols[] = { "fd", NULL };
474 gst_fd_src_uri_get_uri (GstURIHandler * handler)
476 GstFdSrc *src = GST_FD_SRC (handler);
482 gst_fd_src_uri_set_uri (GstURIHandler * handler, const gchar * uri)
485 GstFdSrc *src = GST_FD_SRC (handler);
488 protocol = gst_uri_get_protocol (uri);
489 if (strcmp (protocol, "fd") != 0) {
495 if (sscanf (uri, "fd://%d", &fd) != 1)
500 GST_OBJECT_LOCK (src);
501 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
502 gst_fd_src_update_fd (src);
504 GST_OBJECT_UNLOCK (src);
510 gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
512 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
514 iface->get_type = gst_fd_src_uri_get_type;
515 iface->get_protocols = gst_fd_src_uri_get_protocols;
516 iface->get_uri = gst_fd_src_uri_get_uri;
517 iface->set_uri = gst_fd_src_uri_set_uri;