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 or change the selected ES in its category (audio/video/spu) */
39 ES_OUT_SET_ES
, /* arg1= es_out_id_t* */
40 ES_OUT_UNSET_ES
, /* arg1= es_out_id_t* res=can fail */
41 ES_OUT_RESTART_ES
, /* arg1= es_out_id_t* */
43 /* set 'default' tag on ES (copied across from container) */
44 ES_OUT_SET_ES_DEFAULT
, /* arg1= es_out_id_t* */
46 /* force (un)selection of the ES (bypass current mode)
47 XXX: this will not change the state of any other ES ! (see SET_ES) */
48 ES_OUT_SET_ES_STATE
,/* arg1= es_out_id_t* arg2=bool */
49 ES_OUT_GET_ES_STATE
,/* arg1= es_out_id_t* arg2=bool* */
51 /* sets es selection policy when in auto mode */
52 ES_OUT_SET_ES_CAT_POLICY
, /* arg1=es_format_category_e arg2=es_out_policy_e */
55 ES_OUT_SET_GROUP
, /* arg1= int */
57 /* PCR handling, DTS/PTS will be automatically computed using thoses PCR
58 * XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait
59 * to slow down the demuxer so that it reads at the right speed.
60 * XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send
61 * as you would normally do.
63 ES_OUT_SET_PCR
, /* arg1=vlc_tick_t i_pcr(microsecond!) (using default group 0)*/
64 ES_OUT_SET_GROUP_PCR
, /* arg1= int i_group, arg2=vlc_tick_t i_pcr(microsecond!)*/
65 ES_OUT_RESET_PCR
, /* no arg */
67 /* This will update the fmt, drain and restart the decoder (if any).
68 * The new fmt must have the same i_cat and i_id. */
69 ES_OUT_SET_ES_FMT
, /* arg1= es_out_id_t* arg2=es_format_t* res=can fail */
71 /* Allow preroll of data (data with dts/pts < i_pts for all ES will be decoded but not displayed */
72 ES_OUT_SET_NEXT_DISPLAY_TIME
, /* arg1=int64_t i_pts(microsecond) */
73 /* Set meta data for group (dynamic) (The vlc_meta_t is not modified nor released) */
74 ES_OUT_SET_GROUP_META
, /* arg1=int i_group arg2=const vlc_meta_t */
75 /* Set epg for group (dynamic) (The vlc_epg_t is not modified nor released) */
76 ES_OUT_SET_GROUP_EPG
, /* arg1=int i_group arg2=const vlc_epg_t * */
77 ES_OUT_SET_GROUP_EPG_EVENT
, /* arg1=int i_group arg2=const vlc_epg_event_t * */
78 ES_OUT_SET_EPG_TIME
, /* arg1=int int64_t */
81 ES_OUT_DEL_GROUP
, /* arg1=int i_group */
83 /* Set scrambled state for one es */
84 ES_OUT_SET_ES_SCRAMBLED_STATE
, /* arg1=int i_group arg2=es_out_id_t* */
86 /* Stop any buffering being done, and ask if es_out has no more data to
88 * It will not block and so MUST be used carrefully. The only good reason
89 * is for interactive playback (like for DVD menu).
90 * XXX You SHALL call ES_OUT_RESET_PCR before any other es_out_Control/Send calls. */
91 ES_OUT_GET_EMPTY
, /* arg1=bool* res=cannot fail */
93 /* Set global meta data (The vlc_meta_t is not modified nor released) */
94 ES_OUT_SET_META
, /* arg1=const vlc_meta_t * */
96 /* PCR system clock manipulation for external clock synchronization */
97 ES_OUT_GET_PCR_SYSTEM
, /* arg1=vlc_tick_t *, arg2=vlc_tick_t * res=can fail */
98 ES_OUT_MODIFY_PCR_SYSTEM
, /* arg1=int is_absolute, arg2=vlc_tick_t, res=can fail */
100 ES_OUT_POST_SUBNODE
, /* arg1=input_item_node_t *, res=can fail */
102 ES_OUT_VOUT_SET_MOUSE_EVENT
, /* arg1= es_out_id_t* (video es),
103 arg2=vlc_mouse_event, arg3=void *(user_data),
106 ES_OUT_VOUT_ADD_OVERLAY
, /* arg1= es_out_id_t* (video es),
107 * arg2= subpicture_t *,
108 * arg3= int * (channel id), res= can fail */
110 ES_OUT_VOUT_FLUSH_OVERLAY
, /* arg1= es_out_id_t* (video es),
111 * arg2= int (channel id), res= can fail */
113 ES_OUT_SPU_SET_HIGHLIGHT
, /* arg1= es_out_id_t* (spu es),
114 arg2= const vlc_spu_highlight_t *, res=can fail */
116 /* First value usable for private control */
117 ES_OUT_PRIVATE_START
= 0x10000,
122 ES_OUT_ES_POLICY_EXCLUSIVE
= 0,/* Enforces single ES selection only */
123 ES_OUT_ES_POLICY_SIMULTANEOUS
, /* Allows multiple ES per cat */
126 struct es_out_callbacks
128 es_out_id_t
*(*add
)(es_out_t
*, const es_format_t
*);
129 int (*send
)(es_out_t
*, es_out_id_t
*, block_t
*);
130 void (*del
)(es_out_t
*, es_out_id_t
*);
131 int (*control
)(es_out_t
*, int query
, va_list);
132 void (*destroy
)(es_out_t
*);
137 const struct es_out_callbacks
*cbs
;
141 static inline es_out_id_t
* es_out_Add( es_out_t
*out
, const es_format_t
*fmt
)
143 return out
->cbs
->add( out
, fmt
);
146 static inline void es_out_Del( es_out_t
*out
, es_out_id_t
*id
)
148 out
->cbs
->del( out
, id
);
151 static inline int es_out_Send( es_out_t
*out
, es_out_id_t
*id
,
154 return out
->cbs
->send( out
, id
, p_block
);
157 static inline int es_out_vaControl( es_out_t
*out
, int i_query
, va_list args
)
159 return out
->cbs
->control( out
, i_query
, args
);
162 static inline int es_out_Control( es_out_t
*out
, int i_query
, ... )
167 va_start( args
, i_query
);
168 i_result
= es_out_vaControl( out
, i_query
, args
);
173 static inline void es_out_Delete( es_out_t
*p_out
)
175 p_out
->cbs
->destroy( p_out
);
178 static inline int es_out_SetPCR( es_out_t
*out
, vlc_tick_t pcr
)
180 return es_out_Control( out
, ES_OUT_SET_PCR
, pcr
);
183 static inline int es_out_ControlSetMeta( es_out_t
*out
, const vlc_meta_t
*p_meta
)
185 return es_out_Control( out
, ES_OUT_SET_META
, p_meta
);
188 static inline int es_out_ControlGetPcrSystem( es_out_t
*out
, vlc_tick_t
*pi_system
, vlc_tick_t
*pi_delay
)
190 return es_out_Control( out
, ES_OUT_GET_PCR_SYSTEM
, pi_system
, pi_delay
);
192 static inline int es_out_ControlModifyPcrSystem( es_out_t
*out
, bool b_absolute
, vlc_tick_t i_system
)
194 return es_out_Control( out
, ES_OUT_MODIFY_PCR_SYSTEM
, b_absolute
, i_system
);