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
  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.
  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 General Public License for more details.
  18  *
  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  *****************************************************************************/
  23
  24 #ifndef VLC_VOUT_DISPLAY_H
  25 #define VLC_VOUT_DISPLAY_H 1
  26
  27 /**
  28  * \file
  29  * This file defines vout display structures and functions in vlc
  30  */
  31
  32 #include <vlc_es.h>
  33 #include <vlc_picture.h>
  34 #include <vlc_subpicture.h>
  35 #include <vlc_keys.h>
  36 #include <vlc_mouse.h>
  37 #include <vlc_vout_window.h>
  38
  39 /* XXX
  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.
  42  *
  43  */
  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;
  48
  49 /**
  50  * Possible alignments for vout_display.
  51  */
  52 typedef enum
  53 {
  54     VOUT_DISPLAY_ALIGN_CENTER,
  55     /* */
  56     VOUT_DISPLAY_ALIGN_LEFT,
  57     VOUT_DISPLAY_ALIGN_RIGHT,
  58     /* */
  59     VOUT_DISPLAY_ALIGN_TOP,
  60     VOUT_DISPLAY_ALIGN_BOTTOM,
  61 } vout_display_align_t;
  62
  63 /**
  64  * Initial/Current configuration for a vout_display_t
  65  */
  66 typedef struct {
  67     bool is_fullscreen;  /* Is the display fullscreen */
  68
  69     /* Display properties */
  70     struct {
  71         /* Window title (may be NULL) */
  72         const char *title;
  73
  74         /* Display size */
  75         unsigned  width;
  76         unsigned  height;
  77
  78         /* Display SAR */
  79         struct {
  80             unsigned num;
  81             unsigned den;
  82         } sar;
  83     } display;
  84
  85     /* Alignment of the picture inside the display */
  86     struct {
  87         int horizontal;
  88         int vertical;
  89     } align;
  90
  91     /* Do we fill up the display with the video */
  92     bool is_display_filled;
  93
  94     /* Zoom to use
  95      * It will be applied to the whole display if b_display_filled is set, otherwise
  96      * only on the video source */
  97     struct {
  98         int num;
  99         int den;
 100     } zoom;
 101
 102 } vout_display_cfg_t;
 103
 104 /**
 105  * Informations from a vout_display_t to configure
 106  * the core behaviour.
 107  *
 108  * By default they are all false.
 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_hide_mouse;      /* Is mouse automatically hidden */
 115     bool has_pictures_invalid;/* Will VOUT_DISPLAY_EVENT_PICTURES_INVALID be used */
 116 } vout_display_info_t;
 117
 118 /**
 119  * Control query for vout_display_t
 120  */
 121 enum {
 122     /* Hide the mouse. It will be sent when
 123      * vout_display_t::info.b_hide_mouse is false */
 124     VOUT_DISPLAY_HIDE_MOUSE,
 125
 126     /* Ask to reset the internal buffers after a VOUT_DISPLAY_EVENT_PICTURES_INVALID
 127      * request.
 128      */
 129     VOUT_DISPLAY_RESET_PICTURES,
 130
 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 */
 134
 135     /* Ask the module to acknowledge/refuse the "always on top" state change
 136      * after being requested externally or by VOUT_DISPLAY_EVENT_ON_TOP */
 137     VOUT_DISPLAY_CHANGE_ON_TOP,         /* int b_on_top */
 138
 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, int is_forced */
 142
 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 */
 146
 147     /* Ask the module to acknowledge/refuse zoom change after being requested
 148      * externally */
 149     VOUT_DISPLAY_CHANGE_ZOOM, /* const vout_display_cfg_t *p_cfg */
 150
 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 */
 154
 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 */
 160 };
 161
 162 /**
 163  * Event from vout_display_t
 164  *
 165  * Events modifiying the state may be sent multiple times.
 166  * Only the transition will be retained and acted upon.
 167  */
 168 enum {
 169     /* TODO:
 170      * ZOOM ? DISPLAY_FILLED ? ON_TOP ?
 171      */
 172     /* */
 173     VOUT_DISPLAY_EVENT_PICTURES_INVALID,    /* The buffer are now invalid and need to be changed */
 174
 175     VOUT_DISPLAY_EVENT_FULLSCREEN,
 176     VOUT_DISPLAY_EVENT_ON_TOP,
 177
 178     VOUT_DISPLAY_EVENT_DISPLAY_SIZE,        /* The display size need to change : int i_width, int i_height, bool is_fullscreen */
 179
 180     /* */
 181     VOUT_DISPLAY_EVENT_CLOSE,
 182     VOUT_DISPLAY_EVENT_KEY,
 183
 184     /* Full mouse state.
 185      * You can use it OR use the other mouse events. The core will do
 186      * the conversion.
 187      */
 188     VOUT_DISPLAY_EVENT_MOUSE_STATE,
 189
 190     /* Mouse event */
 191     VOUT_DISPLAY_EVENT_MOUSE_MOVED,
 192     VOUT_DISPLAY_EVENT_MOUSE_PRESSED,
 193     VOUT_DISPLAY_EVENT_MOUSE_RELEASED,
 194     VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK,
 195 };
 196
 197 /**
 198  * Vout owner structures
 199  */
 200 struct vout_display_owner_t {
 201     /* Private place holder for the vout_display_t creator
 202      */
 203     vout_display_owner_sys_t *sys;
 204
 205     /* Event coming from the module
 206      *
 207      * This function is set prior to the module instantiation and must not
 208      * be overwritten nor used directly (use the vout_display_SendEvent*
 209      * wrapper.
 210      *
 211      * You can send it at any time i.e. from any vout_display_t functions or
 212      * from another thread.
 213      * Becarefull, it does not ensure correct serialization if it is used
 214      * from multiple threads.
 215      */
 216     void            (*event)(vout_display_t *, int, va_list);
 217
 218     /* Window management
 219      *
 220      * These functions are set prior to the module instantiation and must not
 221      * be overwritten nor used directly (use the vout_display_*Window
 222      * wrapper */
 223     vout_window_t *(*window_new)(vout_display_t *, const vout_window_cfg_t *);
 224     void           (*window_del)(vout_display_t *, vout_window_t *);
 225 };
 226
 227 struct vout_display_t {
 228     VLC_COMMON_MEMBERS
 229
 230     /* Module */
 231     module_t *module;
 232
 233     /* Initial and current configuration.
 234      * You cannot modify it directly, you must use the appropriate events.
 235      *
 236      * It reflects the current values, i.e. after the event has been accepted
 237      * and applied/configured if needed.
 238      */
 239     const vout_display_cfg_t *cfg;
 240
 241     /* video source format.
 242      *
 243      * Cropping is not requested while in the open function.
 244      * You cannot change it.
 245      */
 246     video_format_t source;
 247
 248     /* picture_t format.
 249      *
 250      * You can only change it inside the module open function to
 251      * match what you want, and when a VOUT_DISPLAY_RESET_PICTURES control
 252      * request is made and succeeds.
 253      *
 254      * By default, it is equal to ::source except for the aspect ratio
 255      * which is undefined(0) and is ignored.
 256      */
 257     video_format_t fmt;
 258
 259     /* Informations
 260      *
 261      * You can only set them in the open function.
 262      */
 263     vout_display_info_t info;
 264
 265     /* Return a new picture_t (mandatory).
 266      *
 267      * You can return NULL when you cannot/do not want to allocate
 268      * more pictures.
 269      * If you want to create a pool of reusable pictures, you can
 270      * use a picture_pool_t.
 271      */
 272     picture_t *(*get)(vout_display_t *);
 273
 274     /* Prepare a picture for display (optional).
 275      *
 276      * It is called before the next pf_display call to provide as much
 277      * time as possible to prepare the given picture for display.
 278      * You are guaranted that pf_display will always be called and using
 279      * the exact same picture_t.
 280      * You cannot change the pixel content of the picture_t.
 281      */
 282     void       (*prepare)(vout_display_t *, picture_t *);
 283
 284     /* Display a picture (mandatory).
 285      *
 286      * The picture must be displayed as soon as possible.
 287      * You cannot change the pixel content of the picture_t.
 288      *
 289      * This function gives away the ownership of the picture, so you must
 290      * release it as soon as possible.
 291      */
 292     void       (*display)(vout_display_t *, picture_t *);
 293
 294     /* Control on the module (mandatory) */
 295     int        (*control)(vout_display_t *, int, va_list);
 296
 297     /* Manage pending event (optional) */
 298     void       (*manage)(vout_display_t *);
 299
 300     /* Private place holder for the vout_display_t module (optional)
 301      *
 302      * A module is free to use it as it wishes.
 303      */
 304     vout_display_sys_t *sys;
 305
 306     /* Reserved for the vout_display_t owner.
 307      *
 308      * It must not be overwritten nor used directly by a module.
 309      */
 310     vout_display_owner_t owner;
 311 };
 312
 313 static inline void vout_display_SendEvent(vout_display_t *vd, int query, ...)
 314 {
 315     va_list args;
 316     va_start(args, query);
 317     vd->owner.event(vd, query, args);
 318     va_end(args);
 319 }
 320
 321 static inline void vout_display_SendEventDisplaySize(vout_display_t *vd, int width, int height, bool is_fullscreen)
 322 {
 323     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_DISPLAY_SIZE, width, height, is_fullscreen);
 324 }
 325 static inline void vout_display_SendEventPicturesInvalid(vout_display_t *vd)
 326 {
 327     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_PICTURES_INVALID);
 328 }
 329 static inline void vout_display_SendEventClose(vout_display_t *vd)
 330 {
 331     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_CLOSE);
 332 }
 333 static inline void vout_display_SendEventKey(vout_display_t *vd, int key)
 334 {
 335     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_KEY, key);
 336 }
 337 static inline void vout_display_SendEventFullscreen(vout_display_t *vd, bool is_fullscreen)
 338 {
 339     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_FULLSCREEN, is_fullscreen);
 340 }
 341 static inline void vout_display_SendEventOnTop(vout_display_t *vd, bool is_on_top)
 342 {
 343     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_ON_TOP, is_on_top);
 344 }
 345 /* The mouse position (State and Moved event) must be expressed against vout_display_t::source unit */
 346 static inline void vout_display_SendEventMouseState(vout_display_t *vd, int x, int y, int button_mask)
 347 {
 348     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_STATE, x, y, button_mask);
 349 }
 350 static inline void vout_display_SendEventMouseMoved(vout_display_t *vd, int x, int y)
 351 {
 352     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_MOVED, x, y);
 353 }
 354 static inline void vout_display_SendEventMousePressed(vout_display_t *vd, int button)
 355 {
 356     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_PRESSED, button);
 357 }
 358 static inline void vout_display_SendEventMouseReleased(vout_display_t *vd, int button)
 359 {
 360     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_RELEASED, button);
 361 }
 362 static inline void vout_display_SendEventMouseDoubleClick(vout_display_t *vd)
 363 {
 364     vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK);
 365 }
 366
 367 /**
 368  * Asks for a new window with the given configuration as hint.
 369  *
 370  * b_standalone/i_x/i_y may be overwritten by the core
 371  */
 372 static inline vout_window_t *vout_display_NewWindow(vout_display_t *vd, const vout_window_cfg_t *cfg)
 373 {
 374     return vd->owner.window_new(vd, cfg);
 375 }
 376 static inline void vout_display_DeleteWindow(vout_display_t *vd,
 377                                              vout_window_t *window)
 378 {
 379     vd->owner.window_del(vd, window);
 380 }
 381
 382 /**
 383  * Computes the default display size given the source and
 384  * the display configuration.
 385  *
 386  * This asssumes that the picture is already cropped.
 387  */
 388 VLC_EXPORT( void, vout_display_GetDefaultDisplaySize, (unsigned *width, unsigned *height, const video_format_t *source, const vout_display_cfg_t *) );
 389
 390
 391 /**
 392  * Structure used to store the result of a vout_display_PlacePicture.
 393  */
 394 typedef struct {
 395     int x;
 396     int y;
 397     unsigned width;
 398     unsigned height;
 399 } vout_display_place_t;
 400
 401 /**
 402  * Computes how to place a picture inside the display to respect
 403  * the given parameters.
 404  * This assumes that cropping is done by an external mean.
 405  *
 406  * \param p_place Place inside the window (window pixel unit)
 407  * \param p_source Video source format
 408  * \param p_cfg Display configuration
 409  * \param b_clip If true, prevent the video to go outside the display (break zoom).
 410  */
 411 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) );
 412
 413 #endif /* VLC_VOUT_DISPLAY_H */
 414