vlc_vout_window.h 4.52 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
/*****************************************************************************
 * 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>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU 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.
 *****************************************************************************/

#ifndef VLC_VOUT_WINDOW_H
#define VLC_VOUT_WINDOW_H 1

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

#include <vlc_common.h>

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


/**
 * Window handle type
 */
enum {
44
    VOUT_WINDOW_TYPE_XID,
45
    VOUT_WINDOW_TYPE_HWND,
46
    VOUT_WINDOW_TYPE_NSOBJECT,
47 48
};

49 50 51 52 53 54
#if defined (WIN32)
# define VOUT_WINDOW_TYPE_NATIVE VOUT_WINDOW_TYPE_HWND
#elif defined (__unix__)
# define VOUT_WINDOW_TYPE_NATIVE VOUT_WINDOW_TYPE_XID
#endif

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 69 70 71 72 73 74
};

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

    /* Window handle type */
    int type;

    /* 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 88 89 90 91 92

} 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

    /* window handle (mandatory)
     *
     * It must be filled in the open function.
     */
    union {
93 94 95
        void     *hwnd;     /* Win32 window handle */
        uint32_t xid;       /* X11 windows ID */
        void     *nsobject; /* Mac OSX view object */
96
    } handle;
97

98 99
    /* display server (mandatory) */
    union {
100 101
        char     *x11; /* X11 display (NULL = use default) */
    } display;
102

103 104
    /* Control on the module (mandatory)
     *
105
     * Do not use it directly; use vout_window_Control instead.
106 107 108 109 110
     */
    int (*control)(vout_window_t *, int query, va_list);

    /* Private place holder for the vout_window_t module (optional)
     *
111
     * A module is free to use it as it wishes.
112 113 114 115 116
     */
    vout_window_sys_t *sys;
};

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

/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
127
 * Deletes a window created by vout_window_New().
128
 *
129
 * @note See vout_window_New() about window recycling.
130
 */
131
VLC_API void vout_window_Delete(vout_window_t *);
132

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
133

134
/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
135 136 137
 * Reconfigures a window.
 *
 * @note The vout_window_* wrappers should be used instead of this function.
138
 *
139
 * @warning The caller must own the window, as vout_window_t is not thread safe.
140
 */
141
VLC_API int vout_window_Control(vout_window_t *, int query, ...);
142 143

/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
144
 * Configures the window manager state for this window.
145
 */
146
static inline int vout_window_SetState(vout_window_t *window, unsigned state)
147
{
148
    return vout_window_Control(window, VOUT_WINDOW_SET_STATE, state);
149 150 151
}

/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
152
 * Configures the window display (i.e. inner/useful) size.
153
 */
154 155
static inline int vout_window_SetSize(vout_window_t *window,
                                      unsigned width, unsigned height)
156 157 158 159
{
    return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height);
}

160
/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
161
 * Sets fullscreen mode.
162 163 164 165 166 167
 */
static inline int vout_window_SetFullScreen(vout_window_t *window, bool full)
{
    return vout_window_Control(window, VOUT_WINDOW_SET_FULLSCREEN, full);
}

168
#endif /* VLC_VOUT_WINDOW_H */