rtsp-client: vmethod for modifying tunnel GET response
[platform/upstream/gstreamer.git] / gst / rtsp-server / rtsp-client.h
index ddb04e9..01f8208 100644 (file)
@@ -27,15 +27,12 @@ G_BEGIN_DECLS
 
 typedef struct _GstRTSPClient GstRTSPClient;
 typedef struct _GstRTSPClientClass GstRTSPClientClass;
-typedef struct _GstRTSPClientState GstRTSPClientState;
 typedef struct _GstRTSPClientPrivate GstRTSPClientPrivate;
 
-#include "rtsp-media.h"
+#include "rtsp-context.h"
 #include "rtsp-mount-points.h"
-#include "rtsp-session-pool.h"
-#include "rtsp-session-media.h"
-#include "rtsp-auth.h"
 #include "rtsp-sdp.h"
+#include "rtsp-auth.h"
 
 #define GST_TYPE_RTSP_CLIENT              (gst_rtsp_client_get_type ())
 #define GST_IS_RTSP_CLIENT(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_CLIENT))
@@ -47,32 +44,6 @@ typedef struct _GstRTSPClientPrivate GstRTSPClientPrivate;
 #define GST_RTSP_CLIENT_CLASS_CAST(klass) ((GstRTSPClientClass*)(klass))
 
 /**
- * GstRTSPClientState:
- * @request: the complete request
- * @uri: the complete url parsed from @request
- * @method: the parsed method of @uri
- * @session: the session, can be NULL
- * @sessmedia: the session media for the url can be NULL
- * @factory: the media factory for the url, can be NULL.
- * @media: the media for the url can be NULL
- * @stream: the stream for the url can be NULL
- * @response: the response
- *
- * Information passed around containing the client state of a request.
- */
-struct _GstRTSPClientState {
-  GstRTSPMessage      *request;
-  GstRTSPUrl          *uri;
-  GstRTSPMethod        method;
-  GstRTSPSession      *session;
-  GstRTSPSessionMedia *sessmedia;
-  GstRTSPMediaFactory *factory;
-  GstRTSPMedia        *media;
-  GstRTSPStream       *stream;
-  GstRTSPMessage      *response;
-};
-
-/**
  * GstRTSPClientSendFunc:
  * @client: a #GstRTSPClient
  * @message: a #GstRTSPMessage
@@ -92,30 +63,64 @@ typedef gboolean (*GstRTSPClientSendFunc)      (GstRTSPClient *client,
 /**
  * GstRTSPClient:
  *
- * The client structure.
+ * The client object represents the connection and its state with a client.
  */
 struct _GstRTSPClient {
   GObject       parent;
 
+  /*< private >*/
   GstRTSPClientPrivate *priv;
+  gpointer _gst_reserved[GST_PADDING];
 };
 
+/**
+ * GstRTSPClientClass:
+ * @create_sdp: called when the SDP needs to be created for media.
+ * @configure_client_media: called when the stream in media needs to be configured.
+ *    The default implementation will configure the blocksize on the payloader when
+ *    spcified in the request headers.
+ * @configure_client_transport: called when the client transport needs to be
+ *    configured.
+ * @params_set: set parameters. This function should also initialize the
+ *    RTSP response(ctx->response) via a call to gst_rtsp_message_init_response()
+ * @params_get: get parameters. This function should also initialize the
+ *    RTSP response(ctx->response) via a call to gst_rtsp_message_init_response()
+ * @tunnel_http_response: called when a response to the GET request is about to
+ *   be sent for a tunneled connection. The response can be modified. Since 1.4
+ *
+ * The client class structure.
+ */
 struct _GstRTSPClientClass {
   GObjectClass  parent_class;
 
   GstSDPMessage * (*create_sdp) (GstRTSPClient *client, GstRTSPMedia *media);
+  gboolean        (*configure_client_media)     (GstRTSPClient * client,
+                                                 GstRTSPMedia * media, GstRTSPStream * stream,
+                                                 GstRTSPContext * ctx);
+  gboolean        (*configure_client_transport) (GstRTSPClient * client,
+                                                 GstRTSPContext * ctx,
+                                                 GstRTSPTransport * ct);
+  GstRTSPResult   (*params_set) (GstRTSPClient *client, GstRTSPContext *ctx);
+  GstRTSPResult   (*params_get) (GstRTSPClient *client, GstRTSPContext *ctx);
+  gchar *         (*make_path_from_uri) (GstRTSPClient *client, const GstRTSPUrl *uri);
 
   /* signals */
   void     (*closed)                  (GstRTSPClient *client);
   void     (*new_session)             (GstRTSPClient *client, GstRTSPSession *session);
-  void     (*options_request)         (GstRTSPClient *client, GstRTSPClientState *state);
-  void     (*describe_request)        (GstRTSPClient *client, GstRTSPClientState *state);
-  void     (*setup_request)           (GstRTSPClient *client, GstRTSPClientState *state);
-  void     (*play_request)            (GstRTSPClient *client, GstRTSPClientState *state);
-  void     (*pause_request)           (GstRTSPClient *client, GstRTSPClientState *state);
-  void     (*teardown_request)        (GstRTSPClient *client, GstRTSPClientState *state);
-  void     (*set_parameter_request)   (GstRTSPClient *client, GstRTSPClientState *state);
-  void     (*get_parameter_request)   (GstRTSPClient *client, GstRTSPClientState *state);
+  void     (*options_request)         (GstRTSPClient *client, GstRTSPContext *ctx);
+  void     (*describe_request)        (GstRTSPClient *client, GstRTSPContext *ctx);
+  void     (*setup_request)           (GstRTSPClient *client, GstRTSPContext *ctx);
+  void     (*play_request)            (GstRTSPClient *client, GstRTSPContext *ctx);
+  void     (*pause_request)           (GstRTSPClient *client, GstRTSPContext *ctx);
+  void     (*teardown_request)        (GstRTSPClient *client, GstRTSPContext *ctx);
+  void     (*set_parameter_request)   (GstRTSPClient *client, GstRTSPContext *ctx);
+  void     (*get_parameter_request)   (GstRTSPClient *client, GstRTSPContext *ctx);
+  void     (*handle_response)         (GstRTSPClient *client, GstRTSPContext *ctx);
+
+  void     (*tunnel_http_response)    (GstRTSPClient * client, GstRTSPMessage * request,
+                                       GstRTSPMessage * response);
+  /*< private >*/
+  gpointer _gst_reserved[GST_PADDING_LARGE-1];
 };
 
 GType                 gst_rtsp_client_get_type          (void);
