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., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
20 #ifndef __GST_RTSP_SERVER_H__
21 #define __GST_RTSP_SERVER_H__
27 typedef struct _GstRTSPServer GstRTSPServer;
28 typedef struct _GstRTSPServerClass GstRTSPServerClass;
29 typedef struct _GstRTSPServerPrivate GstRTSPServerPrivate;
31 #include "rtsp-session-pool.h"
32 #include "rtsp-session.h"
33 #include "rtsp-media.h"
34 #include "rtsp-stream.h"
35 #include "rtsp-stream-transport.h"
36 #include "rtsp-address-pool.h"
37 #include "rtsp-thread-pool.h"
38 #include "rtsp-client.h"
39 #include "rtsp-context.h"
40 #include "rtsp-server.h"
41 #include "rtsp-mount-points.h"
42 #include "rtsp-media-factory.h"
43 #include "rtsp-permissions.h"
44 #include "rtsp-auth.h"
45 #include "rtsp-token.h"
46 #include "rtsp-session-media.h"
48 #include "rtsp-media-factory-uri.h"
49 #include "rtsp-params.h"
51 #define GST_TYPE_RTSP_SERVER (gst_rtsp_server_get_type ())
52 #define GST_IS_RTSP_SERVER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_SERVER))
53 #define GST_IS_RTSP_SERVER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_SERVER))
54 #define GST_RTSP_SERVER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_SERVER, GstRTSPServerClass))
55 #define GST_RTSP_SERVER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_SERVER, GstRTSPServer))
56 #define GST_RTSP_SERVER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_SERVER, GstRTSPServerClass))
57 #define GST_RTSP_SERVER_CAST(obj) ((GstRTSPServer*)(obj))
58 #define GST_RTSP_SERVER_CLASS_CAST(klass) ((GstRTSPServerClass*)(klass))
63 * This object listens on a port, creates and manages the clients connected to
66 struct _GstRTSPServer {
70 GstRTSPServerPrivate *priv;
71 gpointer _gst_reserved[GST_PADDING];
76 * @create_client: Create, configure a new GstRTSPClient
77 * object that handles the new connection on @socket. The default
78 * implementation will create a GstRTSPClient and will configure the
79 * mount-points, auth, session-pool and thread-pool on the client.
80 * @client_connected: emited when a new client connected.
82 * The RTSP server class structure
84 struct _GstRTSPServerClass {
85 GObjectClass parent_class;
87 GstRTSPClient * (*create_client) (GstRTSPServer *server);
90 void (*client_connected) (GstRTSPServer *server, GstRTSPClient *client);
93 gpointer _gst_reserved[GST_PADDING_LARGE];
96 GType gst_rtsp_server_get_type (void);
98 GstRTSPServer * gst_rtsp_server_new (void);
100 void gst_rtsp_server_set_address (GstRTSPServer *server, const gchar *address);
101 gchar * gst_rtsp_server_get_address (GstRTSPServer *server);
103 void gst_rtsp_server_set_service (GstRTSPServer *server, const gchar *service);
104 gchar * gst_rtsp_server_get_service (GstRTSPServer *server);
106 void gst_rtsp_server_set_backlog (GstRTSPServer *server, gint backlog);
107 gint gst_rtsp_server_get_backlog (GstRTSPServer *server);
109 int gst_rtsp_server_get_bound_port (GstRTSPServer *server);
111 void gst_rtsp_server_set_session_pool (GstRTSPServer *server, GstRTSPSessionPool *pool);
112 GstRTSPSessionPool * gst_rtsp_server_get_session_pool (GstRTSPServer *server);
114 void gst_rtsp_server_set_mount_points (GstRTSPServer *server, GstRTSPMountPoints *mounts);
115 GstRTSPMountPoints * gst_rtsp_server_get_mount_points (GstRTSPServer *server);
117 void gst_rtsp_server_set_auth (GstRTSPServer *server, GstRTSPAuth *auth);
118 GstRTSPAuth * gst_rtsp_server_get_auth (GstRTSPServer *server);
120 void gst_rtsp_server_set_thread_pool (GstRTSPServer *server, GstRTSPThreadPool *pool);
121 GstRTSPThreadPool * gst_rtsp_server_get_thread_pool (GstRTSPServer *server);
123 gboolean gst_rtsp_server_transfer_connection (GstRTSPServer * server, GSocket *socket,
124 const gchar * ip, gint port,
125 const gchar *initial_buffer);
127 gboolean gst_rtsp_server_io_func (GSocket *socket, GIOCondition condition,
128 GstRTSPServer *server);
130 GSocket * gst_rtsp_server_create_socket (GstRTSPServer *server,
131 GCancellable *cancellable,
133 GSource * gst_rtsp_server_create_source (GstRTSPServer *server,
134 GCancellable * cancellable,
136 guint gst_rtsp_server_attach (GstRTSPServer *server,
137 GMainContext *context);
140 * GstRTSPServerClientFilterFunc:
141 * @server: a #GstRTSPServer object
142 * @client: a #GstRTSPClient in @server
143 * @user_data: user data that has been given to gst_rtsp_server_client_filter()
145 * This function will be called by the gst_rtsp_server_client_filter(). An
146 * implementation should return a value of #GstRTSPFilterResult.
148 * When this function returns #GST_RTSP_FILTER_REMOVE, @client will be removed
151 * A return value of #GST_RTSP_FILTER_KEEP will leave @client untouched in
154 * A value of #GST_RTSP_FILTER_REF will add @client to the result #GList of
155 * gst_rtsp_server_client_filter().
157 * Returns: a #GstRTSPFilterResult.
159 typedef GstRTSPFilterResult (*GstRTSPServerClientFilterFunc) (GstRTSPServer *server,
160 GstRTSPClient *client,
163 GList * gst_rtsp_server_client_filter (GstRTSPServer *server,
164 GstRTSPServerClientFilterFunc func,
169 #endif /* __GST_RTSP_SERVER_H__ */