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., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, 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 typedef struct _GstRTSPClientPrivate GstRTSPClientPrivate;
  32
  33 #include "rtsp-media.h"
  34 #include "rtsp-mount-points.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 media for the url can be NULL
  58  * @stream: the stream for the url can be NULL
  59  * @response: the response
  60  *
  61  * Information passed around containing the client state of a request.
  62  */
  63 struct _GstRTSPClientState {
  64   GstRTSPMessage      *request;
  65   GstRTSPUrl          *uri;
  66   GstRTSPMethod        method;
  67   GstRTSPSession      *session;
  68   GstRTSPSessionMedia *sessmedia;
  69   GstRTSPMediaFactory *factory;
  70   GstRTSPMedia        *media;
  71   GstRTSPStream       *stream;
  72   GstRTSPMessage      *response;
  73 };
  74
  75 /**
  76  * GstRTSPClientSendFunc:
  77  * @client: a #GstRTSPClient
  78  * @message: a #GstRTSPMessage
  79  * @close: close the connection
  80  * @user_data: user data when registering the callback
  81  *
  82  * This callback is called when @client wants to send @message. When @close is
  83  * %TRUE, the connection should be closed when the message has been sent.
  84  *
  85  * Returns: %TRUE on success.
  86  */
  87 typedef gboolean (*GstRTSPClientSendFunc)      (GstRTSPClient *client,
  88                                                 GstRTSPMessage *message,
  89                                                 gboolean close,
  90                                                 gpointer user_data);
  91
  92 /**
  93  * GstRTSPClient:
  94  *
  95  * The client structure.
  96  */
  97 struct _GstRTSPClient {
  98   GObject       parent;
  99
 100   GstRTSPClientPrivate *priv;
 101 };
 102
 103 /**
 104  * GstRTSPClientClass:
 105  * @params_set: set parameters. This function should also initialize the
 106  * RTSP response(state->response) via a call to gst_rtsp_message_init_response()
 107  * @params_get: get parameters. This function should also initialize the
 108  * RTSP response(state->response) via a call to gst_rtsp_message_init_response()
 109  *
 110  * The client class structure.
 111  */
 112 struct _GstRTSPClientClass {
 113   GObjectClass  parent_class;
 114
 115   GstSDPMessage * (*create_sdp) (GstRTSPClient *client, GstRTSPMedia *media);
 116   gboolean        (*configure_client_transport) (GstRTSPClient * client,
 117                                                  GstRTSPClientState * state,
 118                                                  GstRTSPTransport * ct);
 119   GstRTSPResult   (*params_set) (GstRTSPClient *client, GstRTSPClientState *state);
 120   GstRTSPResult   (*params_get) (GstRTSPClient *client, GstRTSPClientState *state);
 121
 122   /* signals */
 123   void     (*closed)                  (GstRTSPClient *client);
 124   void     (*new_session)             (GstRTSPClient *client, GstRTSPSession *session);
 125   void     (*options_request)         (GstRTSPClient *client, GstRTSPClientState *state);
 126   void     (*describe_request)        (GstRTSPClient *client, GstRTSPClientState *state);
 127   void     (*setup_request)           (GstRTSPClient *client, GstRTSPClientState *state);
 128   void     (*play_request)            (GstRTSPClient *client, GstRTSPClientState *state);
 129   void     (*pause_request)           (GstRTSPClient *client, GstRTSPClientState *state);
 130   void     (*teardown_request)        (GstRTSPClient *client, GstRTSPClientState *state);
 131   void     (*set_parameter_request)   (GstRTSPClient *client, GstRTSPClientState *state);
 132   void     (*get_parameter_request)   (GstRTSPClient *client, GstRTSPClientState *state);
 133 };
 134
 135 GType                 gst_rtsp_client_get_type          (void);
 136
 137 GstRTSPClient *       gst_rtsp_client_new               (void);
 138
 139 void                  gst_rtsp_client_set_session_pool  (GstRTSPClient *client,
 140                                                          GstRTSPSessionPool *pool);
 141 GstRTSPSessionPool *  gst_rtsp_client_get_session_pool  (GstRTSPClient *client);
 142
 143 void                  gst_rtsp_client_set_mount_points  (GstRTSPClient *client,
 144                                                          GstRTSPMountPoints *mounts);
 145 GstRTSPMountPoints *  gst_rtsp_client_get_mount_points  (GstRTSPClient *client);
 146
 147 void                  gst_rtsp_client_set_use_client_settings (GstRTSPClient * client,
 148                                                                gboolean use_client_settings);
 149 gboolean              gst_rtsp_client_get_use_client_settings (GstRTSPClient * client);
 150
 151 void                  gst_rtsp_client_set_auth          (GstRTSPClient *client, GstRTSPAuth *auth);
 152 GstRTSPAuth *         gst_rtsp_client_get_auth          (GstRTSPClient *client);
 153
 154 GstRTSPUrl *          gst_rtsp_client_get_uri           (GstRTSPClient *client);
 155
 156 gboolean              gst_rtsp_client_set_connection    (GstRTSPClient *client, GstRTSPConnection *conn);
 157 GstRTSPConnection *   gst_rtsp_client_get_connection    (GstRTSPClient *client);
 158
 159 void                  gst_rtsp_client_set_send_func     (GstRTSPClient *client,
 160                                                          GstRTSPClientSendFunc func,
 161                                                          gpointer user_data,
 162                                                          GDestroyNotify notify);
 163 GstRTSPResult         gst_rtsp_client_handle_message    (GstRTSPClient *client,
 164                                                          GstRTSPMessage *message);
 165
 166 GstRTSPResult         gst_rtsp_client_send_request      (GstRTSPClient * client,
 167                                                          GstRTSPSession *session,
 168                                                          GstRTSPMessage *request);
 169 guint                 gst_rtsp_client_attach            (GstRTSPClient *client,
 170                                                          GMainContext *context);
 171
 172
 173 G_END_DECLS
 174
 175 #endif /* __GST_RTSP_CLIENT_H__ */