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 * );
 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 * );
 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 * );
 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 * );
 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 *, libvlc_media_t * );
 145
 146 /**
 147  * Get the media used by the media_player.
 148  *
 149  * \param p_mi the Media Player
 150  * \return the media associated with p_mi, or NULL if no
 151  *         media is associated
 152  */
 153 VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t * );
 154
 155 /**
 156  * Get the Event Manager from which the media player send event.
 157  *
 158  * \param p_mi the Media Player
 159  * \return the event manager associated with p_mi
 160  */
 161 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t * );
 162
 163 /**
 164  * is_playing
 165  *
 166  * \param p_mi the Media Player
 167  * \return 1 if the media player is playing, 0 otherwise
 168  */
 169 VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t * );
 170
 171 /**
 172  * Play
 173  *
 174  * \param p_mi the Media Player
 175  * \return 0 if playback started (and was already started), or -1 on error.
 176  */
 177 VLC_PUBLIC_API int libvlc_media_player_play ( libvlc_media_player_t * );
 178
 179 /**
 180  * Toggle pause (no effect if there is no media)
 181  *
 182  * \param p_mi the Media Player
 183  */
 184 VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t * );
 185
 186 /**
 187  * Stop (no effect if there is no media)
 188  *
 189  * \param p_mi the Media Player
 190  */
 191 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t * );
 192
 193 /**
 194  * Set the NSView handler where the media player should render its video output.
 195  *
 196  * The object minimal_macosx expects is of kind NSObject and should
 197  * respect the protocol:
 198  *
 199  * @protocol VLCOpenGLVideoViewEmbedding <NSObject>
 200  * - (void)addVoutSubview:(NSView *)view;
 201  * - (void)removeVoutSubview:(NSView *)view;
 202  * @end
 203  *
 204  * You can find a live example in VLCVideoView in VLCKit.framework.
 205  *
 206  * \param p_mi the Media Player
 207  * \param drawable the NSView handler
 208  */
 209 VLC_PUBLIC_API void libvlc_media_player_set_nsobject ( libvlc_media_player_t *p_mi, void * drawable );
 210
 211 /**
 212  * Get the NSView handler previously set with libvlc_media_player_set_nsobject().
 213  *
 214  * \param p_mi the Media Player
 215  * \return the NSView handler or 0 if none where set
 216  */
 217 VLC_PUBLIC_API void * libvlc_media_player_get_nsobject ( libvlc_media_player_t *p_mi );
 218
 219 /**
 220  * Set the agl handler where the media player should render its video output.
 221  *
 222  * \param p_mi the Media Player
 223  * \param drawable the agl handler
 224  * \param p_e an initialized exception pointer
 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 * );
 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 * );
 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 the movie time (in ms).
 311  */
 312 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t );
 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 * );
 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 *, float );
 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 *, int );
 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 * );
 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 * );
 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 * );
 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 *, int );
 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 *, int );
 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 * );
 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 * );
 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 * );
 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 * );
 410
 411 /**
 412  * Get movie play rate
 413  *
 414  * \param p_mi the Media Player
 415  * \return movie play rate, or zero in case of error
 416  */
 417 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t * );
 418
 419 /**
 420  * Set movie play rate
 421  *
 422  * \param p_mi the Media Player
 423  * \param movie play rate to set
 424  * \return -1 if an error was detected, 0 otherwise (but even then, it might
 425  * not actually work depending on the underlying media protocol)
 426  */
 427 VLC_PUBLIC_API int libvlc_media_player_set_rate( libvlc_media_player_t *, float );
 428
 429 /**
 430  * Get current movie state
 431  *
 432  * \param p_mi the Media Player
 433  */
 434 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *);
 435
 436 /**
 437  * Get movie fps rate
 438  *
 439  * \param p_mi the Media Player
 440  * \return frames per second (fps) for this playing movie, or 0 if unspecified
 441  */
 442 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t * );
 443
 444 /** end bug */
 445
 446 /**
 447  * How many video outputs does this media player have?
 448  *
 449  * \param p_md the media player
 450  * \return the number of video outputs
 451  */
 452 VLC_PUBLIC_API unsigned libvlc_media_player_has_vout( libvlc_media_player_t * );
 453
 454 /**
 455  * Is this media player seekable?
 456  *
 457  * \param p_input the input
 458  */
 459 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi );
 460
 461 /**
 462  * Can this media player be paused?
 463  *
 464  * \param p_input the input
 465  */
 466 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi );
 467
 468
 469 /**
 470  * Display the next frame (if supported)
 471  *
 472  * \param p_input the libvlc_media_player_t instance
 473  */
 474 VLC_PUBLIC_API void libvlc_media_player_next_frame( libvlc_media_player_t *p_input );
 475
 476
 477
 478 /**
 479  * Release (free) libvlc_track_description_t
 480  *
 481  * \param p_track_description the structure to release
 482  */
 483 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
 484
 485 /** \defgroup libvlc_video libvlc_video
 486  * \ingroup libvlc_media_player
 487  * LibVLC Video handling
 488  * @{
 489  */
 490
 491 /**
 492  * Toggle fullscreen status on non-embedded video outputs.
 493  *
 494  * @warning The same limitations applies to this function
 495  * as to libvlc_set_fullscreen().
 496  *
 497  * \param p_mediaplayer the media player
 498  */
 499 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t * );
 500
 501 /**
 502  * Enable or disable fullscreen on non-embedded video outputs.
 503  *
 504  * @warning With most window managers, only a top-level windows can switch to
 505  * full-screen mode. Hence, this function will not operate properly if
 506  * libvlc_media_player_set_xid() or libvlc_media_player_set_hwnd() was
 507  * used to embed the video in a non-LibVLC widget. If you want to to render an
 508  * embedded LibVLC video full-screen, the parent embedding widget must expanded
 509  * to full screen (LibVLC cannot take care of that).
 510  * LibVLC will then automatically resize the video as appropriate.
 511  *
 512  * \param p_mediaplayer the media player
 513  * \param b_fullscreen boolean for fullscreen status
 514  */
 515 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int );
 516
 517 /**
 518  * Get current fullscreen status.
 519  *
 520  * \param p_mediaplayer the media player
 521  * \return the fullscreen status (boolean)
 522  */
 523 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t * );
 524
 525 /**
 526  * Enable or disable key press events handling, according to the LibVLC hotkeys
 527  * configuration. By default and for historical reasons, keyboard events are
 528  * handled by the LibVLC video widget.
 529  *
 530  * \note On X11, there can be only one subscriber for key press and mouse
 531  * click events per window. If your application has subscribed to those events
 532  * for the X window ID of the video widget, then LibVLC will not be able to
 533  * handle key presses and mouse clicks in any case.
 534  *
 535  * \warning This function is only implemented for X11 at the moment.
 536  *
 537  * \param mp the media player
 538  * \param on true to handle key press events, false to ignore them.
 539  */
 540 VLC_PUBLIC_API
 541 void libvlc_video_set_key_input( libvlc_media_player_t *mp, unsigned on );
 542
 543 /**
 544  * Enable or disable mouse click events handling. By default, those events are
 545  * handled. This is needed for DVD menus to work, as well as a few video
 546  * filters such as "puzzle".
 547  *
 548  * \note See also \func libvlc_video_set_key_input().
 549  *
 550  * \warning This function is only implemented for X11 at the moment.
 551  *
 552  * \param mp the media player
 553  * \param on true to handle mouse click events, false to ignore them.
 554  */
 555 VLC_PUBLIC_API
 556 void libvlc_video_set_mouse_input( libvlc_media_player_t *mp, unsigned on );
 557
 558 /**
 559  * Get the pixel dimensions of a video.
 560  *
 561  * \param mp media player
 562  * \param num number of the video (starting from, and most commonly 0)
 563  * \param px pointer to get the pixel width [OUT]
 564  * \param py pointer to get the pixel height [OUT]
 565  * \return 0 on success, -1 if the specified video does not exist
 566  */
 567 VLC_PUBLIC_API
 568 int libvlc_video_get_size( libvlc_media_player_t *mp, unsigned num,
 569                            unsigned *px, unsigned *py );
 570
 571 /**
 572  * Get current video height.
 573  * You should use libvlc_video_get_size() instead.
 574  *
 575  * \param p_mediaplayer the media player
 576  * \return the video pixel height or 0 if not applicable
 577  */
 578 VLC_DEPRECATED_API
 579 int libvlc_video_get_height( libvlc_media_player_t * );
 580
 581 /**
 582  * Get current video width.
 583  * You should use libvlc_video_get_size() instead.
 584  *
 585  * \param p_mediaplayer the media player
 586  * \return the video pixel width or 0 if not applicable
 587  */
 588 VLC_DEPRECATED_API
 589 int libvlc_video_get_width( libvlc_media_player_t * );
 590
 591 /**
 592  * Get the current video scaling factor.
 593  * See also libvlc_video_set_scale().
 594  *
 595  * \param p_mediaplayer the media player
 596  * \return the currently configured zoom factor, or 0. if the video is set
 597  * to fit to the output window/drawable automatically.
 598  */
 599 VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t * );
 600
 601 /**
 602  * Set the video scaling factor. That is the ratio of the number of pixels on
 603  * screen to the number of pixels in the original decoded video in each
 604  * dimension. Zero is a special value; it will adjust the video to the output
 605  * window/drawable (in windowed mode) or the entire screen.
 606  *
 607  * Note that not all video outputs support scaling.
 608  *
 609  * \param p_mediaplayer the media player
 610  * \param i_factor the scaling factor, or zero
 611  */
 612 VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *, float );
 613
 614 /**
 615  * Get current video aspect ratio.
 616  *
 617  * \param p_mediaplayer the media player
 618  * \return the video aspect ratio or NULL if unspecified
 619  * (the result must be released with free() or libvlc_free()).
 620  */
 621 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t * );
 622
 623 /**
 624  * Set new video aspect ratio.
 625  *
 626  * \param p_mediaplayer the media player
 627  * \param psz_aspect new video aspect-ratio or NULL to reset to default
 628  * \note Invalid aspect ratios are ignored.
 629  */
 630 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, const char * );
 631
 632 /**
 633  * Get current video subtitle.
 634  *
 635  * \param p_mediaplayer the media player
 636  * \return the video subtitle selected, or -1 if none
 637  */
 638 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t * );
 639
 640 /**
 641  * Get the number of available video subtitles.
 642  *
 643  * \param p_mediaplayer the media player
 644  * \return the number of available video subtitles
 645  */
 646 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t * );
 647
 648 /**
 649  * Get the description of available video subtitles.
 650  *
 651  * \param p_mediaplayer the media player
 652  * \param p_e an initialized exception pointer
 653  * \return list containing description of available video subtitles
 654  */
 655 VLC_PUBLIC_API libvlc_track_description_t *
 656         libvlc_video_get_spu_description( libvlc_media_player_t * );
 657
 658 /**
 659  * Set new video subtitle.
 660  *
 661  * \param p_mediaplayer the media player
 662  * \param i_spu new video subtitle to select
 663  * \return 0 on success, -1 if out of range
 664  */
 665 VLC_PUBLIC_API int libvlc_video_set_spu( libvlc_media_player_t *, unsigned );
 666
 667 /**
 668  * Set new video subtitle file.
 669  *
 670  * \param p_mediaplayer the media player
 671  * \param psz_subtitle new video subtitle file
 672  * \param p_e an initialized exception pointer
 673  * \return the success status (boolean)
 674  */
 675 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, const char * );
 676
 677 /**
 678  * Get the description of available titles.
 679  *
 680  * \param p_mediaplayer the media player
 681  * \param p_e an initialized exception pointer
 682  * \return list containing description of available titles
 683  */
 684 VLC_PUBLIC_API libvlc_track_description_t *
 685         libvlc_video_get_title_description( libvlc_media_player_t * );
 686
 687 /**
 688  * Get the description of available chapters for specific title.
 689  *
 690  * \param p_mediaplayer the media player
 691  * \param i_title selected title
 692  * \param p_e an initialized exception pointer
 693  * \return list containing description of available chapter for title i_title
 694  */
 695 VLC_PUBLIC_API libvlc_track_description_t *
 696         libvlc_video_get_chapter_description( libvlc_media_player_t *, int );
 697
 698 /**
 699  * Get current crop filter geometry.
 700  *
 701  * \param p_mediaplayer the media player
 702  * \return the crop filter geometry or NULL if unset
 703  */
 704 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t * );
 705
 706 /**
 707  * Set new crop filter geometry.
 708  *
 709  * \param p_mediaplayer the media player
 710  * \param psz_geometry new crop filter geometry (NULL to unset)
 711  */
 712 VLC_PUBLIC_API
 713 void libvlc_video_set_crop_geometry( libvlc_media_player_t *, const char * );
 714
 715 /**
 716  * Get current teletext page requested.
 717  *
 718  * \param p_mediaplayer the media player
 719  * \return the current teletext page requested.
 720  */
 721 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t * );
 722
 723 /**
 724  * Set new teletext page to retrieve.
 725  *
 726  * \param p_mediaplayer the media player
 727  * \param i_page teletex page number requested
 728  * \param p_e an initialized exception pointer
 729  */
 730 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
 731
 732 /**
 733  * Toggle teletext transparent status on video output.
 734  *
 735  * \param p_mediaplayer the media player
 736  * \param p_e an initialized exception pointer
 737  */
 738 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t * );
 739
 740 /**
 741  * Get number of available video tracks.
 742  *
 743  * \param p_mi media player
 744  * \return the number of available video tracks (int)
 745  */
 746 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t * );
 747
 748 /**
 749  * Get the description of available video tracks.
 750  *
 751  * \param p_mi media player
 752  * \return list with description of available video tracks, or NULL on error
 753  */
 754 VLC_PUBLIC_API libvlc_track_description_t *
 755         libvlc_video_get_track_description( libvlc_media_player_t * );
 756
 757 /**
 758  * Get current video track.
 759  *
 760  * \param p_mi media player
 761  * \return the video track (int) or -1 if none
 762  */
 763 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t * );
 764
 765 /**
 766  * Set video track.
 767  *
 768  * \param p_mi media player
 769  * \param i_track the track (int)
 770  * \return 0 on success, -1 if out of range
 771  */
 772 VLC_PUBLIC_API
 773 int libvlc_video_set_track( libvlc_media_player_t *, int );
 774
 775 /**
 776  * Take a snapshot of the current video window.
 777  *
 778  * If i_width AND i_height is 0, original size is used.
 779  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
 780  *
 781  * \param p_mi media player instance
 782  * \param num number of video output (typically 0 for the first/only one)
 783  * \param psz_filepath the path where to save the screenshot to
 784  * \param i_width the snapshot's width
 785  * \param i_height the snapshot's height
 786  * \return 0 on success, -1 if the video was not found
 787  */
 788 VLC_PUBLIC_API
 789 int libvlc_video_take_snapshot( libvlc_media_player_t *, unsigned num,
 790                                 const char *,unsigned int, unsigned int );
 791
 792 /**
 793  * Enable or disable deinterlace filter
 794  *
 795  * \param p_mi libvlc media player
 796  * \param psz_mode type of deinterlace filter, NULL to disable
 797  */
 798 VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *,
 799                                                   const char * );
 800
 801 /**
 802  * Get an integer marquee option value
 803  *
 804  * \param p_mi libvlc media player
 805  * \param option marq option to get \see libvlc_video_marquee_int_option_t
 806  * \param p_e an initialized exception pointer
 807  */
 808 VLC_PUBLIC_API int libvlc_video_get_marquee_int( libvlc_media_player_t *,
 809                                              unsigned, libvlc_exception_t * );
 810
 811 /**
 812  * Get a string marquee option value
 813  *
 814  * \param p_mi libvlc media player
 815  * \param option marq option to get \see libvlc_video_marquee_string_option_t
 816  * \param p_e an initialized exception pointer
 817  */
 818 VLC_PUBLIC_API char *libvlc_video_get_marquee_string( libvlc_media_player_t *,
 819                                              unsigned, libvlc_exception_t * );
 820
 821 /**
 822  * Enable, disable or set an integer marquee option
 823  *
 824  * Setting libvlc_marquee_Enable has the side effect of enabling (arg !0)
 825  * or disabling (arg 0) the marq filter.
 826  *
 827  * \param p_mi libvlc media player
 828  * \param option marq option to set \see libvlc_video_marquee_int_option_t
 829  * \param i_val marq option value
 830  * \param p_e an initialized exception pointer
 831  */
 832 VLC_PUBLIC_API void libvlc_video_set_marquee_int( libvlc_media_player_t *,
 833                                         unsigned, int, libvlc_exception_t * );
 834
 835 /**
 836  * Set a marquee string option
 837  *
 838  * \param p_mi libvlc media player
 839  * \param option marq option to set \see libvlc_video_marquee_string_option_t
 840  * \param psz_text marq option value
 841  * \param p_e an initialized exception pointer
 842  */
 843 VLC_PUBLIC_API void libvlc_video_set_marquee_string( libvlc_media_player_t *,
 844                                unsigned, const char *, libvlc_exception_t * );
 845
 846 /** option values for libvlc_video_{get,set}_logo_{int,string} */
 847 enum libvlc_video_logo_option_t {
 848     libvlc_logo_enable,
 849     libvlc_logo_file,           /**< string argument, "file,d,t;file,d,t;..." */
 850     libvlc_logo_x,
 851     libvlc_logo_y,
 852     libvlc_logo_delay,
 853     libvlc_logo_repeat,
 854     libvlc_logo_opacity,
 855     libvlc_logo_position,
 856 };
 857
 858 /**
 859  * Get integer logo option.
 860  *
 861  * \param p_mi libvlc media player instance
 862  * \param option logo option to get, values of libvlc_video_logo_option_t
 863  * \param p_e an pointer to an initialized exception object
 864  */
 865 VLC_PUBLIC_API int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
 866                                  unsigned option, libvlc_exception_t *p_e );
 867
 868 /**
 869  * Set logo option as integer. Options that take a different type value
 870  * cause an invalid argument exception.
 871  * Passing libvlc_logo_enable as option value has the side effect of
 872  * starting (arg !0) or stopping (arg 0) the logo filter.
 873  *
 874  * \param p_mi libvlc media player instance
 875  * \param option logo option to set, values of libvlc_video_logo_option_t
 876  * \param value logo option value
 877  * \param p_e an pointer to an initialized exception object
 878  */
 879 VLC_PUBLIC_API void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
 880                         unsigned option, int value, libvlc_exception_t *p_e );
 881
 882 /**
 883  * Set logo option as string. Options that take a different type value
 884  * cause an invalid argument exception.
 885  *
 886  * \param p_mi libvlc media player instance
 887  * \param option logo option to set, values of libvlc_video_logo_option_t
 888  * \param psz_value logo option value
 889  * \param p_e an pointer to an initialized exception object
 890  */
 891 VLC_PUBLIC_API void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
 892             unsigned option, const char *psz_value, libvlc_exception_t *p_e );
 893
 894
 895 /** @} video */
 896
 897 /** \defgroup libvlc_audio libvlc_audio
 898  * \ingroup libvlc_media_player
 899  * LibVLC Audio handling
 900  * @{
 901  */
 902
 903 /**
 904  * Audio device types
 905  */
 906 typedef enum libvlc_audio_output_device_types_t {
 907     libvlc_AudioOutputDevice_Error  = -1,
 908     libvlc_AudioOutputDevice_Mono   =  1,
 909     libvlc_AudioOutputDevice_Stereo =  2,
 910     libvlc_AudioOutputDevice_2F2R   =  4,
 911     libvlc_AudioOutputDevice_3F2R   =  5,
 912     libvlc_AudioOutputDevice_5_1    =  6,
 913     libvlc_AudioOutputDevice_6_1    =  7,
 914     libvlc_AudioOutputDevice_7_1    =  8,
 915     libvlc_AudioOutputDevice_SPDIF  = 10
 916 } libvlc_audio_output_device_types_t;
 917
 918 /**
 919  * Audio channels
 920  */
 921 typedef enum libvlc_audio_output_channel_t {
 922     libvlc_AudioChannel_Error   = -1,
 923     libvlc_AudioChannel_Stereo  =  1,
 924     libvlc_AudioChannel_RStereo =  2,
 925     libvlc_AudioChannel_Left    =  3,
 926     libvlc_AudioChannel_Right   =  4,
 927     libvlc_AudioChannel_Dolbys  =  5
 928 } libvlc_audio_output_channel_t;
 929
 930
 931 /**
 932  * Get the list of available audio outputs
 933  *
 934  * \param p_instance libvlc instance
 935  * \return list of available audio outputs. It must be freed it with
 936 *          \see libvlc_audio_output_list_release \see libvlc_audio_output_t .
 937  *         In case of error, NULL is returned.
 938  */
 939 VLC_PUBLIC_API libvlc_audio_output_t *
 940         libvlc_audio_output_list_get( libvlc_instance_t * );
 941
 942 /**
 943  * Free the list of available audio outputs
 944  *
 945  * \param p_list list with audio outputs for release
 946  */
 947 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
 948
 949 /**
 950  * Set the audio output.
 951  * Change will be applied after stop and play.
 952  *
 953  * \param mp media player
 954  * \param psz_name name of audio output,
 955  *               use psz_name of \see libvlc_audio_output_t
 956  * \return true if function succeded
 957  */
 958 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_media_player_t *,
 959                                             const char * );
 960
 961 /**
 962  * Get count of devices for audio output, these devices are hardware oriented
 963  * like analor or digital output of sound card
 964  *
 965  * \param p_instance libvlc instance
 966  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 967  * \return number of devices
 968  */
 969 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
 970                                                      const char * );
 971
 972 /**
 973  * Get long name of device, if not available short name given
 974  *
 975  * \param p_instance libvlc instance
 976  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 977  * \param i_device device index
 978  * \return long name of device
 979  */
 980 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
 981                                                            const char *,
 982                                                            int );
 983
 984 /**
 985  * Get id name of device
 986  *
 987  * \param p_instance libvlc instance
 988  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 989  * \param i_device device index
 990  * \return id name of device, use for setting device, need to be free after use
 991  */
 992 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
 993                                                      const char *,
 994                                                      int );
 995
 996 /**
 997  * Set audio output device. Changes are only effective after stop and play.
 998  *
 999  * \param mp media player
1000  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1001  * \param psz_device_id device
1002  */
1003 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_media_player_t *,
1004                                                     const char *,
1005                                                     const char * );
1006
1007 /**
1008  * Get current audio device type. Device type describes something like
1009  * character of output sound - stereo sound, 2.1, 5.1 etc
1010  *
1011  * \param mp media player
1012  * \return the audio devices type \see libvlc_audio_output_device_types_t
1013  */
1014 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
1015         libvlc_media_player_t * );
1016
1017 /**
1018  * Set current audio device type.
1019  *
1020  * \param mp vlc instance
1021  * \param device_type the audio device type,
1022           according to \see libvlc_audio_output_device_types_t
1023  * \param p_e an initialized exception pointer
1024  */
1025 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_media_player_t *,
1026                                                          int );
1027
1028
1029 /**
1030  * Toggle mute status.
1031  *
1032  * \param mp media player
1033  */
1034 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_media_player_t * );
1035
1036 /**
1037  * Get current mute status.
1038  *
1039  * \param mp media player
1040  * \return the mute status (boolean)
1041  */
1042 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_media_player_t * );
1043
1044 /**
1045  * Set mute status.
1046  *
1047  * \param mp media player
1048  * \param status If status is true then mute, otherwise unmute
1049  */
1050 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_media_player_t *, int );
1051
1052 /**
1053  * Get current audio level.
1054  *
1055  * \param mp media player
1056  * \param p_e an initialized exception pointer
1057  * \return the audio level (int)
1058  */
1059 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_media_player_t * );
1060
1061 /**
1062  * Set current audio level.
1063  *
1064  * \param mp media player
1065  * \param i_volume the volume (int)
1066  * \return 0 if the volume was set, -1 if it was out of range
1067  */
1068 VLC_PUBLIC_API int libvlc_audio_set_volume( libvlc_media_player_t *, int );
1069
1070 /**
1071  * Get number of available audio tracks.
1072  *
1073  * \param p_mi media player
1074  * \return the number of available audio tracks (int), or -1 if unavailable
1075  */
1076 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t * );
1077
1078 /**
1079  * Get the description of available audio tracks.
1080  *
1081  * \param p_mi media player
1082  * \return list with description of available audio tracks, or NULL
1083  */
1084 VLC_PUBLIC_API libvlc_track_description_t *
1085         libvlc_audio_get_track_description( libvlc_media_player_t * );
1086
1087 /**
1088  * Get current audio track.
1089  *
1090  * \param p_mi media player
1091  * \return the audio track (int), or -1 if none.
1092  */
1093 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t * );
1094
1095 /**
1096  * Set current audio track.
1097  *
1098  * \param p_mi media player
1099  * \param i_track the track (int)
1100  * \return 0 on success, -1 on error
1101  */
1102 VLC_PUBLIC_API int libvlc_audio_set_track( libvlc_media_player_t *, int );
1103
1104 /**
1105  * Get current audio channel.
1106  *
1107  * \param mp media player
1108  * \return the audio channel \see libvlc_audio_output_channel_t
1109  */
1110 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_media_player_t * );
1111
1112 /**
1113  * Set current audio channel.
1114  *
1115  * \param p_mi media player
1116  * \param channel the audio channel, \see libvlc_audio_output_channel_t
1117  * \return 0 on success, -1 on error
1118  */
1119 VLC_PUBLIC_API int libvlc_audio_set_channel( libvlc_media_player_t *, int );
1120
1121 /** @} audio */
1122
1123 /** @} media_player */
1124
1125 # ifdef __cplusplus
1126 }
1127 # endif
1128
1129 #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */