1 /*****************************************************************************
2 * vlc_es_out.h: es_out (demuxer output) descriptor, queries and methods
3 *****************************************************************************
4 * Copyright (C) 1999-2004 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_ES_OUT_H 1
32 * \defgroup es out Es Out
38 ES_OUT_MODE_NONE
, /* don't select anything */
39 ES_OUT_MODE_ALL
, /* eg for stream output */
40 ES_OUT_MODE_AUTO
, /* best audio/video or for input follow audio-track, sub-track */
41 ES_OUT_MODE_PARTIAL
/* select programs given after --programs */
46 /* activate apply of mode */
47 ES_OUT_SET_ACTIVE
, /* arg1= vlc_bool_t */
48 /* see if mode is currently aplied or not */
49 ES_OUT_GET_ACTIVE
, /* arg1= vlc_bool_t* */
52 ES_OUT_SET_MODE
, /* arg1= int */
53 ES_OUT_GET_MODE
, /* arg2= int* */
55 /* set es selected for the es category(audio/video/spu) */
56 ES_OUT_SET_ES
, /* arg1= es_out_id_t* */
58 /* set 'default' tag on es (copied across from container) */
59 ES_OUT_SET_DEFAULT
, /* arg1= es_out_id_t* */
61 /* force selection/unselection of the ES (bypass current mode)*/
62 ES_OUT_SET_ES_STATE
,/* arg1= es_out_id_t* arg2=vlc_bool_t */
63 ES_OUT_GET_ES_STATE
,/* arg1= es_out_id_t* arg2=vlc_bool_t* */
66 ES_OUT_SET_GROUP
, /* arg1= int */
67 ES_OUT_GET_GROUP
, /* arg1= int* */
69 /* PCR handling, dts/pts will be automatically computed using thoses PCR
70 * XXX: SET_PCR(_GROUP) is in charge of the pace control. They will wait to slow
71 * down the demuxer to read at the right speed.
72 * XXX: if you want PREROLL just call RESET_PCR and ES_OUT_SET_NEXT_DISPLAY_TIME and send
73 * data to the decoder *without* calling SET_PCR until preroll is finished.
75 ES_OUT_SET_PCR
, /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
76 ES_OUT_SET_GROUP_PCR
, /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
77 ES_OUT_RESET_PCR
, /* no arg */
79 /* Timestamp handling, convert an input timestamp to a global clock one.
80 * (shouldn't have to be used by input plugins directly) */
81 ES_OUT_GET_TS
, /* arg1=int64_t i_ts(microsecond!) (using default group 0), arg2=int64_t* converted i_ts */
83 /* Try not to use this one as it is a bit hacky */
84 ES_OUT_SET_FMT
, /* arg1= es_out_id_t* arg2=es_format_t* */
86 /* Allow preroll of data (data with dts/pts < i_pts for one ES will be decoded but not displayed */
87 ES_OUT_SET_NEXT_DISPLAY_TIME
, /* arg1=es_out_id_t* arg2=int64_t i_pts(microsecond) */
88 /* Set meta data for group (dynamic) */
89 ES_OUT_SET_GROUP_META
, /* arg1=int i_group arg2=vlc_meta_t */
90 /* Set epg for group (dynamic) */
91 ES_OUT_SET_GROUP_EPG
, /* arg1=int i_group arg2=vlc_epg_t */
93 ES_OUT_DEL_GROUP
/* arg1=int i_group */
98 es_out_id_t
*(*pf_add
) ( es_out_t
*, es_format_t
* );
99 int (*pf_send
) ( es_out_t
*, es_out_id_t
*, block_t
* );
100 void (*pf_del
) ( es_out_t
*, es_out_id_t
* );
101 int (*pf_control
)( es_out_t
*, int i_query
, va_list );
107 static inline es_out_id_t
* es_out_Add( es_out_t
*out
, es_format_t
*fmt
)
109 return out
->pf_add( out
, fmt
);
111 static inline void es_out_Del( es_out_t
*out
, es_out_id_t
*id
)
113 out
->pf_del( out
, id
);
115 static inline int es_out_Send( es_out_t
*out
, es_out_id_t
*id
,
118 return out
->pf_send( out
, id
, p_block
);
121 static inline int es_out_vaControl( es_out_t
*out
, int i_query
, va_list args
)
123 return out
->pf_control( out
, i_query
, args
);
125 static inline int es_out_Control( es_out_t
*out
, int i_query
, ... )
130 va_start( args
, i_query
);
131 i_result
= es_out_vaControl( out
, i_query
, args
);