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 ? */
107 bool b_out_pace_control; /* idem ? */
109 /* Main input properties */
110 input_source_t input;
111 /* Slave demuxers (subs, and others) */
113 input_source_t **slave;
117 counter_t *p_read_packets;
118 counter_t *p_read_bytes;
119 counter_t *p_input_bitrate;
120 counter_t *p_demux_read;
121 counter_t *p_demux_bitrate;
122 counter_t *p_decoded_audio;
123 counter_t *p_decoded_video;
124 counter_t *p_decoded_sub;
125 counter_t *p_sout_sent_packets;
126 counter_t *p_sout_sent_bytes;
127 counter_t *p_sout_send_bitrate;
128 counter_t *p_played_abuffers;
129 counter_t *p_lost_abuffers;
130 counter_t *p_displayed_pictures;
131 counter_t *p_lost_pictures;
132 vlc_mutex_t counters_lock;
135 /* Buffer of pending actions */
136 vlc_mutex_t lock_control;
140 /* XXX for string value you have to allocate it before calling
141 * input_ControlPush */
144 } control[INPUT_CONTROL_FIFO_SIZE];
147 /***************************************************************************
148 * Internal control helpers
149 ***************************************************************************/
152 INPUT_CONTROL_SET_DIE,
154 INPUT_CONTROL_SET_STATE,
156 INPUT_CONTROL_SET_RATE,
157 INPUT_CONTROL_SET_RATE_SLOWER,
158 INPUT_CONTROL_SET_RATE_FASTER,
160 INPUT_CONTROL_SET_POSITION,
161 INPUT_CONTROL_SET_POSITION_OFFSET,
163 INPUT_CONTROL_SET_TIME,
164 INPUT_CONTROL_SET_TIME_OFFSET,
166 INPUT_CONTROL_SET_PROGRAM,
168 INPUT_CONTROL_SET_TITLE,
169 INPUT_CONTROL_SET_TITLE_NEXT,
170 INPUT_CONTROL_SET_TITLE_PREV,
172 INPUT_CONTROL_SET_SEEKPOINT,
173 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
174 INPUT_CONTROL_SET_SEEKPOINT_PREV,
176 INPUT_CONTROL_SET_BOOKMARK,
178 INPUT_CONTROL_SET_ES,
180 INPUT_CONTROL_SET_AUDIO_DELAY,
181 INPUT_CONTROL_SET_SPU_DELAY,
183 INPUT_CONTROL_ADD_SLAVE,
186 /* Internal helpers */
187 static inline void input_ControlPush( input_thread_t *p_input,
188 int i_type, vlc_value_t *p_val )
190 vlc_mutex_lock( &p_input->p->lock_control );
191 if( i_type == INPUT_CONTROL_SET_DIE )
193 /* Special case, empty the control */
194 p_input->p->i_control = 1;
195 p_input->p->control[0].i_type = i_type;
196 memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
200 if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
202 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
204 vlc_mutex_unlock( &p_input->p->lock_control );
207 p_input->p->control[p_input->p->i_control].i_type = i_type;
209 p_input->p->control[p_input->p->i_control].val = *p_val;
211 memset( &p_input->p->control[p_input->p->i_control].val, 0,
212 sizeof( vlc_value_t ) );
214 p_input->p->i_control++;
216 vlc_mutex_unlock( &p_input->p->lock_control );
219 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
222 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
224 bool send_event = false;
227 p_i->p_meta = vlc_meta_New();
229 vlc_mutex_lock( &p_i->lock );
232 new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
234 new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
235 if ( p_i->p_meta->i_status != new_status )
237 p_i->p_meta->i_status = new_status;
241 vlc_mutex_unlock( &p_i->lock );
243 if ( send_event == true )
246 event.type = vlc_InputItemPreparsedChanged;
247 event.u.input_item_preparsed_changed.new_status = new_status;
248 vlc_event_send( &p_i->event_manager, &event );
252 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
255 p_i->p_meta = vlc_meta_New();
258 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
260 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
263 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
266 p_i->p_meta = vlc_meta_New();
269 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
271 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
275 /**********************************************************************
277 **********************************************************************/
278 typedef struct playlist_album_t
286 int input_ArtFind ( playlist_t *, input_item_t * );
287 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
289 /* Becarefull; p_item lock HAS to be taken */
290 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
292 /***************************************************************************
293 * Internal prototypes
294 ***************************************************************************/
297 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
300 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
301 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
303 sout_instance_t * input_DetachSout( input_thread_t *p_input );
306 void input_ControlVarInit ( input_thread_t * );
307 void input_ControlVarClean( input_thread_t * );
308 void input_ControlVarNavigation( input_thread_t * );
309 void input_ControlVarTitle( input_thread_t *, int i_title );
311 void input_ConfigVarInit ( input_thread_t * );
314 stream_t *stream_AccessNew( access_t *p_access, bool );
315 void stream_AccessDelete( stream_t *s );
316 void stream_AccessReset( stream_t *s );
317 void stream_AccessUpdate( stream_t *s );
320 void input_DecoderDiscontinuity( decoder_t * p_dec, bool b_flush );
321 bool input_DecoderEmpty( decoder_t * p_dec );
322 int input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
323 int input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
324 void input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
327 es_out_t *input_EsOutNew( input_thread_t *, int i_rate );
328 void input_EsOutDelete( es_out_t * );
329 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
330 void input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
331 void input_EsOutChangeRate( es_out_t *, int );
332 void input_EsOutChangeState( es_out_t * );
333 void input_EsOutChangePosition( es_out_t * );
334 bool input_EsOutDecodersEmpty( es_out_t * );
337 enum /* Synchro states */
346 /* Synchronization information */
348 mtime_t cr_ref, sysdate_ref;
349 mtime_t last_sysdate;
350 mtime_t last_cr; /* reference to detect unexpected stream
362 int i_delta_cr_residue;
365 void input_ClockInit( input_clock_t *, bool b_master, int i_cr_average, int i_rate );
366 void input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
367 void input_ClockResetPCR( input_clock_t * );
368 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
369 void input_ClockSetRate( input_clock_t *cl, int i_rate );
372 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
373 int subtitles_Filter( const char *);
375 void MRLSplit( char *, const char **, const char **, char ** );
377 static inline void input_ChangeState( input_thread_t *p_input, int state )
379 var_SetInteger( p_input, "state", p_input->i_state = state );
384 #define access_New( a, b, c, d ) __access_New(VLC_OBJECT(a), b, c, d )
385 access_t * __access_New( vlc_object_t *p_obj, const char *psz_access,
386 const char *psz_demux, const char *psz_path );
387 access_t * access_FilterNew( access_t *p_source,
388 const char *psz_access_filter );
389 void access_Delete( access_t * );
392 #include <vlc_demux.h>
394 /* stream_t *s could be null and then it mean a access+demux in one */
395 #define demux_New( a, b, c, d, e, f,g ) __demux_New(VLC_OBJECT(a),b,c,d,e,f,g)
396 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 );
398 void demux_Delete(demux_t *);
400 static inline int demux_Demux( demux_t *p_demux )
402 return p_demux->pf_demux( p_demux );
404 static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
406 return p_demux->pf_control( p_demux, i_query, args );
408 static inline int demux_Control( demux_t *p_demux, int i_query, ... )
413 va_start( args, i_query );
414 i_result = demux_vaControl( p_demux, i_query, args );
421 * stream_t definition
427 /*block_t *(*pf_block) ( stream_t *, int i_size );*/
428 int (*pf_read) ( stream_t *, void *p_read, int i_read );
429 int (*pf_peek) ( stream_t *, const uint8_t **pp_peek, int i_peek );
430 int (*pf_control)( stream_t *, int i_query, va_list );
431 void (*pf_destroy)( stream_t *);
435 /* UTF-16 and UTF-32 file reading */
438 bool b_little_endian;
443 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
445 return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
446 VLC_OBJECT_STREAM, "stream" );