*
* 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
+ * 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
* (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.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser 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.
+ * 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.
*****************************************************************************/
#ifndef VLC_VOUT_WINDOW_H
* This file defines vout windows structures and functions in vlc
*/
+#include <stdarg.h>
#include <vlc_common.h>
/* */
typedef struct vout_window_t vout_window_t;
typedef struct vout_window_sys_t vout_window_sys_t;
+struct wl_display;
+struct wl_surface;
/**
* Window handle type
*/
enum {
+ VOUT_WINDOW_TYPE_INVALID=0,
VOUT_WINDOW_TYPE_XID,
VOUT_WINDOW_TYPE_HWND,
+ VOUT_WINDOW_TYPE_NSOBJECT,
+ VOUT_WINDOW_TYPE_ANDROID_NATIVE,
+ VOUT_WINDOW_TYPE_WAYLAND,
};
/**
VOUT_WINDOW_SET_FULLSCREEN, /* int b_fullscreen */
};
-typedef struct {
+typedef struct vout_window_cfg_t {
/* If true, a standalone window is requested */
bool is_standalone;
/* Window handle type */
- int type;
+ unsigned type;
+#ifdef __APPLE__
/* Window position hint */
int x;
int y;
+#endif
/* Windows size hint */
unsigned width;
} vout_window_cfg_t;
+typedef struct vout_window_owner {
+ void *sys;
+ void (*resized)(vout_window_t *, unsigned width, unsigned height);
+ void (*closed)(vout_window_t *);
+} vout_window_owner_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;
+ unsigned type; /**< Window handle type */
/* window handle (mandatory)
*
* It must be filled in the open function.
*/
union {
- void *hwnd; /* Win32 window handle */
- uint32_t xid; /* X11 windows ID */
+ void *hwnd; /* Win32 window handle */
+ uint32_t xid; /* X11 windows ID */
+ void *nsobject; /* Mac OSX view object */
+ void *anativewindow; /* Android native window. */
+ struct wl_surface *wl; /* Wayland surface */
} handle;
/* display server (mandatory) */
union {
- char *x11_display; /* X11 display (NULL = use default) */
- };
+ char *x11; /* X11 display (NULL = use default) */
+ struct wl_display *wl; /* Wayland struct wl_display pointer */
+ } display;
/* Control on the module (mandatory)
*
* A module is free to use it as it wishes.
*/
vout_window_sys_t *sys;
+
+ vout_window_owner_t owner;
};
-/**
- * It creates a new window.
- *
+/**
+ * Creates a new window.
+ *
+ * @param module plugin name (usually "$window")
* @note If you are inside a "vout display", you must use
- * vout_display_New/DeleteWindow when possible to allow window recycling.
+ / vout_display_NewWindow() and vout_display_DeleteWindow() instead.
+ * This enables recycling windows.
*/
-VLC_EXPORT( vout_window_t *, vout_window_New, (vlc_object_t *, const char *module, const vout_window_cfg_t *) );
+VLC_API vout_window_t * vout_window_New(vlc_object_t *, const char *module, const vout_window_cfg_t *, const vout_window_owner_t *);
/**
- * It deletes a window created by vout_window_New().
+ * Deletes a window created by vout_window_New().
*
* @note See vout_window_New() about window recycling.
*/
-VLC_EXPORT( void, vout_window_Delete, (vout_window_t *) );
+VLC_API void vout_window_Delete(vout_window_t *);
+
+static inline int vout_window_vaControl(vout_window_t *window, int query,
+ va_list ap)
+{
+ return window->control(window, query, ap);
+}
/**
- * It allows configuring a window.
+ * Reconfigures a window.
+ *
+ * @note The vout_window_* wrappers should be used instead of this function.
*
* @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.
*/
-VLC_EXPORT( int, vout_window_Control, (vout_window_t *, int query, ...) );
+static inline int vout_window_Control(vout_window_t *window, int query, ...)
+{
+ va_list ap;
+ int ret;
+
+ va_start(ap, query);
+ ret = vout_window_vaControl(window, query, ap);
+ va_end(ap);
+ return ret;
+}
/**
- * Configure the window management state of a windows.
+ * Configures the window manager state for this window.
*/
static inline int vout_window_SetState(vout_window_t *window, unsigned state)
{
}
/**
- * Configure the windows display size.
+ * Configures the window display (i.e. inner/useful) size.
*/
static inline int vout_window_SetSize(vout_window_t *window,
unsigned width, unsigned height)
}
/**
- * Configure the windows fullscreen mode.
+ * Sets fullscreen mode.
*/
static inline int vout_window_SetFullScreen(vout_window_t *window, bool full)
{
return vout_window_Control(window, VOUT_WINDOW_SET_FULLSCREEN, full);
}
-#endif /* VLC_VOUT_WINDOW_H */
+static inline void vout_window_ReportSize(vout_window_t *window,
+ unsigned width, unsigned height)
+{
+ if (window->owner.resized != NULL)
+ window->owner.resized(window, width, height);
+}
+static inline void vout_window_ReportClose(vout_window_t *window)
+{
+ if (window->owner.closed != NULL)
+ window->owner.closed(window);
+}
+
+#endif /* VLC_VOUT_WINDOW_H */
projects / vlc / blobdiff