2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3 * Copyright (C) <2004> Thomas Vander Stichele <thomas at apestaart dot org>
4 * Copyright (C) <2011> Collabora Ltd.
5 * Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>
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.
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.
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.
24 * SECTION:element-tcpclientsrc
25 * @see_also: #tcpclientsink
28 * <title>Example launch line</title>
33 * gst-launch tcpclientsrc port=3000 ! fdsink fd=2
34 * ]| everything you type in the server is shown on the client
42 #include <gst/gst-i18n-plugin.h>
43 #include "gsttcpclientsrc.h"
46 GST_DEBUG_CATEGORY_STATIC (tcpclientsrc_debug);
47 #define GST_CAT_DEFAULT tcpclientsrc_debug
49 #define MAX_READ_SIZE 4 * 1024
52 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
65 #define gst_tcp_client_src_parent_class parent_class
66 G_DEFINE_TYPE (GstTCPClientSrc, gst_tcp_client_src, GST_TYPE_PUSH_SRC);
69 static void gst_tcp_client_src_finalize (GObject * gobject);
71 static GstCaps *gst_tcp_client_src_getcaps (GstBaseSrc * psrc,
74 static GstFlowReturn gst_tcp_client_src_create (GstPushSrc * psrc,
76 static gboolean gst_tcp_client_src_stop (GstBaseSrc * bsrc);
77 static gboolean gst_tcp_client_src_start (GstBaseSrc * bsrc);
78 static gboolean gst_tcp_client_src_unlock (GstBaseSrc * bsrc);
79 static gboolean gst_tcp_client_src_unlock_stop (GstBaseSrc * bsrc);
81 static void gst_tcp_client_src_set_property (GObject * object, guint prop_id,
82 const GValue * value, GParamSpec * pspec);
83 static void gst_tcp_client_src_get_property (GObject * object, guint prop_id,
84 GValue * value, GParamSpec * pspec);
87 gst_tcp_client_src_class_init (GstTCPClientSrcClass * klass)
89 GObjectClass *gobject_class;
90 GstElementClass *gstelement_class;
91 GstBaseSrcClass *gstbasesrc_class;
92 GstPushSrcClass *gstpush_src_class;
94 gobject_class = (GObjectClass *) klass;
95 gstelement_class = (GstElementClass *) klass;
96 gstbasesrc_class = (GstBaseSrcClass *) klass;
97 gstpush_src_class = (GstPushSrcClass *) klass;
99 gobject_class->set_property = gst_tcp_client_src_set_property;
100 gobject_class->get_property = gst_tcp_client_src_get_property;
101 gobject_class->finalize = gst_tcp_client_src_finalize;
103 g_object_class_install_property (gobject_class, PROP_HOST,
104 g_param_spec_string ("host", "Host",
105 "The host IP address to receive packets from", TCP_DEFAULT_HOST,
106 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
107 g_object_class_install_property (gobject_class, PROP_PORT,
108 g_param_spec_int ("port", "Port", "The port to receive packets from", 0,
109 TCP_HIGHEST_PORT, TCP_DEFAULT_PORT,
110 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
112 gst_element_class_add_pad_template (gstelement_class,
113 gst_static_pad_template_get (&srctemplate));
115 gst_element_class_set_details_simple (gstelement_class,
116 "TCP client source", "Source/Network",
117 "Receive data as a client over the network via TCP",
118 "Thomas Vander Stichele <thomas at apestaart dot org>");
120 gstbasesrc_class->get_caps = gst_tcp_client_src_getcaps;
121 gstbasesrc_class->start = gst_tcp_client_src_start;
122 gstbasesrc_class->stop = gst_tcp_client_src_stop;
123 gstbasesrc_class->unlock = gst_tcp_client_src_unlock;
124 gstbasesrc_class->unlock_stop = gst_tcp_client_src_unlock_stop;
126 gstpush_src_class->create = gst_tcp_client_src_create;
128 GST_DEBUG_CATEGORY_INIT (tcpclientsrc_debug, "tcpclientsrc", 0,
129 "TCP Client Source");
133 gst_tcp_client_src_init (GstTCPClientSrc * this)
135 this->port = TCP_DEFAULT_PORT;
136 this->host = g_strdup (TCP_DEFAULT_HOST);
138 this->cancellable = g_cancellable_new ();
140 GST_OBJECT_FLAG_UNSET (this, GST_TCP_CLIENT_SRC_OPEN);
144 gst_tcp_client_src_finalize (GObject * gobject)
146 GstTCPClientSrc *this = GST_TCP_CLIENT_SRC (gobject);
148 if (this->cancellable)
149 g_object_unref (this->cancellable);
150 this->cancellable = NULL;
152 g_object_unref (this->socket);
157 G_OBJECT_CLASS (parent_class)->finalize (gobject);
161 gst_tcp_client_src_getcaps (GstBaseSrc * bsrc, GstCaps * filter)
163 GstTCPClientSrc *src;
164 GstCaps *caps = NULL;
166 src = GST_TCP_CLIENT_SRC (bsrc);
168 caps = (filter ? gst_caps_ref (filter) : gst_caps_new_any ());
170 GST_DEBUG_OBJECT (src, "returning caps %" GST_PTR_FORMAT, caps);
171 g_assert (GST_IS_CAPS (caps));
176 gst_tcp_client_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
178 GstTCPClientSrc *src;
179 GstFlowReturn ret = GST_FLOW_OK;
184 src = GST_TCP_CLIENT_SRC (psrc);
186 if (!GST_OBJECT_FLAG_IS_SET (src, GST_TCP_CLIENT_SRC_OPEN))
189 GST_LOG_OBJECT (src, "asked for a buffer");
191 /* read the buffer header */
192 *outbuf = gst_buffer_new_and_alloc (MAX_READ_SIZE);
193 data = gst_buffer_map (*outbuf, NULL, NULL, GST_MAP_READWRITE);
195 g_socket_receive (src->socket, (gchar *) data, MAX_READ_SIZE,
196 src->cancellable, &err);
199 GST_DEBUG_OBJECT (src, "Connection closed");
201 gst_buffer_unmap (*outbuf, data, MAX_READ_SIZE);
202 gst_buffer_unref (*outbuf);
204 } else if (ret < 0) {
205 if (g_error_matches (err, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
206 ret = GST_FLOW_WRONG_STATE;
207 GST_DEBUG_OBJECT (src, "Cancelled reading from socket");
209 ret = GST_FLOW_ERROR;
210 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
211 ("Failed to read from socket: %s", err->message));
213 gst_buffer_unmap (*outbuf, data, MAX_READ_SIZE);
214 gst_buffer_unref (*outbuf);
218 gst_buffer_unmap (*outbuf, data, rret);
221 "Returning buffer from _get of size %" G_GSIZE_FORMAT ", ts %"
222 GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT
223 ", offset %" G_GINT64_FORMAT ", offset_end %" G_GINT64_FORMAT,
224 gst_buffer_get_size (*outbuf),
225 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (*outbuf)),
226 GST_TIME_ARGS (GST_BUFFER_DURATION (*outbuf)),
227 GST_BUFFER_OFFSET (*outbuf), GST_BUFFER_OFFSET_END (*outbuf));
229 g_clear_error (&err);
235 GST_DEBUG_OBJECT (src, "connection to closed, cannot read data");
236 return GST_FLOW_WRONG_STATE;
241 gst_tcp_client_src_set_property (GObject * object, guint prop_id,
242 const GValue * value, GParamSpec * pspec)
244 GstTCPClientSrc *tcpclientsrc = GST_TCP_CLIENT_SRC (object);
248 if (!g_value_get_string (value)) {
249 g_warning ("host property cannot be NULL");
252 g_free (tcpclientsrc->host);
253 tcpclientsrc->host = g_strdup (g_value_get_string (value));
256 tcpclientsrc->port = g_value_get_int (value);
260 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
266 gst_tcp_client_src_get_property (GObject * object, guint prop_id,
267 GValue * value, GParamSpec * pspec)
269 GstTCPClientSrc *tcpclientsrc = GST_TCP_CLIENT_SRC (object);
273 g_value_set_string (value, tcpclientsrc->host);
276 g_value_set_int (value, tcpclientsrc->port);
279 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
284 /* create a socket for connecting to remote server */
286 gst_tcp_client_src_start (GstBaseSrc * bsrc)
288 GstTCPClientSrc *src = GST_TCP_CLIENT_SRC (bsrc);
291 GSocketAddress *saddr;
294 /* create receiving client socket */
295 GST_DEBUG_OBJECT (src, "opening receiving client socket to %s:%d",
296 src->host, src->port);
299 g_socket_new (G_SOCKET_FAMILY_IPV4, G_SOCKET_TYPE_STREAM,
300 G_SOCKET_PROTOCOL_TCP, &err);
304 GST_DEBUG_OBJECT (src, "opened receiving client socket");
305 GST_OBJECT_FLAG_SET (src, GST_TCP_CLIENT_SRC_OPEN);
307 /* look up name if we need to */
308 addr = g_inet_address_new_from_string (src->host);
312 resolver = g_resolver_get_default ();
315 g_resolver_lookup_by_name (resolver, src->host, src->cancellable, &err);
318 addr = G_INET_ADDRESS (g_object_ref (results->data));
320 g_resolver_free_addresses (results);
321 g_object_unref (resolver);
323 #ifndef GST_DISABLE_GST_DEBUG
325 gchar *ip = g_inet_address_to_string (addr);
327 GST_DEBUG_OBJECT (src, "IP address for host %s is %s", src->host, ip);
332 /* connect to server */
333 saddr = g_inet_socket_address_new (addr, src->port);
334 if (!g_socket_connect (src->socket, saddr, src->cancellable, &err))
337 g_object_unref (saddr);
338 g_object_unref (addr);
344 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
345 ("Failed to create socket: %s", err->message));
346 g_clear_error (&err);
351 if (g_error_matches (err, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
352 GST_DEBUG_OBJECT (src, "Cancelled name resolval");
354 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
355 ("Failed to resolve host '%s': %s", src->host, err->message));
357 g_clear_error (&err);
358 g_object_unref (resolver);
359 gst_tcp_client_src_stop (GST_BASE_SRC (src));
364 if (g_error_matches (err, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
365 GST_DEBUG_OBJECT (src, "Cancelled connecting");
367 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
368 ("Failed to connect to host '%s:%d': %s", src->host, src->port,
371 g_clear_error (&err);
372 g_object_unref (saddr);
373 g_object_unref (addr);
374 gst_tcp_client_src_stop (GST_BASE_SRC (src));
379 /* close the socket and associated resources
381 * used both to recover from errors and go to NULL state */
383 gst_tcp_client_src_stop (GstBaseSrc * bsrc)
385 GstTCPClientSrc *src;
388 src = GST_TCP_CLIENT_SRC (bsrc);
391 GST_DEBUG_OBJECT (src, "closing socket");
393 if (!g_socket_close (src->socket, &err)) {
394 GST_ERROR_OBJECT (src, "Failed to close socket: %s", err->message);
395 g_clear_error (&err);
397 g_object_unref (src->socket);
401 GST_OBJECT_FLAG_UNSET (src, GST_TCP_CLIENT_SRC_OPEN);
406 /* will be called only between calls to start() and stop() */
408 gst_tcp_client_src_unlock (GstBaseSrc * bsrc)
410 GstTCPClientSrc *src = GST_TCP_CLIENT_SRC (bsrc);
412 GST_DEBUG_OBJECT (src, "set to flushing");
413 g_cancellable_cancel (src->cancellable);
418 /* will be called only between calls to start() and stop() */
420 gst_tcp_client_src_unlock_stop (GstBaseSrc * bsrc)
422 GstTCPClientSrc *src = GST_TCP_CLIENT_SRC (bsrc);
424 GST_DEBUG_OBJECT (src, "unset flushing");
425 g_cancellable_reset (src->cancellable);