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