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-tcpclientsink
23 * @see_also: #tcpclientsrc
26 * <title>Example launch line</title>
31 * gst-launch fdsrc fd=1 ! tcpclientsink protocol=none port=3000
32 * ]| everything you type in the client is shown on the server
39 #include <gst/gst-i18n-plugin.h>
40 #include <gst/dataprotocol/dataprotocol.h>
42 #include "gsttcpclientsink.h"
43 #include <string.h> /* memset */
45 /* TCPClientSink signals and args */
53 GST_DEBUG_CATEGORY_STATIC (tcpclientsink_debug);
54 #define GST_CAT_DEFAULT (tcpclientsink_debug)
63 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
68 static void gst_tcp_client_sink_base_init (gpointer g_class);
69 static void gst_tcp_client_sink_class_init (GstTCPClientSink * klass);
70 static void gst_tcp_client_sink_init (GstTCPClientSink * tcpclientsink);
71 static void gst_tcp_client_sink_finalize (GObject * gobject);
73 static gboolean gst_tcp_client_sink_setcaps (GstBaseSink * bsink,
75 static GstFlowReturn gst_tcp_client_sink_render (GstBaseSink * bsink,
77 static GstStateChangeReturn gst_tcp_client_sink_change_state (GstElement *
78 element, GstStateChange transition);
80 static void gst_tcp_client_sink_set_property (GObject * object, guint prop_id,
81 const GValue * value, GParamSpec * pspec);
82 static void gst_tcp_client_sink_get_property (GObject * object, guint prop_id,
83 GValue * value, GParamSpec * pspec);
86 static GstElementClass *parent_class = NULL;
88 /*static guint gst_tcp_client_sink_signals[LAST_SIGNAL] = { 0 }; */
91 gst_tcp_client_sink_get_type (void)
93 static GType tcpclientsink_type = 0;
96 if (!tcpclientsink_type) {
97 static const GTypeInfo tcpclientsink_info = {
98 sizeof (GstTCPClientSinkClass),
99 gst_tcp_client_sink_base_init,
101 (GClassInitFunc) gst_tcp_client_sink_class_init,
104 sizeof (GstTCPClientSink),
106 (GInstanceInitFunc) gst_tcp_client_sink_init,
111 g_type_register_static (GST_TYPE_BASE_SINK, "GstTCPClientSink",
112 &tcpclientsink_info, 0);
114 return tcpclientsink_type;
118 gst_tcp_client_sink_base_init (gpointer g_class)
120 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
122 gst_element_class_add_pad_template (element_class,
123 gst_static_pad_template_get (&sinktemplate));
125 gst_element_class_set_details_simple (element_class,
126 "TCP client sink", "Sink/Network",
127 "Send data as a client over the network via TCP",
128 "Thomas Vander Stichele <thomas at apestaart dot org>");
132 gst_tcp_client_sink_class_init (GstTCPClientSink * klass)
134 GObjectClass *gobject_class;
135 GstElementClass *gstelement_class;
136 GstBaseSinkClass *gstbasesink_class;
138 gobject_class = (GObjectClass *) klass;
139 gstelement_class = (GstElementClass *) klass;
140 gstbasesink_class = (GstBaseSinkClass *) klass;
142 parent_class = g_type_class_peek_parent (klass);
144 gobject_class->set_property = gst_tcp_client_sink_set_property;
145 gobject_class->get_property = gst_tcp_client_sink_get_property;
146 gobject_class->finalize = gst_tcp_client_sink_finalize;
148 g_object_class_install_property (gobject_class, ARG_HOST,
149 g_param_spec_string ("host", "Host", "The host/IP to send the packets to",
150 TCP_DEFAULT_HOST, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
151 g_object_class_install_property (gobject_class, ARG_PORT,
152 g_param_spec_int ("port", "Port", "The port to send the packets to",
153 0, TCP_HIGHEST_PORT, TCP_DEFAULT_PORT,
154 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
156 gstelement_class->change_state = gst_tcp_client_sink_change_state;
158 gstbasesink_class->set_caps = gst_tcp_client_sink_setcaps;
159 gstbasesink_class->render = gst_tcp_client_sink_render;
161 GST_DEBUG_CATEGORY_INIT (tcpclientsink_debug, "tcpclientsink", 0, "TCP sink");
165 gst_tcp_client_sink_init (GstTCPClientSink * this)
167 this->host = g_strdup (TCP_DEFAULT_HOST);
168 this->port = TCP_DEFAULT_PORT;
170 this->sock_fd.fd = -1;
171 GST_OBJECT_FLAG_UNSET (this, GST_TCP_CLIENT_SINK_OPEN);
175 gst_tcp_client_sink_finalize (GObject * gobject)
177 GstTCPClientSink *this = GST_TCP_CLIENT_SINK (gobject);
181 G_OBJECT_CLASS (parent_class)->finalize (gobject);
185 gst_tcp_client_sink_setcaps (GstBaseSink * bsink, GstCaps * caps)
187 GstTCPClientSink *sink;
189 sink = GST_TCP_CLIENT_SINK (bsink);
195 gst_tcp_client_sink_render (GstBaseSink * bsink, GstBuffer * buf)
198 GstTCPClientSink *sink;
201 sink = GST_TCP_CLIENT_SINK (bsink);
203 g_return_val_if_fail (GST_OBJECT_FLAG_IS_SET (sink, GST_TCP_CLIENT_SINK_OPEN),
204 GST_FLOW_WRONG_STATE);
206 size = GST_BUFFER_SIZE (buf);
208 GST_LOG_OBJECT (sink, "writing %d bytes for buffer data", size);
210 /* write buffer data */
211 wrote = gst_tcp_socket_write (sink->sock_fd.fd, GST_BUFFER_DATA (buf), size);
216 sink->data_written += wrote;
223 GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
224 (_("Error while sending data to \"%s:%d\"."), sink->host, sink->port),
225 ("Only %" G_GSIZE_FORMAT " of %u bytes written: %s",
226 wrote, GST_BUFFER_SIZE (buf), g_strerror (errno)));
227 return GST_FLOW_ERROR;
232 gst_tcp_client_sink_set_property (GObject * object, guint prop_id,
233 const GValue * value, GParamSpec * pspec)
235 GstTCPClientSink *tcpclientsink;
237 g_return_if_fail (GST_IS_TCP_CLIENT_SINK (object));
238 tcpclientsink = GST_TCP_CLIENT_SINK (object);
242 if (!g_value_get_string (value)) {
243 g_warning ("host property cannot be NULL");
246 g_free (tcpclientsink->host);
247 tcpclientsink->host = g_strdup (g_value_get_string (value));
250 tcpclientsink->port = g_value_get_int (value);
254 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
260 gst_tcp_client_sink_get_property (GObject * object, guint prop_id,
261 GValue * value, GParamSpec * pspec)
263 GstTCPClientSink *tcpclientsink;
265 g_return_if_fail (GST_IS_TCP_CLIENT_SINK (object));
266 tcpclientsink = GST_TCP_CLIENT_SINK (object);
270 g_value_set_string (value, tcpclientsink->host);
273 g_value_set_int (value, tcpclientsink->port);
277 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
283 /* create a socket for sending to remote machine */
285 gst_tcp_client_sink_start (GstTCPClientSink * this)
290 if (GST_OBJECT_FLAG_IS_SET (this, GST_TCP_CLIENT_SINK_OPEN))
293 /* reset caps_sent flag */
294 this->caps_sent = FALSE;
296 /* create sending client socket */
297 GST_DEBUG_OBJECT (this, "opening sending client socket to %s:%d", this->host,
299 if ((this->sock_fd.fd = socket (AF_INET, SOCK_STREAM, 0)) == -1) {
300 GST_ELEMENT_ERROR (this, RESOURCE, OPEN_WRITE, (NULL), GST_ERROR_SYSTEM);
303 GST_DEBUG_OBJECT (this, "opened sending client socket with fd %d",
306 /* look up name if we need to */
307 ip = gst_tcp_host_to_ip (GST_ELEMENT (this), this->host);
309 gst_tcp_socket_close (&this->sock_fd);
312 GST_DEBUG_OBJECT (this, "IP address for host %s is %s", this->host, ip);
314 /* connect to server */
315 memset (&this->server_sin, 0, sizeof (this->server_sin));
316 this->server_sin.sin_family = AF_INET; /* network socket */
317 this->server_sin.sin_port = htons (this->port); /* on port */
318 this->server_sin.sin_addr.s_addr = inet_addr (ip); /* on host ip */
321 GST_DEBUG_OBJECT (this, "connecting to server");
322 ret = connect (this->sock_fd.fd, (struct sockaddr *) &this->server_sin,
323 sizeof (this->server_sin));
326 gst_tcp_socket_close (&this->sock_fd);
329 GST_ELEMENT_ERROR (this, RESOURCE, OPEN_WRITE,
330 (_("Connection to %s:%d refused."), this->host, this->port),
335 GST_ELEMENT_ERROR (this, RESOURCE, OPEN_READ, (NULL),
336 ("connect to %s:%d failed: %s", this->host, this->port,
337 g_strerror (errno)));
343 GST_OBJECT_FLAG_SET (this, GST_TCP_CLIENT_SINK_OPEN);
345 this->data_written = 0;
351 gst_tcp_client_sink_stop (GstTCPClientSink * this)
353 if (!GST_OBJECT_FLAG_IS_SET (this, GST_TCP_CLIENT_SINK_OPEN))
356 gst_tcp_socket_close (&this->sock_fd);
358 GST_OBJECT_FLAG_UNSET (this, GST_TCP_CLIENT_SINK_OPEN);
363 static GstStateChangeReturn
364 gst_tcp_client_sink_change_state (GstElement * element,
365 GstStateChange transition)
367 GstTCPClientSink *sink;
368 GstStateChangeReturn res;
370 sink = GST_TCP_CLIENT_SINK (element);
372 switch (transition) {
373 case GST_STATE_CHANGE_NULL_TO_READY:
374 case GST_STATE_CHANGE_READY_TO_PAUSED:
375 if (!gst_tcp_client_sink_start (sink))
381 res = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
383 switch (transition) {
384 case GST_STATE_CHANGE_READY_TO_NULL:
385 gst_tcp_client_sink_stop (sink);
393 return GST_STATE_CHANGE_FAILURE;