X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_es_out.h;h=57fc5c003ad3d319f75c6dcbae650c1f45e50d28;hb=c60652e38ac6afd74bd8225e9dae5406f13aaa4f;hp=5af2b77fc8bf6ad4957f30ae08fe8379059e73b9;hpb=70ee5fbf988a94c0c2e394f3346a3dc6eeb18d72;p=vlc diff --git a/include/vlc_es_out.h b/include/vlc_es_out.h index 5af2b77fc8..57fc5c003a 100644 --- a/include/vlc_es_out.h +++ b/include/vlc_es_out.h @@ -1,7 +1,7 @@ /***************************************************************************** - * vlc_es_out.h + * vlc_es_out.h: es_out (demuxer output) descriptor, queries and methods ***************************************************************************** - * Copyright (C) 1999-2004 VideoLAN + * Copyright (C) 1999-2004 the VideoLAN team * $Id$ * * Authors: Laurent Aimar @@ -18,86 +18,103 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#ifndef _VLC_ES_OUT_H -#define _VLC_ES_OUT_H 1 +#ifndef VLC_ES_OUT_H +#define VLC_ES_OUT_H 1 + +/** + * \file + * This file defines functions and structures for handling es_out in stream output + */ /** * \defgroup es out Es Out * @{ */ -enum es_out_mode_e -{ - ES_OUT_MODE_NONE, /* don't select anything */ - ES_OUT_MODE_ALL, /* eg for stream output */ - ES_OUT_MODE_AUTO, /* best audio/video or for input follow audio-track, sub-track */ - ES_OUT_MODE_PARTIAL /* select programs given after --programs */ -}; - enum es_out_query_e { - /* activate apply of mode */ - ES_OUT_SET_ACTIVE, /* arg1= vlc_bool_t */ - /* see if mode is currently aplied or not */ - ES_OUT_GET_ACTIVE, /* arg1= vlc_bool_t* */ - - /* set/get mode */ - ES_OUT_SET_MODE, /* arg1= int */ - ES_OUT_GET_MODE, /* arg2= int* */ - - /* set es selected for the es category(audio/video/spu) */ + /* set ES selected for the es category (audio/video/spu) */ ES_OUT_SET_ES, /* arg1= es_out_id_t* */ + ES_OUT_RESTART_ES, /* arg1= es_out_id_t* */ - /* force selection/unselection of the ES (bypass current mode)*/ - ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t */ - ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t* */ + /* set 'default' tag on ES (copied across from container) */ + ES_OUT_SET_ES_DEFAULT, /* arg1= es_out_id_t* */ + + /* force selection/unselection of the ES (bypass current mode) */ + ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=bool */ + ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=bool* */ /* */ ES_OUT_SET_GROUP, /* arg1= int */ - ES_OUT_GET_GROUP, /* arg1= int* */ - /* PCR handling, dts/pts will be automatically computed using thoses PCR - * XXX: SET_PCR(_GROUP) is in charge of the pace control. They will wait to slow - * down the demuxer to read at the right speed. - * XXX: if you want PREROLL just call RESET_PCR and ES_OUT_SET_NEXT_DISPLAY_TIME and send - * data to the decoder *without* calling SET_PCR until preroll is finished. + /* PCR handling, DTS/PTS will be automatically computed using thoses PCR + * XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait + * to slow down the demuxer so that it reads at the right speed. + * XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send + * as you would normally do. */ ES_OUT_SET_PCR, /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/ ES_OUT_SET_GROUP_PCR, /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/ ES_OUT_RESET_PCR, /* no arg */ - /* Timestamp handling, convert an input timestamp to a global clock one. - * (shouldn't have to be used by input plugins directly) */ - ES_OUT_GET_TS, /* arg1=int64_t i_ts(microsecond!) (using default group 0), arg2=int64_t* converted i_ts */ - /* Try not to use this one as it is a bit hacky */ - ES_OUT_SET_FMT, /* arg1= es_out_id_t* arg2=es_format_t* */ + ES_OUT_SET_ES_FMT, /* arg1= es_out_id_t* arg2=es_format_t* */ + + /* Allow preroll of data (data with dts/pts < i_pts for all ES will be decoded but not displayed */ + ES_OUT_SET_NEXT_DISPLAY_TIME, /* arg1=int64_t i_pts(microsecond) */ + /* Set meta data for group (dynamic) (The vlc_meta_t is not modified nor released) */ + ES_OUT_SET_GROUP_META, /* arg1=int i_group arg2=const vlc_meta_t */ + /* Set epg for group (dynamic) (The vlc_epg_t is not modified nor released) */ + ES_OUT_SET_GROUP_EPG, /* arg1=int i_group arg2=const vlc_epg_t */ + /* */ + ES_OUT_DEL_GROUP, /* arg1=int i_group */ + + /* Set scrambled state for one es */ + ES_OUT_SET_ES_SCRAMBLED_STATE, /* arg1=int i_group arg2=es_out_id_t* */ + + /* Stop any buffering being done, and ask if es_out has no more data to + * play. + * It will not block and so MUST be used carrefully. The only good reason + * is for interactive playback (like for DVD menu). + * XXX You SHALL call ES_OUT_RESET_PCR before any other es_out_Control/Send calls. */ + ES_OUT_GET_EMPTY, /* arg1=bool* res=cannot fail */ + + /* Set global meta data (The vlc_meta_t is not modified nor released) */ + ES_OUT_SET_META, /* arg1=const vlc_meta_t * */ + + /* PCR system clock manipulation for external clock synchronization */ + ES_OUT_GET_PCR_SYSTEM, /* arg1=mtime_t *, arg2=mtime_t * res=can fail */ + ES_OUT_MODIFY_PCR_SYSTEM, /* arg1=int is_absolute, arg2=mtime_t, res=can fail */ - /* Allow preroll of data (data with dts/pts < i_pts for one ES will be decoded but not displayed */ - ES_OUT_SET_NEXT_DISPLAY_TIME, /* arg1=es_out_id_t* arg2=int64_t i_pts(microsecond) */ + /* First value usable for private control */ + ES_OUT_PRIVATE_START = 0x10000, }; struct es_out_t { - es_out_id_t *(*pf_add) ( es_out_t *, es_format_t * ); + es_out_id_t *(*pf_add) ( es_out_t *, const es_format_t * ); int (*pf_send) ( es_out_t *, es_out_id_t *, block_t * ); void (*pf_del) ( es_out_t *, es_out_id_t * ); int (*pf_control)( es_out_t *, int i_query, va_list ); + void (*pf_destroy)( es_out_t * ); es_out_sys_t *p_sys; }; -static inline es_out_id_t * es_out_Add( es_out_t *out, es_format_t *fmt ) +LIBVLC_USED +static inline es_out_id_t * es_out_Add( es_out_t *out, const es_format_t *fmt ) { return out->pf_add( out, fmt ); } + static inline void es_out_Del( es_out_t *out, es_out_id_t *id ) { out->pf_del( out, id ); } + static inline int es_out_Send( es_out_t *out, es_out_id_t *id, block_t *p_block ) { @@ -108,6 +125,7 @@ static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args ) { return out->pf_control( out, i_query, args ); } + static inline int es_out_Control( es_out_t *out, int i_query, ... ) { va_list args; @@ -119,6 +137,25 @@ static inline int es_out_Control( es_out_t *out, int i_query, ... ) return i_result; } +static inline void es_out_Delete( es_out_t *p_out ) +{ + p_out->pf_destroy( p_out ); +} + +static inline int es_out_ControlSetMeta( es_out_t *out, const vlc_meta_t *p_meta ) +{ + return es_out_Control( out, ES_OUT_SET_META, p_meta ); +} + +static inline int es_out_ControlGetPcrSystem( es_out_t *out, mtime_t *pi_system, mtime_t *pi_delay ) +{ + return es_out_Control( out, ES_OUT_GET_PCR_SYSTEM, pi_system, pi_delay ); +} +static inline int es_out_ControlModifyPcrSystem( es_out_t *out, bool b_absolute, mtime_t i_system ) +{ + return es_out_Control( out, ES_OUT_MODIFY_PCR_SYSTEM, b_absolute, i_system ); +} + /** * @} */