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 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25
  26 #include <gst/gst-i18n-plugin.h>
  27 #include "gsttcp.h"
  28 #include "gsttcpserversrc.h"
  29 #include <string.h>             /* memset */
  30 #include <unistd.h>
  31 #include <sys/ioctl.h>
  32 #include <fcntl.h>
  33
  34
  35 GST_DEBUG_CATEGORY_STATIC (tcpserversrc_debug);
  36 #define GST_CAT_DEFAULT tcpserversrc_debug
  37
  38 #define TCP_DEFAULT_LISTEN_HOST         NULL    /* listen on all interfaces */
  39 #define TCP_BACKLOG                     1       /* client connection queue */
  40
  41
  42 static const GstElementDetails gst_tcp_server_src_details =
  43 GST_ELEMENT_DETAILS ("TCP server source",
  44     "Source/Network",
  45     "Receive data as a server over the network via TCP",
  46     "Thomas Vander Stichele <thomas at apestaart dot org>");
  47
  48 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
  49     GST_PAD_SRC,
  50     GST_PAD_ALWAYS,
  51     GST_STATIC_CAPS_ANY);
  52
  53
  54 enum
  55 {
  56   PROP_0,
  57   PROP_HOST,
  58   PROP_PORT,
  59   PROP_PROTOCOL
  60 };
  61
  62
  63 GST_BOILERPLATE (GstTCPServerSrc, gst_tcp_server_src, GstPushSrc,
  64     GST_TYPE_PUSH_SRC);
  65
  66
  67 static void gst_tcp_server_src_finalize (GObject * gobject);
  68
  69 static gboolean gst_tcp_server_src_start (GstBaseSrc * bsrc);
  70 static gboolean gst_tcp_server_src_stop (GstBaseSrc * bsrc);
  71 static gboolean gst_tcp_server_src_unlock (GstBaseSrc * bsrc);
  72 static GstFlowReturn gst_tcp_server_src_create (GstPushSrc * psrc,
  73     GstBuffer ** buf);
  74
  75 static void gst_tcp_server_src_set_property (GObject * object, guint prop_id,
  76     const GValue * value, GParamSpec * pspec);
  77 static void gst_tcp_server_src_get_property (GObject * object, guint prop_id,
  78     GValue * value, GParamSpec * pspec);
  79
  80
  81 static void
  82 gst_tcp_server_src_base_init (gpointer g_class)
  83 {
  84   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
  85
  86   gst_element_class_add_pad_template (element_class,
  87       gst_static_pad_template_get (&srctemplate));
  88
  89   gst_element_class_set_details (element_class, &gst_tcp_server_src_details);
  90 }
  91
  92 static void
  93 gst_tcp_server_src_class_init (GstTCPServerSrcClass * klass)
  94 {
  95   GObjectClass *gobject_class;
  96   GstBaseSrcClass *gstbasesrc_class;
  97   GstPushSrcClass *gstpush_src_class;
  98
  99   gobject_class = (GObjectClass *) klass;
 100   gstbasesrc_class = (GstBaseSrcClass *) klass;
 101   gstpush_src_class = (GstPushSrcClass *) klass;
 102
 103   gobject_class->set_property = gst_tcp_server_src_set_property;
 104   gobject_class->get_property = gst_tcp_server_src_get_property;
 105   gobject_class->finalize = gst_tcp_server_src_finalize;
 106
 107   g_object_class_install_property (gobject_class, PROP_HOST,
 108       g_param_spec_string ("host", "Host", "The hostname to listen as",
 109           TCP_DEFAULT_LISTEN_HOST, G_PARAM_READWRITE));
 110   g_object_class_install_property (gobject_class, PROP_PORT,
 111       g_param_spec_int ("port", "Port", "The port to listen to",
 112           0, TCP_HIGHEST_PORT, TCP_DEFAULT_PORT, G_PARAM_READWRITE));
 113   g_object_class_install_property (gobject_class, PROP_PROTOCOL,
 114       g_param_spec_enum ("protocol", "Protocol", "The protocol to wrap data in",
 115           GST_TYPE_TCP_PROTOCOL, GST_TCP_PROTOCOL_NONE, G_PARAM_READWRITE));
 116
 117   gstbasesrc_class->start = gst_tcp_server_src_start;
 118   gstbasesrc_class->stop = gst_tcp_server_src_stop;
 119   gstbasesrc_class->unlock = gst_tcp_server_src_unlock;
 120
 121   gstpush_src_class->create = gst_tcp_server_src_create;
 122
 123   GST_DEBUG_CATEGORY_INIT (tcpserversrc_debug, "tcpserversrc", 0,
 124       "TCP Server Source");
 125 }
 126
 127 static void
 128 gst_tcp_server_src_init (GstTCPServerSrc * src, GstTCPServerSrcClass * g_class)
 129 {
 130   src->server_port = TCP_DEFAULT_PORT;
 131   src->host = g_strdup (TCP_DEFAULT_HOST);
 132   src->server_sock_fd.fd = -1;
 133   src->client_sock_fd.fd = -1;
 134   src->protocol = GST_TCP_PROTOCOL_NONE;
 135
 136   GST_OBJECT_FLAG_UNSET (src, GST_TCP_SERVER_SRC_OPEN);
 137 }
 138
 139 static void
 140 gst_tcp_server_src_finalize (GObject * gobject)
 141 {
 142   GstTCPServerSrc *src = GST_TCP_SERVER_SRC (gobject);
 143
 144   g_free (src->host);
 145
 146   G_OBJECT_CLASS (parent_class)->finalize (gobject);
 147 }
 148
 149 static GstFlowReturn
 150 gst_tcp_server_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
 151 {
 152   GstTCPServerSrc *src;
 153   GstFlowReturn ret = GST_FLOW_OK;
 154
 155   src = GST_TCP_SERVER_SRC (psrc);
 156
 157   if (!GST_OBJECT_FLAG_IS_SET (src, GST_TCP_SERVER_SRC_OPEN))
 158     goto wrong_state;
 159
 160 restart:
 161   if (src->client_sock_fd.fd >= 0) {
 162     /* if we have a client, wait for read */
 163     gst_poll_fd_ctl_read (src->fdset, &src->server_sock_fd, FALSE);
 164     gst_poll_fd_ctl_read (src->fdset, &src->client_sock_fd, TRUE);
 165   } else {
 166     /* else wait on server socket for connections */
 167     gst_poll_fd_ctl_read (src->fdset, &src->server_sock_fd, TRUE);
 168   }
 169
 170   /* no action (0) is an error too in our case */
 171   if ((ret = gst_poll_wait (src->fdset, GST_CLOCK_TIME_NONE)) <= 0) {
 172     if (ret == -1 && errno == EBUSY)
 173       goto select_cancelled;
 174     else
 175       goto select_error;
 176   }
 177
 178   /* if we have no client socket we can accept one now */
 179   if (src->client_sock_fd.fd < 0) {
 180     if (gst_poll_fd_can_read (src->fdset, &src->server_sock_fd)) {
 181       if ((src->client_sock_fd.fd =
 182               accept (src->server_sock_fd.fd,
 183                   (struct sockaddr *) &src->client_sin,
 184                   &src->client_sin_len)) == -1)
 185         goto accept_error;
 186
 187       gst_poll_add_fd (src->fdset, &src->client_sock_fd);
 188     }
 189     /* and restart now to poll the socket. */
 190     goto restart;
 191   }
 192
 193   GST_LOG_OBJECT (src, "asked for a buffer");
 194
 195   switch (src->protocol) {
 196     case GST_TCP_PROTOCOL_NONE:
 197       ret = gst_tcp_read_buffer (GST_ELEMENT (src), src->client_sock_fd.fd,
 198           src->fdset, outbuf);
 199       break;
 200
 201     case GST_TCP_PROTOCOL_GDP:
 202       if (!src->caps_received) {
 203         GstCaps *caps;
 204         gchar *string;
 205
 206         ret = gst_tcp_gdp_read_caps (GST_ELEMENT (src), src->client_sock_fd.fd,
 207             src->fdset, &caps);
 208
 209         if (ret == GST_FLOW_WRONG_STATE)
 210           goto gdp_cancelled;
 211
 212         if (ret != GST_FLOW_OK)
 213           goto gdp_caps_read_error;
 214
 215         src->caps_received = TRUE;
 216         string = gst_caps_to_string (caps);
 217         GST_DEBUG_OBJECT (src, "Received caps through GDP: %s", string);
 218         g_free (string);
 219
 220         gst_pad_set_caps (GST_BASE_SRC_PAD (psrc), caps);
 221       }
 222
 223       ret = gst_tcp_gdp_read_buffer (GST_ELEMENT (src), src->client_sock_fd.fd,
 224           src->fdset, outbuf);
 225
 226       if (ret == GST_FLOW_OK)
 227         gst_buffer_set_caps (*outbuf, GST_PAD_CAPS (GST_BASE_SRC_PAD (src)));
 228
 229       break;
 230
 231     default:
 232       /* need to assert as buf == NULL */
 233       g_assert ("Unhandled protocol type");
 234       break;
 235   }
 236
 237   if (ret == GST_FLOW_OK) {
 238     GST_LOG_OBJECT (src,
 239         "Returning buffer from _get of size %d, ts %"
 240         GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT
 241         ", offset %" G_GINT64_FORMAT ", offset_end %" G_GINT64_FORMAT,
 242         GST_BUFFER_SIZE (*outbuf),
 243         GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (*outbuf)),
 244         GST_TIME_ARGS (GST_BUFFER_DURATION (*outbuf)),
 245         GST_BUFFER_OFFSET (*outbuf), GST_BUFFER_OFFSET_END (*outbuf));
 246   }
 247
 248   return ret;
 249
 250 wrong_state:
 251   {
 252     GST_DEBUG_OBJECT (src, "connection to closed, cannot read data");
 253     return GST_FLOW_WRONG_STATE;
 254   }
 255 select_error:
 256   {
 257     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
 258         ("Select error: %s", g_strerror (errno)));
 259     return GST_FLOW_ERROR;
 260   }
 261 select_cancelled:
 262   {
 263     GST_DEBUG_OBJECT (src, "select canceled");
 264     return GST_FLOW_WRONG_STATE;
 265   }
 266 accept_error:
 267   {
 268     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
 269         ("Could not accept client on server socket: %s", g_strerror (errno)));
 270     return GST_FLOW_ERROR;
 271   }
 272 gdp_cancelled:
 273   {
 274     GST_DEBUG_OBJECT (src, "reading gdp canceled");
 275     return GST_FLOW_WRONG_STATE;
 276   }
 277 gdp_caps_read_error:
 278   {
 279     /* if we did not get canceled, report an error */
 280     if (ret != GST_FLOW_WRONG_STATE) {
 281       GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
 282           ("Could not read caps through GDP"));
 283     }
 284     return ret;
 285   }
 286 }
 287
 288 static void
 289 gst_tcp_server_src_set_property (GObject * object, guint prop_id,
 290     const GValue * value, GParamSpec * pspec)
 291 {
 292   GstTCPServerSrc *tcpserversrc = GST_TCP_SERVER_SRC (object);
 293
 294   switch (prop_id) {
 295     case PROP_HOST:
 296       if (!g_value_get_string (value)) {
 297         g_warning ("host property cannot be NULL");
 298         break;
 299       }
 300       g_free (tcpserversrc->host);
 301       tcpserversrc->host = g_strdup (g_value_get_string (value));
 302       break;
 303     case PROP_PORT:
 304       tcpserversrc->server_port = g_value_get_int (value);
 305       break;
 306     case PROP_PROTOCOL:
 307       tcpserversrc->protocol = g_value_get_enum (value);
 308       break;
 309
 310     default:
 311       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 312       break;
 313   }
 314 }
 315
 316 static void
 317 gst_tcp_server_src_get_property (GObject * object, guint prop_id,
 318     GValue * value, GParamSpec * pspec)
 319 {
 320   GstTCPServerSrc *tcpserversrc = GST_TCP_SERVER_SRC (object);
 321
 322   switch (prop_id) {
 323     case PROP_HOST:
 324       g_value_set_string (value, tcpserversrc->host);
 325       break;
 326     case PROP_PORT:
 327       g_value_set_int (value, tcpserversrc->server_port);
 328       break;
 329     case PROP_PROTOCOL:
 330       g_value_set_enum (value, tcpserversrc->protocol);
 331       break;
 332
 333     default:
 334       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 335       break;
 336   }
 337 }
 338
 339 /* set up server */
 340 static gboolean
 341 gst_tcp_server_src_start (GstBaseSrc * bsrc)
 342 {
 343   int ret;
 344   GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
 345
 346   /* reset caps_received flag */
 347   src->caps_received = FALSE;
 348
 349   /* create the server listener socket */
 350   if ((src->server_sock_fd.fd = socket (AF_INET, SOCK_STREAM, 0)) == -1)
 351     goto socket_error;
 352
 353   GST_DEBUG_OBJECT (src, "opened receiving server socket with fd %d",
 354       src->server_sock_fd.fd);
 355
 356   /* make address reusable */
 357   ret = 1;
 358   if (setsockopt (src->server_sock_fd.fd, SOL_SOCKET, SO_REUSEADDR, &ret,
 359           sizeof (int)) < 0)
 360     goto sock_opt;
 361
 362   /* name the socket */
 363   memset (&src->server_sin, 0, sizeof (src->server_sin));
 364   src->server_sin.sin_family = AF_INET; /* network socket */
 365   src->server_sin.sin_port = htons (src->server_port);  /* on port */
 366   if (src->host) {
 367     gchar *host;
 368
 369     if (!(host = gst_tcp_host_to_ip (GST_ELEMENT (src), src->host)))
 370       goto host_error;
 371     src->server_sin.sin_addr.s_addr = inet_addr (host);
 372     g_free (host);
 373   } else
 374     src->server_sin.sin_addr.s_addr = htonl (INADDR_ANY);
 375
 376   /* bind it */
 377   GST_DEBUG_OBJECT (src, "binding server socket to address");
 378   if ((ret = bind (src->server_sock_fd.fd, (struct sockaddr *) &src->server_sin,
 379               sizeof (src->server_sin))) < 0)
 380     goto bind_error;
 381
 382   GST_DEBUG_OBJECT (src, "listening on server socket %d with queue of %d",
 383       src->server_sock_fd.fd, TCP_BACKLOG);
 384
 385   if (listen (src->server_sock_fd.fd, TCP_BACKLOG) == -1)
 386     goto listen_error;
 387
 388   /* create an fdset to keep track of our file descriptors */
 389   if ((src->fdset = gst_poll_new (GST_POLL_MODE_AUTO, TRUE)) == NULL)
 390     goto socket_pair;
 391
 392   gst_poll_add_fd (src->fdset, &src->server_sock_fd);
 393
 394   GST_DEBUG_OBJECT (src, "received client");
 395
 396   GST_OBJECT_FLAG_SET (src, GST_TCP_SERVER_SRC_OPEN);
 397
 398   return TRUE;
 399
 400   /* ERRORS */
 401 socket_error:
 402   {
 403     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL), GST_ERROR_SYSTEM);
 404     return FALSE;
 405   }
 406 sock_opt:
 407   {
 408     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
 409         ("Could not setsockopt: %s", g_strerror (errno)));
 410     gst_tcp_socket_close (&src->server_sock_fd);
 411     return FALSE;
 412   }
 413 host_error:
 414   {
 415     gst_tcp_socket_close (&src->server_sock_fd);
 416     return FALSE;
 417   }
 418 bind_error:
 419   {
 420     gst_tcp_socket_close (&src->server_sock_fd);
 421     switch (errno) {
 422       default:
 423         GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
 424             ("bind failed: %s", g_strerror (errno)));
 425         break;
 426     }
 427     return FALSE;
 428   }
 429 listen_error:
 430   {
 431     gst_tcp_socket_close (&src->server_sock_fd);
 432     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (NULL),
 433         ("Could not listen on server socket: %s", g_strerror (errno)));
 434     return FALSE;
 435   }
 436 socket_pair:
 437   {
 438     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
 439         GST_ERROR_SYSTEM);
 440     gst_tcp_socket_close (&src->server_sock_fd);
 441     return FALSE;
 442   }
 443 }
 444
 445 static gboolean
 446 gst_tcp_server_src_stop (GstBaseSrc * bsrc)
 447 {
 448   GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
 449
 450   gst_poll_free (src->fdset);
 451   src->fdset = NULL;
 452
 453   gst_tcp_socket_close (&src->server_sock_fd);
 454   gst_tcp_socket_close (&src->client_sock_fd);
 455
 456   GST_OBJECT_FLAG_UNSET (src, GST_TCP_SERVER_SRC_OPEN);
 457
 458   return TRUE;
 459 }
 460
 461 /* will be called only between calls to start() and stop() */
 462 static gboolean
 463 gst_tcp_server_src_unlock (GstBaseSrc * bsrc)
 464 {
 465   GstTCPServerSrc *src = GST_TCP_SERVER_SRC (bsrc);
 466
 467   gst_poll_set_flushing (src->fdset, TRUE);
 468
 469   return TRUE;
 470 }