vlc_vout_window.h 4.37 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 46 47 48 49 50 51
    VOUT_WINDOW_TYPE_HWND,
};

/**
 * Control query for vout_window_t
 */
enum {
52
    VOUT_WINDOW_SET_STATE, /* unsigned state */
53 54
    VOUT_WINDOW_SET_SIZE,   /* unsigned i_width, unsigned i_height */
    VOUT_WINDOW_SET_FULLSCREEN, /* int b_fullscreen */
55 56 57 58 59 60 61 62 63 64 65 66 67
};

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

    /* Window handle type */
    int type;

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

68 69 70
    /* Windows size hint */
    unsigned width;
    unsigned height;
71 72 73 74 75 76 77 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

    /* Initial state (reserved).
     * Once the open function is called, it will be set to NULL
     */
    const vout_window_cfg_t *cfg;

    /* window handle (mandatory)
     *
     * It must be filled in the open function.
     */
    union {
        void     *hwnd;   /* Win32 window handle */
        uint32_t xid;     /* X11 windows ID */
93
    } handle;
94

95 96
    /* display server (mandatory) */
    union {
97 98
        char     *x11; /* X11 display (NULL = use default) */
    } display;
99

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

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

/** 
 * It creates a new window.
 * 
116
 * @note If you are inside a "vout display", you must use
117 118 119 120 121
 * vout_display_New/DeleteWindow when possible to allow window recycling.
 */
VLC_EXPORT( vout_window_t *, vout_window_New, (vlc_object_t *, const char *module, const vout_window_cfg_t *) );

/**
122
 * It deletes a window created by vout_window_New().
123
 *
124
 * @note See vout_window_New() about window recycling.
125 126 127 128 129 130
 */
VLC_EXPORT( void, vout_window_Delete, (vout_window_t *) );

/**
 * It allows configuring a window.
 *
131 132
 * @warning The caller must own the window, as vout_window_t is not thread safe.
 * You should use it the vout_window_* wrappers instead of this function.
133 134 135 136
 */
VLC_EXPORT( int, vout_window_Control, (vout_window_t *, int query, ...) );

/**
137
 * Configure the window management state of a windows.
138
 */
139
static inline int vout_window_SetState(vout_window_t *window, unsigned state)
140
{
141
    return vout_window_Control(window, VOUT_WINDOW_SET_STATE, state);
142 143 144 145 146
}

/**
 * Configure the windows display size.
 */
147 148
static inline int vout_window_SetSize(vout_window_t *window,
                                      unsigned width, unsigned height)
149 150 151 152
{
    return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height);
}

153 154 155 156 157 158 159 160
/**
 * Configure the windows fullscreen mode.
 */
static inline int vout_window_SetFullScreen(vout_window_t *window, bool full)
{
    return vout_window_Control(window, VOUT_WINDOW_SET_FULLSCREEN, full);
}

161 162
#endif /* VLC_VOUT_WINDOW_H */