1 /*****************************************************************************
2 * vlc_es_out.h: es_out (demuxer output) descriptor, queries and methods
3 *****************************************************************************
4 * Copyright (C) 1999-2004 VLC authors and VideoLAN
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
25 #define VLC_ES_OUT_H 1
28 * \defgroup es_out ES output
30 * Elementary streams output
33 * Elementary streams output interface
38 /* set ES selected for the es category (audio/video/spu) */
39 ES_OUT_SET_ES
, /* arg1= es_out_id_t* */
40 ES_OUT_RESTART_ES
, /* arg1= es_out_id_t* */
42 /* set 'default' tag on ES (copied across from container) */
43 ES_OUT_SET_ES_DEFAULT
, /* arg1= es_out_id_t* */
45 /* force selection/unselection of the ES (bypass current mode) */
46 ES_OUT_SET_ES_STATE
,/* arg1= es_out_id_t* arg2=bool */
47 ES_OUT_GET_ES_STATE
,/* arg1= es_out_id_t* arg2=bool* */
49 /* sets es selection policy when in auto mode */
50 ES_OUT_SET_ES_CAT_POLICY
, /* arg1=es_format_category_e arg2=es_out_policy_e */
53 ES_OUT_SET_GROUP
, /* arg1= int */
55 /* PCR handling, DTS/PTS will be automatically computed using thoses PCR
56 * XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait
57 * to slow down the demuxer so that it reads at the right speed.
58 * XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send
59 * as you would normally do.
61 ES_OUT_SET_PCR
, /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
62 ES_OUT_SET_GROUP_PCR
, /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
63 ES_OUT_RESET_PCR
, /* no arg */
65 /* Try not to use this one as it is a bit hacky */
66 ES_OUT_SET_ES_FMT
, /* arg1= es_out_id_t* arg2=es_format_t* */
68 /* Allow preroll of data (data with dts/pts < i_pts for all ES will be decoded but not displayed */
69 ES_OUT_SET_NEXT_DISPLAY_TIME
, /* arg1=int64_t i_pts(microsecond) */
70 /* Set meta data for group (dynamic) (The vlc_meta_t is not modified nor released) */
71 ES_OUT_SET_GROUP_META
, /* arg1=int i_group arg2=const vlc_meta_t */
72 /* Set epg for group (dynamic) (The vlc_epg_t is not modified nor released) */
73 ES_OUT_SET_GROUP_EPG
, /* arg1=int i_group arg2=const vlc_epg_t */
75 ES_OUT_DEL_GROUP
, /* arg1=int i_group */
77 /* Set scrambled state for one es */
78 ES_OUT_SET_ES_SCRAMBLED_STATE
, /* arg1=int i_group arg2=es_out_id_t* */
80 /* Stop any buffering being done, and ask if es_out has no more data to
82 * It will not block and so MUST be used carrefully. The only good reason
83 * is for interactive playback (like for DVD menu).
84 * XXX You SHALL call ES_OUT_RESET_PCR before any other es_out_Control/Send calls. */
85 ES_OUT_GET_EMPTY
, /* arg1=bool* res=cannot fail */
87 /* Set global meta data (The vlc_meta_t is not modified nor released) */
88 ES_OUT_SET_META
, /* arg1=const vlc_meta_t * */
90 /* PCR system clock manipulation for external clock synchronization */
91 ES_OUT_GET_PCR_SYSTEM
, /* arg1=mtime_t *, arg2=mtime_t * res=can fail */
92 ES_OUT_MODIFY_PCR_SYSTEM
, /* arg1=int is_absolute, arg2=mtime_t, res=can fail */
94 /* First value usable for private control */
95 ES_OUT_PRIVATE_START
= 0x10000,
100 ES_OUT_ES_POLICY_EXCLUSIVE
= 0,/* Enforces single ES selection only */
101 ES_OUT_ES_POLICY_SIMULTANEOUS
, /* Allows multiple ES per cat */
106 es_out_id_t
*(*pf_add
) ( es_out_t
*, const es_format_t
* );
107 int (*pf_send
) ( es_out_t
*, es_out_id_t
*, block_t
* );
108 void (*pf_del
) ( es_out_t
*, es_out_id_t
* );
109 int (*pf_control
)( es_out_t
*, int i_query
, va_list );
110 void (*pf_destroy
)( es_out_t
* );
116 static inline es_out_id_t
* es_out_Add( es_out_t
*out
, const es_format_t
*fmt
)
118 return out
->pf_add( out
, fmt
);
121 static inline void es_out_Del( es_out_t
*out
, es_out_id_t
*id
)
123 out
->pf_del( out
, id
);
126 static inline int es_out_Send( es_out_t
*out
, es_out_id_t
*id
,
129 return out
->pf_send( out
, id
, p_block
);
132 static inline int es_out_vaControl( es_out_t
*out
, int i_query
, va_list args
)
134 return out
->pf_control( out
, i_query
, args
);
137 static inline int es_out_Control( es_out_t
*out
, int i_query
, ... )
142 va_start( args
, i_query
);
143 i_result
= es_out_vaControl( out
, i_query
, args
);
148 static inline void es_out_Delete( es_out_t
*p_out
)
150 p_out
->pf_destroy( p_out
);
153 static inline int es_out_ControlSetMeta( es_out_t
*out
, const vlc_meta_t
*p_meta
)
155 return es_out_Control( out
, ES_OUT_SET_META
, p_meta
);
158 static inline int es_out_ControlGetPcrSystem( es_out_t
*out
, mtime_t
*pi_system
, mtime_t
*pi_delay
)
160 return es_out_Control( out
, ES_OUT_GET_PCR_SYSTEM
, pi_system
, pi_delay
);
162 static inline int es_out_ControlModifyPcrSystem( es_out_t
*out
, bool b_absolute
, mtime_t i_system
)
164 return es_out_Control( out
, ES_OUT_MODIFY_PCR_SYSTEM
, b_absolute
, i_system
);