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