1 /*****************************************************************************
2 * vlc_demux.h: Demuxer descriptor, queries and methods
3 *****************************************************************************
4 * Copyright (C) 1999-2005 VLC authors and VideoLAN
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
28 #include <vlc_stream.h>
29 #include <vlc_es_out.h>
32 * \defgroup demux Demultiplexer
34 * Demultiplexers (file format parsers)
37 * Demultiplexer modules interface
44 /* Module properties */
47 /* eg informative but needed (we can have access+demux) */
54 stream_t
*s
; /* NULL in case of a access+demux in one */
57 es_out_t
*out
; /* our p_es_out */
60 int (*pf_demux
) ( demux_t
* ); /* demux one frame only */
61 int (*pf_control
)( demux_t
*, int i_query
, va_list args
);
63 /* Demux has to maintain them uptodate
64 * when it is responsible of seekpoint/title */
67 unsigned int i_update
; /* Demux sets them on change,
68 Input removes them once take into account*/
69 /* Seekpoint/Title at demux level */
70 int i_title
; /* idem, start from 0 (could be menu) */
71 int i_seekpoint
; /* idem, start from 0 */
75 /* Weak link to parent input */
76 input_thread_t
*p_input
;
79 /* pf_demux return values */
80 #define VLC_DEMUXER_EOF 0
81 #define VLC_DEMUXER_EGENERIC -1
82 #define VLC_DEMUXER_SUCCESS 1
84 /* demux_t.info.i_update field */
85 #define INPUT_UPDATE_TITLE 0x0010
86 #define INPUT_UPDATE_SEEKPOINT 0x0020
87 #define INPUT_UPDATE_META 0x0040
88 #define INPUT_UPDATE_TITLE_LIST 0x0100
90 /* demux_meta_t is returned by "meta reader" module to the demuxer */
91 typedef struct demux_meta_t
94 input_item_t
*p_item
; /***< the input item that is being read */
96 vlc_meta_t
*p_meta
; /**< meta data */
98 int i_attachments
; /**< number of attachments */
99 input_attachment_t
**attachments
; /**< array of attachments */
104 /* I. Common queries to access_demux and demux */
105 /* POSITION double between 0.0 and 1.0 */
106 DEMUX_GET_POSITION
, /* arg1= double * res= */
107 DEMUX_SET_POSITION
, /* arg1= double arg2= bool b_precise res=can fail */
109 /* LENGTH/TIME in microsecond, 0 if unknown */
110 DEMUX_GET_LENGTH
, /* arg1= int64_t * res= */
111 DEMUX_GET_TIME
, /* arg1= int64_t * res= */
112 DEMUX_SET_TIME
, /* arg1= int64_t arg2= bool b_precise res=can fail */
114 /* TITLE_INFO only if more than 1 title or 1 chapter */
115 DEMUX_GET_TITLE_INFO
, /* arg1=input_title_t*** arg2=int*
116 arg3=int*pi_title_offset(0), arg4=int*pi_seekpoint_offset(0) can fail */
117 /* TITLE/SEEKPOINT, only when TITLE_INFO succeed */
118 DEMUX_SET_TITLE
, /* arg1= int can fail */
119 DEMUX_SET_SEEKPOINT
, /* arg1= int can fail */
121 /* DEMUX_SET_GROUP/SET_ES only a hint for demuxer (mainly DVB) to allow not
122 * reading everything (you should not use this to call es_out_Control)
123 * if you don't know what to do with it, just IGNORE it, it is safe(r)
124 * -1 means all group, 0 default group (first es added) */
125 DEMUX_SET_GROUP
, /* arg1= int, arg2=const vlc_list_t * can fail */
126 DEMUX_SET_ES
, /* arg1= int can fail */
128 /* Ask the demux to demux until the given date at the next pf_demux call
129 * but not more (and not less, at the precision available of course).
130 * XXX: not mandatory (except for subtitle demux) but will help a lot
133 DEMUX_SET_NEXT_DEMUX_TIME
, /* arg1= int64_t can fail */
134 /* FPS for correct subtitles handling */
135 DEMUX_GET_FPS
, /* arg1= double * res=can fail */
138 DEMUX_GET_META
, /* arg1= vlc_meta_t ** res=can fail */
139 DEMUX_HAS_UNSUPPORTED_META
, /* arg1= bool * res can fail */
142 DEMUX_GET_ATTACHMENTS
, /* arg1=input_attachment_t***, int* res=can fail */
144 /* RECORD you are ensured that it is never called twice with the same state
145 * you should accept it only if the stream can be recorded without
146 * any modification or header addition. */
147 DEMUX_CAN_RECORD
, /* arg1=bool* res=can fail(assume false) */
148 DEMUX_SET_RECORD_STATE
, /* arg1=bool res=can fail */
150 DEMUX_GET_SIGNAL
, /* arg1=double *pf_quality, arg2=double *pf_strength
153 /* II. Specific access_demux queries */
154 /* PAUSE you are ensured that it is never called twice with the same state */
155 DEMUX_CAN_PAUSE
= 0x1000, /* arg1= bool* can fail (assume false)*/
156 DEMUX_SET_PAUSE_STATE
, /* arg1= bool can fail */
158 DEMUX_GET_PTS_DELAY
, /* arg1= int64_t* cannot fail */
160 /* DEMUX_CAN_CONTROL_PACE returns true (*pb_pace) if we can read the
161 * data at our pace */
162 DEMUX_CAN_CONTROL_PACE
, /* arg1= bool*pb_pace can fail (assume false) */
164 /* DEMUX_CAN_CONTROL_RATE is called only if DEMUX_CAN_CONTROL_PACE has returned false.
165 * *pb_rate should be true when the rate can be changed (using DEMUX_SET_RATE)
166 * *pb_ts_rescale should be true when the timestamps (pts/dts/pcr) have to be rescaled */
167 DEMUX_CAN_CONTROL_RATE
, /* arg1= bool*pb_rate arg2= bool*pb_ts_rescale can fail(assume false) */
168 /* DEMUX_SET_RATE is called only if DEMUX_CAN_CONTROL_RATE has returned true.
169 * It should return the value really used in *pi_rate */
170 DEMUX_SET_RATE
, /* arg1= int*pi_rate can fail */
172 DEMUX_CAN_SEEK
, /* arg1= bool* can fail (assume false)*/
174 /* DEMUX_IS_PLAYLIST returns true if the demux is a playlist
175 * (an archive, a directory or a network share is also a playlist) */
176 DEMUX_IS_PLAYLIST
, /* arg1= bool* can fail (assume false)*/
179 DEMUX_NAV_ACTIVATE
, /* res=can fail */
180 DEMUX_NAV_UP
, /* res=can fail */
181 DEMUX_NAV_DOWN
, /* res=can fail */
182 DEMUX_NAV_LEFT
, /* res=can fail */
183 DEMUX_NAV_RIGHT
, /* res=can fail */
186 VLC_API
int demux_vaControlHelper( stream_t
*, int64_t i_start
, int64_t i_end
, int64_t i_bitrate
, int i_align
, int i_query
, va_list args
);
188 static inline void demux_UpdateTitleFromStream( demux_t
*demux
)
190 stream_t
*s
= demux
->s
;
191 unsigned title
, seekpoint
;
193 if( stream_Control( s
, STREAM_GET_TITLE
, &title
) == VLC_SUCCESS
194 && title
!= (unsigned)demux
->info
.i_title
)
196 demux
->info
.i_title
= title
;
197 demux
->info
.i_update
|= INPUT_UPDATE_TITLE
;
200 if( stream_Control( s
, STREAM_GET_SEEKPOINT
, &seekpoint
) == VLC_SUCCESS
201 && seekpoint
!= (unsigned)demux
->info
.i_seekpoint
)
203 demux
->info
.i_seekpoint
= seekpoint
;
204 demux
->info
.i_update
|= INPUT_UPDATE_SEEKPOINT
;
208 /*************************************************************************
209 * Miscellaneous helpers for demuxers
210 *************************************************************************/
213 static inline bool demux_IsPathExtension( demux_t
*p_demux
, const char *psz_extension
)
215 const char *name
= (p_demux
->psz_file
!= NULL
) ? p_demux
->psz_file
216 : p_demux
->psz_location
;
217 const char *psz_ext
= strrchr ( name
, '.' );
218 if( !psz_ext
|| strcasecmp( psz_ext
, psz_extension
) )
224 static inline bool demux_IsForced( demux_t
*p_demux
, const char *psz_name
)
226 if( !p_demux
->psz_demux
|| strcmp( p_demux
->psz_demux
, psz_name
) )
232 * This function will create a packetizer suitable for a demuxer that parses
235 * The provided es_format_t will be cleaned on error or by
236 * demux_PacketizerDestroy.
238 VLC_API decoder_t
* demux_PacketizerNew( demux_t
*p_demux
, es_format_t
*p_fmt
, const char *psz_msg
) VLC_USED
;
241 * This function will destroy a packetizer create by demux_PacketizerNew.
243 VLC_API
void demux_PacketizerDestroy( decoder_t
*p_packetizer
);
246 #define DEMUX_INIT_COMMON() do { \
247 p_demux->pf_control = Control; \
248 p_demux->pf_demux = Demux; \
249 p_demux->p_sys = calloc( 1, sizeof( demux_sys_t ) ); \
250 if( !p_demux->p_sys ) return VLC_ENOMEM;\