Clean up.
[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     double     f_fps;
63
64     /* Clock average variation */
65     int     i_cr_average;
66
67 } input_source_t;
68
69 /** Private input fields */
70 struct input_thread_private_t
71 {
72     /* Global properties */
73     vlc_bool_t  b_can_pause;
74
75     int         i_rate;
76     /* */
77     int64_t     i_start;    /* :start-time,0 by default */
78     int64_t     i_stop;     /* :stop-time, 0 if none */
79     int64_t     i_run;      /* :run-time, 0 if none */
80
81     /* Title infos FIXME multi-input (not easy) ? */
82     int          i_title;
83     input_title_t **title;
84
85     int i_title_offset;
86     int i_seekpoint_offset;
87
88     /* User bookmarks FIXME won't be easy with multiples input */
89     int         i_bookmark;
90     seekpoint_t **bookmark;
91
92     /* Input attachment */
93     int i_attachment;
94     input_attachment_t **attachment;
95
96     /* Output */
97     es_out_t    *p_es_out;
98     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
99     vlc_bool_t      b_sout_keep;
100     vlc_bool_t      b_out_pace_control; /*     idem ? */
101
102     /* Main input properties */
103     input_source_t input;
104     /* Slave demuxers (subs, and others) */
105     int            i_slave;
106     input_source_t **slave;
107
108     /* Stats counters */
109     struct {
110         counter_t *p_read_packets;
111         counter_t *p_read_bytes;
112         counter_t *p_input_bitrate;
113         counter_t *p_demux_read;
114         counter_t *p_demux_bitrate;
115         counter_t *p_decoded_audio;
116         counter_t *p_decoded_video;
117         counter_t *p_decoded_sub;
118         counter_t *p_sout_sent_packets;
119         counter_t *p_sout_sent_bytes;
120         counter_t *p_sout_send_bitrate;
121         counter_t *p_played_abuffers;
122         counter_t *p_lost_abuffers;
123         counter_t *p_displayed_pictures;
124         counter_t *p_lost_pictures;
125         vlc_mutex_t counters_lock;
126     } counters;
127
128     /* Buffer of pending actions */
129     vlc_mutex_t lock_control;
130     int i_control;
131     struct
132     {
133         /* XXX for string value you have to allocate it before calling
134          * input_ControlPush */
135         int         i_type;
136         vlc_value_t val;
137     } control[INPUT_CONTROL_FIFO_SIZE];
138 };
139
140 /***************************************************************************
141  * Internal control helpers
142  ***************************************************************************/
143 enum input_control_e
144 {
145     INPUT_CONTROL_SET_DIE,
146
147     INPUT_CONTROL_SET_STATE,
148
149     INPUT_CONTROL_SET_RATE,
150     INPUT_CONTROL_SET_RATE_SLOWER,
151     INPUT_CONTROL_SET_RATE_FASTER,
152
153     INPUT_CONTROL_SET_POSITION,
154     INPUT_CONTROL_SET_POSITION_OFFSET,
155
156     INPUT_CONTROL_SET_TIME,
157     INPUT_CONTROL_SET_TIME_OFFSET,
158
159     INPUT_CONTROL_SET_PROGRAM,
160
161     INPUT_CONTROL_SET_TITLE,
162     INPUT_CONTROL_SET_TITLE_NEXT,
163     INPUT_CONTROL_SET_TITLE_PREV,
164
165     INPUT_CONTROL_SET_SEEKPOINT,
166     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
167     INPUT_CONTROL_SET_SEEKPOINT_PREV,
168
169     INPUT_CONTROL_SET_BOOKMARK,
170
171     INPUT_CONTROL_SET_ES,
172
173     INPUT_CONTROL_SET_AUDIO_DELAY,
174     INPUT_CONTROL_SET_SPU_DELAY,
175
176     INPUT_CONTROL_ADD_SLAVE,
177 };
178
179 /* Internal helpers */
180 static inline void input_ControlPush( input_thread_t *p_input,
181                                       int i_type, vlc_value_t *p_val )
182 {
183     vlc_mutex_lock( &p_input->p->lock_control );
184     if( i_type == INPUT_CONTROL_SET_DIE )
185     {
186         /* Special case, empty the control */
187         p_input->p->i_control = 1;
188         p_input->p->control[0].i_type = i_type;
189         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
190     }
191     else
192     {
193         if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
194         {
195             msg_Err( p_input, "input control fifo overflow, trashing type=%d",
196                      i_type );
197             vlc_mutex_unlock( &p_input->p->lock_control );
198             return;
199         }
200         p_input->p->control[p_input->p->i_control].i_type = i_type;
201         if( p_val )
202             p_input->p->control[p_input->p->i_control].val = *p_val;
203         else
204             memset( &p_input->p->control[p_input->p->i_control].val, 0,
205                     sizeof( vlc_value_t ) );
206
207         p_input->p->i_control++;
208     }
209     vlc_mutex_unlock( &p_input->p->lock_control );
210 }
211
212 /**********************************************************************
213  * Item metadata
214  **********************************************************************/
215 typedef struct playlist_album_t
216 {
217     char *psz_artist;
218     char *psz_album;
219     char *psz_arturl;
220     vlc_bool_t b_found;
221 } playlist_album_t;
222
223 int         input_MetaFetch     ( playlist_t *, input_item_t * );
224 int         input_ArtFind       ( playlist_t *, input_item_t * );
225 vlc_bool_t  input_MetaSatisfied ( playlist_t*, input_item_t*,
226                                   uint32_t*, uint32_t* );
227 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
228
229 /* Becarefull; p_item lock HAS to be taken */
230 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
231
232 /***************************************************************************
233  * Internal prototypes
234  ***************************************************************************/
235
236 /* misc/stats.c */
237 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
238
239 /* input.c */
240 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
241 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
242
243 void input_DestroyThreadExtended( input_thread_t *p_input, sout_instance_t ** );
244
245 /* var.c */
246 void input_ControlVarInit ( input_thread_t * );
247 void input_ControlVarClean( input_thread_t * );
248 void input_ControlVarNavigation( input_thread_t * );
249 void input_ControlVarTitle( input_thread_t *, int i_title );
250
251 void input_ConfigVarInit ( input_thread_t * );
252
253 /* stream.c */
254 stream_t *stream_AccessNew( access_t *p_access, vlc_bool_t );
255 void stream_AccessDelete( stream_t *s );
256 void stream_AccessReset( stream_t *s );
257 void stream_AccessUpdate( stream_t *s );
258
259 /* decoder.c */
260 void       input_DecoderDiscontinuity( decoder_t * p_dec, vlc_bool_t b_flush );
261 vlc_bool_t input_DecoderEmpty( decoder_t * p_dec );
262
263 /* es_out.c */
264 es_out_t  *input_EsOutNew( input_thread_t * );
265 void       input_EsOutDelete( es_out_t * );
266 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
267 void       input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
268 void       input_EsOutChangeRate( es_out_t * );
269 void       input_EsOutChangeState( es_out_t * );
270 void       input_EsOutChangePosition( es_out_t * );
271 vlc_bool_t input_EsOutDecodersEmpty( es_out_t * );
272
273 /* clock.c */
274 enum /* Synchro states */
275 {
276     SYNCHRO_OK     = 0,
277     SYNCHRO_START  = 1,
278     SYNCHRO_REINIT = 2,
279 };
280
281 typedef struct
282 {
283     /* Synchronization information */
284     mtime_t                 delta_cr;
285     mtime_t                 cr_ref, sysdate_ref;
286     mtime_t                 last_sysdate;
287     mtime_t                 last_cr; /* reference to detect unexpected stream
288                                       * discontinuities                      */
289     mtime_t                 last_pts;
290     mtime_t                 last_update;
291     int                     i_synchro_state;
292
293     vlc_bool_t              b_master;
294
295     int                     i_rate;
296
297     /* Config */
298     int                     i_cr_average;
299     int                     i_delta_cr_residue;
300 } input_clock_t;
301
302 void    input_ClockInit( input_thread_t *, input_clock_t *, vlc_bool_t b_master, int i_cr_average );
303 void    input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
304 void    input_ClockResetPCR( input_thread_t *, input_clock_t * );
305 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
306 void    input_ClockSetRate( input_thread_t *, input_clock_t *cl );
307
308 /* Subtitles */
309 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
310 int subtitles_Filter( const char *);
311
312 void MRLSplit( vlc_object_t *, char *, const char **, const char **, char ** );
313
314 static inline void input_ChangeState( input_thread_t *p_input, int state )
315 {
316     var_SetInteger( p_input, "state", p_input->i_state = state );
317 }
318
319 /* Access */
320
321 #define access2_New( a, b, c, d, e ) __access2_New(VLC_OBJECT(a), b, c, d, e )
322 access_t * __access2_New( vlc_object_t *p_obj, const char *psz_access,
323                           const char *psz_demux, const char *psz_path,
324                           vlc_bool_t b_quick );
325 access_t * access2_FilterNew( access_t *p_source,
326                               const char *psz_access_filter );
327 void access2_Delete( access_t * );
328
329 /* Demuxer */
330 #include <vlc_demux.h>
331
332 /* stream_t *s could be null and then it mean a access+demux in one */
333 #define demux2_New( a, b, c, d, e, f,g ) __demux2_New(VLC_OBJECT(a),b,c,d,e,f,g)
334 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 );
335
336 void demux2_Delete(demux_t *);
337
338 static inline int demux2_Demux( demux_t *p_demux )
339 {
340     return p_demux->pf_demux( p_demux );
341 }
342 static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
343 {
344     return p_demux->pf_control( p_demux, i_query, args );
345 }
346 static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
347 {
348     va_list args;
349     int     i_result;
350
351     va_start( args, i_query );
352     i_result = demux2_vaControl( p_demux, i_query, args );
353     va_end( args );
354     return i_result;
355 }
356
357 #if defined(__PLUGIN__) || defined(__BUILTIN__)
358 # warning This is an internal header, something is wrong if you see this message.
359 #else
360 /* Stream */
361 /**
362  * stream_t definition
363  */
364 struct stream_t
365 {
366     VLC_COMMON_MEMBERS
367
368     /*block_t *(*pf_block)  ( stream_t *, int i_size );*/
369     int      (*pf_read)   ( stream_t *, void *p_read, int i_read );
370     int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, int i_peek );
371     int      (*pf_control)( stream_t *, int i_query, va_list );
372     void     (*pf_destroy)( stream_t *);
373
374     stream_sys_t *p_sys;
375
376     /* UTF-16 and UTF-32 file reading */
377     vlc_iconv_t     conv;
378     int             i_char_width;
379     vlc_bool_t      b_little_endian;
380 };
381
382 #include <libvlc.h>
383
384 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
385 {
386     return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
387                                           VLC_OBJECT_STREAM, "stream" );
388 }
389 #endif
390
391 #endif