git.sesse.net Git - vlc/blob - include/vlc/libvlc_media_player.h

   1 /*****************************************************************************
   2  * libvlc_media_player.h:  libvlc_media_player external API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2010 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Jean-Paul Saman <jpsaman@videolan.org>
   9  *          Pierre d'Herbemont <pdherbemont@videolan.org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 /**
  27  * \file
  28  * This file defines libvlc_media_player external API
  29  */
  30
  31 #ifndef VLC_LIBVLC_MEDIA_PLAYER_H
  32 #define VLC_LIBVLC_MEDIA_PLAYER_H 1
  33
  34 # ifdef __cplusplus
  35 extern "C" {
  36 # endif
  37
  38 /*****************************************************************************
  39  * Media Player
  40  *****************************************************************************/
  41 /** \defgroup libvlc_media_player libvlc_media_player
  42  * \ingroup libvlc
  43  * LibVLC Media Player, object that let you play a media
  44  * in a custom drawable
  45  * @{
  46  */
  47
  48 typedef struct libvlc_media_player_t libvlc_media_player_t;
  49
  50 /**
  51  * Description for video, audio tracks and subtitles. It contains
  52  * id, name (description string) and pointer to next record.
  53  */
  54 typedef struct libvlc_track_description_t
  55 {
  56     int   i_id;
  57     char *psz_name;
  58     struct libvlc_track_description_t *p_next;
  59
  60 } libvlc_track_description_t;
  61
  62 /**
  63  * Description for audio output. It contains
  64  * name, description and pointer to next record.
  65  */
  66 typedef struct libvlc_audio_output_t
  67 {
  68     char *psz_name;
  69     char *psz_description;
  70     struct libvlc_audio_output_t *p_next;
  71
  72 } libvlc_audio_output_t;
  73
  74 /**
  75  * Rectangle type for video geometry
  76  */
  77 typedef struct libvlc_rectangle_t
  78 {
  79     int top, left;
  80     int bottom, right;
  81 } libvlc_rectangle_t;
  82
  83 /**
  84  * Marq options definition
  85  */
  86 typedef enum libvlc_video_marquee_option_t {
  87     libvlc_marquee_Enable = 0,
  88     libvlc_marquee_Text,                /** string argument */
  89     libvlc_marquee_Color,
  90     libvlc_marquee_Opacity,
  91     libvlc_marquee_Position,
  92     libvlc_marquee_Refresh,
  93     libvlc_marquee_Size,
  94     libvlc_marquee_Timeout,
  95     libvlc_marquee_X,
  96     libvlc_marquee_Y
  97 } libvlc_video_marquee_option_t;
  98
  99 /**
 100  * Create an empty Media Player object
 101  *
 102  * \param p_libvlc_instance the libvlc instance in which the Media Player
 103  *        should be created.
 104  * \return a new media player object, or NULL on error.
 105  */
 106 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *p_libvlc_instance );
 107
 108 /**
 109  * Create a Media Player object from a Media
 110  *
 111  * \param p_md the media. Afterwards the p_md can be safely
 112  *        destroyed.
 113  * \return a new media player object, or NULL on error.
 114  */
 115 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *p_md );
 116
 117 /**
 118  * Release a media_player after use
 119  * Decrement the reference count of a media player object. If the
 120  * reference count is 0, then libvlc_media_player_release() will
 121  * release the media player object. If the media player object
 122  * has been released, then it should not be used again.
 123  *
 124  * \param p_mi the Media Player to free
 125  */
 126 VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t *p_mi );
 127
 128 /**
 129  * Retain a reference to a media player object. Use
 130  * libvlc_media_player_release() to decrement reference count.
 131  *
 132  * \param p_mi media player object
 133  */
 134 VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t *p_mi );
 135
 136 /**
 137  * Set the media that will be used by the media_player. If any,
 138  * previous md will be released.
 139  *
 140  * \param p_mi the Media Player
 141  * \param p_md the Media. Afterwards the p_md can be safely
 142  *        destroyed.
 143  */
 144 VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *p_mi,
 145                                                    libvlc_media_t *p_md );
 146
 147 /**
 148  * Get the media used by the media_player.
 149  *
 150  * \param p_mi the Media Player
 151  * \return the media associated with p_mi, or NULL if no
 152  *         media is associated
 153  */
 154 VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *p_mi );
 155
 156 /**
 157  * Get the Event Manager from which the media player send event.
 158  *
 159  * \param p_mi the Media Player
 160  * \return the event manager associated with p_mi
 161  */
 162 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *p_mi );
 163
 164 /**
 165  * is_playing
 166  *
 167  * \param p_mi the Media Player
 168  * \return 1 if the media player is playing, 0 otherwise
 169  */
 170 VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *p_mi );
 171
 172 /**
 173  * Play
 174  *
 175  * \param p_mi the Media Player
 176  * \return 0 if playback started (and was already started), or -1 on error.
 177  */
 178 VLC_PUBLIC_API int libvlc_media_player_play ( libvlc_media_player_t *p_mi );
 179
 180 /**
 181  * Toggle pause (no effect if there is no media)
 182  *
 183  * \param p_mi the Media Player
 184  */
 185 VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *p_mi );
 186
 187 /**
 188  * Stop (no effect if there is no media)
 189  *
 190  * \param p_mi the Media Player
 191  */
 192 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *p_mi );
 193
 194 /**
 195  * Set the NSView handler where the media player should render its video output.
 196  *
 197  * The object minimal_macosx expects is of kind NSObject and should
 198  * respect the protocol:
 199  *
 200  * @protocol VLCOpenGLVideoViewEmbedding <NSObject>
 201  * - (void)addVoutSubview:(NSView *)view;
 202  * - (void)removeVoutSubview:(NSView *)view;
 203  * @end
 204  *
 205  * You can find a live example in VLCVideoView in VLCKit.framework.
 206  *
 207  * \param p_mi the Media Player
 208  * \param drawable the NSView handler
 209  */
 210 VLC_PUBLIC_API void libvlc_media_player_set_nsobject ( libvlc_media_player_t *p_mi, void * drawable );
 211
 212 /**
 213  * Get the NSView handler previously set with libvlc_media_player_set_nsobject().
 214  *
 215  * \param p_mi the Media Player
 216  * \return the NSView handler or 0 if none where set
 217  */
 218 VLC_PUBLIC_API void * libvlc_media_player_get_nsobject ( libvlc_media_player_t *p_mi );
 219
 220 /**
 221  * Set the agl handler where the media player should render its video output.
 222  *
 223  * \param p_mi the Media Player
 224  * \param drawable the agl handler
 225  */
 226 VLC_PUBLIC_API void libvlc_media_player_set_agl ( libvlc_media_player_t *p_mi, uint32_t drawable );
 227
 228 /**
 229  * Get the agl handler previously set with libvlc_media_player_set_agl().
 230  *
 231  * \param p_mi the Media Player
 232  * \return the agl handler or 0 if none where set
 233  */
 234 VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl ( libvlc_media_player_t *p_mi );
 235
 236 /**
 237  * Set an X Window System drawable where the media player should render its
 238  * video output. If LibVLC was built without X11 output support, then this has
 239  * no effects.
 240  *
 241  * The specified identifier must correspond to an existing Input/Output class
 242  * X11 window. Pixmaps are <b>not</b> supported. The caller shall ensure that
 243  * the X11 server is the same as the one the VLC instance has been configured
 244  * with.
 245  * If XVideo is <b>not</b> used, it is assumed that the drawable has the
 246  * following properties in common with the default X11 screen: depth, scan line
 247  * pad, black pixel. This is a bug.
 248  *
 249  * \param p_mi the Media Player
 250  * \param drawable the ID of the X window
 251  */
 252 VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable );
 253
 254 /**
 255  * Get the X Window System window identifier previously set with
 256  * libvlc_media_player_set_xwindow(). Note that this will return the identifier
 257  * even if VLC is not currently using it (for instance if it is playing an
 258  * audio-only input).
 259  *
 260  * \param p_mi the Media Player
 261  * \return an X window ID, or 0 if none where set.
 262  */
 263 VLC_PUBLIC_API uint32_t libvlc_media_player_get_xwindow ( libvlc_media_player_t *p_mi );
 264
 265 /**
 266  * Set a Win32/Win64 API window handle (HWND) where the media player should
 267  * render its video output. If LibVLC was built without Win32/Win64 API output
 268  * support, then this has no effects.
 269  *
 270  * \param p_mi the Media Player
 271  * \param drawable windows handle of the drawable
 272  */
 273 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable );
 274
 275 /**
 276  * Get the Windows API window handle (HWND) previously set with
 277  * libvlc_media_player_set_hwnd(). The handle will be returned even if LibVLC
 278  * is not currently outputting any video to it.
 279  *
 280  * \param p_mi the Media Player
 281  * \return a window handle or NULL if there are none.
 282  */
 283 VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi );
 284
 285
 286
 287 /** \bug This might go away ... to be replaced by a broader system */
 288
 289 /**
 290  * Get the current movie length (in ms).
 291  *
 292  * \param p_mi the Media Player
 293  * \return the movie length (in ms), or -1 if there is no media.
 294  */
 295 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *p_mi );
 296
 297 /**
 298  * Get the current movie time (in ms).
 299  *
 300  * \param p_mi the Media Player
 301  * \return the movie time (in ms), or -1 if there is no media.
 302  */
 303 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *p_mi );
 304
 305 /**
 306  * Set the movie time (in ms). This has no effect if no media is being played.
 307  * Not all formats and protocols support this.
 308  *
 309  * \param p_mi the Media Player
 310  * \param i_time the movie time (in ms).
 311  */
 312 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *p_mi, libvlc_time_t i_time );
 313
 314 /**
 315  * Get movie position.
 316  *
 317  * \param p_mi the Media Player
 318  * \return movie position, or -1. in case of error
 319  */
 320 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *p_mi );
 321
 322 /**
 323  * Set movie position. This has no effect if playback is not enabled.
 324  * This might not work depending on the underlying input format and protocol.
 325  *
 326  * \param p_mi the Media Player
 327  * \param f_pos the position
 328  */
 329 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *p_mi, float f_pos );
 330
 331 /**
 332  * Set movie chapter (if applicable).
 333  *
 334  * \param p_mi the Media Player
 335  * \param i_chapter chapter number to play
 336  */
 337 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *p_mi, int i_chapter );
 338
 339 /**
 340  * Get movie chapter.
 341  *
 342  * \param p_mi the Media Player
 343  * \return chapter number currently playing, or -1 if there is no media.
 344  */
 345 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *p_mi );
 346
 347 /**
 348  * Get movie chapter count
 349  *
 350  * \param p_mi the Media Player
 351  * \return number of chapters in movie, or -1.
 352  */
 353 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *p_mi );
 354
 355 /**
 356  * Is the player able to play
 357  *
 358  * \param p_mi the Media Player
 359  * \return boolean
 360  */
 361 VLC_PUBLIC_API int libvlc_media_player_will_play( libvlc_media_player_t *p_mi );
 362
 363 /**
 364  * Get title chapter count
 365  *
 366  * \param p_mi the Media Player
 367  * \param i_title title
 368  * \return number of chapters in title, or -1
 369  */
 370 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
 371                        libvlc_media_player_t *p_mi, int i_title );
 372
 373 /**
 374  * Set movie title
 375  *
 376  * \param p_mi the Media Player
 377  * \param i_title title number to play
 378  */
 379 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *p_mi, int i_title );
 380
 381 /**
 382  * Get movie title
 383  *
 384  * \param p_mi the Media Player
 385  * \return title number currently playing, or -1
 386  */
 387 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *p_mi );
 388
 389 /**
 390  * Get movie title count
 391  *
 392  * \param p_mi the Media Player
 393  * \return title number count, or -1
 394  */
 395 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *p_mi );
 396
 397 /**
 398  * Set previous chapter (if applicable)
 399  *
 400  * \param p_mi the Media Player
 401  */
 402 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *p_mi );
 403
 404 /**
 405  * Set next chapter (if applicable)
 406  *
 407  * \param p_mi the Media Player
 408  */
 409 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *p_mi );
 410
 411 /**
 412  * Get the requested movie play rate.
 413  * @warning Depending on the underlying media, the requested rate may be
 414  * different from the real playback rate.
 415  *
 416  * \param p_mi the Media Player
 417  * \return movie play rate
 418  */
 419 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *p_mi );
 420
 421 /**
 422  * Set movie play rate
 423  *
 424  * \param p_mi the Media Player
 425  * \param rate movie play rate to set
 426  * \return -1 if an error was detected, 0 otherwise (but even then, it might
 427  * not actually work depending on the underlying media protocol)
 428  */
 429 VLC_PUBLIC_API int libvlc_media_player_set_rate( libvlc_media_player_t *p_mi, float rate );
 430
 431 /**
 432  * Get current movie state
 433  *
 434  * \param p_mi the Media Player
 435  */
 436 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *p_mi );
 437
 438 /**
 439  * Get movie fps rate
 440  *
 441  * \param p_mi the Media Player
 442  * \return frames per second (fps) for this playing movie, or 0 if unspecified
 443  */
 444 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *p_mi );
 445
 446 /** end bug */
 447
 448 /**
 449  * How many video outputs does this media player have?
 450  *
 451  * \param p_mi the media player
 452  * \return the number of video outputs
 453  */
 454 VLC_PUBLIC_API unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_mi );
 455
 456 /**
 457  * Is this media player seekable?
 458  *
 459  * \param p_mi the media player
 460  */
 461 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi );
 462
 463 /**
 464  * Can this media player be paused?
 465  *
 466  * \param p_mi the media player
 467  */
 468 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi );
 469
 470
 471 /**
 472  * Display the next frame (if supported)
 473  *
 474  * \param p_mi the media player
 475  */
 476 VLC_PUBLIC_API void libvlc_media_player_next_frame( libvlc_media_player_t *p_mi );
 477
 478
 479
 480 /**
 481  * Release (free) libvlc_track_description_t
 482  *
 483  * \param p_track_description the structure to release
 484  */
 485 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
 486
 487 /** \defgroup libvlc_video libvlc_video
 488  * \ingroup libvlc_media_player
 489  * LibVLC Video handling
 490  * @{
 491  */
 492
 493 /**
 494  * Toggle fullscreen status on non-embedded video outputs.
 495  *
 496  * @warning The same limitations applies to this function
 497  * as to libvlc_set_fullscreen().
 498  *
 499  * \param p_mi the media player
 500  */
 501 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi );
 502
 503 /**
 504  * Enable or disable fullscreen on non-embedded video outputs.
 505  *
 506  * @warning With most window managers, only a top-level windows can switch to
 507  * full-screen mode. Hence, this function will not operate properly if
 508  * libvlc_media_player_set_xid() or libvlc_media_player_set_hwnd() was
 509  * used to embed the video in a non-LibVLC widget. If you want to to render an
 510  * embedded LibVLC video full-screen, the parent embedding widget must expanded
 511  * to full screen (LibVLC cannot take care of that).
 512  * LibVLC will then automatically resize the video as appropriate.
 513  *
 514  * \param p_mi the media player
 515  * \param b_fullscreen boolean for fullscreen status
 516  */
 517 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *p_mi, int b_fullscreen );
 518
 519 /**
 520  * Get current fullscreen status.
 521  *
 522  * \param p_mi the media player
 523  * \return the fullscreen status (boolean)
 524  */
 525 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *p_mi );
 526
 527 /**
 528  * Enable or disable key press events handling, according to the LibVLC hotkeys
 529  * configuration. By default and for historical reasons, keyboard events are
 530  * handled by the LibVLC video widget.
 531  *
 532  * \note On X11, there can be only one subscriber for key press and mouse
 533  * click events per window. If your application has subscribed to those events
 534  * for the X window ID of the video widget, then LibVLC will not be able to
 535  * handle key presses and mouse clicks in any case.
 536  *
 537  * \warning This function is only implemented for X11 at the moment.
 538  *
 539  * \param p_mi the media player
 540  * \param on true to handle key press events, false to ignore them.
 541  */
 542 VLC_PUBLIC_API
 543 void libvlc_video_set_key_input( libvlc_media_player_t *p_mi, unsigned on );
 544
 545 /**
 546  * Enable or disable mouse click events handling. By default, those events are
 547  * handled. This is needed for DVD menus to work, as well as a few video
 548  * filters such as "puzzle".
 549  *
 550  * \note See also libvlc_video_set_key_input().
 551  *
 552  * \warning This function is only implemented for X11 at the moment.
 553  *
 554  * \param p_mi the media player
 555  * \param on true to handle mouse click events, false to ignore them.
 556  */
 557 VLC_PUBLIC_API
 558 void libvlc_video_set_mouse_input( libvlc_media_player_t *p_mi, unsigned on );
 559
 560 /**
 561  * Get the pixel dimensions of a video.
 562  *
 563  * \param p_mi media player
 564  * \param num number of the video (starting from, and most commonly 0)
 565  * \param px pointer to get the pixel width [OUT]
 566  * \param py pointer to get the pixel height [OUT]
 567  * \return 0 on success, -1 if the specified video does not exist
 568  */
 569 VLC_PUBLIC_API
 570 int libvlc_video_get_size( libvlc_media_player_t *p_mi, unsigned num,
 571                            unsigned *px, unsigned *py );
 572
 573 /**
 574  * Get current video height.
 575  * You should use libvlc_video_get_size() instead.
 576  *
 577  * \param p_mi the media player
 578  * \return the video pixel height or 0 if not applicable
 579  */
 580 VLC_DEPRECATED_API
 581 int libvlc_video_get_height( libvlc_media_player_t *p_mi );
 582
 583 /**
 584  * Get current video width.
 585  * You should use libvlc_video_get_size() instead.
 586  *
 587  * \param p_mi the media player
 588  * \return the video pixel width or 0 if not applicable
 589  */
 590 VLC_DEPRECATED_API
 591 int libvlc_video_get_width( libvlc_media_player_t *p_mi );
 592
 593 /**
 594  * Get the mouse pointer coordinates over a video.
 595  * Coordinates are expressed in terms of the decoded video resolution,
 596  * <b>not</b> in terms of pixels on the screen/viewport (to get the latter,
 597  * you can query your windowing system directly).
 598  *
 599  * Either of the coordinates may be negative or larger than the corresponding
 600  * dimension of the video, if the cursor is outside the rendering area.
 601  *
 602  * @warning The coordinates may be out-of-date if the pointer is not located
 603  * on the video rendering area. LibVLC does not track the pointer if it is
 604  * outside of the video widget.
 605  *
 606  * @note LibVLC does not support multiple pointers (it does of course support
 607  * multiple input devices sharing the same pointer) at the moment.
 608  *
 609  * \param p_mi media player
 610  * \param num number of the video (starting from, and most commonly 0)
 611  * \param px pointer to get the abscissa [OUT]
 612  * \param py pointer to get the ordinate [OUT]
 613  * \return 0 on success, -1 if the specified video does not exist
 614  */
 615 VLC_PUBLIC_API
 616 int libvlc_video_get_cursor( libvlc_media_player_t *p_mi, unsigned num,
 617                              int *px, int *py );
 618
 619 /**
 620  * Get the current video scaling factor.
 621  * See also libvlc_video_set_scale().
 622  *
 623  * \param p_mi the media player
 624  * \return the currently configured zoom factor, or 0. if the video is set
 625  * to fit to the output window/drawable automatically.
 626  */
 627 VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *p_mi );
 628
 629 /**
 630  * Set the video scaling factor. That is the ratio of the number of pixels on
 631  * screen to the number of pixels in the original decoded video in each
 632  * dimension. Zero is a special value; it will adjust the video to the output
 633  * window/drawable (in windowed mode) or the entire screen.
 634  *
 635  * Note that not all video outputs support scaling.
 636  *
 637  * \param p_mi the media player
 638  * \param f_factor the scaling factor, or zero
 639  */
 640 VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *p_mi, float f_factor );
 641
 642 /**
 643  * Get current video aspect ratio.
 644  *
 645  * \param p_mi the media player
 646  * \return the video aspect ratio or NULL if unspecified
 647  * (the result must be released with free()).
 648  */
 649 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi );
 650
 651 /**
 652  * Set new video aspect ratio.
 653  *
 654  * \param p_mi the media player
 655  * \param psz_aspect new video aspect-ratio or NULL to reset to default
 656  * \note Invalid aspect ratios are ignored.
 657  */
 658 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi, const char *psz_aspect );
 659
 660 /**
 661  * Get current video subtitle.
 662  *
 663  * \param p_mi the media player
 664  * \return the video subtitle selected, or -1 if none
 665  */
 666 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *p_mi );
 667
 668 /**
 669  * Get the number of available video subtitles.
 670  *
 671  * \param p_mi the media player
 672  * \return the number of available video subtitles
 673  */
 674 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi );
 675
 676 /**
 677  * Get the description of available video subtitles.
 678  *
 679  * \param p_mi the media player
 680  * \return list containing description of available video subtitles
 681  */
 682 VLC_PUBLIC_API libvlc_track_description_t *
 683         libvlc_video_get_spu_description( libvlc_media_player_t *p_mi );
 684
 685 /**
 686  * Set new video subtitle.
 687  *
 688  * \param p_mi the media player
 689  * \param i_spu new video subtitle to select
 690  * \return 0 on success, -1 if out of range
 691  */
 692 VLC_PUBLIC_API int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu );
 693
 694 /**
 695  * Set new video subtitle file.
 696  *
 697  * \param p_mi the media player
 698  * \param psz_subtitle new video subtitle file
 699  * \return the success status (boolean)
 700  */
 701 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi, const char *psz_subtitle );
 702
 703 /**
 704  * Get the description of available titles.
 705  *
 706  * \param p_mi the media player
 707  * \return list containing description of available titles
 708  */
 709 VLC_PUBLIC_API libvlc_track_description_t *
 710         libvlc_video_get_title_description( libvlc_media_player_t *p_mi );
 711
 712 /**
 713  * Get the description of available chapters for specific title.
 714  *
 715  * \param p_mi the media player
 716  * \param i_title selected title
 717  * \return list containing description of available chapter for title i_title
 718  */
 719 VLC_PUBLIC_API libvlc_track_description_t *
 720         libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi, int i_title );
 721
 722 /**
 723  * Get current crop filter geometry.
 724  *
 725  * \param p_mi the media player
 726  * \return the crop filter geometry or NULL if unset
 727  */
 728 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *p_mi );
 729
 730 /**
 731  * Set new crop filter geometry.
 732  *
 733  * \param p_mi the media player
 734  * \param psz_geometry new crop filter geometry (NULL to unset)
 735  */
 736 VLC_PUBLIC_API
 737 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi, const char *psz_geometry );
 738
 739 /**
 740  * Get current teletext page requested.
 741  *
 742  * \param p_mi the media player
 743  * \return the current teletext page requested.
 744  */
 745 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *p_mi );
 746
 747 /**
 748  * Set new teletext page to retrieve.
 749  *
 750  * \param p_mi the media player
 751  * \param i_page teletex page number requested
 752  */
 753 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page );
 754
 755 /**
 756  * Toggle teletext transparent status on video output.
 757  *
 758  * \param p_mi the media player
 759  */
 760 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *p_mi );
 761
 762 /**
 763  * Get number of available video tracks.
 764  *
 765  * \param p_mi media player
 766  * \return the number of available video tracks (int)
 767  */
 768 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *p_mi );
 769
 770 /**
 771  * Get the description of available video tracks.
 772  *
 773  * \param p_mi media player
 774  * \return list with description of available video tracks, or NULL on error
 775  */
 776 VLC_PUBLIC_API libvlc_track_description_t *
 777         libvlc_video_get_track_description( libvlc_media_player_t *p_mi );
 778
 779 /**
 780  * Get current video track.
 781  *
 782  * \param p_mi media player
 783  * \return the video track (int) or -1 if none
 784  */
 785 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *p_mi );
 786
 787 /**
 788  * Set video track.
 789  *
 790  * \param p_mi media player
 791  * \param i_track the track (int)
 792  * \return 0 on success, -1 if out of range
 793  */
 794 VLC_PUBLIC_API
 795 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track );
 796
 797 /**
 798  * Take a snapshot of the current video window.
 799  *
 800  * If i_width AND i_height is 0, original size is used.
 801  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
 802  *
 803  * \param p_mi media player instance
 804  * \param num number of video output (typically 0 for the first/only one)
 805  * \param psz_filepath the path where to save the screenshot to
 806  * \param i_width the snapshot's width
 807  * \param i_height the snapshot's height
 808  * \return 0 on success, -1 if the video was not found
 809  */
 810 VLC_PUBLIC_API
 811 int libvlc_video_take_snapshot( libvlc_media_player_t *p_mi, unsigned num,
 812                                 const char *psz_filepath, unsigned int i_width,
 813                                 unsigned int i_height );
 814
 815 /**
 816  * Enable or disable deinterlace filter
 817  *
 818  * \param p_mi libvlc media player
 819  * \param psz_mode type of deinterlace filter, NULL to disable
 820  */
 821 VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
 822                                                   const char *psz_mode );
 823
 824 /**
 825  * Get an integer marquee option value
 826  *
 827  * \param p_mi libvlc media player
 828  * \param option marq option to get \see libvlc_video_marquee_int_option_t
 829  */
 830 VLC_PUBLIC_API int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
 831                                                  unsigned option );
 832
 833 /**
 834  * Get a string marquee option value
 835  *
 836  * \param p_mi libvlc media player
 837  * \param option marq option to get \see libvlc_video_marquee_string_option_t
 838  */
 839 VLC_PUBLIC_API char *libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
 840                                                       unsigned option );
 841
 842 /**
 843  * Enable, disable or set an integer marquee option
 844  *
 845  * Setting libvlc_marquee_Enable has the side effect of enabling (arg !0)
 846  * or disabling (arg 0) the marq filter.
 847  *
 848  * \param p_mi libvlc media player
 849  * \param option marq option to set \see libvlc_video_marquee_int_option_t
 850  * \param i_val marq option value
 851  */
 852 VLC_PUBLIC_API void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
 853                                                   unsigned option, int i_val );
 854
 855 /**
 856  * Set a marquee string option
 857  *
 858  * \param p_mi libvlc media player
 859  * \param option marq option to set \see libvlc_video_marquee_string_option_t
 860  * \param psz_text marq option value
 861  */
 862 VLC_PUBLIC_API void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
 863                                                      unsigned option, const char *psz_text );
 864
 865 /** option values for libvlc_video_{get,set}_logo_{int,string} */
 866 enum libvlc_video_logo_option_t {
 867     libvlc_logo_enable,
 868     libvlc_logo_file,           /**< string argument, "file,d,t;file,d,t;..." */
 869     libvlc_logo_x,
 870     libvlc_logo_y,
 871     libvlc_logo_delay,
 872     libvlc_logo_repeat,
 873     libvlc_logo_opacity,
 874     libvlc_logo_position,
 875 };
 876
 877 /**
 878  * Get integer logo option.
 879  *
 880  * \param p_mi libvlc media player instance
 881  * \param option logo option to get, values of libvlc_video_logo_option_t
 882  */
 883 VLC_PUBLIC_API int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
 884                                               unsigned option );
 885
 886 /**
 887  * Set logo option as integer. Options that take a different type value
 888  * are ignored.
 889  * Passing libvlc_logo_enable as option value has the side effect of
 890  * starting (arg !0) or stopping (arg 0) the logo filter.
 891  *
 892  * \param p_mi libvlc media player instance
 893  * \param option logo option to set, values of libvlc_video_logo_option_t
 894  * \param value logo option value
 895  */
 896 VLC_PUBLIC_API void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
 897                                                unsigned option, int value );
 898
 899 /**
 900  * Set logo option as string. Options that take a different type value
 901  * are ignored.
 902  *
 903  * \param p_mi libvlc media player instance
 904  * \param option logo option to set, values of libvlc_video_logo_option_t
 905  * \param psz_value logo option value
 906  */
 907 VLC_PUBLIC_API void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
 908                                       unsigned option, const char *psz_value );
 909
 910
 911 /** @} video */
 912
 913 /** \defgroup libvlc_audio libvlc_audio
 914  * \ingroup libvlc_media_player
 915  * LibVLC Audio handling
 916  * @{
 917  */
 918
 919 /**
 920  * Audio device types
 921  */
 922 typedef enum libvlc_audio_output_device_types_t {
 923     libvlc_AudioOutputDevice_Error  = -1,
 924     libvlc_AudioOutputDevice_Mono   =  1,
 925     libvlc_AudioOutputDevice_Stereo =  2,
 926     libvlc_AudioOutputDevice_2F2R   =  4,
 927     libvlc_AudioOutputDevice_3F2R   =  5,
 928     libvlc_AudioOutputDevice_5_1    =  6,
 929     libvlc_AudioOutputDevice_6_1    =  7,
 930     libvlc_AudioOutputDevice_7_1    =  8,
 931     libvlc_AudioOutputDevice_SPDIF  = 10
 932 } libvlc_audio_output_device_types_t;
 933
 934 /**
 935  * Audio channels
 936  */
 937 typedef enum libvlc_audio_output_channel_t {
 938     libvlc_AudioChannel_Error   = -1,
 939     libvlc_AudioChannel_Stereo  =  1,
 940     libvlc_AudioChannel_RStereo =  2,
 941     libvlc_AudioChannel_Left    =  3,
 942     libvlc_AudioChannel_Right   =  4,
 943     libvlc_AudioChannel_Dolbys  =  5
 944 } libvlc_audio_output_channel_t;
 945
 946
 947 /**
 948  * Get the list of available audio outputs
 949  *
 950  * \param p_instance libvlc instance
 951  * \return list of available audio outputs. It must be freed it with
 952 *          \see libvlc_audio_output_list_release \see libvlc_audio_output_t .
 953  *         In case of error, NULL is returned.
 954  */
 955 VLC_PUBLIC_API libvlc_audio_output_t *
 956         libvlc_audio_output_list_get( libvlc_instance_t *p_instance );
 957
 958 /**
 959  * Free the list of available audio outputs
 960  *
 961  * \param p_list list with audio outputs for release
 962  */
 963 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t *p_list );
 964
 965 /**
 966  * Set the audio output.
 967  * Change will be applied after stop and play.
 968  *
 969  * \param p_mi media player
 970  * \param psz_name name of audio output,
 971  *               use psz_name of \see libvlc_audio_output_t
 972  * \return true if function succeded
 973  */
 974 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_media_player_t *p_mi,
 975                                             const char *psz_name );
 976
 977 /**
 978  * Get count of devices for audio output, these devices are hardware oriented
 979  * like analor or digital output of sound card
 980  *
 981  * \param p_instance libvlc instance
 982  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 983  * \return number of devices
 984  */
 985 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *p_instance,
 986                                                      const char *psz_audio_output );
 987
 988 /**
 989  * Get long name of device, if not available short name given
 990  *
 991  * \param p_instance libvlc instance
 992  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 993  * \param i_device device index
 994  * \return long name of device
 995  */
 996 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *p_instance,
 997                                                            const char *psz_audio_output,
 998                                                            int i_device );
 999
