include/vlc_vout_window.h

   1 /*****************************************************************************
   2  * vlc_vout_window.h: vout_window_t definitions
   3  *****************************************************************************
   4  * Copyright (C) 2008 Rémi Denis-Courmont
   5  * Copyright (C) 2009 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 VLC_VOUT_WINDOW_H
  26 #define VLC_VOUT_WINDOW_H 1
  27
  28 #include <stdarg.h>
  29 #include <vlc_common.h>
  30
  31 /**
  32  * \defgroup video_window Video window
  33  * \ingroup video_output
  34  * Video output window management
  35  * @{
  36  * \file
  37  * Video output window modules interface
  38  */
  39
  40 typedef struct vout_window_t vout_window_t;
  41 typedef struct vout_window_sys_t vout_window_sys_t;
  42
  43 struct wl_display;
  44 struct wl_surface;
  45
  46 /**
  47  * Window handle type
  48  */
  49 enum {
  50     VOUT_WINDOW_TYPE_INVALID=0,
  51     VOUT_WINDOW_TYPE_XID,
  52     VOUT_WINDOW_TYPE_HWND,
  53     VOUT_WINDOW_TYPE_NSOBJECT,
  54     VOUT_WINDOW_TYPE_ANDROID_NATIVE,
  55     VOUT_WINDOW_TYPE_WAYLAND,
  56 };
  57
  58 /**
  59  * Control query for vout_window_t
  60  */
  61 enum {
  62     VOUT_WINDOW_SET_STATE, /* unsigned state */
  63     VOUT_WINDOW_SET_SIZE,   /* unsigned i_width, unsigned i_height */
  64     VOUT_WINDOW_SET_FULLSCREEN, /* int b_fullscreen */
  65 };
  66
  67 typedef struct vout_window_cfg_t {
  68     /* If true, a standalone window is requested */
  69     bool is_standalone;
  70
  71     /* Window handle type */
  72     unsigned type;
  73
  74 #ifdef __APPLE__
  75     /* Window position hint */
  76     int x;
  77     int y;
  78 #endif
  79
  80     /* Windows size hint */
  81     unsigned width;
  82     unsigned height;
  83
  84 } vout_window_cfg_t;
  85
  86 typedef struct vout_window_owner {
  87     void *sys;
  88     void (*resized)(vout_window_t *, unsigned width, unsigned height);
  89     void (*closed)(vout_window_t *);
  90 } vout_window_owner_t;
  91
  92 /**
  93  * FIXME do we need an event system in the window too ?
  94  * or the window user will take care of it ?
  95  */
  96 struct vout_window_t {
  97     VLC_COMMON_MEMBERS
  98
  99     unsigned type; /**< Window handle type */
 100
 101     /* window handle (mandatory)
 102      *
 103      * It must be filled in the open function.
 104      */
 105     union {
 106         void     *hwnd;          /* Win32 window handle */
 107         uint32_t xid;            /* X11 windows ID */
 108         void     *nsobject;      /* Mac OSX view object */
 109         void     *anativewindow; /* Android native window. */
 110         struct wl_surface *wl;   /* Wayland surface */
 111     } handle;
 112
 113     /* display server (mandatory) */
 114     union {
 115         char     *x11; /* X11 display (NULL = use default) */
 116         struct wl_display *wl;   /* Wayland struct wl_display pointer */
 117     } display;
 118
 119     /* Control on the module (mandatory)
 120      *
 121      * Do not use it directly; use vout_window_Control instead.
 122      */
 123     int (*control)(vout_window_t *, int query, va_list);
 124
 125     /* Private place holder for the vout_window_t module (optional)
 126      *
 127      * A module is free to use it as it wishes.
 128      */
 129     vout_window_sys_t *sys;
 130
 131     vout_window_owner_t owner;
 132 };
 133
 134 /**
 135  * Creates a new window.
 136  *
 137  * @param module plugin name (usually "$window")
 138  * @note If you are inside a "vout display", you must use
 139  / vout_display_NewWindow() and vout_display_DeleteWindow() instead.
 140  * This enables recycling windows.
 141  */
 142 VLC_API vout_window_t * vout_window_New(vlc_object_t *, const char *module, const vout_window_cfg_t *, const vout_window_owner_t *);
 143
 144 /**
 145  * Deletes a window created by vout_window_New().
 146  *
 147  * @note See vout_window_New() about window recycling.
 148  */
 149 VLC_API void vout_window_Delete(vout_window_t *);
 150
 151 static inline int vout_window_vaControl(vout_window_t *window, int query,
 152                                         va_list ap)
 153 {
 154     return window->control(window, query, ap);
 155 }
 156
 157 /**
 158  * Reconfigures a window.
 159  *
 160  * @note The vout_window_* wrappers should be used instead of this function.
 161  *
 162  * @warning The caller must own the window, as vout_window_t is not thread safe.
 163  */
 164 static inline int vout_window_Control(vout_window_t *window, int query, ...)
 165 {
 166     va_list ap;
 167     int ret;
 168
 169     va_start(ap, query);
 170     ret = vout_window_vaControl(window, query, ap);
 171     va_end(ap);
 172     return ret;
 173 }
 174
 175 /**
 176  * Configures the window manager state for this window.
 177  */
 178 static inline int vout_window_SetState(vout_window_t *window, unsigned state)
 179 {
 180     return vout_window_Control(window, VOUT_WINDOW_SET_STATE, state);
 181 }
 182
 183 /**
 184  * Configures the window display (i.e. inner/useful) size.
 185  */
 186 static inline int vout_window_SetSize(vout_window_t *window,
 187                                       unsigned width, unsigned height)
 188 {
 189     return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height);
 190 }
 191
 192 /**
 193  * Sets fullscreen mode.
 194  */
 195 static inline int vout_window_SetFullScreen(vout_window_t *window, bool full)
 196 {
 197     return vout_window_Control(window, VOUT_WINDOW_SET_FULLSCREEN, full);
 198 }
 199
 200 static inline void vout_window_ReportSize(vout_window_t *window,
 201                                           unsigned width, unsigned height)
 202 {
 203     if (window->owner.resized != NULL)
 204         window->owner.resized(window, width, height);
 205 }
 206
 207 static inline void vout_window_ReportClose(vout_window_t *window)
 208 {
 209     if (window->owner.closed != NULL)
 210         window->owner.closed(window);
 211 }
 212
 213 /** @} */
 214 #endif /* VLC_VOUT_WINDOW_H */