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))
56 * @request: the complete request
57 * @uri: the complete url parsed from @request
58 * @method: the parsed method of @uri
59 * @auth: the current auth object or NULL
60 * @token: authorisation token
61 * @session: the session, can be NULL
62 * @sessmedia: the session media for the url can be NULL
63 * @factory: the media factory for the url, can be NULL.
64 * @media: the media for the url can be NULL
65 * @stream: the stream for the url can be NULL
66 * @response: the response
68 * Information passed around containing the client state of a request.
70 struct _GstRTSPClientState {
71 GstRTSPServer *server;
72 GstRTSPClient *client;
73 GstRTSPMessage *request;
78 GstRTSPSession *session;
79 GstRTSPSessionMedia *sessmedia;
80 GstRTSPMediaFactory *factory;
82 GstRTSPStream *stream;
83 GstRTSPMessage *response;
86 GstRTSPClientState * gst_rtsp_client_state_get_current (void);
89 * GstRTSPClientSendFunc:
90 * @client: a #GstRTSPClient
91 * @message: a #GstRTSPMessage
92 * @close: close the connection
93 * @user_data: user data when registering the callback
95 * This callback is called when @client wants to send @message. When @close is
96 * %TRUE, the connection should be closed when the message has been sent.
98 * Returns: %TRUE on success.
100 typedef gboolean (*GstRTSPClientSendFunc) (GstRTSPClient *client,
101 GstRTSPMessage *message,
108 * The client structure.
110 struct _GstRTSPClient {
113 GstRTSPClientPrivate *priv;
117 * GstRTSPClientClass:
118 * @params_set: set parameters. This function should also initialize the
119 * RTSP response(state->response) via a call to gst_rtsp_message_init_response()
120 * @params_get: get parameters. This function should also initialize the
121 * RTSP response(state->response) via a call to gst_rtsp_message_init_response()
123 * The client class structure.
125 struct _GstRTSPClientClass {
126 GObjectClass parent_class;
128 GstSDPMessage * (*create_sdp) (GstRTSPClient *client, GstRTSPMedia *media);
129 gboolean (*configure_client_transport) (GstRTSPClient * client,
130 GstRTSPClientState * state,
131 GstRTSPTransport * ct);
132 GstRTSPResult (*params_set) (GstRTSPClient *client, GstRTSPClientState *state);
133 GstRTSPResult (*params_get) (GstRTSPClient *client, GstRTSPClientState *state);
136 void (*closed) (GstRTSPClient *client);
137 void (*new_session) (GstRTSPClient *client, GstRTSPSession *session);
138 void (*options_request) (GstRTSPClient *client, GstRTSPClientState *state);
139 void (*describe_request) (GstRTSPClient *client, GstRTSPClientState *state);
140 void (*setup_request) (GstRTSPClient *client, GstRTSPClientState *state);
141 void (*play_request) (GstRTSPClient *client, GstRTSPClientState *state);
142 void (*pause_request) (GstRTSPClient *client, GstRTSPClientState *state);
143 void (*teardown_request) (GstRTSPClient *client, GstRTSPClientState *state);
144 void (*set_parameter_request) (GstRTSPClient *client, GstRTSPClientState *state);
145 void (*get_parameter_request) (GstRTSPClient *client, GstRTSPClientState *state);
148 GType gst_rtsp_client_get_type (void);
150 GstRTSPClient * gst_rtsp_client_new (void);
152 void gst_rtsp_client_set_session_pool (GstRTSPClient *client,
153 GstRTSPSessionPool *pool);
154 GstRTSPSessionPool * gst_rtsp_client_get_session_pool (GstRTSPClient *client);
156 void gst_rtsp_client_set_mount_points (GstRTSPClient *client,
157 GstRTSPMountPoints *mounts);
158 GstRTSPMountPoints * gst_rtsp_client_get_mount_points (GstRTSPClient *client);
160 void gst_rtsp_client_set_use_client_settings (GstRTSPClient * client,
161 gboolean use_client_settings);
162 gboolean gst_rtsp_client_get_use_client_settings (GstRTSPClient * client);
164 void gst_rtsp_client_set_auth (GstRTSPClient *client, GstRTSPAuth *auth);
165 GstRTSPAuth * gst_rtsp_client_get_auth (GstRTSPClient *client);
167 void gst_rtsp_client_set_thread_pool (GstRTSPClient *client, GstRTSPThreadPool *pool);
168 GstRTSPThreadPool * gst_rtsp_client_get_thread_pool (GstRTSPClient *client);
170 gboolean gst_rtsp_client_set_connection (GstRTSPClient *client, GstRTSPConnection *conn);
171 GstRTSPConnection * gst_rtsp_client_get_connection (GstRTSPClient *client);
173 void gst_rtsp_client_set_send_func (GstRTSPClient *client,
174 GstRTSPClientSendFunc func,
176 GDestroyNotify notify);
177 GstRTSPResult gst_rtsp_client_handle_message (GstRTSPClient *client,
178 GstRTSPMessage *message);
180 GstRTSPResult gst_rtsp_client_send_request (GstRTSPClient * client,
181 GstRTSPSession *session,
182 GstRTSPMessage *request);
183 guint gst_rtsp_client_attach (GstRTSPClient *client,
184 GMainContext *context);
187 * GstRTSPClientSessionFilterFunc:
188 * @client: a #GstRTSPClient object
189 * @sess: a #GstRTSPSession in @client
190 * @user_data: user data that has been given to gst_rtsp_client_session_filter()
192 * This function will be called by the gst_rtsp_client_session_filter(). An
193 * implementation should return a value of #GstRTSPFilterResult.
195 * When this function returns #GST_RTSP_FILTER_REMOVE, @sess will be removed
198 * A return value of #GST_RTSP_FILTER_KEEP will leave @sess untouched in
201 * A value of GST_RTSP_FILTER_REF will add @sess to the result #GList of
202 * gst_rtsp_client_session_filter().
204 * Returns: a #GstRTSPFilterResult.
206 typedef GstRTSPFilterResult (*GstRTSPClientSessionFilterFunc) (GstRTSPClient *client,
207 GstRTSPSession *sess,
210 GList * gst_rtsp_client_session_filter (GstRTSPClient *client,
211 GstRTSPClientSessionFilterFunc func,
218 #endif /* __GST_RTSP_CLIENT_H__ */