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