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.
21 #include <gst/rtsp/gstrtspconnection.h>
23 #ifndef __GST_RTSP_CLIENT_H__
24 #define __GST_RTSP_CLIENT_H__
28 typedef struct _GstRTSPClient GstRTSPClient;
29 typedef struct _GstRTSPClientClass GstRTSPClientClass;
30 typedef struct _GstRTSPClientState GstRTSPClientState;
31 typedef struct _GstRTSPClientPrivate GstRTSPClientPrivate;
33 #include "rtsp-server.h"
34 #include "rtsp-media.h"
35 #include "rtsp-mount-points.h"
36 #include "rtsp-session-pool.h"
37 #include "rtsp-session-media.h"
38 #include "rtsp-auth.h"
39 #include "rtsp-thread-pool.h"
40 #include "rtsp-token.h"
43 #define GST_TYPE_RTSP_CLIENT (gst_rtsp_client_get_type ())
44 #define GST_IS_RTSP_CLIENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_CLIENT))
45 #define GST_IS_RTSP_CLIENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_CLIENT))
46 #define GST_RTSP_CLIENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_CLIENT, GstRTSPClientClass))
47 #define GST_RTSP_CLIENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_CLIENT, GstRTSPClient))
48 #define GST_RTSP_CLIENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_CLIENT, GstRTSPClientClass))
49 #define GST_RTSP_CLIENT_CAST(obj) ((GstRTSPClient*)(obj))
50 #define GST_RTSP_CLIENT_CLASS_CAST(klass) ((GstRTSPClientClass*)(klass))
55 * @conn: the connection
57 * @request: the complete request
58 * @uri: the complete url parsed from @request
59 * @method: the parsed method of @uri
60 * @auth: the current auth object or NULL
61 * @token: authorisation token
62 * @session: the session, can be NULL
63 * @sessmedia: the session media for the url can be NULL
64 * @factory: the media factory for the url, can be NULL.
65 * @media: the media for the url can be NULL
66 * @stream: the stream for the url can be NULL
67 * @response: the response
69 * Information passed around containing the client state of a request.
71 struct _GstRTSPClientState {
72 GstRTSPServer *server;
73 GstRTSPConnection *conn;
74 GstRTSPClient *client;
75 GstRTSPMessage *request;
80 GstRTSPSession *session;
81 GstRTSPSessionMedia *sessmedia;
82 GstRTSPMediaFactory *factory;
84 GstRTSPStream *stream;
85 GstRTSPMessage *response;
88 GstRTSPClientState * gst_rtsp_client_state_get_current (void);
89 void gst_rtsp_client_state_push_current (GstRTSPClientState * state);
90 void gst_rtsp_client_state_pop_current (GstRTSPClientState * state);
94 * GstRTSPClientSendFunc:
95 * @client: a #GstRTSPClient
96 * @message: a #GstRTSPMessage
97 * @close: close the connection
98 * @user_data: user data when registering the callback
100 * This callback is called when @client wants to send @message. When @close is
101 * %TRUE, the connection should be closed when the message has been sent.
103 * Returns: %TRUE on success.
105 typedef gboolean (*GstRTSPClientSendFunc) (GstRTSPClient *client,
106 GstRTSPMessage *message,
113 * The client object represents the connection and its state with a client.
115 struct _GstRTSPClient {
118 GstRTSPClientPrivate *priv;
122 * GstRTSPClientClass:
123 * @create_sdp: called when the SDP needs to be created for media.
124 * @configure_client_transport: called when the client transport needs to be
126 * @params_set: set parameters. This function should also initialize the
127 * RTSP response(state->response) via a call to gst_rtsp_message_init_response()
128 * @params_get: get parameters. This function should also initialize the
129 * RTSP response(state->response) via a call to gst_rtsp_message_init_response()
131 * The client class structure.
133 struct _GstRTSPClientClass {
134 GObjectClass parent_class;
136 GstSDPMessage * (*create_sdp) (GstRTSPClient *client, GstRTSPMedia *media);
137 gboolean (*configure_client_transport) (GstRTSPClient * client,
138 GstRTSPClientState * state,
139 GstRTSPTransport * ct);
140 GstRTSPResult (*params_set) (GstRTSPClient *client, GstRTSPClientState *state);
141 GstRTSPResult (*params_get) (GstRTSPClient *client, GstRTSPClientState *state);
144 void (*closed) (GstRTSPClient *client);
145 void (*new_session) (GstRTSPClient *client, GstRTSPSession *session);
146 void (*options_request) (GstRTSPClient *client, GstRTSPClientState *state);
147 void (*describe_request) (GstRTSPClient *client, GstRTSPClientState *state);
148 void (*setup_request) (GstRTSPClient *client, GstRTSPClientState *state);
149 void (*play_request) (GstRTSPClient *client, GstRTSPClientState *state);
150 void (*pause_request) (GstRTSPClient *client, GstRTSPClientState *state);
151 void (*teardown_request) (GstRTSPClient *client, GstRTSPClientState *state);
152 void (*set_parameter_request) (GstRTSPClient *client, GstRTSPClientState *state);
153 void (*get_parameter_request) (GstRTSPClient *client, GstRTSPClientState *state);
156 GType gst_rtsp_client_get_type (void);
158 GstRTSPClient * gst_rtsp_client_new (void);
160 void gst_rtsp_client_set_session_pool (GstRTSPClient *client,
161 GstRTSPSessionPool *pool);
162 GstRTSPSessionPool * gst_rtsp_client_get_session_pool (GstRTSPClient *client);
164 void gst_rtsp_client_set_mount_points (GstRTSPClient *client,
165 GstRTSPMountPoints *mounts);
166 GstRTSPMountPoints * gst_rtsp_client_get_mount_points (GstRTSPClient *client);
168 void gst_rtsp_client_set_auth (GstRTSPClient *client, GstRTSPAuth *auth);
169 GstRTSPAuth * gst_rtsp_client_get_auth (GstRTSPClient *client);
171 void gst_rtsp_client_set_thread_pool (GstRTSPClient *client, GstRTSPThreadPool *pool);
172 GstRTSPThreadPool * gst_rtsp_client_get_thread_pool (GstRTSPClient *client);
174 void gst_rtsp_client_set_use_client_settings (GstRTSPClient * client,
175 gboolean use_client_settings);
176 gboolean gst_rtsp_client_get_use_client_settings (GstRTSPClient * client);
178 gboolean gst_rtsp_client_set_connection (GstRTSPClient *client, GstRTSPConnection *conn);
179 GstRTSPConnection * gst_rtsp_client_get_connection (GstRTSPClient *client);
181 guint gst_rtsp_client_attach (GstRTSPClient *client,
182 GMainContext *context);
184 void gst_rtsp_client_set_send_func (GstRTSPClient *client,
185 GstRTSPClientSendFunc func,
187 GDestroyNotify notify);
189 GstRTSPResult gst_rtsp_client_handle_message (GstRTSPClient *client,
190 GstRTSPMessage *message);
191 GstRTSPResult gst_rtsp_client_send_request (GstRTSPClient * client,
192 GstRTSPSession *session,
193 GstRTSPMessage *request);
195 * GstRTSPClientSessionFilterFunc:
196 * @client: a #GstRTSPClient object
197 * @sess: a #GstRTSPSession in @client
198 * @user_data: user data that has been given to gst_rtsp_client_session_filter()
200 * This function will be called by the gst_rtsp_client_session_filter(). An
201 * implementation should return a value of #GstRTSPFilterResult.
203 * When this function returns #GST_RTSP_FILTER_REMOVE, @sess will be removed
206 * A return value of #GST_RTSP_FILTER_KEEP will leave @sess untouched in
209 * A value of GST_RTSP_FILTER_REF will add @sess to the result #GList of
210 * gst_rtsp_client_session_filter().
212 * Returns: a #GstRTSPFilterResult.
214 typedef GstRTSPFilterResult (*GstRTSPClientSessionFilterFunc) (GstRTSPClient *client,
215 GstRTSPSession *sess,
218 GList * gst_rtsp_client_session_filter (GstRTSPClient *client,
219 GstRTSPClientSessionFilterFunc func,
226 #endif /* __GST_RTSP_CLIENT_H__ */