vlc_vout_display.h 15.5 KB
Newer Older
1 2 3 4 5 6 7 8
/*****************************************************************************
 * vlc_vout_display.h: vout_display_t definitions
 *****************************************************************************
 * Copyright (C) 2009 Laurent Aimar
 * $Id$
 *
 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12 13 14 15
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23 24 25 26 27 28
 *****************************************************************************/

#ifndef VLC_VOUT_DISPLAY_H
#define VLC_VOUT_DISPLAY_H 1

#include <vlc_es.h>
#include <vlc_picture.h>
29
#include <vlc_picture_pool.h>
30 31 32
#include <vlc_subpicture.h>
#include <vlc_keys.h>
#include <vlc_mouse.h>
33
#include <vlc_vout.h>
34
#include <vlc_vout_window.h>
35
#include <vlc_viewpoint.h>
36

37 38 39 40 41 42 43 44 45 46
/**
 * \defgroup video_display Video output display
 * Video output display: output buffers and rendering
 *
 * \ingroup video_output
 * @{
 * \file
 * Video output display modules interface
 */

47 48 49 50 51 52 53 54 55 56
/* XXX
 * Do NOT use video_format_t::i_aspect but i_sar_num/den everywhere. i_aspect
 * will be removed as soon as possible.
 *
 */
typedef struct vout_display_t vout_display_t;
typedef struct vout_display_sys_t vout_display_sys_t;
typedef struct vout_display_owner_t vout_display_owner_t;

/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
57
 * Possible alignments for vout_display.
58 59 60 61 62 63 64 65 66 67 68 69
 */
typedef enum
{
    VOUT_DISPLAY_ALIGN_CENTER,
    /* */
    VOUT_DISPLAY_ALIGN_LEFT,
    VOUT_DISPLAY_ALIGN_RIGHT,
    /* */
    VOUT_DISPLAY_ALIGN_TOP,
    VOUT_DISPLAY_ALIGN_BOTTOM,
} vout_display_align_t;

70 71 72 73 74 75 76 77 78 79
/**
 * Window management state.
 */
enum {
    VOUT_WINDOW_STATE_NORMAL=0,
    VOUT_WINDOW_STATE_ABOVE=1,
    VOUT_WINDOW_STATE_BELOW=2,
    VOUT_WINDOW_STACK_MASK=3,
};

80 81 82 83 84 85 86 87 88 89 90 91
/**
 * Initial/Current configuration for a vout_display_t
 */
typedef struct {
    bool is_fullscreen;  /* Is the display fullscreen */

    /* Display properties */
    struct {
        /* Window title (may be NULL) */
        const char *title;

        /* Display size */
92 93
        unsigned  width;
        unsigned  height;
94 95

        /* Display SAR */
96
        vlc_rational_t sar;
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
    } display;

    /* Alignment of the picture inside the display */
    struct {
        int horizontal;
        int vertical;
    } align;

    /* Do we fill up the display with the video */
    bool is_display_filled;

    /* Zoom to use
     * It will be applied to the whole display if b_display_filled is set, otherwise
     * only on the video source */
    struct {
        int num;
        int den;
    } zoom;

116
    vlc_viewpoint_t viewpoint;
117 118 119
} vout_display_cfg_t;

/**
Rémi Duraffort's avatar
Rémi Duraffort committed
120
 * Information from a vout_display_t to configure
121 122
 * the core behaviour.
 *
123
 * By default they are all false or NULL.
124 125 126
 *
 */
typedef struct {
127 128 129 130
    bool is_slow;                           /* The picture memory has slow read/write */
    bool has_double_click;                  /* Is double-click generated */
    bool has_hide_mouse;                    /* Is mouse automatically hidden */
    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 134 135 136 137 138
} vout_display_info_t;

/**
 * Control query for vout_display_t
 */
enum {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
139
    /* Hide the mouse. It will be sent when
140 141 142 143 144 145 146 147 148
     * vout_display_t::info.b_hide_mouse is false */
    VOUT_DISPLAY_HIDE_MOUSE,

    /* Ask to reset the internal buffers after a VOUT_DISPLAY_EVENT_PICTURES_INVALID
     * request.
     */
    VOUT_DISPLAY_RESET_PICTURES,

    /* Ask the module to acknowledge/refuse the fullscreen state change after
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
149
     * being requested (externally or by VOUT_DISPLAY_EVENT_FULLSCREEN */
150
    VOUT_DISPLAY_CHANGE_FULLSCREEN,     /* bool fs */
151
#if defined(_WIN32) || defined(__OS2__)
152 153 154
    /* Ask the module to acknowledge/refuse the window management state change
     * after being requested externally or by VOUT_DISPLAY_WINDOW_STATE */
    VOUT_DISPLAY_CHANGE_WINDOW_STATE,         /* unsigned state */
155
#endif
156
    /* Ask the module to acknowledge/refuse the display size change requested
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
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
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
161
     * being requested externally */
162 163 164
    VOUT_DISPLAY_CHANGE_DISPLAY_FILLED, /* const vout_display_cfg_t *p_cfg */

