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>
36 /*****************************************************************************
37 * Private input fields
38 *****************************************************************************/
39 /* input_source_t: gathers all information per input source */
42 /* Input item description */
45 /* Access/Stream/Demux plugins */
50 /* Title infos for that input */
51 bool b_title_demux; /* Titles/Seekpoints provided by demux */
53 input_title_t **title;
56 int i_seekpoint_offset;
60 int i_seekpoint_start;
65 bool b_can_pace_control;
66 bool b_can_rate_control;
67 bool b_can_stream_record;
70 bool b_eof; /* eof of demuxer */
73 /* Clock average variation */
78 /** Private input fields */
79 struct input_thread_private_t
81 /* Object's event manager */
82 vlc_event_manager_t event_manager;
84 /* Global properties */
86 bool b_can_rate_control;
91 int64_t i_start; /* :start-time,0 by default */
92 int64_t i_stop; /* :stop-time, 0 if none */
93 int64_t i_run; /* :run-time, 0 if none */
95 /* Title infos FIXME multi-input (not easy) ? */
97 input_title_t **title;
100 int i_seekpoint_offset;
102 /* User bookmarks FIXME won't be easy with multiples input */
104 seekpoint_t **bookmark;
106 /* Input attachment */
108 input_attachment_t **attachment;
112 es_out_t *p_es_out_display;
113 sout_instance_t *p_sout; /* XXX Move it to es_out ? */
114 bool b_out_pace_control; /* idem ? */
116 /* Main input properties */
117 input_source_t input;
118 /* Slave demuxers (subs, and others) */
120 input_source_t **slave;
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;
144 vlc_cond_t wait_control;
148 /* XXX for string value you have to allocate it before calling
149 * input_ControlPush */
152 } control[INPUT_CONTROL_FIFO_SIZE];
155 /***************************************************************************
156 * Internal control helpers
157 ***************************************************************************/
160 INPUT_CONTROL_SET_DIE,
162 INPUT_CONTROL_SET_STATE,
164 INPUT_CONTROL_SET_RATE,
165 INPUT_CONTROL_SET_RATE_SLOWER,
166 INPUT_CONTROL_SET_RATE_FASTER,
168 INPUT_CONTROL_SET_POSITION,
169 INPUT_CONTROL_SET_POSITION_OFFSET,
171 INPUT_CONTROL_SET_TIME,
172 INPUT_CONTROL_SET_TIME_OFFSET,
174 INPUT_CONTROL_SET_PROGRAM,
176 INPUT_CONTROL_SET_TITLE,
177 INPUT_CONTROL_SET_TITLE_NEXT,
178 INPUT_CONTROL_SET_TITLE_PREV,
180 INPUT_CONTROL_SET_SEEKPOINT,
181 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
182 INPUT_CONTROL_SET_SEEKPOINT_PREV,
184 INPUT_CONTROL_SET_BOOKMARK,
186 INPUT_CONTROL_SET_ES,
187 INPUT_CONTROL_RESTART_ES,
189 INPUT_CONTROL_SET_AUDIO_DELAY,
190 INPUT_CONTROL_SET_SPU_DELAY,
192 INPUT_CONTROL_ADD_SLAVE,
194 INPUT_CONTROL_ADD_SUBTITLE,
196 INPUT_CONTROL_SET_RECORD_STATE,
198 INPUT_CONTROL_SET_FRAME_NEXT,
201 /* Internal helpers */
202 static inline void input_ControlPush( input_thread_t *p_input,
203 int i_type, vlc_value_t *p_val )
205 vlc_mutex_lock( &p_input->p->lock_control );
206 if( i_type == INPUT_CONTROL_SET_DIE )
208 /* Special case, empty the control */
209 p_input->p->i_control = 1;
210 p_input->p->control[0].i_type = i_type;
211 memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
213 else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
215 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
220 p_input->p->control[p_input->p->i_control].i_type = i_type;
222 p_input->p->control[p_input->p->i_control].val = *p_val;
224 memset( &p_input->p->control[p_input->p->i_control].val, 0,
225 sizeof( vlc_value_t ) );
227 p_input->p->i_control++;
229 vlc_cond_signal( &p_input->p->wait_control );
230 vlc_mutex_unlock( &p_input->p->lock_control );
233 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
236 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
238 bool send_event = false;
241 p_i->p_meta = vlc_meta_New();
243 vlc_mutex_lock( &p_i->lock );
246 new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
248 new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
249 if( p_i->p_meta->i_status != new_status )
251 p_i->p_meta->i_status = new_status;
255 vlc_mutex_unlock( &p_i->lock );
260 event.type = vlc_InputItemPreparsedChanged;
261 event.u.input_item_preparsed_changed.new_status = new_status;
262 vlc_event_send( &p_i->event_manager, &event );
266 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
269 p_i->p_meta = vlc_meta_New();
272 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
274 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
277 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
280 p_i->p_meta = vlc_meta_New();
283 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
285 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
288 void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
290 /**********************************************************************
292 **********************************************************************/
293 typedef struct playlist_album_t
301 int input_ArtFind ( playlist_t *, input_item_t * );
302 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
304 /* Becarefull; p_item lock HAS to be taken */
305 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
307 /***************************************************************************
308 * Internal prototypes
309 ***************************************************************************/
312 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
315 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
316 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
318 sout_instance_t * input_DetachSout( input_thread_t *p_input );
321 void input_ControlVarInit ( input_thread_t * );
322 void input_ControlVarStop( input_thread_t * );
323 void input_ControlVarNavigation( input_thread_t * );
324 void input_ControlVarTitle( input_thread_t *, int i_title );
326 void input_ConfigVarInit ( input_thread_t * );
329 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
330 int subtitles_Filter( const char *);
332 static inline void input_ChangeStateWithVarCallback( input_thread_t *p_input, int i_state, bool callback )
334 const bool changed = p_input->i_state != i_state;
336 p_input->i_state = i_state;
337 if( i_state == ERROR_S )
338 p_input->b_error = true;
339 else if( i_state == END_S )
340 p_input->b_eof = true;
342 input_item_SetHasErrorWhenReading( p_input->p->input.p_item, (i_state == ERROR_S) );
346 var_SetInteger( p_input, "state", i_state );
352 var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
357 event.type = vlc_InputStateChanged;
358 event.u.input_state_changed.new_state = i_state;
359 vlc_event_send( &p_input->p->event_manager, &event );
363 static inline void input_ChangeState( input_thread_t *p_input, int state )
365 input_ChangeStateWithVarCallback( p_input, state, true );
368 /* Helpers FIXME to export without input_ prefix */
369 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
371 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"