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;
66 bool b_can_stream_record;
69 bool b_eof; /* eof of demuxer */
72 /* Clock average variation */
77 /** Private input fields */
78 struct input_thread_private_t
80 /* Object's event manager */
81 vlc_event_manager_t event_manager;
83 /* Global properties */
85 bool b_can_rate_control;
90 int64_t i_start; /* :start-time,0 by default */
91 int64_t i_stop; /* :stop-time, 0 if none */
92 int64_t i_run; /* :run-time, 0 if none */
94 /* Title infos FIXME multi-input (not easy) ? */
96 input_title_t **title;
99 int i_seekpoint_offset;
101 /* User bookmarks FIXME won't be easy with multiples input */
103 seekpoint_t **bookmark;
105 /* Input attachment */
107 input_attachment_t **attachment;
111 sout_instance_t *p_sout; /* XXX Move it to es_out ? */
112 bool b_out_pace_control; /* idem ? */
114 /* Main input properties */
115 input_source_t input;
116 /* Slave demuxers (subs, and others) */
118 input_source_t **slave;
120 /* pts delay fixup */
130 counter_t *p_read_packets;
131 counter_t *p_read_bytes;
132 counter_t *p_input_bitrate;
133 counter_t *p_demux_read;
134 counter_t *p_demux_bitrate;
135 counter_t *p_decoded_audio;
136 counter_t *p_decoded_video;
137 counter_t *p_decoded_sub;
138 counter_t *p_sout_sent_packets;
139 counter_t *p_sout_sent_bytes;
140 counter_t *p_sout_send_bitrate;
141 counter_t *p_played_abuffers;
142 counter_t *p_lost_abuffers;
143 counter_t *p_displayed_pictures;
144 counter_t *p_lost_pictures;
145 vlc_mutex_t counters_lock;
148 /* Buffer of pending actions */
149 vlc_mutex_t lock_control;
150 vlc_cond_t wait_control;
154 /* XXX for string value you have to allocate it before calling
155 * input_ControlPush */
158 } control[INPUT_CONTROL_FIFO_SIZE];
161 /***************************************************************************
162 * Internal control helpers
163 ***************************************************************************/
166 INPUT_CONTROL_SET_DIE,
168 INPUT_CONTROL_SET_STATE,
170 INPUT_CONTROL_SET_RATE,
171 INPUT_CONTROL_SET_RATE_SLOWER,
172 INPUT_CONTROL_SET_RATE_FASTER,
174 INPUT_CONTROL_SET_POSITION,
175 INPUT_CONTROL_SET_POSITION_OFFSET,
177 INPUT_CONTROL_SET_TIME,
178 INPUT_CONTROL_SET_TIME_OFFSET,
180 INPUT_CONTROL_SET_PROGRAM,
182 INPUT_CONTROL_SET_TITLE,
183 INPUT_CONTROL_SET_TITLE_NEXT,
184 INPUT_CONTROL_SET_TITLE_PREV,
186 INPUT_CONTROL_SET_SEEKPOINT,
187 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
188 INPUT_CONTROL_SET_SEEKPOINT_PREV,
190 INPUT_CONTROL_SET_BOOKMARK,
192 INPUT_CONTROL_SET_ES,
193 INPUT_CONTROL_RESTART_ES,
195 INPUT_CONTROL_SET_AUDIO_DELAY,
196 INPUT_CONTROL_SET_SPU_DELAY,
198 INPUT_CONTROL_ADD_SLAVE,
200 INPUT_CONTROL_ADD_SUBTITLE,
202 INPUT_CONTROL_SET_RECORD_STATE,
205 /* Internal helpers */
206 static inline void input_ControlPush( input_thread_t *p_input,
207 int i_type, vlc_value_t *p_val )
209 vlc_mutex_lock( &p_input->p->lock_control );
210 if( i_type == INPUT_CONTROL_SET_DIE )
212 /* Special case, empty the control */
213 p_input->p->i_control = 1;
214 p_input->p->control[0].i_type = i_type;
215 memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
217 else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
219 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
224 p_input->p->control[p_input->p->i_control].i_type = i_type;
226 p_input->p->control[p_input->p->i_control].val = *p_val;
228 memset( &p_input->p->control[p_input->p->i_control].val, 0,
229 sizeof( vlc_value_t ) );
231 p_input->p->i_control++;
233 vlc_cond_signal( &p_input->p->wait_control );
234 vlc_mutex_unlock( &p_input->p->lock_control );
237 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
240 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
242 bool send_event = false;
245 p_i->p_meta = vlc_meta_New();
247 vlc_mutex_lock( &p_i->lock );
250 new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
252 new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
253 if( p_i->p_meta->i_status != new_status )
255 p_i->p_meta->i_status = new_status;
259 vlc_mutex_unlock( &p_i->lock );
264 event.type = vlc_InputItemPreparsedChanged;
265 event.u.input_item_preparsed_changed.new_status = new_status;
266 vlc_event_send( &p_i->event_manager, &event );
270 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
273 p_i->p_meta = vlc_meta_New();
276 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
278 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
281 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
284 p_i->p_meta = vlc_meta_New();
287 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
289 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
292 void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
294 /**********************************************************************
296 **********************************************************************/
297 typedef struct playlist_album_t
305 int input_ArtFind ( playlist_t *, input_item_t * );
306 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
308 /* Becarefull; p_item lock HAS to be taken */
309 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
311 /***************************************************************************
312 * Internal prototypes
313 ***************************************************************************/
316 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
319 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
320 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
322 sout_instance_t * input_DetachSout( input_thread_t *p_input );
325 void input_ControlVarInit ( input_thread_t * );
326 void input_ControlVarStop( input_thread_t * );
327 void input_ControlVarNavigation( input_thread_t * );
328 void input_ControlVarTitle( input_thread_t *, int i_title );
330 void input_ConfigVarInit ( input_thread_t * );
333 stream_t *stream_AccessNew( access_t *p_access, bool );
334 void stream_AccessDelete( stream_t *s );
335 void stream_AccessReset( stream_t *s );
336 void stream_AccessUpdate( stream_t *s );
339 #define BLOCK_FLAG_CORE_FLUSH (1 <<BLOCK_FLAG_CORE_PRIVATE_SHIFT)
340 void input_DecoderDiscontinuity( decoder_t * p_dec, bool b_flush );
341 bool input_DecoderEmpty( decoder_t * p_dec );
342 int input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
343 int input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
344 void input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
347 es_out_t *input_EsOutNew( input_thread_t *, int i_rate );
348 void input_EsOutDelete( es_out_t * );
349 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
350 mtime_t input_EsOutGetWakeup( es_out_t * );
351 void input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
352 int input_EsOutSetRecord( es_out_t *, bool b_record );
353 void input_EsOutChangeRate( es_out_t *, int );
354 void input_EsOutChangeState( es_out_t * );
355 void input_EsOutChangePosition( es_out_t * );
356 bool input_EsOutDecodersEmpty( es_out_t * );
359 typedef struct input_clock_t input_clock_t;
361 input_clock_t *input_clock_New( bool b_master, int i_cr_average, int i_rate );
362 void input_clock_Delete( input_clock_t * );
364 void input_clock_SetPCR( input_clock_t *, input_thread_t *, mtime_t i_clock, mtime_t i_system );
365 void input_clock_ResetPCR( input_clock_t * );
366 mtime_t input_clock_GetTS( input_clock_t *, mtime_t i_pts_delay, mtime_t );
367 void input_clock_SetRate( input_clock_t *cl, int i_rate );
368 void input_clock_SetMaster( input_clock_t *cl, bool b_master );
369 mtime_t input_clock_GetWakeup( input_clock_t *cl, input_thread_t * );
372 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
373 int subtitles_Filter( const char *);
375 static inline void input_ChangeStateWithVarCallback( input_thread_t *p_input, int i_state, bool callback )
377 const bool changed = p_input->i_state != i_state;
379 p_input->i_state = i_state;
380 if( i_state == ERROR_S )
381 p_input->b_error = true;
382 else if( i_state == END_S )
383 p_input->b_eof = true;
385 input_item_SetHasErrorWhenReading( p_input->p->input.p_item, (i_state == ERROR_S) );
389 var_SetInteger( p_input, "state", i_state );
395 var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
400 event.type = vlc_InputStateChanged;
401 event.u.input_state_changed.new_state = i_state;
402 vlc_event_send( &p_input->p->event_manager, &event );
406 static inline void input_ChangeState( input_thread_t *p_input, int state )
408 input_ChangeStateWithVarCallback( p_input, state, true );
411 /* Helpers FIXME to export without input_ prefix */
412 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
414 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
418 #define access_New( a, b, c, d ) __access_New(VLC_OBJECT(a), b, c, d )
419 access_t * __access_New( vlc_object_t *p_obj, const char *psz_access,
420 const char *psz_demux, const char *psz_path );
421 access_t * access_FilterNew( access_t *p_source,
422 const char *psz_access_filter );
423 void access_Delete( access_t * );
426 #include <vlc_demux.h>
428 /* stream_t *s could be null and then it mean a access+demux in one */
429 #define demux_New( a, b, c, d, e, f,g ) __demux_New(VLC_OBJECT(a),b,c,d,e,f,g)
430 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 );
432 void demux_Delete(demux_t *);
434 static inline int demux_Demux( demux_t *p_demux )
436 return p_demux->pf_demux( p_demux );
438 static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
440 return p_demux->pf_control( p_demux, i_query, args );
442 static inline int demux_Control( demux_t *p_demux, int i_query, ... )
447 va_start( args, i_query );
448 i_result = demux_vaControl( p_demux, i_query, args );
455 * stream_t definition
461 /*block_t *(*pf_block) ( stream_t *, int i_size );*/
462 int (*pf_read) ( stream_t *, void *p_read, unsigned int i_read );
463 int (*pf_peek) ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
464 int (*pf_control)( stream_t *, int i_query, va_list );
465 void (*pf_destroy)( stream_t *);
469 /* UTF-16 and UTF-32 file reading */
472 bool b_little_endian;
477 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
479 return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
480 VLC_OBJECT_GENERIC, "stream" );