1 /*****************************************************************************
2 * input_internal.h: Internal input structures
3 *****************************************************************************
4 * Copyright (C) 1998-2006 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
24 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
25 # error This header file can only be included from LibVLC.
28 #ifndef _INPUT_INTERNAL_H
29 #define _INPUT_INTERNAL_H 1
31 #include <vlc_access.h>
32 #include <vlc_demux.h>
33 #include <vlc_input.h>
35 /*****************************************************************************
36 * Private input fields
37 *****************************************************************************/
38 /* input_source_t: gathers all information per input source */
41 /* Input item description */
44 /* Access/Stream/Demux plugins */
49 /* Title infos for that input */
50 bool b_title_demux; /* Titles/Seekpoints provided by demux */
52 input_title_t **title;
55 int i_seekpoint_offset;
59 int i_seekpoint_start;
64 bool b_can_pace_control;
65 bool b_can_rate_control;
68 bool b_eof; /* eof of demuxer */
71 /* Clock average variation */
76 /** Private input fields */
77 struct input_thread_private_t
79 /* Global properties */
81 bool b_can_rate_control;
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 */
89 /* Title infos FIXME multi-input (not easy) ? */
91 input_title_t **title;
94 int i_seekpoint_offset;
96 /* User bookmarks FIXME won't be easy with multiples input */
98 seekpoint_t **bookmark;
100 /* Input attachment */
102 input_attachment_t **attachment;
106 sout_instance_t *p_sout; /* XXX Move it to es_out ? */
108 bool b_out_pace_control; /* idem ? */
109 bool b_owns_its_sout;
111 /* Main input properties */
112 input_source_t input;
113 /* Slave demuxers (subs, and others) */
115 input_source_t **slave;
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;
137 /* Buffer of pending actions */
138 vlc_mutex_t lock_control;
142 /* XXX for string value you have to allocate it before calling
143 * input_ControlPush */
146 } control[INPUT_CONTROL_FIFO_SIZE];
149 /***************************************************************************
150 * Internal control helpers
151 ***************************************************************************/
154 INPUT_CONTROL_SET_DIE,
156 INPUT_CONTROL_SET_STATE,
158 INPUT_CONTROL_SET_RATE,
159 INPUT_CONTROL_SET_RATE_SLOWER,
160 INPUT_CONTROL_SET_RATE_FASTER,
162 INPUT_CONTROL_SET_POSITION,
163 INPUT_CONTROL_SET_POSITION_OFFSET,
165 INPUT_CONTROL_SET_TIME,
166 INPUT_CONTROL_SET_TIME_OFFSET,
168 INPUT_CONTROL_SET_PROGRAM,
170 INPUT_CONTROL_SET_TITLE,
171 INPUT_CONTROL_SET_TITLE_NEXT,
172 INPUT_CONTROL_SET_TITLE_PREV,
174 INPUT_CONTROL_SET_SEEKPOINT,
175 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
176 INPUT_CONTROL_SET_SEEKPOINT_PREV,
178 INPUT_CONTROL_SET_BOOKMARK,
180 INPUT_CONTROL_SET_ES,
182 INPUT_CONTROL_SET_AUDIO_DELAY,
183 INPUT_CONTROL_SET_SPU_DELAY,
185 INPUT_CONTROL_ADD_SLAVE,
188 /* Internal helpers */
189 static inline void input_ControlPush( input_thread_t *p_input,
190 int i_type, vlc_value_t *p_val )
192 vlc_mutex_lock( &p_input->p->lock_control );
193 if( i_type == INPUT_CONTROL_SET_DIE )
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 ) );
202 if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
204 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
206 vlc_mutex_unlock( &p_input->p->lock_control );
209 p_input->p->control[p_input->p->i_control].i_type = i_type;
211 p_input->p->control[p_input->p->i_control].val = *p_val;
213 memset( &p_input->p->control[p_input->p->i_control].val, 0,
214 sizeof( vlc_value_t ) );
216 p_input->p->i_control++;
218 vlc_mutex_unlock( &p_input->p->lock_control );
221 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
224 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
226 bool send_event = false;
229 p_i->p_meta = vlc_meta_New();
231 vlc_mutex_lock( &p_i->lock );
234 new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
236 new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
237 if ( p_i->p_meta->i_status != new_status )
239 p_i->p_meta->i_status = new_status;
243 vlc_mutex_unlock( &p_i->lock );
245 if ( send_event == true )
248 event.type = vlc_InputItemPreparsedChanged;
249 event.u.input_item_preparsed_changed.new_status = new_status;
250 vlc_event_send( &p_i->event_manager, &event );
254 static inline void input_item_SetMetaFetched( input_item_t *p_i, bool metafetched )
257 p_i->p_meta = vlc_meta_New();
260 p_i->p_meta->i_status |= ITEM_META_FETCHED;
262 p_i->p_meta->i_status &= ~ITEM_META_FETCHED;
265 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
268 p_i->p_meta = vlc_meta_New();
271 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
273 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
276 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
279 p_i->p_meta = vlc_meta_New();
282 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
284 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
288 /**********************************************************************
290 **********************************************************************/
291 typedef struct playlist_album_t
299 int input_MetaFetch ( playlist_t *, input_item_t * );
300 int input_ArtFind ( playlist_t *, input_item_t * );
301 bool input_MetaSatisfied ( playlist_t*, input_item_t*,
302 uint32_t*, uint32_t* );
303 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
305 /* Becarefull; p_item lock HAS to be taken */
306 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
308 /***************************************************************************
309 * Internal prototypes
310 ***************************************************************************/
313 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
316 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
317 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
319 sout_instance_t * input_DetachSout( input_thread_t *p_input );
322 void input_ControlVarInit ( input_thread_t * );
323 void input_ControlVarClean( input_thread_t * );
324 void input_ControlVarNavigation( input_thread_t * );
325 void input_ControlVarTitle( input_thread_t *, int i_title );
327 void input_ConfigVarInit ( input_thread_t * );
330 stream_t *stream_AccessNew( access_t *p_access, bool );
331 void stream_AccessDelete( stream_t *s );
332 void stream_AccessReset( stream_t *s );
333 void stream_AccessUpdate( stream_t *s );
336 void input_DecoderDiscontinuity( decoder_t * p_dec, bool b_flush );
337 bool input_DecoderEmpty( decoder_t * p_dec );
338 int input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
339 int input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
340 void input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
343 es_out_t *input_EsOutNew( input_thread_t *, int i_rate );
344 void input_EsOutDelete( es_out_t * );
345 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
346 void input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
347 void input_EsOutChangeRate( es_out_t *, int );
348 void input_EsOutChangeState( es_out_t * );
349 void input_EsOutChangePosition( es_out_t * );
350 bool input_EsOutDecodersEmpty( es_out_t * );
353 enum /* Synchro states */
362 /* Synchronization information */
364 mtime_t cr_ref, sysdate_ref;
365 mtime_t last_sysdate;
366 mtime_t last_cr; /* reference to detect unexpected stream
378 int i_delta_cr_residue;
381 void input_ClockInit( input_clock_t *, bool b_master, int i_cr_average, int i_rate );
382 void input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
383 void input_ClockResetPCR( input_clock_t * );
384 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
385 void input_ClockSetRate( input_clock_t *cl, int i_rate );
388 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
389 int subtitles_Filter( const char *);
391 void MRLSplit( char *, const char **, const char **, char ** );
393 static inline void input_ChangeState( input_thread_t *p_input, int state )
395 var_SetInteger( p_input, "state", p_input->i_state = state );
400 #define access2_New( a, b, c, d ) __access2_New(VLC_OBJECT(a), b, c, d )
401 access_t * __access2_New( vlc_object_t *p_obj, const char *psz_access,
402 const char *psz_demux, const char *psz_path );
403 access_t * access2_FilterNew( access_t *p_source,
404 const char *psz_access_filter );
405 void access2_Delete( access_t * );
408 #include <vlc_demux.h>
410 /* stream_t *s could be null and then it mean a access+demux in one */
411 #define demux_New( a, b, c, d, e, f,g ) __demux_New(VLC_OBJECT(a),b,c,d,e,f,g)
412 demux_t *__demux_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, bool );
414 void demux_Delete(demux_t *);
416 static inline int demux_Demux( demux_t *p_demux )
418 return p_demux->pf_demux( p_demux );
420 static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
422 return p_demux->pf_control( p_demux, i_query, args );
424 static inline int demux_Control( demux_t *p_demux, int i_query, ... )
429 va_start( args, i_query );
430 i_result = demux_vaControl( p_demux, i_query, args );
437 * stream_t definition
443 /*block_t *(*pf_block) ( stream_t *, int i_size );*/
444 int (*pf_read) ( stream_t *, void *p_read, int i_read );
445 int (*pf_peek) ( stream_t *, const uint8_t **pp_peek, int i_peek );
446 int (*pf_control)( stream_t *, int i_query, va_list );
447 void (*pf_destroy)( stream_t *);
451 /* UTF-16 and UTF-32 file reading */
454 bool b_little_endian;
459 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
461 return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
462 VLC_OBJECT_STREAM, "stream" );