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 VLC authors and 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 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.
  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 Lesser General Public License for more details.
  18  *
  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  *****************************************************************************/
  23
  24 #ifndef VLC_ES_OUT_H
  25 #define VLC_ES_OUT_H 1
  26
  27 /**
  28  * \defgroup es_out ES output
  29  * \ingroup input
  30  * Elementary streams output
  31  * @{
  32  * \file
  33  * Elementary streams output interface
  34  */
  35
  36 enum es_out_query_e
  37 {
  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_RESTART_ES,  /* arg1= es_out_id_t*                   */
  41     ES_OUT_RESTART_ALL_ES, /* Deprecated, no effect */
  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 (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*  */
  50
  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 */
  53
  54     /* */
  55     ES_OUT_SET_GROUP,   /* arg1= int                            */
  56
  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.
  62      */
  63     ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
  64     ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
  65     ES_OUT_RESET_PCR,           /* no arg */
  66
  67     /* Try not to use this one as it is a bit hacky */
  68     ES_OUT_SET_ES_FMT,         /* arg1= es_out_id_t* arg2=es_format_t* */
  69
  70     /* Allow preroll of data (data with dts/pts < i_pts for all ES will be decoded but not displayed */
  71     ES_OUT_SET_NEXT_DISPLAY_TIME,       /* arg1=int64_t i_pts(microsecond) */
  72     /* Set meta data for group (dynamic) (The vlc_meta_t is not modified nor released) */
  73     ES_OUT_SET_GROUP_META,  /* arg1=int i_group arg2=const vlc_meta_t */
  74     /* Set epg for group (dynamic) (The vlc_epg_t is not modified nor released) */
  75     ES_OUT_SET_GROUP_EPG,       /* arg1=int i_group arg2=const vlc_epg_t * */
  76     ES_OUT_SET_GROUP_EPG_EVENT, /* arg1=int i_group arg2=const vlc_epg_event_t * */
  77     ES_OUT_SET_EPG_TIME,        /* arg1=int int64_t */
  78
  79     /* */
  80     ES_OUT_DEL_GROUP,       /* arg1=int i_group */
  81
  82     /* Set scrambled state for one es */
  83     ES_OUT_SET_ES_SCRAMBLED_STATE,  /* arg1=int i_group arg2=es_out_id_t* */
  84
  85     /* Stop any buffering being done, and ask if es_out has no more data to
  86      * play.
  87      * It will not block and so MUST be used carrefully. The only good reason
  88      * is for interactive playback (like for DVD menu).
  89      * XXX You SHALL call ES_OUT_RESET_PCR before any other es_out_Control/Send calls. */
  90     ES_OUT_GET_EMPTY,       /* arg1=bool*   res=cannot fail */
  91
  92     /* Set global meta data (The vlc_meta_t is not modified nor released) */
  93     ES_OUT_SET_META, /* arg1=const vlc_meta_t * */
  94
  95     /* PCR system clock manipulation for external clock synchronization */
  96     ES_OUT_GET_PCR_SYSTEM, /* arg1=mtime_t *, arg2=mtime_t * res=can fail */
  97     ES_OUT_MODIFY_PCR_SYSTEM, /* arg1=int is_absolute, arg2=mtime_t, res=can fail */
  98
  99     ES_OUT_POST_SUBNODE, /* arg1=input_item_node_t *, res=can fail */
 100
 101     /* First value usable for private control */
 102     ES_OUT_PRIVATE_START = 0x10000,
 103 };
 104
 105 enum es_out_policy_e
 106 {
 107     ES_OUT_ES_POLICY_EXCLUSIVE = 0,/* Enforces single ES selection only */
 108     ES_OUT_ES_POLICY_SIMULTANEOUS, /* Allows multiple ES per cat */
 109 };
 110
 111 struct es_out_t
 112 {
 113     es_out_id_t *(*pf_add)    ( es_out_t *, const es_format_t * );
 114     int          (*pf_send)   ( es_out_t *, es_out_id_t *, block_t * );
 115     void         (*pf_del)    ( es_out_t *, es_out_id_t * );
 116     int          (*pf_control)( es_out_t *, int i_query, va_list );
 117     void         (*pf_destroy)( es_out_t * );
 118
 119     es_out_sys_t    *p_sys;
 120 };
 121
 122 VLC_USED
 123 static inline es_out_id_t * es_out_Add( es_out_t *out, const es_format_t *fmt )
 124 {
 125     return out->pf_add( out, fmt );
 126 }
 127
 128 static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
 129 {
 130     out->pf_del( out, id );
 131 }
 132
 133 static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
 134                                block_t *p_block )
 135 {
 136     return out->pf_send( out, id, p_block );
 137 }
 138
 139 static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
 140 {
 141     return out->pf_control( out, i_query, args );
 142 }
 143
 144 static inline int es_out_Control( es_out_t *out, int i_query, ... )
 145 {
 146     va_list args;
 147     int     i_result;
 148
 149     va_start( args, i_query );
 150     i_result = es_out_vaControl( out, i_query, args );
 151     va_end( args );
 152     return i_result;
 153 }
 154
 155 static inline void es_out_Delete( es_out_t *p_out )
 156 {
 157     p_out->pf_destroy( p_out );
 158 }
 159
 160 static inline int es_out_SetPCR( es_out_t *out, int64_t pcr )
 161 {
 162     return es_out_Control( out, ES_OUT_SET_PCR, pcr );
 163 }
 164
 165 static inline int es_out_ControlSetMeta( es_out_t *out, const vlc_meta_t *p_meta )
 166 {
 167     return es_out_Control( out, ES_OUT_SET_META, p_meta );
 168 }
 169
 170 static inline int es_out_ControlGetPcrSystem( es_out_t *out, mtime_t *pi_system, mtime_t *pi_delay )
 171 {
 172     return es_out_Control( out, ES_OUT_GET_PCR_SYSTEM, pi_system, pi_delay );
 173 }
 174 static inline int es_out_ControlModifyPcrSystem( es_out_t *out, bool b_absolute, mtime_t i_system )
 175 {
 176     return es_out_Control( out, ES_OUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
 177 }
 178
 179 /**
 180  * @}
 181  */
 182
 183 #endif