Privatized i_pts_delay (input_thread_t).
[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     /* 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     bool       b_eof;   /* eof of demuxer */
72
73 } input_source_t;
74
75 /** Private input fields */
76 struct input_thread_private_t
77 {
78     /* Global properties */
79     bool        b_can_pause;
80     bool        b_can_rate_control;
81     double      f_fps;
82
83     /* Internal caching common to all sources */
84     mtime_t     i_pts_delay;
85
86     /* Current state */
87     int         i_rate;
88     bool        b_recording;
89
90     /* Playtime configuration */
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     seekpoint_t bookmark;
104     int         i_bookmark;
105     seekpoint_t **pp_bookmark;
106
107     /* Input attachment */
108     int i_attachment;
109     input_attachment_t **attachment;
110
111     /* Output */
112     es_out_t        *p_es_out;
113     es_out_t        *p_es_out_display;
114     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
115     bool            b_out_pace_control; /*     idem ? */
116
117     /* Main input properties */
118
119     /* Input item */
120     input_item_t   *p_item;
121     /* Clock average variation */
122     int            i_cr_average;
123     /* Main source */
124     input_source_t input;
125     /* Slave sources (subs, and others) */
126     int            i_slave;
127     input_source_t **slave;
128
129     /* Ressources */
130     input_ressource_t *p_ressource;
131
132     /* Stats counters */
133     struct {
134         counter_t *p_read_packets;
135         counter_t *p_read_bytes;
136         counter_t *p_input_bitrate;
137         counter_t *p_demux_read;
138         counter_t *p_demux_bitrate;
139         counter_t *p_decoded_audio;
140         counter_t *p_decoded_video;
141         counter_t *p_decoded_sub;
142         counter_t *p_sout_sent_packets;
143         counter_t *p_sout_sent_bytes;
144         counter_t *p_sout_send_bitrate;
145         counter_t *p_played_abuffers;
146         counter_t *p_lost_abuffers;
147         counter_t *p_displayed_pictures;
148         counter_t *p_lost_pictures;
149         vlc_mutex_t counters_lock;
150     } counters;
151
152     /* Buffer of pending actions */
153     vlc_mutex_t lock_control;
154     vlc_cond_t  wait_control;
155     int i_control;
156     struct
157     {
158         /* XXX for string value you have to allocate it before calling
159          * input_ControlPush */
160         int         i_type;
161         vlc_value_t val;
162     } control[INPUT_CONTROL_FIFO_SIZE];
163 };
164
165 /***************************************************************************
166  * Internal control helpers
167  ***************************************************************************/
168 enum input_control_e
169 {
170     INPUT_CONTROL_SET_DIE,
171
172     INPUT_CONTROL_SET_STATE,
173
174     INPUT_CONTROL_SET_RATE,
175     INPUT_CONTROL_SET_RATE_SLOWER,
176     INPUT_CONTROL_SET_RATE_FASTER,
177
178     INPUT_CONTROL_SET_POSITION,
179     INPUT_CONTROL_SET_POSITION_OFFSET,
180
181     INPUT_CONTROL_SET_TIME,
182     INPUT_CONTROL_SET_TIME_OFFSET,
183
184     INPUT_CONTROL_SET_PROGRAM,
185
186     INPUT_CONTROL_SET_TITLE,
187     INPUT_CONTROL_SET_TITLE_NEXT,
188     INPUT_CONTROL_SET_TITLE_PREV,
189
190     INPUT_CONTROL_SET_SEEKPOINT,
191     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
192     INPUT_CONTROL_SET_SEEKPOINT_PREV,
193
194     INPUT_CONTROL_SET_BOOKMARK,
195
196     INPUT_CONTROL_SET_ES,
197     INPUT_CONTROL_RESTART_ES,
198
199     INPUT_CONTROL_SET_AUDIO_DELAY,
200     INPUT_CONTROL_SET_SPU_DELAY,
201
202     INPUT_CONTROL_ADD_SLAVE,
203
204     INPUT_CONTROL_ADD_SUBTITLE,
205
206     INPUT_CONTROL_SET_RECORD_STATE,
207
208     INPUT_CONTROL_SET_FRAME_NEXT,
209 };
210
211 /* Internal helpers */
212 void input_ControlPush( input_thread_t *, int i_type, vlc_value_t * );
213
214 /**********************************************************************
215  * Item metadata
216  **********************************************************************/
217 /* input_ExtractAttachmentAndCacheArt:
218  *  Becarefull; p_item lock HAS to be taken */
219 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
220
221 /***************************************************************************
222  * Internal prototypes
223  ***************************************************************************/
224
225 /* var.c */
226 void input_ControlVarInit ( input_thread_t * );
227 void input_ControlVarStop( input_thread_t * );
228 void input_ControlVarNavigation( input_thread_t * );
229 void input_ControlVarTitle( input_thread_t *, int i_title );
230
231 void input_ConfigVarInit ( input_thread_t * );
232
233 /* Subtitles */
234 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
235 int subtitles_Filter( const char *);
236
237 #endif