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 ES selected for the es 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 selection/unselection of the ES (bypass current mode) */
  49     ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=bool   */
  50     ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=bool*  */
  51
  52     /* sets es selection policy when in auto mode */
  53     ES_OUT_SET_ES_CAT_POLICY, /* arg1=es_format_category_e arg2=es_out_policy_e */
  54
  55     /* */
  56     ES_OUT_SET_GROUP,   /* arg1= int                            */
  57
  58     /* PCR handling, DTS/PTS will be automatically computed using thoses PCR
  59      * XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait
  60      * to slow down the demuxer so that it reads at the right speed.
  61      * XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send
  62      * as you would normally do.
  63      */
  64     ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
  65     ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
  66     ES_OUT_RESET_PCR,           /* no arg */
  67
  68     /* Try not to use this one as it is a bit hacky */
  69     ES_OUT_SET_ES_FMT,         /* arg1= es_out_id_t* arg2=es_format_t* */
  70
  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 */
  79
  80     /* */
  81     ES_OUT_DEL_GROUP,       /* arg1=int i_group */
  82
  83     /* Set scrambled state for one es */
  84     ES_OUT_SET_ES_SCRAMBLED_STATE,  /* arg1=int i_group arg2=es_out_id_t* */
  85
  86     /* Stop any buffering being done, and ask if es_out has no more data to
  87      * play.
  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 */
  92
  93     /* Set global meta data (The vlc_meta_t is not modified nor released) */
  94     ES_OUT_SET_META, /* arg1=const vlc_meta_t * */
  95
  96     /* PCR system clock manipulation for external clock synchronization */
  97     ES_OUT_GET_PCR_SYSTEM, /* arg1=mtime_t *, arg2=mtime_t * res=can fail */
  98     ES_OUT_MODIFY_PCR_SYSTEM, /* arg1=int is_absolute, arg2=mtime_t, res=can fail */
  99
 100     ES_OUT_POST_SUBNODE, /* arg1=input_item_node_t *, res=can fail */
 101
 102     /* First value usable for private control */
 103     ES_OUT_PRIVATE_START = 0x10000,
 104 };
 105
 106 enum es_out_policy_e
 107 {
 108     ES_OUT_ES_POLICY_EXCLUSIVE = 0,/* Enforces single ES selection only */
 109     ES_OUT_ES_POLICY_SIMULTANEOUS, /* Allows multiple ES per cat */
 110 };
 111
 112 struct es_out_t
 113 {
 114     es_out_id_t *(*pf_add)    ( es_out_t *, const es_format_t * );
 115     int          (*pf_send)   ( es_out_t *, es_out_id_t *, block_t * );
 116     void         (*pf_del)    ( es_out_t *, es_out_id_t * );
 117     int          (*pf_control)( es_out_t *, int i_query, va_list );
 118     void         (*pf_destroy)( es_out_t * );
 119
 120     es_out_sys_t    *p_sys;
 121 };
 122
 123 VLC_USED
 124 static inline es_out_id_t * es_out_Add( es_out_t *out, const es_format_t *fmt )
 125 {
 126     return out->pf_add( out, fmt );
 127 }
 128
 129 static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
 130 {
 131     out->pf_del( out, id );
 132 }
 133
 134 static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
 135                                block_t *p_block )
 136 {
 137     return out->pf_send( out, id, p_block );
 138 }
 139
 140 static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
 141 {
 142     return out->pf_control( out, i_query, args );
 143 }
 144
 145 static inline int es_out_Control( es_out_t *out, int i_query, ... )
 146 {
 147     va_list args;
 148     int     i_result;
 149
 150     va_start( args, i_query );
 151     i_result = es_out_vaControl( out, i_query, args );
 152     va_end( args );
 153     return i_result;
 154 }
 155
 156 static inline void es_out_Delete( es_out_t *p_out )
 157 {
 158     p_out->pf_destroy( p_out );
 159 }
 160
 161 static inline int es_out_SetPCR( es_out_t *out, int64_t pcr )
 162 {
 163     return es_out_Control( out, ES_OUT_SET_PCR, pcr );
 164 }
 165
 166 static inline int es_out_ControlSetMeta( es_out_t *out, const vlc_meta_t *p_meta )
 167 {
 168     return es_out_Control( out, ES_OUT_SET_META, p_meta );
 169 }
 170
 171 static inline int es_out_ControlGetPcrSystem( es_out_t *out, mtime_t *pi_system, mtime_t *pi_delay )
 172 {
 173     return es_out_Control( out, ES_OUT_GET_PCR_SYSTEM, pi_system, pi_delay );
 174 }
 175 static inline int es_out_ControlModifyPcrSystem( es_out_t *out, bool b_absolute, mtime_t i_system )
 176 {
 177     return es_out_Control( out, ES_OUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
 178 }
 179
 180 /**
 181  * @}
 182  */
 183
 184 #endif