git.sesse.net Git - vlc/blob - include/vlc_httpd.h

   1 /*****************************************************************************
   2  * vlc_httpd.h: builtin HTTP/RTSP server.
   3  *****************************************************************************
   4  * Copyright (C) 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef _VLC_HTTPD_H
  25 #define _VLC_HTTPD_H 1
  26
  27 /* NEVER touch that, it's here only because src/misc/objects.c
  28  * need sizeof(httpd_t) */
  29 struct httpd_t
  30 {
  31     VLC_COMMON_MEMBERS
  32
  33     int          i_host;
  34     httpd_host_t **host;
  35 };
  36
  37 enum
  38 {
  39     HTTPD_MSG_NONE,
  40
  41     /* answer */
  42     HTTPD_MSG_ANSWER,
  43
  44     /* channel communication */
  45     HTTPD_MSG_CHANNEL,
  46
  47     /* http request */
  48     HTTPD_MSG_GET,
  49     HTTPD_MSG_HEAD,
  50     HTTPD_MSG_POST,
  51
  52     /* rtsp request */
  53     HTTPD_MSG_OPTIONS,
  54     HTTPD_MSG_DESCRIBE,
  55     HTTPD_MSG_SETUP,
  56     HTTPD_MSG_PLAY,
  57     HTTPD_MSG_PAUSE,
  58     HTTPD_MSG_GETPARAMETER,
  59     HTTPD_MSG_TEARDOWN,
  60
  61     /* just to track the count of MSG */
  62     HTTPD_MSG_MAX
  63 };
  64
  65 /* each host run in his own thread */
  66 struct httpd_host_t
  67 {
  68     VLC_COMMON_MEMBERS
  69
  70     httpd_t     *httpd;
  71
  72     /* ref count */
  73     int         i_ref;
  74
  75     /* address/port and socket for listening at connections */
  76     char        *psz_hostname;
  77     int         i_port;
  78     int         *fd;
  79
  80     /* Statistics */
  81     counter_t *p_active_counter;
  82     counter_t *p_total_counter;
  83
  84     vlc_mutex_t lock;
  85
  86     /* all registered url (becarefull that 2 httpd_url_t could point at the same url)
  87      * This will slow down the url research but make my live easier
  88      * All url will have their cb trigger, but only the first one can answer
  89      * */
  90     int         i_url;
  91     httpd_url_t **url;
  92
  93     int            i_client;
  94     httpd_client_t **client;
  95
  96     /* TLS data */
  97     tls_server_t *p_tls;
  98 };
  99
 100
 101
 102 enum
 103 {
 104     HTTPD_PROTO_NONE,
 105     HTTPD_PROTO_HTTP,
 106     HTTPD_PROTO_RTSP,
 107 };
 108
 109 struct httpd_message_t
 110 {
 111     httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */
 112
 113     int     i_type;
 114     int     i_proto;
 115     int     i_version;
 116
 117     /* for an answer */
 118     int     i_status;
 119     char    *psz_status;
 120
 121     /* for a query */
 122     char    *psz_url;
 123     /* FIXME find a clean way to handle GET(psz_args)
 124        and POST(body) through the same code */
 125     uint8_t *psz_args;
 126
 127     /* for rtp over rtsp */
 128     int     i_channel;
 129
 130     /* options */
 131     int     i_name;
 132     char    **name;
 133     int     i_value;
 134     char    **value;
 135
 136     /* body */
 137     int64_t i_body_offset;
 138     int     i_body;
 139     uint8_t *p_body;
 140
 141 };
 142
 143 /* create a new host */
 144 VLC_EXPORT( httpd_host_t *, httpd_HostNew, ( vlc_object_t *, const char *psz_host, int i_port ) );
 145 VLC_EXPORT( httpd_host_t *, httpd_TLSHostNew, ( vlc_object_t *, const char *, int, const char *, const char *, const char *, const char * ) );
 146
 147 /* delete a host */
 148 VLC_EXPORT( void,           httpd_HostDelete, ( httpd_host_t * ) );
 149
 150 /* register a new url */
 151 VLC_EXPORT( httpd_url_t *,  httpd_UrlNew, ( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl ) );
 152 VLC_EXPORT( httpd_url_t *,  httpd_UrlNewUnique, ( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl ) );
 153 /* register callback on a url */
 154 VLC_EXPORT( int,            httpd_UrlCatch, ( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * ) );
 155 /* delete an url */
 156 VLC_EXPORT( void,           httpd_UrlDelete, ( httpd_url_t * ) );
 157
 158 /* Default client mode is FILE, use these to change it */
 159 VLC_EXPORT( void,           httpd_ClientModeStream, ( httpd_client_t *cl ) );
 160 VLC_EXPORT( void,           httpd_ClientModeBidir, ( httpd_client_t *cl ) );
 161 VLC_EXPORT( char*,          httpd_ClientIP, ( const httpd_client_t *cl, char *psz_ip ) );
 162 VLC_EXPORT( char*,          httpd_ServerIP, ( const httpd_client_t *cl, char *psz_ip ) );
 163
 164 /* High level */
 165
 166 VLC_EXPORT( httpd_file_t *, httpd_FileNew, ( httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl, httpd_file_callback_t pf_fill, httpd_file_sys_t * ) );
 167 VLC_EXPORT( void,           httpd_FileDelete, ( httpd_file_t * ) );
 168
 169
 170 VLC_EXPORT( httpd_handler_t *, httpd_HandlerNew, ( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl, httpd_handler_callback_t pf_fill, httpd_handler_sys_t * ) );
 171 VLC_EXPORT( void,           httpd_HandlerDelete, ( httpd_handler_t * ) );
 172
 173
 174 VLC_EXPORT( httpd_redirect_t *, httpd_RedirectNew, ( httpd_host_t *, const char *psz_url_dst, const char *psz_url_src ) );
 175 VLC_EXPORT( void,               httpd_RedirectDelete, ( httpd_redirect_t * ) );
 176
 177
 178 VLC_EXPORT( httpd_stream_t *, httpd_StreamNew,    ( httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl ) );
 179 VLC_EXPORT( void,             httpd_StreamDelete, ( httpd_stream_t * ) );
 180 VLC_EXPORT( int,              httpd_StreamHeader, ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
 181 VLC_EXPORT( int,              httpd_StreamSend,   ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
 182
 183
 184 /* Msg functions facilities */
 185 VLC_EXPORT( void,         httpd_MsgInit, ( httpd_message_t * )  );
 186 VLC_EXPORT( void,         httpd_MsgAdd, ( httpd_message_t *, char *psz_name, char *psz_value, ... ) );
 187 /* return "" if not found. The string is not allocated */
 188 VLC_EXPORT( char *,       httpd_MsgGet, ( httpd_message_t *, char *psz_name ) );
 189 VLC_EXPORT( void,         httpd_MsgClean, ( httpd_message_t * ) );
 190
 191 #endif /* _VLC_HTTPD_H */