2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3 * Copyright (C) <2004> Thomas Vander Stichele <thomas at apestaart dot org>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * SECTION:element-tcpserversrc
23 * @see_also: #tcpserversink
26 * <title>Example launch line</title>
29 * gst-launch tcpserversrc protocol=none port=3000 ! fdsink fd=2
31 * gst-launch fdsrc fd=1 ! tcpclientsink protocol=none port=3000
40 #include <gst/gst-i18n-plugin.h>
42 #include "gsttcpserversrc.h"
43 #include <string.h> /* memset */
45 #include <sys/ioctl.h>
49 GST_DEBUG_CATEGORY_STATIC (tcpserversrc_debug);
50 #define GST_CAT_DEFAULT tcpserversrc_debug
52 #define TCP_DEFAULT_LISTEN_HOST NULL /* listen on all interfaces */
53 #define TCP_BACKLOG 1 /* client connection queue */
56 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
71 GST_BOILERPLATE (GstTCPServerSrc, gst_tcp_server_src, GstPushSrc,
75 static void gst_tcp_server_src_finalize (GObject * gobject);
77 static gboolean gst_tcp_server_src_start (GstBaseSrc * bsrc);
78 static gboolean gst_tcp_server_src_stop (GstBaseSrc * bsrc);
79 static gboolean gst_tcp_server_src_unlock (GstBaseSrc * bsrc);
80 static GstFlowReturn gst_tcp_server_src_create (GstPushSrc * psrc,
83 static void gst_tcp_server_src_set_property (GObject * object, guint prop_id,
84 const GValue * value, GParamSpec * pspec);
85 static void gst_tcp_server_src_get_property (GObject * object, guint prop_id,
86 GValue * value, GParamSpec * pspec);
90 gst_tcp_server_src_base_init (gpointer g_class)
92 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
94 gst_element_class_add_static_pad_template (element_class, &srctemplate);
96 gst_element_class_set_details_simple (element_class,
97 "TCP server source", "Source/Network",
98 "Receive data as a server over the network via TCP",
99 "Thomas Vander Stichele <thomas at apestaart dot org>");
103 gst_tcp_server_src_class_init (GstTCPServerSrcClass * klass)
105 GObjectClass *gobject_class;
106 GstBaseSrcClass *gstbasesrc_class;
107 GstPushSrcClass *gstpush_src_class;
109 gobject_class = (GObjectClass *) klass;
110 gstbasesrc_class = (GstBaseSrcClass *) klass;
111 gstpush_src_class = (GstPushSrcClass *) klass;
113 gobject_class->set_property = gst_tcp_server_src_set_property;
114 gobject_class->get_property = gst_tcp_server_src_get_property;
115 gobject_class->finalize = gst_tcp_server_src_finalize;
117 g_object_class_install_property (gobject_class, PROP_HOST,
118 g_param_spec_string ("host", "Host", "The hostname to listen as",
119 TCP_DEFAULT_LISTEN_HOST, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
120 g_object_class_install_property (gobject_class, PROP_PORT,
121 g_param_spec_int ("port", "Port", "The port to listen to",
122 0, TCP_HIGHEST_PORT, TCP_DEFAULT_PORT,
123 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
124 g_object_class_install_property (gobject_class, PROP_PROTOCOL,
125 g_param_spec_enum ("protocol", "Protocol", "The protocol to wrap data in",
126 GST_TYPE_TCP_PROTOCOL, GST_TCP_PROTOCOL_NONE,
127 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
129 gstbasesrc_class->start = gst_tcp_server_src_start;
130 gstbasesrc_class->stop = gst_tcp_server_src_stop;
131 gstbasesrc_class->unlock = gst_tcp_server_src_unlock;
133 gstpush_src_class->create = gst_tcp_server_src_create;
135 GST_DEBUG_CATEGORY_INIT (tcpserversrc_debug, "tcpserversrc", 0,
136 "TCP Server Source");
140 gst_tcp_server_src_init (GstTCPServerSrc * src, GstTCPServerSrcClass * g_class)
142 src->server_port = TCP_DEFAULT_PORT;
143 src->host = g_strdup (TCP_DEFAULT_HOST);
144 src->server_sock_fd.fd = -1;
145 src->client_sock_fd.fd = -1;
146 src->protocol = GST_TCP_PROTOCOL_NONE;
148 GST_OBJECT_FLAG_UNSET (src, GST_TCP_SERVER_SRC_OPEN);
152 gst_tcp_server_src_finalize (GObject * gobject)
154 GstTCPServerSrc *src = GST_TCP_SERVER_SRC (gobject);
158 G_OBJECT_CLASS (parent_class)->finalize (gobject);
162 gst_tcp_server_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
164 GstTCPServerSrc *src;
165 GstFlowReturn ret = GST_FLOW_OK;
167 src = GST_TCP_SERVER_SRC (psrc);
169 if (!GST_OBJECT_FLAG_IS_SET (src, GST_TCP_SERVER_SRC_OPEN))
173 if (src->client_sock_fd.fd >= 0) {
174 /* if we have a client, wait for read */
175 gst_poll_fd_ctl_read (src->fdset, &src->server_sock_fd, FALSE);
176 gst_poll_fd_ctl_read (src->fdset, &src->client_sock_fd, TRUE);
178 /* else wait on server socket for connections */
179 gst_poll_fd_ctl_read (src->fdset, &src->server_sock_fd, TRUE);
182 /* no action (0) is an error too in our case */
183 if ((ret = gst_poll_wait (src->fdset, GST_CLOCK_TIME_NONE)) <= 0) {
184 if (ret == -1 && errno == EBUSY)
185 goto select_cancelled;
190 /* if we have no client socket we can accept one now */
191 if (src->client_sock_fd.fd < 0) {
192 if (gst_poll_fd_can_read (src->fdset, &src->server_sock_fd)) {
193 if ((src->client_sock_fd.fd =
194 accept (src->server_sock_fd.fd,
195 (struct sockaddr *) &src->client_sin,
196 &src->client_sin_len)) == -1)
199 gst_poll_add_fd (src->fdset, &src->client_sock_fd);
201 /* and restart now to poll the socket. */
205 GST_LOG_OBJECT (src, "asked for a buffer");
207 switch (src->protocol) {
208 case GST_TCP_PROTOCOL_NONE:
209 ret = gst_tcp_read_buffer (GST_ELEMENT (src), src->client_sock_fd.fd,
213 case GST_TCP_PROTOCOL_GDP:
214 if (!src->caps_received) {
218 ret = gst_tcp_gdp_read_caps (GST_ELEMENT (src), src->client_sock_fd.fd,
221 if (ret == GST_FLOW_WRONG_STATE)
224 if (ret != GST_FLOW_OK)
225 goto gdp_caps_read_error;
227 src->caps_received = TRUE;
228 string = gst_caps_to_string (caps);
229 GST_DEBUG_OBJECT (src, "Received caps through GDP: %s", string);
232 gst_pad_set_caps (GST_BASE_SRC_PAD (psrc), caps);
235 ret = gst_tcp_gdp_read_buffer (GST_ELEMENT (src), src->client_sock_fd.fd,
238 if (ret == GST_FLOW_OK)
239 gst_buffer_set_caps (*outbuf, GST_PAD_CAPS (GST_BASE_SRC_PAD (src)));
244 /* need to assert as buf == NULL */
245 g_assert ("Unhandled protocol type");
249 if (ret == GST_FLOW_OK) {
251 "Returning buffer from _get of size %d, ts %"
252 GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT
253 ", offset %" G_GINT64_FORMAT ", offset_end %" G_GINT64_FORMAT,
254 GST_BUFFER_SIZE (*outbuf),
255 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (*outbuf)),
256 GST_TIME_ARGS (GST_BUFFER_DURATION (*outbuf)),
257 GST_BUFFER_OFFSET (*outbuf), GST_BUFFER_OFFSET_END (*outbuf));
264 GST_DEBUG_OBJECT (src, "connection to closed, cannot read data");
265 return GST_FLOW_WRONG_STATE;
269 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
270 ("Select error: %s", g_strerror (errno)));
271 return GST_FLOW_ERROR;
275 GST_DEBUG_OBJECT (src, "select canceled");
276 return GST_FLOW_WRONG_STATE;
280 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
281 ("Could not accept client on server socket: %s", g_strerror (errno)));
282 return GST_FLOW_ERROR;
286 GST_DEBUG_OBJECT (src, "reading gdp canceled");
287 return GST_FLOW_WRONG_STATE;
291 /* if we did not get canceled, report an error */
292 if (ret != GST_FLOW_WRONG_STATE) {
293 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
294 ("Could not read caps through GDP"));
301 gst_tcp_server_src_set_property (GObject * object, guint prop_id,
302 const GValue * value, GParamSpec * pspec)
304 GstTCPServerSrc *tcpserversrc = GST_TCP_SERVER_SRC (object);
308 if (!g_value_get_string (value)) {
309 g_warning ("host property cannot be NULL");
312 g_free (tcpserversrc->host);
313 tcpserversrc->host = g_strdup (g_value_get_string (value));
316 tcpserversrc->server_port = g_value_get_int (value);
319 tcpserversrc->protocol = g_value_get_enum (value);
323 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
329 gst_tcp_server_src_get_property (GObject * object, guint prop_id,
330 GValue * value, GParamSpec * pspec)
332 GstTCPServerSrc *tcpserversrc = GST_TCP_SERVER_SRC (object);
336 g_value_set_string (value, tcpserversrc->host);
339 g_value_set_int (value, tcpserversrc->server_port);
342 g_value_set_enum (value, tcpserversrc->protocol);
346 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
353 gst_tcp_server_src_start (GstBaseSrc * bsrc)
356 GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
358 /* reset caps_received flag */
359 src->caps_received = FALSE;
361 /* create the server listener socket */
362 if ((src->server_sock_fd.fd = socket (AF_INET, SOCK_STREAM, 0)) == -1)
365 GST_DEBUG_OBJECT (src, "opened receiving server socket with fd %d",
366 src->server_sock_fd.fd);
368 /* make address reusable */
370 if (setsockopt (src->server_sock_fd.fd, SOL_SOCKET, SO_REUSEADDR, &ret,
374 /* name the socket */
375 memset (&src->server_sin, 0, sizeof (src->server_sin));
376 src->server_sin.sin_family = AF_INET; /* network socket */
377 src->server_sin.sin_port = htons (src->server_port); /* on port */
381 if (!(host = gst_tcp_host_to_ip (GST_ELEMENT (src), src->host)))
383 src->server_sin.sin_addr.s_addr = inet_addr (host);
386 src->server_sin.sin_addr.s_addr = htonl (INADDR_ANY);
389 GST_DEBUG_OBJECT (src, "binding server socket to address");
390 if ((ret = bind (src->server_sock_fd.fd, (struct sockaddr *) &src->server_sin,
391 sizeof (src->server_sin))) < 0)
394 GST_DEBUG_OBJECT (src, "listening on server socket %d with queue of %d",
395 src->server_sock_fd.fd, TCP_BACKLOG);
397 if (listen (src->server_sock_fd.fd, TCP_BACKLOG) == -1)
400 /* create an fdset to keep track of our file descriptors */
401 if ((src->fdset = gst_poll_new (TRUE)) == NULL)
404 gst_poll_add_fd (src->fdset, &src->server_sock_fd);
406 GST_DEBUG_OBJECT (src, "received client");
408 GST_OBJECT_FLAG_SET (src, GST_TCP_SERVER_SRC_OPEN);
415 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL), GST_ERROR_SYSTEM);
420 GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
421 ("Could not setsockopt: %s", g_strerror (errno)));
422 gst_tcp_socket_close (&src->server_sock_fd);
427 gst_tcp_socket_close (&src->server_sock_fd);
432 gst_tcp_socket_close (&src->server_sock_fd);
435 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
436 ("bind failed: %s", g_strerror (errno)));
443 gst_tcp_socket_close (&src->server_sock_fd);
444 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
445 ("Could not listen on server socket: %s", g_strerror (errno)));
450 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
452 gst_tcp_socket_close (&src->server_sock_fd);
458 gst_tcp_server_src_stop (GstBaseSrc * bsrc)
460 GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
462 gst_poll_free (src->fdset);
465 gst_tcp_socket_close (&src->server_sock_fd);
466 gst_tcp_socket_close (&src->client_sock_fd);
468 GST_OBJECT_FLAG_UNSET (src, GST_TCP_SERVER_SRC_OPEN);
473 /* will be called only between calls to start() and stop() */
475 gst_tcp_server_src_unlock (GstBaseSrc * bsrc)
477 GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
479 gst_poll_set_flushing (src->fdset, TRUE);