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