ffmpeg: ask a packetizer for audio too (needed since ffmpeg r6098,
[vlc.git] / include / vlc_demux.h
1 /*****************************************************************************
2  * vlc_demux.h: Demuxer descriptor, queries and methods
3  *****************************************************************************
4  * Copyright (C) 1999-2005 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( __LIBVLC__ )
25   #error You are not libvlc or one of its plugins. You cannot include this file
26 #endif
27
28 #ifndef _VLC_DEMUX_H
29 #define _VLC_DEMUX_H 1
30
31 #include <vlc_es.h>
32 #include <vlc_stream.h>
33 #include <vlc_es_out.h>
34
35 /**
36  * \defgroup demux Demux
37  * @{
38  */
39
40 struct demux_t
41 {
42     VLC_COMMON_MEMBERS
43
44     /* Module properties */
45     module_t    *p_module;
46
47     /* eg informative but needed (we can have access+demux) */
48     char        *psz_access;
49     char        *psz_demux;
50     char        *psz_path;
51
52     /* input stream */
53     stream_t    *s;     /* NULL in case of a access+demux in one */
54
55     /* es output */
56     es_out_t    *out;   /* our p_es_out */
57
58     /* set by demuxer */
59     int (*pf_demux)  ( demux_t * );   /* demux one frame only */
60     int (*pf_control)( demux_t *, int i_query, va_list args);
61
62     /* Demux has to maintain them uptodate
63      * when it is responsible of seekpoint/title */
64     struct
65     {
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 */
71     } info;
72     demux_sys_t *p_sys;
73 };
74
75 enum demux_query_e
76 {
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    */
81
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    */
86
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 */
89
90     /* TITLE/SEEKPOINT, only when TITLE_INFO succeed */
91     DEMUX_SET_TITLE,            /* arg1= int            can fail */
92     DEMUX_SET_SEEKPOINT,        /* arg1= int            can fail */
93
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 */
99
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
103      * for multi-input
104      */
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    */
108     /* Meta data */
109     DEMUX_GET_META,             /* arg1= vlc_meta_t **  res=can fail    */
110
111
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 };
118
119 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 ) );
120
121 /*************************************************************************
122  * Miscellaneous helpers for demuxers
123  *************************************************************************/
124
125 static inline vlc_bool_t isExtension( demux_t *p_demux, const char *psz_requested )
126 {
127     const char *psz_ext = strrchr ( p_demux->psz_path, '.' );
128     if( !psz_ext || strcmp( psz_ext, psz_requested ) )
129         return VLC_FALSE;
130     return VLC_TRUE;
131 }
132
133 static inline vlc_bool_t isDemux( demux_t *p_demux, const char *psz_requested )
134 {
135    if( !p_demux->psz_demux || strcmp( p_demux->psz_demux, psz_requested ) )
136         return VLC_FALSE;
137     return VLC_TRUE;
138 }
139
140 #define STANDARD_DEMUX_INIT \
141     p_demux->pf_control = Control; \
142     p_demux->pf_demux = Demux; \
143     MALLOC_ERR( p_demux->p_sys, demux_sys_t ); \
144     memset( p_demux->p_sys, 0, sizeof( demux_sys_t ) );
145
146 #define STANDARD_DEMUX_INIT_MSG( msg ) \
147     p_demux->pf_control = Control; \
148     p_demux->pf_demux = Demux; \
149     MALLOC_ERR( p_demux->p_sys, demux_sys_t ); \
150     memset( p_demux->p_sys, 0, sizeof( demux_sys_t ) ); \
151     msg_Dbg( p_demux, msg ); \
152
153 #define DEMUX_BY_EXTENSION( ext ) \
154     demux_t *p_demux = (demux_t *)p_this; \
155     if( !isExtension( p_demux, ext ) ) \
156         return VLC_EGENERIC; \
157     STANDARD_DEMUX_INIT;
158
159 #define DEMUX_BY_EXTENSION_MSG( ext, msg ) \
160     demux_t *p_demux = (demux_t *)p_this; \
161     if( !isExtension( p_demux, ext ) ) \
162         return VLC_EGENERIC; \
163     STANDARD_DEMUX_INIT_MSG( msg );
164
165 #define DEMUX_BY_EXTENSION_OR_FORCED( ext, module ) \
166     demux_t *p_demux = (demux_t *)p_this; \
167     if( !isExtension( p_demux, ext ) && !isDemux( p_demux, module ) ) \
168         return VLC_EGENERIC; \
169     STANDARD_DEMUX_INIT;
170
171 #define DEMUX_BY_EXTENSION_OR_FORCED_MSG( ext, module, msg ) \
172     demux_t *p_demux = (demux_t *)p_this; \
173     if( !isExtension( p_demux, ext ) && !isDemux( p_demux, module ) ) \
174         return VLC_EGENERIC; \
175     STANDARD_DEMUX_INIT_MSG( msg );
176
177 #define CHECK_PEEK( zepeek, size ) \
178     if( stream_Peek( p_demux->s , &zepeek, size ) < size ){ \
179         msg_Dbg( p_demux, "not enough data" ); return VLC_EGENERIC; }
180
181 #define CHECK_PEEK_GOTO( zepeek, size ) \
182     if( stream_Peek( p_demux->s , &zepeek, size ) < size ) { \
183         msg_Dbg( p_demux, "not enough data" ); goto error; }
184
185 #define CHECK_DISCARD_PEEK( size ) { uint8_t *p_peek; \
186     if( stream_Peek( p_demux->s , &p_peek, size ) < size ) return VLC_EGENERIC;}
187
188 #define POKE( peek, stuff, size ) (strncasecmp( (char *)peek, stuff, size )==0)
189
190 #define COMMON_INIT_PACKETIZER( location ) \
191     location = vlc_object_create( p_demux, VLC_OBJECT_PACKETIZER ); \
192     location->pf_decode_audio = 0; \
193     location->pf_decode_video = 0; \
194     location->pf_decode_sub = 0; \
195     location->pf_packetize = 0; \
196
197 #define INIT_APACKETIZER( location, a,b,c,d ) \
198     COMMON_INIT_PACKETIZER(location ); \
199     es_format_Init( &location->fmt_in, AUDIO_ES, \
200                     VLC_FOURCC( a, b, c, d ) );
201
202 #define INIT_VPACKETIZER( location, a,b,c,d ) \
203     COMMON_INIT_PACKETIZER(location ); \
204     es_format_Init( &location->fmt_in, VIDEO_ES, \
205                     VLC_FOURCC( a, b, c, d ) );
206
207 /* BEWARE ! This can lead to memory leaks ! */
208 #define LOAD_PACKETIZER_OR_FAIL( location, msg ) \
209     location->p_module = \
210         module_Need( location, "packetizer", NULL, 0 ); \
211     if( location->p_module == NULL ) \
212     { \
213         vlc_object_destroy( location ); \
214         msg_Err( p_demux, "cannot find packetizer for " # msg ); \
215         free( p_sys ); \
216         return VLC_EGENERIC; \
217     }
218
219 #define DESTROY_PACKETIZER( location ) \
220     if( location->p_module ) module_Unneed( location, location->p_module ); \
221     vlc_object_destroy( location );
222
223 /**
224  * @}
225  */
226
227 #endif