include/vlc_httpd.h

   1 /*****************************************************************************
   2  * vlc_httpd.h: builtin HTTP/RTSP server.
   3  *****************************************************************************
   4  * Copyright (C) 2004-2006 VLC authors and VideoLAN
   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 it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * 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 /**
  28  * \file
  29  * HTTP/RTSP server API.
  30  */
  31
  32 enum
  33 {
  34     HTTPD_MSG_NONE,
  35
  36     /* answer */
  37     HTTPD_MSG_ANSWER,
  38
  39     /* http request */
  40     HTTPD_MSG_GET,
  41     HTTPD_MSG_HEAD,
  42     HTTPD_MSG_POST,
  43
  44     /* rtsp request */
  45     HTTPD_MSG_OPTIONS,
  46     HTTPD_MSG_DESCRIBE,
  47     HTTPD_MSG_SETUP,
  48     HTTPD_MSG_PLAY,
  49     HTTPD_MSG_PAUSE,
  50     HTTPD_MSG_GETPARAMETER,
  51     HTTPD_MSG_TEARDOWN,
  52
  53     /* just to track the count of MSG */
  54     HTTPD_MSG_MAX
  55 };
  56
  57 enum
  58 {
  59     HTTPD_PROTO_NONE,
  60     HTTPD_PROTO_HTTP,  /* HTTP/1.x */
  61     HTTPD_PROTO_RTSP,  /* RTSP/1.x */
  62     HTTPD_PROTO_HTTP0, /* HTTP/0.x */
  63 };
  64
  65 typedef struct httpd_host_t   httpd_host_t;
  66 typedef struct httpd_client_t httpd_client_t;
  67 /* create a new host */
  68 VLC_API httpd_host_t *vlc_http_HostNew( vlc_object_t * ) VLC_USED;
  69 VLC_API httpd_host_t *vlc_https_HostNew( vlc_object_t * ) VLC_USED;
  70 VLC_API httpd_host_t *vlc_rtsp_HostNew( vlc_object_t * ) VLC_USED;
  71 /* delete a host */
  72 VLC_API void httpd_HostDelete( httpd_host_t * );
  73
  74 typedef struct
  75 {
  76     char * name;
  77     char * value;
  78 } httpd_header;
  79
  80 typedef struct httpd_message_t
  81 {
  82     httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */
  83
  84     uint8_t i_type;
  85     uint8_t i_proto;
  86     uint8_t i_version;
  87
  88     /* for an answer */
  89     int     i_status;
  90
  91     /* for a query */
  92     char    *psz_url;
  93     /* FIXME find a clean way to handle GET(psz_args)
  94        and POST(body) through the same code */
  95     uint8_t *psz_args;
  96
  97     /* options */
  98     size_t       i_headers;
  99     httpd_header *p_headers;
 100
 101     /* body */
 102     int64_t i_body_offset;
 103     int     i_body;
 104     uint8_t *p_body;
 105
 106 } httpd_message_t;
 107
 108 typedef struct httpd_url_t      httpd_url_t;
 109 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
 110 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
 111 /* register a new url */
 112 VLC_API httpd_url_t * httpd_UrlNew( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password ) VLC_USED;
 113 /* register callback on a url */
 114 VLC_API int httpd_UrlCatch( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * );
 115 /* delete a url */
 116 VLC_API void httpd_UrlDelete( httpd_url_t * );
 117
 118 VLC_API char* httpd_ClientIP( const httpd_client_t *cl, char *, int * );
 119 VLC_API char* httpd_ServerIP( const httpd_client_t *cl, char *, int * );
 120
 121 /* High level */
 122
 123 typedef struct httpd_file_t     httpd_file_t;
 124 typedef struct httpd_file_sys_t httpd_file_sys_t;
 125 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
 126 VLC_API httpd_file_t * httpd_FileNew( httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password, httpd_file_callback_t pf_fill, httpd_file_sys_t * ) VLC_USED;
 127 VLC_API httpd_file_sys_t * httpd_FileDelete( httpd_file_t * );
 128
 129
 130 typedef struct httpd_handler_t  httpd_handler_t;
 131 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
 132 typedef int (*httpd_handler_callback_t)( httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data );
 133 VLC_API httpd_handler_t * httpd_HandlerNew( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, httpd_handler_callback_t pf_fill, httpd_handler_sys_t * ) VLC_USED;
 134 VLC_API httpd_handler_sys_t * httpd_HandlerDelete( httpd_handler_t * );
 135
 136 typedef struct httpd_redirect_t httpd_redirect_t;
 137 VLC_API httpd_redirect_t * httpd_RedirectNew( httpd_host_t *, const char *psz_url_dst, const char *psz_url_src ) VLC_USED;
 138 VLC_API void httpd_RedirectDelete( httpd_redirect_t * );
 139
 140
 141 typedef struct httpd_stream_t httpd_stream_t;
 142 VLC_API httpd_stream_t * httpd_StreamNew( httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password ) VLC_USED;
 143 VLC_API void httpd_StreamDelete( httpd_stream_t * );
 144 VLC_API int httpd_StreamHeader( httpd_stream_t *, uint8_t *p_data, int i_data );
 145 VLC_API int httpd_StreamSend( httpd_stream_t *, const block_t *p_block );
 146 VLC_API int httpd_StreamSetHTTPHeaders(httpd_stream_t *, httpd_header *, size_t);
 147
 148 /* Msg functions facilities */
 149 VLC_API void httpd_MsgAdd( httpd_message_t *, const char *psz_name, const char *psz_value, ... ) VLC_FORMAT( 3, 4 );
 150 /* return "" if not found. The string is not allocated */
 151 VLC_API const char * httpd_MsgGet( const httpd_message_t *, const char *psz_name );
 152
 153 #endif /* _VLC_HTTPD_H */