1 /*****************************************************************************
2 * vlc_vout_display.h: vout_display_t definitions
3 *****************************************************************************
4 * Copyright (C) 2009 Laurent Aimar
7 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #ifndef VLC_VOUT_DISPLAY_H
25 #define VLC_VOUT_DISPLAY_H 1
29 * This file defines vout display structures and functions in vlc
33 #include <vlc_picture.h>
34 #include <vlc_subpicture.h>
36 #include <vlc_mouse.h>
37 #include <vlc_vout_window.h>
40 * Do NOT use video_format_t::i_aspect but i_sar_num/den everywhere. i_aspect
41 * will be removed as soon as possible.
44 typedef struct vout_display_t vout_display_t;
45 typedef struct vout_display_sys_t vout_display_sys_t;
46 typedef struct vout_display_owner_t vout_display_owner_t;
47 typedef struct vout_display_owner_sys_t vout_display_owner_sys_t;
50 * Possible alignments for vout_display.
54 VOUT_DISPLAY_ALIGN_CENTER,
56 VOUT_DISPLAY_ALIGN_LEFT,
57 VOUT_DISPLAY_ALIGN_RIGHT,
59 VOUT_DISPLAY_ALIGN_TOP,
60 VOUT_DISPLAY_ALIGN_BOTTOM,
61 } vout_display_align_t;
64 * Initial/Current configuration for a vout_display_t
67 bool is_fullscreen; /* Is the display fullscreen */
69 /* Display properties */
71 /* Window title (may be NULL) */
85 /* Alignment of the picture inside the display */
91 /* Do we fill up the display with the video */
92 bool is_display_filled;
95 * It will be applied to the whole display if b_display_filled is set, otherwise
96 * only on the video source */
102 } vout_display_cfg_t;
105 * Informations from a vout_display_t to configure
106 * the core behaviour.
108 * By default they are all false.
112 bool is_slow; /* The picture memory has slow read/write */
113 bool has_double_click; /* Is double-click generated */
114 bool has_hide_mouse; /* Is mouse automatically hidden */
115 bool has_pictures_invalid;/* Will VOUT_DISPLAY_EVENT_PICTURES_INVALID be used */
116 } vout_display_info_t;
119 * Control query for vout_display_t
122 /* Hide the mouse. It will be sent when
123 * vout_display_t::info.b_hide_mouse is false */
124 VOUT_DISPLAY_HIDE_MOUSE,
126 /* Ask to reset the internal buffers after a VOUT_DISPLAY_EVENT_PICTURES_INVALID
129 VOUT_DISPLAY_RESET_PICTURES,
131 /* Ask the module to acknowledge/refuse the fullscreen state change after
132 * being requested (externally or by VOUT_DISPLAY_EVENT_FULLSCREEN */
133 VOUT_DISPLAY_CHANGE_FULLSCREEN, /* const vout_display_cfg_t *p_cfg */
135 /* Ask the module to acknowledge/refuse the "always on top" state change
136 * after being requested externally */
137 VOUT_DISPLAY_CHANGE_ON_TOP, /* int b_on_top */
139 /* Ask the module to acknowledge/refuse the display size change requested
140 * (externally or by VOUT_DISPLAY_EVENT_DISPLAY_SIZE) */
141 VOUT_DISPLAY_CHANGE_DISPLAY_SIZE, /* const vout_display_cfg_t *p_cfg */
143 /* Ask the module to acknowledge/refuse fill display state change after
144 * being requested externally */
145 VOUT_DISPLAY_CHANGE_DISPLAY_FILLED, /* const vout_display_cfg_t *p_cfg */
147 /* Ask the module to acknowledge/refuse zoom change after being requested
149 VOUT_DISPLAY_CHANGE_ZOOM, /* const vout_display_cfg_t *p_cfg */
151 /* Ask the module to acknowledge/refuse source aspect ratio after being
152 * requested externally */
153 VOUT_DISPLAY_CHANGE_SOURCE_ASPECT, /* const video_format_t *p_source */
155 /* Ask the module to acknowledge/refuse source crop change after being
156 * requested externally.
157 * The cropping requested is stored by video_format_t::i_x/y_offset and
158 * video_format_t::i_visible_width/height */
159 VOUT_DISPLAY_CHANGE_SOURCE_CROP, /* const video_format_t *p_source */
163 * Event from vout_display_t
165 * Events modifiying the state may be sent multiple times.
166 * Only the transition will be retained and acted upon.
170 * ZOOM ? DISPLAY_FILLED ? ON_TOP ?
173 VOUT_DISPLAY_EVENT_PICTURES_INVALID, /* The buffer are now invalid and need to be changed */
175 VOUT_DISPLAY_EVENT_FULLSCREEN,
177 VOUT_DISPLAY_EVENT_DISPLAY_SIZE, /* The display size need to change : int i_width, int i_height */
180 VOUT_DISPLAY_EVENT_CLOSE,
181 VOUT_DISPLAY_EVENT_KEY,
184 * You can use it OR use the other mouse events. The core will do
187 VOUT_DISPLAY_EVENT_MOUSE_STATE,
190 VOUT_DISPLAY_EVENT_MOUSE_MOVED,
191 VOUT_DISPLAY_EVENT_MOUSE_PRESSED,
192 VOUT_DISPLAY_EVENT_MOUSE_RELEASED,
193 VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK,
197 * Vout owner structures
199 struct vout_display_owner_t {
200 /* Private place holder for the vout_display_t creator
202 vout_display_owner_sys_t *sys;
204 /* Event coming from the module
206 * This function is set prior to the module instantiation and must not
207 * be overwritten nor used directly (use the vout_display_SendEvent*
210 * You can send it at any time i.e. from any vout_display_t functions
211 * (TODO add support from a private thread).
213 void (*event)(vout_display_t *, int, va_list);
217 * These functions are set prior to the module instantiation and must not
218 * be overwritten nor used directly (use the vout_display_*Window
220 vout_window_t *(*window_new)(vout_display_t *, const vout_window_cfg_t *);
221 void (*window_del)(vout_display_t *, vout_window_t *);
224 struct vout_display_t {
230 /* Initial and current configuration.
231 * You cannot modify it directly, you must use the appropriate events.
233 * It reflects the current values, i.e. after the event has been accepted
234 * and applied/configured if needed.
236 const vout_display_cfg_t *cfg;
238 /* video source format.
240 * Cropping is not requested while in the open function.
241 * You cannot change it.
243 video_format_t source;
247 * You can only change it inside the module open function to
248 * match what you want, and when a VOUT_DISPLAY_RESET_PICTURES control
249 * request is made and succeeds.
251 * By default, it is equal to ::source except for the aspect ratio
252 * which is undefined(0) and is ignored.
258 * You can only set them in the open function.
260 vout_display_info_t info;
262 /* Return a new picture_t (mandatory).
264 * You can return NULL when you cannot/do not want to allocate
266 * If you want to create a pool of reusable pictures, you can
267 * use a picture_pool_t.
269 picture_t *(*get)(vout_display_t *);
271 /* Prepare a picture for display (optional).
273 * It is called before the next pf_display call to provide as much
274 * time as possible to prepare the given picture for display.
275 * You are guaranted that pf_display will always be called and using
276 * the exact same picture_t.
277 * You cannot change the pixel content of the picture_t.
279 void (*prepare)(vout_display_t *, picture_t *);
281 /* Display a picture (mandatory).
283 * The picture must be displayed as soon as possible.
284 * You cannot change the pixel content of the picture_t.
286 * This function gives away the ownership of the picture, so you must
287 * release it as soon as possible.
289 void (*display)(vout_display_t *, picture_t *);
291 /* Control on the module (mandatory) */
292 int (*control)(vout_display_t *, int, va_list);
294 /* Manage pending event (mandatory for now) */
295 void (*manage)(vout_display_t *);
297 /* Private place holder for the vout_display_t module (optional)
299 * A module is free to use it as it wishes.
301 vout_display_sys_t *sys;
303 /* Reserved for the vout_display_t owner.
305 * It must not be overwritten nor used directly by a module.
307 vout_display_owner_t owner;
310 static inline void vout_display_SendEvent(vout_display_t *vd, int query, ...)
313 va_start(args, query);
314 vd->owner.event(vd, query, args);
318 static inline void vout_display_SendEventDisplaySize(vout_display_t *vd, int width, int height)
320 vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_DISPLAY_SIZE, width, height);
322 static inline void vout_display_SendEventPicturesInvalid(vout_display_t *vd)
324 vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_PICTURES_INVALID);
326 static inline void vout_display_SendEventClose(vout_display_t *vd)
328 vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_CLOSE);
330 static inline void vout_display_SendEventKey(vout_display_t *vd, int key)
332 vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_KEY, key);
334 static inline void vout_display_SendEventFullscreen(vout_display_t *vd, bool is_fullscreen)
336 vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_FULLSCREEN, is_fullscreen);
338 /* The mouse position (State and Moved event) must be expressed against vout_display_t::source unit */
339 static inline void vout_display_SendEventMouseState(vout_display_t *vd, int x, int y, int button_mask)
341 vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_STATE, x, y, button_mask);
343 static inline void vout_display_SendEventMouseMoved(vout_display_t *vd, int x, int y)
345 vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_MOVED, x, y);
347 static inline void vout_display_SendEventMousePressed(vout_display_t *vd, int button)
349 vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_PRESSED, button);
351 static inline void vout_display_SendEventMouseReleased(vout_display_t *vd, int button)
353 vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_RELEASED, button);
355 static inline void vout_display_SendEventMouseDoubleClick(vout_display_t *vd)
357 vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK);
361 * Asks for a new window with the given configuration as hint.
363 * b_standalone/i_x/i_y may be overwritten by the core
365 static inline vout_window_t *vout_display_NewWindow(vout_display_t *vd, const vout_window_cfg_t *cfg)
367 return vd->owner.window_new(vd, cfg);
369 static inline void vout_display_DeleteWindow(vout_display_t *vd,
370 vout_window_t *window)
372 vd->owner.window_del(vd, window);
376 * Computes the default display size given the source and
377 * the display configuration.
379 * This asssumes that the picture is already cropped.
381 VLC_EXPORT( void, vout_display_GetDefaultDisplaySize, (unsigned *width, unsigned *height, const video_format_t *source, const vout_display_cfg_t *) );
385 * Structure used to store the result of a vout_display_PlacePicture.
392 } vout_display_place_t;
395 * Computes how to place a picture inside the display to respect
396 * the given parameters.
397 * This assumes that cropping is done by an external mean.
399 * \param p_place Place inside the window (window pixel unit)
400 * \param p_source Video source format
401 * \param p_cfg Display configuration
402 * \param b_clip If true, prevent the video to go outside the display (break zoom).
404 VLC_EXPORT( void, vout_display_PlacePicture, (vout_display_place_t *place, const video_format_t *source, const vout_display_cfg_t *cfg, bool do_clipping) );
406 #endif /* VLC_VOUT_DISPLAY_H */