gst/rtsp-server/rtsp-server.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 #ifndef __GST_RTSP_SERVER_H__
  21 #define __GST_RTSP_SERVER_H__
  22
  23 #include <gst/gst.h>
  24
  25 G_BEGIN_DECLS
  26
  27 typedef struct _GstRTSPServer GstRTSPServer;
  28 typedef struct _GstRTSPServerClass GstRTSPServerClass;
  29
  30 #include "rtsp-session-pool.h"
  31 #include "rtsp-media-mapping.h"
  32 #include "rtsp-media-factory-uri.h"
  33 #include "rtsp-client.h"
  34 #include "rtsp-auth.h"
  35
  36 #define GST_TYPE_RTSP_SERVER              (gst_rtsp_server_get_type ())
  37 #define GST_IS_RTSP_SERVER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_SERVER))
  38 #define GST_IS_RTSP_SERVER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_SERVER))
  39 #define GST_RTSP_SERVER_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_SERVER, GstRTSPServerClass))
  40 #define GST_RTSP_SERVER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_SERVER, GstRTSPServer))
  41 #define GST_RTSP_SERVER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_SERVER, GstRTSPServerClass))
  42 #define GST_RTSP_SERVER_CAST(obj)         ((GstRTSPServer*)(obj))
  43 #define GST_RTSP_SERVER_CLASS_CAST(klass) ((GstRTSPServerClass*)(klass))
  44
  45 #define GST_RTSP_SERVER_GET_LOCK(server)  (&(GST_RTSP_SERVER_CAST(server)->lock))
  46 #define GST_RTSP_SERVER_LOCK(server)      (g_mutex_lock(GST_RTSP_SERVER_GET_LOCK(server)))
  47 #define GST_RTSP_SERVER_UNLOCK(server)    (g_mutex_unlock(GST_RTSP_SERVER_GET_LOCK(server)))
  48
  49 /**
  50  * GstRTSPServer:
  51  *
  52  * This object listens on a port, creates and manages the clients connected to
  53  * it.
  54  */
  55 struct _GstRTSPServer {
  56   GObject      parent;
  57
  58   GMutex       lock;
  59
  60   /* server information */
  61   gchar       *address;
  62   gchar       *service;
  63   gint         backlog;
  64
  65   GSocket     *socket;
  66
  67   /* sessions on this server */
  68   GstRTSPSessionPool  *session_pool;
  69
  70   /* media mapper for this server */
  71   GstRTSPMediaMapping *media_mapping;
  72
  73   /* authentication manager */
  74   GstRTSPAuth *auth;
  75
  76   /* the clients that are connected */
  77   GList   *clients;
  78 };
  79
  80 /**
  81  * GstRTSPServerClass:
  82  *
  83  * @create_client: Create, configure a new GstRTSPClient
  84  *          object that handles the new connection on @socket.
  85  * @accept_client: accept a new GstRTSPClient
  86  *
  87  * The RTSP server class structure
  88  */
  89 struct _GstRTSPServerClass {
  90   GObjectClass  parent_class;
  91
  92   GstRTSPClient * (*create_client)      (GstRTSPServer *server);
  93   gboolean        (*accept_client)      (GstRTSPServer *server, GstRTSPClient *client,
  94                                          GSocket *socket, GError **error);
  95   /* signals */
  96   void            (*client_connected)   (GstRTSPServer *server, GstRTSPClient *client);
  97 };
  98
  99 GType                 gst_rtsp_server_get_type             (void);
 100
 101 GstRTSPServer *       gst_rtsp_server_new                  (void);
 102
 103 void                  gst_rtsp_server_set_address          (GstRTSPServer *server, const gchar *address);
 104 gchar *               gst_rtsp_server_get_address          (GstRTSPServer *server);
 105
 106 void                  gst_rtsp_server_set_service          (GstRTSPServer *server, const gchar *service);
 107 gchar *               gst_rtsp_server_get_service          (GstRTSPServer *server);
 108
 109 int                   gst_rtsp_server_get_bound_port       (GstRTSPServer *server);
 110
 111 void                  gst_rtsp_server_set_backlog          (GstRTSPServer *server, gint backlog);
 112 gint                  gst_rtsp_server_get_backlog          (GstRTSPServer *server);
 113
 114 void                  gst_rtsp_server_set_session_pool     (GstRTSPServer *server, GstRTSPSessionPool *pool);
 115 GstRTSPSessionPool *  gst_rtsp_server_get_session_pool     (GstRTSPServer *server);
 116
 117 void                  gst_rtsp_server_set_media_mapping    (GstRTSPServer *server, GstRTSPMediaMapping *mapping);
 118 GstRTSPMediaMapping * gst_rtsp_server_get_media_mapping    (GstRTSPServer *server);
 119
 120 void                  gst_rtsp_server_set_auth             (GstRTSPServer *server, GstRTSPAuth *auth);
 121 GstRTSPAuth *         gst_rtsp_server_get_auth             (GstRTSPServer *server);
 122
 123 gboolean              gst_rtsp_server_transfer_connection  (GstRTSPServer * server, GSocket *socket,
 124                                                             const gchar * ip, gint port,
 125                                                             const gchar *initial_buffer);
 126
 127 gboolean              gst_rtsp_server_io_func              (GSocket *socket, GIOCondition condition,
 128                                                             GstRTSPServer *server);
 129
 130 GSocket *             gst_rtsp_server_create_socket        (GstRTSPServer *server,
 131                                                             GCancellable  *cancellable,
 132                                                             GError **error);
 133 GSource *             gst_rtsp_server_create_source        (GstRTSPServer *server,
 134                                                             GCancellable * cancellable,
 135                                                             GError **error);
 136 guint                 gst_rtsp_server_attach               (GstRTSPServer *server,
 137                                                             GMainContext *context);
 138
 139 G_END_DECLS
 140
 141 #endif /* __GST_RTSP_SERVER_H__ */