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;
66 bool b_can_stream_record;
69 bool b_eof; /* eof of demuxer */
72 /* Clock average variation */
77 /** Private input fields */
78 struct input_thread_private_t
80 /* Object's event manager */
81 vlc_event_manager_t event_manager;
83 /* Global properties */
85 bool b_can_rate_control;
90 int64_t i_start; /* :start-time,0 by default */
91 int64_t i_stop; /* :stop-time, 0 if none */
92 int64_t i_run; /* :run-time, 0 if none */
94 /* Title infos FIXME multi-input (not easy) ? */
96 input_title_t **title;
99 int i_seekpoint_offset;
101 /* User bookmarks FIXME won't be easy with multiples input */
103 seekpoint_t **bookmark;
105 /* Input attachment */
107 input_attachment_t **attachment;
111 sout_instance_t *p_sout; /* XXX Move it to es_out ? */
112 bool b_out_pace_control; /* idem ? */
114 /* Main input properties */
115 input_source_t input;
116 /* Slave demuxers (subs, and others) */
118 input_source_t **slave;
120 /* pts delay fixup */
130 counter_t *p_read_packets;
131 counter_t *p_read_bytes;
132 counter_t *p_input_bitrate;
133 counter_t *p_demux_read;
134 counter_t *p_demux_bitrate;
135 counter_t *p_decoded_audio;
136 counter_t *p_decoded_video;
137 counter_t *p_decoded_sub;
138 counter_t *p_sout_sent_packets;
139 counter_t *p_sout_sent_bytes;
140 counter_t *p_sout_send_bitrate;
141 counter_t *p_played_abuffers;
142 counter_t *p_lost_abuffers;
143 counter_t *p_displayed_pictures;
144 counter_t *p_lost_pictures;
145 vlc_mutex_t counters_lock;
148 /* Buffer of pending actions */
149 vlc_mutex_t lock_control;
150 vlc_cond_t wait_control;
154 /* XXX for string value you have to allocate it before calling
155 * input_ControlPush */
158 } control[INPUT_CONTROL_FIFO_SIZE];
161 /***************************************************************************
162 * Internal control helpers
163 ***************************************************************************/
166 INPUT_CONTROL_SET_DIE,
168 INPUT_CONTROL_SET_STATE,
170 INPUT_CONTROL_SET_RATE,
171 INPUT_CONTROL_SET_RATE_SLOWER,
172 INPUT_CONTROL_SET_RATE_FASTER,
174 INPUT_CONTROL_SET_POSITION,
175 INPUT_CONTROL_SET_POSITION_OFFSET,
177 INPUT_CONTROL_SET_TIME,
178 INPUT_CONTROL_SET_TIME_OFFSET,
180 INPUT_CONTROL_SET_PROGRAM,
182 INPUT_CONTROL_SET_TITLE,
183 INPUT_CONTROL_SET_TITLE_NEXT,
184 INPUT_CONTROL_SET_TITLE_PREV,
186 INPUT_CONTROL_SET_SEEKPOINT,
187 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
188 INPUT_CONTROL_SET_SEEKPOINT_PREV,
190 INPUT_CONTROL_SET_BOOKMARK,
192 INPUT_CONTROL_SET_ES,
193 INPUT_CONTROL_RESTART_ES,
195 INPUT_CONTROL_SET_AUDIO_DELAY,
196 INPUT_CONTROL_SET_SPU_DELAY,
198 INPUT_CONTROL_ADD_SLAVE,
200 INPUT_CONTROL_SET_RECORD_STATE,
203 /* Internal helpers */
204 static inline void input_ControlPush( input_thread_t *p_input,
205 int i_type, vlc_value_t *p_val )
207 vlc_mutex_lock( &p_input->p->lock_control );
208 if( i_type == INPUT_CONTROL_SET_DIE )
210 /* Special case, empty the control */
211 p_input->p->i_control = 1;
212 p_input->p->control[0].i_type = i_type;
213 memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
215 else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
217 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
222 p_input->p->control[p_input->p->i_control].i_type = i_type;
224 p_input->p->control[p_input->p->i_control].val = *p_val;
226 memset( &p_input->p->control[p_input->p->i_control].val, 0,
227 sizeof( vlc_value_t ) );
229 p_input->p->i_control++;
231 vlc_cond_signal( &p_input->p->wait_control );
232 vlc_mutex_unlock( &p_input->p->lock_control );
235 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
238 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
240 bool send_event = false;
243 p_i->p_meta = vlc_meta_New();
245 vlc_mutex_lock( &p_i->lock );
248 new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
250 new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
251 if( p_i->p_meta->i_status != new_status )
253 p_i->p_meta->i_status = new_status;
257 vlc_mutex_unlock( &p_i->lock );
262 event.type = vlc_InputItemPreparsedChanged;
263 event.u.input_item_preparsed_changed.new_status = new_status;
264 vlc_event_send( &p_i->event_manager, &event );
268 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
271 p_i->p_meta = vlc_meta_New();
274 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
276 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
279 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
282 p_i->p_meta = vlc_meta_New();
285 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
287 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
290 void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
292 /**********************************************************************
294 **********************************************************************/
295 typedef struct playlist_album_t
303 int input_ArtFind ( playlist_t *, input_item_t * );
304 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
306 /* Becarefull; p_item lock HAS to be taken */
307 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
309 /***************************************************************************
310 * Internal prototypes
311 ***************************************************************************/
314 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
317 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
318 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
320 sout_instance_t * input_DetachSout( input_thread_t *p_input );
323 void input_ControlVarInit ( input_thread_t * );
324 void input_ControlVarStop( input_thread_t * );
325 void input_ControlVarNavigation( input_thread_t * );
326 void input_ControlVarTitle( input_thread_t *, int i_title );
328 void input_ConfigVarInit ( input_thread_t * );
331 stream_t *stream_AccessNew( access_t *p_access, bool );
332 void stream_AccessDelete( stream_t *s );
333 void stream_AccessReset( stream_t *s );
334 void stream_AccessUpdate( stream_t *s );
337 void input_DecoderDiscontinuity( decoder_t * p_dec, bool b_flush );
338 bool input_DecoderEmpty( decoder_t * p_dec );
339 int input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
340 int input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
341 void input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
344 es_out_t *input_EsOutNew( input_thread_t *, int i_rate );
345 void input_EsOutDelete( es_out_t * );
346 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
347 void input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
348 int input_EsOutSetRecord( es_out_t *, bool b_record );
349 void input_EsOutChangeRate( es_out_t *, int );
350 void input_EsOutChangeState( es_out_t * );
351 void input_EsOutChangePosition( es_out_t * );
352 bool input_EsOutDecodersEmpty( es_out_t * );
355 enum /* Synchro states */
364 /* Synchronization information */
366 mtime_t cr_ref, sysdate_ref;
367 mtime_t last_sysdate;
368 mtime_t last_cr; /* reference to detect unexpected stream
380 int i_delta_cr_residue;
383 void input_ClockInit( input_clock_t *, bool b_master, int i_cr_average, int i_rate );
384 void input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
385 void input_ClockResetPCR( input_clock_t * );
386 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
387 void input_ClockSetRate( input_clock_t *cl, int i_rate );
390 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
391 int subtitles_Filter( const char *);
393 static inline void input_ChangeStateWithVarCallback( input_thread_t *p_input, int i_state, bool callback )
395 const bool changed = p_input->i_state != i_state;
397 p_input->i_state = i_state;
398 if( i_state == ERROR_S )
399 p_input->b_error = true;
400 else if( i_state == END_S )
401 p_input->b_eof = true;
403 input_item_SetHasErrorWhenReading( p_input->p->input.p_item, (i_state == ERROR_S) );
407 var_SetInteger( p_input, "state", i_state );
413 var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
418 event.type = vlc_InputStateChanged;
419 event.u.input_state_changed.new_state = i_state;
420 vlc_event_send( &p_input->p->event_manager, &event );
424 static inline void input_ChangeState( input_thread_t *p_input, int state )
426 input_ChangeStateWithVarCallback( p_input, state, true );
429 /* Helpers FIXME to export without input_ prefix */
430 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
432 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
436 #define access_New( a, b, c, d ) __access_New(VLC_OBJECT(a), b, c, d )
437 access_t * __access_New( vlc_object_t *p_obj, const char *psz_access,
438 const char *psz_demux, const char *psz_path );
439 access_t * access_FilterNew( access_t *p_source,
440 const char *psz_access_filter );
441 void access_Delete( access_t * );
444 #include <vlc_demux.h>
446 /* stream_t *s could be null and then it mean a access+demux in one */
447 #define demux_New( a, b, c, d, e, f,g ) __demux_New(VLC_OBJECT(a),b,c,d,e,f,g)
448 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 );
450 void demux_Delete(demux_t *);
452 static inline int demux_Demux( demux_t *p_demux )
454 return p_demux->pf_demux( p_demux );
456 static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
458 return p_demux->pf_control( p_demux, i_query, args );
460 static inline int demux_Control( demux_t *p_demux, int i_query, ... )
465 va_start( args, i_query );
466 i_result = demux_vaControl( p_demux, i_query, args );
473 * stream_t definition
479 /*block_t *(*pf_block) ( stream_t *, int i_size );*/
480 int (*pf_read) ( stream_t *, void *p_read, unsigned int i_read );
481 int (*pf_peek) ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
482 int (*pf_control)( stream_t *, int i_query, va_list );
483 void (*pf_destroy)( stream_t *);
487 /* UTF-16 and UTF-32 file reading */
490 bool b_little_endian;
495 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
497 return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
498 VLC_OBJECT_GENERIC, "stream" );