]> git.sesse.net Git - vlc/blob - src/input/input_internal.h
Use var_Inherit* instead of var_CreateGet*.
[vlc] / 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     /* Access/Stream/Demux plugins */
47     access_t *p_access;
48     stream_t *p_stream;
49     demux_t  *p_demux;
50
51     /* Title infos for that input */
52     bool         b_title_demux; /* Titles/Seekpoints provided by demux */
53     int          i_title;
54     input_title_t **title;
55
56     int i_title_offset;
57     int i_seekpoint_offset;
58
59     int i_title_start;
60     int i_title_end;
61     int i_seekpoint_start;
62     int i_seekpoint_end;
63
64     /* Properties */
65     bool b_can_pause;
66     bool b_can_pace_control;
67     bool b_can_rate_control;
68     bool b_can_stream_record;
69     bool b_rescale_ts;
70
71     /* */
72     int64_t i_pts_delay;
73
74     bool       b_eof;   /* eof of demuxer */
75
76 } input_source_t;
77
78 typedef struct
79 {
80     int         i_type;
81     vlc_value_t val;
82 } input_control_t;
83
84 /** Private input fields */
85 struct input_thread_private_t
86 {
87     /* Global properties */
88     double      f_fps;
89     int         i_state;
90     bool        b_can_pause;
91     bool        b_can_rate_control;
92     bool        b_can_pace_control;
93
94     /* Current state */
95     bool        b_recording;
96     int         i_rate;
97
98     /* Playtime configuration and state */
99     int64_t     i_start;    /* :start-time,0 by default */
100     int64_t     i_stop;     /* :stop-time, 0 if none */
101     int64_t     i_run;      /* :run-time, 0 if none */
102     int64_t     i_time;     /* Current time */
103     bool        b_fast_seek;/* :input-fast-seek */
104
105     /* Output */
106     bool            b_out_pace_control; /* XXX Move it ot es_sout ? */
107     sout_instance_t *p_sout;            /* Idem ? */
108     es_out_t        *p_es_out;
109     es_out_t        *p_es_out_display;
110
111     /* Title infos FIXME multi-input (not easy) ? */
112     int          i_title;
113     input_title_t **title;
114
115     int i_title_offset;
116     int i_seekpoint_offset;
117
118     /* User bookmarks FIXME won't be easy with multiples input */
119     seekpoint_t bookmark;
120     int         i_bookmark;
121     seekpoint_t **pp_bookmark;
122
123     /* Input attachment */
124     int i_attachment;
125     input_attachment_t **attachment;
126
127     /* Main input properties */
128
129     /* Input item */
130     input_item_t   *p_item;
131
132     /* Main source */
133     input_source_t input;
134     /* Slave sources (subs, and others) */
135     int            i_slave;
136     input_source_t **slave;
137
138     /* Resources */
139     input_resource_t *p_resource;
140     input_resource_t *p_resource_private;
141
142     /* Stats counters */
143     struct {
144         counter_t *p_read_packets;
145         counter_t *p_read_bytes;
146         counter_t *p_input_bitrate;
147         counter_t *p_demux_read;
148         counter_t *p_demux_bitrate;
149         counter_t *p_demux_corrupted;
150         counter_t *p_demux_discontinuity;
151         counter_t *p_decoded_audio;
152         counter_t *p_decoded_video;
153         counter_t *p_decoded_sub;
154         counter_t *p_sout_sent_packets;
155         counter_t *p_sout_sent_bytes;
156         counter_t *p_sout_send_bitrate;
157         counter_t *p_played_abuffers;
158         counter_t *p_lost_abuffers;
159         counter_t *p_displayed_pictures;
160         counter_t *p_lost_pictures;
161         vlc_mutex_t counters_lock;
162     } counters;
163
164     /* Buffer of pending actions */
165     vlc_mutex_t lock_control;
166     vlc_cond_t  wait_control;
167     int i_control;
168     input_control_t control[INPUT_CONTROL_FIFO_SIZE];
169
170     bool b_abort;
171 };
172
173 /***************************************************************************
174  * Internal control helpers
175  ***************************************************************************/
176 enum input_control_e
177 {
178     INPUT_CONTROL_SET_DIE,
179
180     INPUT_CONTROL_SET_STATE,
181
182     INPUT_CONTROL_SET_RATE,
183
184     INPUT_CONTROL_SET_POSITION,
185
186     INPUT_CONTROL_SET_TIME,
187
188     INPUT_CONTROL_SET_PROGRAM,
189
190     INPUT_CONTROL_SET_TITLE,
191     INPUT_CONTROL_SET_TITLE_NEXT,
192     INPUT_CONTROL_SET_TITLE_PREV,
193
194     INPUT_CONTROL_SET_SEEKPOINT,
195     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
196     INPUT_CONTROL_SET_SEEKPOINT_PREV,
197
198     INPUT_CONTROL_SET_BOOKMARK,
199
200     INPUT_CONTROL_SET_ES,
201     INPUT_CONTROL_RESTART_ES,
202
203     INPUT_CONTROL_SET_AUDIO_DELAY,
204     INPUT_CONTROL_SET_SPU_DELAY,
205
206     INPUT_CONTROL_ADD_SLAVE,
207
208     INPUT_CONTROL_ADD_SUBTITLE,
209
210     INPUT_CONTROL_SET_RECORD_STATE,
211
212     INPUT_CONTROL_SET_FRAME_NEXT,
213 };
214
215 /* Internal helpers */
216
217 /* XXX for string value you have to allocate it before calling
218  * input_ControlPush
219  */
220 void input_ControlPush( input_thread_t *, int i_type, vlc_value_t * );
221
222 /* Bound pts_delay */
223 #define INPUT_PTS_DELAY_MAX INT64_C(60000000)
224
225 /**********************************************************************
226  * Item metadata
227  **********************************************************************/
228 /* input_ExtractAttachmentAndCacheArt:
229  *  Becarefull; p_item lock HAS to be taken */
230 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
231
232 /***************************************************************************
233  * Internal prototypes
234  ***************************************************************************/
235
236 /* var.c */
237 void input_ControlVarInit ( input_thread_t * );
238 void input_ControlVarStop( input_thread_t * );
239 void input_ControlVarNavigation( input_thread_t * );
240 void input_ControlVarTitle( input_thread_t *, int i_title );
241
242 void input_ConfigVarInit ( input_thread_t * );
243
244 /* Subtitles */
245 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
246 int subtitles_Filter( const char *);
247
248 #endif