git.sesse.net Git - vlc/blob - src/input/es_out.h

   1 /*****************************************************************************
   2  * es_out.h: Input es_out functions
   3  *****************************************************************************
   4  * Copyright (C) 1998-2008 the VideoLAN team
   5  * Copyright (C) 2008 Laurent Aimar
   6  * $Id$
   7  *
   8  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
  26 # error This header file can only be included from LibVLC.
  27 #endif
  28
  29 #ifndef _INPUT_ES_OUT_H
  30 #define _INPUT_ES_OUT_H 1
  31
  32 #include <vlc_common.h>
  33
  34 enum es_out_query_private_e
  35 {
  36
  37     /* activate application of mode */
  38     ES_OUT_SET_ACTIVE = ES_OUT_PRIVATE_START,       /* arg1= bool                     */
  39
  40     /* set/get mode */
  41     ES_OUT_SET_MODE,                                /* arg1= int                            */
  42
  43     /* Get date to wait before demuxing more data */
  44     ES_OUT_GET_WAKE_UP,                             /* arg1=mtime_t*            res=cannot fail */
  45
  46     /* Wrapper for some ES command to work with id */
  47     ES_OUT_SET_ES_BY_ID,
  48     ES_OUT_RESTART_ES_BY_ID,
  49     ES_OUT_SET_ES_DEFAULT_BY_ID,
  50
  51     /* Get buffering state */
  52     ES_OUT_GET_BUFFERING,                           /* arg1=bool*               res=cannot fail */
  53
  54     /* Check if es_out has still data to play */
  55     ES_OUT_GET_EMPTY,                               /* arg1=bool*               res=cannot fail */
  56
  57     /* Set delay for a ES category */
  58     ES_OUT_SET_DELAY,                               /* arg1=es_category_e,      res=can fail */
  59
  60     /* Set record state */
  61     ES_OUT_SET_RECORD_STATE,                        /* arg1=bool                res=can fail */
  62
  63     /* Set pause state */
  64     ES_OUT_SET_PAUSE_STATE,                         /* arg1=bool b_source_paused, bool b_paused arg2=mtime_t   res=can fail */
  65
  66     /* Set rate */
  67     ES_OUT_SET_RATE,                                /* arg1=int i_source_rate arg2=int i_rate                  res=can fail */
  68
  69     /* Set a new time */
  70     ES_OUT_SET_TIME,                                /* arg1=mtime_t             res=can fail */
  71
  72     /* Set next frame */
  73     ES_OUT_SET_FRAME_NEXT,                          /*                          res=can fail */
  74
  75     /* Set position/time/length */
  76     ES_OUT_SET_TIMES,                               /* arg1=double f_position arg2=mtime_t i_time arg3=mtime_t i_length res=cannot fail */
  77
  78     /* Set jitter */
  79     ES_OUT_SET_JITTER,                              /* arg1=mtime_t i_pts_delay arg2=int i_cr_average res=cannot fail */
  80 };
  81
  82 static inline mtime_t es_out_GetWakeup( es_out_t *p_out )
  83 {
  84     mtime_t i_wu;
  85     int i_ret = es_out_Control( p_out, ES_OUT_GET_WAKE_UP, &i_wu );
  86
  87     assert( !i_ret );
  88     return i_wu;
  89 }
  90 static inline bool es_out_GetBuffering( es_out_t *p_out )
  91 {
  92     bool b;
  93     int i_ret = es_out_Control( p_out, ES_OUT_GET_BUFFERING, &b );
  94
  95     assert( !i_ret );
  96     return b;
  97 }
  98 static inline bool es_out_GetEmpty( es_out_t *p_out )
  99 {
 100     bool b;
 101     int i_ret = es_out_Control( p_out, ES_OUT_GET_EMPTY, &b );
 102
 103     assert( !i_ret );
 104     return b;
 105 }
 106 static inline int es_out_SetDelay( es_out_t *p_out, int i_cat, mtime_t i_delay )
 107 {
 108     return es_out_Control( p_out, ES_OUT_SET_DELAY, i_cat, i_delay );
 109 }
 110 static inline int es_out_SetRecordState( es_out_t *p_out, bool b_record )
 111 {
 112     return es_out_Control( p_out, ES_OUT_SET_RECORD_STATE, b_record );
 113 }
 114 static inline int es_out_SetPauseState( es_out_t *p_out, bool b_source_paused, bool b_paused, mtime_t i_date )
 115 {
 116     return es_out_Control( p_out, ES_OUT_SET_PAUSE_STATE, b_source_paused, b_paused, i_date );
 117 }
 118 static inline int es_out_SetRate( es_out_t *p_out, int i_source_rate, int i_rate )
 119 {
 120     return es_out_Control( p_out, ES_OUT_SET_RATE, i_source_rate, i_rate );
 121 }
 122 static inline int es_out_SetTime( es_out_t *p_out, mtime_t i_date )
 123 {
 124     return es_out_Control( p_out, ES_OUT_SET_TIME, i_date );
 125 }
 126 static inline int es_out_SetFrameNext( es_out_t *p_out )
 127 {
 128     return es_out_Control( p_out, ES_OUT_SET_FRAME_NEXT );
 129 }
 130 static inline void es_out_SetTimes( es_out_t *p_out, double f_position, mtime_t i_time, mtime_t i_length )
 131 {
 132     int i_ret = es_out_Control( p_out, ES_OUT_SET_TIMES, f_position, i_time, i_length );
 133     assert( !i_ret );
 134 }
 135 static inline void es_out_SetJitter( es_out_t *p_out, mtime_t i_pts_delay, int i_cr_average )
 136 {
 137     int i_ret = es_out_Control( p_out, ES_OUT_SET_JITTER, i_pts_delay, i_cr_average );
 138     assert( !i_ret );
 139 }
 140
 141 es_out_t  *input_EsOutNew( input_thread_t *, int i_rate );
 142
 143 #endif