rtsp: massive refactoring
[platform/upstream/gstreamer.git] / gst / rtsp-server / rtsp-client.h
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., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 #include <gst/gst.h>
21 #include <gst/rtsp/gstrtspconnection.h>
22
23 #ifndef __GST_RTSP_CLIENT_H__
24 #define __GST_RTSP_CLIENT_H__
25
26 G_BEGIN_DECLS
27
28 typedef struct _GstRTSPClient GstRTSPClient;
29 typedef struct _GstRTSPClientClass GstRTSPClientClass;
30 typedef struct _GstRTSPClientState GstRTSPClientState;
31
32 #include "rtsp-server.h"
33 #include "rtsp-media.h"
34 #include "rtsp-media-mapping.h"
35 #include "rtsp-session-pool.h"
36 #include "rtsp-session-media.h"
37 #include "rtsp-auth.h"
38 #include "rtsp-sdp.h"
39
40 #define GST_TYPE_RTSP_CLIENT              (gst_rtsp_client_get_type ())
41 #define GST_IS_RTSP_CLIENT(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_CLIENT))
42 #define GST_IS_RTSP_CLIENT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_CLIENT))
43 #define GST_RTSP_CLIENT_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_CLIENT, GstRTSPClientClass))
44 #define GST_RTSP_CLIENT(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_CLIENT, GstRTSPClient))
45 #define GST_RTSP_CLIENT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_CLIENT, GstRTSPClientClass))
46 #define GST_RTSP_CLIENT_CAST(obj)         ((GstRTSPClient*)(obj))
47 #define GST_RTSP_CLIENT_CLASS_CAST(klass) ((GstRTSPClientClass*)(klass))
48
49 /**
50  * GstRTSPClientState:
51  * @request: the complete request
52  * @uri: the complete url parsed from @request
53  * @method: the parsed method of @uri
54  * @session: the session, can be NULL
55  * @sessmedia: the session media for the url can be NULL
56  * @factory: the media factory for the url, can be NULL.
57  * @media: the session media for the url can be NULL
58  * @response: the response
59  *
60  * Information passed around containing the client state of a request.
61  */
62 struct _GstRTSPClientState {
63   GstRTSPMessage      *request;
64   GstRTSPUrl          *uri;
65   GstRTSPMethod        method;
66   GstRTSPSession      *session;
67   GstRTSPSessionMedia *sessmedia;
68   GstRTSPMediaFactory *factory;
69   GstRTSPMedia        *media;
70   GstRTSPMessage      *response;
71 };
72
73 /**
74  * GstRTSPClient:
75  *
76  * @connection: the connection object handling the client request.
77  * @watch: watch for the connection
78  * @watchid: id of the watch
79  * @ip: ip address used by the client to connect to us
80  * @use_client_settings: whether to allow client transport settings for multicast
81  * @session_pool: handle to the session pool used by the client.
82  * @media_mapping: handle to the media mapping used by the client.
83  * @uri: cached uri
84  * @media: cached media
85  * @transports: a list of #GstRTSPStreamTransport using @connection.
86  * @sessions: a list of sessions managed by @connection.
87  *
88  * The client structure.
89  */
90 struct _GstRTSPClient {
91   GObject       parent;
92
93   GstRTSPConnection *connection;
94   GstRTSPWatch      *watch;
95   guint              watchid;
96   gchar             *server_ip;
97   gboolean           is_ipv6;
98   gboolean           use_client_settings;
99
100   GstRTSPServer        *server;
101   GstRTSPSessionPool   *session_pool;
102   GstRTSPMediaMapping  *media_mapping;
103   GstRTSPAuth          *auth;
104
105   GstRTSPUrl     *uri;
106   GstRTSPMedia   *media;
107
108   GList *transports;
109   GList *sessions;
110 };
111
112 struct _GstRTSPClientClass {
113   GObjectClass  parent_class;
114
115   GstSDPMessage * (*create_sdp) (GstRTSPClient *client, GstRTSPMedia *media);
116
117   /* signals */
118   void     (*closed)                  (GstRTSPClient *client);
119   void     (*new_session)             (GstRTSPClient *client, GstRTSPSession *session);
120   void     (*options_request)         (GstRTSPClient *client, GstRTSPClientState *state);
121   void     (*describe_request)        (GstRTSPClient *client, GstRTSPClientState *state);
122   void     (*setup_request)           (GstRTSPClient *client, GstRTSPClientState *state);
123   void     (*play_request)            (GstRTSPClient *client, GstRTSPClientState *state);
124   void     (*pause_request)           (GstRTSPClient *client, GstRTSPClientState *state);
125   void     (*teardown_request)        (GstRTSPClient *client, GstRTSPClientState *state);
126   void     (*set_parameter_request)   (GstRTSPClient *client, GstRTSPClientState *state);
127   void     (*get_parameter_request)   (GstRTSPClient *client, GstRTSPClientState *state);
128 };
129
130 GType                 gst_rtsp_client_get_type          (void);
131
132 GstRTSPClient *       gst_rtsp_client_new               (void);
133
134 void                  gst_rtsp_client_set_server        (GstRTSPClient * client, GstRTSPServer * server);
135 GstRTSPServer *       gst_rtsp_client_get_server        (GstRTSPClient * client);
136
137 void                  gst_rtsp_client_set_session_pool  (GstRTSPClient *client,
138                                                          GstRTSPSessionPool *pool);
139 GstRTSPSessionPool *  gst_rtsp_client_get_session_pool  (GstRTSPClient *client);
140
141 void                  gst_rtsp_client_set_media_mapping (GstRTSPClient *client,
142                                                          GstRTSPMediaMapping *mapping);
143 GstRTSPMediaMapping * gst_rtsp_client_get_media_mapping (GstRTSPClient *client);
144
145 void                  gst_rtsp_client_set_use_client_settings (GstRTSPClient * client,
146                                                                gboolean use_client_settings);
147 gboolean              gst_rtsp_client_get_use_client_settings (GstRTSPClient * client);
148
149 void                  gst_rtsp_client_set_auth          (GstRTSPClient *client, GstRTSPAuth *auth);
150 GstRTSPAuth *         gst_rtsp_client_get_auth          (GstRTSPClient *client);
151
152
153 gboolean              gst_rtsp_client_accept            (GstRTSPClient *client,
154                                                          GSocket *socket,
155                                                          GCancellable *cancellable,
156                                                          GError **error);
157
158 gboolean              gst_rtsp_client_create_from_socket(GstRTSPClient * client,
159                                                          GSocket *socket,
160                                                          const gchar * ip,
161                                                          gint port,
162                                                          const gchar *initial_buffer,
163                                                          GError **error);
164
165 G_END_DECLS
166
167 #endif /* __GST_RTSP_CLIENT_H__ */