wearable/gst/tcp/gsttcpserversrc.c

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  * Copyright (C) <2004> Thomas Vander Stichele <thomas at apestaart dot org>
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  */
  20
  21 /**
  22  * SECTION:element-tcpserversrc
  23  * @see_also: #tcpserversink
  24  *
  25  * <refsect2>
  26  * <title>Example launch line</title>
  27  * |[
  28  * # server:
  29  * gst-launch tcpserversrc protocol=none port=3000 ! fdsink fd=2
  30  * # client:
  31  * gst-launch fdsrc fd=1 ! tcpclientsink protocol=none port=3000
  32  * ]|
  33  * </refsect2>
  34  */
  35
  36 #ifdef HAVE_CONFIG_H
  37 #include "config.h"
  38 #endif
  39
  40 #include <gst/gst-i18n-plugin.h>
  41 #include "gsttcp.h"
  42 #include "gsttcpserversrc.h"
  43 #include <string.h>             /* memset */
  44 #include <unistd.h>
  45 #include <sys/ioctl.h>
  46 #include <fcntl.h>
  47
  48
  49 GST_DEBUG_CATEGORY_STATIC (tcpserversrc_debug);
  50 #define GST_CAT_DEFAULT tcpserversrc_debug
  51
  52 #define TCP_DEFAULT_LISTEN_HOST         NULL    /* listen on all interfaces */
  53 #define TCP_BACKLOG                     1       /* client connection queue */
  54
  55
  56 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
  57     GST_PAD_SRC,
  58     GST_PAD_ALWAYS,
  59     GST_STATIC_CAPS_ANY);
  60
  61
  62 enum
  63 {
  64   PROP_0,
  65   PROP_HOST,
  66   PROP_PORT,
  67   PROP_PROTOCOL
  68 };
  69
  70
  71 GST_BOILERPLATE (GstTCPServerSrc, gst_tcp_server_src, GstPushSrc,
  72     GST_TYPE_PUSH_SRC);
  73
  74
  75 static void gst_tcp_server_src_finalize (GObject * gobject);
  76
  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,
  81     GstBuffer ** buf);
  82
  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);
  87
  88
  89 static void
  90 gst_tcp_server_src_base_init (gpointer g_class)
  91 {
  92   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
  93
  94   gst_element_class_add_static_pad_template (element_class, &srctemplate);
  95
  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>");
 100 }
 101
 102 static void
 103 gst_tcp_server_src_class_init (GstTCPServerSrcClass * klass)
 104 {
 105   GObjectClass *gobject_class;
 106   GstBaseSrcClass *gstbasesrc_class;
 107   GstPushSrcClass *gstpush_src_class;
 108
 109   gobject_class = (GObjectClass *) klass;
 110   gstbasesrc_class = (GstBaseSrcClass *) klass;
 111   gstpush_src_class = (GstPushSrcClass *) klass;
 112
 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;
 116
 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));
 128
 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;
 132
 133   gstpush_src_class->create = gst_tcp_server_src_create;
 134
 135   GST_DEBUG_CATEGORY_INIT (tcpserversrc_debug, "tcpserversrc", 0,
 136       "TCP Server Source");
 137 }
 138
 139 static void
 140 gst_tcp_server_src_init (GstTCPServerSrc * src, GstTCPServerSrcClass * g_class)
 141 {
 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;
 147
 148   GST_OBJECT_FLAG_UNSET (src, GST_TCP_SERVER_SRC_OPEN);
 149 }
 150
 151 static void
 152 gst_tcp_server_src_finalize (GObject * gobject)
 153 {
 154   GstTCPServerSrc *src = GST_TCP_SERVER_SRC (gobject);
 155
 156   g_free (src->host);
 157
 158   G_OBJECT_CLASS (parent_class)->finalize (gobject);
 159 }
 160
 161 static GstFlowReturn
 162 gst_tcp_server_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
 163 {
 164   GstTCPServerSrc *src;
 165   GstFlowReturn ret = GST_FLOW_OK;
 166
 167   src = GST_TCP_SERVER_SRC (psrc);
 168
 169   if (!GST_OBJECT_FLAG_IS_SET (src, GST_TCP_SERVER_SRC_OPEN))
 170     goto wrong_state;
 171
 172 restart:
 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);
 177   } else {
 178     /* else wait on server socket for connections */
 179     gst_poll_fd_ctl_read (src->fdset, &src->server_sock_fd, TRUE);
 180   }
 181
 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;
 186     else
 187       goto select_error;
 188   }
 189
 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)
 197         goto accept_error;
 198
 199       gst_poll_add_fd (src->fdset, &src->client_sock_fd);
 200     }
 201     /* and restart now to poll the socket. */
 202     goto restart;
 203   }
 204
 205   GST_LOG_OBJECT (src, "asked for a buffer");
 206
 207   switch (src->protocol) {
 208     case GST_TCP_PROTOCOL_NONE:
 209       ret = gst_tcp_read_buffer (GST_ELEMENT (src), src->client_sock_fd.fd,
 210           src->fdset, outbuf);
 211       break;
 212
 213     case GST_TCP_PROTOCOL_GDP:
 214       if (!src->caps_received) {
 215         GstCaps *caps;
 216         gchar *string;
 217
 218         ret = gst_tcp_gdp_read_caps (GST_ELEMENT (src), src->client_sock_fd.fd,
 219             src->fdset, &caps);
 220
 221         if (ret == GST_FLOW_WRONG_STATE)
 222           goto gdp_cancelled;
 223
 224         if (ret != GST_FLOW_OK)
 225           goto gdp_caps_read_error;
 226
 227         src->caps_received = TRUE;
 228         string = gst_caps_to_string (caps);
 229         GST_DEBUG_OBJECT (src, "Received caps through GDP: %s", string);
 230         g_free (string);
 231
 232         gst_pad_set_caps (GST_BASE_SRC_PAD (psrc), caps);
 233       }
 234
 235       ret = gst_tcp_gdp_read_buffer (GST_ELEMENT (src), src->client_sock_fd.fd,
 236           src->fdset, outbuf);
 237
 238       if (ret == GST_FLOW_OK)
 239         gst_buffer_set_caps (*outbuf, GST_PAD_CAPS (GST_BASE_SRC_PAD (src)));
 240
 241       break;
 242
 243     default:
 244       /* need to assert as buf == NULL */
 245       g_assert ("Unhandled protocol type");
 246       break;
 247   }
 248
 249   if (ret == GST_FLOW_OK) {
 250     GST_LOG_OBJECT (src,
 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));
 258   }
 259
 260   return ret;
 261
 262 wrong_state:
 263   {
 264     GST_DEBUG_OBJECT (src, "connection to closed, cannot read data");
 265     return GST_FLOW_WRONG_STATE;
 266   }
 267 select_error:
 268   {
 269     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
 270         ("Select error: %s", g_strerror (errno)));
 271     return GST_FLOW_ERROR;
 272   }
 273 select_cancelled:
 274   {
 275     GST_DEBUG_OBJECT (src, "select canceled");
 276     return GST_FLOW_WRONG_STATE;
 277   }
 278 accept_error:
 279   {
 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;
 283   }
 284 gdp_cancelled:
 285   {
 286     GST_DEBUG_OBJECT (src, "reading gdp canceled");
 287     return GST_FLOW_WRONG_STATE;
 288   }
 289 gdp_caps_read_error:
 290   {
 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"));
 295     }
 296     return ret;
 297   }
 298 }
 299
 300 static void
 301 gst_tcp_server_src_set_property (GObject * object, guint prop_id,
 302     const GValue * value, GParamSpec * pspec)
 303 {
 304   GstTCPServerSrc *tcpserversrc = GST_TCP_SERVER_SRC (object);
 305
 306   switch (prop_id) {
 307     case PROP_HOST:
 308       if (!g_value_get_string (value)) {
 309         g_warning ("host property cannot be NULL");
 310         break;
 311       }
 312       g_free (tcpserversrc->host);
 313       tcpserversrc->host = g_strdup (g_value_get_string (value));
 314       break;
 315     case PROP_PORT:
 316       tcpserversrc->server_port = g_value_get_int (value);
 317       break;
 318     case PROP_PROTOCOL:
 319       tcpserversrc->protocol = g_value_get_enum (value);
 320       break;
 321
 322     default:
 323       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 324       break;
 325   }
 326 }
 327
 328 static void
 329 gst_tcp_server_src_get_property (GObject * object, guint prop_id,
 330     GValue * value, GParamSpec * pspec)
 331 {
 332   GstTCPServerSrc *tcpserversrc = GST_TCP_SERVER_SRC (object);
 333
 334   switch (prop_id) {
 335     case PROP_HOST:
 336       g_value_set_string (value, tcpserversrc->host);
 337       break;
 338     case PROP_PORT:
 339       g_value_set_int (value, tcpserversrc->server_port);
 340       break;
 341     case PROP_PROTOCOL:
 342       g_value_set_enum (value, tcpserversrc->protocol);
 343       break;
 344
 345     default:
 346       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 347       break;
 348   }
 349 }
 350
 351 /* set up server */
 352 static gboolean
 353 gst_tcp_server_src_start (GstBaseSrc * bsrc)
 354 {
 355   int ret;
 356   GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
 357
 358   /* reset caps_received flag */
 359   src->caps_received = FALSE;
 360
 361   /* create the server listener socket */
 362   if ((src->server_sock_fd.fd = socket (AF_INET, SOCK_STREAM, 0)) == -1)
 363     goto socket_error;
 364
 365   GST_DEBUG_OBJECT (src, "opened receiving server socket with fd %d",
 366       src->server_sock_fd.fd);
 367
 368   /* make address reusable */
 369   ret = 1;
 370   if (setsockopt (src->server_sock_fd.fd, SOL_SOCKET, SO_REUSEADDR, &ret,
 371           sizeof (int)) < 0)
 372     goto sock_opt;
 373
 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 */
 378   if (src->host) {
 379     gchar *host;
 380
 381     if (!(host = gst_tcp_host_to_ip (GST_ELEMENT (src), src->host)))
 382       goto host_error;
 383     src->server_sin.sin_addr.s_addr = inet_addr (host);
 384     g_free (host);
 385   } else
 386     src->server_sin.sin_addr.s_addr = htonl (INADDR_ANY);
 387
 388   /* bind it */
 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)
 392     goto bind_error;
 393
 394   GST_DEBUG_OBJECT (src, "listening on server socket %d with queue of %d",
 395       src->server_sock_fd.fd, TCP_BACKLOG);
 396
 397   if (listen (src->server_sock_fd.fd, TCP_BACKLOG) == -1)
 398     goto listen_error;
 399
 400   /* create an fdset to keep track of our file descriptors */
 401   if ((src->fdset = gst_poll_new (TRUE)) == NULL)
 402     goto socket_pair;
 403
 404   gst_poll_add_fd (src->fdset, &src->server_sock_fd);
 405
 406   GST_DEBUG_OBJECT (src, "received client");
 407
 408   GST_OBJECT_FLAG_SET (src, GST_TCP_SERVER_SRC_OPEN);
 409
 410   return TRUE;
 411
 412   /* ERRORS */
 413 socket_error:
 414   {
 415     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL), GST_ERROR_SYSTEM);
 416     return FALSE;
 417   }
 418 sock_opt:
 419   {
 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);
 423     return FALSE;
 424   }
 425 host_error:
 426   {
 427     gst_tcp_socket_close (&src->server_sock_fd);
 428     return FALSE;
 429   }
 430 bind_error:
 431   {
 432     gst_tcp_socket_close (&src->server_sock_fd);
 433     switch (errno) {
 434       default:
 435         GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
 436             ("bind failed: %s", g_strerror (errno)));
 437         break;
 438     }
 439     return FALSE;
 440   }
 441 listen_error:
 442   {
 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)));
 446     return FALSE;
 447   }
 448 socket_pair:
 449   {
 450     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
 451         GST_ERROR_SYSTEM);
 452     gst_tcp_socket_close (&src->server_sock_fd);
 453     return FALSE;
 454   }
 455 }
 456
 457 static gboolean
 458 gst_tcp_server_src_stop (GstBaseSrc * bsrc)
 459 {
 460   GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
 461
 462   gst_poll_free (src->fdset);
 463   src->fdset = NULL;
 464
 465   gst_tcp_socket_close (&src->server_sock_fd);
 466   gst_tcp_socket_close (&src->client_sock_fd);
 467
 468   GST_OBJECT_FLAG_UNSET (src, GST_TCP_SERVER_SRC_OPEN);
 469
 470   return TRUE;
 471 }
 472
 473 /* will be called only between calls to start() and stop() */
 474 static gboolean
 475 gst_tcp_server_src_unlock (GstBaseSrc * bsrc)
 476 {
 477   GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
 478
 479   gst_poll_set_flushing (src->fdset, TRUE);
 480
 481   return TRUE;
 482 }