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 _GstRTSPClientPrivate GstRTSPClientPrivate;
32 #include "rtsp-context.h"
33 #include "rtsp-mount-points.h"
35 #include "rtsp-auth.h"
37 #define GST_TYPE_RTSP_CLIENT (gst_rtsp_client_get_type ())
38 #define GST_IS_RTSP_CLIENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_CLIENT))
39 #define GST_IS_RTSP_CLIENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_CLIENT))
40 #define GST_RTSP_CLIENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_CLIENT, GstRTSPClientClass))
41 #define GST_RTSP_CLIENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_CLIENT, GstRTSPClient))
42 #define GST_RTSP_CLIENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_CLIENT, GstRTSPClientClass))
43 #define GST_RTSP_CLIENT_CAST(obj) ((GstRTSPClient*)(obj))
44 #define GST_RTSP_CLIENT_CLASS_CAST(klass) ((GstRTSPClientClass*)(klass))
47 * GstRTSPClientSendFunc:
48 * @client: a #GstRTSPClient
49 * @message: a #GstRTSPMessage
50 * @close: close the connection
51 * @user_data: user data when registering the callback
53 * This callback is called when @client wants to send @message. When @close is
54 * %TRUE, the connection should be closed when the message has been sent.
56 * Returns: %TRUE on success.
58 typedef gboolean (*GstRTSPClientSendFunc) (GstRTSPClient *client,
59 GstRTSPMessage *message,
66 * The client object represents the connection and its state with a client.
68 struct _GstRTSPClient {
71 GstRTSPClientPrivate *priv;
76 * @create_sdp: called when the SDP needs to be created for media.
77 * @configure_client_transport: called when the client transport needs to be
79 * @params_set: set parameters. This function should also initialize the
80 * RTSP response(ctx->response) via a call to gst_rtsp_message_init_response()
81 * @params_get: get parameters. This function should also initialize the
82 * RTSP response(ctx->response) via a call to gst_rtsp_message_init_response()
84 * The client class structure.
86 struct _GstRTSPClientClass {
87 GObjectClass parent_class;
89 GstSDPMessage * (*create_sdp) (GstRTSPClient *client, GstRTSPMedia *media);
90 gboolean (*configure_client_transport) (GstRTSPClient * client,
92 GstRTSPTransport * ct);
93 GstRTSPResult (*params_set) (GstRTSPClient *client, GstRTSPContext *ctx);
94 GstRTSPResult (*params_get) (GstRTSPClient *client, GstRTSPContext *ctx);
97 void (*closed) (GstRTSPClient *client);
98 void (*new_session) (GstRTSPClient *client, GstRTSPSession *session);
99 void (*options_request) (GstRTSPClient *client, GstRTSPContext *ctx);
100 void (*describe_request) (GstRTSPClient *client, GstRTSPContext *ctx);
101 void (*setup_request) (GstRTSPClient *client, GstRTSPContext *ctx);
102 void (*play_request) (GstRTSPClient *client, GstRTSPContext *ctx);
103 void (*pause_request) (GstRTSPClient *client, GstRTSPContext *ctx);
104 void (*teardown_request) (GstRTSPClient *client, GstRTSPContext *ctx);
105 void (*set_parameter_request) (GstRTSPClient *client, GstRTSPContext *ctx);
106 void (*get_parameter_request) (GstRTSPClient *client, GstRTSPContext *ctx);
109 GType gst_rtsp_client_get_type (void);
111 GstRTSPClient * gst_rtsp_client_new (void);
113 void gst_rtsp_client_set_session_pool (GstRTSPClient *client,
114 GstRTSPSessionPool *pool);
115 GstRTSPSessionPool * gst_rtsp_client_get_session_pool (GstRTSPClient *client);
117 void gst_rtsp_client_set_mount_points (GstRTSPClient *client,
118 GstRTSPMountPoints *mounts);
119 GstRTSPMountPoints * gst_rtsp_client_get_mount_points (GstRTSPClient *client);
121 void gst_rtsp_client_set_auth (GstRTSPClient *client, GstRTSPAuth *auth);
122 GstRTSPAuth * gst_rtsp_client_get_auth (GstRTSPClient *client);
124 void gst_rtsp_client_set_thread_pool (GstRTSPClient *client, GstRTSPThreadPool *pool);
125 GstRTSPThreadPool * gst_rtsp_client_get_thread_pool (GstRTSPClient *client);
127 gboolean gst_rtsp_client_set_connection (GstRTSPClient *client, GstRTSPConnection *conn);
128 GstRTSPConnection * gst_rtsp_client_get_connection (GstRTSPClient *client);
130 guint gst_rtsp_client_attach (GstRTSPClient *client,
131 GMainContext *context);
133 void gst_rtsp_client_set_send_func (GstRTSPClient *client,
134 GstRTSPClientSendFunc func,
136 GDestroyNotify notify);
138 GstRTSPResult gst_rtsp_client_handle_message (GstRTSPClient *client,
139 GstRTSPMessage *message);
140 GstRTSPResult gst_rtsp_client_send_message (GstRTSPClient * client,
141 GstRTSPSession *session,
142 GstRTSPMessage *message);
144 * GstRTSPClientSessionFilterFunc:
145 * @client: a #GstRTSPClient object
146 * @sess: a #GstRTSPSession in @client
147 * @user_data: user data that has been given to gst_rtsp_client_session_filter()
149 * This function will be called by the gst_rtsp_client_session_filter(). An
150 * implementation should return a value of #GstRTSPFilterResult.
152 * When this function returns #GST_RTSP_FILTER_REMOVE, @sess will be removed
155 * A return value of #GST_RTSP_FILTER_KEEP will leave @sess untouched in
158 * A value of #GST_RTSP_FILTER_REF will add @sess to the result #GList of
159 * gst_rtsp_client_session_filter().
161 * Returns: a #GstRTSPFilterResult.
163 typedef GstRTSPFilterResult (*GstRTSPClientSessionFilterFunc) (GstRTSPClient *client,
164 GstRTSPSession *sess,
167 GList * gst_rtsp_client_session_filter (GstRTSPClient *client,
168 GstRTSPClientSessionFilterFunc func,
175 #endif /* __GST_RTSP_CLIENT_H__ */