src/video_output/vout_control.h

   1 /*****************************************************************************
   2  * vout_control.h : Vout control function definitions
   3  *****************************************************************************
   4  * Copyright (C) 2008 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef LIBVLC_VOUT_CONTROL_H
  26 #define LIBVLC_VOUT_CONTROL_H 1
  27
  28 typedef struct vout_window_mouse_event_t vout_window_mouse_event_t;
  29
  30 /**
  31  * This function will (un)pause the display of pictures.
  32  * It is thread safe
  33  */
  34 void vout_ChangePause( vout_thread_t *, bool b_paused, mtime_t i_date );
  35
  36 /**
  37  * This function will apply an offset on subtitle subpicture.
  38  */
  39 void spu_OffsetSubtitleDate( spu_t *p_spu, mtime_t i_duration );
  40
  41 /**
  42  * This function will return and reset internal statistics.
  43  */
  44 void vout_GetResetStatistic( vout_thread_t *p_vout, unsigned *pi_displayed,
  45                              unsigned *pi_lost );
  46
  47 /**
  48  * This function will ensure that all ready/displayed pictures have at most
  49  * the provided date.
  50  */
  51 void vout_Flush( vout_thread_t *p_vout, mtime_t i_date );
  52
  53 /*
  54  * Cancel the vout, if cancel is true, it won't return any pictures after this
  55  * call.
  56  */
  57 void vout_Cancel( vout_thread_t *p_vout, bool b_canceled );
  58
  59 /**
  60  * This function will force to display the next picture while paused
  61  */
  62 void vout_NextPicture( vout_thread_t *p_vout, mtime_t *pi_duration );
  63
  64 /**
  65  * This function will ask the display of the input title
  66  */
  67 void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title );
  68
  69 void vout_WindowMouseEvent( vout_thread_t *p_vout,
  70                             const vout_window_mouse_event_t *mouse );
  71
  72 /**
  73  * This function will return true if no more pictures are to be displayed.
  74  */
  75 bool vout_IsEmpty( vout_thread_t *p_vout );
  76
  77 #endif