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 #ifndef _INPUT_INTERNAL_H
25 #define _INPUT_INTERNAL_H 1
27 #include <vlc_access.h>
28 #include <vlc_demux.h>
29 #include <vlc_input.h>
31 /*****************************************************************************
32 * Private input fields
33 *****************************************************************************/
34 /* input_source_t: gathers all information per input source */
37 /* Input item description */
40 /* Access/Stream/Demux plugins */
45 /* Title infos for that input */
46 vlc_bool_t b_title_demux; /* Titles/Seekpoints provided by demux */
48 input_title_t **title;
51 int i_seekpoint_offset;
55 int i_seekpoint_start;
59 vlc_bool_t b_can_pace_control;
60 vlc_bool_t b_can_pause;
61 vlc_bool_t b_eof; /* eof of demuxer */
64 /* Clock average variation */
69 /** Private input fields */
70 struct input_thread_private_t
72 /* Global properties */
73 vlc_bool_t b_can_pause;
77 int64_t i_start; /* :start-time,0 by default */
78 int64_t i_stop; /* :stop-time, 0 if none */
79 int64_t i_run; /* :run-time, 0 if none */
81 /* Title infos FIXME multi-input (not easy) ? */
83 input_title_t **title;
86 int i_seekpoint_offset;
88 /* User bookmarks FIXME won't be easy with multiples input */
90 seekpoint_t **bookmark;
92 /* Input attachment */
94 input_attachment_t **attachment;
98 sout_instance_t *p_sout; /* XXX Move it to es_out ? */
99 vlc_bool_t b_sout_keep;
100 vlc_bool_t b_out_pace_control; /* idem ? */
102 /* Main input properties */
103 input_source_t input;
104 /* Slave demuxers (subs, and others) */
106 input_source_t **slave;
110 counter_t *p_read_packets;
111 counter_t *p_read_bytes;
112 counter_t *p_input_bitrate;
113 counter_t *p_demux_read;
114 counter_t *p_demux_bitrate;
115 counter_t *p_decoded_audio;
116 counter_t *p_decoded_video;
117 counter_t *p_decoded_sub;
118 counter_t *p_sout_sent_packets;
119 counter_t *p_sout_sent_bytes;
120 counter_t *p_sout_send_bitrate;
121 counter_t *p_played_abuffers;
122 counter_t *p_lost_abuffers;
123 counter_t *p_displayed_pictures;
124 counter_t *p_lost_pictures;
125 vlc_mutex_t counters_lock;
128 /* Buffer of pending actions */
129 vlc_mutex_t lock_control;
133 /* XXX for string value you have to allocate it before calling
134 * input_ControlPush */
137 } control[INPUT_CONTROL_FIFO_SIZE];
140 /***************************************************************************
141 * Internal control helpers
142 ***************************************************************************/
145 INPUT_CONTROL_SET_DIE,
147 INPUT_CONTROL_SET_STATE,
149 INPUT_CONTROL_SET_RATE,
150 INPUT_CONTROL_SET_RATE_SLOWER,
151 INPUT_CONTROL_SET_RATE_FASTER,
153 INPUT_CONTROL_SET_POSITION,
154 INPUT_CONTROL_SET_POSITION_OFFSET,
156 INPUT_CONTROL_SET_TIME,
157 INPUT_CONTROL_SET_TIME_OFFSET,
159 INPUT_CONTROL_SET_PROGRAM,
161 INPUT_CONTROL_SET_TITLE,
162 INPUT_CONTROL_SET_TITLE_NEXT,
163 INPUT_CONTROL_SET_TITLE_PREV,
165 INPUT_CONTROL_SET_SEEKPOINT,
166 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
167 INPUT_CONTROL_SET_SEEKPOINT_PREV,
169 INPUT_CONTROL_SET_BOOKMARK,
171 INPUT_CONTROL_SET_ES,
173 INPUT_CONTROL_SET_AUDIO_DELAY,
174 INPUT_CONTROL_SET_SPU_DELAY,
176 INPUT_CONTROL_ADD_SLAVE,
179 /* Internal helpers */
180 static inline void input_ControlPush( input_thread_t *p_input,
181 int i_type, vlc_value_t *p_val )
183 vlc_mutex_lock( &p_input->p->lock_control );
184 if( i_type == INPUT_CONTROL_SET_DIE )
186 /* Special case, empty the control */
187 p_input->p->i_control = 1;
188 p_input->p->control[0].i_type = i_type;
189 memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
193 if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
195 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
197 vlc_mutex_unlock( &p_input->p->lock_control );
200 p_input->p->control[p_input->p->i_control].i_type = i_type;
202 p_input->p->control[p_input->p->i_control].val = *p_val;
204 memset( &p_input->p->control[p_input->p->i_control].val, 0,
205 sizeof( vlc_value_t ) );
207 p_input->p->i_control++;
209 vlc_mutex_unlock( &p_input->p->lock_control );
212 /**********************************************************************
214 **********************************************************************/
215 typedef struct playlist_album_t
223 int input_MetaFetch ( playlist_t *, input_item_t * );
224 int input_ArtFind ( playlist_t *, input_item_t * );
225 vlc_bool_t input_MetaSatisfied ( playlist_t*, input_item_t*,
226 uint32_t*, uint32_t* );
227 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
229 /* Becarefull; p_item lock HAS to be taken */
230 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
232 /***************************************************************************
233 * Internal prototypes
234 ***************************************************************************/
237 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
240 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
241 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
243 void input_DestroyThreadExtended( input_thread_t *p_input, sout_instance_t ** );
246 void input_ControlVarInit ( input_thread_t * );
247 void input_ControlVarClean( input_thread_t * );
248 void input_ControlVarNavigation( input_thread_t * );
249 void input_ControlVarTitle( input_thread_t *, int i_title );
251 void input_ConfigVarInit ( input_thread_t * );
254 stream_t *stream_AccessNew( access_t *p_access, vlc_bool_t );
255 void stream_AccessDelete( stream_t *s );
256 void stream_AccessReset( stream_t *s );
257 void stream_AccessUpdate( stream_t *s );
260 void input_DecoderDiscontinuity( decoder_t * p_dec, vlc_bool_t b_flush );
261 vlc_bool_t input_DecoderEmpty( decoder_t * p_dec );
264 es_out_t *input_EsOutNew( input_thread_t * );
265 void input_EsOutDelete( es_out_t * );
266 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
267 void input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
268 void input_EsOutChangeRate( es_out_t * );
269 void input_EsOutChangeState( es_out_t * );
270 void input_EsOutChangePosition( es_out_t * );
271 vlc_bool_t input_EsOutDecodersEmpty( es_out_t * );
274 enum /* Synchro states */
283 /* Synchronization information */
285 mtime_t cr_ref, sysdate_ref;
286 mtime_t last_sysdate;
287 mtime_t last_cr; /* reference to detect unexpected stream
299 int i_delta_cr_residue;
302 void input_ClockInit( input_thread_t *, input_clock_t *, vlc_bool_t b_master, int i_cr_average );
303 void input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
304 void input_ClockResetPCR( input_thread_t *, input_clock_t * );
305 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
306 void input_ClockSetRate( input_thread_t *, input_clock_t *cl );
309 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
310 int subtitles_Filter( const char *);
312 void MRLSplit( vlc_object_t *, char *, const char **, const char **, char ** );
314 static inline void input_ChangeState( input_thread_t *p_input, int state )
316 var_SetInteger( p_input, "state", p_input->i_state = state );
321 #define access2_New( a, b, c, d, e ) __access2_New(VLC_OBJECT(a), b, c, d, e )
322 access_t * __access2_New( vlc_object_t *p_obj, const char *psz_access,
323 const char *psz_demux, const char *psz_path,
324 vlc_bool_t b_quick );
325 access_t * access2_FilterNew( access_t *p_source,
326 const char *psz_access_filter );
327 void access2_Delete( access_t * );
330 #include <vlc_demux.h>
332 /* stream_t *s could be null and then it mean a access+demux in one */
333 #define demux2_New( a, b, c, d, e, f,g ) __demux2_New(VLC_OBJECT(a),b,c,d,e,f,g)
334 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 );
336 void demux2_Delete(demux_t *);
338 static inline int demux2_Demux( demux_t *p_demux )
340 return p_demux->pf_demux( p_demux );
342 static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
344 return p_demux->pf_control( p_demux, i_query, args );
346 static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
351 va_start( args, i_query );
352 i_result = demux2_vaControl( p_demux, i_query, args );
357 #if defined(__PLUGIN__) || defined(__BUILTIN__)
358 # warning This is an internal header, something is wrong if you see this message.
362 * stream_t definition
368 /*block_t *(*pf_block) ( stream_t *, int i_size );*/
369 int (*pf_read) ( stream_t *, void *p_read, int i_read );
370 int (*pf_peek) ( stream_t *, const uint8_t **pp_peek, int i_peek );
371 int (*pf_control)( stream_t *, int i_query, va_list );
372 void (*pf_destroy)( stream_t *);
376 /* UTF-16 and UTF-32 file reading */
379 vlc_bool_t b_little_endian;
384 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
386 return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
387 VLC_OBJECT_STREAM, "stream" );