include/vlc_vout_wrapper.h

   1 /*****************************************************************************
   2  * vlc_vout_wrapper.h: definitions for vout wrappers (temporary)
   3  *****************************************************************************
   4  * Copyright (C) 2009 Laurent Aimar
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_VOUT_WRAPPER_H
  25 #define VLC_VOUT_WRAPPER_H 1
  26
  27 #include <vlc_vout_display.h>
  28
  29 /* XXX DO NOT use it outside the vout module wrapper XXX */
  30
  31 /**
  32  * It retreives a picture pool from the display
  33  */
  34 static inline picture_pool_t *vout_display_Pool(vout_display_t *vd, unsigned count)
  35 {
  36     return vd->pool(vd, count);
  37 }
  38
  39 /**
  40  * It preparse a picture for display.
  41  */
  42 static inline void vout_display_Prepare(vout_display_t *vd,
  43                                         picture_t *picture,
  44                                         subpicture_t *subpicture,
  45                                         vlc_tick_t date)
  46 {
  47     if (vd->prepare)
  48         vd->prepare(vd, picture, subpicture, date);
  49 }
  50
  51 /**
  52  * It display a picture.
  53  */
  54 static inline void vout_display_Display(vout_display_t *vd,
  55                                         picture_t *picture,
  56                                         subpicture_t *subpicture)
  57 {
  58     vd->display(vd, picture, subpicture);
  59 }
  60
  61 /**
  62  * It holds a state for a vout display.
  63  */
  64 typedef struct {
  65     vout_display_cfg_t cfg;
  66 #if defined(_WIN32) || defined(__OS2__)
  67     unsigned wm_state;
  68 #endif
  69     vlc_rational_t sar;
  70 } vout_display_state_t;
  71
  72 /**
  73  * It creates a vout managed display.
  74  */
  75 vout_display_t *vout_NewDisplay( vout_thread_t *, const video_format_t *,
  76     const vout_display_state_t *, const char *module);
  77 /**
  78  * It destroy a vout managed display.
  79  */
  80 void vout_DeleteDisplay(vout_display_t *, vout_display_state_t *);
  81 bool vout_IsDisplayFiltered(vout_display_t *);
  82 picture_t * vout_FilterDisplay(vout_display_t *, picture_t *);
  83 void vout_FilterFlush(vout_display_t *);
  84 bool vout_AreDisplayPicturesInvalid(vout_display_t *);
  85
  86 bool vout_ManageDisplay(vout_display_t *, bool allow_reset_pictures);
  87
  88 void vout_SetDisplaySize(vout_display_t *, unsigned width, unsigned height);
  89 void vout_SetDisplayFilled(vout_display_t *, bool is_filled);
  90 void vout_SetDisplayZoom(vout_display_t *, unsigned num, unsigned den);
  91 void vout_SetDisplayAspect(vout_display_t *, unsigned num, unsigned den);
  92 void vout_SetDisplayCrop(vout_display_t *, unsigned num, unsigned den,
  93                          unsigned left, unsigned top, int right, int bottom);
  94 void vout_SetDisplayViewpoint(vout_display_t *, const vlc_viewpoint_t *);
  95
  96 #endif /* VLC_VOUT_WRAPPER_H */
  97