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

   1 /*****************************************************************************
   2  * vlc_httpd.h: builtin HTTP/RTSP server.
   3  *****************************************************************************
   4  * Copyright (C) 2004-2006 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 enum
  28 {
  29     HTTPD_MSG_NONE,
  30
  31     /* answer */
  32     HTTPD_MSG_ANSWER,
  33
  34     /* channel communication */
  35     HTTPD_MSG_CHANNEL,
  36
  37     /* http request */
  38     HTTPD_MSG_GET,
  39     HTTPD_MSG_HEAD,
  40     HTTPD_MSG_POST,
  41
  42     /* rtsp request */
  43     HTTPD_MSG_OPTIONS,
  44     HTTPD_MSG_DESCRIBE,
  45     HTTPD_MSG_SETUP,
  46     HTTPD_MSG_PLAY,
  47     HTTPD_MSG_PAUSE,
  48     HTTPD_MSG_GETPARAMETER,
  49     HTTPD_MSG_TEARDOWN,
  50
  51     /* just to track the count of MSG */
  52     HTTPD_MSG_MAX
  53 };
  54
  55 enum
  56 {
  57     HTTPD_PROTO_NONE,
  58     HTTPD_PROTO_HTTP,  /* HTTP/1.x */
  59     HTTPD_PROTO_RTSP,  /* RTSP/1.x */
  60     HTTPD_PROTO_HTTP0, /* HTTP/0.x */
  61 };
  62
  63 struct httpd_message_t
  64 {
  65     httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */
  66
  67     uint8_t i_type;
  68     uint8_t i_proto;
  69     uint8_t i_version;
  70
  71     /* for an answer */
  72     int     i_status;
  73
  74     /* for a query */
  75     char    *psz_url;
  76     /* FIXME find a clean way to handle GET(psz_args)
  77        and POST(body) through the same code */
  78     uint8_t *psz_args;
  79
  80     /* for rtp over rtsp */
  81     int     i_channel;
  82
  83     /* options */
  84     int     i_name;
  85     char    **name;
  86     int     i_value;
  87     char    **value;
  88
  89     /* body */
  90     int64_t i_body_offset;
  91     int     i_body;
  92     uint8_t *p_body;
  93
  94 };
  95
  96 /* create a new host */
  97 VLC_EXPORT( httpd_host_t *, httpd_HostNew, ( vlc_object_t *, const char *psz_host, int i_port ) );
  98 VLC_EXPORT( httpd_host_t *, httpd_TLSHostNew, ( vlc_object_t *, const char *, int, const char *, const char *, const char *, const char * ) );
  99
 100 /* delete a host */
 101 VLC_EXPORT( void,           httpd_HostDelete, ( httpd_host_t * ) );
 102
 103 /* register a new url */
 104 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 ) );
 105 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 ) );
 106 /* register callback on a url */
 107 VLC_EXPORT( int,            httpd_UrlCatch, ( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * ) );
 108 /* delete an url */
 109 VLC_EXPORT( void,           httpd_UrlDelete, ( httpd_url_t * ) );
 110
 111 /* Default client mode is FILE, use these to change it */
 112 VLC_EXPORT( void,           httpd_ClientModeStream, ( httpd_client_t *cl ) );
 113 VLC_EXPORT( void,           httpd_ClientModeBidir, ( httpd_client_t *cl ) );
 114 VLC_EXPORT( char*,          httpd_ClientIP, ( const httpd_client_t *cl, char *psz_ip ) );
 115 VLC_EXPORT( char*,          httpd_ServerIP, ( const httpd_client_t *cl, char *psz_ip ) );
 116
 117 /* High level */
 118
 119 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 * ) );
 120 VLC_EXPORT( httpd_file_sys_t *, httpd_FileDelete, ( httpd_file_t * ) );
 121
 122
 123 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 * ) );
 124 VLC_EXPORT( httpd_handler_sys_t *, httpd_HandlerDelete, ( httpd_handler_t * ) );
 125
 126
 127 VLC_EXPORT( httpd_redirect_t *, httpd_RedirectNew, ( httpd_host_t *, const char *psz_url_dst, const char *psz_url_src ) );
 128 VLC_EXPORT( void,               httpd_RedirectDelete, ( httpd_redirect_t * ) );
 129
 130
 131 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 ) );
 132 VLC_EXPORT( void,             httpd_StreamDelete, ( httpd_stream_t * ) );
 133 VLC_EXPORT( int,              httpd_StreamHeader, ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
 134 VLC_EXPORT( int,              httpd_StreamSend,   ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
 135
 136
 137 /* Msg functions facilities */
 138 VLC_EXPORT( void,         httpd_MsgInit, ( httpd_message_t * )  );
 139 VLC_EXPORT( void,         httpd_MsgAdd, ( httpd_message_t *, const char *psz_name, const char *psz_value, ... ) LIBVLC_FORMAT( 3, 4 ) );
 140 /* return "" if not found. The string is not allocated */
 141 VLC_EXPORT( const char *, httpd_MsgGet, ( const httpd_message_t *, const char *psz_name ) );
 142 VLC_EXPORT( void,         httpd_MsgClean, ( httpd_message_t * ) );
 143
 144 #endif /* _VLC_HTTPD_H */