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;
153 /* XXX for string value you have to allocate it before calling
154 * input_ControlPush */
157 } control[INPUT_CONTROL_FIFO_SIZE];
160 /***************************************************************************
161 * Internal control helpers
162 ***************************************************************************/
165 INPUT_CONTROL_SET_DIE,
167 INPUT_CONTROL_SET_STATE,
169 INPUT_CONTROL_SET_RATE,
170 INPUT_CONTROL_SET_RATE_SLOWER,
171 INPUT_CONTROL_SET_RATE_FASTER,
173 INPUT_CONTROL_SET_POSITION,
174 INPUT_CONTROL_SET_POSITION_OFFSET,
176 INPUT_CONTROL_SET_TIME,
177 INPUT_CONTROL_SET_TIME_OFFSET,
179 INPUT_CONTROL_SET_PROGRAM,
181 INPUT_CONTROL_SET_TITLE,
182 INPUT_CONTROL_SET_TITLE_NEXT,
183 INPUT_CONTROL_SET_TITLE_PREV,
185 INPUT_CONTROL_SET_SEEKPOINT,
186 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
187 INPUT_CONTROL_SET_SEEKPOINT_PREV,
189 INPUT_CONTROL_SET_BOOKMARK,
191 INPUT_CONTROL_SET_ES,
193 INPUT_CONTROL_SET_AUDIO_DELAY,
194 INPUT_CONTROL_SET_SPU_DELAY,
196 INPUT_CONTROL_ADD_SLAVE,
198 INPUT_CONTROL_SET_RECORD_STATE,
201 /* Internal helpers */
202 static inline void input_ControlPush( input_thread_t *p_input,
203 int i_type, vlc_value_t *p_val )
205 vlc_mutex_lock( &p_input->p->lock_control );
206 if( i_type == INPUT_CONTROL_SET_DIE )
208 /* Special case, empty the control */
209 p_input->p->i_control = 1;
210 p_input->p->control[0].i_type = i_type;
211 memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
214 if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
216 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
221 p_input->p->control[p_input->p->i_control].i_type = i_type;
223 p_input->p->control[p_input->p->i_control].val = *p_val;
225 memset( &p_input->p->control[p_input->p->i_control].val, 0,
226 sizeof( vlc_value_t ) );
228 p_input->p->i_control++;
230 vlc_mutex_unlock( &p_input->p->lock_control );
233 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
236 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
238 bool send_event = false;
241 p_i->p_meta = vlc_meta_New();
243 vlc_mutex_lock( &p_i->lock );
246 new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
248 new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
249 if( p_i->p_meta->i_status != new_status )
251 p_i->p_meta->i_status = new_status;
255 vlc_mutex_unlock( &p_i->lock );
260 event.type = vlc_InputItemPreparsedChanged;
261 event.u.input_item_preparsed_changed.new_status = new_status;
262 vlc_event_send( &p_i->event_manager, &event );
266 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
269 p_i->p_meta = vlc_meta_New();
272 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
274 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
277 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
280 p_i->p_meta = vlc_meta_New();
283 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
285 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
288 void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
290 /**********************************************************************
292 **********************************************************************/
293 typedef struct playlist_album_t
301 int input_ArtFind ( playlist_t *, input_item_t * );
302 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
304 /* Becarefull; p_item lock HAS to be taken */
305 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
307 /***************************************************************************
308 * Internal prototypes
309 ***************************************************************************/
312 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
315 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
316 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
318 sout_instance_t * input_DetachSout( input_thread_t *p_input );
321 void input_ControlVarInit ( input_thread_t * );
322 void input_ControlVarStop( input_thread_t * );
323 void input_ControlVarNavigation( input_thread_t * );
324 void input_ControlVarTitle( input_thread_t *, int i_title );
326 void input_ConfigVarInit ( input_thread_t * );
329 stream_t *stream_AccessNew( access_t *p_access, bool );
330 void stream_AccessDelete( stream_t *s );
331 void stream_AccessReset( stream_t *s );
332 void stream_AccessUpdate( stream_t *s );
335 void input_DecoderDiscontinuity( decoder_t * p_dec, bool b_flush );
336 bool input_DecoderEmpty( decoder_t * p_dec );
337 int input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
338 int input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
339 void input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
342 es_out_t *input_EsOutNew( input_thread_t *, int i_rate );
343 void input_EsOutDelete( es_out_t * );
344 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
345 void input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
346 int input_EsOutSetRecord( es_out_t *, bool b_record );
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 static inline void input_ChangeStateWithVarCallback( input_thread_t *p_input, int state, bool callback )
393 const bool changed = p_input->i_state != state;
395 p_input->i_state = state;
397 input_item_SetHasErrorWhenReading( p_input->p->input.p_item, (state == ERROR_S) );
401 var_SetInteger( p_input, "state", state );
407 var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
412 event.type = vlc_InputStateChanged;
413 event.u.input_state_changed.new_state = state;
414 vlc_event_send( &p_input->p->event_manager, &event );
418 static inline void input_ChangeState( input_thread_t *p_input, int state )
420 input_ChangeStateWithVarCallback( p_input, state, true );
423 /* Helpers FIXME to export without input_ prefix */
424 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
426 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
430 #define access_New( a, b, c, d ) __access_New(VLC_OBJECT(a), b, c, d )
431 access_t * __access_New( vlc_object_t *p_obj, const char *psz_access,
432 const char *psz_demux, const char *psz_path );
433 access_t * access_FilterNew( access_t *p_source,
434 const char *psz_access_filter );
435 void access_Delete( access_t * );
438 #include <vlc_demux.h>
440 /* stream_t *s could be null and then it mean a access+demux in one */
441 #define demux_New( a, b, c, d, e, f,g ) __demux_New(VLC_OBJECT(a),b,c,d,e,f,g)
442 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 );
444 void demux_Delete(demux_t *);
446 static inline int demux_Demux( demux_t *p_demux )
448 return p_demux->pf_demux( p_demux );
450 static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
452 return p_demux->pf_control( p_demux, i_query, args );
454 static inline int demux_Control( demux_t *p_demux, int i_query, ... )
459 va_start( args, i_query );
460 i_result = demux_vaControl( p_demux, i_query, args );
467 * stream_t definition
473 /*block_t *(*pf_block) ( stream_t *, int i_size );*/
474 int (*pf_read) ( stream_t *, void *p_read, unsigned int i_read );
475 int (*pf_peek) ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
476 int (*pf_control)( stream_t *, int i_query, va_list );
477 void (*pf_destroy)( stream_t *);
481 /* UTF-16 and UTF-32 file reading */
484 bool b_little_endian;
489 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
491 return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
492 VLC_OBJECT_GENERIC, "stream" );