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