git.maemo.org Git - mafwsubrenderer/blob - gst-plugins-base-subtitles0.10/gst-libs/gst/rtsp/gstrtspconnection.h

   1 /* GStreamer
   2  * Copyright (C) <2005,2009> Wim Taymans <wim.taymans@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  * Unless otherwise indicated, Source Code is licensed under MIT license.
  21  * See further explanation attached in License Statement (distributed in the file
  22  * LICENSE).
  23  *
  24  * Permission is hereby granted, free of charge, to any person obtaining a copy of
  25  * this software and associated documentation files (the "Software"), to deal in
  26  * the Software without restriction, including without limitation the rights to
  27  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  28  * of the Software, and to permit persons to whom the Software is furnished to do
  29  * so, subject to the following conditions:
  30  *
  31  * The above copyright notice and this permission notice shall be included in all
  32  * copies or substantial portions of the Software.
  33  *
  34  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  35  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  36  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  37  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  38  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  39  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  40  * SOFTWARE.
  41  */
  42
  43 #ifndef __GST_RTSP_CONNECTION_H__
  44 #define __GST_RTSP_CONNECTION_H__
  45
  46 #include <glib.h>
  47
  48 #include <gst/gstconfig.h>
  49 #include <gst/rtsp/gstrtspdefs.h>
  50 #include <gst/rtsp/gstrtspurl.h>
  51 #include <gst/rtsp/gstrtspmessage.h>
  52
  53 G_BEGIN_DECLS
  54
  55 /**
  56  * GstRTSPConnection:
  57  *
  58  * Opaque RTSP connection object.
  59  */
  60 typedef struct _GstRTSPConnection GstRTSPConnection;
  61
  62 /* opening/closing a connection */
  63 GstRTSPResult      gst_rtsp_connection_create        (const GstRTSPUrl *url, GstRTSPConnection **conn);
  64 GstRTSPResult      gst_rtsp_connection_create_from_fd (gint fd,
  65                                                        const gchar * ip,
  66                                                        guint16 port,
  67                                                        const gchar * initial_buffer,
  68                                                        GstRTSPConnection ** conn);
  69 GstRTSPResult      gst_rtsp_connection_accept        (gint sock, GstRTSPConnection **conn);
  70 GstRTSPResult      gst_rtsp_connection_connect       (GstRTSPConnection *conn, GTimeVal *timeout);
  71 GstRTSPResult      gst_rtsp_connection_close         (GstRTSPConnection *conn);
  72 GstRTSPResult      gst_rtsp_connection_free          (GstRTSPConnection *conn);
  73
  74
  75 /* sending/receiving raw bytes */
  76 GstRTSPResult      gst_rtsp_connection_read          (GstRTSPConnection * conn, guint8 * data,
  77                                                       guint size, GTimeVal * timeout);
  78 GstRTSPResult      gst_rtsp_connection_write         (GstRTSPConnection * conn, const guint8 * data,
  79                                                       guint size, GTimeVal * timeout);
  80
  81 /* sending/receiving messages */
  82 GstRTSPResult      gst_rtsp_connection_send          (GstRTSPConnection *conn, GstRTSPMessage *message,
  83                                                       GTimeVal *timeout);
  84 GstRTSPResult      gst_rtsp_connection_receive       (GstRTSPConnection *conn, GstRTSPMessage *message,
  85                                                       GTimeVal *timeout);
  86
  87 /* status management */
  88 GstRTSPResult      gst_rtsp_connection_poll          (GstRTSPConnection *conn, GstRTSPEvent events,
  89                                                       GstRTSPEvent *revents, GTimeVal *timeout);
  90
  91 /* reset the timeout */
  92 GstRTSPResult      gst_rtsp_connection_next_timeout  (GstRTSPConnection *conn, GTimeVal *timeout);
  93 GstRTSPResult      gst_rtsp_connection_reset_timeout (GstRTSPConnection *conn);
  94
  95 /* flushing state */
  96 GstRTSPResult      gst_rtsp_connection_flush         (GstRTSPConnection *conn, gboolean flush);
  97
  98 /* HTTP proxy support */
  99 GstRTSPResult      gst_rtsp_connection_set_proxy     (GstRTSPConnection *conn,
 100                                                       const gchar *host, guint port);
 101
 102 /* configure authentication data */
 103 GstRTSPResult      gst_rtsp_connection_set_auth      (GstRTSPConnection *conn, GstRTSPAuthMethod method,
 104                                                       const gchar *user, const gchar *pass);
 105
 106 void               gst_rtsp_connection_set_auth_param    (GstRTSPConnection *conn,
 107                                                           const gchar * param,
 108                                                           const gchar *value);
 109 void               gst_rtsp_connection_clear_auth_params (GstRTSPConnection *conn);
 110
 111 /* configure DSCP */
 112 GstRTSPResult      gst_rtsp_connection_set_qos_dscp  (GstRTSPConnection *conn,
 113                                                       guint qos_dscp);
 114
 115 /* accessors */
 116 GstRTSPUrl *       gst_rtsp_connection_get_url       (const GstRTSPConnection *conn);
 117 const gchar *      gst_rtsp_connection_get_ip        (const GstRTSPConnection *conn);
 118 void               gst_rtsp_connection_set_ip        (GstRTSPConnection *conn, const gchar *ip);
 119
 120 gint               gst_rtsp_connection_get_readfd    (const GstRTSPConnection *conn);
 121 gint               gst_rtsp_connection_get_writefd   (const GstRTSPConnection *conn);
 122
 123 void               gst_rtsp_connection_set_http_mode (GstRTSPConnection *conn,
 124                                                       gboolean enable);
 125
 126 /* tunneling */
 127 void               gst_rtsp_connection_set_tunneled  (GstRTSPConnection *conn, gboolean tunneled);
 128 gboolean           gst_rtsp_connection_is_tunneled   (const GstRTSPConnection *conn);
 129
 130 const gchar *      gst_rtsp_connection_get_tunnelid  (const GstRTSPConnection *conn);
 131 GstRTSPResult      gst_rtsp_connection_do_tunnel     (GstRTSPConnection *conn, GstRTSPConnection *conn2);
 132
 133 /* async IO */
 134
 135 /**
 136  * GstRTSPWatch:
 137  *
 138  * Opaque RTSP watch object that can be used for asynchronous RTSP
 139  * operations.
 140  */
 141 typedef struct _GstRTSPWatch GstRTSPWatch;
 142
 143 /**
 144  * GstRTSPWatchFuncs:
 145  * @message_received: callback when a message was received
 146  * @message_sent: callback when a message was sent
 147  * @closed: callback when the connection is closed
 148  * @error: callback when an error occured
 149  * @tunnel_start: a client started a tunneled connection. The tunnelid of the
 150  *   connection must be saved.
 151  * @tunnel_complete: a client finished a tunneled connection. In this callback
 152  *   you usually pair the tunnelid of this connection with the saved one using
 153  *   gst_rtsp_connection_do_tunnel().
 154  * @error_full: callback when an error occured with more information than
 155  *   the @error callback. Since 0.10.25
 156  * @tunnel_lost: callback when the post connection of a tunnel is closed.
 157  *   Since 0.10.29
 158  *
 159  * Callback functions from a #GstRTSPWatch.
 160  *
 161  * Since: 0.10.23
 162  */
 163 typedef struct {
 164   GstRTSPResult     (*message_received) (GstRTSPWatch *watch, GstRTSPMessage *message,
 165                                          gpointer user_data);
 166   GstRTSPResult     (*message_sent)     (GstRTSPWatch *watch, guint id,
 167                                          gpointer user_data);
 168   GstRTSPResult     (*closed)           (GstRTSPWatch *watch, gpointer user_data);
 169   GstRTSPResult     (*error)            (GstRTSPWatch *watch, GstRTSPResult result,
 170                                          gpointer user_data);
 171   GstRTSPStatusCode (*tunnel_start)     (GstRTSPWatch *watch, gpointer user_data);
 172   GstRTSPResult     (*tunnel_complete)  (GstRTSPWatch *watch, gpointer user_data);
 173   GstRTSPResult     (*error_full)       (GstRTSPWatch *watch, GstRTSPResult result,
 174                                          GstRTSPMessage *message, guint id,
 175                                          gpointer user_data);
 176   GstRTSPResult     (*tunnel_lost)      (GstRTSPWatch *watch, gpointer user_data);
 177
 178   /*< private >*/
 179   gpointer _gst_reserved[GST_PADDING - 2];
 180 } GstRTSPWatchFuncs;
 181
 182 GstRTSPWatch *     gst_rtsp_watch_new                (GstRTSPConnection *conn,
 183                                                       GstRTSPWatchFuncs *funcs,
 184                                                       gpointer user_data,
 185                                                       GDestroyNotify notify);
 186 void               gst_rtsp_watch_reset              (GstRTSPWatch *watch);
 187 void               gst_rtsp_watch_unref              (GstRTSPWatch *watch);
 188
 189 guint              gst_rtsp_watch_attach             (GstRTSPWatch *watch,
 190                                                       GMainContext *context);
 191
 192 GstRTSPResult      gst_rtsp_watch_write_data         (GstRTSPWatch *watch,
 193                                                       const guint8 *data,
 194                                                       guint size, guint *id);
 195 GstRTSPResult      gst_rtsp_watch_send_message       (GstRTSPWatch *watch,
 196                                                       GstRTSPMessage *message,
 197                                                       guint *id);
 198
 199 #ifndef GST_DISABLE_DEPRECATED
 200 guint              gst_rtsp_watch_queue_data         (GstRTSPWatch * watch,
 201                                                       const guint8 * data,
 202                                                       guint size);
 203 guint              gst_rtsp_watch_queue_message      (GstRTSPWatch *watch,
 204                                                       GstRTSPMessage *message);
 205 #endif
 206
 207 G_END_DECLS
 208
 209 #endif /* __GST_RTSP_CONNECTION_H__ */