signals: use generic marshal function
[platform/upstream/gstreamer.git] / 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., 51 Franklin St, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19 /**
20  * SECTION:rtsp-server
21  * @short_description: The main server object
22  * @see_also: #GstRTSPClient, #GstRTSPThreadPool
23  *
24  * The server object is the object listening for connections on a port and
25  * creating #GstRTSPClient objects to handle those connections.
26  *
27  * The server will listen on the address set with gst_rtsp_server_set_address()
28  * and the port or service configured with gst_rtsp_server_set_service().
29  * Use gst_rtsp_server_set_backlog() to configure the amount of pending requests
30  * that the server will keep. By default the server listens on the current
31  * network (0.0.0.0) and port 8554.
32  *
33  * The server will require an SSL connection when a TLS certificate has been
34  * set in the auth object with gst_rtsp_auth_set_tls_certificate().
35  *
36  * To start the server, use gst_rtsp_server_attach() to attach it to a
37  * #GMainContext. For more control, gst_rtsp_server_create_source() and
38  * gst_rtsp_server_create_socket() can be used to get a #GSource and #GSocket
39  * respectively.
40  *
41  * gst_rtsp_server_transfer_connection() can be used to transfer an existing
42  * socket to the RTSP server, for example from an HTTP server.
43  *
44  * Once the server socket is attached to a mainloop, it will start accepting
45  * connections. When a new connection is received, a new #GstRTSPClient object
46  * is created to handle the connection. The new client will be configured with
47  * the server #GstRTSPAuth, #GstRTSPMountPoints, #GstRTSPSessionPool and
48  * #GstRTSPThreadPool.
49  *
50  * The server uses the configured #GstRTSPThreadPool object to handle the
51  * remainder of the communication with this client.
52  *
53  * Last reviewed on 2013-07-11 (1.0.0)
54  */
55 #include <stdlib.h>
56 #include <string.h>
57
58 #include "rtsp-server.h"
59 #include "rtsp-client.h"
60
61 #define GST_RTSP_SERVER_GET_PRIVATE(obj)  \
62        (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_RTSP_SERVER, GstRTSPServerPrivate))
63
64 #define GST_RTSP_SERVER_GET_LOCK(server)  (&(GST_RTSP_SERVER_CAST(server)->priv->lock))
65 #define GST_RTSP_SERVER_LOCK(server)      (g_mutex_lock(GST_RTSP_SERVER_GET_LOCK(server)))
66 #define GST_RTSP_SERVER_UNLOCK(server)    (g_mutex_unlock(GST_RTSP_SERVER_GET_LOCK(server)))
67
68 struct _GstRTSPServerPrivate
69 {
70   GMutex lock;                  /* protects everything in this struct */
71
72   /* server information */
73   gchar *address;
74   gchar *service;
75   gint backlog;
76
77   GSocket *socket;
78
79   /* sessions on this server */
80   GstRTSPSessionPool *session_pool;
81
82   /* mount points for this server */
83   GstRTSPMountPoints *mount_points;
84
85   /* authentication manager */
86   GstRTSPAuth *auth;
87
88   /* resource manager */
89   GstRTSPThreadPool *thread_pool;
90
91   /* the clients that are connected */
92   GList *clients;
93 };
94
95 #define DEFAULT_ADDRESS         "0.0.0.0"
96 #define DEFAULT_BOUND_PORT      -1
97 /* #define DEFAULT_ADDRESS         "::0" */
98 #define DEFAULT_SERVICE         "8554"
99 #define DEFAULT_BACKLOG         5
100
101 /* Define to use the SO_LINGER option so that the server sockets can be resused
102  * sooner. Disabled for now because it is not very well implemented by various
103  * OSes and it causes clients to fail to read the TEARDOWN response. */
104 #undef USE_SOLINGER
105
106 enum
107 {
108   PROP_0,
109   PROP_ADDRESS,
110   PROP_SERVICE,
111   PROP_BOUND_PORT,
112   PROP_BACKLOG,
113
114   PROP_SESSION_POOL,
115   PROP_MOUNT_POINTS,
116   PROP_LAST
117 };
118
119 enum
120 {
121   SIGNAL_CLIENT_CONNECTED,
122   SIGNAL_LAST
123 };
124
125 G_DEFINE_TYPE (GstRTSPServer, gst_rtsp_server, G_TYPE_OBJECT);
126
127 GST_DEBUG_CATEGORY_STATIC (rtsp_server_debug);
128 #define GST_CAT_DEFAULT rtsp_server_debug
129
130 typedef struct _ClientContext ClientContext;
131
132 static guint gst_rtsp_server_signals[SIGNAL_LAST] = { 0 };
133
134 static void gst_rtsp_server_get_property (GObject * object, guint propid,
135     GValue * value, GParamSpec * pspec);
136 static void gst_rtsp_server_set_property (GObject * object, guint propid,
137     const GValue * value, GParamSpec * pspec);
138 static void gst_rtsp_server_finalize (GObject * object);
139
140 static GstRTSPClient *default_create_client (GstRTSPServer * server);
141
142 static void
143 gst_rtsp_server_class_init (GstRTSPServerClass * klass)
144 {
145   GObjectClass *gobject_class;
146
147   g_type_class_add_private (klass, sizeof (GstRTSPServerPrivate));
148
149   gobject_class = G_OBJECT_CLASS (klass);
150
151   gobject_class->get_property = gst_rtsp_server_get_property;
152   gobject_class->set_property = gst_rtsp_server_set_property;
153   gobject_class->finalize = gst_rtsp_server_finalize;
154
155   /**
156    * GstRTSPServer::address:
157    *
158    * The address of the server. This is the address where the server will
159    * listen on.
160    */
161   g_object_class_install_property (gobject_class, PROP_ADDRESS,
162       g_param_spec_string ("address", "Address",
163           "The address the server uses to listen on", DEFAULT_ADDRESS,
164           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
165   /**
166    * GstRTSPServer::service:
167    *
168    * The service of the server. This is either a string with the service name or
169    * a port number (as a string) the server will listen on.
170    */
171   g_object_class_install_property (gobject_class, PROP_SERVICE,
172       g_param_spec_string ("service", "Service",
173           "The service or port number the server uses to listen on",
174           DEFAULT_SERVICE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
175   /**
176    * GstRTSPServer::bound-port:
177    *
178    * The actual port the server is listening on. Can be used to retrieve the
179    * port number when the server is started on port 0, which means bind to a
180    * random port. Set to -1 if the server has not been bound yet.
181    */
182   g_object_class_install_property (gobject_class, PROP_BOUND_PORT,
183       g_param_spec_int ("bound-port", "Bound port",
184           "The port number the server is listening on",
185           -1, G_MAXUINT16, DEFAULT_BOUND_PORT,
186           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
187   /**
188    * GstRTSPServer::backlog:
189    *
190    * The backlog argument defines the maximum length to which the queue of
191    * pending connections for the server may grow. If a connection request arrives
192    * when the queue is full, the client may receive an error with an indication of
193    * ECONNREFUSED or, if the underlying protocol supports retransmission, the
194    * request may be ignored so that a later reattempt at connection succeeds.
195    */
196   g_object_class_install_property (gobject_class, PROP_BACKLOG,
197       g_param_spec_int ("backlog", "Backlog",
198           "The maximum length to which the queue "
199           "of pending connections may grow", 0, G_MAXINT, DEFAULT_BACKLOG,
200           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
201   /**
202    * GstRTSPServer::session-pool:
203    *
204    * The session pool of the server. By default each server has a separate
205    * session pool but sessions can be shared between servers by setting the same
206    * session pool on multiple servers.
207    */
208   g_object_class_install_property (gobject_class, PROP_SESSION_POOL,
209       g_param_spec_object ("session-pool", "Session Pool",
210           "The session pool to use for client session",
211           GST_TYPE_RTSP_SESSION_POOL,
212           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
213   /**
214    * GstRTSPServer::mount-points:
215    *
216    * The mount points to use for this server. By default the server has no
217    * mount points and thus cannot map urls to media streams.
218    */
219   g_object_class_install_property (gobject_class, PROP_MOUNT_POINTS,
220       g_param_spec_object ("mount-points", "Mount Points",
221           "The mount points to use for client session",
222           GST_TYPE_RTSP_MOUNT_POINTS,
223           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
224
225   gst_rtsp_server_signals[SIGNAL_CLIENT_CONNECTED] =
226       g_signal_new ("client-connected", G_TYPE_FROM_CLASS (gobject_class),
227       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRTSPServerClass, client_connected),
228       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1,
229       GST_TYPE_RTSP_CLIENT);
230
231   klass->create_client = default_create_client;
232
233   GST_DEBUG_CATEGORY_INIT (rtsp_server_debug, "rtspserver", 0, "GstRTSPServer");
234 }
235
236 static void
237 gst_rtsp_server_init (GstRTSPServer * server)
238 {
239   GstRTSPServerPrivate *priv = GST_RTSP_SERVER_GET_PRIVATE (server);
240
241   server->priv = priv;
242
243   g_mutex_init (&priv->lock);
244   priv->address = g_strdup (DEFAULT_ADDRESS);
245   priv->service = g_strdup (DEFAULT_SERVICE);
246   priv->socket = NULL;
247   priv->backlog = DEFAULT_BACKLOG;
248   priv->session_pool = gst_rtsp_session_pool_new ();
249   priv->mount_points = gst_rtsp_mount_points_new ();
250   priv->thread_pool = gst_rtsp_thread_pool_new ();
251 }
252
253 static void
254 gst_rtsp_server_finalize (GObject * object)
255 {
256   GstRTSPServer *server = GST_RTSP_SERVER (object);
257   GstRTSPServerPrivate *priv = server->priv;
258
259   GST_DEBUG_OBJECT (server, "finalize server");
260
261   g_free (priv->address);
262   g_free (priv->service);
263
264   if (priv->socket)
265     g_object_unref (priv->socket);
266
267   if (priv->session_pool)
268     g_object_unref (priv->session_pool);
269   if (priv->mount_points)
270     g_object_unref (priv->mount_points);
271   if (priv->thread_pool)
272     g_object_unref (priv->thread_pool);
273
274   if (priv->auth)
275     g_object_unref (priv->auth);
276
277   g_mutex_clear (&priv->lock);
278
279   G_OBJECT_CLASS (gst_rtsp_server_parent_class)->finalize (object);
280 }
281
282 /**
283  * gst_rtsp_server_new:
284  *
285  * Create a new #GstRTSPServer instance.
286  *
287  * Returns: (transfer full): a new #GstRTSPServer
288  */
289 GstRTSPServer *
290 gst_rtsp_server_new (void)
291 {
292   GstRTSPServer *result;
293
294   result = g_object_new (GST_TYPE_RTSP_SERVER, NULL);
295
296   return result;
297 }
298
299 /**
300  * gst_rtsp_server_set_address:
301  * @server: a #GstRTSPServer
302  * @address: the address
303  *
304  * Configure @server to accept connections on the given address.
305  *
306  * This function must be called before the server is bound.
307  */
308 void
309 gst_rtsp_server_set_address (GstRTSPServer * server, const gchar * address)
310 {
311   GstRTSPServerPrivate *priv;
312
313   g_return_if_fail (GST_IS_RTSP_SERVER (server));
314   g_return_if_fail (address != NULL);
315
316   priv = server->priv;
317
318   GST_RTSP_SERVER_LOCK (server);
319   g_free (priv->address);
320   priv->address = g_strdup (address);
321   GST_RTSP_SERVER_UNLOCK (server);
322 }
323
324 /**
325  * gst_rtsp_server_get_address:
326  * @server: a #GstRTSPServer
327  *
328  * Get the address on which the server will accept connections.
329  *
330  * Returns: (transfer full): the server address. g_free() after usage.
331  */
332 gchar *
333 gst_rtsp_server_get_address (GstRTSPServer * server)
334 {
335   GstRTSPServerPrivate *priv;
336   gchar *result;
337
338   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
339
340   priv = server->priv;
341
342   GST_RTSP_SERVER_LOCK (server);
343   result = g_strdup (priv->address);
344   GST_RTSP_SERVER_UNLOCK (server);
345
346   return result;
347 }
348
349 /**
350  * gst_rtsp_server_get_bound_port:
351  * @server: a #GstRTSPServer
352  *
353  * Get the port number where the server was bound to.
354  *
355  * Returns: the port number
356  */
357 int
358 gst_rtsp_server_get_bound_port (GstRTSPServer * server)
359 {
360   GstRTSPServerPrivate *priv;
361   GSocketAddress *address;
362   int result = -1;
363
364   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), result);
365
366   priv = server->priv;
367
368   GST_RTSP_SERVER_LOCK (server);
369   if (priv->socket == NULL)
370     goto out;
371
372   address = g_socket_get_local_address (priv->socket, NULL);
373   result = g_inet_socket_address_get_port (G_INET_SOCKET_ADDRESS (address));
374   g_object_unref (address);
375
376 out:
377   GST_RTSP_SERVER_UNLOCK (server);
378
379   return result;
380 }
381
382 /**
383  * gst_rtsp_server_set_service:
384  * @server: a #GstRTSPServer
385  * @service: the service
386  *
387  * Configure @server to accept connections on the given service.
388  * @service should be a string containing the service name (see services(5)) or
389  * a string containing a port number between 1 and 65535.
390  *
391  * When @service is set to "0", the server will listen on a random free
392  * port. The actual used port can be retrieved with
393  * gst_rtsp_server_get_bound_port().
394  *
395  * This function must be called before the server is bound.
396  */
397 void
398 gst_rtsp_server_set_service (GstRTSPServer * server, const gchar * service)
399 {
400   GstRTSPServerPrivate *priv;
401
402   g_return_if_fail (GST_IS_RTSP_SERVER (server));
403   g_return_if_fail (service != NULL);
404
405   priv = server->priv;
406
407   GST_RTSP_SERVER_LOCK (server);
408   g_free (priv->service);
409   priv->service = g_strdup (service);
410   GST_RTSP_SERVER_UNLOCK (server);
411 }
412
413 /**
414  * gst_rtsp_server_get_service:
415  * @server: a #GstRTSPServer
416  *
417  * Get the service on which the server will accept connections.
418  *
419  * Returns: (transfer full): the service. use g_free() after usage.
420  */
421 gchar *
422 gst_rtsp_server_get_service (GstRTSPServer * server)
423 {
424   GstRTSPServerPrivate *priv;
425   gchar *result;
426
427   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
428
429   priv = server->priv;
430
431   GST_RTSP_SERVER_LOCK (server);
432   result = g_strdup (priv->service);
433   GST_RTSP_SERVER_UNLOCK (server);
434
435   return result;
436 }
437
438 /**
439  * gst_rtsp_server_set_backlog:
440  * @server: a #GstRTSPServer
441  * @backlog: the backlog
442  *
443  * configure the maximum amount of requests that may be queued for the
444  * server.
445  *
446  * This function must be called before the server is bound.
447  */
448 void
449 gst_rtsp_server_set_backlog (GstRTSPServer * server, gint backlog)
450 {
451   GstRTSPServerPrivate *priv;
452
453   g_return_if_fail (GST_IS_RTSP_SERVER (server));
454
455   priv = server->priv;
456
457   GST_RTSP_SERVER_LOCK (server);
458   priv->backlog = backlog;
459   GST_RTSP_SERVER_UNLOCK (server);
460 }
461
462 /**
463  * gst_rtsp_server_get_backlog:
464  * @server: a #GstRTSPServer
465  *
466  * The maximum amount of queued requests for the server.
467  *
468  * Returns: the server backlog.
469  */
470 gint
471 gst_rtsp_server_get_backlog (GstRTSPServer * server)
472 {
473   GstRTSPServerPrivate *priv;
474   gint result;
475
476   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), -1);
477
478   priv = server->priv;
479
480   GST_RTSP_SERVER_LOCK (server);
481   result = priv->backlog;
482   GST_RTSP_SERVER_UNLOCK (server);
483
484   return result;
485 }
486
487 /**
488  * gst_rtsp_server_set_session_pool:
489  * @server: a #GstRTSPServer
490  * @pool: (transfer none): a #GstRTSPSessionPool
491  *
492  * configure @pool to be used as the session pool of @server.
493  */
494 void
495 gst_rtsp_server_set_session_pool (GstRTSPServer * server,
496     GstRTSPSessionPool * pool)
497 {
498   GstRTSPServerPrivate *priv;
499   GstRTSPSessionPool *old;
500
501   g_return_if_fail (GST_IS_RTSP_SERVER (server));
502
503   priv = server->priv;
504
505   if (pool)
506     g_object_ref (pool);
507
508   GST_RTSP_SERVER_LOCK (server);
509   old = priv->session_pool;
510   priv->session_pool = pool;
511   GST_RTSP_SERVER_UNLOCK (server);
512
513   if (old)
514     g_object_unref (old);
515 }
516
517 /**
518  * gst_rtsp_server_get_session_pool:
519  * @server: a #GstRTSPServer
520  *
521  * Get the #GstRTSPSessionPool used as the session pool of @server.
522  *
523  * Returns: (transfer full): the #GstRTSPSessionPool used for sessions. g_object_unref() after
524  * usage.
525  */
526 GstRTSPSessionPool *
527 gst_rtsp_server_get_session_pool (GstRTSPServer * server)
528 {
529   GstRTSPServerPrivate *priv;
530   GstRTSPSessionPool *result;
531
532   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
533
534   priv = server->priv;
535
536   GST_RTSP_SERVER_LOCK (server);
537   if ((result = priv->session_pool))
538     g_object_ref (result);
539   GST_RTSP_SERVER_UNLOCK (server);
540
541   return result;
542 }
543
544 /**
545  * gst_rtsp_server_set_mount_points:
546  * @server: a #GstRTSPServer
547  * @mounts: (transfer none): a #GstRTSPMountPoints
548  *
549  * configure @mounts to be used as the mount points of @server.
550  */
551 void
552 gst_rtsp_server_set_mount_points (GstRTSPServer * server,
553     GstRTSPMountPoints * mounts)
554 {
555   GstRTSPServerPrivate *priv;
556   GstRTSPMountPoints *old;
557
558   g_return_if_fail (GST_IS_RTSP_SERVER (server));
559
560   priv = server->priv;
561
562   if (mounts)
563     g_object_ref (mounts);
564
565   GST_RTSP_SERVER_LOCK (server);
566   old = priv->mount_points;
567   priv->mount_points = mounts;
568   GST_RTSP_SERVER_UNLOCK (server);
569
570   if (old)
571     g_object_unref (old);
572 }
573
574
575 /**
576  * gst_rtsp_server_get_mount_points:
577  * @server: a #GstRTSPServer
578  *
579  * Get the #GstRTSPMountPoints used as the mount points of @server.
580  *
581  * Returns: (transfer full): the #GstRTSPMountPoints of @server. g_object_unref() after
582  * usage.
583  */
584 GstRTSPMountPoints *
585 gst_rtsp_server_get_mount_points (GstRTSPServer * server)
586 {
587   GstRTSPServerPrivate *priv;
588   GstRTSPMountPoints *result;
589
590   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
591
592   priv = server->priv;
593
594   GST_RTSP_SERVER_LOCK (server);
595   if ((result = priv->mount_points))
596     g_object_ref (result);
597   GST_RTSP_SERVER_UNLOCK (server);
598
599   return result;
600 }
601
602 /**
603  * gst_rtsp_server_set_auth:
604  * @server: a #GstRTSPServer
605  * @auth: (transfer none): a #GstRTSPAuth
606  *
607  * configure @auth to be used as the authentication manager of @server.
608  */
609 void
610 gst_rtsp_server_set_auth (GstRTSPServer * server, GstRTSPAuth * auth)
611 {
612   GstRTSPServerPrivate *priv;
613   GstRTSPAuth *old;
614
615   g_return_if_fail (GST_IS_RTSP_SERVER (server));
616
617   priv = server->priv;
618
619   if (auth)
620     g_object_ref (auth);
621
622   GST_RTSP_SERVER_LOCK (server);
623   old = priv->auth;
624   priv->auth = auth;
625   GST_RTSP_SERVER_UNLOCK (server);
626
627   if (old)
628     g_object_unref (old);
629 }
630
631
632 /**
633  * gst_rtsp_server_get_auth:
634  * @server: a #GstRTSPServer
635  *
636  * Get the #GstRTSPAuth used as the authentication manager of @server.
637  *
638  * Returns: (transfer full): the #GstRTSPAuth of @server. g_object_unref() after
639  * usage.
640  */
641 GstRTSPAuth *
642 gst_rtsp_server_get_auth (GstRTSPServer * server)
643 {
644   GstRTSPServerPrivate *priv;
645   GstRTSPAuth *result;
646
647   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
648
649   priv = server->priv;
650
651   GST_RTSP_SERVER_LOCK (server);
652   if ((result = priv->auth))
653     g_object_ref (result);
654   GST_RTSP_SERVER_UNLOCK (server);
655
656   return result;
657 }
658
659 /**
660  * gst_rtsp_server_set_thread_pool:
661  * @server: a #GstRTSPServer
662  * @pool: (transfer none): a #GstRTSPThreadPool
663  *
664  * configure @pool to be used as the thread pool of @server.
665  */
666 void
667 gst_rtsp_server_set_thread_pool (GstRTSPServer * server,
668     GstRTSPThreadPool * pool)
669 {
670   GstRTSPServerPrivate *priv;
671   GstRTSPThreadPool *old;
672
673   g_return_if_fail (GST_IS_RTSP_SERVER (server));
674
675   priv = server->priv;
676
677   if (pool)
678     g_object_ref (pool);
679
680   GST_RTSP_SERVER_LOCK (server);
681   old = priv->thread_pool;
682   priv->thread_pool = pool;
683   GST_RTSP_SERVER_UNLOCK (server);
684
685   if (old)
686     g_object_unref (old);
687 }
688
689 /**
690  * gst_rtsp_server_get_thread_pool:
691  * @server: a #GstRTSPServer
692  *
693  * Get the #GstRTSPThreadPool used as the thread pool of @server.
694  *
695  * Returns: (transfer full): the #GstRTSPThreadPool of @server. g_object_unref() after
696  * usage.
697  */
698 GstRTSPThreadPool *
699 gst_rtsp_server_get_thread_pool (GstRTSPServer * server)
700 {
701   GstRTSPServerPrivate *priv;
702   GstRTSPThreadPool *result;
703
704   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
705
706   priv = server->priv;
707
708   GST_RTSP_SERVER_LOCK (server);
709   if ((result = priv->thread_pool))
710     g_object_ref (result);
711   GST_RTSP_SERVER_UNLOCK (server);
712
713   return result;
714 }
715
716 static void
717 gst_rtsp_server_get_property (GObject * object, guint propid,
718     GValue * value, GParamSpec * pspec)
719 {
720   GstRTSPServer *server = GST_RTSP_SERVER (object);
721
722   switch (propid) {
723     case PROP_ADDRESS:
724       g_value_take_string (value, gst_rtsp_server_get_address (server));
725       break;
726     case PROP_SERVICE:
727       g_value_take_string (value, gst_rtsp_server_get_service (server));
728       break;
729     case PROP_BOUND_PORT:
730       g_value_set_int (value, gst_rtsp_server_get_bound_port (server));
731       break;
732     case PROP_BACKLOG:
733       g_value_set_int (value, gst_rtsp_server_get_backlog (server));
734       break;
735     case PROP_SESSION_POOL:
736       g_value_take_object (value, gst_rtsp_server_get_session_pool (server));
737       break;
738     case PROP_MOUNT_POINTS:
739       g_value_take_object (value, gst_rtsp_server_get_mount_points (server));
740       break;
741     default:
742       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, propid, pspec);
743   }
744 }
745
746 static void
747 gst_rtsp_server_set_property (GObject * object, guint propid,
748     const GValue * value, GParamSpec * pspec)
749 {
750   GstRTSPServer *server = GST_RTSP_SERVER (object);
751
752   switch (propid) {
753     case PROP_ADDRESS:
754       gst_rtsp_server_set_address (server, g_value_get_string (value));
755       break;
756     case PROP_SERVICE:
757       gst_rtsp_server_set_service (server, g_value_get_string (value));
758       break;
759     case PROP_BACKLOG:
760       gst_rtsp_server_set_backlog (server, g_value_get_int (value));
761       break;
762     case PROP_SESSION_POOL:
763       gst_rtsp_server_set_session_pool (server, g_value_get_object (value));
764       break;
765     case PROP_MOUNT_POINTS:
766       gst_rtsp_server_set_mount_points (server, g_value_get_object (value));
767       break;
768     default:
769       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, propid, pspec);
770   }
771 }
772
773 /**
774  * gst_rtsp_server_create_socket:
775  * @server: a #GstRTSPServer
776  * @cancellable: (allow-none): a #GCancellable
777  * @error: (out): a #GError
778  *
779  * Create a #GSocket for @server. The socket will listen on the
780  * configured service.
781  *
782  * Returns: (transfer full): the #GSocket for @server or %NULL when an error
783  * occurred.
784  */
785 GSocket *
786 gst_rtsp_server_create_socket (GstRTSPServer * server,
787     GCancellable * cancellable, GError ** error)
788 {
789   GstRTSPServerPrivate *priv;
790   GSocketConnectable *conn;
791   GSocketAddressEnumerator *enumerator;
792   GSocket *socket = NULL;
793 #ifdef USE_SOLINGER
794   struct linger linger;
795 #endif
796   GError *sock_error = NULL;
797   GError *bind_error = NULL;
798   guint16 port;
799
800   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
801
802   priv = server->priv;
803
804   GST_RTSP_SERVER_LOCK (server);
805   GST_DEBUG_OBJECT (server, "getting address info of %s/%s", priv->address,
806       priv->service);
807
808   /* resolve the server IP address */
809   port = atoi (priv->service);
810   if (port != 0 || !strcmp (priv->service, "0"))
811     conn = g_network_address_new (priv->address, port);
812   else
813     conn = g_network_service_new (priv->service, "tcp", priv->address);
814
815   enumerator = g_socket_connectable_enumerate (conn);
816   g_object_unref (conn);
817
818   /* create server socket, we loop through all the addresses until we manage to
819    * create a socket and bind. */
820   while (TRUE) {
821     GSocketAddress *sockaddr;
822
823     sockaddr =
824         g_socket_address_enumerator_next (enumerator, cancellable, error);
825     if (!sockaddr) {
826       if (!*error)
827         GST_DEBUG_OBJECT (server, "no more addresses %s",
828             *error ? (*error)->message : "");
829       else
830         GST_DEBUG_OBJECT (server, "failed to retrieve next address %s",
831             (*error)->message);
832       break;
833     }
834
835     /* only keep the first error */
836     socket = g_socket_new (g_socket_address_get_family (sockaddr),
837         G_SOCKET_TYPE_STREAM, G_SOCKET_PROTOCOL_TCP,
838         sock_error ? NULL : &sock_error);
839
840     if (socket == NULL) {
841       GST_DEBUG_OBJECT (server, "failed to make socket (%s), try next",
842           sock_error->message);
843       g_object_unref (sockaddr);
844       continue;
845     }
846
847     if (g_socket_bind (socket, sockaddr, TRUE, bind_error ? NULL : &bind_error)) {
848       /* ask what port the socket has been bound to */
849       if (port == 0 || !strcmp (priv->service, "0")) {
850         GError *addr_error = NULL;
851
852         g_object_unref (sockaddr);
853         sockaddr = g_socket_get_local_address (socket, &addr_error);
854
855         if (addr_error != NULL) {
856           GST_DEBUG_OBJECT (server,
857               "failed to get the local address of a bound socket %s",
858               addr_error->message);
859           g_clear_error (&addr_error);
860           break;
861         }
862         port =
863             g_inet_socket_address_get_port (G_INET_SOCKET_ADDRESS (sockaddr));
864
865         if (port != 0) {
866           g_free (priv->service);
867           priv->service = g_strdup_printf ("%d", port);
868         } else {
869           GST_DEBUG_OBJECT (server, "failed to get the port of a bound socket");
870         }
871       }
872       g_object_unref (sockaddr);
873       break;
874     }
875
876     GST_DEBUG_OBJECT (server, "failed to bind socket (%s), try next",
877         bind_error->message);
878     g_object_unref (sockaddr);
879     g_object_unref (socket);
880     socket = NULL;
881   }
882   g_object_unref (enumerator);
883
884   if (socket == NULL)
885     goto no_socket;
886
887   g_clear_error (&sock_error);
888   g_clear_error (&bind_error);
889
890   GST_DEBUG_OBJECT (server, "opened sending server socket");
891
892   /* keep connection alive; avoids SIGPIPE during write */
893   g_socket_set_keepalive (socket, TRUE);
894
895 #if 0
896 #ifdef USE_SOLINGER
897   /* make sure socket is reset 5 seconds after close. This ensure that we can
898    * reuse the socket quickly while still having a chance to send data to the
899    * client. */
900   linger.l_onoff = 1;
901   linger.l_linger = 5;
902   if (setsockopt (sockfd, SOL_SOCKET, SO_LINGER,
903           (void *) &linger, sizeof (linger)) < 0)
904     goto linger_failed;
905 #endif
906 #endif
907
908   /* set the server socket to nonblocking */
909   g_socket_set_blocking (socket, FALSE);
910
911   /* set listen backlog */
912   g_socket_set_listen_backlog (socket, priv->backlog);
913
914   if (!g_socket_listen (socket, error))
915     goto listen_failed;
916
917   GST_DEBUG_OBJECT (server, "listening on server socket %p with queue of %d",
918       socket, priv->backlog);
919
920   GST_RTSP_SERVER_UNLOCK (server);
921
922   return socket;
923
924   /* ERRORS */
925 no_socket:
926   {
927     GST_ERROR_OBJECT (server, "failed to create socket");
928     goto close_error;
929   }
930 #if 0
931 #ifdef USE_SOLINGER
932 linger_failed:
933   {
934     GST_ERROR_OBJECT (server, "failed to no linger socket: %s",
935         g_strerror (errno));
936     goto close_error;
937   }
938 #endif
939 #endif
940 listen_failed:
941   {
942     GST_ERROR_OBJECT (server, "failed to listen on socket: %s",
943         (*error)->message);
944     goto close_error;
945   }
946 close_error:
947   {
948     if (socket)
949       g_object_unref (socket);
950
951     if (sock_error) {
952       if (error == NULL)
953         g_propagate_error (error, sock_error);
954       else
955         g_error_free (sock_error);
956     }
957     if (bind_error) {
958       if ((error == NULL) || (*error == NULL))
959         g_propagate_error (error, bind_error);
960       else
961         g_error_free (bind_error);
962     }
963     GST_RTSP_SERVER_UNLOCK (server);
964     return NULL;
965   }
966 }
967
968 struct _ClientContext
969 {
970   GstRTSPServer *server;
971   GstRTSPThread *thread;
972   GstRTSPClient *client;
973 };
974
975 static gboolean
976 free_client_context (ClientContext * ctx)
977 {
978   GST_DEBUG ("free context %p", ctx);
979
980   GST_RTSP_SERVER_LOCK (ctx->server);
981   if (ctx->thread)
982     gst_rtsp_thread_stop (ctx->thread);
983   GST_RTSP_SERVER_UNLOCK (ctx->server);
984
985   g_object_unref (ctx->client);
986   g_object_unref (ctx->server);
987   g_slice_free (ClientContext, ctx);
988
989   return G_SOURCE_REMOVE;
990 }
991
992 static void
993 unmanage_client (GstRTSPClient * client, ClientContext * ctx)
994 {
995   GstRTSPServer *server = ctx->server;
996   GstRTSPServerPrivate *priv = server->priv;
997
998   GST_DEBUG_OBJECT (server, "unmanage client %p", client);
999
1000   GST_RTSP_SERVER_LOCK (server);
1001   priv->clients = g_list_remove (priv->clients, ctx);
1002   GST_RTSP_SERVER_UNLOCK (server);
1003
1004   if (ctx->thread) {
1005     GSource *src;
1006
1007     src = g_idle_source_new ();
1008     g_source_set_callback (src, (GSourceFunc) free_client_context, ctx, NULL);
1009     g_source_attach (src, ctx->thread->context);
1010     g_source_unref (src);
1011   } else {
1012     free_client_context (ctx);
1013   }
1014 }
1015
1016 /* add the client context to the active list of clients, takes ownership
1017  * of client */
1018 static void
1019 manage_client (GstRTSPServer * server, GstRTSPClient * client)
1020 {
1021   ClientContext *cctx;
1022   GstRTSPServerPrivate *priv = server->priv;
1023   GMainContext *mainctx = NULL;
1024   GstRTSPContext ctx = { NULL };
1025
1026   GST_DEBUG_OBJECT (server, "manage client %p", client);
1027
1028   g_signal_emit (server, gst_rtsp_server_signals[SIGNAL_CLIENT_CONNECTED], 0,
1029       client);
1030
1031   cctx = g_slice_new0 (ClientContext);
1032   cctx->server = g_object_ref (server);
1033   cctx->client = client;
1034
1035   GST_RTSP_SERVER_LOCK (server);
1036
1037   ctx.server = server;
1038   ctx.client = client;
1039
1040   cctx->thread = gst_rtsp_thread_pool_get_thread (priv->thread_pool,
1041       GST_RTSP_THREAD_TYPE_CLIENT, &ctx);
1042   if (cctx->thread)
1043     mainctx = cctx->thread->context;
1044   else {
1045     GSource *source;
1046     /* find the context to add the watch */
1047     if ((source = g_main_current_source ()))
1048       mainctx = g_source_get_context (source);
1049   }
1050
1051   g_signal_connect (client, "closed", (GCallback) unmanage_client, cctx);
1052   priv->clients = g_list_prepend (priv->clients, cctx);
1053
1054   gst_rtsp_client_attach (client, mainctx);
1055
1056   GST_RTSP_SERVER_UNLOCK (server);
1057 }
1058
1059 static GstRTSPClient *
1060 default_create_client (GstRTSPServer * server)
1061 {
1062   GstRTSPClient *client;
1063   GstRTSPServerPrivate *priv = server->priv;
1064
1065   /* a new client connected, create a session to handle the client. */
1066   client = gst_rtsp_client_new ();
1067
1068   /* set the session pool that this client should use */
1069   GST_RTSP_SERVER_LOCK (server);
1070   gst_rtsp_client_set_session_pool (client, priv->session_pool);
1071   /* set the mount points that this client should use */
1072   gst_rtsp_client_set_mount_points (client, priv->mount_points);
1073   /* set authentication manager */
1074   gst_rtsp_client_set_auth (client, priv->auth);
1075   /* set threadpool */
1076   gst_rtsp_client_set_thread_pool (client, priv->thread_pool);
1077   GST_RTSP_SERVER_UNLOCK (server);
1078
1079   return client;
1080 }
1081
1082 /**
1083  * gst_rtsp_server_transfer_connection:
1084  * @server: a #GstRTSPServer
1085  * @socket: (transfer full): a network socket
1086  * @ip: the IP address of the remote client
1087  * @port: the port used by the other end
1088  * @initial_buffer: any initial data that was already read from the socket
1089  *
1090  * Take an existing network socket and use it for an RTSP connection. This
1091  * is used when transferring a socket from an HTTP server which should be used
1092  * as an RTSP over HTTP tunnel. The @initial_buffer contains any remaining data
1093  * that the HTTP server read from the socket while parsing the HTTP header.
1094  *
1095  * Returns: TRUE if all was ok, FALSE if an error occurred.
1096  */
1097 gboolean
1098 gst_rtsp_server_transfer_connection (GstRTSPServer * server, GSocket * socket,
1099     const gchar * ip, gint port, const gchar * initial_buffer)
1100 {
1101   GstRTSPClient *client = NULL;
1102   GstRTSPServerClass *klass;
1103   GstRTSPConnection *conn;
1104   GstRTSPResult res;
1105
1106   klass = GST_RTSP_SERVER_GET_CLASS (server);
1107
1108   if (klass->create_client)
1109     client = klass->create_client (server);
1110   if (client == NULL)
1111     goto client_failed;
1112
1113   GST_RTSP_CHECK (gst_rtsp_connection_create_from_socket (socket, ip, port,
1114           initial_buffer, &conn), no_connection);
1115   g_object_unref (socket);
1116
1117   /* set connection on the client now */
1118   gst_rtsp_client_set_connection (client, conn);
1119
1120   /* manage the client connection */
1121   manage_client (server, client);
1122
1123   return TRUE;
1124
1125   /* ERRORS */
1126 client_failed:
1127   {
1128     GST_ERROR_OBJECT (server, "failed to create a client");
1129     g_object_unref (socket);
1130     return FALSE;
1131   }
1132 no_connection:
1133   {
1134     gchar *str = gst_rtsp_strresult (res);
1135     GST_ERROR ("could not create connection from socket %p: %s", socket, str);
1136     g_free (str);
1137     g_object_unref (socket);
1138     return FALSE;
1139   }
1140 }
1141
1142 /**
1143  * gst_rtsp_server_io_func:
1144  * @socket: a #GSocket
1145  * @condition: the condition on @source
1146  * @server: (transfer none): a #GstRTSPServer
1147  *
1148  * A default #GSocketSourceFunc that creates a new #GstRTSPClient to accept and handle a
1149  * new connection on @socket or @server.
1150  *
1151  * Returns: TRUE if the source could be connected, FALSE if an error occurred.
1152  */
1153 gboolean
1154 gst_rtsp_server_io_func (GSocket * socket, GIOCondition condition,
1155     GstRTSPServer * server)
1156 {
1157   GstRTSPServerPrivate *priv = server->priv;
1158   GstRTSPClient *client = NULL;
1159   GstRTSPServerClass *klass;
1160   GstRTSPResult res;
1161   GstRTSPConnection *conn = NULL;
1162   GstRTSPContext ctx = { NULL };
1163
1164   if (condition & G_IO_IN) {
1165     /* a new client connected. */
1166     GST_RTSP_CHECK (gst_rtsp_connection_accept (socket, &conn, NULL),
1167         accept_failed);
1168
1169     ctx.server = server;
1170     ctx.conn = conn;
1171     ctx.auth = priv->auth;
1172     gst_rtsp_context_push_current (&ctx);
1173
1174     if (!gst_rtsp_auth_check (GST_RTSP_AUTH_CHECK_CONNECT))
1175       goto connection_refused;
1176
1177     klass = GST_RTSP_SERVER_GET_CLASS (server);
1178     /* a new client connected, create a client object to handle the client. */
1179     if (klass->create_client)
1180       client = klass->create_client (server);
1181     if (client == NULL)
1182       goto client_failed;
1183
1184     /* set connection on the client now */
1185     gst_rtsp_client_set_connection (client, conn);
1186
1187     /* manage the client connection */
1188     manage_client (server, client);
1189   } else {
1190     GST_WARNING_OBJECT (server, "received unknown event %08x", condition);
1191   }
1192 exit:
1193   gst_rtsp_context_pop_current (&ctx);
1194
1195   return G_SOURCE_CONTINUE;
1196
1197   /* ERRORS */
1198 accept_failed:
1199   {
1200     gchar *str = gst_rtsp_strresult (res);
1201     GST_ERROR_OBJECT (server, "Could not accept client on socket %p: %s",
1202         socket, str);
1203     g_free (str);
1204     goto exit;
1205   }
1206 connection_refused:
1207   {
1208     GST_ERROR_OBJECT (server, "connection refused");
1209     gst_rtsp_connection_free (conn);
1210     goto exit;
1211   }
1212 client_failed:
1213   {
1214     GST_ERROR_OBJECT (server, "failed to create a client");
1215     gst_rtsp_connection_free (conn);
1216     goto exit;
1217   }
1218 }
1219
1220 static void
1221 watch_destroyed (GstRTSPServer * server)
1222 {
1223   GstRTSPServerPrivate *priv = server->priv;
1224
1225   GST_DEBUG_OBJECT (server, "source destroyed");
1226
1227   g_object_unref (priv->socket);
1228   priv->socket = NULL;
1229   g_object_unref (server);
1230 }
1231
1232 /**
1233  * gst_rtsp_server_create_source:
1234  * @server: a #GstRTSPServer
1235  * @cancellable: (allow-none): a #GCancellable or %NULL.
1236  * @error: (out): a #GError
1237  *
1238  * Create a #GSource for @server. The new source will have a default
1239  * #GSocketSourceFunc of gst_rtsp_server_io_func().
1240  *
1241  * @cancellable if not %NULL can be used to cancel the source, which will cause
1242  * the source to trigger, reporting the current condition (which is likely 0
1243  * unless cancellation happened at the same time as a condition change). You can
1244  * check for this in the callback using g_cancellable_is_cancelled().
1245  *
1246  * Returns: (transfer full): the #GSource for @server or %NULL when an error
1247  * occurred. Free with g_source_unref ()
1248  */
1249 GSource *
1250 gst_rtsp_server_create_source (GstRTSPServer * server,
1251     GCancellable * cancellable, GError ** error)
1252 {
1253   GstRTSPServerPrivate *priv;
1254   GSocket *socket, *old;
1255   GSource *source;
1256
1257   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
1258
1259   priv = server->priv;
1260
1261   socket = gst_rtsp_server_create_socket (server, NULL, error);
1262   if (socket == NULL)
1263     goto no_socket;
1264
1265   GST_RTSP_SERVER_LOCK (server);
1266   old = priv->socket;
1267   priv->socket = g_object_ref (socket);
1268   GST_RTSP_SERVER_UNLOCK (server);
1269
1270   if (old)
1271     g_object_unref (old);
1272
1273   /* create a watch for reads (new connections) and possible errors */
1274   source = g_socket_create_source (socket, G_IO_IN |
1275       G_IO_ERR | G_IO_HUP | G_IO_NVAL, cancellable);
1276   g_object_unref (socket);
1277
1278   /* configure the callback */
1279   g_source_set_callback (source,
1280       (GSourceFunc) gst_rtsp_server_io_func, g_object_ref (server),
1281       (GDestroyNotify) watch_destroyed);
1282
1283   return source;
1284
1285 no_socket:
1286   {
1287     GST_ERROR_OBJECT (server, "failed to create socket");
1288     return NULL;
1289   }
1290 }
1291
1292 /**
1293  * gst_rtsp_server_attach:
1294  * @server: a #GstRTSPServer
1295  * @context: (allow-none): a #GMainContext
1296  *
1297  * Attaches @server to @context. When the mainloop for @context is run, the
1298  * server will be dispatched. When @context is %NULL, the default context will be
1299  * used).
1300  *
1301  * This function should be called when the server properties and urls are fully
1302  * configured and the server is ready to start.
1303  *
1304  * Returns: the ID (greater than 0) for the source within the GMainContext.
1305  */
1306 guint
1307 gst_rtsp_server_attach (GstRTSPServer * server, GMainContext * context)
1308 {
1309   guint res;
1310   GSource *source;
1311   GError *error = NULL;
1312
1313   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), 0);
1314
1315   source = gst_rtsp_server_create_source (server, NULL, &error);
1316   if (source == NULL)
1317     goto no_source;
1318
1319   res = g_source_attach (source, context);
1320   g_source_unref (source);
1321
1322   return res;
1323
1324   /* ERRORS */
1325 no_source:
1326   {
1327     GST_ERROR_OBJECT (server, "failed to create watch: %s", error->message);
1328     g_error_free (error);
1329     return 0;
1330   }
1331 }
1332
1333 /**
1334  * gst_rtsp_server_client_filter:
1335  * @server: a #GstRTSPServer
1336  * @func: (scope call) (allow-none): a callback
1337  * @user_data: user data passed to @func
1338  *
1339  * Call @func for each client managed by @server. The result value of @func
1340  * determines what happens to the client. @func will be called with @server
1341  * locked so no further actions on @server can be performed from @func.
1342  *
1343  * If @func returns #GST_RTSP_FILTER_REMOVE, the client will be removed from
1344  * @server.
1345  *
1346  * If @func returns #GST_RTSP_FILTER_KEEP, the client will remain in @server.
1347  *
1348  * If @func returns #GST_RTSP_FILTER_REF, the client will remain in @server but
1349  * will also be added with an additional ref to the result #GList of this
1350  * function..
1351  *
1352  * When @func is %NULL, #GST_RTSP_FILTER_REF will be assumed for each client.
1353  *
1354  * Returns: (element-type GstRTSPClient) (transfer full): a #GList with all
1355  * clients for which @func returned #GST_RTSP_FILTER_REF. After usage, each
1356  * element in the #GList should be unreffed before the list is freed.
1357  */
1358 GList *
1359 gst_rtsp_server_client_filter (GstRTSPServer * server,
1360     GstRTSPServerClientFilterFunc func, gpointer user_data)
1361 {
1362   GstRTSPServerPrivate *priv;
1363   GList *result, *walk, *next;
1364
1365   g_return_val_if_fail (GST_IS_RTSP_SERVER (server), NULL);
1366
1367   priv = server->priv;
1368
1369   result = NULL;
1370
1371   GST_RTSP_SERVER_LOCK (server);
1372   for (walk = priv->clients; walk; walk = next) {
1373     ClientContext *cctx = walk->data;
1374     GstRTSPFilterResult res;
1375
1376     next = g_list_next (walk);
1377
1378     if (func)
1379       res = func (server, cctx->client, user_data);
1380     else
1381       res = GST_RTSP_FILTER_REF;
1382
1383     switch (res) {
1384       case GST_RTSP_FILTER_REMOVE:
1385         /* remove client, FIXME */
1386         break;
1387       case GST_RTSP_FILTER_REF:
1388         result = g_list_prepend (result, g_object_ref (cctx->client));
1389         break;
1390       case GST_RTSP_FILTER_KEEP:
1391       default:
1392         break;
1393     }
1394   }
1395   GST_RTSP_SERVER_UNLOCK (server);
1396
1397   return result;
1398 }