src/video_output/vout_control.h

   1 /*****************************************************************************
   2  * vout_control.h : Vout control function definitions
   3  *****************************************************************************
   4  * Copyright (C) 2008 the VideoLAN team
   5  * Copyright (C) 2008 Laurent Aimar
   6  * $Id$
   7  *
   8  * Authors: Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
   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
  26 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
  27 # error This header file can only be included from LibVLC.
  28 #endif
  29
  30 #ifndef _VOUT_CONTROL_H
  31 #define _VOUT_CONTROL_H 1
  32
  33 /* DO NOT use vout_CountPictureAvailable unless your are in src/input/decoder.c (no exception) */
  34 int vout_CountPictureAvailable( vout_thread_t * );
  35
  36 /**
  37  * This function will (un)pause the display of pictures.
  38  * It is thread safe
  39  */
  40 void vout_ChangePause( vout_thread_t *, bool b_paused, mtime_t i_date );
  41
  42 /**
  43  * This function will apply an offset on subtitle subpicture.
  44  */
  45 void spu_OffsetSubtitleDate( spu_t *p_spu, mtime_t i_duration );
  46
  47 /**
  48  * This function will return and reset internal statistics.
  49  */
  50 void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost );
  51
  52 /**
  53  * This function will ensure that all ready/displayed pciture have at most
  54  * the provided dat
  55  */
  56 void vout_Flush( vout_thread_t *p_vout, mtime_t i_date );
  57
  58 /**
  59  * This function will try to detect if pictures are being leaked. If so it
  60  * will release them.
  61  *
  62  * XXX This function is there to workaround bugs in decoder
  63  */
  64 void vout_FixLeaks( vout_thread_t *p_vout, bool b_forced );
  65
  66 /**
  67  * This functions will drop a picture retreived by vout_CreatePicture.
  68  */
  69 void vout_DropPicture( vout_thread_t *p_vout, picture_t * );
  70
  71 /**
  72  * This function will force to display the next picture while paused
  73  */
  74 void vout_NextPicture( vout_thread_t *p_vout, mtime_t *pi_duration );
  75
  76 /**
  77  * This function will ask the display of the input title
  78  */
  79 void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title );
  80
  81 #endif
  82