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_ADDRESS "0.0.0.0"
26 /* #define DEFAULT_ADDRESS "::0" */
27 #define DEFAULT_SERVICE "8554"
28 #define DEFAULT_BACKLOG 5
42 G_DEFINE_TYPE (GstRTSPServer, gst_rtsp_server, G_TYPE_OBJECT);
44 GST_DEBUG_CATEGORY_STATIC (rtsp_server_debug);
45 #define GST_CAT_DEFAULT rtsp_server_debug
47 static void gst_rtsp_server_get_property (GObject *object, guint propid,
48 GValue *value, GParamSpec *pspec);
49 static void gst_rtsp_server_set_property (GObject *object, guint propid,
50 const GValue *value, GParamSpec *pspec);
51 static void gst_rtsp_server_finalize (GObject *object);
53 static GstRTSPClient * default_accept_client (GstRTSPServer *server,
57 gst_rtsp_server_class_init (GstRTSPServerClass * klass)
59 GObjectClass *gobject_class;
61 gobject_class = G_OBJECT_CLASS (klass);
63 gobject_class->get_property = gst_rtsp_server_get_property;
64 gobject_class->set_property = gst_rtsp_server_set_property;
65 gobject_class->finalize = gst_rtsp_server_finalize;
68 * GstRTSPServer::address
70 * The address of the server. This is the address where the server will
73 g_object_class_install_property (gobject_class, PROP_ADDRESS,
74 g_param_spec_string ("address", "Address", "The address the server uses to listen on",
75 DEFAULT_ADDRESS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
77 * GstRTSPServer::service
79 * The service of the server. This is either a string with the service name or
80 * a port number (as a string) the server will listen on.
82 g_object_class_install_property (gobject_class, PROP_SERVICE,
83 g_param_spec_string ("service", "Service", "The service or port number the server uses to listen on",
84 DEFAULT_SERVICE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
86 * GstRTSPServer::backlog
88 * The backlog argument defines the maximum length to which the queue of
89 * pending connections for the server may grow. If a connection request arrives
90 * when the queue is full, the client may receive an error with an indication of
91 * ECONNREFUSED or, if the underlying protocol supports retransmission, the
92 * request may be ignored so that a later reattempt at connection succeeds.
94 g_object_class_install_property (gobject_class, PROP_BACKLOG,
95 g_param_spec_int ("backlog", "Backlog", "The maximum length to which the queue "
96 "of pending connections may grow",
97 0, G_MAXINT, DEFAULT_BACKLOG, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
99 * GstRTSPServer::session-pool
101 * The session pool of the server. By default each server has a separate
102 * session pool but sessions can be shared between servers by setting the same
103 * session pool on multiple servers.
105 g_object_class_install_property (gobject_class, PROP_SESSION_POOL,
106 g_param_spec_object ("session-pool", "Session Pool",
107 "The session pool to use for client session",
108 GST_TYPE_RTSP_SESSION_POOL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
110 * GstRTSPServer::media-mapping
112 * The media mapping to use for this server. By default the server has no
113 * media mapping and thus cannot map urls to media streams.
115 g_object_class_install_property (gobject_class, PROP_MEDIA_MAPPING,
116 g_param_spec_object ("media-mapping", "Media Mapping",
117 "The media mapping to use for client session",
118 GST_TYPE_RTSP_MEDIA_MAPPING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
120 klass->accept_client = default_accept_client;
122 GST_DEBUG_CATEGORY_INIT (rtsp_server_debug, "rtspserver", 0, "GstRTSPServer");
126 gst_rtsp_server_init (GstRTSPServer * server)
128 server->address = g_strdup (DEFAULT_ADDRESS);
129 server->service = g_strdup (DEFAULT_SERVICE);
130 server->backlog = DEFAULT_BACKLOG;
131 server->session_pool = gst_rtsp_session_pool_new ();
132 server->media_mapping = gst_rtsp_media_mapping_new ();
136 gst_rtsp_server_finalize (GObject *object)
138 GstRTSPServer *server = GST_RTSP_SERVER (object);
140 g_free (server->address);
141 g_free (server->service);
143 g_object_unref (server->session_pool);
144 g_object_unref (server->media_mapping);
148 * gst_rtsp_server_new:
150 * Create a new #GstRTSPServer instance.
153 gst_rtsp_server_new (void)
155 GstRTSPServer *result;
157 result = g_object_new (GST_TYPE_RTSP_SERVER, NULL);
163 * gst_rtsp_server_set_address:
164 * @server: a #GstRTSPServer
165 * @address: the address
167 * Configure @server to accept connections on the given address.
169 * This function must be called before the server is bound.
172 gst_rtsp_server_set_address (GstRTSPServer *server, const gchar *address)
174 g_return_if_fail (GST_IS_RTSP_SERVER (server));
175 g_return_if_fail (address != NULL);
177 g_free (server->address);
178 server->address = g_strdup (address);
182 * gst_rtsp_server_get_address:
183 * @server: a #GstRTSPServer
185 * Get the address on which the server will accept connections.
187 * Returns: the server address. g_free() after usage.
190 gst_rtsp_server_get_address (GstRTSPServer *server)
192 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
194 return g_strdup (server->address);
198 * gst_rtsp_server_set_service:
199 * @server: a #GstRTSPServer
200 * @service: the service
202 * Configure @server to accept connections on the given service.
203 * @service should be a string containing the service name (see services(5)) or
204 * a string containing a port number between 1 and 65535.
206 * This function must be called before the server is bound.
209 gst_rtsp_server_set_service (GstRTSPServer *server, const gchar *service)
211 g_return_if_fail (GST_IS_RTSP_SERVER (server));
212 g_return_if_fail (service != NULL);
214 g_free (server->service);
215 server->service = g_strdup (service);
219 * gst_rtsp_server_get_service:
220 * @server: a #GstRTSPServer
222 * Get the service on which the server will accept connections.
224 * Returns: the service. use g_free() after usage.
227 gst_rtsp_server_get_service (GstRTSPServer *server)
229 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
231 return g_strdup (server->service);
235 * gst_rtsp_server_set_backlog:
236 * @server: a #GstRTSPServer
237 * @backlog: the backlog
239 * configure the maximum amount of requests that may be queued for the
242 * This function must be called before the server is bound.
245 gst_rtsp_server_set_backlog (GstRTSPServer *server, gint backlog)
247 g_return_if_fail (GST_IS_RTSP_SERVER (server));
249 server->backlog = backlog;
253 * gst_rtsp_server_get_backlog:
254 * @server: a #GstRTSPServer
256 * The maximum amount of queued requests for the server.
258 * Returns: the server backlog.
261 gst_rtsp_server_get_backlog (GstRTSPServer *server)
263 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), -1);
265 return server->backlog;
269 * gst_rtsp_server_set_session_pool:
270 * @server: a #GstRTSPServer
271 * @pool: a #GstRTSPSessionPool
273 * configure @pool to be used as the session pool of @server.
276 gst_rtsp_server_set_session_pool (GstRTSPServer *server, GstRTSPSessionPool *pool)
278 GstRTSPSessionPool *old;
280 g_return_if_fail (GST_IS_RTSP_SERVER (server));
282 old = server->session_pool;
287 server->session_pool = pool;
289 g_object_unref (old);
294 * gst_rtsp_server_get_session_pool:
295 * @server: a #GstRTSPServer
297 * Get the #GstRTSPSessionPool used as the session pool of @server.
299 * Returns: the #GstRTSPSessionPool used for sessions. g_object_unref() after
303 gst_rtsp_server_get_session_pool (GstRTSPServer *server)
305 GstRTSPSessionPool *result;
307 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
309 if ((result = server->session_pool))
310 g_object_ref (result);
316 * gst_rtsp_server_set_media_mapping:
317 * @server: a #GstRTSPServer
318 * @mapping: a #GstRTSPMediaMapping
320 * configure @mapping to be used as the media mapping of @server.
323 gst_rtsp_server_set_media_mapping (GstRTSPServer *server, GstRTSPMediaMapping *mapping)
325 GstRTSPMediaMapping *old;
327 g_return_if_fail (GST_IS_RTSP_SERVER (server));
329 old = server->media_mapping;
331 if (old != mapping) {
333 g_object_ref (mapping);
334 server->media_mapping = mapping;
336 g_object_unref (old);
342 * gst_rtsp_server_get_media_mapping:
343 * @server: a #GstRTSPServer
345 * Get the #GstRTSPMediaMapping used as the media mapping of @server.
347 * Returns: the #GstRTSPMediaMapping of @server. g_object_unref() after
350 GstRTSPMediaMapping *
351 gst_rtsp_server_get_media_mapping (GstRTSPServer *server)
353 GstRTSPMediaMapping *result;
355 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
357 if ((result = server->media_mapping))
358 g_object_ref (result);
364 gst_rtsp_server_get_property (GObject *object, guint propid,
365 GValue *value, GParamSpec *pspec)
367 GstRTSPServer *server = GST_RTSP_SERVER (object);
371 g_value_take_string (value, gst_rtsp_server_get_address (server));
374 g_value_take_string (value, gst_rtsp_server_get_service (server));
377 g_value_set_int (value, gst_rtsp_server_get_backlog (server));
379 case PROP_SESSION_POOL:
380 g_value_take_object (value, gst_rtsp_server_get_session_pool (server));
382 case PROP_MEDIA_MAPPING:
383 g_value_take_object (value, gst_rtsp_server_get_media_mapping (server));
386 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, propid, pspec);
391 gst_rtsp_server_set_property (GObject *object, guint propid,
392 const GValue *value, GParamSpec *pspec)
394 GstRTSPServer *server = GST_RTSP_SERVER (object);
398 gst_rtsp_server_set_address (server, g_value_get_string (value));
401 gst_rtsp_server_set_service (server, g_value_get_string (value));
404 gst_rtsp_server_set_backlog (server, g_value_get_int (value));
406 case PROP_SESSION_POOL:
407 gst_rtsp_server_set_session_pool (server, g_value_get_object (value));
409 case PROP_MEDIA_MAPPING:
410 gst_rtsp_server_set_media_mapping (server, g_value_get_object (value));
413 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, propid, pspec);
417 /* Prepare a server socket for @server and make it listen on the configured port */
419 gst_rtsp_server_sink_init_send (GstRTSPServer * server)
422 struct addrinfo hints;
423 struct addrinfo *result, *rp;
424 struct linger linger;
426 memset(&hints, 0, sizeof(struct addrinfo));
427 hints.ai_family = AF_UNSPEC; /* Allow IPv4 or IPv6 */
428 hints.ai_socktype = SOCK_STREAM; /* stream socket */
429 hints.ai_flags = AI_PASSIVE | AI_CANONNAME; /* For wildcard IP address */
430 hints.ai_protocol = 0; /* Any protocol */
431 hints.ai_canonname = NULL;
432 hints.ai_addr = NULL;
433 hints.ai_next = NULL;
435 GST_DEBUG_OBJECT (server, "getting address info of %s/%s", server->address, server->service);
437 /* resolve the server IP address */
438 if ((ret = getaddrinfo (server->address, server->service, &hints, &result)) != 0)
441 /* create server socket, we loop through all the addresses until we manage to
442 * create a socket and bind. */
443 for (rp = result; rp; rp = rp->ai_next) {
444 sockfd = socket (rp->ai_family, rp->ai_socktype, rp->ai_protocol);
446 GST_DEBUG_OBJECT (server, "failed to make socket (%s), try next", g_strerror (errno));
450 if (bind (sockfd, rp->ai_addr, rp->ai_addrlen) == 0) {
451 GST_DEBUG_OBJECT (server, "bind on %s", rp->ai_canonname);
455 GST_DEBUG_OBJECT (server, "failed to bind socket (%s), try next", g_strerror (errno));
458 freeaddrinfo (result);
463 server->server_sock.fd = sockfd;
465 GST_DEBUG_OBJECT (server, "opened sending server socket with fd %d",
466 server->server_sock.fd);
468 /* make address reusable */
470 if (setsockopt (server->server_sock.fd, SOL_SOCKET, SO_REUSEADDR,
471 (void *) &ret, sizeof (ret)) < 0)
474 /* keep connection alive; avoids SIGPIPE during write */
476 if (setsockopt (server->server_sock.fd, SOL_SOCKET, SO_KEEPALIVE,
477 (void *) &ret, sizeof (ret)) < 0)
478 goto keepalive_failed;
480 /* make sure socket is reset immediately after close. This ensure that we can
481 * reuse the socket quickly. */
484 if (setsockopt (server->server_sock.fd, SOL_SOCKET, SO_LINGER,
485 (void *) &linger, sizeof (linger)) < 0)
488 /* set the server socket to nonblocking */
489 fcntl (server->server_sock.fd, F_SETFL, O_NONBLOCK);
491 GST_DEBUG_OBJECT (server, "listening on server socket %d with queue of %d",
492 server->server_sock.fd, server->backlog);
493 if (listen (server->server_sock.fd, server->backlog) == -1)
496 GST_DEBUG_OBJECT (server,
497 "listened on server socket %d, returning from connection setup",
498 server->server_sock.fd);
500 GST_INFO_OBJECT (server, "listening on service %s", server->service);
507 GST_ERROR_OBJECT (server, "failed to resolve address: %s", gai_strerror(ret));
512 GST_ERROR_OBJECT (server, "failed to create socket: %s", g_strerror (errno));
517 GST_ERROR_OBJECT (server, "failed to reuse socket: %s", g_strerror (errno));
522 GST_ERROR_OBJECT (server, "failed to configure keepalive socket: %s", g_strerror (errno));
527 GST_ERROR_OBJECT (server, "failed to no linger socket: %s", g_strerror (errno));
532 GST_ERROR_OBJECT (server, "failed to listen on socket: %s", g_strerror (errno));
537 if (server->server_sock.fd >= 0) {
538 close (server->server_sock.fd);
539 server->server_sock.fd = -1;
545 /* default method for creating a new client object in the server to accept and
546 * handle a client connection on this server */
547 static GstRTSPClient *
548 default_accept_client (GstRTSPServer *server, GIOChannel *channel)
550 GstRTSPClient *client;
552 /* a new client connected, create a session to handle the client. */
553 client = gst_rtsp_client_new ();
555 /* set the session pool that this client should use */
556 gst_rtsp_client_set_session_pool (client, server->session_pool);
557 /* set the media mapping that this client should use */
558 gst_rtsp_client_set_media_mapping (client, server->media_mapping);
560 /* accept connections for that client, this function returns after accepting
561 * the connection and will run the remainder of the communication with the
562 * client asyncronously. */
563 if (!gst_rtsp_client_accept (client, channel))
571 GST_ERROR_OBJECT (server, "Could not accept client on server socket %d: %s (%d)",
572 server->server_sock.fd, g_strerror (errno), errno);
573 gst_object_unref (client);
579 * gst_rtsp_server_io_func:
580 * @channel: a #GIOChannel
581 * @condition: the condition on @source
583 * A default #GIOFunc that creates a new #GstRTSPClient to accept and handle a
584 * new connection on @channel or @server.
586 * Returns: TRUE if the source could be connected, FALSE if an error occured.
589 gst_rtsp_server_io_func (GIOChannel *channel, GIOCondition condition, GstRTSPServer *server)
591 GstRTSPClient *client = NULL;
592 GstRTSPServerClass *klass;
594 if (condition & G_IO_IN) {
595 klass = GST_RTSP_SERVER_GET_CLASS (server);
597 /* a new client connected, create a client object to handle the client. */
598 if (klass->accept_client)
599 client = klass->accept_client (server, channel);
603 /* can unref the client now, when the request is finished, it will be
605 gst_object_unref (client);
608 GST_WARNING_OBJECT (server, "received unknown event %08x", condition);
615 GST_ERROR_OBJECT (server, "failed to create a client");
621 * gst_rtsp_server_get_io_channel:
622 * @server: a #GstRTSPServer
624 * Create a #GIOChannel for @server.
626 * Returns: the GIOChannel for @server or NULL when an error occured.
629 gst_rtsp_server_get_io_channel (GstRTSPServer *server)
631 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
633 if (server->io_channel == NULL) {
634 if (!gst_rtsp_server_sink_init_send (server))
637 /* create IO channel for the socket */
638 server->io_channel = g_io_channel_unix_new (server->server_sock.fd);
640 return server->io_channel;
644 GST_ERROR_OBJECT (server, "failed to initialize server");
650 * gst_rtsp_server_create_watch:
651 * @server: a #GstRTSPServer
653 * Create a #GSource for @server. The new source will have a default
654 * #GIOFunc of gst_rtsp_server_io_func().
656 * Returns: the #GSource for @server or NULL when an error occured.
659 gst_rtsp_server_create_watch (GstRTSPServer *server)
661 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
663 if (server->io_watch == NULL) {
666 channel = gst_rtsp_server_get_io_channel (server);
670 /* create a watch for reads (new connections) and possible errors */
671 server->io_watch = g_io_create_watch (channel, G_IO_IN |
672 G_IO_ERR | G_IO_HUP | G_IO_NVAL);
674 /* configure the callback */
675 g_source_set_callback (server->io_watch, (GSourceFunc) gst_rtsp_server_io_func, server, NULL);
677 return server->io_watch;
681 GST_ERROR_OBJECT (server, "failed to create IO channel");
687 * gst_rtsp_server_attach:
688 * @server: a #GstRTSPServer
689 * @context: a #GMainContext
691 * Attaches @server to @context. When the mainloop for @context is run, the
692 * server will be dispatched.
694 * This function should be called when the server properties and urls are fully
695 * configured and the server is ready to start.
697 * Returns: the ID (greater than 0) for the source within the GMainContext.
700 gst_rtsp_server_attach (GstRTSPServer *server, GMainContext *context)
705 g_return_val_if_fail (GST_IS_RTSP_SERVER (server), 0);
707 source = gst_rtsp_server_create_watch (server);
711 res = g_source_attach (source, context);
718 GST_ERROR_OBJECT (server, "failed to create watch");