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