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 */
63 /* Clock average variation */
68 /** Private input fields */
69 struct input_thread_private_t
71 /* Global properties */
72 vlc_bool_t b_can_pause;
76 int64_t i_start; /* :start-time,0 by default */
77 int64_t i_stop; /* :stop-time, 0 if none */
78 int64_t i_run; /* :run-time, 0 if none */
80 /* Title infos FIXME multi-input (not easy) ? */
82 input_title_t **title;
85 int i_seekpoint_offset;
87 /* User bookmarks FIXME won't be easy with multiples input */
89 seekpoint_t **bookmark;
91 /* Input attachment */
93 input_attachment_t **attachment;
97 sout_instance_t *p_sout; /* XXX Move it to es_out ? */
98 vlc_bool_t b_sout_keep;
99 vlc_bool_t b_out_pace_control; /* idem ? */
101 /* Main input properties */
102 input_source_t input;
103 /* Slave demuxers (subs, and others) */
105 input_source_t **slave;
109 counter_t *p_read_packets;
110 counter_t *p_read_bytes;
111 counter_t *p_input_bitrate;
112 counter_t *p_demux_read;
113 counter_t *p_demux_bitrate;
114 counter_t *p_decoded_audio;
115 counter_t *p_decoded_video;
116 counter_t *p_decoded_sub;
117 counter_t *p_sout_sent_packets;
118 counter_t *p_sout_sent_bytes;
119 counter_t *p_sout_send_bitrate;
120 counter_t *p_played_abuffers;
121 counter_t *p_lost_abuffers;
122 counter_t *p_displayed_pictures;
123 counter_t *p_lost_pictures;
124 vlc_mutex_t counters_lock;
127 /* Buffer of pending actions */
128 vlc_mutex_t lock_control;
132 /* XXX for string value you have to allocate it before calling
133 * input_ControlPush */
136 } control[INPUT_CONTROL_FIFO_SIZE];
139 /***************************************************************************
140 * Internal control helpers
141 ***************************************************************************/
144 INPUT_CONTROL_SET_DIE,
146 INPUT_CONTROL_SET_STATE,
148 INPUT_CONTROL_SET_RATE,
149 INPUT_CONTROL_SET_RATE_SLOWER,
150 INPUT_CONTROL_SET_RATE_FASTER,
152 INPUT_CONTROL_SET_POSITION,
153 INPUT_CONTROL_SET_POSITION_OFFSET,
155 INPUT_CONTROL_SET_TIME,
156 INPUT_CONTROL_SET_TIME_OFFSET,
158 INPUT_CONTROL_SET_PROGRAM,
160 INPUT_CONTROL_SET_TITLE,
161 INPUT_CONTROL_SET_TITLE_NEXT,
162 INPUT_CONTROL_SET_TITLE_PREV,
164 INPUT_CONTROL_SET_SEEKPOINT,
165 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
166 INPUT_CONTROL_SET_SEEKPOINT_PREV,
168 INPUT_CONTROL_SET_BOOKMARK,
170 INPUT_CONTROL_SET_ES,
172 INPUT_CONTROL_SET_AUDIO_DELAY,
173 INPUT_CONTROL_SET_SPU_DELAY,
175 INPUT_CONTROL_ADD_SLAVE,
178 /* Internal helpers */
179 static inline void input_ControlPush( input_thread_t *p_input,
180 int i_type, vlc_value_t *p_val )
182 vlc_mutex_lock( &p_input->p->lock_control );
183 if( i_type == INPUT_CONTROL_SET_DIE )
185 /* Special case, empty the control */
186 p_input->p->i_control = 1;
187 p_input->p->control[0].i_type = i_type;
188 memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
192 if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
194 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
196 vlc_mutex_unlock( &p_input->p->lock_control );
199 p_input->p->control[p_input->p->i_control].i_type = i_type;
201 p_input->p->control[p_input->p->i_control].val = *p_val;
203 memset( &p_input->p->control[p_input->p->i_control].val, 0,
204 sizeof( vlc_value_t ) );
206 p_input->p->i_control++;
208 vlc_mutex_unlock( &p_input->p->lock_control );
211 /**********************************************************************
213 **********************************************************************/
214 typedef struct playlist_album_t
221 int input_MetaFetch ( playlist_t *, input_item_t * );
222 int input_ArtFind ( playlist_t *, input_item_t * );
223 vlc_bool_t input_MetaSatisfied ( playlist_t*, input_item_t*,
224 uint32_t*, uint32_t* );
225 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
227 /* Becarefull; p_item lock HAS to be taken */
228 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
230 /***************************************************************************
231 * Internal prototypes
232 ***************************************************************************/
235 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
238 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
239 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
241 void input_DestroyThreadExtended( input_thread_t *p_input, sout_instance_t ** );
244 void input_ControlVarInit ( input_thread_t * );
245 void input_ControlVarClean( input_thread_t * );
246 void input_ControlVarNavigation( input_thread_t * );
247 void input_ControlVarTitle( input_thread_t *, int i_title );
249 void input_ConfigVarInit ( input_thread_t * );
252 stream_t *stream_AccessNew( access_t *p_access, vlc_bool_t );
253 void stream_AccessDelete( stream_t *s );
254 void stream_AccessReset( stream_t *s );
255 void stream_AccessUpdate( stream_t *s );
258 void input_DecoderDiscontinuity( decoder_t * p_dec, vlc_bool_t b_flush );
259 vlc_bool_t input_DecoderEmpty( decoder_t * p_dec );
262 es_out_t *input_EsOutNew( input_thread_t * );
263 void input_EsOutDelete( es_out_t * );
264 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
265 void input_EsOutDiscontinuity( es_out_t *, vlc_bool_t b_flush, vlc_bool_t b_audio );
266 void input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
267 void input_EsOutSetRate( es_out_t * );
268 vlc_bool_t input_EsOutDecodersEmpty( es_out_t * );
271 enum /* Synchro states */
280 /* Synchronization information */
282 mtime_t cr_ref, sysdate_ref;
283 mtime_t last_sysdate;
284 mtime_t last_cr; /* reference to detect unexpected stream
296 int i_delta_cr_residue;
299 void input_ClockInit( input_thread_t *, input_clock_t *, vlc_bool_t b_master, int i_cr_average );
300 void input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
301 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
302 void input_ClockSetRate( input_thread_t *, input_clock_t *cl );
305 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
306 int subtitles_Filter( const char *);
308 void MRLSplit( vlc_object_t *, char *, const char **, const char **, char ** );
310 static inline void input_ChangeState( input_thread_t *p_input, int state )
313 val.i_int = p_input->i_state = state;
314 var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
319 #define access2_New( a, b, c, d, e ) __access2_New(VLC_OBJECT(a), b, c, d, e )
320 access_t * __access2_New( vlc_object_t *p_obj, const char *psz_access,
321 const char *psz_demux, const char *psz_path,
322 vlc_bool_t b_quick );
323 access_t * access2_FilterNew( access_t *p_source,
324 const char *psz_access_filter );
325 void access2_Delete( access_t * );
328 #include <vlc_demux.h>
330 /* stream_t *s could be null and then it mean a access+demux in one */
331 #define demux2_New( a, b, c, d, e, f,g ) __demux2_New(VLC_OBJECT(a),b,c,d,e,f,g)
332 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 );
334 void demux2_Delete(demux_t *);
336 static inline int demux2_Demux( demux_t *p_demux )
338 return p_demux->pf_demux( p_demux );
340 static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
342 return p_demux->pf_control( p_demux, i_query, args );
344 static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
349 va_start( args, i_query );
350 i_result = demux2_vaControl( p_demux, i_query, args );
355 #if defined(__PLUGIN__) || defined(__BUILTIN__)
356 # warning This is an internal header. Please don't relay on it unless you really know what you are doing.
360 * stream_t definition
366 block_t *(*pf_block) ( stream_t *, int i_size );
367 int (*pf_read) ( stream_t *, void *p_read, int i_read );
368 int (*pf_peek) ( stream_t *, uint8_t **pp_peek, int i_peek );
369 int (*pf_control)( stream_t *, int i_query, va_list );
370 void (*pf_destroy)( stream_t *);
374 /* UTF-16 and UTF-32 file reading */
377 vlc_bool_t b_little_endian;
382 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
384 return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
385 VLC_OBJECT_STREAM, "stream" );