Sanitize input headers (pass 4).
[vlc.git] / src / input / stream.h
1 /*****************************************************************************
2  * stream.h: Input stream functions
3  *****************************************************************************
4  * Copyright (C) 1998-2008 the VideoLAN team
5  * Copyright (C) 2008 Laurent Aimar
6  * $Id$
7  *
8  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
26 # error This header file can only be included from LibVLC.
27 #endif
28
29 #ifndef _INPUT_STREAM_H
30 #define _INPUT_STREAM_H 1
31
32 #include <vlc_common.h>
33 #include <vlc_stream.h>
34
35 /**
36  * stream_t definition
37  */
38 struct stream_t
39 {
40     VLC_COMMON_MEMBERS
41
42     /*block_t *(*pf_block)  ( stream_t *, int i_size );*/
43     int      (*pf_read)   ( stream_t *, void *p_read, unsigned int i_read );
44     int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
45     int      (*pf_control)( stream_t *, int i_query, va_list );
46     void     (*pf_destroy)( stream_t *);
47
48     stream_sys_t *p_sys;
49
50     /* UTF-16 and UTF-32 file reading */
51     vlc_iconv_t     conv;
52     int             i_char_width;
53     bool            b_little_endian;
54 };
55
56 #include <libvlc.h>
57
58 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
59 {
60     return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
61                                           VLC_OBJECT_GENERIC, "stream" );
62 }
63
64 #endif
65