include/vlc_vout_display.h

   1 /*****************************************************************************
   2  * vlc_vout_display.h: vout_display_t definitions
   3  *****************************************************************************
   4  * Copyright (C) 2009 Laurent Aimar
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_VOUT_DISPLAY_H
  25 #define VLC_VOUT_DISPLAY_H 1
  26
  27 #include <vlc_es.h>
  28 #include <vlc_picture.h>
  29 #include <vlc_picture_pool.h>
  30 #include <vlc_subpicture.h>
  31 #include <vlc_keys.h>
  32 #include <vlc_mouse.h>
  33 #include <vlc_vout_window.h>
  34
  35 /**
  36  * \defgroup video_display Video output display
  37  * Video output display: output buffers and rendering
  38  *
  39  * \ingroup video_output
  40  * @{
  41  * \file
  42  * Video output display modules interface
  43  */
  44
  45 /* XXX
  46  * Do NOT use video_format_t::i_aspect but i_sar_num/den everywhere. i_aspect
  47  * will be removed as soon as possible.
  48  *
  49  */
  50 typedef struct vout_display_t vout_display_t;
  51 typedef struct vout_display_sys_t vout_display_sys_t;
  52 typedef struct vout_display_owner_t vout_display_owner_t;
  53 typedef struct vout_display_owner_sys_t vout_display_owner_sys_t;
  54
  55 /**
  56  * Possible alignments for vout_display.
  57  */
  58 typedef enum
  59 {
  60     VOUT_DISPLAY_ALIGN_CENTER,
  61     /* */
  62     VOUT_DISPLAY_ALIGN_LEFT,
  63     VOUT_DISPLAY_ALIGN_RIGHT,
  64     /* */
  65     VOUT_DISPLAY_ALIGN_TOP,
  66     VOUT_DISPLAY_ALIGN_BOTTOM,
  67 } vout_display_align_t;
  68
  69 /**
  70  * Window management state.
  71  */
  72 enum {
  73     VOUT_WINDOW_STATE_NORMAL=0,
  74     VOUT_WINDOW_STATE_ABOVE=1,
  75     VOUT_WINDOW_STATE_BELOW=2,
  76     VOUT_WINDOW_STACK_MASK=3,
  77 };
  78
  79 /**
  80  * Initial/Current configuration for a vout_display_t
  81  */
  82 typedef struct {
  83     bool is_fullscreen;  /* Is the display fullscreen */
  84
  85     /* Display properties */
  86     struct {
  87         /* Window title (may be NULL) */
  88         const char *title;
  89
  90         /* Display size */
  91         unsigned  width;
  92         unsigned  height;
  93
  94         /* Display SAR */
  95         struct {
  96             unsigned num;
  97             unsigned den;
  98         } sar;
  99     } display;
 100
 101     /* Alignment of the picture inside the display */
 102     struct {
 103         int horizontal;
 104         int vertical;
 105     } align;
 106
 107     /* Do we fill up the display with the video */
 108     bool is_display_filled;
 109
 110     /* Zoom to use
 111      * It will be applied to the whole display if b_display_filled is set, otherwise
 112      * only on the video source */
 113     struct {
 114         int num;
 115         int den;
 116     } zoom;
 117
 118 } vout_display_cfg_t;
 119
 120 /**
 121  * Information from a vout_display_t to configure
 122  * the core behaviour.
 123  *
 124  * By default they are all false or NULL.
 125  *
 126  */
 127 typedef struct {
 128     bool is_slow;                           /* The picture memory has slow read/write */
 129     bool has_double_click;                  /* Is double-click generated */
 130     bool has_hide_mouse;                    /* Is mouse automatically hidden */
 131     bool has_pictures_invalid;              /* Will VOUT_DISPLAY_EVENT_PICTURES_INVALID be used */
 132     bool has_event_thread;                  /* Will events (key at least) be emitted using an independent thread */
 133     const vlc_fourcc_t *subpicture_chromas; /* List of supported chromas for subpicture rendering. */
 134 } vout_display_info_t;
 135
 136 /**
 137  * Control query for vout_display_t
 138  */
 139 enum {
 140     /* Hide the mouse. It will be sent when
 141      * vout_display_t::info.b_hide_mouse is false */
 142     VOUT_DISPLAY_HIDE_MOUSE,
 143
 144     /* Ask to reset the internal buffers after a VOUT_DISPLAY_EVENT_PICTURES_INVALID
 145      * request.
 146      */
 147     VOUT_DISPLAY_RESET_PICTURES,
 148
 149     /* Ask the module to acknowledge/refuse the fullscreen state change after
 150      * being requested (externally or by VOUT_DISPLAY_EVENT_FULLSCREEN */
 151     VOUT_DISPLAY_CHANGE_FULLSCREEN,     /* bool fs */
 152
 153     /* Ask the module to acknowledge/refuse the window management state change
 154      * after being requested externally or by VOUT_DISPLAY_WINDOW_STATE */
 155     VOUT_DISPLAY_CHANGE_WINDOW_STATE,         /* unsigned state */
 156
 157     /* Ask the module to acknowledge/refuse the display size change requested
 158      * (externally or by VOUT_DISPLAY_EVENT_DISPLAY_SIZE) */
 159     VOUT_DISPLAY_CHANGE_DISPLAY_SIZE,   /* const vout_display_cfg_t *p_cfg */
 160
 161     /* Ask the module to acknowledge/refuse fill display state change after
 162      * being requested externally */
 163     VOUT_DISPLAY_CHANGE_DISPLAY_FILLED, /* const vout_display_cfg_t *p_cfg */
 164
 165     /* Ask the module to acknowledge/refuse zoom change after being requested
 166      * externally */
 167     VOUT_DISPLAY_CHANGE_ZOOM, /* const vout_display_cfg_t *p_cfg */
 168
 169     /* Ask the module to acknowledge/refuse source aspect ratio after being
 170      * requested externally */
 171     VOUT_DISPLAY_CHANGE_SOURCE_ASPECT, /* const video_format_t *p_source */
 172
 173     /* Ask the module to acknowledge/refuse source crop change after being
 174      * requested externally.
 175      * The cropping requested is stored by video_format_t::i_x/y_offset and
 176      * video_format_t::i_visible_width/height */
 177     VOUT_DISPLAY_CHANGE_SOURCE_CROP,   /* const video_format_t *p_source */
 178 };
 179
 180 /**
 181  * Event from vout_display_t
 182  *
 183  * Events modifiying the state may be sent multiple times.
 184  * Only the transition will be retained and acted upon.
 185  */
 186 enum {
 187     /* TODO:
 188      * ZOOM ? DISPLAY_FILLED ? ON_TOP ?
 189      */
 190     /* */
 191     VOUT_DISPLAY_EVENT_PICTURES_INVALID,    /* The buffer are now invalid and need to be changed */
 192
 193     VOUT_DISPLAY_EVENT_FULLSCREEN,
 194 #if defined(_WIN32) || defined(__OS2__)
 195     VOUT_DISPLAY_EVENT_WINDOW_STATE,
 196 #endif
 197
 198     VOUT_DISPLAY_EVENT_DISPLAY_SIZE,        /* The display size need to change : int i_width, int i_height */
 199
 200     /* */
 201     VOUT_DISPLAY_EVENT_CLOSE,
 202     VOUT_DISPLAY_EVENT_KEY,
 203
 204     /* Full mouse state.
 205      * You can use it OR use the other mouse events. The core will do
 206      * the conversion.
 207      */
 208     VOUT_DISPLAY_EVENT_MOUSE_STATE,
 209
 210     /* Mouse event */
 211     VOUT_DISPLAY_EVENT_MOUSE_MOVED,
 212     VOUT_DISPLAY_EVENT_MOUSE_PRESSED,
 213     VOUT_DISPLAY_EVENT_MOUSE_RELEASED,
 214     VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK,
 215 };
 216
 217 /**
 218  * Vout owner structures
 219  */
 220 struct vout_display_owner_t {
 221     /* Private place holder for the vout_display_t creator
 222      */
 223     vout_display_owner_sys_t *sys;
 224
 225     /* Event coming from the module
 226      *
 227      * This function is set prior to the module instantiation and must not
 228      * be overwritten nor used directly (use the vout_display_SendEvent*
 229      * wrapper.
 230      *
 231      * You can send it at any time i.e. from any vout_display_t functions or
 232      * from another thread.
 233      * Be careful, it does not ensure correct serialization if it is used
 234      * from multiple threads.
 235      */
 236     void            (*event)(vout_display_t *, int, va_list);
 237
 238     /* Window management
 239      *
 240      * These functions are set prior to the module instantiation and must not
 241      * be overwritten nor used directly (use the vout_display_*Window
 242      * wrapper */
 243     vout_window_t *(*window_new)(vout_display_t *, unsigned type);
 244     void           (*window_del)(vout_display_t *, vout_window_t *);
 245 };
 246
 247 struct vout_display_t {
 248     VLC_COMMON_MEMBERS
 249
 250     /* Module */
 251     module_t *module;
 252
 253     /* Initial and current configuration.
 254      * You cannot modify it directly, you must use the appropriate events.
 255      *
 256      * It reflects the current values, i.e. after the event has been accepted
 257      * and applied/configured if needed.
 258      */
 259     const vout_display_cfg_t *cfg;
 260
 261     /* video source format.
 262      *
 263      * Cropping is not requested while in the open function.
 264      * You cannot change it.
 265      */
 266     video_format_t source;
 267
 268     /* picture_t format.
 269      *
 270      * You can only change it inside the module open function to
 271      * match what you want, and when a VOUT_DISPLAY_RESET_PICTURES control
 272      * request is made and succeeds.
 273      *
 274      * By default, it is equal to ::source except for the aspect ratio
 275      * which is undefined(0) and is ignored.
 276      */
 277     video_format_t fmt;
 278
 279     /* Information
 280      *
 281      * You can only set them in the open function.
 282      */
 283     vout_display_info_t info;
 284
 285     /* Return a pointer over the current picture_pool_t* (mandatory).
 286      *
 287      * For performance reasons, it is best to provide at least count
 288      * pictures but it is not mandatory.
 289      * You can return NULL when you cannot/do not want to allocate
 290      * pictures.
 291      * The vout display module keeps the ownership of the pool and can
 292      * destroy it only when closing or on invalid pictures control.
 293      */
 294     picture_pool_t *(*pool)(vout_display_t *, unsigned count);
 295
 296     /* Prepare a picture and an optional subpicture for display (optional).
 297      *
 298      * It is called before the next pf_display call to provide as much
 299      * time as possible to prepare the given picture and the subpicture
 300      * for display.
 301      * You are guaranted that pf_display will always be called and using
 302      * the exact same picture_t and subpicture_t.
 303      * You cannot change the pixel content of the picture_t or of the
 304      * subpicture_t.
 305      */
 306     void       (*prepare)(vout_display_t *, picture_t *, subpicture_t *);
 307
 308     /* Display a picture and an optional subpicture (mandatory).
 309      *
 310      * The picture and the optional subpicture must be displayed as soon as
 311      * possible.
 312      * You cannot change the pixel content of the picture_t or of the
 313      * subpicture_t.
 314      *
 315      * This function gives away the ownership of the picture and of the
 316      * subpicture, so you must release them as soon as possible.
 317      */
 318     void       (*display)(vout_display_t *, picture_t *, subpicture_t *);
 319
 320     /* Control on the module (mandatory) */
 321     int        (*control)(vout_display_t *, int, va_list);
 322
 323     /* Manage pending event (optional) */
 324     void       (*manage)(vout_display_t *);
 325
 326     /* Private place holder for the vout_display_t module (optional)
 327      *
 328      * A module is free to use it as it wishes.
 329      */
 330     vout_display_sys_t *sys;
 331
 332     /* Reserved for the vout_display_t owner.
 333      *
 334      * It must not be overwritten nor used directly by a module.
 335      */
 336     vout_display_owner_t owner;
 337 };
 338
 339 static inline void vout_display_SendEvent(vout_display_t *vd, int query, ...)
 340 {
 341     va_list args;
 342     va_start(args, query);
 343     vd->owner.event(vd, query, args);
 344     va_end(args);
 345 }
 346
 347 static inline void vout_display_SendEventDisplaySize(vout_display_t *vd, int width, int height)
 348 {
 349     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_DISPLAY_SIZE, width, height);
 350 }
 351 static inline void vout_display_SendEventPicturesInvalid(vout_display_t *vd)
 352 {
 353     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_PICTURES_INVALID);
 354 }
 355 static inline void vout_display_SendEventClose(vout_display_t *vd)
 356 {
 357     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_CLOSE);
 358 }
 359 static inline void vout_display_SendEventKey(vout_display_t *vd, int key)
 360 {
 361     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_KEY, key);
 362 }
 363 static inline void vout_display_SendEventFullscreen(vout_display_t *vd, bool is_fullscreen)
 364 {
 365     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_FULLSCREEN, is_fullscreen);
 366 }
 367 #if defined(_WIN32)
 368 static inline void vout_display_SendWindowState(vout_display_t *vd, unsigned state)
 369 {
 370     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_WINDOW_STATE, state);
 371 }
 372 #endif
 373 /* The mouse position (State and Moved event) must be expressed against vout_display_t::source unit */
 374 static inline void vout_display_SendEventMouseState(vout_display_t *vd, int x, int y, int button_mask)
 375 {
 376     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_STATE, x, y, button_mask);
 377 }
 378 static inline void vout_display_SendEventMouseMoved(vout_display_t *vd, int x, int y)
 379 {
 380     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_MOVED, x, y);
 381 }
 382 static inline void vout_display_SendEventMousePressed(vout_display_t *vd, int button)
 383 {
 384     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_PRESSED, button);
 385 }
 386 static inline void vout_display_SendEventMouseReleased(vout_display_t *vd, int button)
 387 {
 388     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_RELEASED, button);
 389 }
 390 static inline void vout_display_SendEventMouseDoubleClick(vout_display_t *vd)
 391 {
 392     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK);
 393 }
 394
 395 /**
 396  * Asks for a new window of a given type.
 397  */
 398 static inline vout_window_t *vout_display_NewWindow(vout_display_t *vd, unsigned type)
 399 {
 400     return vd->owner.window_new(vd, type);
 401 }
 402 /**
 403  * Deletes a window created by vout_display_NewWindow if window is non NULL
 404  * or any unused windows otherwise.
 405  */
 406 static inline void vout_display_DeleteWindow(vout_display_t *vd,
 407                                              vout_window_t *window)
 408 {
 409     vd->owner.window_del(vd, window);
 410 }
 411
 412 static inline bool vout_display_IsWindowed(vout_display_t *vd)
 413 {
 414     vout_window_t *window = vout_display_NewWindow(vd, VOUT_WINDOW_TYPE_INVALID);
 415     if (window != NULL)
 416         vout_display_DeleteWindow(vd, window);
 417     return window != NULL;
 418 }
 419
 420 /**
 421  * Computes the default display size given the source and
 422  * the display configuration.
 423  *
 424  * This asssumes that the picture is already cropped.
 425  */
 426 VLC_API void vout_display_GetDefaultDisplaySize(unsigned *width, unsigned *height, const video_format_t *source, const vout_display_cfg_t *);
 427
 428
 429 /**
 430  * Structure used to store the result of a vout_display_PlacePicture.
 431  */
 432 typedef struct {
 433     int x;
 434     int y;
 435     unsigned width;
 436     unsigned height;
 437 } vout_display_place_t;
 438
 439 /**
 440  * Computes how to place a picture inside the display to respect
 441  * the given parameters.
 442  * This assumes that cropping is done by an external mean.
 443  *
 444  * \param p_place Place inside the window (window pixel unit)
 445  * \param p_source Video source format
 446  * \param p_cfg Display configuration
 447  * \param b_clip If true, prevent the video to go outside the display (break zoom).
 448  */
 449 VLC_API void vout_display_PlacePicture(vout_display_place_t *place, const video_format_t *source, const vout_display_cfg_t *cfg, bool do_clipping);
 450
 451
 452 /**
 453  * Helper function that applies the necessary transforms to the mouse position
 454  * and then calls vout_display_SendEventMouseMoved.
 455  *
 456  * \param vd vout_display_t.
 457  * \param orient_display The orientation of the picture as seen on screen (probably ORIENT_NORMAL).
 458  * \param m_x Mouse x position (relative to place, origin is top left).
 459  * \param m_y Mouse y position (relative to place, origin is top left).
 460  * \param place Place of the picture.
 461  */
 462 VLC_API void vout_display_SendMouseMovedDisplayCoordinates(vout_display_t *vd, video_orientation_t orient_display, int m_x, int m_y,
 463                                                            vout_display_place_t *place);
 464
 465 /** @} */
 466 #endif /* VLC_VOUT_DISPLAY_H */