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)
65 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
70 static void gst_tcp_client_sink_base_init (gpointer g_class);
71 static void gst_tcp_client_sink_class_init (GstTCPClientSink * klass);
72 static void gst_tcp_client_sink_init (GstTCPClientSink * tcpclientsink);
73 static void gst_tcp_client_sink_finalize (GObject * gobject);
75 static gboolean gst_tcp_client_sink_setcaps (GstBaseSink * bsink,
77 static GstFlowReturn gst_tcp_client_sink_render (GstBaseSink * bsink,
79 static GstStateChangeReturn gst_tcp_client_sink_change_state (GstElement *
80 element, GstStateChange transition);
82 static void gst_tcp_client_sink_set_property (GObject * object, guint prop_id,
83 const GValue * value, GParamSpec * pspec);
84 static void gst_tcp_client_sink_get_property (GObject * object, guint prop_id,
85 GValue * value, GParamSpec * pspec);
88 static GstElementClass *parent_class = NULL;
90 /*static guint gst_tcp_client_sink_signals[LAST_SIGNAL] = { 0 }; */
93 gst_tcp_client_sink_get_type (void)
95 static GType tcpclientsink_type = 0;
98 if (!tcpclientsink_type) {
99 static const GTypeInfo tcpclientsink_info = {
100 sizeof (GstTCPClientSinkClass),
101 gst_tcp_client_sink_base_init,
103 (GClassInitFunc) gst_tcp_client_sink_class_init,
106 sizeof (GstTCPClientSink),
108 (GInstanceInitFunc) gst_tcp_client_sink_init,
113 g_type_register_static (GST_TYPE_BASE_SINK, "GstTCPClientSink",
114 &tcpclientsink_info, 0);
116 return tcpclientsink_type;
120 gst_tcp_client_sink_base_init (gpointer g_class)
122 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
124 gst_element_class_add_pad_template (element_class,
125 gst_static_pad_template_get (&sinktemplate));
127 gst_element_class_set_details_simple (element_class,
128 "TCP client sink", "Sink/Network",
129 "Send data as a client over the network via TCP",
130 "Thomas Vander Stichele <thomas at apestaart dot org>");
134 gst_tcp_client_sink_class_init (GstTCPClientSink * klass)
136 GObjectClass *gobject_class;
137 GstElementClass *gstelement_class;
138 GstBaseSinkClass *gstbasesink_class;
140 gobject_class = (GObjectClass *) klass;
141 gstelement_class = (GstElementClass *) klass;
142 gstbasesink_class = (GstBaseSinkClass *) klass;
144 parent_class = g_type_class_peek_parent (klass);
146 gobject_class->set_property = gst_tcp_client_sink_set_property;
147 gobject_class->get_property = gst_tcp_client_sink_get_property;
148 gobject_class->finalize = gst_tcp_client_sink_finalize;
150 g_object_class_install_property (gobject_class, ARG_HOST,
151 g_param_spec_string ("host", "Host", "The host/IP to send the packets to",
152 TCP_DEFAULT_HOST, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
153 g_object_class_install_property (gobject_class, ARG_PORT,
154 g_param_spec_int ("port", "Port", "The port to send the packets to",
155 0, TCP_HIGHEST_PORT, TCP_DEFAULT_PORT,
156 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
157 g_object_class_install_property (gobject_class, ARG_PROTOCOL,
158 g_param_spec_enum ("protocol", "Protocol", "The protocol to wrap data in",
159 GST_TYPE_TCP_PROTOCOL, GST_TCP_PROTOCOL_NONE,
160 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
162 gstelement_class->change_state = gst_tcp_client_sink_change_state;
164 gstbasesink_class->set_caps = gst_tcp_client_sink_setcaps;
165 gstbasesink_class->render = gst_tcp_client_sink_render;
167 GST_DEBUG_CATEGORY_INIT (tcpclientsink_debug, "tcpclientsink", 0, "TCP sink");
171 gst_tcp_client_sink_init (GstTCPClientSink * this)
173 this->host = g_strdup (TCP_DEFAULT_HOST);
174 this->port = TCP_DEFAULT_PORT;
176 this->sock_fd.fd = -1;
177 this->protocol = GST_TCP_PROTOCOL_NONE;
178 GST_OBJECT_FLAG_UNSET (this, GST_TCP_CLIENT_SINK_OPEN);
182 gst_tcp_client_sink_finalize (GObject * gobject)
184 GstTCPClientSink *this = GST_TCP_CLIENT_SINK (gobject);
188 G_OBJECT_CLASS (parent_class)->finalize (gobject);
192 gst_tcp_client_sink_setcaps (GstBaseSink * bsink, GstCaps * caps)
194 GstTCPClientSink *sink;
196 sink = GST_TCP_CLIENT_SINK (bsink);
198 /* write the buffer header if we have one */
199 switch (sink->protocol) {
200 case GST_TCP_PROTOCOL_NONE:
203 case GST_TCP_PROTOCOL_GDP:
204 /* if we haven't send caps yet, send them first */
205 if (!sink->caps_sent) {
209 caps = GST_PAD_CAPS (GST_PAD_PEER (GST_BASE_SINK_PAD (bsink)));
210 string = gst_caps_to_string (caps);
211 GST_DEBUG_OBJECT (sink, "Sending caps %s through GDP", string);
214 if (!gst_tcp_gdp_write_caps (GST_ELEMENT (sink), sink->sock_fd.fd,
215 caps, TRUE, sink->host, sink->port))
216 goto gdp_write_error;
218 sink->caps_sent = TRUE;
222 g_warning ("Unhandled protocol type");
236 gst_tcp_client_sink_render (GstBaseSink * bsink, GstBuffer * buf)
239 GstTCPClientSink *sink;
242 sink = GST_TCP_CLIENT_SINK (bsink);
244 g_return_val_if_fail (GST_OBJECT_FLAG_IS_SET (sink, GST_TCP_CLIENT_SINK_OPEN),
245 GST_FLOW_WRONG_STATE);
247 size = GST_BUFFER_SIZE (buf);
249 GST_LOG_OBJECT (sink, "writing %d bytes for buffer data", size);
251 /* write the buffer header if we have one */
252 switch (sink->protocol) {
253 case GST_TCP_PROTOCOL_NONE:
255 case GST_TCP_PROTOCOL_GDP:
256 GST_LOG_OBJECT (sink, "Sending buffer header through GDP");
257 if (!gst_tcp_gdp_write_buffer (GST_ELEMENT (sink), sink->sock_fd.fd, buf,
258 TRUE, sink->host, sink->port))
259 goto gdp_write_error;
265 /* write buffer data */
266 wrote = gst_tcp_socket_write (sink->sock_fd.fd, GST_BUFFER_DATA (buf), size);
271 sink->data_written += wrote;
282 GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
283 (_("Error while sending data to \"%s:%d\"."), sink->host, sink->port),
284 ("Only %" G_GSIZE_FORMAT " of %u bytes written: %s",
285 wrote, GST_BUFFER_SIZE (buf), g_strerror (errno)));
286 return GST_FLOW_ERROR;
291 gst_tcp_client_sink_set_property (GObject * object, guint prop_id,
292 const GValue * value, GParamSpec * pspec)
294 GstTCPClientSink *tcpclientsink;
296 g_return_if_fail (GST_IS_TCP_CLIENT_SINK (object));
297 tcpclientsink = GST_TCP_CLIENT_SINK (object);
301 if (!g_value_get_string (value)) {
302 g_warning ("host property cannot be NULL");
305 g_free (tcpclientsink->host);
306 tcpclientsink->host = g_strdup (g_value_get_string (value));
309 tcpclientsink->port = g_value_get_int (value);
312 tcpclientsink->protocol = g_value_get_enum (value);
316 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
322 gst_tcp_client_sink_get_property (GObject * object, guint prop_id,
323 GValue * value, GParamSpec * pspec)
325 GstTCPClientSink *tcpclientsink;
327 g_return_if_fail (GST_IS_TCP_CLIENT_SINK (object));
328 tcpclientsink = GST_TCP_CLIENT_SINK (object);
332 g_value_set_string (value, tcpclientsink->host);
335 g_value_set_int (value, tcpclientsink->port);
338 g_value_set_enum (value, tcpclientsink->protocol);
342 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
348 /* create a socket for sending to remote machine */
350 gst_tcp_client_sink_start (GstTCPClientSink * this)
355 if (GST_OBJECT_FLAG_IS_SET (this, GST_TCP_CLIENT_SINK_OPEN))
358 /* reset caps_sent flag */
359 this->caps_sent = FALSE;
361 /* create sending client socket */
362 GST_DEBUG_OBJECT (this, "opening sending client socket to %s:%d", this->host,
364 if ((this->sock_fd.fd = socket (AF_INET, SOCK_STREAM, 0)) == -1) {
365 GST_ELEMENT_ERROR (this, RESOURCE, OPEN_WRITE, (NULL), GST_ERROR_SYSTEM);
368 GST_DEBUG_OBJECT (this, "opened sending client socket with fd %d",
371 /* look up name if we need to */
372 ip = gst_tcp_host_to_ip (GST_ELEMENT (this), this->host);
374 gst_tcp_socket_close (&this->sock_fd);
377 GST_DEBUG_OBJECT (this, "IP address for host %s is %s", this->host, ip);
379 /* connect to server */
380 memset (&this->server_sin, 0, sizeof (this->server_sin));
381 this->server_sin.sin_family = AF_INET; /* network socket */
382 this->server_sin.sin_port = htons (this->port); /* on port */
383 this->server_sin.sin_addr.s_addr = inet_addr (ip); /* on host ip */
386 GST_DEBUG_OBJECT (this, "connecting to server");
387 ret = connect (this->sock_fd.fd, (struct sockaddr *) &this->server_sin,
388 sizeof (this->server_sin));
391 gst_tcp_socket_close (&this->sock_fd);
394 GST_ELEMENT_ERROR (this, RESOURCE, OPEN_WRITE,
395 (_("Connection to %s:%d refused."), this->host, this->port),
400 GST_ELEMENT_ERROR (this, RESOURCE, OPEN_READ, (NULL),
401 ("connect to %s:%d failed: %s", this->host, this->port,
402 g_strerror (errno)));
408 GST_OBJECT_FLAG_SET (this, GST_TCP_CLIENT_SINK_OPEN);
410 this->data_written = 0;
416 gst_tcp_client_sink_stop (GstTCPClientSink * this)
418 if (!GST_OBJECT_FLAG_IS_SET (this, GST_TCP_CLIENT_SINK_OPEN))
421 gst_tcp_socket_close (&this->sock_fd);
423 GST_OBJECT_FLAG_UNSET (this, GST_TCP_CLIENT_SINK_OPEN);
428 static GstStateChangeReturn
429 gst_tcp_client_sink_change_state (GstElement * element,
430 GstStateChange transition)
432 GstTCPClientSink *sink;
433 GstStateChangeReturn res;
435 sink = GST_TCP_CLIENT_SINK (element);
437 switch (transition) {
438 case GST_STATE_CHANGE_NULL_TO_READY:
439 case GST_STATE_CHANGE_READY_TO_PAUSED:
440 if (!gst_tcp_client_sink_start (sink))
446 res = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
448 switch (transition) {
449 case GST_STATE_CHANGE_READY_TO_NULL:
450 gst_tcp_client_sink_stop (sink);
458 return GST_STATE_CHANGE_FAILURE;