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