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
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 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 General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, 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_XWINDOW,
  45     VOUT_WINDOW_TYPE_HWND,
  46 };
  47
  48 /**
  49  * Control query for vout_window_t
  50  */
  51 enum {
  52     VOUT_WINDOW_SET_ON_TOP, /* int b_on_top */
  53     VOUT_WINDOW_SET_SIZE,   /* int i_width, int i_height */
  54 };
  55
  56 typedef struct {
  57     /* If true, a standalone window is requested */
  58     bool is_standalone;
  59
  60     /* Window handle type */
  61     int type;
  62
  63     /* Window position hint */
  64     int x;
  65     int y;
  66
  67     /* Windows size int */
  68     int width;
  69     int height;
  70
  71 } vout_window_cfg_t;
  72
  73 /**
  74  * FIXME do we need an event system in the window too ?
  75  * or the window user will take care of it ?
  76  */
  77 struct vout_window_t {
  78     VLC_COMMON_MEMBERS
  79
  80     /* Module */
  81     module_t *module;
  82
  83     /* Initial state (reserved).
  84      * Once the open function is called, it will be set to NULL
  85      */
  86     const vout_window_cfg_t *cfg;
  87
  88     /* window handle (mandatory)
  89      *
  90      * It must be filled in the open function.
  91      */
  92     union {
  93         void     *hwnd;   /* Win32 window handle */
  94         uint32_t xid;     /* X11 windows ID */
  95     } handle;
  96
  97     /* Control on the module (mandatory)
  98      *
  99      * Do not use it directly but use vout_window_Control.
 100      */
 101     int (*control)(vout_window_t *, int query, va_list);
 102
 103     /* Private place holder for the vout_window_t module (optional)
 104      *
 105      * A module is free to used it as it wishes.
 106      */
 107     vout_window_sys_t *sys;
 108 };
 109
 110 /**
 111  * It creates a new window.
 112  *
 113  * XXX If you are inside a "vout display", you must use
 114  * vout_display_New/DeleteWindow when possible to allow window recycling.
 115  */
 116 VLC_EXPORT( vout_window_t *, vout_window_New, (vlc_object_t *, const char *module, const vout_window_cfg_t *) );
 117
 118 /**
 119  * It deletes a window created by vout_window_New.
 120  *
 121  * XXX See vout_window_New about window recycling.
 122  */
 123 VLC_EXPORT( void, vout_window_Delete, (vout_window_t *) );
 124
 125 /**
 126  * It allows configuring a window.
 127  *
 128  * XXX you must own the windows, and vout_window_t are not thread safe.
 129  * You must not use it directly but prefer the vout_window_* wrappers.
 130  */
 131 VLC_EXPORT( int, vout_window_Control, (vout_window_t *, int query, ...) );
 132
 133 /**
 134  * Configure the "On Top" properties of a windows.
 135  */
 136 static inline int vout_window_SetOnTop(vout_window_t *window, bool is_on_top)
 137 {
 138     return vout_window_Control(window, VOUT_WINDOW_SET_ON_TOP, is_on_top);
 139 }
 140
 141 /**
 142  * Configure the windows display size.
 143  */
 144 static inline int vout_window_SetSize(vout_window_t *window, int width, int height)
 145 {
 146     return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height);
 147 }
 148
 149 #endif /* VLC_VOUT_WINDOW_H */
 150