@@ -130,36 +135,56 @@ void                  gst_rtsp_client_set_mount_points  (GstRTSPClient *client,
                                                          GstRTSPMountPoints *mounts);
 GstRTSPMountPoints *  gst_rtsp_client_get_mount_points  (GstRTSPClient *client);
 
-void                  gst_rtsp_client_set_use_client_settings (GstRTSPClient * client,
-                                                               gboolean use_client_settings);
-gboolean              gst_rtsp_client_get_use_client_settings (GstRTSPClient * client);
-
 void                  gst_rtsp_client_set_auth          (GstRTSPClient *client, GstRTSPAuth *auth);
 GstRTSPAuth *         gst_rtsp_client_get_auth          (GstRTSPClient *client);
 
-GstRTSPUrl *          gst_rtsp_client_get_uri           (GstRTSPClient *client);
+void                  gst_rtsp_client_set_thread_pool   (GstRTSPClient *client, GstRTSPThreadPool *pool);
+GstRTSPThreadPool *   gst_rtsp_client_get_thread_pool   (GstRTSPClient *client);
+
+gboolean              gst_rtsp_client_set_connection    (GstRTSPClient *client, GstRTSPConnection *conn);
+GstRTSPConnection *   gst_rtsp_client_get_connection    (GstRTSPClient *client);
+
+guint                 gst_rtsp_client_attach            (GstRTSPClient *client,
+                                                         GMainContext *context);
 
 void                  gst_rtsp_client_set_send_func     (GstRTSPClient *client,
                                                          GstRTSPClientSendFunc func,
                                                          gpointer user_data,
                                                          GDestroyNotify notify);
+
 GstRTSPResult         gst_rtsp_client_handle_message    (GstRTSPClient *client,
                                                          GstRTSPMessage *message);
+GstRTSPResult         gst_rtsp_client_send_message      (GstRTSPClient * client,
+                                                         GstRTSPSession *session,
+                                                         GstRTSPMessage *message);
+/**
+ * GstRTSPClientSessionFilterFunc:
+ * @client: a #GstRTSPClient object
+ * @sess: a #GstRTSPSession in @client
+ * @user_data: user data that has been given to gst_rtsp_client_session_filter()
+ *
+ * This function will be called by the gst_rtsp_client_session_filter(). An
+ * implementation should return a value of #GstRTSPFilterResult.
+ *
+ * When this function returns #GST_RTSP_FILTER_REMOVE, @sess will be removed
+ * from @client.
+ *
+ * A return value of #GST_RTSP_FILTER_KEEP will leave @sess untouched in
+ * @client.
+ *
+ * A value of #GST_RTSP_FILTER_REF will add @sess to the result #GList of
+ * gst_rtsp_client_session_filter().
+ *
+ * Returns: a #GstRTSPFilterResult.
+ */
+typedef GstRTSPFilterResult (*GstRTSPClientSessionFilterFunc)  (GstRTSPClient *client,
+                                                                GstRTSPSession *sess,
+                                                                gpointer user_data);
 
-gboolean              gst_rtsp_client_accept            (GstRTSPClient *client,
-                                                         GSocket *socket,
-                                                         GCancellable *cancellable,
-                                                         GError **error);
-
-gboolean              gst_rtsp_client_use_socket        (GstRTSPClient * client,
-                                                         GSocket *socket,
-                                                         const gchar * ip,
-                                                         gint port,
-                                                         const gchar *initial_buffer,
-                                                         GError **error);
+GList *                gst_rtsp_client_session_filter    (GstRTSPClient *client,
+                                                          GstRTSPClientSessionFilterFunc func,
+                                                          gpointer user_data);
 
-guint                 gst_rtsp_client_attach            (GstRTSPClient *client,
-                                                         GMainContext *context);
 
 
 G_END_DECLS