Fix typos in comments
[vlc.git] / src / input / input_interface.h
1 /*****************************************************************************
2  * input_interface.h: Input functions usable outside input code.
3  *****************************************************************************
4  * Copyright (C) 1998-2008 the VideoLAN team
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
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.
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 General Public License for more details.
18  *
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  *****************************************************************************/
23
24 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
25 # error This header file can only be included from LibVLC.
26 #endif
27
28 #ifndef _INPUT_INTERFACE_H
29 #define _INPUT_INTERFACE_H 1
30
31 #include <vlc_input.h>
32 #include <libvlc.h>
33
34 /**********************************************************************
35  * Item metadata
36  **********************************************************************/
37 void input_item_SetPreparsed( input_item_t *p_i, bool b_preparsed );
38 void input_item_SetArtNotFound( input_item_t *p_i, bool b_not_found );
39 void input_item_SetArtFetched( input_item_t *p_i, bool b_art_fetched );
40 void input_item_SetEpg( input_item_t *p_item,
41                         const char *psz_epg, const vlc_epg_t *p_epg );
42
43 int input_Preparse( vlc_object_t *, input_item_t * );
44
45 /* misc/stats.c
46  * FIXME it should NOT be defined here or not coded in misc/stats.c */
47 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
48
49 /**
50  * This function deletes the current sout in the resources.
51  */
52 void input_resource_TerminateSout( input_resource_t *p_resource );
53
54 /**
55  * This function deletes the current vout in the resources.
56  */
57 void input_resource_TerminateVout( input_resource_t *p_resource );
58
59 /**
60  * This function return true if there is at least one vout in the resources.
61  *
62  * It can only be called on detached resources.
63  */
64 bool input_resource_HasVout( input_resource_t *p_resource );
65
66 /* input.c */
67
68 /* */
69 typedef enum
70 {
71     INPUT_STATISTIC_DECODED_VIDEO,
72     INPUT_STATISTIC_DECODED_AUDIO,
73     INPUT_STATISTIC_DECODED_SUBTITLE,
74
75     /* Use them only if you do not goes through a access_out module */
76     INPUT_STATISTIC_SENT_PACKET,
77     INPUT_STATISTIC_SENT_BYTE,
78
79 } input_statistic_t;
80 /**
81  * It will update internal input statistics from external sources.
82  * XXX For now, the only one allowed to do it is stream_out and input core.
83  */
84 void input_UpdateStatistic( input_thread_t *, input_statistic_t, int i_delta );
85
86 #endif