Sanitize input headers (pass 4).
[vlc.git] / src / input / input_internal.h
1 /*****************************************************************************
2  * input_internal.h: Internal input structures
3  *****************************************************************************
4  * Copyright (C) 1998-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
25 # error This header file can only be included from LibVLC.
26 #endif
27
28 #ifndef _INPUT_INTERNAL_H
29 #define _INPUT_INTERNAL_H 1
30
31 #include <vlc_access.h>
32 #include <vlc_demux.h>
33 #include <vlc_input.h>
34 #include <libvlc.h>
35
36 /*****************************************************************************
37  *  Private input fields
38  *****************************************************************************/
39 /* input_source_t: gathers all information per input source */
40 typedef struct
41 {
42     /* Input item description */
43     input_item_t *p_item;
44
45     /* Access/Stream/Demux plugins */
46     access_t *p_access;
47     stream_t *p_stream;
48     demux_t  *p_demux;
49
50     /* Title infos for that input */
51     bool         b_title_demux; /* Titles/Seekpoints provided by demux */
52     int          i_title;
53     input_title_t **title;
54
55     int i_title_offset;
56     int i_seekpoint_offset;
57
58     int i_title_start;
59     int i_title_end;
60     int i_seekpoint_start;
61     int i_seekpoint_end;
62
63     /* Properties */
64     bool b_can_pause;
65     bool b_can_pace_control;
66     bool b_can_rate_control;
67     bool b_can_stream_record;
68     bool b_rescale_ts;
69
70     bool       b_eof;   /* eof of demuxer */
71     double     f_fps;
72
73     /* Clock average variation */
74     int     i_cr_average;
75
76 } input_source_t;
77
78 /** Private input fields */
79 struct input_thread_private_t
80 {
81     /* Object's event manager */
82     vlc_event_manager_t event_manager;
83
84     /* Global properties */
85     bool        b_can_pause;
86     bool        b_can_rate_control;
87
88     int         i_rate;
89     bool        b_recording;
90     /* */
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 */
94
95     /* Title infos FIXME multi-input (not easy) ? */
96     int          i_title;
97     input_title_t **title;
98
99     int i_title_offset;
100     int i_seekpoint_offset;
101
102     /* User bookmarks FIXME won't be easy with multiples input */
103     int         i_bookmark;
104     seekpoint_t **bookmark;
105
106     /* Input attachment */
107     int i_attachment;
108     input_attachment_t **attachment;
109
110     /* Output */
111     es_out_t        *p_es_out;
112     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
113     bool            b_out_pace_control; /*     idem ? */
114
115     /* Main input properties */
116     input_source_t input;
117     /* Slave demuxers (subs, and others) */
118     int            i_slave;
119     input_source_t **slave;
120
121     /* Stats counters */
122     struct {
123         counter_t *p_read_packets;
124         counter_t *p_read_bytes;
125         counter_t *p_input_bitrate;
126         counter_t *p_demux_read;
127         counter_t *p_demux_bitrate;
128         counter_t *p_decoded_audio;
129         counter_t *p_decoded_video;
130         counter_t *p_decoded_sub;
131         counter_t *p_sout_sent_packets;
132         counter_t *p_sout_sent_bytes;
133         counter_t *p_sout_send_bitrate;
134         counter_t *p_played_abuffers;
135         counter_t *p_lost_abuffers;
136         counter_t *p_displayed_pictures;
137         counter_t *p_lost_pictures;
138         vlc_mutex_t counters_lock;
139     } counters;
140
141     /* Buffer of pending actions */
142     vlc_mutex_t lock_control;
143     vlc_cond_t  wait_control;
144     int i_control;
145     struct
146     {
147         /* XXX for string value you have to allocate it before calling
148          * input_ControlPush */
149         int         i_type;
150         vlc_value_t val;
151     } control[INPUT_CONTROL_FIFO_SIZE];
152 };
153
154 /***************************************************************************
155  * Internal control helpers
156  ***************************************************************************/
157 enum input_control_e
158 {
159     INPUT_CONTROL_SET_DIE,
160
161     INPUT_CONTROL_SET_STATE,
162
163     INPUT_CONTROL_SET_RATE,
164     INPUT_CONTROL_SET_RATE_SLOWER,
165     INPUT_CONTROL_SET_RATE_FASTER,
166
167     INPUT_CONTROL_SET_POSITION,
168     INPUT_CONTROL_SET_POSITION_OFFSET,
169
170     INPUT_CONTROL_SET_TIME,
171     INPUT_CONTROL_SET_TIME_OFFSET,
172
173     INPUT_CONTROL_SET_PROGRAM,
174
175     INPUT_CONTROL_SET_TITLE,
176     INPUT_CONTROL_SET_TITLE_NEXT,
177     INPUT_CONTROL_SET_TITLE_PREV,
178
179     INPUT_CONTROL_SET_SEEKPOINT,
180     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
181     INPUT_CONTROL_SET_SEEKPOINT_PREV,
182
183     INPUT_CONTROL_SET_BOOKMARK,
184
185     INPUT_CONTROL_SET_ES,
186     INPUT_CONTROL_RESTART_ES,
187
188     INPUT_CONTROL_SET_AUDIO_DELAY,
189     INPUT_CONTROL_SET_SPU_DELAY,
190
191     INPUT_CONTROL_ADD_SLAVE,
192
193     INPUT_CONTROL_ADD_SUBTITLE,
194
195     INPUT_CONTROL_SET_RECORD_STATE,
196 };
197
198 /* Internal helpers */
199 static inline void input_ControlPush( input_thread_t *p_input,
200                                       int i_type, vlc_value_t *p_val )
201 {
202     vlc_mutex_lock( &p_input->p->lock_control );
203     if( i_type == INPUT_CONTROL_SET_DIE )
204     {
205         /* Special case, empty the control */
206         p_input->p->i_control = 1;
207         p_input->p->control[0].i_type = i_type;
208         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
209     }
210     else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
211     {
212         msg_Err( p_input, "input control fifo overflow, trashing type=%d",
213                  i_type );
214     }
215     else
216     {
217         p_input->p->control[p_input->p->i_control].i_type = i_type;
218         if( p_val )
219             p_input->p->control[p_input->p->i_control].val = *p_val;
220         else
221             memset( &p_input->p->control[p_input->p->i_control].val, 0,
222                     sizeof( vlc_value_t ) );
223
224         p_input->p->i_control++;
225     }
226     vlc_cond_signal( &p_input->p->wait_control );
227     vlc_mutex_unlock( &p_input->p->lock_control );
228 }
229
230 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
231  * anyway. */
232
233 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
234 {
235     bool send_event = false;
236
237     if( !p_i->p_meta )
238         p_i->p_meta = vlc_meta_New();
239
240     vlc_mutex_lock( &p_i->lock );
241     int new_status;
242     if( preparsed )
243         new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
244     else
245         new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
246     if( p_i->p_meta->i_status != new_status )
247     {
248         p_i->p_meta->i_status = new_status;
249         send_event = true;
250     }
251
252     vlc_mutex_unlock( &p_i->lock );
253
254     if( send_event )
255     {
256         vlc_event_t event;
257         event.type = vlc_InputItemPreparsedChanged;
258         event.u.input_item_preparsed_changed.new_status = new_status;
259         vlc_event_send( &p_i->event_manager, &event );
260     }
261 }
262
263 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
264 {
265     if( !p_i->p_meta )
266         p_i->p_meta = vlc_meta_New();
267
268     if( notfound )
269         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
270     else
271         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
272 }
273
274 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
275 {
276     if( !p_i->p_meta )
277         p_i->p_meta = vlc_meta_New();
278
279     if( artfetched )
280         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
281     else
282         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
283 }
284
285 void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
286
287 /**********************************************************************
288  * Item metadata
289  **********************************************************************/
290 typedef struct playlist_album_t
291 {
292     char *psz_artist;
293     char *psz_album;
294     char *psz_arturl;
295     bool b_found;
296 } playlist_album_t;
297
298 int         input_ArtFind       ( playlist_t *, input_item_t * );
299 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
300
301 /* Becarefull; p_item lock HAS to be taken */
302 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
303
304 /***************************************************************************
305  * Internal prototypes
306  ***************************************************************************/
307
308 /* misc/stats.c */
309 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
310
311 /* input.c */
312 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
313 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
314
315 sout_instance_t * input_DetachSout( input_thread_t *p_input );
316
317 /* var.c */
318 void input_ControlVarInit ( input_thread_t * );
319 void input_ControlVarStop( input_thread_t * );
320 void input_ControlVarNavigation( input_thread_t * );
321 void input_ControlVarTitle( input_thread_t *, int i_title );
322
323 void input_ConfigVarInit ( input_thread_t * );
324
325 /* stream.c */
326 stream_t *stream_AccessNew( access_t *p_access, bool );
327 void stream_AccessDelete( stream_t *s );
328 void stream_AccessReset( stream_t *s );
329 void stream_AccessUpdate( stream_t *s );
330
331 /* Subtitles */
332 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
333 int subtitles_Filter( const char *);
334
335 static inline void input_ChangeStateWithVarCallback( input_thread_t *p_input, int i_state, bool callback )
336 {
337     const bool changed = p_input->i_state != i_state;
338
339     p_input->i_state = i_state;
340     if( i_state == ERROR_S )
341         p_input->b_error = true;
342     else if( i_state == END_S )
343         p_input->b_eof = true;
344
345     input_item_SetHasErrorWhenReading( p_input->p->input.p_item, (i_state == ERROR_S) );
346
347     if( callback )
348     {
349         var_SetInteger( p_input, "state", i_state );
350     }
351     else
352     {
353         vlc_value_t val;
354         val.i_int = i_state;
355         var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
356     }
357     if( changed )
358     {
359         vlc_event_t event;
360         event.type = vlc_InputStateChanged;
361         event.u.input_state_changed.new_state = i_state;
362         vlc_event_send( &p_input->p->event_manager, &event );
363     }
364 }
365
366 static inline void input_ChangeState( input_thread_t *p_input, int state )
367 {
368     input_ChangeStateWithVarCallback( p_input, state, true );
369 }
370
371 /* Helpers FIXME to export without input_ prefix */
372 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
373
374 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
375
376 #endif