1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 1999-2001 VideoLAN
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
31 ES_OUT_MODE_NONE, /* don't select anything */
32 ES_OUT_MODE_ALL, /* eg for stream output */
33 ES_OUT_MODE_AUTO /* best audio/video or for input follow audio-channel, spu-channel */
38 /* activate apply of mode */
39 ES_OUT_SET_ACTIVE, /* arg1= vlc_bool_t */
40 /* see if mode is currently aplied or not */
41 ES_OUT_GET_ACTIVE, /* arg1= vlc_bool_t* */
44 ES_OUT_SET_MODE, /* arg1= int */
45 ES_OUT_GET_MODE, /* arg2= int* */
47 /* set es selected for the es category(audio/video/spu) */
48 ES_OUT_SET_ES, /* arg1= es_out_id_t* */
50 /* force selection/unselection of the ES (bypass current mode)*/
51 ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t */
52 ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t* */
54 /* XXX XXX XXX Don't use them YET !!! */
55 ES_OUT_SET_PCR, /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
56 ES_OUT_SET_GROUP_PCR, /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
57 ES_OUT_RESET_PCR /* no arg */
62 es_out_id_t *(*pf_add) ( es_out_t *, es_format_t * );
63 int (*pf_send) ( es_out_t *, es_out_id_t *, block_t * );
64 void (*pf_del) ( es_out_t *, es_out_id_t * );
65 int (*pf_control)( es_out_t *, int i_query, va_list );
70 static inline es_out_id_t * es_out_Add( es_out_t *out, es_format_t *fmt )
72 return out->pf_add( out, fmt );
74 static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
76 out->pf_del( out, id );
78 static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
81 return out->pf_send( out, id, p_block );
84 static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
86 return out->pf_control( out, i_query, args );
88 static inline int es_out_Control( es_out_t *out, int i_query, ... )
93 va_start( args, i_query );
94 i_result = es_out_vaControl( out, i_query, args );
100 * \defgroup stream Stream
102 * This will allow you to easily handle read/seek in demuxer modules.
107 * Possible commands to send to stream_Control() and stream_vaControl()
112 STREAM_CAN_SEEK, /**< arg1= vlc_bool_t * res=cannot fail*/
113 STREAM_CAN_FASTSEEK, /**< arg1= vlc_bool_t * res=cannot fail*/
116 STREAM_SET_POSITION, /**< arg1= int64_t res=can fail */
117 STREAM_GET_POSITION, /**< arg1= int64_t * res=cannot fail*/
119 STREAM_GET_SIZE, /**< arg1= int64_t * res=cannot fail (0 if no sense)*/
121 STREAM_GET_MTU /**< arg1= int * res=cannot fail (0 if no sense)*/
125 * stream_t definition
131 block_t *(*pf_block) ( stream_t *, int i_size );
132 int (*pf_read) ( stream_t *, void *p_read, int i_read );
133 int (*pf_peek) ( stream_t *, uint8_t **pp_peek, int i_peek );
134 int (*pf_control)( stream_t *, int i_query, va_list );
140 * Try to read "i_read" bytes into a buffer pointed by "p_read". If
141 * "p_read" is NULL then data are skipped instead of read. The return
142 * value is the real numbers of bytes read/skip. If this value is less
143 * than i_read that means that it's the end of the stream.
145 static inline int stream_Read( stream_t *s, void *p_read, int i_read )
147 return s->pf_read( s, p_read, i_read );
151 * Store in pp_peek a pointer to the next "i_peek" bytes in the stream
152 * \return The real numbers of valid bytes, if it's less
153 * or equal to 0, *pp_peek is invalid.
154 * \note pp_peek is a pointer to internal buffer and it will be invalid as
155 * soons as other stream_* functions are called.
156 * \note Due to input limitation, it could be less than i_peek without meaning
157 * the end of the stream (but only when you have i_peek >=
158 * p_input->i_bufsize)
160 static inline int stream_Peek( stream_t *s, uint8_t **pp_peek, int i_peek )
162 return s->pf_peek( s, pp_peek, i_peek );
166 * Use to control the "stream_t *". Look at #stream_query_e for
167 * possible "i_query" value and format arguments. Return VLC_SUCCESS
168 * if ... succeed ;) and VLC_EGENERIC if failed or unimplemented
170 static inline int stream_vaControl( stream_t *s, int i_query, va_list args )
172 return s->pf_control( s, i_query, args );
174 static inline int stream_Control( stream_t *s, int i_query, ... )
179 va_start( args, i_query );
180 i_result = s->pf_control( s, i_query, args );
184 static inline int64_t stream_Tell( stream_t *s )
187 stream_Control( s, STREAM_GET_POSITION, &i_pos );
190 static inline int64_t stream_Size( stream_t *s )
193 stream_Control( s, STREAM_GET_SIZE, &i_pos );
196 static inline int stream_MTU( stream_t *s )
199 stream_Control( s, STREAM_GET_MTU, &i_mtu );
202 static inline int stream_Seek( stream_t *s, int64_t i_pos )
204 return stream_Control( s, STREAM_SET_POSITION, i_pos );
208 * Read "i_size" bytes and store them in a block_t. If less than "i_size"
209 * bytes are available then return what is left and if nothing is availble,
212 static inline block_t *stream_Block( stream_t *s, int i_size )
214 if( i_size <= 0 ) return NULL;
218 return s->pf_block( s, i_size );
222 /* emulate block read */
223 block_t *p_bk = block_New( s, i_size );
226 p_bk->i_buffer = stream_Read( s, p_bk->p_buffer, i_size );
227 if( p_bk->i_buffer > 0 )
232 if( p_bk ) block_Release( p_bk );
237 VLC_EXPORT( char *, stream_ReadLine, ( stream_t * ) );
244 * \defgroup demux Demux
252 /* Module properties */
255 /* eg informative but needed (we can have access+demux) */
261 stream_t *s; /* NULL in case of a access+demux in one */
264 es_out_t *out; /* ou p_es_out */
267 int (*pf_demux) ( demux_t * ); /* demux one frame only */
268 int (*pf_control)( demux_t *, int i_query, va_list args);
274 DEMUX_GET_POSITION, /* arg1= double * res= */
275 DEMUX_SET_POSITION, /* arg1= double res=can fail */
277 DEMUX_GET_TIME, /* arg1= int64_t * res= */
278 DEMUX_SET_TIME, /* arg1= int64_t res=can fail */
280 DEMUX_GET_LENGTH, /* arg1= int64_t * res=can fail */
282 DEMUX_GET_FPS, /* arg1= float * res=can fail */
283 DEMUX_GET_META /* arg1= vlc_meta_t ** res=can fail */
288 int64_t i_byte_offset;
289 int64_t i_time_offset;
293 static inline seekpoint_t *vlc_seekpoint_New( void )
295 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
296 point->i_byte_offset = point->i_time_offset;
297 point->psz_name = NULL;
301 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
304 if( point->psz_name ) free( point->psz_name );
308 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
310 seekpoint_t *point = vlc_seekpoint_New();
311 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
312 point->i_time_offset = src->i_time_offset;
313 point->i_byte_offset = src->i_byte_offset;
318 VLC_EXPORT( int, demux_vaControl, ( input_thread_t *, int i_query, va_list ) );
319 VLC_EXPORT( int, demux_Control, ( input_thread_t *, int i_query, ... ) );
321 VLC_EXPORT( int, demux_vaControlDefault, ( input_thread_t *, int i_query, va_list ) );
324 /* New demux arch: don't touch that */
325 /* stream_t *s could be null and then it mean a access+demux in one */
326 #define demux2_New( a, b, c, d ) __demux2_New(VLC_OBJECT(a), b, c, d)
327 VLC_EXPORT( demux_t *, __demux2_New, ( vlc_object_t *p_obj, char *psz_mrl, stream_t *s, es_out_t *out ) );
328 VLC_EXPORT( void, demux2_Delete, ( demux_t * ) );
329 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 ) );
331 static inline int demux2_Demux( demux_t *p_demux )
333 return p_demux->pf_demux( p_demux );
335 static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
337 return p_demux->pf_control( p_demux, i_query, args );
339 static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
344 va_start( args, i_query );
345 i_result = demux2_vaControl( p_demux, i_query, args );
351 VLC_EXPORT( char **, subtitles_Detect, ( input_thread_t *, char* path, char *fname ) );
359 * \defgroup input Input
364 INPUT_GET_POSITION, /* arg1= double * res= */
365 INPUT_SET_POSITION, /* arg1= double res=can fail */
367 INPUT_GET_TIME, /* arg1= int64_t * res= */
368 INPUT_SET_TIME, /* arg1= int64_t res=can fail */
370 INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
372 INPUT_GET_FPS, /* arg1= float * res=can fail */
373 INPUT_GET_META, /* arg1= vlc_meta_t ** res=can fail */
375 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
376 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
377 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
378 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
379 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
381 INPUT_GET_SUBDELAY, /* arg1 = int* res=can fail */
382 INPUT_SET_SUBDELAY, /* arg1 = int res=can fail */
387 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
388 VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) );