input: Get rid of Destroy(), and move sout keeping code to the destructor.
[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 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
25 # error This header file can only be included from LibVLC.
26 #endif
27
28 #ifndef _INPUT_INTERNAL_H
29 #define _INPUT_INTERNAL_H 1
30
31 #include <vlc_access.h>
32 #include <vlc_demux.h>
33 #include <vlc_input.h>
34
35 /*****************************************************************************
36  *  Private input fields
37  *****************************************************************************/
38 /* input_source_t: gathers all information per input source */
39 typedef struct
40 {
41     /* Input item description */
42     input_item_t *p_item;
43
44     /* Access/Stream/Demux plugins */
45     access_t *p_access;
46     stream_t *p_stream;
47     demux_t  *p_demux;
48
49     /* Title infos for that input */
50     vlc_bool_t   b_title_demux; /* Titles/Seekpoints provided by demux */
51     int          i_title;
52     input_title_t **title;
53
54     int i_title_offset;
55     int i_seekpoint_offset;
56
57     int i_title_start;
58     int i_title_end;
59     int i_seekpoint_start;
60     int i_seekpoint_end;
61
62     /* Properties */
63     vlc_bool_t b_can_pause;
64     vlc_bool_t b_can_pace_control;
65     vlc_bool_t b_can_rate_control;
66     vlc_bool_t b_rescale_ts;
67
68     vlc_bool_t b_eof;   /* eof of demuxer */
69     double     f_fps;
70
71     /* Clock average variation */
72     int     i_cr_average;
73
74 } input_source_t;
75
76 /** Private input fields */
77 struct input_thread_private_t
78 {
79     /* Global properties */
80     vlc_bool_t  b_can_pause;
81     vlc_bool_t  b_can_rate_control;
82
83     int         i_rate;
84     /* */
85     int64_t     i_start;    /* :start-time,0 by default */
86     int64_t     i_stop;     /* :stop-time, 0 if none */
87     int64_t     i_run;      /* :run-time, 0 if none */
88
89     /* Title infos FIXME multi-input (not easy) ? */
90     int          i_title;
91     input_title_t **title;
92
93     int i_title_offset;
94     int i_seekpoint_offset;
95
96     /* User bookmarks FIXME won't be easy with multiples input */
97     int         i_bookmark;
98     seekpoint_t **bookmark;
99
100     /* Input attachment */
101     int i_attachment;
102     input_attachment_t **attachment;
103
104     /* Output */
105     es_out_t    *p_es_out;
106     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
107     vlc_bool_t      b_sout_keep;
108     vlc_bool_t      b_out_pace_control; /*     idem ? */
109     vlc_bool_t      b_owns_its_sout;
110
111     /* Main input properties */
112     input_source_t input;
113     /* Slave demuxers (subs, and others) */
114     int            i_slave;
115     input_source_t **slave;
116
117     /* Stats counters */
118     struct {
119         counter_t *p_read_packets;
120         counter_t *p_read_bytes;
121         counter_t *p_input_bitrate;
122         counter_t *p_demux_read;
123         counter_t *p_demux_bitrate;
124         counter_t *p_decoded_audio;
125         counter_t *p_decoded_video;
126         counter_t *p_decoded_sub;
127         counter_t *p_sout_sent_packets;
128         counter_t *p_sout_sent_bytes;
129         counter_t *p_sout_send_bitrate;
130         counter_t *p_played_abuffers;
131         counter_t *p_lost_abuffers;
132         counter_t *p_displayed_pictures;
133         counter_t *p_lost_pictures;
134         vlc_mutex_t counters_lock;
135     } counters;
136
137     /* Buffer of pending actions */
138     vlc_mutex_t lock_control;
139     int i_control;
140     struct
141     {
142         /* XXX for string value you have to allocate it before calling
143          * input_ControlPush */
144         int         i_type;
145         vlc_value_t val;
146     } control[INPUT_CONTROL_FIFO_SIZE];
147 };
148
149 /***************************************************************************
150  * Internal control helpers
151  ***************************************************************************/
152 enum input_control_e
153 {
154     INPUT_CONTROL_SET_DIE,
155
156     INPUT_CONTROL_SET_STATE,
157
158     INPUT_CONTROL_SET_RATE,
159     INPUT_CONTROL_SET_RATE_SLOWER,
160     INPUT_CONTROL_SET_RATE_FASTER,
161
162     INPUT_CONTROL_SET_POSITION,
163     INPUT_CONTROL_SET_POSITION_OFFSET,
164
165     INPUT_CONTROL_SET_TIME,
166     INPUT_CONTROL_SET_TIME_OFFSET,
167
168     INPUT_CONTROL_SET_PROGRAM,
169
170     INPUT_CONTROL_SET_TITLE,
171     INPUT_CONTROL_SET_TITLE_NEXT,
172     INPUT_CONTROL_SET_TITLE_PREV,
173
174     INPUT_CONTROL_SET_SEEKPOINT,
175     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
176     INPUT_CONTROL_SET_SEEKPOINT_PREV,
177
178     INPUT_CONTROL_SET_BOOKMARK,
179
180     INPUT_CONTROL_SET_ES,
181
182     INPUT_CONTROL_SET_AUDIO_DELAY,
183     INPUT_CONTROL_SET_SPU_DELAY,
184
185     INPUT_CONTROL_ADD_SLAVE,
186 };
187
188 /* Internal helpers */
189 static inline void input_ControlPush( input_thread_t *p_input,
190                                       int i_type, vlc_value_t *p_val )
191 {
192     vlc_mutex_lock( &p_input->p->lock_control );
193     if( i_type == INPUT_CONTROL_SET_DIE )
194     {
195         /* Special case, empty the control */
196         p_input->p->i_control = 1;
197         p_input->p->control[0].i_type = i_type;
198         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
199     }
200     else
201     {
202         if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
203         {
204             msg_Err( p_input, "input control fifo overflow, trashing type=%d",
205                      i_type );
206             vlc_mutex_unlock( &p_input->p->lock_control );
207             return;
208         }
209         p_input->p->control[p_input->p->i_control].i_type = i_type;
210         if( p_val )
211             p_input->p->control[p_input->p->i_control].val = *p_val;
212         else
213             memset( &p_input->p->control[p_input->p->i_control].val, 0,
214                     sizeof( vlc_value_t ) );
215
216         p_input->p->i_control++;
217     }
218     vlc_mutex_unlock( &p_input->p->lock_control );
219 }
220
221 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
222  * anyway. */
223 static inline void input_ItemInit( vlc_object_t *p_o, input_item_t *p_i )
224 {
225     memset( p_i, 0, sizeof(input_item_t) );
226     p_i->psz_name = NULL;
227     p_i->psz_uri = NULL;
228     TAB_INIT( p_i->i_es, p_i->es );
229     TAB_INIT( p_i->i_options, p_i->ppsz_options );
230     p_i->optflagv = NULL, p_i->optflagc = 0;
231     TAB_INIT( p_i->i_categories, p_i->pp_categories );
232
233     p_i->i_type = ITEM_TYPE_UNKNOWN;
234     p_i->b_fixed_name = VLC_TRUE;
235
236     p_i->p_stats = NULL;
237     p_i->p_meta = NULL;
238
239     vlc_mutex_init( p_o, &p_i->lock );
240     vlc_event_manager_init( &p_i->event_manager, p_i, p_o );
241     vlc_event_manager_register_event_type( &p_i->event_manager,
242         vlc_InputItemMetaChanged );
243     vlc_event_manager_register_event_type( &p_i->event_manager,
244         vlc_InputItemSubItemAdded );
245     vlc_event_manager_register_event_type( &p_i->event_manager,
246         vlc_InputItemDurationChanged );
247     vlc_event_manager_register_event_type( &p_i->event_manager,
248         vlc_InputItemPreparsedChanged );
249 }
250
251 static inline void input_item_SetPreparsed( input_item_t *p_i, vlc_bool_t preparsed )
252 {
253     vlc_bool_t send_event = VLC_FALSE;
254
255     if( !p_i->p_meta )
256         p_i->p_meta = vlc_meta_New();
257
258     vlc_mutex_lock( &p_i->lock );
259     int new_status;
260     if( preparsed )
261         new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
262     else
263         new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
264     if ( p_i->p_meta->i_status != new_status )
265     {
266         p_i->p_meta->i_status = new_status;
267         send_event = VLC_TRUE;
268     }
269
270     vlc_mutex_unlock( &p_i->lock );
271
272     if ( send_event == VLC_TRUE )
273     {
274         vlc_event_t event;
275         event.type = vlc_InputItemPreparsedChanged;
276         event.u.input_item_preparsed_changed.new_status = new_status;
277         vlc_event_send( &p_i->event_manager, &event );
278     }
279 }
280
281 static inline void input_item_SetMetaFetched( input_item_t *p_i, vlc_bool_t metafetched )
282 {
283     if( !p_i->p_meta )
284         p_i->p_meta = vlc_meta_New();
285
286     if( metafetched )
287         p_i->p_meta->i_status |= ITEM_META_FETCHED;
288     else
289         p_i->p_meta->i_status &= ~ITEM_META_FETCHED;
290 }
291
292 static inline void input_item_SetArtNotFound( input_item_t *p_i, vlc_bool_t notfound )
293 {
294     if( !p_i->p_meta )
295         p_i->p_meta = vlc_meta_New();
296
297     if( notfound )
298         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
299     else
300         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
301 }
302
303 static inline void input_item_SetArtFetched( input_item_t *p_i, vlc_bool_t artfetched )
304 {
305     if( !p_i->p_meta )
306         p_i->p_meta = vlc_meta_New();
307
308     if( artfetched )
309         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
310     else
311         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
312 }
313
314
315 /**********************************************************************
316  * Item metadata
317  **********************************************************************/
318 typedef struct playlist_album_t
319 {
320     char *psz_artist;
321     char *psz_album;
322     char *psz_arturl;
323     vlc_bool_t b_found;
324 } playlist_album_t;
325
326 int         input_MetaFetch     ( playlist_t *, input_item_t * );
327 int         input_ArtFind       ( playlist_t *, input_item_t * );
328 vlc_bool_t  input_MetaSatisfied ( playlist_t*, input_item_t*,
329                                   uint32_t*, uint32_t* );
330 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
331
332 /* Becarefull; p_item lock HAS to be taken */
333 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
334
335 /***************************************************************************
336  * Internal prototypes
337  ***************************************************************************/
338
339 /* misc/stats.c */
340 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
341
342 /* input.c */
343 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
344 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
345
346 sout_instance_t * input_DetachSout( input_thread_t *p_input );
347
348 /* var.c */
349 void input_ControlVarInit ( input_thread_t * );
350 void input_ControlVarClean( input_thread_t * );
351 void input_ControlVarNavigation( input_thread_t * );
352 void input_ControlVarTitle( input_thread_t *, int i_title );
353
354 void input_ConfigVarInit ( input_thread_t * );
355
356 /* stream.c */
357 stream_t *stream_AccessNew( access_t *p_access, vlc_bool_t );
358 void stream_AccessDelete( stream_t *s );
359 void stream_AccessReset( stream_t *s );
360 void stream_AccessUpdate( stream_t *s );
361
362 /* decoder.c */
363 void       input_DecoderDiscontinuity( decoder_t * p_dec, vlc_bool_t b_flush );
364 vlc_bool_t input_DecoderEmpty( decoder_t * p_dec );
365 int        input_DecoderSetCcState( decoder_t *, vlc_bool_t b_decode, int i_channel );
366 int        input_DecoderGetCcState( decoder_t *, vlc_bool_t *pb_decode, int i_channel );
367 void       input_DecoderIsCcPresent( decoder_t *, vlc_bool_t pb_present[4] );
368
369 /* es_out.c */
370 es_out_t  *input_EsOutNew( input_thread_t *, int i_rate );
371 void       input_EsOutDelete( es_out_t * );
372 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
373 void       input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
374 void       input_EsOutChangeRate( es_out_t *, int );
375 void       input_EsOutChangeState( es_out_t * );
376 void       input_EsOutChangePosition( es_out_t * );
377 vlc_bool_t input_EsOutDecodersEmpty( es_out_t * );
378
379 /* clock.c */
380 enum /* Synchro states */
381 {
382     SYNCHRO_OK     = 0,
383     SYNCHRO_START  = 1,
384     SYNCHRO_REINIT = 2,
385 };
386
387 typedef struct
388 {
389     /* Synchronization information */
390     mtime_t                 delta_cr;
391     mtime_t                 cr_ref, sysdate_ref;
392     mtime_t                 last_sysdate;
393     mtime_t                 last_cr; /* reference to detect unexpected stream
394                                       * discontinuities                      */
395     mtime_t                 last_pts;
396     mtime_t                 last_update;
397     int                     i_synchro_state;
398
399     vlc_bool_t              b_master;
400
401     int                     i_rate;
402
403     /* Config */
404     int                     i_cr_average;
405     int                     i_delta_cr_residue;
406 } input_clock_t;
407
408 void    input_ClockInit( input_clock_t *, vlc_bool_t b_master, int i_cr_average, int i_rate );
409 void    input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
410 void    input_ClockResetPCR( input_clock_t * );
411 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
412 void    input_ClockSetRate( input_clock_t *cl, int i_rate );
413
414 /* Subtitles */
415 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
416 int subtitles_Filter( const char *);
417
418 void MRLSplit( char *, const char **, const char **, char ** );
419
420 static inline void input_ChangeState( input_thread_t *p_input, int state )
421 {
422     var_SetInteger( p_input, "state", p_input->i_state = state );
423 }
424
425 /* Access */
426
427 #define access2_New( a, b, c, d ) __access2_New(VLC_OBJECT(a), b, c, d )
428 access_t * __access2_New( vlc_object_t *p_obj, const char *psz_access,
429                           const char *psz_demux, const char *psz_path );
430 access_t * access2_FilterNew( access_t *p_source,
431                               const char *psz_access_filter );
432 void access2_Delete( access_t * );
433
434 /* Demuxer */
435 #include <vlc_demux.h>
436
437 /* stream_t *s could be null and then it mean a access+demux in one */
438 #define demux2_New( a, b, c, d, e, f,g ) __demux2_New(VLC_OBJECT(a),b,c,d,e,f,g)
439 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 );
440
441 void demux2_Delete(demux_t *);
442
443 static inline int demux2_Demux( demux_t *p_demux )
444 {
445     return p_demux->pf_demux( p_demux );
446 }
447 static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
448 {
449     return p_demux->pf_control( p_demux, i_query, args );
450 }
451 static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
452 {
453     va_list args;
454     int     i_result;
455
456     va_start( args, i_query );
457     i_result = demux2_vaControl( p_demux, i_query, args );
458     va_end( args );
459     return i_result;
460 }
461
462 /* Stream */
463 /**
464  * stream_t definition
465  */
466 struct stream_t
467 {
468     VLC_COMMON_MEMBERS
469
470     /*block_t *(*pf_block)  ( stream_t *, int i_size );*/
471     int      (*pf_read)   ( stream_t *, void *p_read, int i_read );
472     int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, int i_peek );
473     int      (*pf_control)( stream_t *, int i_query, va_list );
474     void     (*pf_destroy)( stream_t *);
475
476     stream_sys_t *p_sys;
477
478     /* UTF-16 and UTF-32 file reading */
479     vlc_iconv_t     conv;
480     int             i_char_width;
481     vlc_bool_t      b_little_endian;
482 };
483
484 #include <libvlc.h>
485
486 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
487 {
488     return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
489                                           VLC_OBJECT_STREAM, "stream" );
490 }
491
492 #endif