1000 /**
1001  * Get id name of device
1002  *
1003  * \param p_instance libvlc instance
1004  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1005  * \param i_device device index
1006  * \return id name of device, use for setting device, need to be free after use
1007  */
1008 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *p_instance,
1009                                                      const char *psz_audio_output,
1010                                                      int i_device );
1011
1012 /**
1013  * Set audio output device. Changes are only effective after stop and play.
1014  *
1015  * \param p_mi media player
1016  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1017  * \param psz_device_id device
1018  */
1019 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_media_player_t *p_mi,
1020                                                     const char *psz_audio_output,
1021                                                     const char *psz_device_id );
1022
1023 /**
1024  * Get current audio device type. Device type describes something like
1025  * character of output sound - stereo sound, 2.1, 5.1 etc
1026  *
1027  * \param p_mi media player
1028  * \return the audio devices type \see libvlc_audio_output_device_types_t
1029  */
1030 VLC_PUBLIC_API int libvlc_audio_output_get_device_type( libvlc_media_player_t *p_mi );
1031
1032 /**
1033  * Set current audio device type.
1034  *
1035  * \param p_mi vlc instance
1036  * \param device_type the audio device type,
1037           according to \see libvlc_audio_output_device_types_t
1038  */
1039 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_media_player_t *p_mi,
1040                                                          int device_type );
1041
1042
1043 /**
1044  * Toggle mute status.
1045  *
1046  * \param p_mi media player
1047  */
1048 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_media_player_t *p_mi );
1049
1050 /**
1051  * Get current mute status.
1052  *
1053  * \param p_mi media player
1054  * \return the mute status (boolean)
1055  */
1056 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_media_player_t *p_mi );
1057
1058 /**
1059  * Set mute status.
1060  *
1061  * \param p_mi media player
1062  * \param status If status is true then mute, otherwise unmute
1063  */
1064 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_media_player_t *p_mi, int status );
1065
1066 /**
1067  * Get current audio level.
1068  *
1069  * \param p_mi media player
1070  * \return the audio level (int)
1071  */
1072 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_media_player_t *p_mi );
1073
1074 /**
1075  * Set current audio level.
1076  *
1077  * \param p_mi media player
1078  * \param i_volume the volume (int)
1079  * \return 0 if the volume was set, -1 if it was out of range
1080  */
1081 VLC_PUBLIC_API int libvlc_audio_set_volume( libvlc_media_player_t *p_mi, int i_volume );
1082
1083 /**
1084  * Get number of available audio tracks.
1085  *
1086  * \param p_mi media player
1087  * \return the number of available audio tracks (int), or -1 if unavailable
1088  */
1089 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *p_mi );
1090
1091 /**
1092  * Get the description of available audio tracks.
1093  *
1094  * \param p_mi media player
1095  * \return list with description of available audio tracks, or NULL
1096  */
1097 VLC_PUBLIC_API libvlc_track_description_t *
1098         libvlc_audio_get_track_description( libvlc_media_player_t *p_mi );
1099
1100 /**
1101  * Get current audio track.
1102  *
1103  * \param p_mi media player
1104  * \return the audio track (int), or -1 if none.
1105  */
1106 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *p_mi );
1107
1108 /**
1109  * Set current audio track.
1110  *
1111  * \param p_mi media player
1112  * \param i_track the track (int)
1113  * \return 0 on success, -1 on error
1114  */
1115 VLC_PUBLIC_API int libvlc_audio_set_track( libvlc_media_player_t *p_mi, int i_track );
1116
1117 /**
1118  * Get current audio channel.
1119  *
1120  * \param p_mi media player
1121  * \return the audio channel \see libvlc_audio_output_channel_t
1122  */
1123 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_media_player_t *p_mi );
1124
1125 /**
1126  * Set current audio channel.
1127  *
1128  * \param p_mi media player
1129  * \param channel the audio channel, \see libvlc_audio_output_channel_t
1130  * \return 0 on success, -1 on error
1131  */
1132 VLC_PUBLIC_API int libvlc_audio_set_channel( libvlc_media_player_t *p_mi, int channel );
1133
1134 /** @} audio */
1135
1136 /** @} media_player */
1137
1138 # ifdef __cplusplus
1139 }
1140 # endif
1141
1142 #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */