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 vlc_bool_t b_title_demux; /* Titles/Seekpoints provided by demux */
52 input_title_t **title;
55 int i_seekpoint_offset;
59 int i_seekpoint_start;
63 vlc_bool_t b_can_pace_control;
64 vlc_bool_t b_can_pause;
65 vlc_bool_t b_eof; /* eof of demuxer */
68 /* Clock average variation */
73 /** Private input fields */
74 struct input_thread_private_t
76 /* Global properties */
77 vlc_bool_t b_can_pause;
81 int64_t i_start; /* :start-time,0 by default */
82 int64_t i_stop; /* :stop-time, 0 if none */
83 int64_t i_run; /* :run-time, 0 if none */
85 /* Title infos FIXME multi-input (not easy) ? */
87 input_title_t **title;
90 int i_seekpoint_offset;
92 /* User bookmarks FIXME won't be easy with multiples input */
94 seekpoint_t **bookmark;
96 /* Input attachment */
98 input_attachment_t **attachment;
102 sout_instance_t *p_sout; /* XXX Move it to es_out ? */
103 vlc_bool_t b_sout_keep;
104 vlc_bool_t b_out_pace_control; /* idem ? */
106 /* Main input properties */
107 input_source_t input;
108 /* Slave demuxers (subs, and others) */
110 input_source_t **slave;
114 counter_t *p_read_packets;
115 counter_t *p_read_bytes;
116 counter_t *p_input_bitrate;
117 counter_t *p_demux_read;
118 counter_t *p_demux_bitrate;
119 counter_t *p_decoded_audio;
120 counter_t *p_decoded_video;
121 counter_t *p_decoded_sub;
122 counter_t *p_sout_sent_packets;
123 counter_t *p_sout_sent_bytes;
124 counter_t *p_sout_send_bitrate;
125 counter_t *p_played_abuffers;
126 counter_t *p_lost_abuffers;
127 counter_t *p_displayed_pictures;
128 counter_t *p_lost_pictures;
129 vlc_mutex_t counters_lock;
132 /* Buffer of pending actions */
133 vlc_mutex_t lock_control;
137 /* XXX for string value you have to allocate it before calling
138 * input_ControlPush */
141 } control[INPUT_CONTROL_FIFO_SIZE];
144 /***************************************************************************
145 * Internal control helpers
146 ***************************************************************************/
149 INPUT_CONTROL_SET_DIE,
151 INPUT_CONTROL_SET_STATE,
153 INPUT_CONTROL_SET_RATE,
154 INPUT_CONTROL_SET_RATE_SLOWER,
155 INPUT_CONTROL_SET_RATE_FASTER,
157 INPUT_CONTROL_SET_POSITION,
158 INPUT_CONTROL_SET_POSITION_OFFSET,
160 INPUT_CONTROL_SET_TIME,
161 INPUT_CONTROL_SET_TIME_OFFSET,
163 INPUT_CONTROL_SET_PROGRAM,
165 INPUT_CONTROL_SET_TITLE,
166 INPUT_CONTROL_SET_TITLE_NEXT,
167 INPUT_CONTROL_SET_TITLE_PREV,
169 INPUT_CONTROL_SET_SEEKPOINT,
170 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
171 INPUT_CONTROL_SET_SEEKPOINT_PREV,
173 INPUT_CONTROL_SET_BOOKMARK,
175 INPUT_CONTROL_SET_ES,
177 INPUT_CONTROL_SET_AUDIO_DELAY,
178 INPUT_CONTROL_SET_SPU_DELAY,
180 INPUT_CONTROL_ADD_SLAVE,
183 /* Internal helpers */
184 static inline void input_ControlPush( input_thread_t *p_input,
185 int i_type, vlc_value_t *p_val )
187 vlc_mutex_lock( &p_input->p->lock_control );
188 if( i_type == INPUT_CONTROL_SET_DIE )
190 /* Special case, empty the control */
191 p_input->p->i_control = 1;
192 p_input->p->control[0].i_type = i_type;
193 memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
197 if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
199 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
201 vlc_mutex_unlock( &p_input->p->lock_control );
204 p_input->p->control[p_input->p->i_control].i_type = i_type;
206 p_input->p->control[p_input->p->i_control].val = *p_val;
208 memset( &p_input->p->control[p_input->p->i_control].val, 0,
209 sizeof( vlc_value_t ) );
211 p_input->p->i_control++;
213 vlc_mutex_unlock( &p_input->p->lock_control );
216 /**********************************************************************
218 **********************************************************************/
219 typedef struct playlist_album_t
227 int input_MetaFetch ( playlist_t *, input_item_t * );
228 int input_ArtFind ( playlist_t *, input_item_t * );
229 vlc_bool_t input_MetaSatisfied ( playlist_t*, input_item_t*,
230 uint32_t*, uint32_t* );
231 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
233 /* Becarefull; p_item lock HAS to be taken */
234 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
236 /***************************************************************************
237 * Internal prototypes
238 ***************************************************************************/
241 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
244 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
245 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
247 void input_DestroyThreadExtended( input_thread_t *p_input, sout_instance_t ** );
250 void input_ControlVarInit ( input_thread_t * );
251 void input_ControlVarClean( input_thread_t * );
252 void input_ControlVarNavigation( input_thread_t * );
253 void input_ControlVarTitle( input_thread_t *, int i_title );
255 void input_ConfigVarInit ( input_thread_t * );
258 stream_t *stream_AccessNew( access_t *p_access, vlc_bool_t );
259 void stream_AccessDelete( stream_t *s );
260 void stream_AccessReset( stream_t *s );
261 void stream_AccessUpdate( stream_t *s );
264 void input_DecoderDiscontinuity( decoder_t * p_dec, vlc_bool_t b_flush );
265 vlc_bool_t input_DecoderEmpty( decoder_t * p_dec );
266 int input_DecoderSetCcState( decoder_t *, vlc_bool_t b_decode, int i_channel );
267 int input_DecoderGetCcState( decoder_t *, vlc_bool_t *pb_decode, int i_channel );
268 void input_DecoderIsCcPresent( decoder_t *, vlc_bool_t pb_present[4] );
271 es_out_t *input_EsOutNew( input_thread_t * );
272 void input_EsOutDelete( es_out_t * );
273 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
274 void input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
275 void input_EsOutChangeRate( es_out_t * );
276 void input_EsOutChangeState( es_out_t * );
277 void input_EsOutChangePosition( es_out_t * );
278 vlc_bool_t input_EsOutDecodersEmpty( es_out_t * );
281 enum /* Synchro states */
290 /* Synchronization information */
292 mtime_t cr_ref, sysdate_ref;
293 mtime_t last_sysdate;
294 mtime_t last_cr; /* reference to detect unexpected stream
306 int i_delta_cr_residue;
309 void input_ClockInit( input_thread_t *, input_clock_t *, vlc_bool_t b_master, int i_cr_average );
310 void input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
311 void input_ClockResetPCR( input_thread_t *, input_clock_t * );
312 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
313 void input_ClockSetRate( input_thread_t *, input_clock_t *cl );
316 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
317 int subtitles_Filter( const char *);
319 void MRLSplit( vlc_object_t *, char *, const char **, const char **, char ** );
321 static inline void input_ChangeState( input_thread_t *p_input, int state )
323 var_SetInteger( p_input, "state", p_input->i_state = state );
328 #define access2_New( a, b, c, d, e ) __access2_New(VLC_OBJECT(a), b, c, d, e )
329 access_t * __access2_New( vlc_object_t *p_obj, const char *psz_access,
330 const char *psz_demux, const char *psz_path,
331 vlc_bool_t b_quick );
332 access_t * access2_FilterNew( access_t *p_source,
333 const char *psz_access_filter );
334 void access2_Delete( access_t * );
337 #include <vlc_demux.h>
339 /* stream_t *s could be null and then it mean a access+demux in one */
340 #define demux2_New( a, b, c, d, e, f,g ) __demux2_New(VLC_OBJECT(a),b,c,d,e,f,g)
341 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 );
343 void demux2_Delete(demux_t *);
345 static inline int demux2_Demux( demux_t *p_demux )
347 return p_demux->pf_demux( p_demux );
349 static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
351 return p_demux->pf_control( p_demux, i_query, args );
353 static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
358 va_start( args, i_query );
359 i_result = demux2_vaControl( p_demux, i_query, args );
366 * stream_t definition
372 /*block_t *(*pf_block) ( stream_t *, int i_size );*/
373 int (*pf_read) ( stream_t *, void *p_read, int i_read );
374 int (*pf_peek) ( stream_t *, const uint8_t **pp_peek, int i_peek );
375 int (*pf_control)( stream_t *, int i_query, va_list );
376 void (*pf_destroy)( stream_t *);
380 /* UTF-16 and UTF-32 file reading */
383 vlc_bool_t b_little_endian;
388 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
390 return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
391 VLC_OBJECT_STREAM, "stream" );