mirror of https://code.videolan.org/videolan/vlc
152 lines
5.5 KiB
C
152 lines
5.5 KiB
C
/*****************************************************************************
|
|
* vlc_httpd.h: builtin HTTP/RTSP server.
|
|
*****************************************************************************
|
|
* Copyright (C) 2004-2006 VLC authors and VideoLAN
|
|
*
|
|
* Authors: Laurent Aimar <fenrir@via.ecp.fr>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation; either version 2.1 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
|
|
*****************************************************************************/
|
|
|
|
#ifndef VLC_HTTPD_H
|
|
#define VLC_HTTPD_H 1
|
|
|
|
/**
|
|
* \file
|
|
* HTTP/RTSP server API.
|
|
*/
|
|
|
|
enum
|
|
{
|
|
HTTPD_MSG_NONE,
|
|
|
|
/* answer */
|
|
HTTPD_MSG_ANSWER,
|
|
|
|
/* http request */
|
|
HTTPD_MSG_GET,
|
|
HTTPD_MSG_HEAD,
|
|
HTTPD_MSG_POST,
|
|
|
|
/* rtsp request */
|
|
HTTPD_MSG_OPTIONS,
|
|
HTTPD_MSG_DESCRIBE,
|
|
HTTPD_MSG_SETUP,
|
|
HTTPD_MSG_PLAY,
|
|
HTTPD_MSG_PAUSE,
|
|
HTTPD_MSG_GETPARAMETER,
|
|
HTTPD_MSG_TEARDOWN,
|
|
|
|
/* just to track the count of MSG */
|
|
HTTPD_MSG_MAX
|
|
};
|
|
|
|
enum
|
|
{
|
|
HTTPD_PROTO_NONE,
|
|
HTTPD_PROTO_HTTP, /* HTTP/1.x */
|
|
HTTPD_PROTO_RTSP, /* RTSP/1.x */
|
|
HTTPD_PROTO_HTTP0, /* HTTP/0.x */
|
|
};
|
|
|
|
typedef struct httpd_host_t httpd_host_t;
|
|
typedef struct httpd_client_t httpd_client_t;
|
|
/* create a new host */
|
|
VLC_API httpd_host_t *vlc_http_HostNew( vlc_object_t * ) VLC_USED;
|
|
VLC_API httpd_host_t *vlc_https_HostNew( vlc_object_t * ) VLC_USED;
|
|
VLC_API httpd_host_t *vlc_rtsp_HostNew( vlc_object_t * ) VLC_USED;
|
|
/* delete a host */
|
|
VLC_API void httpd_HostDelete( httpd_host_t * );
|
|
|
|
typedef struct
|
|
{
|
|
char * name;
|
|
char * value;
|
|
} httpd_header;
|
|
|
|
typedef struct httpd_message_t
|
|
{
|
|
httpd_client_t *cl; /* NULL if not through a connection e vlc internal */
|
|
|
|
uint8_t i_type;
|
|
uint8_t i_proto;
|
|
uint8_t i_version;
|
|
|
|
/* for an answer */
|
|
int i_status;
|
|
|
|
/* for a query */
|
|
char *psz_url;
|
|
/* FIXME find a clean way to handle GET(psz_args)
|
|
and POST(body) through the same code */
|
|
uint8_t *psz_args;
|
|
|
|
/* options */
|
|
size_t i_headers;
|
|
httpd_header *p_headers;
|
|
|
|
/* body */
|
|
int64_t i_body_offset;
|
|
size_t i_body;
|
|
uint8_t *p_body;
|
|
|
|
} httpd_message_t;
|
|
|
|
typedef struct httpd_url_t httpd_url_t;
|
|
typedef struct httpd_callback_sys_t httpd_callback_sys_t;
|
|
typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
|
|
/* register a new url */
|
|
VLC_API httpd_url_t * httpd_UrlNew( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password ) VLC_USED;
|
|
/* register callback on a url */
|
|
VLC_API int httpd_UrlCatch( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * );
|
|
/* delete a url */
|
|
VLC_API void httpd_UrlDelete( httpd_url_t * );
|
|
|
|
VLC_API char* httpd_ClientIP( const httpd_client_t *cl, char *, int * );
|
|
VLC_API char* httpd_ServerIP( const httpd_client_t *cl, char *, int * );
|
|
|
|
/* High level */
|
|
|
|
typedef struct httpd_file_t httpd_file_t;
|
|
typedef struct httpd_file_sys_t httpd_file_sys_t;
|
|
typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, size_t *pi_data );
|
|
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;
|
|
VLC_API httpd_file_sys_t * httpd_FileDelete( httpd_file_t * );
|
|
|
|
|
|
typedef struct httpd_handler_t httpd_handler_t;
|
|
typedef int (*httpd_handler_callback_t)( void *, 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, size_t *pi_data );
|
|
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, void * ) VLC_USED;
|
|
VLC_API void * httpd_HandlerDelete( httpd_handler_t * );
|
|
|
|
typedef struct httpd_redirect_t httpd_redirect_t;
|
|
VLC_API httpd_redirect_t * httpd_RedirectNew( httpd_host_t *, const char *psz_url_dst, const char *psz_url_src ) VLC_USED;
|
|
VLC_API void httpd_RedirectDelete( httpd_redirect_t * );
|
|
|
|
|
|
typedef struct httpd_stream_t httpd_stream_t;
|
|
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;
|
|
VLC_API void httpd_StreamDelete( httpd_stream_t * );
|
|
VLC_API int httpd_StreamHeader( httpd_stream_t *, uint8_t *p_data, int i_data );
|
|
VLC_API int httpd_StreamSend( httpd_stream_t *, const block_t *p_block );
|
|
VLC_API int httpd_StreamSetHTTPHeaders(httpd_stream_t *, const httpd_header *, size_t);
|
|
|
|
/* Msg functions facilities */
|
|
VLC_API void httpd_MsgAdd( httpd_message_t *, const char *psz_name, const char *psz_value, ... ) VLC_FORMAT( 3, 4 );
|
|
/* return "" if not found. The string is not allocated */
|
|
VLC_API const char * httpd_MsgGet( const httpd_message_t *, const char *psz_name );
|
|
|
|
#endif /* _VLC_HTTPD_H */
|