MediaPlayer.hpp 52.9 KB
Newer Older
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1
/*****************************************************************************
2
 * MediaPlayer.hpp: MediaPlayer API
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
3
 *****************************************************************************
4
 * Copyright © 2015 libvlcpp authors & VideoLAN
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
5
 *
6
 * Authors: Alexey Sokolov <alexey+vlc@asokolov.org>
7
 *          Hugo Beauzée-Luyssen <hugo@beauzee.fr>
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * 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
 * (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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * 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.
 *****************************************************************************/

#ifndef LIBVLC_CXX_MEDIAPLAYER_H
#define LIBVLC_CXX_MEDIAPLAYER_H

27
#include <array>
28 29
#include <string>
#include <vector>
30
#include <memory>
31

32
#include "common.hpp"
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
33

34
namespace VLC
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
35 36
{

37
class AudioOutputDeviceDescription;
38
class Equalizer;
39 40
class Instance;
class Media;
41
class MediaPlayerEventManager;
42
class TrackDescription;
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
43

Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
44 45 46
///
/// \brief The MediaPlayer class exposes libvlc_media_player_t functionnalities
///
47
class MediaPlayer : private CallbackOwner<13>, public Internal<libvlc_media_player_t>
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
48
{
49
private:
50
    enum class CallbackIdx : unsigned int
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
    {
        AudioPlay,
        AudioPause,
        AudioResume,
        AudioFlush,
        AudioDrain,
        AudioVolume,
        AudioSetup,
        AudioCleanup,

        VideoLock,
        VideoUnlock,
        VideoDisplay,
        VideoFormat,
        VideoCleanup,
    };
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
67 68 69 70 71 72
public:
    /**
     * Check if 2 MediaPlayer objects contain the same libvlc_media_player_t.
     * \param another another MediaPlayer
     * \return true if they contain the same libvlc_media_player_t
     */
73 74 75 76
    bool operator==(const MediaPlayer& another) const
    {
        return m_obj == another.m_obj;
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
77 78 79 80 81 82 83

    /**
     * Create an empty Media Player object
     *
     * \param p_libvlc_instance  the libvlc instance in which the Media
     * Player should be created.
     */
84
    MediaPlayer( Instance& instance )
85
        : Internal{ libvlc_media_player_new( instance ), libvlc_media_player_release }
86 87
    {
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
88 89 90 91 92 93

    /**
     * Create a Media Player object from a Media
     *
     * \param p_md  the media. Afterwards the p_md can be safely destroyed.
     */
94
    MediaPlayer( Media& md )
95 96 97 98 99 100
        : Internal{ libvlc_media_player_new_from_media(
                        getInternalPtr<libvlc_media_t>( md ) ),
                    libvlc_media_player_release }
    {
    }

101
/**
102 103 104 105 106
     * Create an empty VLC MediaPlayer instance.
     *
     * Calling any method on such an instance is undefined.
    */
    MediaPlayer() = default;
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
107 108 109 110 111 112 113

    /**
     * Set the media that will be used by the media_player. If any, previous
     * md will be released.
     *
     * \param p_md  the Media. Afterwards the p_md can be safely destroyed.
     */
114
    void setMedia(Media& md)
115
    {
116
        libvlc_media_player_set_media( *this, getInternalPtr<libvlc_media_t>( md ) );
117
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
118 119 120 121 122 123 124

    /**
     * Get the media used by the media_player.
     *
     * \return the media associated with p_mi, or NULL if no media is
     * associated
     */
125 126
    MediaPtr media()
    {
127 128 129
        auto media = libvlc_media_player_get_media(*this);
        if ( media == nullptr )
            return nullptr;
130
        return std::make_shared<Media>( media, false );
131
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
132 133 134 135 136 137

    /**
     * Get the Event Manager from which the media player send event.
     *
     * \return the event manager associated with p_mi
     */
138
    MediaPlayerEventManager& eventManager()
139
    {
140
        if ( m_eventManager == nullptr )
141
        {
142
            libvlc_event_manager_t* obj = libvlc_media_player_event_manager( *this );
143
            m_eventManager = std::make_shared<MediaPlayerEventManager>( obj );
144
        }
145
        return *m_eventManager;
146
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
147 148

    /**
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
149
     * \return true if the media player is playing, 0 otherwise
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
150
     */
151 152
    bool isPlaying()
    {
153
        return libvlc_media_player_is_playing(*this) != 0;
154
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
155 156

    /**
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
157
     * @brief play Start playback
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
158
     *
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
159
     * If playback was already started, this method has no effect
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
160
     */
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
161
    bool play()
162
    {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
163
        return libvlc_media_player_play(*this) == 0;
164
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
165 166 167 168

    /**
     * Pause or resume (no effect if there is no media)
     *
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
169
     * \param do_pause  play/resume if true, pause if false
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
170 171 172
     *
     * \version LibVLC 1.1.1 or later
     */
173
    void setPause(bool pause)
174
    {
175
        libvlc_media_player_set_pause(*this, pause);
176
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
177 178

    /**
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
179
     * @brief pause Toggle pause (no effect if there is no media)
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
180
     */
181 182
    void pause()
    {
183
        libvlc_media_player_pause(*this);
184
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
185 186

    /**
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
187 188 189 190 191
     * @brief stop Stop the playback (no effect if there is no media)
     *
     * \warning This is synchronous, and will block until all VLC threads have
     *          been joined.
     *          Calling this from a VLC callback is a bound to cause a deadlock.
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
192
     */
193 194
    void stop()
    {
195
        libvlc_media_player_stop(*this);
196
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
197 198 199 200 201 202 203 204

    /**
     * Set the NSView handler where the media player should render its video
     * output.
     *
     * Use the vout called "macosx".
     *
     * The drawable is an NSObject that follow the
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
205
     * VLCOpenGLVideoViewEmbedding protocol: VLCOpenGLVideoViewEmbedding <NSObject>
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219
     *
     * Or it can be an NSView object.
     *
     * If you want to use it along with Qt4 see the QMacCocoaViewContainer.
     * Then the following code should work:  { NSView *video = [[NSView
     * alloc] init]; QMacCocoaViewContainer *container = new
     * QMacCocoaViewContainer(video, parent);
     * libvlc_media_player_set_nsobject(mp, video); [video release]; }
     *
     * You can find a live example in VLCVideoView in VLCKit.framework.
     *
     * \param drawable  the drawable that is either an NSView or an object
     * following the VLCOpenGLVideoViewEmbedding protocol.
     */
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
220
    void setNsobject(void* drawable)
221
    {
222
        libvlc_media_player_set_nsobject(*this, drawable);
223
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
224 225 226 227 228 229 230

    /**
     * Get the NSView handler previously set with MediaPlayer::setNsobject()
     * .
     *
     * \return the NSView handler or 0 if none where set
     */
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
231
    void* nsobject()
232
    {
233
        return libvlc_media_player_get_nsobject(*this);
234
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249

    /**
     * Set an X Window System drawable where the media player should render
     * its video output. If LibVLC was built without X11 output support, then
     * this has no effects.
     *
     * The specified identifier must correspond to an existing Input/Output
     * class X11 window. Pixmaps are supported. The caller shall ensure that
     * the X11 server is the same as the one the VLC instance has been
     * configured with. This function must be called before video playback is
     * started; otherwise it will only take effect after playback stop and
     * restart.
     *
     * \param drawable  the ID of the X window
     */
250 251
    void setXwindow(uint32_t drawable)
    {
252
        libvlc_media_player_set_xwindow(*this, drawable);
253
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
254 255 256 257 258 259 260 261 262

    /**
     * Get the X Window System window identifier previously set with
     * MediaPlayer::setXwindow() . Note that this will return the identifier
     * even if VLC is not currently using it (for instance if it is playing
     * an audio-only input).
     *
     * \return an X window ID, or 0 if none where set.
     */
263 264
    uint32_t xwindow()
    {
265
        return libvlc_media_player_get_xwindow(*this);
266
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
267 268 269 270 271 272 273 274

    /**
     * Set a Win32/Win64 API window handle (HWND) where the media player
     * should render its video output. If LibVLC was built without
     * Win32/Win64 API output support, then this has no effects.
     *
     * \param drawable  windows handle of the drawable
     */
275 276
    void setHwnd(void * drawable)
    {
277
        libvlc_media_player_set_hwnd(*this, drawable);
278
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
279 280 281 282 283 284

    /**
     * Get the Windows API window handle (HWND) previously set with
     * MediaPlayer::setHwnd() . The handle will be returned even if LibVLC is
     * not currently outputting any video to it.
     *
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
285
     * \return a window handle or nullptr if there are none.
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
286
     */
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
287
    void* hwnd()
288
    {
289
        return libvlc_media_player_get_hwnd(*this);
290
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
291 292 293 294 295 296

    /**
     * Get the current movie length (in ms).
     *
     * \return the movie length (in ms), or -1 if there is no media.
     */
297 298
    libvlc_time_t length()
    {
299
        return libvlc_media_player_get_length(*this);
300
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
301 302 303 304 305 306

    /**
     * Get the current movie time (in ms).
     *
     * \return the movie time (in ms), or -1 if there is no media.
     */
307 308
    libvlc_time_t time()
    {
309
        return  libvlc_media_player_get_time(*this);
310
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
311 312 313 314 315 316 317

    /**
     * Set the movie time (in ms). This has no effect if no media is being
     * played. Not all formats and protocols support this.
     *
     * \param i_time  the movie time (in ms).
     */
318 319
    void setTime(libvlc_time_t i_time)
    {
320
        libvlc_media_player_set_time(*this, i_time);
321
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
322 323 324 325 326 327

    /**
     * Get movie position as percentage between 0.0 and 1.0.
     *
     * \return movie position, or -1. in case of error
     */
328 329
    float position()
    {
330
        return libvlc_media_player_get_position(*this);
331
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
332 333 334 335 336 337 338 339

    /**
     * Set movie position as percentage between 0.0 and 1.0. This has no
     * effect if playback is not enabled. This might not work depending on
     * the underlying input format and protocol.
     *
     * \param f_pos  the position
     */
340 341
    void setPosition(float f_pos)
    {
342
        libvlc_media_player_set_position(*this, f_pos);
343
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
344 345 346 347 348 349

    /**
     * Set movie chapter (if applicable).
     *
     * \param i_chapter  chapter number to play
     */
350 351
    void setChapter(int i_chapter)
    {
352
        libvlc_media_player_set_chapter(*this, i_chapter);
353
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
354 355 356 357 358 359

    /**
     * Get movie chapter.
     *
     * \return chapter number currently playing, or -1 if there is no media.
     */
360 361
    int chapter()
    {
362
        return libvlc_media_player_get_chapter(*this);
363
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
364 365 366 367 368 369

    /**
     * Get movie chapter count
     *
     * \return number of chapters in movie, or -1.
     */
370 371
    int chapterCount()
    {
372
        return libvlc_media_player_get_chapter_count(*this);
373
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
374 375 376 377 378 379

    /**
     * Is the player able to play
     *
     * \return boolean
     */
380 381
    bool willPlay()
    {
382
        return libvlc_media_player_will_play(*this) != 0;
383
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
384 385 386 387 388 389 390 391

    /**
     * Get title chapter count
     *
     * \param i_title  title
     *
     * \return number of chapters in title, or -1
     */
392 393
    int chapterCountForTitle(int i_title)
    {
394
        return libvlc_media_player_get_chapter_count_for_title(*this, i_title);
395
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
396 397 398 399 400 401

    /**
     * Set movie title
     *
     * \param i_title  title number to play
     */
402 403
    void setTitle(int i_title)
    {
404
        libvlc_media_player_set_title(*this, i_title);
405
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
406 407 408 409 410 411

    /**
     * Get movie title
     *
     * \return title number currently playing, or -1
     */
412 413
    int title()
    {
414
        return libvlc_media_player_get_title(*this);
415
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
416 417 418 419 420 421

    /**
     * Get movie title count
     *
     * \return title number count, or -1
     */
422 423
    int titleCount()
    {
424
        return libvlc_media_player_get_title_count(*this);
425
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
426 427 428 429

    /**
     * Set previous chapter (if applicable)
     */
430 431
    void previousChapter()
    {
432
        libvlc_media_player_previous_chapter(*this);
433
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
434 435 436 437

    /**
     * Set next chapter (if applicable)
     */
438 439
    void nextChapter()
    {
440
        libvlc_media_player_next_chapter(*this);
441
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
442 443 444 445 446 447 448 449 450

    /**
     * Get the requested movie play rate.
     *
     * \warning Depending on the underlying media, the requested rate may be
     * different from the real playback rate.
     *
     * \return movie play rate
     */
451 452
    float rate()
    {
453
        return libvlc_media_player_get_rate(*this);
454
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
455 456 457 458 459 460 461 462 463

    /**
     * Set movie play rate
     *
     * \param rate  movie play rate to set
     *
     * \return -1 if an error was detected, 0 otherwise (but even then, it
     * might not actually work depending on the underlying media protocol)
     */
464 465
    int setRate(float rate)
    {
466
        return libvlc_media_player_set_rate(*this, rate);
467
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
468 469 470 471 472 473 474 475

    /**
     * Get current movie state
     *
     * \return the current state of the media player (playing, paused, ...)
     *
     * \see libvlc_state_t
     */
476 477
    libvlc_state_t state()
    {
478
        return libvlc_media_player_get_state(*this);
479
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
480

481
#if LIBVLC_VERSION_INT < LIBVLC_VERSION(3, 0, 0, 0)
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
482 483 484 485 486 487
    /**
     * Get movie fps rate
     *
     * \return frames per second (fps) for this playing movie, or 0 if
     * unspecified
     */
488 489
    float fps()
    {
490
        return libvlc_media_player_get_fps(*this);
491
    }
492
#endif
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
493 494

    /**
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
495
     * Get the amount of video outputs this media player has?
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
496 497 498
     *
     * \return the number of video outputs
     */
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
499
    uint32_t hasVout()
500
    {
501
        return libvlc_media_player_has_vout(*this);
502
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
503 504 505 506 507 508

    /**
     * Is this media player seekable?
     *
     * \return true if the media player can seek
     */
509 510
    bool isSeekable()
    {
511
        return libvlc_media_player_is_seekable(*this) != 0;
512
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
513 514 515 516 517 518

    /**
     * Can this media player be paused?
     *
     * \return true if the media player can pause
     */
519 520
    bool canPause()
    {
521
        return libvlc_media_player_can_pause(*this) != 0;
522
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
523 524 525 526 527 528 529 530

    /**
     * Check if the current program is scrambled
     *
     * \return true if the current program is scrambled
     *
     * \version LibVLC 2.2.0 or later
     */
531 532
    bool programScrambled()
    {
533
        return libvlc_media_player_program_scrambled(*this) != 0;
534
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
535 536 537 538

    /**
     * Display the next frame (if supported)
     */
539 540
    void nextFrame()
    {
541
        libvlc_media_player_next_frame(*this);
542
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
543 544 545 546 547 548 549 550

    /**
     * Navigate through DVD Menu
     *
     * \param navigate  the Navigation mode
     *
     * \version libVLC 2.0.0 or later
     */
551 552
    void navigate(unsigned navigate)
    {
553
        libvlc_media_player_navigate(*this, navigate);
554
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
555 556 557 558 559 560 561 562 563 564 565 566

    /**
     * Set if, and how, the video title will be shown when media is played.
     *
     * \param position  position at which to display the title, or
     * libvlc_position_disable to prevent the title from being displayed
     *
     * \param timeout  title display timeout in milliseconds (ignored if
     * libvlc_position_disable)
     *
     * \version libVLC 2.1.0 or later
     */
567 568
    void setVideoTitleDisplay(libvlc_position_t position, unsigned int timeout)
    {
569
        libvlc_media_player_set_video_title_display(*this, position, timeout);
570
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
571 572 573 574 575 576 577

    /**
     * Toggle fullscreen status on non-embedded video outputs.
     *
     * \warning The same limitations applies to this function as to
     * MediaPlayer::setFullscreen() .
     */
578 579
    void toggleFullscreen()
    {
580
        libvlc_toggle_fullscreen(*this);
581
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
582 583 584 585 586 587 588 589 590 591 592 593 594

    /**
     * Enable or disable fullscreen.
     *
     * \warning With most window managers, only a top-level windows can be in
     * full-screen mode. Hence, this function will not operate properly if
     * MediaPlayer::setXwindow() was used to embed the video in a non-top-
     * level window. In that case, the embedding window must be reparented to
     * the root window fullscreen mode is enabled. You will want to reparent
     * it back to its normal parent when disabling fullscreen.
     *
     * \param b_fullscreen  boolean for fullscreen status
     */
595
    void setFullscreen(bool fullscreen)
596
    {
597
        libvlc_set_fullscreen( *this, fullscreen );
598
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
599 600 601 602 603 604

    /**
     * Get current fullscreen status.
     *
     * \return the fullscreen status (boolean)
     */
605 606
    bool fullscreen()
    {
607
        return libvlc_get_fullscreen(*this) != 0;
608
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
609

610
#if LIBVLC_VERSION_INT < LIBVLC_VERSION(3, 0, 0, 0)
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
611 612 613
    /**
     * Toggle teletext transparent status on video output.
     */
614 615
    void toggleTeletext()
    {
616
        libvlc_toggle_teletext(*this);
617
    }
618
#endif
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645

    /**
     * Apply new equalizer settings to a media player.
     *
     * The equalizer is first created by invoking
     * libvlc_audio_equalizer_new() or
     * libvlc_audio_equalizer_new_from_preset() .
     *
     * It is possible to apply new equalizer settings to a media player
     * whether the media player is currently playing media or not.
     *
     * Invoking this method will immediately apply the new equalizer settings
     * to the audio output of the currently playing media if there is any.
     *
     * If there is no currently playing media, the new equalizer settings
     * will be applied later if and when new media is played.
     *
     * Equalizer settings will automatically be applied to subsequently
     * played media.
     *
     * To disable the equalizer for a media player invoke this method passing
     * NULL for the p_equalizer parameter.
     *
     * The media player does not keep a reference to the supplied equalizer
     * so it is safe for an application to release the equalizer reference
     * any time after this method returns.
     *
646
     * \param equalizer  The equalizer to be used by this media player
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
647
     *
648
     * \return true on success, false otherwise
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
649 650 651
     *
     * \version LibVLC 2.2.0 or later
     */
652 653 654 655 656 657 658 659 660 661 662
    bool setEqualizer(Equalizer& equalizer)
    {
        return libvlc_media_player_set_equalizer( *this, equalizer ) == 0;
    }

    ///
    /// \brief unsetEqualizer disable equalizer for this media player
    ///
    /// \return true on success, false otherwise.
    ///
    bool unsetEqualizer()
663
    {
664
        return libvlc_media_player_set_equalizer( *this, nullptr ) == 0;
665
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
666

667 668 669 670 671
    /**
     * Set callbacks and private data for decoded audio. Use
     * MediaPlayer::setFormat() or MediaPlayer::setFormatCallbacks() to configure the
     * decoded audio format.
     *
672 673
     * \param play  callback to play audio samples (must not be nullptr)
     *              Required prototype is: void(const void *samples, unsigned count, int64_t pts)
674
     *
675 676
     * \param pause  callback to pause playback (or nullptr to ignore)
     *               Required prototype is void(int64_t pts);
677
     *
678 679
     * \param resume callback to resume playback (or nullptr to ignore)
     *               Required prototype is void(int64_t pts);
680
     *
681 682
     * \param flush  callback to flush audio buffers (or nullptr to ignore)
     *               Required prototype is void(int64_t pts);
683
     *
684 685
     * \param drain  callback to drain audio buffers (or nullptr to ignore)
     * *             Required prototype is void();
686 687 688
     *
     * \version LibVLC 2.0.0 or later
     */
689 690
    template <typename PlayCb, typename PauseCb, typename ResumeCb, typename FlushCb, typename DrainCb>
    void setAudioCallbacks(PlayCb&& play, PauseCb&& pause, ResumeCb&& resume, FlushCb&& flush, DrainCb&& drain)
691
    {
692 693 694 695 696 697 698
        static_assert(signature_match<PlayCb, void(const void*, unsigned int, int64_t)>::value, "Mismatched play callback prototype");
        static_assert(signature_match_or_nullptr<PauseCb, void(int64_t)>::value, "Mismatched pause callback prototype");
        static_assert(signature_match_or_nullptr<ResumeCb, void(int64_t)>::value, "Mismatched resume callback prototype");
        static_assert(signature_match_or_nullptr<FlushCb, void(int64_t pts)>::value, "Mismatched flush callback prototype");
        static_assert(signature_match_or_nullptr<DrainCb, void()>::value, "Mismatched drain callback prototype");

        libvlc_audio_set_callbacks( *this,
699 700 701 702 703
            CallbackWrapper<(unsigned int)CallbackIdx::AudioPlay,   libvlc_audio_play_cb>::wrap(   *m_callbacks, std::forward<PlayCb>( play ) ),
            CallbackWrapper<(unsigned int)CallbackIdx::AudioPause,  libvlc_audio_pause_cb>::wrap(  *m_callbacks, std::forward<PauseCb>( pause ) ),
            CallbackWrapper<(unsigned int)CallbackIdx::AudioResume, libvlc_audio_resume_cb>::wrap( *m_callbacks, std::forward<ResumeCb>( resume ) ),
            CallbackWrapper<(unsigned int)CallbackIdx::AudioFlush,  libvlc_audio_flush_cb>::wrap(  *m_callbacks, std::forward<FlushCb>( flush ) ),
            CallbackWrapper<(unsigned int)CallbackIdx::AudioDrain,  libvlc_audio_drain_cb>::wrap(  *m_callbacks, std::forward<DrainCb>( drain ) ),
704
            // We will receive the pointer as a void*, we need to offset the value *now*, otherwise we'd get
705
            // a shifted value, resulting in an invalid callback array.
706
            m_callbacks.get() );
707
    }
708 709 710 711 712 713

    /**
     * Set callbacks and private data for decoded audio. Use
     * MediaPlayer::setFormat() or MediaPlayer::setFormatCallbacks() to configure the
     * decoded audio format.
     *
714 715 716
     * \param set_volume  callback to apply audio volume, or nullptr to apply
     *                    volume in software
     *                    Expected prototype is void(float volume, bool mute)
717 718 719
     *
     * \version LibVLC 2.0.0 or later
     */
720 721
    template <typename VolumeCb>
    void setVolumeCallback(VolumeCb&& func)
722
    {
723 724
        static_assert(signature_match_or_nullptr<VolumeCb, void(float, bool)>::value, "Mismatched set volume callback");
        libvlc_audio_set_volume_callback(*this,
725
            CallbackWrapper<(unsigned int)CallbackIdx::AudioVolume, libvlc_audio_set_volume_cb>::wrap( this, std::forward<VolumeCb>( func ) ) );
726
    }
727 728 729 730 731

    /**
     * Set decoded audio format. This only works in combination with
     * MediaPlayer::setCallbacks() .
     *
732 733 734
     * \param setup  callback to select the audio format (cannot be a nullptr)
     *               Expected prototype is int(char *format, unsigned *rate, unsigned *channels)
     *               Where the return value is 0 for success, anything else to skip audio playback
735
     *
736 737
     * \param cleanup  callback to release any allocated resources (or nullptr)
     *                 Expected prototype is void()
738 739 740
     *
     * \version LibVLC 2.0.0 or later
     */
741 742
    template <typename SetupCb, typename CleanupCb>
    void setAudioFormatCallbacks(SetupCb&& setup, CleanupCb&& cleanup)
743
    {
744 745 746 747
        static_assert(signature_match<SetupCb, int(char*, uint32_t*, uint32_t*)>::value, "Mismatched Setup callback");
        static_assert(signature_match_or_nullptr<CleanupCb, void()>::value, "Mismatched cleanup callback");

        libvlc_audio_set_format_callbacks(*this,
748 749
            CallbackWrapper<(unsigned int)CallbackIdx::AudioSetup, libvlc_audio_setup_cb>::wrap( this, std::forward<SetupCb>( setup ) ),
            CallbackWrapper<(unsigned int)CallbackIdx::AudioCleanup, libvlc_audio_cleanup_cb>::wrap( this, std::forward<CleanupCb>( cleanup ) ) );
750
    }
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765

    /**
     * Set decoded audio format. This only works in combination with
     * MediaPlayer::setCallbacks() , and is mutually exclusive with
     * MediaPlayer::setFormatCallbacks() .
     *
     * \param format  a four-characters string identifying the sample format
     * (e.g. "S16N" or "FL32")
     *
     * \param rate  sample rate (expressed in Hz)
     *
     * \param channels  channels count
     *
     * \version LibVLC 2.0.0 or later
     */
766 767
    void setAudioFormat(const std::string& format, unsigned rate, unsigned channels)
    {
768
        libvlc_audio_set_format(*this, format.c_str(), rate, channels);
769
    }
770 771 772 773 774 775 776

    /**
     * Selects an audio output module.
     *
     * \note Any change will take be effect only after playback is stopped
     * and restarted. Audio output cannot be changed while playing.
     *
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
777
     * \param name  name of audio output, use psz_name of
778 779 780 781 782
     *
     * \see AudioOutputDescription
     *
     * \return 0 if function succeded, -1 on error
     */
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
783
    int setAudioOutput(const std::string& name)
784
    {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
785
        return libvlc_audio_output_set(*this, name.c_str());
786
    }
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803

    /**
     * Gets a list of potential audio output devices,
     *
     * \see MediaPlayer::outputDeviceSet() .
     *
     * \note Not all audio outputs support enumerating devices. The audio
     * output may be functional even if the list is empty (NULL).
     *
     * \note The list may not be exhaustive.
     *
     * \warning Some audio output devices in the list might not actually work
     * in some circumstances. By default, it is recommended to not specify
     * any explicit audio device.
     *
     * \version LibVLC 2.2.0 or later.
     */
804 805
    std::vector<AudioOutputDeviceDescription> outputDeviceEnum()
    {
806 807 808
        auto devices = libvlc_audio_output_device_enum(*this);
        if ( devices == nullptr )
            return {};
809
        std::vector<AudioOutputDeviceDescription> res;
810 811
        std::unique_ptr<libvlc_audio_output_device_t, decltype(&libvlc_audio_output_device_list_release)>
                devicesPtr( devices, libvlc_audio_output_device_list_release);
812 813
        for ( auto* p = devices; p != NULL; p = p->p_next )
            res.emplace_back( p );
814 815
        return res;
    }
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854

    /**
     * Configures an explicit audio output device.
     *
     * If the module paramater is NULL, audio output will be moved to the
     * device specified by the device identifier string immediately. This is
     * the recommended usage.
     *
     * A list of adequate potential device strings can be obtained with
     * MediaPlayer::outputDeviceEnum() .
     *
     * However passing NULL is supported in LibVLC version 2.2.0 and later
     * only; in earlier versions, this function would have no effects when
     * the module parameter was NULL.
     *
     * If the module parameter is not NULL, the device parameter of the
     * corresponding audio output, if it exists, will be set to the specified
     * string. Note that some audio output modules do not have such a
     * parameter (notably MMDevice and PulseAudio).
     *
     * A list of adequate potential device strings can be obtained with
     * Instance::audioOutputDeviceList() .
     *
     * \note This function does not select the specified audio output plugin.
     * MediaPlayer::outputSet() is used for that purpose.
     *
     * \warning The syntax for the device parameter depends on the audio
     * output. Some audio output modules require further parameters (e.g. a
     * channels map in the case of ALSA).
     *
     * \param module  If NULL, current audio output module. if non-NULL, name
     * of audio output module (
     *
     * \see AudioOutputDescription )
     *
     * \param device_id  device identifier string
     *
     * \return Nothing. Errors are ignored (this is a design bug).
     */
855 856
    void outputDeviceSet(const std::string& module, const std::string& device_id)
    {
857
        libvlc_audio_output_device_set(*this, module.c_str(), device_id.c_str());
858
    }
859

860 861 862 863 864
    void outputDeviceSet(const std::string& device_id)
    {
        libvlc_audio_output_device_set(*this, nullptr, device_id.c_str());
    }

865 866 867 868 869 870 871 872
    /**
     * Toggle mute status.
     *
     * \warning Toggling mute atomically is not always possible: On some
     * platforms, other processes can mute the VLC audio playback stream
     * asynchronously. Thus, there is a small race condition where toggling
     * will not work. See also the limitations of MediaPlayer::setMute() .
     */
873 874
    void toggleMute()
    {
875
        libvlc_audio_toggle_mute(*this);
876
    }
877 878 879 880

    /**
     * Get current mute status.
     */
881
    bool mute()
882
    {
883
        return libvlc_audio_get_mute( *this ) == 1;
884
    }
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899

    /**
     * Set mute status.
     *
     * \param status  If status is true then mute, otherwise unmute
     *
     * \warning This function does not always work. If there are no active
     * audio playback stream, the mute status might not be available. If
     * digital pass-through (S/PDIF, HDMI...) is in use, muting may be
     * unapplicable. Also some audio output plugins do not support muting at
     * all.
     *
     * \note To force silent playback, disable all audio tracks. This is more
     * efficient and reliable than mute.
     */
900
    void setMute(bool mute)
901
    {
902
        libvlc_audio_set_mute( *this, (int)mute );
903
    }
904 905 906 907 908 909 910

    /**
     * Get current software audio volume.
     *
     * \return the software volume in percents (0 = mute, 100 = nominal /
     * 0dB)
     */
911 912
    int volume()
    {
913
        return libvlc_audio_get_volume(*this);
914
    }
915 916 917 918 919 920

    /**
     * Set current software audio volume.
     *
     * \param i_volume  the volume in percents (0 = mute, 100 = 0dB)
     */
921
    bool setVolume(int i_volume)
922
    {
923
        return libvlc_audio_set_volume(*this, i_volume) == 0;
924
    }
925 926 927 928 929 930 931

    /**
     * Get number of available audio tracks.
     *
     * \return the number of available audio tracks (int), or -1 if
     * unavailable
     */
932 933
    int audioTrackCount()
    {
934
        return libvlc_audio_get_track_count(*this);
935
    }
936 937 938 939

    /**
     * Get the description of available audio tracks.
     *
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
940
     * \return list with description of available audio tracks
941
     */
942 943
    std::vector<TrackDescription> audioTrackDescription()
    {
944
        libvlc_track_description_t* result = libvlc_audio_get_track_description( *this );
945 946
        return getTracksDescription( result );
    }
947 948 949 950 951 952

    /**
     * Get current audio track.
     *
     * \return the audio track ID or -1 if no active input.
     */
953 954
    int audioTrack()
    {
955
        return libvlc_audio_get_track(*this);
956
    }
957 958 959 960 961 962

    /**
     * Set current audio track.
     *
     * \param i_track  the track ID (i_id field from track description)
     */
963
    bool setAudioTrack(int i_track)
964
    {
965
        return libvlc_audio_set_track(*this, i_track) == 0;
966
    }
967 968 969 970 971 972 973 974

    /**
     * Get current audio channel.
     *
     * \return the audio channel
     *
     * \see libvlc_audio_output_channel_t
     */
975 976
    int channel()
    {
977
        return libvlc_audio_get_channel(*this);
978
    }
979 980 981 982 983 984 985 986

    /**
     * Set current audio channel.
     *
     * \param channel  the audio channel,
     *
     * \see libvlc_audio_output_channel_t
     */
987
    bool setChannel(int channel)
988
    {
989
        return libvlc_audio_set_channel(*this, channel) == 0;
990
    }
991 992 993 994 995 996 997 998

    /**
     * Get current audio delay.
     *
     * \return the audio delay (microseconds)
     *
     * \version LibVLC 1.1.1 or later
     */
999
    int64_t audioDelay()
1000
    {
1001
        return libvlc_audio_get_delay(*this);
1002
    }
1003 1004 1005 1006 1007 1008 1009 1010 1011

    /**
     * Set current audio delay. The audio delay will be reset to zero each
     * time the media changes.
     *
     * \param i_delay  the audio delay (microseconds)
     *
     * \version LibVLC 1.1.1 or later
     */
1012
    bool setAudioDelay(int64_t i_delay)
1013
    {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1014
        return libvlc_audio_set_delay(*this, i_delay) == 0;
1015
    }
1016 1017 1018 1019 1020 1021

    /**
     * Set callbacks and private data to render decoded video to a custom
     * area in memory. Use MediaPlayer::setFormat() or MediaPlayer::setFormatCallbacks()
     * to configure the decoded format.
     *
1022 1023 1024 1025
     * \param lock  callback to lock video memory (must not be nullptr)
     *              Expected prototype is void*(void** planes)
     *              planes is a pointer to an array of planes, that must be provided with some allocated buffers
     *              Return value is a picture identifier, to be passed to unlock & display callbacks
1026
     *
1027 1028 1029 1030
     * \param unlock  callback to unlock video memory (or nullptr if not needed)
     *                Expected prototype is void(void* pictureId, void*const* planes);
     *                pictureId is the value returned by the lock callback.
     *                planes is the planes provided by the lock callback
1031
     *
1032 1033 1034
     * \param display callback to display video (or nullptr if not needed)
     *                Expected prototype is void(void* pictureId);
     *                pictureId is the value returned by the lock callback.
1035 1036 1037
     *
     * \version LibVLC 1.1.1 or later
     */
1038 1039
    template <typename LockCb, typename UnlockCb, typename DisplayCb>
    void setVideoCallbacks(LockCb&& lock, UnlockCb&& unlock, DisplayCb&& display)
1040
    {
1041 1042 1043 1044 1045
        static_assert(signature_match<LockCb, void*(void**)>::value, "Mismatched lock callback signature");
        static_assert(signature_match_or_nullptr<UnlockCb, void(void*, void *const *)>::value, "Mismatched unlock callback signature");
        static_assert(signature_match_or_nullptr<DisplayCb, void(void*)>::value, "Mismatched lock callback signature");

        libvlc_video_set_callbacks(*this,
1046 1047 1048
                CallbackWrapper<(unsigned int)CallbackIdx::VideoLock, libvlc_video_lock_cb>::wrap( *m_callbacks, std::forward<LockCb>( lock ) ),
                CallbackWrapper<(unsigned int)CallbackIdx::VideoUnlock, libvlc_video_unlock_cb>::wrap( *m_callbacks, std::forward<UnlockCb>( unlock ) ),
                CallbackWrapper<(unsigned int)CallbackIdx::VideoDisplay, libvlc_video_display_cb>::wrap( *m_callbacks, std::forward<DisplayCb>( display ) ),
1049 1050
                // We will receive the pointer as a void*, we need to offset the value *now*, otherwise we'd get
                // a shifted value, resulting in an empty callback array.
1051
                m_callbacks.get() );
1052
    }
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069

    /**
     * Set decoded video chroma and dimensions. This only works in
     * combination with MediaPlayer::setCallbacks() , and is mutually exclusive
     * with MediaPlayer::setFormatCallbacks() .
     *
     * \param chroma  a four-characters string identifying the chroma (e.g.
     * "RV32" or "YUYV")
     *
     * \param width  pixel width
     *
     * \param height  pixel height
     *
     * \param pitch  line pitch (in bytes)
     *
     * \version LibVLC 1.1.1 or later
     */
1070 1071
    void setVideoFormat(const std::string& chroma, unsigned width, unsigned height, unsigned pitch)
    {
1072
        libvlc_video_set_format(*this, chroma.c_str(), width, height, pitch);
1073
    }
1074 1075 1076 1077 1078

    /**
     * Set decoded video chroma and dimensions. This only works in
     * combination with MediaPlayer::setCallbacks() .
     *
1079 1080 1081 1082 1083 1084 1085
     * \param setup  callback to lock video memory (must not be nullptr)
     *              Expected prototype is uint32_t(char *chroma,       // Must be filled with the required fourcc
     *                                              unsigned *width,   // Must be filled with the required width
     *                                              unsigned *height,  // Must be filled with the required height
     *                                              unsigned *pitches, // Must be filled with the required pitch for each plane
     *                                              unsigned *lines);  // Must be filled with the required number of lines for each plane
     *              The return value reprensent the amount of pictures to create in a pool. 0 to indicate an error
1086
     *
1087 1088
     * \param cleanup  callback to release any allocated resources (or nullptr)
     *                 Expected prototype is void()
1089 1090 1091
     *
     * \version LibVLC 2.0.0 or later
     */
1092 1093
    template <typename FormatCb, typename CleanupCb>
    void setVideoFormatCallbacks(FormatCb&& setup, CleanupCb&& cleanup)
1094
    {
1095 1096 1097 1098 1099
        static_assert(signature_match<FormatCb, uint32_t(char*, uint32_t*, uint32_t*, uint32_t*, uint32_t*)>::value,
                      "Unmatched prototype for format callback" );
        static_assert(signature_match_or_nullptr<CleanupCb, void()>::value, "Unmatched prototype for cleanup callback");

        libvlc_video_set_format_callbacks(*this,
1100 1101
                CallbackWrapper<(unsigned int)CallbackIdx::VideoFormat, libvlc_video_format_cb>::wrap( *m_callbacks, std::forward<FormatCb>( setup ) ),
                CallbackWrapper<(unsigned int)CallbackIdx::VideoCleanup, libvlc_video_cleanup_cb>::wrap( *m_callbacks, std::forward<CleanupCb>( cleanup ) ) );
1102
    }
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118

    /**
     * Enable or disable key press events handling, according to the LibVLC
     * hotkeys configuration. By default and for historical reasons, keyboard
     * events are handled by the LibVLC video widget.
     *
     * \note On X11, there can be only one subscriber for key press and mouse
     * click events per window. If your application has subscribed to those
     * events for the X window ID of the video widget, then LibVLC will not
     * be able to handle key presses and mouse clicks in any case.
     *
     * \warning This function is only implemented for X11 and Win32 at the
     * moment.
     *
     * \param on  true to handle key press events, false to ignore them.
     */
1119
    void setKeyInput(bool enable)
1120
    {
1121
        libvlc_video_set_key_input(*this, (int)enable);
1122
    }
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135

    /**
     * Enable or disable mouse click events handling. By default, those
     * events are handled. This is needed for DVD menus to work, as well as a
     * few video filters such as "puzzle".
     *
     * \see MediaPlayer::setKeyInput() .
     *
     * \warning This function is only implemented for X11 and Win32 at the
     * moment.
     *
     * \param on  true to handle mouse click events, false to ignore them.
     */
1136
    void setMouseInput(bool enable)
1137
    {
1138
        libvlc_video_set_mouse_input(*this, (int)enable);
1139
    }
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149

    /**
     * Get the pixel dimensions of a video.
     *
     * \param num  number of the video (starting from, and most commonly 0)
     *
     * \param px  pointer to get the pixel width [OUT]
     *
     * \param py  pointer to get the pixel height [OUT]
     */
1150
    bool size(unsigned num, unsigned * px, unsigned * py)
1151
    {
1152
        return libvlc_video_get_size( *this, num, px, py ) == 0;
1153
    }
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178

    /**
     * Get the mouse pointer coordinates over a video. Coordinates are
     * expressed in terms of the decoded video resolution, in terms of pixels
     * on the screen/viewport (to get the latter, you can query your
     * windowing system directly).
     *
     * Either of the coordinates may be negative or larger than the
     * corresponding dimension of the video, if the cursor is outside the
     * rendering area.
     *
     * \warning The coordinates may be out-of-date if the pointer is not
     * located on the video rendering area. LibVLC does not track the pointer
     * if it is outside of the video widget.
     *
     * \note LibVLC does not support multiple pointers (it does of course
     * support multiple input devices sharing the same pointer) at the
     * moment.
     *
     * \param num  number of the video (starting from, and most commonly 0)
     *
     * \param px  pointer to get the abscissa [OUT]
     *
     * \param py  pointer to get the ordinate [OUT]
     */
1179
    bool cursor(unsigned num, int * px, int * py)
1180
    {
1181
        return libvlc_video_get_cursor( *this, num, px, py ) == 0;
1182
    }
1183 1184 1185 1186 1187 1188 1189

    /**
     * Get the current video scaling factor. See also MediaPlayer::setScale() .
     *
     * \return the currently configured zoom factor, or 0. if the video is
     * set to fit to the output window/drawable automatically.
     */
1190 1191
    float scale()
    {
1192
        return libvlc_video_get_scale(*this);
1193
    }
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204

    /**
     * Set the video scaling factor. That is the ratio of the number of
     * pixels on screen to the number of pixels in the original decoded video
     * in each dimension. Zero is a special value; it will adjust the video
     * to the output window/drawable (in windowed mode) or the entire screen.
     *
     * Note that not all video outputs support scaling.
     *
     * \param f_factor  the scaling factor, or zero
     */
1205 1206
    void setScale(float f_factor)
    {
1207
        libvlc_video_set_scale(*this, f_factor);
1208
    }
1209 1210 1211 1212

    /**
     * Get current video aspect ratio.
     *
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1213
     * \return the video aspect ratio or an empty string if unspecified.
1214
     */
1215 1216
    std::string aspectRatio()
    {
1217 1218 1219 1220
        auto str = wrapCStr( libvlc_video_get_aspect_ratio(*this) );
        if ( str == nullptr )
            return {};
        return str.get();
1221
    }
1222 1223 1224 1225

    /**
     * Set new video aspect ratio.
     *
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1226
     * \param psz_aspect  new video aspect-ratio or empty string to reset to default
1227 1228 1229
     *
     * \note Invalid aspect ratios are ignored.
     */
1230
    void setAspectRatio( const std::string& ar )
1231
    {
1232
        libvlc_video_set_aspect_ratio( *this, ar.size() > 0 ? ar.c_str() : nullptr );
1233
    }
1234 1235 1236 1237 1238 1239

    /**
     * Get current video subtitle.
     *
     * \return the video subtitle selected, or -1 if none
     */
1240 1241
    int spu()
    {
1242
        return libvlc_video_get_spu(*this);
1243
    }
1244 1245 1246 1247 1248 1249

    /**
     * Get the number of available video subtitles.
     *
     * \return the number of available video subtitles
     */
1250 1251
    int spuCount()
    {
1252
        return libvlc_video_get_spu_count(*this);
1253
    }
1254 1255 1256 1257 1258 1259

    /**
     * Get the description of available video subtitles.
     *
     * \return list containing description of available video subtitles
     */
1260 1261
    std::vector<TrackDescription> spuDescription()
    {
1262
        libvlc_track_description_t* result = libvlc_video_get_spu_description( *this );
1263 1264
        return getTracksDescription( result );
    }
1265 1266 1267 1268 1269 1270 1271 1272 1273

    /**
     * Set new video subtitle.
     *
     * \param i_spu  video subtitle track to select (i_id from track
     * description)
     *
     * \return 0 on success, -1 if out of range
     */
1274 1275
    int setSpu(int i_spu)
    {
1276
        return libvlc_video_set_spu(*this, i_spu);
1277
    }
1278

1279
#if LIBVLC_VERSION_INT < LIBVLC_VERSION(3, 0, 0, 0)
1280 1281 1282 1283 1284
    /**
     * Set new video subtitle file.
     *
     * \param psz_subtitle  new video subtitle file
     */
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1285
    bool setSubtitleFile(const std::string& psz_subtitle)
1286
    {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1287
        return libvlc_video_set_subtitle_file(*this, psz_subtitle.c_str()) != 0;
1288
    }
1289
#endif
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299

    /**
     * Get the current subtitle delay. Positive values means subtitles are
     * being displayed later, negative values earlier.
     *
     * \return time (in microseconds) the display of subtitles is being
     * delayed
     *
     * \version LibVLC 2.0.0 or later
     */
1300 1301
    int64_t spuDelay()
    {
1302
        return libvlc_video_get_spu_delay(*this);
1303
    }
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319

    /**
     * Set the subtitle delay. This affects the timing of when the subtitle
     * will be displayed. Positive values result in subtitles being displayed
     * later, while negative values will result in subtitles being displayed
     * earlier.
     *
     * The subtitle delay will be reset to zero each time the media changes.
     *
     * \param i_delay  time (in microseconds) the display of subtitles should
     * be delayed
     *
     * \return 0 on success, -1 on error
     *
     * \version LibVLC 2.0.0 or later
     */
1320 1321
    int setSpuDelay(int64_t i_delay)
    {
1322
        return libvlc_video_set_spu_delay(*this, i_delay);
1323
    }
1324 1325 1326 1327 1328 1329

    /**
     * Get the description of available titles.
     *
     * \return list containing description of available titles
     */
1330
#if LIBVLC_VERSION_INT < LIBVLC_VERSION(3, 0, 0, 0)
1331 1332
    std::vector<TrackDescription> titleDescription()
    {
1333
        libvlc_track_description_t* result = libvlc_video_get_title_description( *this );
1334 1335
        return getTracksDescription( result );
    }
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
#else
    std::vector<TitleDescription> titleDescription()
    {
        libvlc_title_description_t **titles;
        int nbTitles = libvlc_media_player_get_full_title_descriptions( *this, &titles);
        auto cleanupCb = [nbTitles]( libvlc_title_description_t** ts) {
            libvlc_title_descriptions_release( ts, nbTitles );
        };

        std::vector<TitleDescription> res;

        if ( nbTitles < 1 )
            return res;

1350 1351
        std::unique_ptr<libvlc_title_description_t*[], decltype(cleanupCb)> ptr( titles, cleanupCb );

1352 1353
        for ( int i = 0; i < nbTitles; ++i )
            res.emplace_back( ptr[i] );
1354
        return res;
1355 1356
    }
#endif
1357 1358 1359 1360 1361 1362

    /**
     * Get the description of available chapters for specific title.
     *
     * \param i_title  selected title
     *
1363
     * \return list containing description of available chapters for title
1364 1365
     * i_title
     */
1366
#if LIBVLC_VERSION_INT < LIBVLC_VERSION(3, 0, 0, 0)
1367 1368
    std::vector<TrackDescription> chapterDescription(int i_title)
    {
1369
        libvlc_track_description_t* result = libvlc_video_get_chapter_description( *this, i_title );
1370 1371
        return getTracksDescription( result );
    }
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
#else
    std::vector<ChapterDescription> chapterDescription(int i_title)
    {
        libvlc_chapter_description_t **chapters;
        int nbChapters = libvlc_media_player_get_full_chapter_descriptions( *this, i_title, &chapters );
        auto cleanupCb = [nbChapters](libvlc_chapter_description_t** cs) {
            libvlc_chapter_descriptions_release( cs, nbChapters );
        };

        std::vector<ChapterDescription> res;

        if ( nbChapters < 1 )
            return res;

1386 1387
        std::unique_ptr<libvlc_chapter_description_t*[], decltype(cleanupCb)> ptr( chapters, cleanupCb );

1388 1389
        for ( int i = 0; i < nbChapters; ++i )
            res.emplace_back( ptr[i] );
1390
        return res;
1391 1392
    }
#endif
1393 1394 1395 1396

    /**
     * Get current crop filter geometry.
     *
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1397
     * \return the crop filter geometry or an empty string if unset
1398
     */
1399 1400
    std::string cropGeometry()
    {
1401 1402 1403 1404
        auto str = wrapCStr( libvlc_video_get_crop_geometry(*this) );
        if ( str == nullptr )
            return {};
        return str.get();
1405
    }
1406 1407 1408 1409

    /**
     * Set new crop filter geometry.
     *
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1410
     * \param psz_geometry new crop filter geometry (empty string to unset)
1411
     */
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1412
    void setCropGeometry(const std::string& geometry)
1413
    {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1414
        libvlc_video_set_crop_geometry( *this, geometry.size() > 0 ? geometry.c_str() : nullptr );
1415
    }
1416 1417 1418 1419 1420 1421

    /**
     * Get current teletext page requested.
     *
     * \return the current teletext page requested.
     */
1422 1423
    int teletext()
    {
1424
        return libvlc_video_get_teletext(*this);
1425
    }
1426 1427 1428 1429 1430 1431

    /**
     * Set new teletext page to retrieve.
     *
     * \param i_page  teletex page number requested
     */
1432 1433
    void setTeletext(int i_page)
    {
1434
        libvlc_video_set_teletext(*this, i_page);
1435
    }
1436 1437 1438 1439 1440 1441

    /**
     * Get number of available video tracks.
     *
     * \return the number of available video tracks (int)
     */
1442 1443
    int videoTrackCount()
    {
1444
        return libvlc_video_get_track_count(*this);
1445