77c416990696f18fd26a6b693920063563993a33
[vlc.git] / src / input / input_internal.h
1 /*****************************************************************************
2  * input_internal.h: Internal input structures
3  *****************************************************************************
4  * Copyright (C) 1998-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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 #ifndef _INPUT_INTERNAL_H
25 #define _INPUT_INTERNAL_H 1
26
27 #include <vlc_access.h>
28 #include <vlc_demux.h>
29 #include <vlc_input.h>
30
31 /*****************************************************************************
32  *  Private input fields
33  *****************************************************************************/
34 /* input_source_t: gathers all information per input source */
35 typedef struct
36 {
37     /* Input item description */
38     input_item_t *p_item;
39
40     /* Access/Stream/Demux plugins */
41     access_t *p_access;
42     stream_t *p_stream;
43     demux_t  *p_demux;
44
45     /* Title infos for that input */
46     vlc_bool_t   b_title_demux; /* Titles/Seekpoints provided by demux */
47     int          i_title;
48     input_title_t **title;
49
50     int i_title_offset;
51     int i_seekpoint_offset;
52
53     int i_title_start;
54     int i_title_end;
55     int i_seekpoint_start;
56     int i_seekpoint_end;
57
58     /* Properties */
59     vlc_bool_t b_can_pace_control;
60     vlc_bool_t b_can_pause;
61     vlc_bool_t b_eof;   /* eof of demuxer */
62
63     /* Clock average variation */
64     int     i_cr_average;
65
66 } input_source_t;
67
68 /** Private input fields */
69 struct input_thread_private_t
70 {
71     /* Global properties */
72     vlc_bool_t  b_can_pause;
73
74     int         i_rate;
75     /* */
76     int64_t     i_start;    /* :start-time,0 by default */
77     int64_t     i_stop;     /* :stop-time, 0 if none */
78
79     /* Title infos FIXME multi-input (not easy) ? */
80     int          i_title;
81     input_title_t **title;
82
83     int i_title_offset;
84     int i_seekpoint_offset;
85
86     /* User bookmarks FIXME won't be easy with multiples input */
87     int         i_bookmark;
88     seekpoint_t **bookmark;
89
90     /* Global meta datas FIXME move to input_item_t ? */
91     vlc_meta_t  *p_meta;
92
93     /* Output */
94     es_out_t    *p_es_out;
95     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
96     vlc_bool_t      b_out_pace_control; /*     idem ? */
97
98     /* Main input properties */
99     input_source_t input;
100     /* Slave demuxers (subs, and others) */
101     int            i_slave;
102     input_source_t **slave;
103
104     /* Stats counters */
105     struct {
106         counter_t *p_read_packets;
107         counter_t *p_read_bytes;
108         counter_t *p_input_bitrate;
109         counter_t *p_demux_read;
110         counter_t *p_demux_bitrate;
111         counter_t *p_decoded_audio;
112         counter_t *p_decoded_video;
113         counter_t *p_decoded_sub;
114         counter_t *p_sout_sent_packets;
115         counter_t *p_sout_sent_bytes;
116         counter_t *p_sout_send_bitrate;
117         counter_t *p_played_abuffers;
118         counter_t *p_lost_abuffers;
119         counter_t *p_displayed_pictures;
120         counter_t *p_lost_pictures;
121         vlc_mutex_t counters_lock;
122     } counters;
123
124     /* Buffer of pending actions */
125     vlc_mutex_t lock_control;
126     int i_control;
127     struct
128     {
129         /* XXX: val isn't duplicated so it won't works with string */
130         int         i_type;
131         vlc_value_t val;
132     } control[INPUT_CONTROL_FIFO_SIZE];
133 };
134
135 /***************************************************************************
136  * Internal control helpers
137  ***************************************************************************/
138 enum input_control_e
139 {
140     INPUT_CONTROL_SET_DIE,
141
142     INPUT_CONTROL_SET_STATE,
143
144     INPUT_CONTROL_SET_RATE,
145     INPUT_CONTROL_SET_RATE_SLOWER,
146     INPUT_CONTROL_SET_RATE_FASTER,
147
148     INPUT_CONTROL_SET_POSITION,
149     INPUT_CONTROL_SET_POSITION_OFFSET,
150
151     INPUT_CONTROL_SET_TIME,
152     INPUT_CONTROL_SET_TIME_OFFSET,
153
154     INPUT_CONTROL_SET_PROGRAM,
155
156     INPUT_CONTROL_SET_TITLE,
157     INPUT_CONTROL_SET_TITLE_NEXT,
158     INPUT_CONTROL_SET_TITLE_PREV,
159
160     INPUT_CONTROL_SET_SEEKPOINT,
161     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
162     INPUT_CONTROL_SET_SEEKPOINT_PREV,
163
164     INPUT_CONTROL_SET_BOOKMARK,
165
166     INPUT_CONTROL_SET_ES,
167
168     INPUT_CONTROL_SET_AUDIO_DELAY,
169     INPUT_CONTROL_SET_SPU_DELAY,
170
171     INPUT_CONTROL_ADD_SLAVE,
172 };
173
174 /* Internal helpers */
175 static inline void input_ControlPush( input_thread_t *p_input,
176                                       int i_type, vlc_value_t *p_val )
177 {
178     vlc_mutex_lock( &p_input->p->lock_control );
179     if( i_type == INPUT_CONTROL_SET_DIE )
180     {
181         /* Special case, empty the control */
182         p_input->p->i_control = 1;
183         p_input->p->control[0].i_type = i_type;
184         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
185     }
186     else
187     {
188         if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
189         {
190             msg_Err( p_input, "input control fifo overflow, trashing type=%d",
191                      i_type );
192             vlc_mutex_unlock( &p_input->p->lock_control );
193             return;
194         }
195         p_input->p->control[p_input->p->i_control].i_type = i_type;
196         if( p_val )
197             p_input->p->control[p_input->p->i_control].val = *p_val;
198         else
199             memset( &p_input->p->control[p_input->p->i_control].val, 0,
200                     sizeof( vlc_value_t ) );
201
202         p_input->p->i_control++;
203     }
204     vlc_mutex_unlock( &p_input->p->lock_control );
205 }
206
207 /**********************************************************************
208  * Item metadata
209  **********************************************************************/
210 typedef struct playlist_album_t
211 {
212     char *psz_artist;
213     char *psz_album;
214     vlc_bool_t b_found;
215 } playlist_album_t;
216
217 int         input_MetaFetch     ( playlist_t *, input_item_t * );
218 int         input_ArtFind       ( playlist_t *, input_item_t * );
219 vlc_bool_t  input_MetaSatisfied ( playlist_t*, input_item_t*,
220                                   uint32_t*, uint32_t* );
221 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
222
223 /***************************************************************************
224  * Internal prototypes
225  ***************************************************************************/
226
227 /* input.c */
228 #define input_CreateThread2(a,b,c) __input_CreateThread2(VLC_OBJECT(a),b,c)
229 input_thread_t *__input_CreateThread2 ( vlc_object_t *, input_item_t *, const char * );
230
231 /* var.c */
232 void input_ControlVarInit ( input_thread_t * );
233 void input_ControlVarClean( input_thread_t * );
234 void input_ControlVarNavigation( input_thread_t * );
235 void input_ControlVarTitle( input_thread_t *, int i_title );
236
237 void input_ConfigVarInit ( input_thread_t * );
238
239 /* stream.c */
240 stream_t *stream_AccessNew( access_t *p_access, vlc_bool_t );
241 void stream_AccessDelete( stream_t *s );
242 void stream_AccessReset( stream_t *s );
243 void stream_AccessUpdate( stream_t *s );
244
245 /* decoder.c FIXME make it public ?*/
246 void       input_DecoderDiscontinuity( decoder_t * p_dec );
247 vlc_bool_t input_DecoderEmpty( decoder_t * p_dec );
248 void       input_DecoderPreroll( decoder_t *p_dec, int64_t i_preroll_end );
249
250 /* es_out.c */
251 es_out_t  *input_EsOutNew( input_thread_t * );
252 void       input_EsOutDelete( es_out_t * );
253 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
254 void       input_EsOutDiscontinuity( es_out_t *, vlc_bool_t b_audio );
255 void       input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
256 vlc_bool_t input_EsOutDecodersEmpty( es_out_t * );
257
258 /* clock.c */
259 enum /* Synchro states */
260 {
261     SYNCHRO_OK     = 0,
262     SYNCHRO_START  = 1,
263     SYNCHRO_REINIT = 2,
264 };
265
266 typedef struct
267 {
268     /* Synchronization information */
269     mtime_t                 delta_cr;
270     mtime_t                 cr_ref, sysdate_ref;
271     mtime_t                 last_sysdate;
272     mtime_t                 last_cr; /* reference to detect unexpected stream
273                                       * discontinuities                      */
274     mtime_t                 last_pts;
275     int                     i_synchro_state;
276
277     vlc_bool_t              b_master;
278
279     /* Config */
280     int                     i_cr_average;
281     int                     i_delta_cr_residue;
282 } input_clock_t;
283
284 void input_ClockInit( input_clock_t *, vlc_bool_t b_master, int i_cr_average );
285 void    input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
286 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
287
288 /* Subtitles */
289 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
290 int subtitles_Filter( const char *);
291
292 void MRLSplit( vlc_object_t *, char *, const char **, const char **, char ** );
293
294 static inline void input_ChangeState( input_thread_t *p_input, int state )
295 {
296     vlc_value_t val;
297     val.i_int = p_input->i_state = state;
298     var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
299 }
300
301 /* Access */
302
303 #define access2_New( a, b, c, d, e ) __access2_New(VLC_OBJECT(a), b, c, d, e )
304 access_t * __access2_New( vlc_object_t *p_obj, const char *psz_access,
305                           const char *psz_demux, const char *psz_path,
306                           vlc_bool_t b_quick );
307 access_t * access2_FilterNew( access_t *p_source,
308                               const char *psz_access_filter );
309 void access2_Delete( access_t * );
310
311 /* Demuxer */
312 #include <vlc_demux.h>
313
314 /* stream_t *s could be null and then it mean a access+demux in one */
315 #define demux2_New( a, b, c, d, e, f,g ) __demux2_New(VLC_OBJECT(a),b,c,d,e,f,g)
316 demux_t *__demux2_New(vlc_object_t *p_obj, const char *psz_access, const char *psz_demux, const char *psz_path, stream_t *s, es_out_t *out, vlc_bool_t );
317
318 void demux2_Delete(demux_t *);
319
320 static inline int demux2_Demux( demux_t *p_demux )
321 {
322     return p_demux->pf_demux( p_demux );
323 }
324 static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
325 {
326     return p_demux->pf_control( p_demux, i_query, args );
327 }
328 static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
329 {
330     va_list args;
331     int     i_result;
332
333     va_start( args, i_query );
334     i_result = demux2_vaControl( p_demux, i_query, args );
335     va_end( args );
336     return i_result;
337 }
338
339 #endif