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