    /* Ask the module to acknowledge/refuse zoom change after being requested
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
165
     * externally */
166 167 168
    VOUT_DISPLAY_CHANGE_ZOOM, /* const vout_display_cfg_t *p_cfg */

    /* Ask the module to acknowledge/refuse source aspect ratio after being
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
169
     * requested externally */
170
    VOUT_DISPLAY_CHANGE_SOURCE_ASPECT,
171 172

    /* Ask the module to acknowledge/refuse source crop change after being
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
173
     * requested externally.
174 175
     * The cropping requested is stored by video_format_t::i_x/y_offset and
     * video_format_t::i_visible_width/height */
176
    VOUT_DISPLAY_CHANGE_SOURCE_CROP,
177 178 179 180

    /* Ask the module to acknowledge/refuse VR/360° viewing direction after
     * being requested externally */
    VOUT_DISPLAY_CHANGE_VIEWPOINT,   /* const vout_display_cfg_t *p_cfg */
181 182 183 184 185
};

/**
 * Event from vout_display_t
 *
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
186 187
 * Events modifiying the state may be sent multiple times.
 * Only the transition will be retained and acted upon.
188 189 190 191 192 193 194 195 196
 */
enum {
    /* TODO:
     * ZOOM ? DISPLAY_FILLED ? ON_TOP ?
     */
    /* */
    VOUT_DISPLAY_EVENT_PICTURES_INVALID,    /* The buffer are now invalid and need to be changed */

    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 205 206 207 208 209 210 211 212 213 214 215 216 217

    /* */
    VOUT_DISPLAY_EVENT_CLOSE,
    VOUT_DISPLAY_EVENT_KEY,

    /* Full mouse state.
     * You can use it OR use the other mouse events. The core will do
     * the conversion.
     */
    VOUT_DISPLAY_EVENT_MOUSE_STATE,

    /* Mouse event */
    VOUT_DISPLAY_EVENT_MOUSE_MOVED,
    VOUT_DISPLAY_EVENT_MOUSE_PRESSED,
    VOUT_DISPLAY_EVENT_MOUSE_RELEASED,
    VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK,
218 219 220

    /* VR navigation */
    VOUT_DISPLAY_EVENT_VIEWPOINT_MOVED,
221 222 223 224 225 226 227 228
};

/**
 * Vout owner structures
 */
struct vout_display_owner_t {
    /* Private place holder for the vout_display_t creator
     */
229
    void *sys;
230

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
231
    /* Event coming from the module
232 233 234 235 236
     *
     * This function is set prior to the module instantiation and must not
     * be overwritten nor used directly (use the vout_display_SendEvent*
     * wrapper.
     *
237 238
     * You can send it at any time i.e. from any vout_display_t functions or
     * from another thread.
Rémi Denis-Courmont's avatar
Grammar  
Rémi Denis-Courmont committed
239
     * Be careful, it does not ensure correct serialization if it is used
240
     * from multiple threads.
241 242 243 244 245 246 247 248
     */
    void            (*event)(vout_display_t *, int, va_list);

    /* Window management
     *
     * These functions are set prior to the module instantiation and must not
     * be overwritten nor used directly (use the vout_display_*Window
     * wrapper */
249
    vout_window_t *(*window_new)(vout_display_t *, unsigned type);
250 251 252 253 254 255 256 257 258 259
    void           (*window_del)(vout_display_t *, vout_window_t *);
};

struct vout_display_t {
    VLC_COMMON_MEMBERS

    /* Module */
    module_t *module;

    /* Initial and current configuration.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
260
     * You cannot modify it directly, you must use the appropriate events.
261
     *
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
262
     * It reflects the current values, i.e. after the event has been accepted
263 264 265 266 267 268
     * and applied/configured if needed.
     */
    const vout_display_cfg_t *cfg;

    /* video source format.
     *
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
269
     * Cropping is not requested while in the open function.
270 271 272 273 274 275 276
     * You cannot change it.
     */
    video_format_t source;

    /* picture_t format.
     *
     * You can only change it inside the module open function to
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
277 278
     * match what you want, and when a VOUT_DISPLAY_RESET_PICTURES control
     * request is made and succeeds.
279 280 281 282 283 284
     *
     * By default, it is equal to ::source except for the aspect ratio
     * which is undefined(0) and is ignored.
     */
    video_format_t fmt;

Rémi Duraffort's avatar
Rémi Duraffort committed
285
    /* Information
286
     *
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
287
     * You can only set them in the open function.
288 289 290
     */
    vout_display_info_t info;

291
    /* Return a pointer over the current picture_pool_t* (mandatory).
292
     *
293 294
     * For performance reasons, it is best to provide at least count
     * pictures but it is not mandatory.
295
     * You can return NULL when you cannot/do not want to allocate
296 297 298
     * pictures.
     * The vout display module keeps the ownership of the pool and can
     * 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 306
     * time as possible to prepare the given picture and the subpicture
     * for display.
307
     * You are guaranted that pf_display will always be called and using
308 309 310
     * the exact same picture_t and subpicture_t.
     * You cannot change the pixel content of the picture_t or of the
     * 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 317 318 319
     * The picture and the optional subpicture must be displayed as soon as
     * possible.
     * You cannot change the pixel content of the picture_t or of the
     * subpicture_t.
320
     *
321 322
     * This function gives away the ownership of the picture and of the
     * subpicture, so you must release them as soon as possible.
323
     */
324
    void       (*display)(vout_display_t *, picture_t *, subpicture_t *);
325 326 327 328

