home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 May / maximum-cd-2009-05.iso / DiscContents / vlc-0.9.8a-win32.exe / sdk / include / vlc / plugins / vlc_es_out.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-06  |  5.1 KB  |  146 lines
  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: bd654484a972d30c5b23de24c00dead6a9cd90fe $
  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_mode_e
  38. {
  39.     ES_OUT_MODE_NONE,   /* don't select anything */
  40.     ES_OUT_MODE_ALL,    /* eg for stream output */
  41.     ES_OUT_MODE_AUTO,   /* best audio/video or for input follow audio-track, sub-track */
  42.     ES_OUT_MODE_PARTIAL /* select programs given after --programs */
  43. };
  44.  
  45. enum es_out_query_e
  46. {
  47.     /* activate application of mode */
  48.     ES_OUT_SET_ACTIVE,  /* arg1= bool                     */
  49.     /* see if mode is currently aplied or not */
  50.     ES_OUT_GET_ACTIVE,  /* arg1= bool*                    */
  51.  
  52.     /* set/get mode */
  53.     ES_OUT_SET_MODE,    /* arg1= int                            */
  54.     ES_OUT_GET_MODE,    /* arg2= int*                           */
  55.  
  56.     /* set ES selected for the es category (audio/video/spu) */
  57.     ES_OUT_SET_ES,      /* arg1= es_out_id_t*                   */
  58.  
  59.     /* set 'default' tag on ES (copied across from container) */
  60.     ES_OUT_SET_DEFAULT, /* arg1= es_out_id_t*                   */
  61.  
  62.     /* force selection/unselection of the ES (bypass current mode) */
  63.     ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=bool   */
  64.     ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=bool*  */
  65.  
  66.     /* */
  67.     ES_OUT_SET_GROUP,   /* arg1= int                            */
  68.     ES_OUT_GET_GROUP,   /* arg1= int*                           */
  69.  
  70.     /* PCR handling, DTS/PTS will be automatically computed using thoses PCR
  71.      * XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait
  72.      * to slow down the demuxer so that it reads at the right speed.
  73.      * XXX: if you want PREROLL just call RESET_PCR and
  74.      * ES_OUT_SET_NEXT_DISPLAY_TIME and send data to the decoder *without*
  75.      * calling SET_PCR until preroll is finished.
  76.      */
  77.     ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
  78.     ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
  79.     ES_OUT_RESET_PCR,           /* no arg */
  80.  
  81.     /* Timestamp handling, convert an input timestamp to a global clock one.
  82.      * (shouldn't have to be used by input plugins directly) */
  83.     ES_OUT_GET_TS,             /* arg1=int64_t i_ts(microsecond!) (using default group 0), arg2=int64_t* converted i_ts */
  84.  
  85.     /* Try not to use this one as it is a bit hacky */
  86.     ES_OUT_SET_FMT,     /* arg1= es_out_id_t* arg2=es_format_t* */
  87.  
  88.     /* Allow preroll of data (data with dts/pts < i_pts for one ES will be decoded but not displayed */
  89.     ES_OUT_SET_NEXT_DISPLAY_TIME,   /* arg1=es_out_id_t* arg2=int64_t i_pts(microsecond) */
  90.     /* Set meta data for group (dynamic) */
  91.     ES_OUT_SET_GROUP_META,  /* arg1=int i_group arg2=vlc_meta_t */
  92.     /* Set epg for group (dynamic) */
  93.     ES_OUT_SET_GROUP_EPG,   /* arg1=int i_group arg2=vlc_epg_t */
  94.     /* */
  95.     ES_OUT_DEL_GROUP        /* arg1=int i_group */
  96. };
  97.  
  98. struct es_out_t
  99. {
  100.     es_out_id_t *(*pf_add)    ( es_out_t *, es_format_t * );
  101.     int          (*pf_send)   ( es_out_t *, es_out_id_t *, block_t * );
  102.     void         (*pf_del)    ( es_out_t *, es_out_id_t * );
  103.     int          (*pf_control)( es_out_t *, int i_query, va_list );
  104.     bool      b_sout;
  105.  
  106.     es_out_sys_t    *p_sys;
  107. };
  108.  
  109. static inline es_out_id_t * es_out_Add( es_out_t *out, 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. /**
  142.  * @}
  143.  */
  144.  
  145. #endif
  146.