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_pad_template (element_class,
95 gst_static_pad_template_get (&srctemplate));
97 gst_element_class_set_details_simple (element_class,
98 "TCP server source", "Source/Network",
99 "Receive data as a server over the network via TCP",
100 "Thomas Vander Stichele <thomas at apestaart dot org>");
104 gst_tcp_server_src_class_init (GstTCPServerSrcClass * klass)
106 GObjectClass *gobject_class;
107 GstBaseSrcClass *gstbasesrc_class;
108 GstPushSrcClass *gstpush_src_class;
110 gobject_class = (GObjectClass *) klass;
111 gstbasesrc_class = (GstBaseSrcClass *) klass;
112 gstpush_src_class = (GstPushSrcClass *) klass;
114 gobject_class->set_property = gst_tcp_server_src_set_property;
115 gobject_class->get_property = gst_tcp_server_src_get_property;
116 gobject_class->finalize = gst_tcp_server_src_finalize;
118 g_object_class_install_property (gobject_class, PROP_HOST,
119 g_param_spec_string ("host", "Host", "The hostname to listen as",
120 TCP_DEFAULT_LISTEN_HOST, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
121 g_object_class_install_property (gobject_class, PROP_PORT,
122 g_param_spec_int ("port", "Port", "The port to listen to",
123 0, TCP_HIGHEST_PORT, TCP_DEFAULT_PORT,
124 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
125 g_object_class_install_property (gobject_class, PROP_PROTOCOL,
126 g_param_spec_enum ("protocol", "Protocol", "The protocol to wrap data in",
127 GST_TYPE_TCP_PROTOCOL, GST_TCP_PROTOCOL_NONE,
128 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
130 gstbasesrc_class->start = gst_tcp_server_src_start;
131 gstbasesrc_class->stop = gst_tcp_server_src_stop;
132 gstbasesrc_class->unlock = gst_tcp_server_src_unlock;
134 gstpush_src_class->create = gst_tcp_server_src_create;
136 GST_DEBUG_CATEGORY_INIT (tcpserversrc_debug, "tcpserversrc", 0,
137 "TCP Server Source");
141 gst_tcp_server_src_init (GstTCPServerSrc * src, GstTCPServerSrcClass * g_class)
143 src->server_port = TCP_DEFAULT_PORT;
144 src->host = g_strdup (TCP_DEFAULT_HOST);
145 src->server_sock_fd.fd = -1;
146 src->client_sock_fd.fd = -1;
147 src->protocol = GST_TCP_PROTOCOL_NONE;
149 GST_OBJECT_FLAG_UNSET (src, GST_TCP_SERVER_SRC_OPEN);
153 gst_tcp_server_src_finalize (GObject * gobject)
155 GstTCPServerSrc *src = GST_TCP_SERVER_SRC (gobject);
159 G_OBJECT_CLASS (parent_class)->finalize (gobject);
163 gst_tcp_server_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
165 GstTCPServerSrc *src;
166 GstFlowReturn ret = GST_FLOW_OK;
168 src = GST_TCP_SERVER_SRC (psrc);
170 if (!GST_OBJECT_FLAG_IS_SET (src, GST_TCP_SERVER_SRC_OPEN))
174 if (src->client_sock_fd.fd >= 0) {
175 /* if we have a client, wait for read */
176 gst_poll_fd_ctl_read (src->fdset, &src->server_sock_fd, FALSE);
177 gst_poll_fd_ctl_read (src->fdset, &src->client_sock_fd, TRUE);
179 /* else wait on server socket for connections */
180 gst_poll_fd_ctl_read (src->fdset, &src->server_sock_fd, TRUE);
183 /* no action (0) is an error too in our case */
184 if ((ret = gst_poll_wait (src->fdset, GST_CLOCK_TIME_NONE)) <= 0) {
185 if (ret == -1 && errno == EBUSY)
186 goto select_cancelled;
191 /* if we have no client socket we can accept one now */
192 if (src->client_sock_fd.fd < 0) {
193 if (gst_poll_fd_can_read (src->fdset, &src->server_sock_fd)) {
194 if ((src->client_sock_fd.fd =
195 accept (src->server_sock_fd.fd,
196 (struct sockaddr *) &src->client_sin,
197 &src->client_sin_len)) == -1)
200 gst_poll_add_fd (src->fdset, &src->client_sock_fd);
202 /* and restart now to poll the socket. */
206 GST_LOG_OBJECT (src, "asked for a buffer");
208 switch (src->protocol) {
209 case GST_TCP_PROTOCOL_NONE:
210 ret = gst_tcp_read_buffer (GST_ELEMENT (src), src->client_sock_fd.fd,
214 case GST_TCP_PROTOCOL_GDP:
215 if (!src->caps_received) {
219 ret = gst_tcp_gdp_read_caps (GST_ELEMENT (src), src->client_sock_fd.fd,
222 if (ret == GST_FLOW_WRONG_STATE)
225 if (ret != GST_FLOW_OK)
226 goto gdp_caps_read_error;
228 src->caps_received = TRUE;
229 string = gst_caps_to_string (caps);
230 GST_DEBUG_OBJECT (src, "Received caps through GDP: %s", string);
233 gst_pad_set_caps (GST_BASE_SRC_PAD (psrc), caps);
236 ret = gst_tcp_gdp_read_buffer (GST_ELEMENT (src), src->client_sock_fd.fd,
239 if (ret == GST_FLOW_OK)
240 gst_buffer_set_caps (*outbuf, GST_PAD_CAPS (GST_BASE_SRC_PAD (src)));
245 /* need to assert as buf == NULL */
246 g_assert ("Unhandled protocol type");
250 if (ret == GST_FLOW_OK) {
252 "Returning buffer from _get of size %d, ts %"
253 GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT
254 ", offset %" G_GINT64_FORMAT ", offset_end %" G_GINT64_FORMAT,
255 GST_BUFFER_SIZE (*outbuf),
256 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (*outbuf)),
257 GST_TIME_ARGS (GST_BUFFER_DURATION (*outbuf)),
258 GST_BUFFER_OFFSET (*outbuf), GST_BUFFER_OFFSET_END (*outbuf));
265 GST_DEBUG_OBJECT (src, "connection to closed, cannot read data");
266 return GST_FLOW_WRONG_STATE;
270 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
271 ("Select error: %s", g_strerror (errno)));
272 return GST_FLOW_ERROR;
276 GST_DEBUG_OBJECT (src, "select canceled");
277 return GST_FLOW_WRONG_STATE;
281 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
282 ("Could not accept client on server socket: %s", g_strerror (errno)));
283 return GST_FLOW_ERROR;
287 GST_DEBUG_OBJECT (src, "reading gdp canceled");
288 return GST_FLOW_WRONG_STATE;
292 /* if we did not get canceled, report an error */
293 if (ret != GST_FLOW_WRONG_STATE) {
294 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
295 ("Could not read caps through GDP"));
302 gst_tcp_server_src_set_property (GObject * object, guint prop_id,
303 const GValue * value, GParamSpec * pspec)
305 GstTCPServerSrc *tcpserversrc = GST_TCP_SERVER_SRC (object);
309 if (!g_value_get_string (value)) {
310 g_warning ("host property cannot be NULL");
313 g_free (tcpserversrc->host);
314 tcpserversrc->host = g_strdup (g_value_get_string (value));
317 tcpserversrc->server_port = g_value_get_int (value);
320 tcpserversrc->protocol = g_value_get_enum (value);
324 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
330 gst_tcp_server_src_get_property (GObject * object, guint prop_id,
331 GValue * value, GParamSpec * pspec)
333 GstTCPServerSrc *tcpserversrc = GST_TCP_SERVER_SRC (object);
337 g_value_set_string (value, tcpserversrc->host);
340 g_value_set_int (value, tcpserversrc->server_port);
343 g_value_set_enum (value, tcpserversrc->protocol);
347 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
354 gst_tcp_server_src_start (GstBaseSrc * bsrc)
357 GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
359 /* reset caps_received flag */
360 src->caps_received = FALSE;
362 /* create the server listener socket */
363 if ((src->server_sock_fd.fd = socket (AF_INET, SOCK_STREAM, 0)) == -1)
366 GST_DEBUG_OBJECT (src, "opened receiving server socket with fd %d",
367 src->server_sock_fd.fd);
369 /* make address reusable */
371 if (setsockopt (src->server_sock_fd.fd, SOL_SOCKET, SO_REUSEADDR, &ret,
375 /* name the socket */
376 memset (&src->server_sin, 0, sizeof (src->server_sin));
377 src->server_sin.sin_family = AF_INET; /* network socket */
378 src->server_sin.sin_port = htons (src->server_port); /* on port */
382 if (!(host = gst_tcp_host_to_ip (GST_ELEMENT (src), src->host)))
384 src->server_sin.sin_addr.s_addr = inet_addr (host);
387 src->server_sin.sin_addr.s_addr = htonl (INADDR_ANY);
390 GST_DEBUG_OBJECT (src, "binding server socket to address");
391 if ((ret = bind (src->server_sock_fd.fd, (struct sockaddr *) &src->server_sin,
392 sizeof (src->server_sin))) < 0)
395 GST_DEBUG_OBJECT (src, "listening on server socket %d with queue of %d",
396 src->server_sock_fd.fd, TCP_BACKLOG);
398 if (listen (src->server_sock_fd.fd, TCP_BACKLOG) == -1)
401 /* create an fdset to keep track of our file descriptors */
402 if ((src->fdset = gst_poll_new (TRUE)) == NULL)
405 gst_poll_add_fd (src->fdset, &src->server_sock_fd);
407 GST_DEBUG_OBJECT (src, "received client");
409 GST_OBJECT_FLAG_SET (src, GST_TCP_SERVER_SRC_OPEN);
416 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL), GST_ERROR_SYSTEM);
421 GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
422 ("Could not setsockopt: %s", g_strerror (errno)));
423 gst_tcp_socket_close (&src->server_sock_fd);
428 gst_tcp_socket_close (&src->server_sock_fd);
433 gst_tcp_socket_close (&src->server_sock_fd);
436 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
437 ("bind failed: %s", g_strerror (errno)));
444 gst_tcp_socket_close (&src->server_sock_fd);
445 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
446 ("Could not listen on server socket: %s", g_strerror (errno)));
451 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
453 gst_tcp_socket_close (&src->server_sock_fd);
459 gst_tcp_server_src_stop (GstBaseSrc * bsrc)
461 GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
463 gst_poll_free (src->fdset);
466 gst_tcp_socket_close (&src->server_sock_fd);
467 gst_tcp_socket_close (&src->client_sock_fd);
469 GST_OBJECT_FLAG_UNSET (src, GST_TCP_SERVER_SRC_OPEN);
474 /* will be called only between calls to start() and stop() */
476 gst_tcp_server_src_unlock (GstBaseSrc * bsrc)
478 GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
480 gst_poll_set_flushing (src->fdset, TRUE);