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 *****************************************************************************/
40 #define INPUT_CONTROL_FIFO_SIZE 100
42 /* input_source_t: gathers all information per input source */
45 /* Input item description */
48 /* Access/Stream/Demux plugins */
53 /* Title infos for that input */
54 bool b_title_demux; /* Titles/Seekpoints provided by demux */
56 input_title_t **title;
59 int i_seekpoint_offset;
63 int i_seekpoint_start;
68 bool b_can_pace_control;
69 bool b_can_rate_control;
70 bool b_can_stream_record;
73 bool b_eof; /* eof of demuxer */
76 /* Clock average variation */
81 /** Private input fields */
82 struct input_thread_private_t
84 /* Object's event manager */
85 vlc_event_manager_t event_manager;
87 /* Global properties */
89 bool b_can_rate_control;
94 int64_t i_start; /* :start-time,0 by default */
95 int64_t i_stop; /* :stop-time, 0 if none */
96 int64_t i_run; /* :run-time, 0 if none */
98 /* Title infos FIXME multi-input (not easy) ? */
100 input_title_t **title;
103 int i_seekpoint_offset;
105 /* User bookmarks FIXME won't be easy with multiples input */
107 seekpoint_t **bookmark;
109 /* Input attachment */
111 input_attachment_t **attachment;
115 es_out_t *p_es_out_display;
116 sout_instance_t *p_sout; /* XXX Move it to es_out ? */
117 bool b_out_pace_control; /* idem ? */
119 /* Main input properties */
120 input_source_t input;
121 /* Slave demuxers (subs, and others) */
123 input_source_t **slave;
127 counter_t *p_read_packets;
128 counter_t *p_read_bytes;
129 counter_t *p_input_bitrate;
130 counter_t *p_demux_read;
131 counter_t *p_demux_bitrate;
132 counter_t *p_decoded_audio;
133 counter_t *p_decoded_video;
134 counter_t *p_decoded_sub;
135 counter_t *p_sout_sent_packets;
136 counter_t *p_sout_sent_bytes;
137 counter_t *p_sout_send_bitrate;
138 counter_t *p_played_abuffers;
139 counter_t *p_lost_abuffers;
140 counter_t *p_displayed_pictures;
141 counter_t *p_lost_pictures;
142 vlc_mutex_t counters_lock;
145 /* Buffer of pending actions */
146 vlc_mutex_t lock_control;
147 vlc_cond_t wait_control;
151 /* XXX for string value you have to allocate it before calling
152 * input_ControlPush */
155 } control[INPUT_CONTROL_FIFO_SIZE];
158 /***************************************************************************
159 * Internal control helpers
160 ***************************************************************************/
163 INPUT_CONTROL_SET_DIE,
165 INPUT_CONTROL_SET_STATE,
167 INPUT_CONTROL_SET_RATE,
168 INPUT_CONTROL_SET_RATE_SLOWER,
169 INPUT_CONTROL_SET_RATE_FASTER,
171 INPUT_CONTROL_SET_POSITION,
172 INPUT_CONTROL_SET_POSITION_OFFSET,
174 INPUT_CONTROL_SET_TIME,
175 INPUT_CONTROL_SET_TIME_OFFSET,
177 INPUT_CONTROL_SET_PROGRAM,
179 INPUT_CONTROL_SET_TITLE,
180 INPUT_CONTROL_SET_TITLE_NEXT,
181 INPUT_CONTROL_SET_TITLE_PREV,
183 INPUT_CONTROL_SET_SEEKPOINT,
184 INPUT_CONTROL_SET_SEEKPOINT_NEXT,
185 INPUT_CONTROL_SET_SEEKPOINT_PREV,
187 INPUT_CONTROL_SET_BOOKMARK,
189 INPUT_CONTROL_SET_ES,
190 INPUT_CONTROL_RESTART_ES,
192 INPUT_CONTROL_SET_AUDIO_DELAY,
193 INPUT_CONTROL_SET_SPU_DELAY,
195 INPUT_CONTROL_ADD_SLAVE,
197 INPUT_CONTROL_ADD_SUBTITLE,
199 INPUT_CONTROL_SET_RECORD_STATE,
201 INPUT_CONTROL_SET_FRAME_NEXT,
204 /* Internal helpers */
205 static inline void input_ControlPush( input_thread_t *p_input,
206 int i_type, vlc_value_t *p_val )
208 vlc_mutex_lock( &p_input->p->lock_control );
209 if( i_type == INPUT_CONTROL_SET_DIE )
211 /* Special case, empty the control */
212 p_input->p->i_control = 1;
213 p_input->p->control[0].i_type = i_type;
214 memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
216 else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
218 msg_Err( p_input, "input control fifo overflow, trashing type=%d",
223 p_input->p->control[p_input->p->i_control].i_type = i_type;
225 p_input->p->control[p_input->p->i_control].val = *p_val;
227 memset( &p_input->p->control[p_input->p->i_control].val, 0,
228 sizeof( vlc_value_t ) );
230 p_input->p->i_control++;
232 vlc_cond_signal( &p_input->p->wait_control );
233 vlc_mutex_unlock( &p_input->p->lock_control );
236 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
239 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
241 bool send_event = false;
244 p_i->p_meta = vlc_meta_New();
246 vlc_mutex_lock( &p_i->lock );
249 new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
251 new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
252 if( p_i->p_meta->i_status != new_status )
254 p_i->p_meta->i_status = new_status;
258 vlc_mutex_unlock( &p_i->lock );
263 event.type = vlc_InputItemPreparsedChanged;
264 event.u.input_item_preparsed_changed.new_status = new_status;
265 vlc_event_send( &p_i->event_manager, &event );
269 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
272 p_i->p_meta = vlc_meta_New();
275 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
277 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
280 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
283 p_i->p_meta = vlc_meta_New();
286 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
288 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
291 void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
293 /**********************************************************************
295 **********************************************************************/
296 typedef struct playlist_album_t
304 int input_ArtFind ( playlist_t *, input_item_t * );
305 int input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
307 /* Becarefull; p_item lock HAS to be taken */
308 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
310 /***************************************************************************
311 * Internal prototypes
312 ***************************************************************************/
315 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
318 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
319 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
321 sout_instance_t * input_DetachSout( input_thread_t *p_input );
324 void input_ControlVarInit ( input_thread_t * );
325 void input_ControlVarStop( input_thread_t * );
326 void input_ControlVarNavigation( input_thread_t * );
327 void input_ControlVarTitle( input_thread_t *, int i_title );
329 void input_ConfigVarInit ( input_thread_t * );
332 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
333 int subtitles_Filter( const char *);
335 /* Helpers FIXME to export without input_ prefix */
336 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
338 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"