vlc_vout_window.h 4.96 KB
Newer Older
1 2 3 4 5 6 7 8 9
/*****************************************************************************
 * vlc_vout_window.h: vout_window_t definitions
 *****************************************************************************
 * Copyright (C) 2008 Rémi Denis-Courmont
 * Copyright (C) 2009 Laurent Aimar
 * $Id$
 *
 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
10 11 12
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
13 14 15 16
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
19
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
20 21 22
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24 25 26 27 28 29 30 31 32
 *****************************************************************************/

#ifndef VLC_VOUT_WINDOW_H
#define VLC_VOUT_WINDOW_H 1

/**
 * \file
 * This file defines vout windows structures and functions in vlc
 */

33
#include <stdarg.h>
34 35 36 37 38 39
#include <vlc_common.h>

/* */
typedef struct vout_window_t vout_window_t;
typedef struct vout_window_sys_t vout_window_sys_t;

40 41
struct wl_display;
struct wl_surface;
42 43 44 45 46

/**
 * Window handle type
 */
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 57 58
};

/**
 * Control query for vout_window_t
 */
enum {
59
    VOUT_WINDOW_SET_STATE, /* unsigned state */
60 61
    VOUT_WINDOW_SET_SIZE,   /* unsigned i_width, unsigned i_height */
    VOUT_WINDOW_SET_FULLSCREEN, /* int b_fullscreen */
62 63 64 65 66 67 68
};

typedef struct {
    /* If true, a standalone window is requested */
    bool is_standalone;

    /* Window handle type */
69
    unsigned type;
70 71 72 73 74

    /* Window position hint */
    int x;
    int y;

75 76 77
    /* Windows size hint */
    unsigned width;
    unsigned height;
78 79 80 81 82 83 84 85 86 87

} vout_window_cfg_t;

/**
 * FIXME do we need an event system in the window too ?
 * or the window user will take care of it ?
 */
struct vout_window_t {
    VLC_COMMON_MEMBERS

88 89
    unsigned type; /**< Window handle type */

90 91 92 93 94
    /* window handle (mandatory)
     *
     * It must be filled in the open function.
     */
    union {
95 96 97 98
        void     *hwnd;          /* Win32 window handle */
        uint32_t xid;            /* X11 windows ID */
        void     *nsobject;      /* Mac OSX view object */
        void     *anativewindow; /* Android native window. */
99
        struct wl_surface *wl;   /* Wayland surface */
100
    } handle;
101

102 103
    /* display server (mandatory) */
    union {
104
        char     *x11; /* X11 display (NULL = use default) */
105
        struct wl_display *wl;   /* Wayland struct wl_display pointer */
106
    } display;
107

108 109
    /* Control on the module (mandatory)
     *
110
     * Do not use it directly; use vout_window_Control instead.
111 112 113 114 115
     */
    int (*control)(vout_window_t *, int query, va_list);

    /* Private place holder for the vout_window_t module (optional)
     *
116
     * A module is free to use it as it wishes.
117 118 119 120
     */
    vout_window_sys_t *sys;
};

121
/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
122 123 124
 * Creates a new window.
 *
 * @param module plugin name (usually "$window")
125
 * @note If you are inside a "vout display", you must use
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
126 127
 / vout_display_NewWindow() and vout_display_DeleteWindow() instead.
 * This enables recycling windows.
128
 */
129
VLC_API vout_window_t * vout_window_New(vlc_object_t *, const char *module, const vout_window_cfg_t *);
130 131

/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
132
 * Deletes a window created by vout_window_New().
133
 *
134
 * @note See vout_window_New() about window recycling.
135
 */
136
VLC_API void vout_window_Delete(vout_window_t *);
137

138 139 140 141 142
static inline int vout_window_vaControl(vout_window_t *window, int query,
                                        va_list ap)
{
    return window->control(window, query, ap);
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
143

144
/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
145 146 147
 * Reconfigures a window.
 *
 * @note The vout_window_* wrappers should be used instead of this function.
148
 *
149
 * @warning The caller must own the window, as vout_window_t is not thread safe.
150
 */
151
VLC_API int vout_window_Control(vout_window_t *, int query, ...);
152 153

/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
154
 * Configures the window manager state for this window.
155
 */
156
static inline int vout_window_SetState(vout_window_t *window, unsigned state)
157
{
158
    return vout_window_Control(window, VOUT_WINDOW_SET_STATE, state);
159 160 161
}

/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
162
 * Configures the window display (i.e. inner/useful) size.
163
 */
164 165
static inline int vout_window_SetSize(vout_window_t *window,
                                      unsigned width, unsigned height)
166 167 168 169
{
    return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height);
}

170
/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
171
 * Sets fullscreen mode.
172 173 174 175 176 177
 */
static inline int vout_window_SetFullScreen(vout_window_t *window, bool full)
{
    return vout_window_Control(window, VOUT_WINDOW_SET_FULLSCREEN, full);
}

178
#endif /* VLC_VOUT_WINDOW_H */