Added es_out_ControlGetPcrSystem helper.
[vlc.git] / include / vlc_es_out.h
1 /*****************************************************************************
2  * vlc_es_out.h: es_out (demuxer output) descriptor, queries and methods
3  *****************************************************************************
4  * Copyright (C) 1999-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 #ifndef VLC_ES_OUT_H
25 #define VLC_ES_OUT_H 1
26
27 /**
28  * \file
29  * This file defines functions and structures for handling es_out in stream output
30  */
31
32 /**
33  * \defgroup es out Es Out
34  * @{
35  */
36
37 enum es_out_query_e
38 {
39     /* set ES selected for the es category (audio/video/spu) */
40     ES_OUT_SET_ES,      /* arg1= es_out_id_t*                   */
41     ES_OUT_RESTART_ES,  /* arg1= es_out_id_t*                   */
42
43     /* set 'default' tag on ES (copied across from container) */
44     ES_OUT_SET_ES_DEFAULT, /* arg1= es_out_id_t*                */
45
46     /* force selection/unselection of the ES (bypass current mode) */
47     ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=bool   */
48     ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=bool*  */
49
50     /* */
51     ES_OUT_SET_GROUP,   /* arg1= int                            */
52
53     /* PCR handling, DTS/PTS will be automatically computed using thoses PCR
54      * XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait
55      * to slow down the demuxer so that it reads at the right speed.
56      * XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send
57      * as you would normally do.
58      */
59     ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
60     ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
61     ES_OUT_RESET_PCR,           /* no arg */
62
63     /* Try not to use this one as it is a bit hacky */
64     ES_OUT_SET_ES_FMT,         /* arg1= es_out_id_t* arg2=es_format_t* */
65
66     /* Allow preroll of data (data with dts/pts < i_pts for all ES will be decoded but not displayed */
67     ES_OUT_SET_NEXT_DISPLAY_TIME,       /* arg1=int64_t i_pts(microsecond) */
68     /* Set meta data for group (dynamic) (The vlc_meta_t is not modified nor released) */
69     ES_OUT_SET_GROUP_META,  /* arg1=int i_group arg2=const vlc_meta_t */
70     /* Set epg for group (dynamic) (The vlc_epg_t is not modified nor released) */
71     ES_OUT_SET_GROUP_EPG,   /* arg1=int i_group arg2=const vlc_epg_t */
72     /* */
73     ES_OUT_DEL_GROUP,       /* arg1=int i_group */
74
75     /* Set scrambled state for one es */
76     ES_OUT_SET_ES_SCRAMBLED_STATE,  /* arg1=int i_group arg2=es_out_id_t* */
77
78     /* Stop any buffering being done, and ask if es_out has no more data to
79      * play.
80      * It will not block and so MUST be used carrefully. The only good reason
81      * is for interactive playback (like for DVD menu).
82      * XXX You SHALL call ES_OUT_RESET_PCR before any other es_out_Control/Send calls. */
83     ES_OUT_GET_EMPTY,       /* arg1=bool*   res=cannot fail */
84
85     /* Set global meta data (The vlc_meta_t is not modified nor released) */
86     ES_OUT_SET_META, /* arg1=const vlc_meta_t * */
87
88     /* PCR system clock manipulation for external clock synchronization */
89     ES_OUT_GET_PCR_SYSTEM, /* arg1=mtime_t * res=can fail */
90
91     /* First value usable for private control */
92     ES_OUT_PRIVATE_START = 0x10000,
93 };
94
95 struct es_out_t
96 {
97     es_out_id_t *(*pf_add)    ( es_out_t *, const es_format_t * );
98     int          (*pf_send)   ( es_out_t *, es_out_id_t *, block_t * );
99     void         (*pf_del)    ( es_out_t *, es_out_id_t * );
100     int          (*pf_control)( es_out_t *, int i_query, va_list );
101     void         (*pf_destroy)( es_out_t * );
102
103     bool         b_sout;
104
105     es_out_sys_t    *p_sys;
106 };
107
108 LIBVLC_USED
109 static inline es_out_id_t * es_out_Add( es_out_t *out, const es_format_t *fmt )
110 {
111     return out->pf_add( out, fmt );
112 }
113
114 static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
115 {
116     out->pf_del( out, id );
117 }
118
119 static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
120                                block_t *p_block )
121 {
122     return out->pf_send( out, id, p_block );
123 }
124
125 static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
126 {
127     return out->pf_control( out, i_query, args );
128 }
129
130 static inline int es_out_Control( es_out_t *out, int i_query, ... )
131 {
132     va_list args;
133     int     i_result;
134
135     va_start( args, i_query );
136     i_result = es_out_vaControl( out, i_query, args );
137     va_end( args );
138     return i_result;
139 }
140
141 static inline void es_out_Delete( es_out_t *p_out )
142 {
143     p_out->pf_destroy( p_out );
144 }
145
146 static inline int es_out_ControlSetMeta( es_out_t *out, const vlc_meta_t *p_meta )
147 {
148     return es_out_Control( out, ES_OUT_SET_META, p_meta );
149 }
150
151 static inline int es_out_ControlGetPcrSystem( es_out_t *out, mtime_t *pi_system )
152 {
153     return es_out_Control( out, ES_OUT_GET_PCR_SYSTEM, pi_system );
154 }
155
156 /**
157  * @}
158  */
159
160 #endif