* block: added
[vlc.git] / include / vlc_es_out.h
1 /*****************************************************************************
2  * vlc_es_out.h
3  *****************************************************************************
4  * Copyright (C) 1999-2004 VideoLAN
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 #ifndef _VLC_ES_OUT_H
25 #define _VLC_ES_OUT_H 1
26
27 /**
28  * \defgroup es out Es Out
29  * @{
30  */
31
32 enum es_out_mode_e
33 {
34     ES_OUT_MODE_NONE,   /* don't select anything */
35     ES_OUT_MODE_ALL,    /* eg for stream output */
36     ES_OUT_MODE_AUTO,   /* best audio/video or for input follow audio-track, sub-track */
37     ES_OUT_MODE_PARTIAL /* select programs given after --programs */
38 };
39
40 enum es_out_query_e
41 {
42     /* activate apply of mode */
43     ES_OUT_SET_ACTIVE,  /* arg1= vlc_bool_t                     */
44     /* see if mode is currently aplied or not */
45     ES_OUT_GET_ACTIVE,  /* arg1= vlc_bool_t*                    */
46
47     /* set/get mode */
48     ES_OUT_SET_MODE,    /* arg1= int                            */
49     ES_OUT_GET_MODE,    /* arg2= int*                           */
50
51     /* set es selected for the es category(audio/video/spu) */
52     ES_OUT_SET_ES,      /* arg1= es_out_id_t*                   */
53
54     /* force selection/unselection of the ES (bypass current mode)*/
55     ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t   */
56     ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t*  */
57
58     /* */
59     ES_OUT_SET_GROUP,   /* arg1= int                            */
60     ES_OUT_GET_GROUP,   /* arg1= int*                           */
61
62     /* PCR handling, dts/pts will be automatically computed using thoses PCR
63      * XXX: SET_PCR(_GROUP) is in charge of the pace control. They will wait to slow
64      * down the demuxer to read at the right speed.
65      * XXX: if you want PREROLL just call RESET_PCR and ES_OUT_SET_NEXT_DISPLAY_TIME and send
66      * data to the decoder *without* calling SET_PCR until preroll is finished.
67      */
68     ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
69     ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
70     ES_OUT_RESET_PCR,           /* no arg */
71
72     /* Timestamp handling, convert an input timestamp to a global clock one.
73      * (shouldn't have to be used by input plugins directly) */
74     ES_OUT_GET_TS,             /* arg1=int64_t i_ts(microsecond!) (using default group 0), arg2=int64_t* converted i_ts */
75
76     /* Try not to use this one as it is a bit hacky */
77     ES_OUT_SET_FMT,     /* arg1= es_out_id_t* arg2=es_format_t* */
78
79     /* Allow preroll of data (data with dts/pts < i_pts for one ES will be decoded but not displayed */
80     ES_OUT_SET_NEXT_DISPLAY_TIME,   /* arg1=es_out_id_t* arg2=int64_t i_pts(microsecond) */
81 };
82
83 struct es_out_t
84 {
85     es_out_id_t *(*pf_add)    ( es_out_t *, es_format_t * );
86     int          (*pf_send)   ( es_out_t *, es_out_id_t *, block_t * );
87     void         (*pf_del)    ( es_out_t *, es_out_id_t * );
88     int          (*pf_control)( es_out_t *, int i_query, va_list );
89
90     es_out_sys_t    *p_sys;
91 };
92
93 static inline es_out_id_t * es_out_Add( es_out_t *out, es_format_t *fmt )
94 {
95     return out->pf_add( out, fmt );
96 }
97 static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
98 {
99     out->pf_del( out, id );
100 }
101 static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
102                                block_t *p_block )
103 {
104     return out->pf_send( out, id, p_block );
105 }
106
107 static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
108 {
109     return out->pf_control( out, i_query, args );
110 }
111 static inline int es_out_Control( es_out_t *out, int i_query, ... )
112 {
113     va_list args;
114     int     i_result;
115
116     va_start( args, i_query );
117     i_result = es_out_vaControl( out, i_query, args );
118     va_end( args );
119     return i_result;
120 }
121
122 /**
123  * @}
124  */
125
126 #endif