1 /*****************************************************************************
2 * vlc_demux.h: Demuxer descriptor, queries and methods
3 *****************************************************************************
4 * Copyright (C) 1999-2005 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
24 #if !defined( __LIBVLC__ )
25 #error You are not libvlc or one of its plugins. You cannot include this file
29 #define _VLC_DEMUX_H 1
32 #include <vlc_stream.h>
33 #include <vlc_es_out.h>
36 * \defgroup demux Demux
44 /* Module properties */
47 /* eg informative but needed (we can have access+demux) */
53 stream_t *s; /* NULL in case of a access+demux in one */
56 es_out_t *out; /* our p_es_out */
59 int (*pf_demux) ( demux_t * ); /* demux one frame only */
60 int (*pf_control)( demux_t *, int i_query, va_list args);
62 /* Demux has to maintain them uptodate
63 * when it is responsible of seekpoint/title */
66 unsigned int i_update; /* Demux sets them on change,
67 Input removes them once take into account*/
68 /* Seekpoint/Title at demux level */
69 int i_title; /* idem, start from 0 (could be menu) */
70 int i_seekpoint; /* idem, start from 0 */
77 /* I. Common queries to access_demux and demux */
78 /* POSITION double between 0.0 and 1.0 */
79 DEMUX_GET_POSITION, /* arg1= double * res= */
80 DEMUX_SET_POSITION, /* arg1= double res=can fail */
82 /* LENGTH/TIME in microsecond, 0 if unknown */
83 DEMUX_GET_LENGTH, /* arg1= int64_t * res= */
84 DEMUX_GET_TIME, /* arg1= int64_t * res= */
85 DEMUX_SET_TIME, /* arg1= int64_t res=can fail */
87 /* TITLE_INFO only if more than 1 title or 1 chapter */
88 DEMUX_GET_TITLE_INFO, /* arg1=input_title_t*** arg2=int* can fail */
90 /* TITLE/SEEKPOINT, only when TITLE_INFO succeed */
91 DEMUX_SET_TITLE, /* arg1= int can fail */
92 DEMUX_SET_SEEKPOINT, /* arg1= int can fail */
94 /* DEMUX_SET_GROUP only a hit for demuxer (mainly DVB) to allow not
95 * reading everything (you should not use this to call es_out_Control)
96 * if you don't know what to do with it, just IGNORE it, it is safe(r)
97 * -1 means all group, 0 default group (first es added) */
98 DEMUX_SET_GROUP, /* arg1= int can fail */
100 /* Ask the demux to demux until the given date at the next pf_demux call
101 * but not more (and not less, at the precision avaiable of course).
102 * XXX: not mandatory (except for subtitle demux) but I will help a lot
105 DEMUX_SET_NEXT_DEMUX_TIME, /* arg1= int64_t * can fail */
106 /* FPS for correct subtitles handling */
107 DEMUX_GET_FPS, /* arg1= float * res=can fail */
109 DEMUX_GET_META, /* arg1= vlc_meta_t ** res=can fail */
112 /* II. Specific access_demux queries */
113 DEMUX_CAN_PAUSE, /* arg1= vlc_bool_t* cannot fail */
114 DEMUX_CAN_CONTROL_PACE, /* arg1= vlc_bool_t* cannot fail */
115 DEMUX_GET_PTS_DELAY, /* arg1= int64_t* cannot fail */
116 DEMUX_SET_PAUSE_STATE, /* arg1= vlc_bool_t can fail */
117 DEMUX_GET_ATTACHMENTS /* arg1= int, arg2= attachment_t*** can fail */
120 VLC_EXPORT( int, demux2_vaControlHelper, ( stream_t *, int64_t i_start, int64_t i_end, int i_bitrate, int i_align, int i_query, va_list args ) );
122 /*************************************************************************
123 * Miscellaneous helpers for demuxers
124 *************************************************************************/
126 static inline vlc_bool_t isExtension( demux_t *p_demux, const char *psz_requested )
128 const char *psz_ext = strrchr ( p_demux->psz_path, '.' );
129 if( !psz_ext || strcmp( psz_ext, psz_requested ) )
134 static inline vlc_bool_t isDemux( demux_t *p_demux, const char *psz_requested )
136 if( !p_demux->psz_demux || strcmp( p_demux->psz_demux, psz_requested ) )
141 #define STANDARD_DEMUX_INIT \
142 p_demux->pf_control = Control; \
143 p_demux->pf_demux = Demux; \
144 MALLOC_ERR( p_demux->p_sys, demux_sys_t ); \
145 memset( p_demux->p_sys, 0, sizeof( demux_sys_t ) );
147 #define STANDARD_DEMUX_INIT_MSG( msg ) \
148 p_demux->pf_control = Control; \
149 p_demux->pf_demux = Demux; \
150 MALLOC_ERR( p_demux->p_sys, demux_sys_t ); \
151 memset( p_demux->p_sys, 0, sizeof( demux_sys_t ) ); \
152 msg_Dbg( p_demux, msg ); \
154 #define DEMUX_BY_EXTENSION( ext ) \
155 demux_t *p_demux = (demux_t *)p_this; \
156 if( !isExtension( p_demux, ext ) ) \
157 return VLC_EGENERIC; \
160 #define DEMUX_BY_EXTENSION_MSG( ext, msg ) \
161 demux_t *p_demux = (demux_t *)p_this; \
162 if( !isExtension( p_demux, ext ) ) \
163 return VLC_EGENERIC; \
164 STANDARD_DEMUX_INIT_MSG( msg );
166 #define DEMUX_BY_EXTENSION_OR_FORCED( ext, module ) \
167 demux_t *p_demux = (demux_t *)p_this; \
168 if( !isExtension( p_demux, ext ) && !isDemux( p_demux, module ) ) \
169 return VLC_EGENERIC; \
172 #define DEMUX_BY_EXTENSION_OR_FORCED_MSG( ext, module, msg ) \
173 demux_t *p_demux = (demux_t *)p_this; \
174 if( !isExtension( p_demux, ext ) && !isDemux( p_demux, module ) ) \
175 return VLC_EGENERIC; \
176 STANDARD_DEMUX_INIT_MSG( msg );
178 #define CHECK_PEEK( zepeek, size ) \
179 if( stream_Peek( p_demux->s , &zepeek, size ) < size ){ \
180 msg_Dbg( p_demux, "not enough data" ); return VLC_EGENERIC; }
182 #define CHECK_PEEK_GOTO( zepeek, size ) \
183 if( stream_Peek( p_demux->s , &zepeek, size ) < size ) { \
184 msg_Dbg( p_demux, "not enough data" ); goto error; }
186 #define CHECK_DISCARD_PEEK( size ) { uint8_t *p_peek; \
187 if( stream_Peek( p_demux->s , &p_peek, size ) < size ) return VLC_EGENERIC;}
189 #define POKE( peek, stuff, size ) (strncasecmp( (char *)peek, stuff, size )==0)
191 #define COMMON_INIT_PACKETIZER( location ) \
192 location = vlc_object_create( p_demux, VLC_OBJECT_PACKETIZER ); \
193 location->pf_decode_audio = 0; \
194 location->pf_decode_video = 0; \
195 location->pf_decode_sub = 0; \
196 location->pf_packetize = 0; \
198 #define INIT_APACKETIZER( location, a,b,c,d ) \
199 COMMON_INIT_PACKETIZER(location ); \
200 es_format_Init( &location->fmt_in, AUDIO_ES, \
201 VLC_FOURCC( a, b, c, d ) );
203 #define INIT_VPACKETIZER( location, a,b,c,d ) \
204 COMMON_INIT_PACKETIZER(location ); \
205 es_format_Init( &location->fmt_in, VIDEO_ES, \
206 VLC_FOURCC( a, b, c, d ) );
208 /* BEWARE ! This can lead to memory leaks ! */
209 #define LOAD_PACKETIZER_OR_FAIL( location, msg ) \
210 location->p_module = \
211 module_Need( location, "packetizer", NULL, 0 ); \
212 if( location->p_module == NULL ) \
214 vlc_object_destroy( location ); \
215 msg_Err( p_demux, "cannot find packetizer for " # msg ); \
217 return VLC_EGENERIC; \
220 #define DESTROY_PACKETIZER( location ) \
221 if( location->p_module ) module_Unneed( location, location->p_module ); \
222 vlc_object_destroy( location );