include/vlc_vout_display.h

   1 /*****************************************************************************
   2  * vlc_vout_display.h: vout_display_t definitions
   3  *****************************************************************************
   4  * Copyright (C) 2009 Laurent Aimar
   5  *
   6  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 #ifndef VLC_VOUT_DISPLAY_H
  24 #define VLC_VOUT_DISPLAY_H 1
  25
  26 #include <vlc_es.h>
  27 #include <vlc_picture.h>
  28 #include <vlc_picture_pool.h>
  29 #include <vlc_subpicture.h>
  30 #include <vlc_actions.h>
  31 #include <vlc_mouse.h>
  32 #include <vlc_vout.h>
  33 #include <vlc_vout_window.h>
  34 #include <vlc_viewpoint.h>
  35
  36 /**
  37  * \defgroup video_display Video output display
  38  * Video output display: output buffers and rendering
  39  *
  40  * \ingroup video_output
  41  * @{
  42  * \file
  43  * Video output display modules interface
  44  */
  45
  46 typedef struct vout_display_t vout_display_t;
  47 typedef struct vout_display_sys_t vout_display_sys_t;
  48 typedef struct vout_display_owner_t vout_display_owner_t;
  49
  50 /**
  51  * \defgroup video_align Video alignment
  52  * @{
  53  */
  54 #define VLC_VIDEO_ALIGN_CENTER 0
  55 #define VLC_VIDEO_ALIGN_LEFT   1
  56 #define VLC_VIDEO_ALIGN_RIGHT  2
  57 #define VLC_VIDEO_ALIGN_TOP    1
  58 #define VLC_VIDEO_ALIGN_BOTTOM 2
  59
  60 /**
  61  * Video alignment within the display.
  62  */
  63 typedef struct vlc_video_align {
  64     /**
  65      * Horizontal alignment.
  66      *
  67      * This must be one of \ref VLC_VIDEO_ALIGN_CENTER,
  68      * \ref VLC_VIDEO_ALIGN_LEFT or \ref VLC_VIDEO_ALIGN_RIGHT.
  69      */
  70     char horizontal;
  71
  72     /**
  73      * Vectical alignment.
  74      *
  75      * This must be one of \ref VLC_VIDEO_ALIGN_CENTER,
  76      * \ref VLC_VIDEO_ALIGN_TOP or \ref VLC_VIDEO_ALIGN_BOTTOM.
  77      */
  78     char vertical;
  79 } vlc_video_align_t;
  80 /** @} */
  81
  82 /**
  83  * User configuration for a video output display (\ref vout_display_t)
  84  *
  85  * This primarily controls the size of the display area within the video
  86  * window, as follows:
  87  * - If \ref is_display_filled is set,
  88  *   the video size is fitted to the display size.
  89  * - Otherwise, the video size is determined from the original video format,
  90  *   multiplied by the zoom factor.
  91  */
  92 typedef struct vout_display_cfg {
  93     struct vout_window_t *window; /**< Window */
  94 #if defined(__OS2__)
  95     bool is_fullscreen VLC_DEPRECATED;  /* Is the display fullscreen */
  96 #endif
  97
  98     /** Display properties */
  99     struct {
 100         unsigned width; /**< Requested display pixel width (0 by default). */
 101         unsigned height; /**< Requested display pixel height (0 by default). */
 102         vlc_rational_t sar; /**< Requested sample aspect ratio */
 103     } display;
 104
 105     /** Alignment of the video within the window */
 106     vlc_video_align_t align;
 107
 108     /** Automatic scaling/fitting flag */
 109     bool is_display_filled;
 110
 111     /** Zoom ratio */
 112     struct {
 113         unsigned num;
 114         unsigned den;
 115     } zoom;
 116
 117     vlc_viewpoint_t viewpoint;
 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 can_scale_spu;                     /* Handles subpictures with a non default zoom factor */
 129     const vlc_fourcc_t *subpicture_chromas; /* List of supported chromas for subpicture rendering. */
 130 } vout_display_info_t;
 131
 132 /**
 133  * Control query for vout_display_t
 134  */
 135 enum vout_display_query {
 136     /**
 137      * Asks to reset the internal buffers and picture format.
 138      *
 139      * This occurs after a
 140      * \ref VOUT_DISPLAY_CHANGE_DISPLAY_SIZE,
 141      * \ref VOUT_DISPLAY_CHANGE_DISPLAY_FILLED,
 142      * \ref VOUT_DISPLAY_CHANGE_ZOOM,
 143      * \ref VOUT_DISPLAY_CHANGE_SOURCE_ASPECT or
 144      * \ref VOUT_DISPLAY_CHANGE_SOURCE_CROP
 145      * control query returns an error.
 146      */
 147     VOUT_DISPLAY_RESET_PICTURES, /* const vout_display_cfg_t *, video_format_t * */
 148
 149 #if defined(__OS2__)
 150     /* Ask the module to acknowledge/refuse the fullscreen state change after
 151      * being requested (externally or by VOUT_DISPLAY_EVENT_FULLSCREEN */
 152     VOUT_DISPLAY_CHANGE_FULLSCREEN VLC_DEPRECATED_ENUM,     /* bool fs */
 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 VLC_DEPRECATED_ENUM,   /* unsigned state */
 156 #endif
 157     /**
 158      * Notifies a change in display size.
 159      *
 160      * \retval VLC_SUCCESS if the display handled the change
 161      * \retval VLC_EGENERIC if a \ref VOUT_DISPLAY_RESET_PICTURES request
 162      *                      is necessary
 163      */
 164     VOUT_DISPLAY_CHANGE_DISPLAY_SIZE,   /* const vout_display_cfg_t *p_cfg */
 165
 166     /**
 167      * Notifies a change of the display fill display flag by the user.
 168      *
 169      * \retval VLC_SUCCESS if the display handled the change
 170      * \retval VLC_EGENERIC if a \ref VOUT_DISPLAY_RESET_PICTURES request
 171      *                      is necessary
 172      */
 173     VOUT_DISPLAY_CHANGE_DISPLAY_FILLED, /* const vout_display_cfg_t *p_cfg */
 174
 175     /**
 176      * Notifies a change of the user zoom factor.
 177      *
 178      * \retval VLC_SUCCESS if the display handled the change
 179      * \retval VLC_EGENERIC if a \ref VOUT_DISPLAY_RESET_PICTURES request
 180      *                      is necessary
 181      */
 182     VOUT_DISPLAY_CHANGE_ZOOM, /* const vout_display_cfg_t *p_cfg */
 183
 184     /**
 185      * Notifies a change of the sample aspect ratio.
 186      *
 187      * \retval VLC_SUCCESS if the display handled the change
 188      * \retval VLC_EGENERIC if a \ref VOUT_DISPLAY_RESET_PICTURES request
 189      *                      is necessary
 190      */
 191     VOUT_DISPLAY_CHANGE_SOURCE_ASPECT, /* const vout_display_cfg_t *p_cfg */
 192
 193     /**
 194      * Notifies a change of the source cropping.
 195      *
 196      * The cropping requested is stored by source video_format_t::i_x/y_offset
 197      * and video_format_t::i_visible_width/height
 198      *
 199      * \retval VLC_SUCCESS if the display handled the change
 200      * \retval VLC_EGENERIC if a \ref VOUT_DISPLAY_RESET_PICTURES request
 201      *                      is necessary
 202      */
 203     VOUT_DISPLAY_CHANGE_SOURCE_CROP, /* const vout_display_cfg_t *p_cfg */
 204
 205     /**
 206      * Notifies a change of VR/360° viewpoint.
 207      */
 208     VOUT_DISPLAY_CHANGE_VIEWPOINT,   /* const vout_display_cfg_t *p_cfg */
 209 };
 210
 211 /**
 212  * Vout owner structures
 213  */
 214 struct vout_display_owner_t {
 215     /* Private place holder for the vout_display_t creator
 216      */
 217     void *sys;
 218
 219     /* Event coming from the module
 220      *
 221      * This function is set prior to the module instantiation and must not
 222      * be overwritten nor used directly (use the vout_display_SendEvent*
 223      * wrapper.
 224      *
 225      * You can send it at any time i.e. from any vout_display_t functions or
 226      * from another thread.
 227      * Be careful, it does not ensure correct serialization if it is used
 228      * from multiple threads.
 229      */
 230     void (*viewpoint_moved)(void *sys, const vlc_viewpoint_t *vp);
 231 };
 232
 233 /**
 234  * "vout display" open callback
 235  *
 236  * @param vd vout display context
 237  * @param cfg Initial and current configuration.
 238  * @param fmtp By default, it is equal to vd->source except for the aspect
 239  * ratio which is undefined(0) and is ignored. It can be changed by the module
 240  * to request a different format.
 241  * @param context XXX: to be defined.
 242  * @return VLC_SUCCESS or a VLC error code
 243  */
 244 typedef int (*vout_display_open_cb)(vout_display_t *vd,
 245                                     const vout_display_cfg_t *cfg,
 246                                     video_format_t *fmtp,
 247                                     vlc_video_context *context);
 248
 249 #define set_callback_display(activate, priority) \
 250     { \
 251         vout_display_open_cb open__ = activate; \
 252         (void) open__; \
 253         set_callback(activate) \
 254     } \
 255     set_capability( "vout display", priority )
 256
 257
 258 struct vout_display_t {
 259     struct vlc_object_t obj;
 260
 261     /**
 262      * User configuration.
 263      *
 264      * This cannot be modified directly. It reflects the current values.
 265      */
 266     const vout_display_cfg_t *cfg;
 267
 268     /**
 269      * Source video format.
 270      *
 271      * This is the format of the video that is being displayed (after decoding
 272      * and filtering). It cannot be modified.
 273      *
 274      * \note
 275      * Cropping is not requested while in the open function.
 276      */
 277     video_format_t source;
 278
 279     /**
 280      * Picture format.
 281      *
 282      * This is the format of the pictures that are supplied to the
 283      * \ref prepare and \ref display callbacks. Ideally, it should be identical
 284      * or as close as possible as \ref source.
 285      *
 286      * This can only be changed from the display module activation callback,
 287      * or within a VOUT_DISPLAY_RESET_PICTURES control request.
 288      *
 289      * By default, it is equal to ::source except for the aspect ratio
 290      * which is undefined(0) and is ignored.
 291      */
 292     video_format_t fmt;
 293
 294     /* Information
 295      *
 296      * You can only set them in the open function.
 297      */
 298     vout_display_info_t info;
 299
 300     /**
 301      * Prepares a picture and an optional subpicture for display (optional).
 302      *
 303      * This callback is called once a picture buffer content is ready,
 304      * as far in advance as possible to the intended display time,
 305      * but only after the previous picture was displayed.
 306      *
 307      * The callback should perform any preprocessing operation that will not
 308      * actually cause the picture to be shown, such as blending the subpicture
 309      * or upload the picture to video memory. If supported, this can also
 310      * queue the picture to be shown asynchronously at the given date.
 311      *
 312      * If prepare is not \c NULL, there is an implicit guarantee that display
 313      * will be invoked with the exact same picture afterwards:
 314      * prepare 1st picture, display 1st picture, prepare 2nd picture, display
 315      * 2nd picture, and so on.
 316      *
 317      * \note The picture buffers may have multiple references.
 318      * Therefore the pixel content of the picture or of the subpicture
 319      * must not be changed.
 320      *
 321      * \param pic picture
 322      * \param subpic subpicture to render over the picture
 323      * \param date time when the picture is intended to be shown
 324      */
 325     void       (*prepare)(vout_display_t *, picture_t *pic,
 326                           subpicture_t *subpic, vlc_tick_t date);
 327
 328     /**
 329      * Displays a picture.
 330      *
 331      * This callback is invoked at the time when the picture should be shown.
 332      * The picture must be displayed as soon as possible.
 333      *
 334      * \note The picture buffers may have multiple references.
 335      * Therefore the pixel content of the picture or of the subpicture
 336      * must not be changed.
 337      */
 338     void       (*display)(vout_display_t *, picture_t *pic);
 339
 340     /**
 341      * Performs a control request (mandatory).
 342      *
 343      * \param query request type
 344      *
 345      * See \ref vout_display_query for the list of request types.
 346      */
 347     int        (*control)(vout_display_t *, int query, va_list);
 348
 349     /**
 350      * Destroys the display.
 351      */
 352     void (*close)(vout_display_t *);
 353
 354     /**
 355      * Private data for the display module.
 356      *
 357      * A module is free to use it as it wishes.
 358      */
 359     vout_display_sys_t *sys;
 360
 361     /* Reserved for the vout_display_t owner.
 362      *
 363      * It must not be overwritten nor used directly by a module.
 364      */
 365     vout_display_owner_t owner;
 366 };
 367
 368 /**
 369  * Creates video output display.
 370  */
 371 VLC_API
 372 vout_display_t *vout_display_New(vlc_object_t *,
 373     const video_format_t *, vlc_video_context *,
 374     const vout_display_cfg_t *, const char *module,
 375     const vout_display_owner_t *);
 376
 377 /**
 378  * Destroys a video output display.
 379  */
 380 VLC_API void vout_display_Delete(vout_display_t *);
 381
 382 /**
 383  * Prepares a picture for display.
 384  *
 385  * This renders a picture for subsequent display, with vout_display_Display().
 386  *
 387  * \note A reference to the input picture is consumed by the function, which
 388  * returns a reference to an output picture for display. The input and output
 389  * picture may or may not be equal depending on the underlying display setup.
 390  *
 391  * \bug Currently, only one picture can be prepared at a time. It must be
 392  * displayed with vout_display_Display() before any picture is prepared or
 393  * before the display is destroyd with vout_display_Delete().
 394  *
 395  \ bug Rendering subpictures is not supported with this function yet.
 396  * \c subpic must be @c NULL .
 397  *
 398  * \param vd display to prepare the picture for
 399  * \param picture picure to be prepared
 400  * \param subpic reserved, must be NULL
 401  * \param date intended time to show the picture
 402  * \return The prepared picture is returned, NULL on error.
 403  */
 404 VLC_API picture_t *vout_display_Prepare(vout_display_t *vd, picture_t *picture,
 405                                         subpicture_t *subpic, vlc_tick_t date);
 406
 407 /**
 408  * Displays a picture.
 409  */
 410 static inline void vout_display_Display(vout_display_t *vd, picture_t *picture)
 411 {
 412     if (vd->display != NULL)
 413         vd->display(vd, picture);
 414     picture_Release(picture);
 415 }
 416
 417 VLC_API
 418 void vout_display_SetSize(vout_display_t *vd, unsigned width, unsigned height);
 419
 420 VLC_API void vout_display_SendEventPicturesInvalid(vout_display_t *vd);
 421
 422 static inline void vout_display_SendEventMousePressed(vout_display_t *vd, int button)
 423 {
 424     vout_window_ReportMousePressed(vd->cfg->window, button);
 425 }
 426 static inline void vout_display_SendEventMouseReleased(vout_display_t *vd, int button)
 427 {
 428     vout_window_ReportMouseReleased(vd->cfg->window, button);
 429 }
 430 static inline void vout_display_SendEventMouseDoubleClick(vout_display_t *vd)
 431 {
 432     vout_window_ReportMouseDoubleClick(vd->cfg->window, MOUSE_BUTTON_LEFT);
 433 }
 434 static inline void vout_display_SendEventViewpointMoved(vout_display_t *vd,
 435                                                         const vlc_viewpoint_t *vp)
 436 {
 437     if (vd->owner.viewpoint_moved)
 438         vd->owner.viewpoint_moved(vd->owner.sys, vp);
 439 }
 440
 441 /**
 442  * Helper function that applies the necessary transforms to the mouse position
 443  * and then calls vout_display_SendEventMouseMoved.
 444  *
 445  * \param vd vout_display_t.
 446  * \param m_x Mouse x position (relative to place, origin is top left).
 447  * \param m_y Mouse y position (relative to place, origin is top left).
 448  */
 449 static inline void vout_display_SendMouseMovedDisplayCoordinates(vout_display_t *vd, int m_x, int m_y)
 450 {
 451     vout_window_ReportMouseMoved(vd->cfg->window, m_x, m_y);
 452 }
 453
 454 static inline bool vout_display_cfg_IsWindowed(const vout_display_cfg_t *cfg)
 455 {
 456     return cfg->window->type != VOUT_WINDOW_TYPE_DUMMY;
 457 }
 458
 459 /**
 460  * Computes the default display size given the source and
 461  * the display configuration.
 462  *
 463  * This asssumes that the picture is already cropped.
 464  */
 465 VLC_API void vout_display_GetDefaultDisplaySize(unsigned *width, unsigned *height, const video_format_t *source, const vout_display_cfg_t *);
 466
 467
 468 /**
 469  * Video placement.
 470  *
 471  * This structure stores the result of a vout_display_PlacePicture() call.
 472  */
 473 typedef struct {
 474     int x; /*< Relative pixel offset from the display left edge */
 475     int y; /*< Relative pixel offset from the display top edge */
 476     unsigned width; /*< Picture pixel width */
 477     unsigned height; /*< Picture pixel height */
 478 } vout_display_place_t;
 479
 480 /**
 481  * Compares two \ref vout_display_place_t.
 482  */
 483 static inline bool vout_display_PlaceEquals(const vout_display_place_t *p1,
 484                                             const vout_display_place_t *p2)
 485 {
 486     return p1->x == p2->x && p1->width == p2->width &&
 487             p1->y == p2->y && p1->height == p2->height;
 488 }
 489
 490 /**
 491  * Computes the intended picture placement inside the display.
 492  *
 493  * This function computes where to show a picture inside the display with
 494  * respect to the provided parameters, and returns the result
 495  * in a \ref vout_display_place_t structure.
 496  *
 497  * This assumes that cropping is done by an external mean.
 498  *
 499  * \param place Storage space for the picture placement [OUT]
 500  * \param source Video source format
 501  * \param cfg Display configuration
 502  */
 503 VLC_API void vout_display_PlacePicture(vout_display_place_t *place, const video_format_t *source, const vout_display_cfg_t *cfg);
 504
 505 /**
 506  * Translates mouse state.
 507  *
 508  * This translates the mouse (pointer) state from window coordinates to
 509  * video coordinates.
 510  * @note @c video and @c window pointers may alias.
 511  */
 512 void vout_display_TranslateMouseState(vout_display_t *vd, vlc_mouse_t *video,
 513                                       const vlc_mouse_t *window);
 514
 515 /** @} */
 516 #endif /* VLC_VOUT_DISPLAY_H */