fe06e7fdd4e22a2b12c19bd9036f859ea69fc739
[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 #include "input_interface.h"
36
37 /*****************************************************************************
38  *  Private input fields
39  *****************************************************************************/
40
41 #define INPUT_CONTROL_FIFO_SIZE    100
42
43 /* input_source_t: gathers all information per input source */
44 typedef struct
45 {
46     /* Input item description */
47     input_item_t *p_item;
48
49     /* Access/Stream/Demux plugins */
50     access_t *p_access;
51     stream_t *p_stream;
52     demux_t  *p_demux;
53
54     /* Title infos for that input */
55     bool         b_title_demux; /* Titles/Seekpoints provided by demux */
56     int          i_title;
57     input_title_t **title;
58
59     int i_title_offset;
60     int i_seekpoint_offset;
61
62     int i_title_start;
63     int i_title_end;
64     int i_seekpoint_start;
65     int i_seekpoint_end;
66
67     /* Properties */
68     bool b_can_pause;
69     bool b_can_pace_control;
70     bool b_can_rate_control;
71     bool b_can_stream_record;
72     bool b_rescale_ts;
73
74     bool       b_eof;   /* eof of demuxer */
75     double     f_fps;
76
77     /* Clock average variation */
78     int     i_cr_average;
79
80 } input_source_t;
81
82 /** Private input fields */
83 struct input_thread_private_t
84 {
85     /* Object's event manager */
86     vlc_event_manager_t event_manager;
87
88     /* Global properties */
89     bool        b_can_pause;
90     bool        b_can_rate_control;
91
92     int         i_rate;
93     bool        b_recording;
94     /* */
95     int64_t     i_start;    /* :start-time,0 by default */
96     int64_t     i_stop;     /* :stop-time, 0 if none */
97     int64_t     i_run;      /* :run-time, 0 if none */
98
99     /* Title infos FIXME multi-input (not easy) ? */
100     int          i_title;
101     input_title_t **title;
102
103     int i_title_offset;
104     int i_seekpoint_offset;
105
106     /* User bookmarks FIXME won't be easy with multiples input */
107     int         i_bookmark;
108     seekpoint_t **bookmark;
109
110     /* Input attachment */
111     int i_attachment;
112     input_attachment_t **attachment;
113
114     /* Output */
115     es_out_t        *p_es_out;
116     es_out_t        *p_es_out_display;
117     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
118     bool            b_out_pace_control; /*     idem ? */
119
120     /* Main input properties */
121     input_source_t input;
122     /* Slave demuxers (subs, and others) */
123     int            i_slave;
124     input_source_t **slave;
125
126     /* Stats counters */
127     struct {
128         counter_t *p_read_packets;
129         counter_t *p_read_bytes;
130         counter_t *p_input_bitrate;
131         counter_t *p_demux_read;
132         counter_t *p_demux_bitrate;
133         counter_t *p_decoded_audio;
134         counter_t *p_decoded_video;
135         counter_t *p_decoded_sub;
136         counter_t *p_sout_sent_packets;
137         counter_t *p_sout_sent_bytes;
138         counter_t *p_sout_send_bitrate;
139         counter_t *p_played_abuffers;
140         counter_t *p_lost_abuffers;
141         counter_t *p_displayed_pictures;
142         counter_t *p_lost_pictures;
143         vlc_mutex_t counters_lock;
144     } counters;
145
146     /* Buffer of pending actions */
147     vlc_mutex_t lock_control;
148     vlc_cond_t  wait_control;
149     int i_control;
150     struct
151     {
152         /* XXX for string value you have to allocate it before calling
153          * input_ControlPush */
154         int         i_type;
155         vlc_value_t val;
156     } control[INPUT_CONTROL_FIFO_SIZE];
157 };
158
159 /***************************************************************************
160  * Internal control helpers
161  ***************************************************************************/
162 enum input_control_e
163 {
164     INPUT_CONTROL_SET_DIE,
165
166     INPUT_CONTROL_SET_STATE,
167
168     INPUT_CONTROL_SET_RATE,
169     INPUT_CONTROL_SET_RATE_SLOWER,
170     INPUT_CONTROL_SET_RATE_FASTER,
171
172     INPUT_CONTROL_SET_POSITION,
173     INPUT_CONTROL_SET_POSITION_OFFSET,
174
175     INPUT_CONTROL_SET_TIME,
176     INPUT_CONTROL_SET_TIME_OFFSET,
177
178     INPUT_CONTROL_SET_PROGRAM,
179
180     INPUT_CONTROL_SET_TITLE,
181     INPUT_CONTROL_SET_TITLE_NEXT,
182     INPUT_CONTROL_SET_TITLE_PREV,
183
184     INPUT_CONTROL_SET_SEEKPOINT,
185     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
186     INPUT_CONTROL_SET_SEEKPOINT_PREV,
187
188     INPUT_CONTROL_SET_BOOKMARK,
189
190     INPUT_CONTROL_SET_ES,
191     INPUT_CONTROL_RESTART_ES,
192
193     INPUT_CONTROL_SET_AUDIO_DELAY,
194     INPUT_CONTROL_SET_SPU_DELAY,
195
196     INPUT_CONTROL_ADD_SLAVE,
197
198     INPUT_CONTROL_ADD_SUBTITLE,
199
200     INPUT_CONTROL_SET_RECORD_STATE,
201
202     INPUT_CONTROL_SET_FRAME_NEXT,
203 };
204
205 /* Internal helpers */
206 static inline void input_ControlPush( input_thread_t *p_input,
207                                       int i_type, vlc_value_t *p_val )
208 {
209     vlc_mutex_lock( &p_input->p->lock_control );
210     if( i_type == INPUT_CONTROL_SET_DIE )
211     {
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 ) );
216     }
217     else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
218     {
219         msg_Err( p_input, "input control fifo overflow, trashing type=%d",
220                  i_type );
221     }
222     else
223     {
224         p_input->p->control[p_input->p->i_control].i_type = i_type;
225         if( p_val )
226             p_input->p->control[p_input->p->i_control].val = *p_val;
227         else
228             memset( &p_input->p->control[p_input->p->i_control].val, 0,
229                     sizeof( vlc_value_t ) );
230
231         p_input->p->i_control++;
232     }
233     vlc_cond_signal( &p_input->p->wait_control );
234     vlc_mutex_unlock( &p_input->p->lock_control );
235 }
236
237 /**********************************************************************
238  * Item metadata
239  **********************************************************************/
240 /* input_ExtractAttachmentAndCacheArt:
241  *  Becarefull; p_item lock HAS to be taken */
242 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
243
244 void input_item_SetErrorWhenReading( input_item_t *p_i, bool b_error );
245
246 /***************************************************************************
247  * Internal prototypes
248  ***************************************************************************/
249
250 /* var.c */
251 void input_ControlVarInit ( input_thread_t * );
252 void input_ControlVarStop( input_thread_t * );
253 void input_ControlVarNavigation( input_thread_t * );
254 void input_ControlVarTitle( input_thread_t *, int i_title );
255
256 void input_ConfigVarInit ( input_thread_t * );
257
258 /* Subtitles */
259 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
260 int subtitles_Filter( const char *);
261
262 /* Helpers FIXME to export without input_ prefix */
263 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
264
265 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
266
267 #endif