home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 December / maximum-cd-2009-12.iso / DiscContents / vlc-1.0.1-win32.exe / sdk / include / vlc / plugins / vlc_es_out.h < prev    next >
Encoding:
C/C++ Source or Header  |  2009-07-26  |  5.1 KB  |  153 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$
  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.     /* set ES selected for the es category (audio/video/spu) */
  48.     ES_OUT_SET_ES,      /* arg1= es_out_id_t*                   */
  49.     ES_OUT_RESTART_ES,  /* arg1= es_out_id_t*                   */
  50.  
  51.     /* set 'default' tag on ES (copied across from container) */
  52.     ES_OUT_SET_ES_DEFAULT, /* 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=bool   */
  56.     ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=bool*  */
  57.  
  58.     /* */
  59.     ES_OUT_SET_GROUP,   /* arg1= int                            */
  60.  
  61.     /* PCR handling, DTS/PTS will be automatically computed using thoses PCR
  62.      * XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait
  63.      * to slow down the demuxer so that it reads at the right speed.
  64.      * XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send
  65.      * as you would normally do.
  66.      */
  67.     ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
  68.     ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
  69.     ES_OUT_RESET_PCR,           /* no arg */
  70.  
  71.     /* Try not to use this one as it is a bit hacky */
  72.     ES_OUT_SET_ES_FMT,         /* arg1= es_out_id_t* arg2=es_format_t* */
  73.  
  74.     /* Allow preroll of data (data with dts/pts < i_pts for all ES will be decoded but not displayed */
  75.     ES_OUT_SET_NEXT_DISPLAY_TIME,       /* arg1=int64_t i_pts(microsecond) */
  76.     /* Set meta data for group (dynamic) */
  77.     ES_OUT_SET_GROUP_META,  /* arg1=int i_group arg2=vlc_meta_t */
  78.     /* Set epg for group (dynamic) */
  79.     ES_OUT_SET_GROUP_EPG,   /* arg1=int i_group arg2=vlc_epg_t */
  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.     /* First value usable for private control */
  94.     ES_OUT_PRIVATE_START = 0x10000,
  95. };
  96.  
  97. struct es_out_t
  98. {
  99.     es_out_id_t *(*pf_add)    ( es_out_t *, const es_format_t * );
  100.     int          (*pf_send)   ( es_out_t *, es_out_id_t *, block_t * );
  101.     void         (*pf_del)    ( es_out_t *, es_out_id_t * );
  102.     int          (*pf_control)( es_out_t *, int i_query, va_list );
  103.     void         (*pf_destroy)( es_out_t * );
  104.  
  105.     bool         b_sout;
  106.  
  107.     es_out_sys_t    *p_sys;
  108. };
  109.  
  110. LIBVLC_USED
  111. static inline es_out_id_t * es_out_Add( es_out_t *out, const es_format_t *fmt )
  112. {
  113.     return out->pf_add( out, fmt );
  114. }
  115.  
  116. static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
  117. {
  118.     out->pf_del( out, id );
  119. }
  120.  
  121. static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
  122.                                block_t *p_block )
  123. {
  124.     return out->pf_send( out, id, p_block );
  125. }
  126.  
  127. static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
  128. {
  129.     return out->pf_control( out, i_query, args );
  130. }
  131.  
  132. static inline int es_out_Control( es_out_t *out, int i_query, ... )
  133. {
  134.     va_list args;
  135.     int     i_result;
  136.  
  137.     va_start( args, i_query );
  138.     i_result = es_out_vaControl( out, i_query, args );
  139.     va_end( args );
  140.     return i_result;
  141. }
  142.  
  143. static inline void es_out_Delete( es_out_t *p_out )
  144. {
  145.     p_out->pf_destroy( p_out );
  146. }
  147.  
  148. /**
  149.  * @}
  150.  */
  151.  
  152. #endif
  153.