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