access: merge stream_access.c and access.c
[vlc.git] / src / input / stream.h
1 /*****************************************************************************
2  * stream.h: Input stream functions
3  *****************************************************************************
4  * Copyright (C) 1998-2008 VLC authors and VideoLAN
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 it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #ifndef LIBVLC_INPUT_STREAM_H
26 #define LIBVLC_INPUT_STREAM_H 1
27
28 #include <vlc_common.h>
29 #include <vlc_stream.h>
30
31 /* */
32 stream_t *stream_CommonNew( vlc_object_t * );
33
34 /**
35  * This function creates a stream_t with an access_t back-end.
36  */
37 stream_t *stream_AccessNew(vlc_object_t *, input_thread_t *, const char *);
38
39 /**
40  * This function creates a new stream_t filter.
41  *
42  * You must release it using stream_Delete unless it is used as a
43  * source to another filter.
44  */
45 stream_t *stream_FilterNew( stream_t *p_source,
46                             const char *psz_stream_filter );
47
48 /**
49  * Automatically wraps a stream with any applicable stream filter.
50  * @return the (outermost/downstream) stream filter; if no filters were added,
51  * then the function return the source parameter.
52  * @note The function never returns NULL.
53  */
54 stream_t *stream_FilterAutoNew( stream_t *source ) VLC_USED;
55
56 /**
57  * This function creates a chain of filters according to the colon-separated
58  * list.
59  *
60  * You must release the returned value using stream_Delete unless it is used as a
61  * source to another filter.
62  */
63 stream_t *stream_FilterChainNew( stream_t *p_source, const char *psz_chain );
64
65 char *get_path(const char *location);
66
67 #endif