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     /* Restart all ES, destroying and recreating decoder/sout and potential
  42      * video/audio outputs. This is not recommended and might not even work */
  43     ES_OUT_RESTART_ALL_ES, /* No arg */
  44
  45     /* set 'default' tag on ES (copied across from container) */
  46     ES_OUT_SET_ES_DEFAULT, /* arg1= es_out_id_t*                */
  47
  48     /* force (un)selection of the ES (bypass current mode)
  49        XXX: this will not change the state of any other ES ! (see SET_ES) */
  50     ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=bool   */
  51     ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=bool*  */
  52
  53     /* sets es selection policy when in auto mode */
  54     ES_OUT_SET_ES_CAT_POLICY, /* arg1=es_format_category_e arg2=es_out_policy_e */
  55
  56     /* */
  57     ES_OUT_SET_GROUP,   /* arg1= int                            */
  58
  59     /* PCR handling, DTS/PTS will be automatically computed using thoses PCR
  60      * XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait
  61      * to slow down the demuxer so that it reads at the right speed.
  62      * XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send
  63      * as you would normally do.
  64      */
  65     ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
  66     ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
  67     ES_OUT_RESET_PCR,           /* no arg */
  68
  69     /* Try not to use this one as it is a bit hacky */
  70     ES_OUT_SET_ES_FMT,         /* arg1= es_out_id_t* arg2=es_format_t* */
  71
  72     /* Allow preroll of data (data with dts/pts < i_pts for all ES will be decoded but not displayed */
  73     ES_OUT_SET_NEXT_DISPLAY_TIME,       /* arg1=int64_t i_pts(microsecond) */
  74     /* Set meta data for group (dynamic) (The vlc_meta_t is not modified nor released) */
  75     ES_OUT_SET_GROUP_META,  /* arg1=int i_group arg2=const vlc_meta_t */
  76     /* Set epg for group (dynamic) (The vlc_epg_t is not modified nor released) */
  77     ES_OUT_SET_GROUP_EPG,       /* arg1=int i_group arg2=const vlc_epg_t * */
  78     ES_OUT_SET_GROUP_EPG_EVENT, /* arg1=int i_group arg2=const vlc_epg_event_t * */
  79     ES_OUT_SET_EPG_TIME,        /* arg1=int int64_t */
  80
  81     /* */
  82     ES_OUT_DEL_GROUP,       /* arg1=int i_group */
  83
  84     /* Set scrambled state for one es */
  85     ES_OUT_SET_ES_SCRAMBLED_STATE,  /* arg1=int i_group arg2=es_out_id_t* */
  86
  87     /* Stop any buffering being done, and ask if es_out has no more data to
  88      * play.
  89      * It will not block and so MUST be used carrefully. The only good reason
  90      * is for interactive playback (like for DVD menu).
  91      * XXX You SHALL call ES_OUT_RESET_PCR before any other es_out_Control/Send calls. */
  92     ES_OUT_GET_EMPTY,       /* arg1=bool*   res=cannot fail */
  93
  94     /* Set global meta data (The vlc_meta_t is not modified nor released) */
  95     ES_OUT_SET_META, /* arg1=const vlc_meta_t * */
  96
  97     /* PCR system clock manipulation for external clock synchronization */
  98     ES_OUT_GET_PCR_SYSTEM, /* arg1=mtime_t *, arg2=mtime_t * res=can fail */
  99     ES_OUT_MODIFY_PCR_SYSTEM, /* arg1=int is_absolute, arg2=mtime_t, res=can fail */
 100
 101     ES_OUT_POST_SUBNODE, /* arg1=input_item_node_t *, res=can fail */
 102
 103     /* First value usable for private control */
 104     ES_OUT_PRIVATE_START = 0x10000,
 105 };
 106
 107 enum es_out_policy_e
 108 {
 109     ES_OUT_ES_POLICY_EXCLUSIVE = 0,/* Enforces single ES selection only */
 110     ES_OUT_ES_POLICY_SIMULTANEOUS, /* Allows multiple ES per cat */
 111 };
 112
 113 struct es_out_t
 114 {
 115     es_out_id_t *(*pf_add)    ( es_out_t *, const es_format_t * );
 116     int          (*pf_send)   ( es_out_t *, es_out_id_t *, block_t * );
 117     void         (*pf_del)    ( es_out_t *, es_out_id_t * );
 118     int          (*pf_control)( es_out_t *, int i_query, va_list );
 119     void         (*pf_destroy)( es_out_t * );
 120
 121     es_out_sys_t    *p_sys;
 122 };
 123
 124 VLC_USED
 125 static inline es_out_id_t * es_out_Add( es_out_t *out, const es_format_t *fmt )
 126 {
 127     return out->pf_add( out, fmt );
 128 }
 129
 130 static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
 131 {
 132     out->pf_del( out, id );
 133 }
 134
 135 static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
 136                                block_t *p_block )
 137 {
 138     return out->pf_send( out, id, p_block );
 139 }
 140
 141 static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
 142 {
 143     return out->pf_control( out, i_query, args );
 144 }
 145
 146 static inline int es_out_Control( es_out_t *out, int i_query, ... )
 147 {
 148     va_list args;
 149     int     i_result;
 150
 151     va_start( args, i_query );
 152     i_result = es_out_vaControl( out, i_query, args );
 153     va_end( args );
 154     return i_result;
 155 }
 156
 157 static inline void es_out_Delete( es_out_t *p_out )
 158 {
 159     p_out->pf_destroy( p_out );
 160 }
 161
 162 static inline int es_out_SetPCR( es_out_t *out, int64_t pcr )
 163 {
 164     return es_out_Control( out, ES_OUT_SET_PCR, pcr );
 165 }
 166
 167 static inline int es_out_ControlSetMeta( es_out_t *out, const vlc_meta_t *p_meta )
 168 {
 169     return es_out_Control( out, ES_OUT_SET_META, p_meta );
 170 }
 171
 172 static inline int es_out_ControlGetPcrSystem( es_out_t *out, mtime_t *pi_system, mtime_t *pi_delay )
 173 {
 174     return es_out_Control( out, ES_OUT_GET_PCR_SYSTEM, pi_system, pi_delay );
 175 }
 176 static inline int es_out_ControlModifyPcrSystem( es_out_t *out, bool b_absolute, mtime_t i_system )
 177 {
 178     return es_out_Control( out, ES_OUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
 179 }
 180
 181 /**
 182  * @}
 183  */
 184
 185 #endif