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;
115 /* pts delay fixup */
124 counter_t *p_read_packets;
125 counter_t *p_read_bytes;
126 counter_t *p_input_bitrate;
127 counter_t *p_demux_read;
128 counter_t *p_demux_bitrate;
129 counter_t *p_decoded_audio;
130 counter_t *p_decoded_video;
131 counter_t *p_decoded_sub;
132 counter_t *p_sout_sent_packets;
133 counter_t *p_sout_sent_bytes;
134 counter_t *p_sout_send_bitrate;
135 counter_t *p_played_abuffers;
136 counter_t *p_lost_abuffers;
137 counter_t *p_displayed_pictures;
138 counter_t *p_lost_pictures;
139 vlc_mutex_t counters_lock;
142 /* Buffer of pending actions */
143 vlc_mutex_t lock_control;
147 /* XXX for string value you have to allocate it before calling
148 * input_ControlPush */
151 } control[INPUT_CONTROL_FIFO_SIZE];
154 /***************************************************************************
155 * Internal control helpers
156 ***************************************************************************/
159 INPUT_CONTROL_SET_DIE,
161 INPUT_CONTROL_SET_STATE,
163 INPUT_CONTROL_SET_RATE,
164 INPUT_CONTROL_SET_RATE_SLOWER,
165 INPUT_CONTROL_SET_RATE_FASTER,
167 INPUT_CONTROL_SET_POSITION,
168 INPUT_CONTROL_SET_POSITION_OFFSET,
170 INPUT_CONTROL_SET_TIME,
171 INPUT_CONTROL_SET_TIME_OFFSET,
173 INPUT_CONTROL_SET_PROGRAM,
175 INPUT_CONTROL_SET_TITLE,
176 INPUT_CONTROL_SET_TITLE_NEXT,
177 INPUT_CONTROL_SET_TITLE_PREV,
179 INPUT_CONTROL_SET_SEEKPOINT,
180 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
181 INPUT_CONTROL_SET_SEEKPOINT_PREV,
183 INPUT_CONTROL_SET_BOOKMARK,
185 INPUT_CONTROL_SET_ES,
187 INPUT_CONTROL_SET_AUDIO_DELAY,
188 INPUT_CONTROL_SET_SPU_DELAY,
190 INPUT_CONTROL_ADD_SLAVE,
193 /* Internal helpers */
194 static inline void input_ControlPush( input_thread_t *p_input,
195 int i_type, vlc_value_t *p_val )
197 vlc_mutex_lock( &p_input->p->lock_control );
198 if( i_type == INPUT_CONTROL_SET_DIE )
200 /* Special case, empty the control */
201 p_input->p->i_control = 1;
202 p_input->p->control[0].i_type = i_type;
203 memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
207 if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
209 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
211 vlc_mutex_unlock( &p_input->p->lock_control );
214 p_input->p->control[p_input->p->i_control].i_type = i_type;
216 p_input->p->control[p_input->p->i_control].val = *p_val;
218 memset( &p_input->p->control[p_input->p->i_control].val, 0,
219 sizeof( vlc_value_t ) );
221 p_input->p->i_control++;
223 vlc_mutex_unlock( &p_input->p->lock_control );
226 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
229 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
231 bool send_event = false;
234 p_i->p_meta = vlc_meta_New();
236 vlc_mutex_lock( &p_i->lock );
239 new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
241 new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
242 if ( p_i->p_meta->i_status != new_status )
244 p_i->p_meta->i_status = new_status;
248 vlc_mutex_unlock( &p_i->lock );
250 if ( send_event == true )
253 event.type = vlc_InputItemPreparsedChanged;
254 event.u.input_item_preparsed_changed.new_status = new_status;
255 vlc_event_send( &p_i->event_manager, &event );
259 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
262 p_i->p_meta = vlc_meta_New();
265 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
267 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
270 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
273 p_i->p_meta = vlc_meta_New();
276 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
278 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
282 /**********************************************************************
284 **********************************************************************/
285 typedef struct playlist_album_t
293 int input_ArtFind ( playlist_t *, input_item_t * );
294 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
296 /* Becarefull; p_item lock HAS to be taken */
297 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
299 /***************************************************************************
300 * Internal prototypes
301 ***************************************************************************/
304 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
307 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
308 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
310 sout_instance_t * input_DetachSout( input_thread_t *p_input );
313 void input_ControlVarInit ( input_thread_t * );
314 void input_ControlVarClean( input_thread_t * );
315 void input_ControlVarNavigation( input_thread_t * );
316 void input_ControlVarTitle( input_thread_t *, int i_title );
318 void input_ConfigVarInit ( input_thread_t * );
321 stream_t *stream_AccessNew( access_t *p_access, bool );
322 void stream_AccessDelete( stream_t *s );
323 void stream_AccessReset( stream_t *s );
324 void stream_AccessUpdate( stream_t *s );
327 void input_DecoderDiscontinuity( decoder_t * p_dec, bool b_flush );
328 bool input_DecoderEmpty( decoder_t * p_dec );
329 int input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
330 int input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
331 void input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
334 es_out_t *input_EsOutNew( input_thread_t *, int i_rate );
335 void input_EsOutDelete( es_out_t * );
336 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
337 void input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
338 void input_EsOutChangeRate( es_out_t *, int );
339 void input_EsOutChangeState( es_out_t * );
340 void input_EsOutChangePosition( es_out_t * );
341 bool input_EsOutDecodersEmpty( es_out_t * );
344 enum /* Synchro states */
353 /* Synchronization information */
355 mtime_t cr_ref, sysdate_ref;
356 mtime_t last_sysdate;
357 mtime_t last_cr; /* reference to detect unexpected stream
369 int i_delta_cr_residue;
372 void input_ClockInit( input_clock_t *, bool b_master, int i_cr_average, int i_rate );
373 void input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
374 void input_ClockResetPCR( input_clock_t * );
375 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
376 void input_ClockSetRate( input_clock_t *cl, int i_rate );
379 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
380 int subtitles_Filter( const char *);
382 void MRLSplit( char *, const char **, const char **, char ** );
384 static inline void input_ChangeState( input_thread_t *p_input, int state )
386 var_SetInteger( p_input, "state", p_input->i_state = state );
391 #define access_New( a, b, c, d ) __access_New(VLC_OBJECT(a), b, c, d )
392 access_t * __access_New( vlc_object_t *p_obj, const char *psz_access,
393 const char *psz_demux, const char *psz_path );
394 access_t * access_FilterNew( access_t *p_source,
395 const char *psz_access_filter );
396 void access_Delete( access_t * );
399 #include <vlc_demux.h>
401 /* stream_t *s could be null and then it mean a access+demux in one */
402 #define demux_New( a, b, c, d, e, f,g ) __demux_New(VLC_OBJECT(a),b,c,d,e,f,g)
403 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 );
405 void demux_Delete(demux_t *);
407 static inline int demux_Demux( demux_t *p_demux )
409 return p_demux->pf_demux( p_demux );
411 static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
413 return p_demux->pf_control( p_demux, i_query, args );
415 static inline int demux_Control( demux_t *p_demux, int i_query, ... )
420 va_start( args, i_query );
421 i_result = demux_vaControl( p_demux, i_query, args );
428 * stream_t definition
434 /*block_t *(*pf_block) ( stream_t *, int i_size );*/
435 int (*pf_read) ( stream_t *, void *p_read, int i_read );
436 int (*pf_peek) ( stream_t *, const uint8_t **pp_peek, int i_peek );
437 int (*pf_control)( stream_t *, int i_query, va_list );
438 void (*pf_destroy)( stream_t *);
442 /* UTF-16 and UTF-32 file reading */
445 bool b_little_endian;
450 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
452 return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
453 VLC_OBJECT_STREAM, "stream" );