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     /* Set delay for a ES category */
  55     ES_OUT_SET_DELAY,                               /* arg1=es_category_e,      res=can fail */
  56
  57     /* Set record state */
  58     ES_OUT_SET_RECORD_STATE,                        /* arg1=bool                res=can fail */
  59
  60     /* Set pause state */
  61     ES_OUT_SET_PAUSE_STATE,                         /* arg1=bool b_source_paused, bool b_paused arg2=mtime_t   res=can fail */
  62
  63     /* Set rate */
  64     ES_OUT_SET_RATE,                                /* arg1=int i_source_rate arg2=int i_rate                  res=can fail */
  65
  66     /* Set a new time */
  67     ES_OUT_SET_TIME,                                /* arg1=mtime_t             res=can fail */
  68
  69     /* Set next frame */
  70     ES_OUT_SET_FRAME_NEXT,                          /*                          res=can fail */
  71
  72     /* Set position/time/length */
  73     ES_OUT_SET_TIMES,                               /* arg1=double f_position arg2=mtime_t i_time arg3=mtime_t i_length res=cannot fail */
  74
  75     /* Set jitter */
  76     ES_OUT_SET_JITTER,                              /* arg1=mtime_t i_pts_delay arg2=int i_cr_average res=cannot fail */
  77 };
  78
  79 static inline mtime_t es_out_GetWakeup( es_out_t *p_out )
  80 {
  81     mtime_t i_wu;
  82     int i_ret = es_out_Control( p_out, ES_OUT_GET_WAKE_UP, &i_wu );
  83
  84     assert( !i_ret );
  85     return i_wu;
  86 }
  87 static inline bool es_out_GetBuffering( es_out_t *p_out )
  88 {
  89     bool b;
  90     int i_ret = es_out_Control( p_out, ES_OUT_GET_BUFFERING, &b );
  91
  92     assert( !i_ret );
  93     return b;
  94 }
  95 static inline bool es_out_GetEmpty( es_out_t *p_out )
  96 {
  97     bool b;
  98     int i_ret = es_out_Control( p_out, ES_OUT_GET_EMPTY, &b );
  99
 100     assert( !i_ret );
 101     return b;
 102 }
 103 static inline int es_out_SetDelay( es_out_t *p_out, int i_cat, mtime_t i_delay )
 104 {
 105     return es_out_Control( p_out, ES_OUT_SET_DELAY, i_cat, i_delay );
 106 }
 107 static inline int es_out_SetRecordState( es_out_t *p_out, bool b_record )
 108 {
 109     return es_out_Control( p_out, ES_OUT_SET_RECORD_STATE, b_record );
 110 }
 111 static inline int es_out_SetPauseState( es_out_t *p_out, bool b_source_paused, bool b_paused, mtime_t i_date )
 112 {
 113     return es_out_Control( p_out, ES_OUT_SET_PAUSE_STATE, b_source_paused, b_paused, i_date );
 114 }
 115 static inline int es_out_SetRate( es_out_t *p_out, int i_source_rate, int i_rate )
 116 {
 117     return es_out_Control( p_out, ES_OUT_SET_RATE, i_source_rate, i_rate );
 118 }
 119 static inline int es_out_SetTime( es_out_t *p_out, mtime_t i_date )
 120 {
 121     return es_out_Control( p_out, ES_OUT_SET_TIME, i_date );
 122 }
 123 static inline int es_out_SetFrameNext( es_out_t *p_out )
 124 {
 125     return es_out_Control( p_out, ES_OUT_SET_FRAME_NEXT );
 126 }
 127 static inline void es_out_SetTimes( es_out_t *p_out, double f_position, mtime_t i_time, mtime_t i_length )
 128 {
 129     int i_ret = es_out_Control( p_out, ES_OUT_SET_TIMES, f_position, i_time, i_length );
 130     assert( !i_ret );
 131 }
 132 static inline void es_out_SetJitter( es_out_t *p_out, mtime_t i_pts_delay, int i_cr_average )
 133 {
 134     int i_ret = es_out_Control( p_out, ES_OUT_SET_JITTER, i_pts_delay, i_cr_average );
 135     assert( !i_ret );
 136 }
 137
 138 es_out_t  *input_EsOutNew( input_thread_t *, int i_rate );
 139
 140 #endif