X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_vout_display.h;h=503f92db13b46b212b32b24095ff674fa76200fa;hb=6fad8bffb1cdfe90c495eb19cc680f4120ecc657;hp=aa739aa1ac835247143e2e47eb681577c580aed4;hpb=1329ce1e1cf65d99ac6a3f1cc4ccd3d0da42d010;p=vlc diff --git a/include/vlc_vout_display.h b/include/vlc_vout_display.h index aa739aa1ac..503f92db13 100644 --- a/include/vlc_vout_display.h +++ b/include/vlc_vout_display.h @@ -31,6 +31,7 @@ #include #include +#include #include #include #include @@ -60,6 +61,16 @@ typedef enum VOUT_DISPLAY_ALIGN_BOTTOM, } vout_display_align_t; +/** + * Window management state. + */ +enum { + VOUT_WINDOW_STATE_NORMAL=0, + VOUT_WINDOW_STATE_ABOVE=1, + VOUT_WINDOW_STATE_BELOW=2, + VOUT_WINDOW_STACK_MASK=3, +}; + /** * Initial/Current configuration for a vout_display_t */ @@ -72,13 +83,13 @@ typedef struct { const char *title; /* Display size */ - int width; - int height; + unsigned width; + unsigned height; /* Display SAR */ struct { - int num; - int den; + unsigned num; + unsigned den; } sar; } display; @@ -102,7 +113,7 @@ typedef struct { } vout_display_cfg_t; /** - * Informations from a vout_display_t to configure + * Information from a vout_display_t to configure * the core behaviour. * * By default they are all false. @@ -113,6 +124,7 @@ typedef struct { bool has_double_click; /* Is double-click generated */ bool has_hide_mouse; /* Is mouse automatically hidden */ bool has_pictures_invalid;/* Will VOUT_DISPLAY_EVENT_PICTURES_INVALID be used */ + bool has_event_thread; /* Will events (key at least) be emitted using an independent thread */ } vout_display_info_t; /** @@ -132,13 +144,13 @@ enum { * being requested (externally or by VOUT_DISPLAY_EVENT_FULLSCREEN */ VOUT_DISPLAY_CHANGE_FULLSCREEN, /* const vout_display_cfg_t *p_cfg */ - /* Ask the module to acknowledge/refuse the "always on top" state change - * after being requested externally */ - VOUT_DISPLAY_CHANGE_ON_TOP, /* int b_on_top */ + /* Ask the module to acknowledge/refuse the window management state change + * after being requested externally or by VOUT_DISPLAY_WINDOW_STATE */ + VOUT_DISPLAY_CHANGE_WINDOW_STATE, /* unsigned state */ /* Ask the module to acknowledge/refuse the display size change requested * (externally or by VOUT_DISPLAY_EVENT_DISPLAY_SIZE) */ - VOUT_DISPLAY_CHANGE_DISPLAY_SIZE, /* const vout_display_cfg_t *p_cfg */ + VOUT_DISPLAY_CHANGE_DISPLAY_SIZE, /* const vout_display_cfg_t *p_cfg, int is_forced */ /* Ask the module to acknowledge/refuse fill display state change after * being requested externally */ @@ -157,6 +169,9 @@ enum { * The cropping requested is stored by video_format_t::i_x/y_offset and * video_format_t::i_visible_width/height */ VOUT_DISPLAY_CHANGE_SOURCE_CROP, /* const video_format_t *p_source */ + + /* Ask an opengl interface if available. */ + VOUT_DISPLAY_GET_OPENGL, /* vout_opengl_t ** */ }; /** @@ -173,8 +188,9 @@ enum { VOUT_DISPLAY_EVENT_PICTURES_INVALID, /* The buffer are now invalid and need to be changed */ VOUT_DISPLAY_EVENT_FULLSCREEN, + VOUT_DISPLAY_EVENT_WINDOW_STATE, - VOUT_DISPLAY_EVENT_DISPLAY_SIZE, /* The display size need to change : int i_width, int i_height */ + VOUT_DISPLAY_EVENT_DISPLAY_SIZE, /* The display size need to change : int i_width, int i_height, bool is_fullscreen */ /* */ VOUT_DISPLAY_EVENT_CLOSE, @@ -207,8 +223,10 @@ struct vout_display_owner_t { * be overwritten nor used directly (use the vout_display_SendEvent* * wrapper. * - * You can send it at any time i.e. from any vout_display_t functions - * (TODO add support from a private thread). + * You can send it at any time i.e. from any vout_display_t functions or + * from another thread. + * Be careful, it does not ensure correct serialization if it is used + * from multiple threads. */ void (*event)(vout_display_t *, int, va_list); @@ -253,20 +271,22 @@ struct vout_display_t { */ video_format_t fmt; - /* Informations + /* Information * * You can only set them in the open function. */ vout_display_info_t info; - /* Return a new picture_t (mandatory). + /* Return a pointer over the current picture_pool_t* (mandatory). * + * For performance reasons, it is best to provide at least count + * pictures but it is not mandatory. * You can return NULL when you cannot/do not want to allocate - * more pictures. - * If you want to create a pool of reusable pictures, you can - * use a picture_pool_t. + * pictures. + * The vout display module keeps the ownership of the pool and can + * destroy it only when closing or on invalid pictures control. */ - picture_t *(*get)(vout_display_t *); + picture_pool_t *(*pool)(vout_display_t *, unsigned count); /* Prepare a picture for display (optional). * @@ -291,7 +311,7 @@ struct vout_display_t { /* Control on the module (mandatory) */ int (*control)(vout_display_t *, int, va_list); - /* Manage pending event (mandatory for now) */ + /* Manage pending event (optional) */ void (*manage)(vout_display_t *); /* Private place holder for the vout_display_t module (optional) @@ -315,9 +335,9 @@ static inline void vout_display_SendEvent(vout_display_t *vd, int query, ...) va_end(args); } -static inline void vout_display_SendEventDisplaySize(vout_display_t *vd, int width, int height) +static inline void vout_display_SendEventDisplaySize(vout_display_t *vd, int width, int height, bool is_fullscreen) { - vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_DISPLAY_SIZE, width, height); + vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_DISPLAY_SIZE, width, height, is_fullscreen); } static inline void vout_display_SendEventPicturesInvalid(vout_display_t *vd) { @@ -335,6 +355,10 @@ static inline void vout_display_SendEventFullscreen(vout_display_t *vd, bool is_ { vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_FULLSCREEN, is_fullscreen); } +static inline void vout_display_SendWindowState(vout_display_t *vd, unsigned state) +{ + vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_WINDOW_STATE, state); +} /* The mouse position (State and Moved event) must be expressed against vout_display_t::source unit */ static inline void vout_display_SendEventMouseState(vout_display_t *vd, int x, int y, int button_mask) { @@ -366,6 +390,10 @@ static inline vout_window_t *vout_display_NewWindow(vout_display_t *vd, const vo { return vd->owner.window_new(vd, cfg); } +/** + * Deletes a window created by vout_display_NewWindow if window is non NULL + * or any unused windows otherwise. + */ static inline void vout_display_DeleteWindow(vout_display_t *vd, vout_window_t *window) { @@ -378,7 +406,7 @@ static inline void vout_display_DeleteWindow(vout_display_t *vd, * * This asssumes that the picture is already cropped. */ -VLC_EXPORT( void, vout_display_GetDefaultDisplaySize, (int *width, int *height, const video_format_t *source, const vout_display_cfg_t *) ); +VLC_EXPORT( void, vout_display_GetDefaultDisplaySize, (unsigned *width, unsigned *height, const video_format_t *source, const vout_display_cfg_t *) ); /** @@ -387,8 +415,8 @@ VLC_EXPORT( void, vout_display_GetDefaultDisplaySize, (int *width, int *height, typedef struct { int x; int y; - int width; - int height; + unsigned width; + unsigned height; } vout_display_place_t; /**