LGPL
[vlc.git] / src / input / resource.h
1 /*****************************************************************************
2  * resource.h
3  *****************************************************************************
4  * Copyright (C) 2008 Laurent Aimar
5  * $Id$
6  *
7  * Authors: Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef LIBVLC_INPUT_RESOURCE_H
25 #define LIBVLC_INPUT_RESOURCE_H 1
26
27 #include <vlc_common.h>
28
29 /**
30  * This function set the associated input.
31  */
32 void input_resource_SetInput( input_resource_t *, input_thread_t * );
33
34 /**
35  * This function handles sout request.
36  */
37 sout_instance_t *input_resource_RequestSout( input_resource_t *, sout_instance_t *, const char *psz_sout );
38
39 /**
40  * This function handles aout request.
41  */
42 audio_output_t *input_resource_RequestAout( input_resource_t *, audio_output_t * );
43
44 /**
45  * This function returns the current aout if any.
46  *
47  * You must call vlc_object_release on the value returned (if non NULL).
48  */
49 audio_output_t *input_resource_HoldAout( input_resource_t *p_resource );
50
51 /**
52  * This function handles vout request.
53  */
54 vout_thread_t *input_resource_RequestVout( input_resource_t *, vout_thread_t *, video_format_t *, unsigned dpb_size, bool b_recycle );
55
56 /**
57  * This function returns one of the current vout if any.
58  *
59  * You must call vlc_object_release on the value returned (if non NULL).
60  */
61 vout_thread_t *input_resource_HoldVout( input_resource_t * );
62
63 /**
64  * This function returns all current vouts if any.
65  *
66  * You must call vlc_object_release on all values returned (if non NULL).
67  */
68 void input_resource_HoldVouts( input_resource_t *, vout_thread_t ***, size_t * );
69
70 /**
71  * This function releases all resources (object).
72  */
73 void input_resource_Terminate( input_resource_t * );
74
75 /**
76  * This function holds the input_resource_t itself
77  */
78 input_resource_t *input_resource_Hold( input_resource_t * );
79
80 #endif