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., 59 Temple Place - Suite 330, Boston, MA  02111, 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_TEARDOWN,
  59
  60     /* just to track the count of MSG */
  61     HTTPD_MSG_MAX
  62 };
  63
  64 enum
  65 {
  66     HTTPD_PROTO_NONE,
  67     HTTPD_PROTO_HTTP,
  68     HTTPD_PROTO_RTSP,
  69 };
  70
  71 struct httpd_message_t
  72 {
  73     httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */
  74
  75     int     i_type;
  76     int     i_proto;
  77     int     i_version;
  78
  79     /* for an answer */
  80     int     i_status;
  81     char    *psz_status;
  82
  83     /* for a query */
  84     char    *psz_url;
  85     /* FIXME find a clean way to handle GET(psz_args)
  86        and POST(body) through the same code */
  87     uint8_t *psz_args;
  88
  89     /* for rtp over rtsp */
  90     int     i_channel;
  91
  92     /* options */
  93     int     i_name;
  94     char    **name;
  95     int     i_value;
  96     char    **value;
  97
  98     /* body */
  99     int64_t i_body_offset;
 100     int     i_body;
 101     uint8_t *p_body;
 102
 103 };
 104
 105 /* I keep the definition here, easier than looking at vlc_common.h
 106
 107  * answer could be null, int this case no answer is requested
 108 typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
 109 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
 110
 111 typedef struct httpd_file_t     httpd_file_t;
 112 typedef struct httpd_file_sys_t httpd_file_sys_t;
 113 typedef int (*httpd_file_callback_t)( httpd_file_sys_t*, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
 114 */
 115
 116 /* create a new host */
 117 VLC_EXPORT( httpd_host_t *, httpd_HostNew, ( vlc_object_t *, const char *psz_host, int i_port ) );
 118 VLC_EXPORT( httpd_host_t *, httpd_TLSHostNew, ( vlc_object_t *, const char *, int, const char *, const char *, const char *, const char * ) );
 119
 120 /* delete a host */
 121 VLC_EXPORT( void,           httpd_HostDelete, ( httpd_host_t * ) );
 122
 123 /* register a new url */
 124 VLC_EXPORT( httpd_url_t *,  httpd_UrlNew, ( httpd_host_t *, char *psz_url, char *psz_user, char *psz_password, const vlc_acl_t *p_acl ) );
 125 VLC_EXPORT( httpd_url_t *,  httpd_UrlNewUnique, ( httpd_host_t *, char *psz_url, char *psz_user, char *psz_password, const vlc_acl_t *p_acl ) );
 126 /* register callback on a url */
 127 VLC_EXPORT( int,            httpd_UrlCatch, ( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * ) );
 128 /* delete an url */
 129 VLC_EXPORT( void,           httpd_UrlDelete, ( httpd_url_t * ) );
 130
 131 /* Default client mode is FILE, use these to change it */
 132 VLC_EXPORT( void,           httpd_ClientModeStream, ( httpd_client_t *cl ) );
 133 VLC_EXPORT( void,           httpd_ClientModeBidir, ( httpd_client_t *cl ) );
 134 VLC_EXPORT( char*,          httpd_ClientIP, ( httpd_client_t *cl ) );
 135
 136 /* High level */
 137
 138 VLC_EXPORT( httpd_file_t *, httpd_FileNew, ( httpd_host_t *, char *psz_url, char *psz_mime, char *psz_user, char *psz_password, const vlc_acl_t *p_acl, httpd_file_callback_t pf_fill, httpd_file_sys_t * ) );
 139 VLC_EXPORT( void,           httpd_FileDelete, ( httpd_file_t * ) );
 140
 141
 142 VLC_EXPORT( httpd_redirect_t *, httpd_RedirectNew, ( httpd_host_t *, char *psz_url_dst, char *psz_url_src ) );
 143 VLC_EXPORT( void,               httpd_RedirectDelete, ( httpd_redirect_t * ) );
 144
 145
 146 VLC_EXPORT( httpd_stream_t *, httpd_StreamNew,    ( httpd_host_t *, char *psz_url, char *psz_mime, char *psz_user, char *psz_password, const vlc_acl_t *p_acl ) );
 147 VLC_EXPORT( void,             httpd_StreamDelete, ( httpd_stream_t * ) );
 148 VLC_EXPORT( int,              httpd_StreamHeader, ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
 149 VLC_EXPORT( int,              httpd_StreamSend,   ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
 150
 151
 152 /* Msg functions facilities */
 153 VLC_EXPORT( void,         httpd_MsgInit, ( httpd_message_t * )  );
 154 VLC_EXPORT( void,         httpd_MsgAdd, ( httpd_message_t *, char *psz_name, char *psz_value, ... ) );
 155 /* return "" if not found. The string is not allocated */
 156 VLC_EXPORT( char *,       httpd_MsgGet, ( httpd_message_t *, char *psz_name ) );
 157 VLC_EXPORT( void,         httpd_MsgClean, ( httpd_message_t * ) );
 158
 159 #endif /* _VLC_HTTPD_H */