2 * Copyright (C) 2008 Wim Taymans <wim.taymans at gmail.com>
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.
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.
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.
20 #include <sys/ioctl.h>
22 #include "rtsp-server.h"
23 #include "rtsp-client.h"
25 #define DEFAULT_BACKLOG 5
26 #define DEFAULT_PORT 1554
38 G_DEFINE_TYPE (GstRTSPServer, gst_rtsp_server, G_TYPE_OBJECT);
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);
45 static GstRTSPClient * gst_rtsp_server_accept_client (GstRTSPServer *server,
49 gst_rtsp_server_class_init (GstRTSPServerClass * klass)
51 GObjectClass *gobject_class;
53 gobject_class = G_OBJECT_CLASS (klass);
55 gobject_class->get_property = gst_rtsp_server_get_property;
56 gobject_class->set_property = gst_rtsp_server_set_property;
59 * GstRTSPServer::backlog
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.
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));
74 * The session port of the server. This is the port where the server will
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));
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.
87 g_object_class_install_property (gobject_class, PROP_POOL,
88 g_param_spec_object ("pool", "Pool", "The session pool to use for client session",
89 GST_TYPE_RTSP_SESSION_POOL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
91 * GstRTSPServer::mapping
93 * The media mapping to use for this server. By default the server has no
94 * media mapping and thus cannot map urls to media streams.
96 g_object_class_install_property (gobject_class, PROP_MAPPING,
97 g_param_spec_object ("mapping", "Mapping", "The media mapping to use for client session",
98 GST_TYPE_RTSP_MEDIA_MAPPING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
100 klass->accept_client = gst_rtsp_server_accept_client;
104 gst_rtsp_server_init (GstRTSPServer * server)
106 server->server_port = DEFAULT_PORT;
107 server->backlog = DEFAULT_BACKLOG;
108 server->pool = gst_rtsp_session_pool_new ();
109 server->mapping = gst_rtsp_media_mapping_new ();
113 * gst_rtsp_server_new:
115 * Create a new #GstRTSPServer instance.
118 gst_rtsp_server_new (void)
120 GstRTSPServer *result;
122 result = g_object_new (GST_TYPE_RTSP_SERVER, NULL);
128 * gst_rtsp_server_set_port:
129 * @server: a #GstRTSPServer
132 * Configure @server to accept connections on the given port.
133 * @port should be a port number between 1 and 65535.
135 * This function must be called before the server is bound.
138 gst_rtsp_server_set_port (GstRTSPServer *server, gint port)
140 g_return_if_fail (GST_IS_RTSP_SERVER (server));
141 g_return_if_fail (port >= 1 && port <= 65535);
143 server->server_port = port;
147 * gst_rtsp_server_get_port:
148 * @server: a #GstRTSPServer
150 * Get the port number on which the server will accept connections.
152 * Returns: the server port.
155 gst_rtsp_server_get_port (GstRTSPServer *server)
157 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), -1);
159 return server->server_port;
163 * gst_rtsp_server_set_backlog:
164 * @server: a #GstRTSPServer
165 * @backlog: the backlog
167 * configure the maximum amount of requests that may be queued for the
170 * This function must be called before the server is bound.
173 gst_rtsp_server_set_backlog (GstRTSPServer *server, gint backlog)
175 g_return_if_fail (GST_IS_RTSP_SERVER (server));
177 server->backlog = backlog;
181 * gst_rtsp_server_get_backlog:
182 * @server: a #GstRTSPServer
184 * The maximum amount of queued requests for the server.
186 * Returns: the server backlog.
189 gst_rtsp_server_get_backlog (GstRTSPServer *server)
191 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), -1);
193 return server->backlog;
197 * gst_rtsp_server_set_session_pool:
198 * @server: a #GstRTSPServer
199 * @pool: a #GstRTSPSessionPool
201 * configure @pool to be used as the session pool of @server.
204 gst_rtsp_server_set_session_pool (GstRTSPServer *server, GstRTSPSessionPool *pool)
206 GstRTSPSessionPool *old;
208 g_return_if_fail (GST_IS_RTSP_SERVER (server));
217 g_object_unref (old);
223 * gst_rtsp_server_get_session_pool:
224 * @server: a #GstRTSPServer
226 * Get the #GstRTSPSessionPool used as the session pool of @server.
228 * Returns: the #GstRTSPSessionPool used for sessions. g_object_unref() after
232 gst_rtsp_server_get_session_pool (GstRTSPServer *server)
234 GstRTSPSessionPool *result;
236 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
238 if ((result = server->pool))
239 g_object_ref (result);
245 * gst_rtsp_server_set_media_mapping:
246 * @server: a #GstRTSPServer
247 * @mapping: a #GstRTSPMediaMapping
249 * configure @mapping to be used as the media mapping of @server.
252 gst_rtsp_server_set_media_mapping (GstRTSPServer *server, GstRTSPMediaMapping *mapping)
254 GstRTSPMediaMapping *old;
256 g_return_if_fail (GST_IS_RTSP_SERVER (server));
258 old = server->mapping;
260 if (old != mapping) {
262 g_object_ref (mapping);
263 server->mapping = mapping;
265 g_object_unref (old);
271 * gst_rtsp_server_get_media_mapping:
272 * @server: a #GstRTSPServer
274 * Get the #GstRTSPMediaMapping used as the media mapping of @server.
276 * Returns: the #GstRTSPMediaMapping of @server. g_object_unref() after
279 GstRTSPMediaMapping *
280 gst_rtsp_server_get_media_mapping (GstRTSPServer *server)
282 GstRTSPMediaMapping *result;
284 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
286 if ((result = server->mapping))
287 g_object_ref (result);
293 gst_rtsp_server_get_property (GObject *object, guint propid,
294 GValue *value, GParamSpec *pspec)
296 GstRTSPServer *server = GST_RTSP_SERVER (object);
300 g_value_set_int (value, gst_rtsp_server_get_port (server));
303 g_value_set_int (value, gst_rtsp_server_get_backlog (server));
306 g_value_take_object (value, gst_rtsp_server_get_session_pool (server));
309 g_value_take_object (value, gst_rtsp_server_get_media_mapping (server));
312 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, propid, pspec);
317 gst_rtsp_server_set_property (GObject *object, guint propid,
318 const GValue *value, GParamSpec *pspec)
320 GstRTSPServer *server = GST_RTSP_SERVER (object);
324 gst_rtsp_server_set_port (server, g_value_get_int (value));
327 gst_rtsp_server_set_backlog (server, g_value_get_int (value));
330 gst_rtsp_server_set_session_pool (server, g_value_get_object (value));
333 gst_rtsp_server_set_media_mapping (server, g_value_get_object (value));
336 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, propid, pspec);
340 /* Prepare a server socket for @server and make it listen on the configured port */
342 gst_rtsp_server_sink_init_send (GstRTSPServer * server)
346 /* create server socket */
347 if ((server->server_sock.fd = socket (AF_INET, SOCK_STREAM, 0)) == -1)
350 GST_DEBUG_OBJECT (server, "opened sending server socket with fd %d",
351 server->server_sock.fd);
353 /* make address reusable */
355 if (setsockopt (server->server_sock.fd, SOL_SOCKET, SO_REUSEADDR,
356 (void *) &ret, sizeof (ret)) < 0)
359 /* keep connection alive; avoids SIGPIPE during write */
361 if (setsockopt (server->server_sock.fd, SOL_SOCKET, SO_KEEPALIVE,
362 (void *) &ret, sizeof (ret)) < 0)
363 goto keepalive_failed;
365 /* name the socket */
366 memset (&server->server_sin, 0, sizeof (server->server_sin));
367 server->server_sin.sin_family = AF_INET; /* network socket */
368 server->server_sin.sin_port = htons (server->server_port); /* on port */
369 server->server_sin.sin_addr.s_addr = htonl (INADDR_ANY); /* for hosts */
372 GST_DEBUG_OBJECT (server, "binding server socket to address");
373 ret = bind (server->server_sock.fd, (struct sockaddr *) &server->server_sin,
374 sizeof (server->server_sin));
378 /* set the server socket to nonblocking */
379 fcntl (server->server_sock.fd, F_SETFL, O_NONBLOCK);
381 GST_DEBUG_OBJECT (server, "listening on server socket %d with queue of %d",
382 server->server_sock.fd, server->backlog);
383 if (listen (server->server_sock.fd, server->backlog) == -1)
386 GST_DEBUG_OBJECT (server,
387 "listened on server socket %d, returning from connection setup",
388 server->server_sock.fd);
395 GST_ERROR_OBJECT (server, "failed to create socket: %s", g_strerror (errno));
400 if (server->server_sock.fd >= 0) {
401 close (server->server_sock.fd);
402 server->server_sock.fd = -1;
404 GST_ERROR_OBJECT (server, "failed to reuse socket: %s", g_strerror (errno));
409 if (server->server_sock.fd >= 0) {
410 close (server->server_sock.fd);
411 server->server_sock.fd = -1;
413 GST_ERROR_OBJECT (server, "failed to configure keepalive socket: %s", g_strerror (errno));
418 if (server->server_sock.fd >= 0) {
419 close (server->server_sock.fd);
420 server->server_sock.fd = -1;
422 GST_ERROR_OBJECT (server, "failed to listen on socket: %s", g_strerror (errno));
427 if (server->server_sock.fd >= 0) {
428 close (server->server_sock.fd);
429 server->server_sock.fd = -1;
431 GST_ERROR_OBJECT (server, "failed to bind on socket: %s", g_strerror (errno));
436 /* default method for creating a new client object in the server to accept and
437 * handle a client connection on this server */
438 static GstRTSPClient *
439 gst_rtsp_server_accept_client (GstRTSPServer *server, GIOChannel *channel)
441 GstRTSPClient *client;
443 /* a new client connected, create a session to handle the client. */
444 client = gst_rtsp_client_new ();
446 /* set the session pool that this client should use */
447 gst_rtsp_client_set_session_pool (client, server->pool);
449 /* set the session pool that this client should use */
450 gst_rtsp_client_set_media_mapping (client, server->mapping);
452 /* accept connections for that client, this function returns after accepting
453 * the connection and will run the remainder of the communication with the
454 * client asyncronously. */
455 if (!gst_rtsp_client_accept (client, channel))
463 g_error ("Could not accept client on server socket %d: %s (%d)",
464 server->server_sock.fd, g_strerror (errno), errno);
465 gst_object_unref (client);
471 * gst_rtsp_server_io_func:
472 * @channel: a #GIOChannel
473 * @condition: the condition on @source
475 * A default #GIOFunc that creates a new #GstRTSPClient to accept and handle a
476 * new connection on @channel or @server.
478 * Returns: TRUE if the source could be connected, FALSE if an error occured.
481 gst_rtsp_server_io_func (GIOChannel *channel, GIOCondition condition, GstRTSPServer *server)
483 GstRTSPClient *client = NULL;
484 GstRTSPServerClass *klass;
486 if (condition & G_IO_IN) {
487 klass = GST_RTSP_SERVER_GET_CLASS (server);
489 /* a new client connected, create a client object to handle the client. */
490 if (klass->accept_client)
491 client = klass->accept_client (server, channel);
495 /* can unref the client now, when the request is finished, it will be
497 gst_object_unref (client);
500 g_print ("received unknown event %08x", condition);
507 GST_ERROR_OBJECT (server, "failed to create a client");
513 * gst_rtsp_server_get_io_channel:
514 * @server: a #GstRTSPServer
516 * Create a #GIOChannel for @server.
518 * Returns: the GIOChannel for @server or NULL when an error occured.
521 gst_rtsp_server_get_io_channel (GstRTSPServer *server)
523 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
525 if (server->io_channel == NULL) {
526 if (!gst_rtsp_server_sink_init_send (server))
529 /* create IO channel for the socket */
530 server->io_channel = g_io_channel_unix_new (server->server_sock.fd);
532 return server->io_channel;
541 * gst_rtsp_server_create_watch:
542 * @server: a #GstRTSPServer
544 * Create a #GSource for @server. The new source will have a default
545 * #GIOFunc of gst_rtsp_server_io_func().
547 * Returns: the #GSource for @server or NULL when an error occured.
550 gst_rtsp_server_create_watch (GstRTSPServer *server)
552 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
554 if (server->io_watch == NULL) {
557 channel = gst_rtsp_server_get_io_channel (server);
561 /* create a watch for reads (new connections) and possible errors */
562 server->io_watch = g_io_create_watch (channel, G_IO_IN |
563 G_IO_ERR | G_IO_HUP | G_IO_NVAL);
565 /* configure the callback */
566 g_source_set_callback (server->io_watch, (GSourceFunc) gst_rtsp_server_io_func, server, NULL);
568 return server->io_watch;
577 * gst_rtsp_server_attach:
578 * @server: a #GstRTSPServer
579 * @context: a #GMainContext
581 * Attaches @server to @context. When the mainloop for @context is run, the
582 * server will be dispatched.
584 * This function should be called when the server properties and urls are fully
585 * configured and the server is ready to start.
587 * Returns: the ID (greater than 0) for the source within the GMainContext.
590 gst_rtsp_server_attach (GstRTSPServer *server, GMainContext *context)
595 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), 0);
597 source = gst_rtsp_server_create_watch (server);
601 res = g_source_attach (source, context);