gst/rtsp-server/rtsp-server.c

   1 /* GStreamer
   2  * Copyright (C) 2008 Wim Taymans <wim.taymans at gmail.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include <sys/ioctl.h>
  21
  22 #include "rtsp-server.h"
  23 #include "rtsp-client.h"
  24
  25 #define DEFAULT_BACKLOG         5
  26 #define DEFAULT_PORT            8554
  27
  28 enum
  29 {
  30   PROP_0,
  31   PROP_BACKLOG,
  32   PROP_PORT,
  33   PROP_SESSION_POOL,
  34   PROP_MEDIA_MAPPING,
  35   PROP_LAST
  36 };
  37
  38 G_DEFINE_TYPE (GstRTSPServer, gst_rtsp_server, G_TYPE_OBJECT);
  39
  40 static void gst_rtsp_server_get_property (GObject *object, guint propid,
  41     GValue *value, GParamSpec *pspec);
  42 static void gst_rtsp_server_set_property (GObject *object, guint propid,
  43     const GValue *value, GParamSpec *pspec);
  44
  45 static GstRTSPClient * default_accept_client (GstRTSPServer *server,
  46     GIOChannel *channel);
  47
  48 static void
  49 gst_rtsp_server_class_init (GstRTSPServerClass * klass)
  50 {
  51   GObjectClass *gobject_class;
  52
  53   gobject_class = G_OBJECT_CLASS (klass);
  54
  55   gobject_class->get_property = gst_rtsp_server_get_property;
  56   gobject_class->set_property = gst_rtsp_server_set_property;
  57
  58   /**
  59    * GstRTSPServer::backlog
  60    *
  61    * The backlog argument defines the maximum length to which the queue of
  62    * pending connections for the server may grow. If a connection request arrives
  63    * when the queue is full, the client may receive an error with an indication of
  64    * ECONNREFUSED or, if the underlying protocol supports retransmission, the
  65    * request may be ignored so that a later reattempt at  connection succeeds.
  66    */
  67   g_object_class_install_property (gobject_class, PROP_BACKLOG,
  68       g_param_spec_int ("backlog", "Backlog", "The maximum length to which the queue "
  69               "of pending connections may grow",
  70           0, G_MAXINT, DEFAULT_BACKLOG, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
  71   /**
  72    * GstRTSPServer::port
  73    *
  74    * The session port of the server. This is the port where the server will
  75    * listen on.
  76    */
  77   g_object_class_install_property (gobject_class, PROP_PORT,
  78       g_param_spec_int ("port", "Port", "The port the server uses to listen on",
  79           1, 65535, DEFAULT_PORT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
  80   /**
  81    * GstRTSPServer::session-pool
  82    *
  83    * The session pool of the server. By default each server has a separate
  84    * session pool but sessions can be shared between servers by setting the same
  85    * session pool on multiple servers.
  86    */
  87   g_object_class_install_property (gobject_class, PROP_SESSION_POOL,
  88       g_param_spec_object ("session-pool", "Session Pool",
  89           "The session pool to use for client session",
  90           GST_TYPE_RTSP_SESSION_POOL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
  91   /**
  92    * GstRTSPServer::media-mapping
  93    *
  94    * The media mapping to use for this server. By default the server has no
  95    * media mapping and thus cannot map urls to media streams.
  96    */
  97   g_object_class_install_property (gobject_class, PROP_MEDIA_MAPPING,
  98       g_param_spec_object ("media-mapping", "Media Mapping",
  99           "The media mapping to use for client session",
 100           GST_TYPE_RTSP_MEDIA_MAPPING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 101
 102   klass->accept_client = default_accept_client;
 103 }
 104
 105 static void
 106 gst_rtsp_server_init (GstRTSPServer * server)
 107 {
 108   server->server_port = DEFAULT_PORT;
 109   server->backlog = DEFAULT_BACKLOG;
 110   server->session_pool = gst_rtsp_session_pool_new ();
 111   server->media_mapping = gst_rtsp_media_mapping_new ();
 112 }
 113
 114 /**
 115  * gst_rtsp_server_new:
 116  *
 117  * Create a new #GstRTSPServer instance.
 118  */
 119 GstRTSPServer *
 120 gst_rtsp_server_new (void)
 121 {
 122   GstRTSPServer *result;
 123
 124   result = g_object_new (GST_TYPE_RTSP_SERVER, NULL);
 125
 126   return result;
 127 }
 128
 129 /**
 130  * gst_rtsp_server_set_port:
 131  * @server: a #GstRTSPServer
 132  * @port: the port
 133  *
 134  * Configure @server to accept connections on the given port.
 135  * @port should be a port number between 1 and 65535.
 136  *
 137  * This function must be called before the server is bound.
 138  */
 139 void
 140 gst_rtsp_server_set_port (GstRTSPServer *server, gint port)
 141 {
 142   g_return_if_fail (GST_IS_RTSP_SERVER (server));
 143   g_return_if_fail (port >= 1 && port <= 65535);
 144
 145   server->server_port = port;
 146 }
 147
 148 /**
 149  * gst_rtsp_server_get_port:
 150  * @server: a #GstRTSPServer
 151  *
 152  * Get the port number on which the server will accept connections.
 153  *
 154  * Returns: the server port.
 155  */
 156 gint
 157 gst_rtsp_server_get_port (GstRTSPServer *server)
 158 {
 159   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), -1);
 160
 161   return server->server_port;
 162 }
 163
 164 /**
 165  * gst_rtsp_server_set_backlog:
 166  * @server: a #GstRTSPServer
 167  * @backlog: the backlog
 168  *
 169  * configure the maximum amount of requests that may be queued for the
 170  * server.
 171  *
 172  * This function must be called before the server is bound.
 173  */
 174 void
 175 gst_rtsp_server_set_backlog (GstRTSPServer *server, gint backlog)
 176 {
 177   g_return_if_fail (GST_IS_RTSP_SERVER (server));
 178
 179   server->backlog = backlog;
 180 }
 181
 182 /**
 183  * gst_rtsp_server_get_backlog:
 184  * @server: a #GstRTSPServer
 185  *
 186  * The maximum amount of queued requests for the server.
 187  *
 188  * Returns: the server backlog.
 189  */
 190 gint
 191 gst_rtsp_server_get_backlog (GstRTSPServer *server)
 192 {
 193   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), -1);
 194
 195   return server->backlog;
 196 }
 197
 198 /**
 199  * gst_rtsp_server_set_session_pool:
 200  * @server: a #GstRTSPServer
 201  * @pool: a #GstRTSPSessionPool
 202  *
 203  * configure @pool to be used as the session pool of @server.
 204  */
 205 void
 206 gst_rtsp_server_set_session_pool (GstRTSPServer *server, GstRTSPSessionPool *pool)
 207 {
 208   GstRTSPSessionPool *old;
 209
 210   g_return_if_fail (GST_IS_RTSP_SERVER (server));
 211
 212   old = server->session_pool;
 213
 214   if (old != pool) {
 215     if (pool)
 216       g_object_ref (pool);
 217     server->session_pool = pool;
 218     if (old)
 219       g_object_unref (old);
 220   }
 221 }
 222
 223
 224 /**
 225  * gst_rtsp_server_get_session_pool:
 226  * @server: a #GstRTSPServer
 227  *
 228  * Get the #GstRTSPSessionPool used as the session pool of @server.
 229  *
 230  * Returns: the #GstRTSPSessionPool used for sessions. g_object_unref() after
 231  * usage.
 232  */
 233 GstRTSPSessionPool *
 234 gst_rtsp_server_get_session_pool (GstRTSPServer *server)
 235 {
 236   GstRTSPSessionPool *result;
 237
 238   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
 239
 240   if ((result = server->session_pool))
 241     g_object_ref (result);
 242
 243   return result;
 244 }
 245
 246 /**
 247  * gst_rtsp_server_set_media_mapping:
 248  * @server: a #GstRTSPServer
 249  * @mapping: a #GstRTSPMediaMapping
 250  *
 251  * configure @mapping to be used as the media mapping of @server.
 252  */
 253 void
 254 gst_rtsp_server_set_media_mapping (GstRTSPServer *server, GstRTSPMediaMapping *mapping)
 255 {
 256   GstRTSPMediaMapping *old;
 257
 258   g_return_if_fail (GST_IS_RTSP_SERVER (server));
 259
 260   old = server->media_mapping;
 261
 262   if (old != mapping) {
 263     if (mapping)
 264       g_object_ref (mapping);
 265     server->media_mapping = mapping;
 266     if (old)
 267       g_object_unref (old);
 268   }
 269 }
 270
 271
 272 /**
 273  * gst_rtsp_server_get_media_mapping:
 274  * @server: a #GstRTSPServer
 275  *
 276  * Get the #GstRTSPMediaMapping used as the media mapping of @server.
 277  *
 278  * Returns: the #GstRTSPMediaMapping of @server. g_object_unref() after
 279  * usage.
 280  */
 281 GstRTSPMediaMapping *
 282 gst_rtsp_server_get_media_mapping (GstRTSPServer *server)
 283 {
 284   GstRTSPMediaMapping *result;
 285
 286   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
 287
 288   if ((result = server->media_mapping))
 289     g_object_ref (result);
 290
 291   return result;
 292 }
 293
 294 static void
 295 gst_rtsp_server_get_property (GObject *object, guint propid,
 296     GValue *value, GParamSpec *pspec)
 297 {
 298   GstRTSPServer *server = GST_RTSP_SERVER (object);
 299
 300   switch (propid) {
 301     case PROP_PORT:
 302       g_value_set_int (value, gst_rtsp_server_get_port (server));
 303       break;
 304     case PROP_BACKLOG:
 305       g_value_set_int (value, gst_rtsp_server_get_backlog (server));
 306       break;
 307     case PROP_SESSION_POOL:
 308       g_value_take_object (value, gst_rtsp_server_get_session_pool (server));
 309       break;
 310     case PROP_MEDIA_MAPPING:
 311       g_value_take_object (value, gst_rtsp_server_get_media_mapping (server));
 312       break;
 313     default:
 314       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, propid, pspec);
 315   }
 316 }
 317
 318 static void
 319 gst_rtsp_server_set_property (GObject *object, guint propid,
 320     const GValue *value, GParamSpec *pspec)
 321 {
 322   GstRTSPServer *server = GST_RTSP_SERVER (object);
 323
 324   switch (propid) {
 325     case PROP_PORT:
 326       gst_rtsp_server_set_port (server, g_value_get_int (value));
 327       break;
 328     case PROP_BACKLOG:
 329       gst_rtsp_server_set_backlog (server, g_value_get_int (value));
 330       break;
 331     case PROP_SESSION_POOL:
 332       gst_rtsp_server_set_session_pool (server, g_value_get_object (value));
 333       break;
 334     case PROP_MEDIA_MAPPING:
 335       gst_rtsp_server_set_media_mapping (server, g_value_get_object (value));
 336       break;
 337     default:
 338       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, propid, pspec);
 339   }
 340 }
 341
 342 /* Prepare a server socket for @server and make it listen on the configured port */
 343 static gboolean
 344 gst_rtsp_server_sink_init_send (GstRTSPServer * server)
 345 {
 346   int ret;
 347
 348   /* create server socket */
 349   if ((server->server_sock.fd = socket (AF_INET, SOCK_STREAM, 0)) == -1)
 350     goto no_socket;
 351
 352   GST_DEBUG_OBJECT (server, "opened sending server socket with fd %d",
 353       server->server_sock.fd);
 354
 355   /* make address reusable */
 356   ret = 1;
 357   if (setsockopt (server->server_sock.fd, SOL_SOCKET, SO_REUSEADDR,
 358           (void *) &ret, sizeof (ret)) < 0)
 359     goto reuse_failed;
 360
 361   /* keep connection alive; avoids SIGPIPE during write */
 362   ret = 1;
 363   if (setsockopt (server->server_sock.fd, SOL_SOCKET, SO_KEEPALIVE,
 364           (void *) &ret, sizeof (ret)) < 0)
 365     goto keepalive_failed;
 366
 367   /* name the socket */
 368   memset (&server->server_sin, 0, sizeof (server->server_sin));
 369   server->server_sin.sin_family = AF_INET;        /* network socket */
 370   server->server_sin.sin_port = htons (server->server_port);        /* on port */
 371   server->server_sin.sin_addr.s_addr = htonl (INADDR_ANY);        /* for hosts */
 372
 373   /* bind it */
 374   GST_DEBUG_OBJECT (server, "binding server socket to address");
 375   ret = bind (server->server_sock.fd, (struct sockaddr *) &server->server_sin,
 376       sizeof (server->server_sin));
 377   if (ret)
 378     goto bind_failed;
 379
 380   /* set the server socket to nonblocking */
 381   fcntl (server->server_sock.fd, F_SETFL, O_NONBLOCK);
 382
 383   GST_DEBUG_OBJECT (server, "listening on server socket %d with queue of %d",
 384       server->server_sock.fd, server->backlog);
 385   if (listen (server->server_sock.fd, server->backlog) == -1)
 386     goto listen_failed;
 387
 388   GST_DEBUG_OBJECT (server,
 389       "listened on server socket %d, returning from connection setup",
 390       server->server_sock.fd);
 391
 392   return TRUE;
 393
 394   /* ERRORS */
 395 no_socket:
 396   {
 397     GST_ERROR_OBJECT (server, "failed to create socket: %s", g_strerror (errno));
 398     return FALSE;
 399   }
 400 reuse_failed:
 401   {
 402     if (server->server_sock.fd >= 0) {
 403       close (server->server_sock.fd);
 404       server->server_sock.fd = -1;
 405     }
 406     GST_ERROR_OBJECT (server, "failed to reuse socket: %s", g_strerror (errno));
 407     return FALSE;
 408   }
 409 keepalive_failed:
 410   {
 411     if (server->server_sock.fd >= 0) {
 412       close (server->server_sock.fd);
 413       server->server_sock.fd = -1;
 414     }
 415     GST_ERROR_OBJECT (server, "failed to configure keepalive socket: %s", g_strerror (errno));
 416     return FALSE;
 417   }
 418 listen_failed:
 419   {
 420     if (server->server_sock.fd >= 0) {
 421       close (server->server_sock.fd);
 422       server->server_sock.fd = -1;
 423     }
 424     GST_ERROR_OBJECT (server, "failed to listen on socket: %s", g_strerror (errno));
 425     return FALSE;
 426   }
 427 bind_failed:
 428   {
 429     if (server->server_sock.fd >= 0) {
 430       close (server->server_sock.fd);
 431       server->server_sock.fd = -1;
 432     }
 433     GST_ERROR_OBJECT (server, "failed to bind on socket: %s", g_strerror (errno));
 434     return FALSE;
 435   }
 436 }
 437
 438 /* default method for creating a new client object in the server to accept and
 439  * handle a client connection on this server */
 440 static GstRTSPClient *
 441 default_accept_client (GstRTSPServer *server, GIOChannel *channel)
 442 {
 443   GstRTSPClient *client;
 444
 445   /* a new client connected, create a session to handle the client. */
 446   client = gst_rtsp_client_new ();
 447
 448   /* set the session pool that this client should use */
 449   gst_rtsp_client_set_session_pool (client, server->session_pool);
 450
 451   /* set the session pool that this client should use */
 452   gst_rtsp_client_set_media_mapping (client, server->media_mapping);
 453
 454   /* accept connections for that client, this function returns after accepting
 455    * the connection and will run the remainder of the communication with the
 456    * client asyncronously. */
 457   if (!gst_rtsp_client_accept (client, channel))
 458     goto accept_failed;
 459
 460   return client;
 461
 462   /* ERRORS */
 463 accept_failed:
 464   {
 465     g_error ("Could not accept client on server socket %d: %s (%d)",
 466             server->server_sock.fd, g_strerror (errno), errno);
 467     gst_object_unref (client);
 468     return NULL;
 469   }
 470 }
 471
 472 /**
 473  * gst_rtsp_server_io_func:
 474  * @channel: a #GIOChannel
 475  * @condition: the condition on @source
 476  *
 477  * A default #GIOFunc that creates a new #GstRTSPClient to accept and handle a
 478  * new connection on @channel or @server.
 479  *
 480  * Returns: TRUE if the source could be connected, FALSE if an error occured.
 481  */
 482 gboolean
 483 gst_rtsp_server_io_func (GIOChannel *channel, GIOCondition condition, GstRTSPServer *server)
 484 {
 485   GstRTSPClient *client = NULL;
 486   GstRTSPServerClass *klass;
 487
 488   if (condition & G_IO_IN) {
 489     klass = GST_RTSP_SERVER_GET_CLASS (server);
 490
 491     /* a new client connected, create a client object to handle the client. */
 492     if (klass->accept_client)
 493       client = klass->accept_client (server, channel);
 494     if (client == NULL)
 495       goto client_failed;
 496
 497     /* can unref the client now, when the request is finished, it will be
 498      * unreffed async. */
 499     gst_object_unref (client);
 500   }
 501   else {
 502     g_print ("received unknown event %08x", condition);
 503   }
 504   return TRUE;
 505
 506   /* ERRORS */
 507 client_failed:
 508   {
 509     GST_ERROR_OBJECT (server, "failed to create a client");
 510     return FALSE;
 511   }
 512 }
 513
 514 /**
 515  * gst_rtsp_server_get_io_channel:
 516  * @server: a #GstRTSPServer
 517  *
 518  * Create a #GIOChannel for @server.
 519  *
 520  * Returns: the GIOChannel for @server or NULL when an error occured.
 521  */
 522 GIOChannel *
 523 gst_rtsp_server_get_io_channel (GstRTSPServer *server)
 524 {
 525   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
 526
 527   if (server->io_channel == NULL) {
 528     if (!gst_rtsp_server_sink_init_send (server))
 529       goto init_failed;
 530
 531     /* create IO channel for the socket */
 532     server->io_channel = g_io_channel_unix_new (server->server_sock.fd);
 533   }
 534   return server->io_channel;
 535
 536 init_failed:
 537   {
 538     return NULL;
 539   }
 540 }
 541
 542 /**
 543  * gst_rtsp_server_create_watch:
 544  * @server: a #GstRTSPServer
 545  *
 546  * Create a #GSource for @server. The new source will have a default
 547  * #GIOFunc of gst_rtsp_server_io_func().
 548  *
 549  * Returns: the #GSource for @server or NULL when an error occured.
 550  */
 551 GSource *
 552 gst_rtsp_server_create_watch (GstRTSPServer *server)
 553 {
 554   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
 555
 556   if (server->io_watch == NULL) {
 557     GIOChannel *channel;
 558
 559     channel = gst_rtsp_server_get_io_channel (server);
 560     if (channel == NULL)
 561       goto no_channel;
 562
 563     /* create a watch for reads (new connections) and possible errors */
 564     server->io_watch = g_io_create_watch (channel, G_IO_IN |
 565                   G_IO_ERR | G_IO_HUP | G_IO_NVAL);
 566
 567     /* configure the callback */
 568     g_source_set_callback (server->io_watch, (GSourceFunc) gst_rtsp_server_io_func, server, NULL);
 569   }
 570   return server->io_watch;
 571
 572 no_channel:
 573   {
 574     return NULL;
 575   }
 576 }
 577
 578 /**
 579  * gst_rtsp_server_attach:
 580  * @server: a #GstRTSPServer
 581  * @context: a #GMainContext
 582  *
 583  * Attaches @server to @context. When the mainloop for @context is run, the
 584  * server will be dispatched.
 585  *
 586  * This function should be called when the server properties and urls are fully
 587  * configured and the server is ready to start.
 588  *
 589  * Returns: the ID (greater than 0) for the source within the GMainContext.
 590  */
 591 guint
 592 gst_rtsp_server_attach (GstRTSPServer *server, GMainContext *context)
 593 {
 594   guint res;
 595   GSource *source;
 596
 597   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), 0);
 598
 599   source = gst_rtsp_server_create_watch (server);
 600   if (source == NULL)
 601     goto no_source;
 602
 603   res = g_source_attach (source, context);
 604
 605   return res;
 606
 607   /* ERRORS */
 608 no_source:
 609   {
 610     return 0;
 611   }
 612 }