1 /*****************************************************************************
2 * vlc_httpd.h: builtin HTTP/RTSP server.
3 *****************************************************************************
4 * Copyright (C) 2004-2006 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
29 * This file defines functions, structures, enums and macros for httpd functionality in vlc.
39 /* channel communication */
53 HTTPD_MSG_GETPARAMETER,
56 /* just to track the count of MSG */
63 HTTPD_PROTO_HTTP, /* HTTP/1.x */
64 HTTPD_PROTO_RTSP, /* RTSP/1.x */
65 HTTPD_PROTO_HTTP0, /* HTTP/0.x */
68 struct httpd_message_t
70 httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */
81 /* FIXME find a clean way to handle GET(psz_args)
82 and POST(body) through the same code */
85 /* for rtp over rtsp */
95 int64_t i_body_offset;
101 /* create a new host */
102 VLC_API httpd_host_t *vlc_http_HostNew( vlc_object_t * ) VLC_USED;
103 VLC_API httpd_host_t *vlc_https_HostNew( vlc_object_t * ) VLC_USED;
104 VLC_API httpd_host_t *vlc_rtsp_HostNew( vlc_object_t * ) VLC_USED;
107 VLC_API void httpd_HostDelete( httpd_host_t * );
109 /* register a new url */
110 VLC_API 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 ) VLC_USED;
111 VLC_API 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 ) VLC_USED;
112 /* register callback on a url */
113 VLC_API int httpd_UrlCatch( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * );
115 VLC_API void httpd_UrlDelete( httpd_url_t * );
117 /* Default client mode is FILE, use these to change it */
118 VLC_API void httpd_ClientModeStream( httpd_client_t *cl );
119 VLC_API void httpd_ClientModeBidir( httpd_client_t *cl );
120 VLC_API char* httpd_ClientIP( const httpd_client_t *cl, char *, int * );
121 VLC_API char* httpd_ServerIP( const httpd_client_t *cl, char *, int * );
125 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, const vlc_acl_t *p_acl, httpd_file_callback_t pf_fill, httpd_file_sys_t * ) VLC_USED;
126 VLC_API httpd_file_sys_t * httpd_FileDelete( httpd_file_t * );
129 VLC_API 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 * ) VLC_USED;
130 VLC_API httpd_handler_sys_t * httpd_HandlerDelete( httpd_handler_t * );
133 VLC_API httpd_redirect_t * httpd_RedirectNew( httpd_host_t *, const char *psz_url_dst, const char *psz_url_src ) VLC_USED;
134 VLC_API void httpd_RedirectDelete( httpd_redirect_t * );
137 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, const vlc_acl_t *p_acl ) VLC_USED;
138 VLC_API void httpd_StreamDelete( httpd_stream_t * );
139 VLC_API int httpd_StreamHeader( httpd_stream_t *, uint8_t *p_data, int i_data );
140 VLC_API int httpd_StreamSend( httpd_stream_t *, uint8_t *p_data, int i_data );
143 /* Msg functions facilities */
144 VLC_API void httpd_MsgAdd( httpd_message_t *, const char *psz_name, const char *psz_value, ... ) VLC_FORMAT( 3, 4 );
145 /* return "" if not found. The string is not allocated */
146 VLC_API const char * httpd_MsgGet( const httpd_message_t *, const char *psz_name );
148 #endif /* _VLC_HTTPD_H */