MediaPlayer.hpp 50.3 KB
Newer Older
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
1
/*****************************************************************************
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
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@alexeysokolov.co.cc>
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 38 39 40
class AudioOutputDeviceDescription;
class TrackDescription;
class Instance;
class Media;
41
class MediaPlayerEventManager;
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
42

43
class MediaPlayer : public Internal<libvlc_media_player_t>, private EventOwner<13>
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
44
{
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
private:
    enum class EventIdx : unsigned int
    {
        AudioPlay,
        AudioPause,
        AudioResume,
        AudioFlush,
        AudioDrain,
        AudioVolume,
        AudioSetup,
        AudioCleanup,

        VideoLock,
        VideoUnlock,
        VideoDisplay,
        VideoFormat,
        VideoCleanup,
    };
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
63 64 65 66 67 68
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
     */
69 70 71 72
    bool operator==(const MediaPlayer& another) const
    {
        return m_obj == another.m_obj;
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
73 74 75 76 77 78 79 80

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

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

Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
99 100 101 102 103 104 105

    /**
     * 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.
     */
106
    void setMedia(Media& md)
107
    {
108
        libvlc_media_player_set_media( *this, getInternalPtr<libvlc_media_t>( md ) );
109
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
110 111 112 113 114 115 116

    /**
     * Get the media used by the media_player.
     *
     * \return the media associated with p_mi, or NULL if no media is
     * associated
     */
117 118
    MediaPtr media()
    {
119
        libvlc_media_t* media = libvlc_media_player_get_media(*this);
120 121
        return std::make_shared<Media>( media, true );
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
122 123 124 125 126 127

    /**
     * Get the Event Manager from which the media player send event.
     *
     * \return the event manager associated with p_mi
     */
128
    MediaPlayerEventManager& eventManager()
129 130 131
    {
        if ( m_eventManager == NULL )
        {
132
            libvlc_event_manager_t* obj = libvlc_media_player_event_manager( *this );
133
            m_eventManager = std::make_shared<MediaPlayerEventManager>( obj );
134
        }
135
        return *m_eventManager;
136
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
137 138 139 140 141 142

    /**
     * is_playing
     *
     * \return 1 if the media player is playing, 0 otherwise
     */
143 144
    bool isPlaying()
    {
145
        return libvlc_media_player_is_playing(*this) != 0;
146
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
147 148 149 150 151 152 153

    /**
     * Play
     *
     * \return 0 if playback started (and was already started), or -1 on
     * error.
     */
154 155
    int play()
    {
156
        return libvlc_media_player_play(*this);
157
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
158 159 160 161 162 163 164 165

    /**
     * Pause or resume (no effect if there is no media)
     *
     * \param do_pause  play/resume if zero, pause if non-zero
     *
     * \version LibVLC 1.1.1 or later
     */
166 167
    void setPause(int do_pause)
    {
168
        libvlc_media_player_set_pause(*this, do_pause);
169
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
170 171 172 173

    /**
     * Toggle pause (no effect if there is no media)
     */
174 175
    void pause()
    {
176
        libvlc_media_player_pause(*this);
177
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
178 179 180 181

    /**
     * Stop (no effect if there is no media)
     */
182 183
    void stop()
    {
184
        libvlc_media_player_stop(*this);
185
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

    /**
     * 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
     * VLCOpenGLVideoViewEmbedding protocol:
     *
     * @protocol VLCOpenGLVideoViewEmbedding <NSObject>
     *
     * 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.
     */
211 212
    void setNsobject(void * drawable)
    {
213
        libvlc_media_player_set_nsobject(*this, drawable);
214
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
215 216 217 218 219 220 221

    /**
     * Get the NSView handler previously set with MediaPlayer::setNsobject()
     * .
     *
     * \return the NSView handler or 0 if none where set
     */
222 223
    void * nsobject()
    {
224
        return libvlc_media_player_get_nsobject(*this);
225
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
226 227 228 229 230 231 232

    /**
     * Set the agl handler where the media player should render its video
     * output.
     *
     * \param drawable  the agl handler
     */
233 234
    void setAgl(uint32_t drawable)
    {
235
        libvlc_media_player_set_agl(*this, drawable);
236
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
237 238 239 240 241 242

    /**
     * Get the agl handler previously set with MediaPlayer::setAgl() .
     *
     * \return the agl handler or 0 if none where set
     */
243 244
    uint32_t agl()
    {
245
        return libvlc_media_player_get_agl(*this);
246
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261

    /**
     * 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
     */
262 263
    void setXwindow(uint32_t drawable)
    {
264
        libvlc_media_player_set_xwindow(*this, drawable);
265
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
266 267 268 269 270 271 272 273 274

    /**
     * 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.
     */
275 276
    uint32_t xwindow()
    {
277
        return libvlc_media_player_get_xwindow(*this);
278
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
279 280 281 282 283 284 285 286

    /**
     * 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
     */
287 288
    void setHwnd(void * drawable)
    {
289
        libvlc_media_player_set_hwnd(*this, drawable);
290
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
291 292 293 294 295 296 297 298

    /**
     * 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.
     *
     * \return a window handle or NULL if there are none.
     */
299 300
    void * hwnd()
    {
301
        return libvlc_media_player_get_hwnd(*this);
302
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
303 304 305 306 307 308

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

    /**
     * Get the current movie time (in ms).
     *
     * \return the movie time (in ms), or -1 if there is no media.
     */
319 320
    libvlc_time_t time()
    {
321
        return  libvlc_media_player_get_time(*this);
322
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
323 324 325 326 327 328 329

    /**
     * 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).
     */
330 331
    void setTime(libvlc_time_t i_time)
    {
332
        libvlc_media_player_set_time(*this, i_time);
333
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
334 335 336 337 338 339

    /**
     * Get movie position as percentage between 0.0 and 1.0.
     *
     * \return movie position, or -1. in case of error
     */
340 341
    float position()
    {
342
        return libvlc_media_player_get_position(*this);
343
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
344 345 346 347 348 349 350 351

    /**
     * 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
     */
352 353
    void setPosition(float f_pos)
    {
354
        libvlc_media_player_set_position(*this, f_pos);
355
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
356 357 358 359 360 361

    /**
     * Set movie chapter (if applicable).
     *
     * \param i_chapter  chapter number to play
     */
362 363
    void setChapter(int i_chapter)
    {
364
        libvlc_media_player_set_chapter(*this, i_chapter);
365
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
366 367 368 369 370 371

    /**
     * Get movie chapter.
     *
     * \return chapter number currently playing, or -1 if there is no media.
     */
372 373
    int chapter()
    {
374
        return libvlc_media_player_get_chapter(*this);
375
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
376 377 378 379 380 381

    /**
     * Get movie chapter count
     *
     * \return number of chapters in movie, or -1.
     */
382 383
    int chapterCount()
    {
384
        return libvlc_media_player_get_chapter_count(*this);
385
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
386 387 388 389 390 391

    /**
     * Is the player able to play
     *
     * \return boolean
     */
392 393
    bool willPlay()
    {
394
        return libvlc_media_player_will_play(*this) != 0;
395
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
396 397 398 399 400 401 402 403

    /**
     * Get title chapter count
     *
     * \param i_title  title
     *
     * \return number of chapters in title, or -1
     */
404 405
    int chapterCountForTitle(int i_title)
    {
406
        return libvlc_media_player_get_chapter_count_for_title(*this, i_title);
407
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
408 409 410 411 412 413

    /**
     * Set movie title
     *
     * \param i_title  title number to play
     */
414 415
    void setTitle(int i_title)
    {
416
        libvlc_media_player_set_title(*this, i_title);
417
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
418 419 420 421 422 423

    /**
     * Get movie title
     *
     * \return title number currently playing, or -1
     */
424 425
    int title()
    {
426
        return libvlc_media_player_get_title(*this);
427
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
428 429 430 431 432 433

    /**
     * Get movie title count
     *
     * \return title number count, or -1
     */
434 435
    int titleCount()
    {
436
        return libvlc_media_player_get_title_count(*this);
437
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
438 439 440 441

    /**
     * Set previous chapter (if applicable)
     */
442 443
    void previousChapter()
    {
444
        libvlc_media_player_previous_chapter(*this);
445
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
446 447 448 449

    /**
     * Set next chapter (if applicable)
     */
450 451
    void nextChapter()
    {
452
        libvlc_media_player_next_chapter(*this);
453
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
454 455 456 457 458 459 460 461 462

    /**
     * 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
     */
463 464
    float rate()
    {
465
        return libvlc_media_player_get_rate(*this);
466
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
467 468 469 470 471 472 473 474 475

    /**
     * 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)
     */
476 477
    int setRate(float rate)
    {
478
        return libvlc_media_player_set_rate(*this, rate);
479
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
480 481 482 483 484 485 486 487

    /**
     * Get current movie state
     *
     * \return the current state of the media player (playing, paused, ...)
     *
     * \see libvlc_state_t
     */
488 489
    libvlc_state_t state()
    {
490
        return libvlc_media_player_get_state(*this);
491
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
492 493 494 495 496 497 498

    /**
     * Get movie fps rate
     *
     * \return frames per second (fps) for this playing movie, or 0 if
     * unspecified
     */
499 500
    float fps()
    {
501
        return libvlc_media_player_get_fps(*this);
502
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
503 504 505 506 507 508

    /**
     * end bug How many video outputs does this media player have?
     *
     * \return the number of video outputs
     */
509 510
    unsigned hasVout()
    {
511
        return libvlc_media_player_has_vout(*this);
512
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
513 514 515 516 517 518

    /**
     * Is this media player seekable?
     *
     * \return true if the media player can seek
     */
519 520
    bool isSeekable()
    {
521
        return libvlc_media_player_is_seekable(*this) != 0;
522
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
523 524 525 526 527 528

    /**
     * Can this media player be paused?
     *
     * \return true if the media player can pause
     */
529 530
    bool canPause()
    {
531
        return libvlc_media_player_can_pause(*this) != 0;
532
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
533 534 535 536 537 538 539 540

    /**
     * Check if the current program is scrambled
     *
     * \return true if the current program is scrambled
     *
     * \version LibVLC 2.2.0 or later
     */
541 542
    bool programScrambled()
    {
543
        return libvlc_media_player_program_scrambled(*this) != 0;
544
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
545 546 547 548

    /**
     * Display the next frame (if supported)
     */
549 550
    void nextFrame()
    {
551
        libvlc_media_player_next_frame(*this);
552
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
553 554 555 556 557 558 559 560

    /**
     * Navigate through DVD Menu
     *
     * \param navigate  the Navigation mode
     *
     * \version libVLC 2.0.0 or later
     */
561 562
    void navigate(unsigned navigate)
    {
563
        libvlc_media_player_navigate(*this, navigate);
564
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
565 566 567 568 569 570 571 572 573 574 575 576

    /**
     * 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
     */
577 578
    void setVideoTitleDisplay(libvlc_position_t position, unsigned int timeout)
    {
579
        libvlc_media_player_set_video_title_display(*this, position, timeout);
580
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
581 582 583 584 585 586 587

    /**
     * Toggle fullscreen status on non-embedded video outputs.
     *
     * \warning The same limitations applies to this function as to
     * MediaPlayer::setFullscreen() .
     */
588 589
    void toggleFullscreen()
    {
590
        libvlc_toggle_fullscreen(*this);
591
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
592 593 594 595 596 597 598 599 600 601 602 603 604

    /**
     * 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
     */
605 606
    void setFullscreen(int b_fullscreen)
    {
607
        libvlc_set_fullscreen(*this, b_fullscreen);
608
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
609 610 611 612 613 614

    /**
     * Get current fullscreen status.
     *
     * \return the fullscreen status (boolean)
     */
615 616
    bool fullscreen()
    {
617
        return libvlc_get_fullscreen(*this) != 0;
618
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
619 620 621 622

    /**
     * Toggle teletext transparent status on video output.
     */
623 624
    void toggleTeletext()
    {
625
        libvlc_toggle_teletext(*this);
626
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660

    /**
     * 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.
     *
     * \param p_equalizer  opaque equalizer handle, or NULL to disable the
     * equalizer for this media player
     *
     * \return zero on success, -1 on error
     *
     * \version LibVLC 2.2.0 or later
     */
661 662
    int setEqualizer(libvlc_equalizer_t * p_equalizer)
    {
663
        return libvlc_media_player_set_equalizer(*this, p_equalizer);
664
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
665

666 667 668 669 670
    /**
     * Set callbacks and private data for decoded audio. Use
     * MediaPlayer::setFormat() or MediaPlayer::setFormatCallbacks() to configure the
     * decoded audio format.
     *
671 672
     * \param play  callback to play audio samples (must not be nullptr)
     *              Required prototype is: void(const void *samples, unsigned count, int64_t pts)
673
     *
674 675
     * \param pause  callback to pause playback (or nullptr to ignore)
     *               Required prototype is void(int64_t pts);
676
     *
677 678
     * \param resume callback to resume playback (or nullptr to ignore)
     *               Required prototype is void(int64_t pts);
679
     *
680 681
     * \param flush  callback to flush audio buffers (or nullptr to ignore)
     *               Required prototype is void(int64_t pts);
682
     *
683 684
     * \param drain  callback to drain audio buffers (or nullptr to ignore)
     * *             Required prototype is void();
685 686 687
     *
     * \version LibVLC 2.0.0 or later
     */
688 689
    template <typename PlayCb, typename PauseCb, typename ResumeCb, typename FlushCb, typename DrainCb>
    void setAudioCallbacks(PlayCb&& play, PauseCb&& pause, ResumeCb&& resume, FlushCb&& flush, DrainCb&& drain)
690
    {
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
        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,
            CallbackWrapper<(int)EventIdx::AudioPlay,     PlayCb,  libvlc_audio_play_cb>::wrap(   this, std::forward<PlayCb>( play ) ),
            CallbackWrapper<(int)EventIdx::AudioPause,    PauseCb, libvlc_audio_pause_cb>::wrap(  this, std::forward<PauseCb>( pause ) ),
            CallbackWrapper<(int)EventIdx::AudioResume,   ResumeCb,libvlc_audio_resume_cb>::wrap( this, std::forward<ResumeCb>( resume ) ),
            CallbackWrapper<(int)EventIdx::AudioFlush,    FlushCb, libvlc_audio_flush_cb>::wrap(  this, std::forward<FlushCb>( flush ) ),
            CallbackWrapper<(int)EventIdx::AudioDrain,    DrainCb, libvlc_audio_drain_cb>::wrap(  this, std::forward<DrainCb>( drain ) ),
            // 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.
            static_cast<EventOwner<13>*>( this ) );
706
    }
707 708 709 710 711 712

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

    /**
     * Set decoded audio format. This only works in combination with
     * MediaPlayer::setCallbacks() .
     *
731 732 733
     * \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
734
     *
735 736
     * \param cleanup  callback to release any allocated resources (or nullptr)
     *                 Expected prototype is void()
737 738 739
     *
     * \version LibVLC 2.0.0 or later
     */
740 741
    template <typename SetupCb, typename CleanupCb>
    void setAudioFormatCallbacks(SetupCb&& setup, CleanupCb&& cleanup)
742
    {
743 744 745 746 747 748
        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,
            CallbackWrapper<(int)EventIdx::AudioSetup, SetupCb, libvlc_audio_setup_cb>::wrap( this, std::forward<SetupCb>( setup ) ),
            CallbackWrapper<(int)EventIdx::AudioCleanup, CleanupCb, libvlc_audio_cleanup_cb>::wrap( this, std::forward<CleanupCb>( cleanup ) ) );
749
    }
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764

    /**
     * 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
     */
765 766
    void setAudioFormat(const std::string& format, unsigned rate, unsigned channels)
    {
767
        libvlc_audio_set_format(*this, format.c_str(), rate, channels);
768
    }
769 770 771 772 773 774 775 776 777 778 779 780 781

    /**
     * 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.
     *
     * \param psz_name  name of audio output, use psz_name of
     *
     * \see AudioOutputDescription
     *
     * \return 0 if function succeded, -1 on error
     */
782 783
    int setAudioOutput(const std::string& psz_name)
    {
784
        return libvlc_audio_output_set(*this, psz_name.c_str());
785
    }
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806

    /**
     * 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.
     *
     * \return A NULL-terminated linked list of potential audio output
     * devices. It must be freed it with
     * libvlc_audio_output_device_list_release()
     *
     * \version LibVLC 2.2.0 or later.
     */
807 808
    std::vector<AudioOutputDeviceDescription> outputDeviceEnum()
    {
809
        libvlc_audio_output_device_t* devices = libvlc_audio_output_device_enum(*this);
810 811 812 813 814 815 816 817
        std::vector<AudioOutputDeviceDescription> res;
        if ( devices == NULL )
            return res;
        for ( libvlc_audio_output_device_t* p = devices; p != NULL; p = p->p_next )
            res.push_back( AudioOutputDeviceDescription( p ) );
        libvlc_audio_output_device_list_release( devices );
        return res;
    }
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 855 856

    /**
     * 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).
     */
857 858
    void outputDeviceSet(const std::string& module, const std::string& device_id)
    {
859
        libvlc_audio_output_device_set(*this, module.c_str(), device_id.c_str());
860
    }
861 862 863 864 865 866 867 868 869

    /**
     * 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() .
     */
870 871
    void toggleMute()
    {
872
        libvlc_audio_toggle_mute(*this);
873
    }
874 875 876 877 878 879 880

    /**
     * Get current mute status.
     *
     * \return the mute status (boolean) if defined, -1 if
     * undefined/unapplicable
     */
881 882
    int mute()
    {
883
        return libvlc_audio_get_mute(*this);
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 901
    void setMute(int status)
    {
902
        libvlc_audio_set_mute(*this,status);
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 921 922

    /**
     * Set current software audio volume.
     *
     * \param i_volume  the volume in percents (0 = mute, 100 = 0dB)
     *
     * \return 0 if the volume was set, -1 if it was out of range
     */
923 924
    int setVolume(int i_volume)
    {
925
        return libvlc_audio_set_volume(*this, i_volume);
926
    }
927 928 929 930 931 932 933

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

    /**
     * Get the description of available audio tracks.
     *
     * \return list with description of available audio tracks, or NULL
     */
944 945
    std::vector<TrackDescription> audioTrackDescription()
    {
946
        libvlc_track_description_t* result = libvlc_audio_get_track_description( *this );
947 948
        return getTracksDescription( result );
    }
949 950 951 952 953 954

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

    /**
     * Set current audio track.
     *
     * \param i_track  the track ID (i_id field from track description)
     *
     * \return 0 on success, -1 on error
     */
967 968
    int setAudioTrack(int i_track)
    {
969
        return libvlc_audio_set_track(*this, i_track);
970
    }
971 972 973 974 975 976 977 978

    /**
     * Get current audio channel.
     *
     * \return the audio channel
     *
     * \see libvlc_audio_output_channel_t
     */
979 980
    int channel()
    {
981
        return libvlc_audio_get_channel(*this);
982
    }
983 984 985 986 987 988 989 990 991 992

    /**
     * Set current audio channel.
     *
     * \param channel  the audio channel,
     *
     * \see libvlc_audio_output_channel_t
     *
     * \return 0 on success, -1 on error
     */
993 994
    int setChannel(int channel)
    {
995
        return libvlc_audio_set_channel(*this, channel);
996
    }
997 998 999 1000 1001 1002 1003 1004

    /**
     * Get current audio delay.
     *
     * \return the audio delay (microseconds)
     *
     * \version LibVLC 1.1.1 or later
     */
1005 1006
    int64_t delay()
    {
1007
        return libvlc_audio_get_delay(*this);
1008
    }
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019

    /**
     * Set current audio delay. The audio delay will be reset to zero each
     * time the media changes.
     *
     * \param i_delay  the audio delay (microseconds)
     *
     * \return 0 on success, -1 on error
     *
     * \version LibVLC 1.1.1 or later
     */
1020 1021
    int setDelay(int64_t i_delay)
    {
1022
        return libvlc_audio_set_delay(*this, i_delay);
1023
    }
1024 1025 1026 1027 1028 1029

    /**
     * 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.
     *
1030 1031 1032 1033
     * \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
1034
     *
1035 1036 1037 1038
     * \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
1039
     *
1040 1041 1042
     * \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.
1043 1044 1045
     *
     * \version LibVLC 1.1.1 or later
     */
1046 1047
    template <typename LockCb, typename UnlockCb, typename DisplayCb>
    void setVideoCallbacks(LockCb&& lock, UnlockCb&& unlock, DisplayCb&& display)
1048
    {
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
        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,
                CallbackWrapper<(int)EventIdx::VideoLock, LockCb, libvlc_video_lock_cb>::wrap( this, std::forward<LockCb>( lock ) ),
                CallbackWrapper<(int)EventIdx::VideoUnlock, UnlockCb, libvlc_video_unlock_cb>::wrap( this, std::forward<UnlockCb>( unlock ) ),
                CallbackWrapper<(int)EventIdx::VideoDisplay, DisplayCb, libvlc_video_display_cb>::wrap( this, std::forward<DisplayCb>( display ) ),
                // 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.
                static_cast<EventOwner<13>*>( this ) );
1060
    }
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077

    /**
     * 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
     */
1078 1079
    void setVideoFormat(const std::string& chroma, unsigned width, unsigned height, unsigned pitch)
    {
1080
        libvlc_video_set_format(*this, chroma.c_str(), width, height, pitch);
1081
    }
1082 1083 1084 1085 1086

    /**
     * Set decoded video chroma and dimensions. This only works in
     * combination with MediaPlayer::setCallbacks() .
     *
1087 1088 1089 1090 1091 1092 1093
     * \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
1094
     *
1095 1096
     * \param cleanup  callback to release any allocated resources (or nullptr)
     *                 Expected prototype is void()
1097 1098 1099
     *
     * \version LibVLC 2.0.0 or later
     */
1100 1101
    template <typename FormatCb, typename CleanupCb>
    void setVideoFormatCallbacks(FormatCb&& setup, CleanupCb&& cleanup)
1102
    {
1103 1104 1105 1106 1107 1108 1109
        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,
                CallbackWrapper<(int)EventIdx::VideoFormat, FormatCb, libvlc_video_format_cb>::wrap( static_cast<EventOwner<13>*>( this ), std::forward<FormatCb>( setup ) ),
                CallbackWrapper<(int)EventIdx::VideoCleanup, CleanupCb, libvlc_video_cleanup_cb>::wrap( this, std::forward<CleanupCb>( cleanup ) ) );
1110
    }
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126

    /**
     * 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.
     */
1127 1128
    void setKeyInput(unsigned on)
    {
1129
        libvlc_video_set_key_input(*this, on);
1130
    }
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143

    /**
     * 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.
     */
1144 1145
    void setMouseInput(unsigned on)
    {
1146
        libvlc_video_set_mouse_input(*this, on);
1147
    }
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159

    /**
     * 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]
     *
     * \return 0 on success, -1 if the specified video does not exist
     */
1160 1161
    int size(unsigned num, unsigned * px, unsigned * py)
    {
1162
        return libvlc_video_get_size(*this, num, px, py);
1163
    }
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190

    /**
     * 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]
     *
     * \return 0 on success, -1 if the specified video does not exist
     */
1191 1192
    int cursor(unsigned num, int * px, int * py)
    {
1193
        return libvlc_video_get_cursor(*this, num, px, py);
1194
    }
1195 1196 1197 1198 1199 1200 1201

    /**
     * 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.
     */
1202 1203
    float scale()
    {
1204
        return libvlc_video_get_scale(*this);
1205
    }
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216

    /**
     * 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
     */
1217 1218
    void setScale(float f_factor)
    {
1219
        libvlc_video_set_scale(*this, f_factor);
1220
    }
1221 1222 1223 1224 1225 1226 1227

    /**
     * Get current video aspect ratio.
     *
     * \return the video aspect ratio or NULL if unspecified (the result must
     * be released with free() or libvlc_free() ).
     */
1228 1229
    std::string aspectRatio()
    {
1230 1231 1232 1233
        auto str = wrapCStr( libvlc_video_get_aspect_ratio(*this) );
        if ( str == nullptr )
            return {};
        return str.get();