    /* Control on the module (mandatory) */
    int        (*control)(vout_display_t *, int, va_list);

329
    /* Manage pending event (optional) */
330 331 332 333
    void       (*manage)(vout_display_t *);

    /* Private place holder for the vout_display_t module (optional)
     *
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
334
     * A module is free to use it as it wishes.
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
     */
    vout_display_sys_t *sys;

    /* Reserved for the vout_display_t owner.
     *
     * It must not be overwritten nor used directly by a module.
     */
    vout_display_owner_t owner;
};

static inline void vout_display_SendEvent(vout_display_t *vd, int query, ...)
{
    va_list args;
    va_start(args, query);
    vd->owner.event(vd, query, args);
    va_end(args);
}

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 358 359 360 361 362 363 364 365 366 367 368
}
static inline void vout_display_SendEventPicturesInvalid(vout_display_t *vd)
{
    vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_PICTURES_INVALID);
}
static inline void vout_display_SendEventClose(vout_display_t *vd)
{
    vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_CLOSE);
}
static inline void vout_display_SendEventKey(vout_display_t *vd, int key)
{
    vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_KEY, key);
}
369 370
static inline void vout_display_SendEventFullscreen(vout_display_t *vd, bool is_fullscreen,
                                                    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 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
/* The mouse position (State and Moved event) must be expressed against vout_display_t::source unit */
static inline void vout_display_SendEventMouseState(vout_display_t *vd, int x, int y, int button_mask)
{
    vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_STATE, x, y, button_mask);
}
static inline void vout_display_SendEventMouseMoved(vout_display_t *vd, int x, int y)
{
    vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_MOVED, x, y);
}
static inline void vout_display_SendEventMousePressed(vout_display_t *vd, int button)
{
    vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_PRESSED, button);
}
static inline void vout_display_SendEventMouseReleased(vout_display_t *vd, int button)
{
    vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_RELEASED, button);
}
static inline void vout_display_SendEventMouseDoubleClick(vout_display_t *vd)
{
    vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK);
}
401 402 403 404 405
static inline void vout_display_SendEventViewpointMoved(vout_display_t *vd,
                                                        const vlc_viewpoint_t *vp)
{
    vout_display_SendEvent(vd, VOUT_DISPLAY_EVENT_VIEWPOINT_MOVED, vp);
}
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 416 417
/**
 * Deletes a window created by vout_display_NewWindow if window is non NULL
 * or any unused windows otherwise.
 */
418 419 420 421 422 423
static inline void vout_display_DeleteWindow(vout_display_t *vd,
                                             vout_window_t *window)
{
    vd->owner.window_del(vd, window);
}

424 425
static inline bool vout_display_IsWindowed(vout_display_t *vd)
{
426
    vout_window_t *window = vout_display_NewWindow(vd, VOUT_WINDOW_TYPE_INVALID);
427 428 429 430 431
    if (window != NULL)
        vout_display_DeleteWindow(vd, window);
    return window != NULL;
}

432
/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
433
 * Computes the default display size given the source and
434 435
 * the display configuration.
 *
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
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 443 444 445 446


/**
 * Structure used to store the result of a vout_display_PlacePicture.
 */
typedef struct {
    int x;
    int y;
447 448
    unsigned width;
    unsigned height;
449 450 451
} vout_display_place_t;

/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
452
 * Computes how to place a picture inside the display to respect
453
 * the given parameters.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
454
 * This assumes that cropping is done by an external mean.
455 456 457 458 459 460
 *
 * \param p_place Place inside the window (window pixel unit)
 * \param p_source Video source format
 * \param p_cfg Display configuration
 * \param b_clip If true, prevent the video to go outside the display (break zoom).
 */
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 466 467 468 469 470 471 472 473 474 475

/**
 * Helper function that applies the necessary transforms to the mouse position
 * and then calls vout_display_SendEventMouseMoved.
 *
 * \param vd vout_display_t.
 * \param orient_display The orientation of the picture as seen on screen (probably ORIENT_NORMAL).
 * \param m_x Mouse x position (relative to place, origin is top left).
 * \param m_y Mouse y position (relative to place, origin is top left).
 * \param place Place of the picture.
 */
VLC_API void vout_display_SendMouseMovedDisplayCoordinates(vout_display_t *vd, video_orientation_t orient_display, int m_x, int m_y,
                                                           vout_display_place_t *place);
476

477 478
/** @} */
#endif /* VLC_VOUT_DISPLAY_H */