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 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 *p_mi );
 418
 419 /**
 420  * Set movie play rate
 421  *
 422  * \param p_mi the Media Player
 423  * \param rate 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 *p_mi, float rate );
 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 *p_mi );
 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 *p_mi );
 443
 444 /** end bug */
 445
 446 /**
 447  * How many video outputs does this media player have?
 448  *
 449  * \param p_mi 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 *p_mi );
 453
 454 /**
 455  * Is this media player seekable?
 456  *
 457  * \param p_mi the media player
 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_mi the media player
 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_mi the media player
 473  */
 474 VLC_PUBLIC_API void libvlc_media_player_next_frame( libvlc_media_player_t *p_mi );
 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_mi the media player
 498  */
 499 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi );
 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_mi the media player
 513  * \param b_fullscreen boolean for fullscreen status
 514  */
 515 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *p_mi, int b_fullscreen );
 516
 517 /**
 518  * Get current fullscreen status.
 519  *
 520  * \param p_mi the media player
 521  * \return the fullscreen status (boolean)
 522  */
 523 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *p_mi );
 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 p_mi 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 *p_mi, 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 libvlc_video_set_key_input().
 549  *
 550  * \warning This function is only implemented for X11 at the moment.
 551  *
 552  * \param p_mi 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 *p_mi, unsigned on );
 557
 558 /**
 559  * Get the pixel dimensions of a video.
 560  *
 561  * \param p_mi 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 *p_mi, 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_mi 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 *p_mi );
 580
 581 /**
 582  * Get current video width.
 583  * You should use libvlc_video_get_size() instead.
 584  *
 585  * \param p_mi 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 *p_mi );
 590
 591 /**
 592  * Get the mouse pointer coordinates over a video.
 593  * Coordinates are expressed in terms of the decoded video resolution,
 594  * <b>not</b> in terms of pixels on the screen/viewport (to get the latter,
 595  * you can query your windowing system directly).
 596  *
 597  * Either of the coordinates may be negative or larger than the corresponding
 598  * dimension of the video, if the cursor is outside the rendering area.
 599  *
 600  * @warning The coordinates may be out-of-date if the pointer is not located
 601  * on the video rendering area. LibVLC does not track the pointer if it is
 602  * outside of the video widget.
 603  *
 604  * @note LibVLC does not support multiple pointers (it does of course support
 605  * multiple input devices sharing the same pointer) at the moment.
 606  *
 607  * \param p_mi media player
 608  * \param num number of the video (starting from, and most commonly 0)
 609  * \param px pointer to get the abscissa [OUT]
 610  * \param py pointer to get the ordinate [OUT]
 611  * \return 0 on success, -1 if the specified video does not exist
 612  */
 613 VLC_PUBLIC_API
 614 int libvlc_video_get_cursor( libvlc_media_player_t *p_mi, unsigned num,
 615                              int *px, int *py );
 616
 617 /**
 618  * Get the current video scaling factor.
 619  * See also libvlc_video_set_scale().
 620  *
 621  * \param p_mi the media player
 622  * \return the currently configured zoom factor, or 0. if the video is set
 623  * to fit to the output window/drawable automatically.
 624  */
 625 VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *p_mi );
 626
 627 /**
 628  * Set the video scaling factor. That is the ratio of the number of pixels on
 629  * screen to the number of pixels in the original decoded video in each
 630  * dimension. Zero is a special value; it will adjust the video to the output
 631  * window/drawable (in windowed mode) or the entire screen.
 632  *
 633  * Note that not all video outputs support scaling.
 634  *
 635  * \param p_mi the media player
 636  * \param f_factor the scaling factor, or zero
 637  */
 638 VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *p_mi, float f_factor );
 639
 640 /**
 641  * Get current video aspect ratio.
 642  *
 643  * \param p_mi the media player
 644  * \return the video aspect ratio or NULL if unspecified
 645  * (the result must be released with free()).
 646  */
 647 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi );
 648
 649 /**
 650  * Set new video aspect ratio.
 651  *
 652  * \param p_mi the media player
 653  * \param psz_aspect new video aspect-ratio or NULL to reset to default
 654  * \note Invalid aspect ratios are ignored.
 655  */
 656 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi, const char *psz_aspect );
 657
 658 /**
 659  * Get current video subtitle.
 660  *
 661  * \param p_mi the media player
 662  * \return the video subtitle selected, or -1 if none
 663  */
 664 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *p_mi );
 665
 666 /**
 667  * Get the number of available video subtitles.
 668  *
 669  * \param p_mi the media player
 670  * \return the number of available video subtitles
 671  */
 672 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi );
 673
 674 /**
 675  * Get the description of available video subtitles.
 676  *
 677  * \param p_mi the media player
 678  * \return list containing description of available video subtitles
 679  */
 680 VLC_PUBLIC_API libvlc_track_description_t *
 681         libvlc_video_get_spu_description( libvlc_media_player_t *p_mi );
 682
 683 /**
 684  * Set new video subtitle.
 685  *
 686  * \param p_mi the media player
 687  * \param i_spu new video subtitle to select
 688  * \return 0 on success, -1 if out of range
 689  */
 690 VLC_PUBLIC_API int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu );
 691
 692 /**
 693  * Set new video subtitle file.
 694  *
 695  * \param p_mi the media player
 696  * \param psz_subtitle new video subtitle file
 697  * \return the success status (boolean)
 698  */
 699 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi, const char *psz_subtitle );
 700
 701 /**
 702  * Get the description of available titles.
 703  *
 704  * \param p_mi the media player
 705  * \return list containing description of available titles
 706  */
 707 VLC_PUBLIC_API libvlc_track_description_t *
 708         libvlc_video_get_title_description( libvlc_media_player_t *p_mi );
 709
 710 /**
 711  * Get the description of available chapters for specific title.
 712  *
 713  * \param p_mi the media player
 714  * \param i_title selected title
 715  * \return list containing description of available chapter for title i_title
 716  */
 717 VLC_PUBLIC_API libvlc_track_description_t *
 718         libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi, int i_title );
 719
 720 /**
 721  * Get current crop filter geometry.
 722  *
 723  * \param p_mi the media player
 724  * \return the crop filter geometry or NULL if unset
 725  */
 726 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *p_mi );
 727
 728 /**
 729  * Set new crop filter geometry.
 730  *
 731  * \param p_mi the media player
 732  * \param psz_geometry new crop filter geometry (NULL to unset)
 733  */
 734 VLC_PUBLIC_API
 735 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi, const char *psz_geometry );
 736
 737 /**
 738  * Get current teletext page requested.
 739  *
 740  * \param p_mi the media player
 741  * \return the current teletext page requested.
 742  */
 743 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *p_mi );
 744
 745 /**
 746  * Set new teletext page to retrieve.
 747  *
 748  * \param p_mi the media player
 749  * \param i_page teletex page number requested
 750  */
 751 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page );
 752
 753 /**
 754  * Toggle teletext transparent status on video output.
 755  *
 756  * \param p_mi the media player
 757  */
 758 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *p_mi );
 759
 760 /**
 761  * Get number of available video tracks.
 762  *
 763  * \param p_mi media player
 764  * \return the number of available video tracks (int)
 765  */
 766 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *p_mi );
 767
 768 /**
 769  * Get the description of available video tracks.
 770  *
 771  * \param p_mi media player
 772  * \return list with description of available video tracks, or NULL on error
 773  */
 774 VLC_PUBLIC_API libvlc_track_description_t *
 775         libvlc_video_get_track_description( libvlc_media_player_t *p_mi );
 776
 777 /**
 778  * Get current video track.
 779  *
 780  * \param p_mi media player
 781  * \return the video track (int) or -1 if none
 782  */
 783 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *p_mi );
 784
 785 /**
 786  * Set video track.
 787  *
 788  * \param p_mi media player
 789  * \param i_track the track (int)
 790  * \return 0 on success, -1 if out of range
 791  */
 792 VLC_PUBLIC_API
 793 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track );
 794
 795 /**
 796  * Take a snapshot of the current video window.
 797  *
 798  * If i_width AND i_height is 0, original size is used.
 799  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
 800  *
 801  * \param p_mi media player instance
 802  * \param num number of video output (typically 0 for the first/only one)
 803  * \param psz_filepath the path where to save the screenshot to
 804  * \param i_width the snapshot's width
 805  * \param i_height the snapshot's height
 806  * \return 0 on success, -1 if the video was not found
 807  */
 808 VLC_PUBLIC_API
 809 int libvlc_video_take_snapshot( libvlc_media_player_t *p_mi, unsigned num,
 810                                 const char *psz_filepath, unsigned int i_width,
 811                                 unsigned int i_height );
 812
 813 /**
 814  * Enable or disable deinterlace filter
 815  *
 816  * \param p_mi libvlc media player
 817  * \param psz_mode type of deinterlace filter, NULL to disable
 818  */
 819 VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
 820                                                   const char *psz_mode );
 821
 822 /**
 823  * Get an integer marquee option value
 824  *
 825  * \param p_mi libvlc media player
 826  * \param option marq option to get \see libvlc_video_marquee_int_option_t
 827  */
 828 VLC_PUBLIC_API int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
 829                                                  unsigned option );
 830
 831 /**
 832  * Get a string marquee option value
 833  *
 834  * \param p_mi libvlc media player
 835  * \param option marq option to get \see libvlc_video_marquee_string_option_t
 836  */
 837 VLC_PUBLIC_API char *libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
 838                                                       unsigned option );
 839
 840 /**
 841  * Enable, disable or set an integer marquee option
 842  *
 843  * Setting libvlc_marquee_Enable has the side effect of enabling (arg !0)
 844  * or disabling (arg 0) the marq filter.
 845  *
 846  * \param p_mi libvlc media player
 847  * \param option marq option to set \see libvlc_video_marquee_int_option_t
 848  * \param i_val marq option value
 849  */
 850 VLC_PUBLIC_API void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
 851                                                   unsigned option, int i_val );
 852
 853 /**
 854  * Set a marquee string option
 855  *
 856  * \param p_mi libvlc media player
 857  * \param option marq option to set \see libvlc_video_marquee_string_option_t
 858  * \param psz_text marq option value
 859  */
 860 VLC_PUBLIC_API void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
 861                                                      unsigned option, const char *psz_text );
 862
 863 /** option values for libvlc_video_{get,set}_logo_{int,string} */
 864 enum libvlc_video_logo_option_t {
 865     libvlc_logo_enable,
 866     libvlc_logo_file,           /**< string argument, "file,d,t;file,d,t;..." */
 867     libvlc_logo_x,
 868     libvlc_logo_y,
 869     libvlc_logo_delay,
 870     libvlc_logo_repeat,
 871     libvlc_logo_opacity,
 872     libvlc_logo_position,
 873 };
 874
 875 /**
 876  * Get integer logo option.
 877  *
 878  * \param p_mi libvlc media player instance
 879  * \param option logo option to get, values of libvlc_video_logo_option_t
 880  */
 881 VLC_PUBLIC_API int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
 882                                               unsigned option );
 883
 884 /**
 885  * Set logo option as integer. Options that take a different type value
 886  * are ignored.
 887  * Passing libvlc_logo_enable as option value has the side effect of
 888  * starting (arg !0) or stopping (arg 0) the logo filter.
 889  *
 890  * \param p_mi libvlc media player instance
 891  * \param option logo option to set, values of libvlc_video_logo_option_t
 892  * \param value logo option value
 893  */
 894 VLC_PUBLIC_API void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
 895                                                unsigned option, int value );
 896
 897 /**
 898  * Set logo option as string. Options that take a different type value
 899  * are ignored.
 900  *
 901  * \param p_mi libvlc media player instance
 902  * \param option logo option to set, values of libvlc_video_logo_option_t
 903  * \param psz_value logo option value
 904  */
 905 VLC_PUBLIC_API void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
 906                                       unsigned option, const char *psz_value );
 907
 908
 909 /** @} video */
 910
 911 /** \defgroup libvlc_audio libvlc_audio
 912  * \ingroup libvlc_media_player
 913  * LibVLC Audio handling
 914  * @{
 915  */
 916
 917 /**
 918  * Audio device types
 919  */
 920 typedef enum libvlc_audio_output_device_types_t {
 921     libvlc_AudioOutputDevice_Error  = -1,
 922     libvlc_AudioOutputDevice_Mono   =  1,
 923     libvlc_AudioOutputDevice_Stereo =  2,
 924     libvlc_AudioOutputDevice_2F2R   =  4,
 925     libvlc_AudioOutputDevice_3F2R   =  5,
 926     libvlc_AudioOutputDevice_5_1    =  6,
 927     libvlc_AudioOutputDevice_6_1    =  7,
 928     libvlc_AudioOutputDevice_7_1    =  8,
 929     libvlc_AudioOutputDevice_SPDIF  = 10
 930 } libvlc_audio_output_device_types_t;
 931
 932 /**
 933  * Audio channels
 934  */
 935 typedef enum libvlc_audio_output_channel_t {
 936     libvlc_AudioChannel_Error   = -1,
 937     libvlc_AudioChannel_Stereo  =  1,
 938     libvlc_AudioChannel_RStereo =  2,
 939     libvlc_AudioChannel_Left    =  3,
 940     libvlc_AudioChannel_Right   =  4,
 941     libvlc_AudioChannel_Dolbys  =  5
 942 } libvlc_audio_output_channel_t;
 943
 944
 945 /**
 946  * Get the list of available audio outputs
 947  *
 948  * \param p_instance libvlc instance
 949  * \return list of available audio outputs. It must be freed it with
 950 *          \see libvlc_audio_output_list_release \see libvlc_audio_output_t .
 951  *         In case of error, NULL is returned.
 952  */
 953 VLC_PUBLIC_API libvlc_audio_output_t *
 954         libvlc_audio_output_list_get( libvlc_instance_t *p_instance );
 955
 956 /**
 957  * Free the list of available audio outputs
 958  *
 959  * \param p_list list with audio outputs for release
 960  */
 961 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t *p_list );
 962
 963 /**
 964  * Set the audio output.
 965  * Change will be applied after stop and play.
 966  *
 967  * \param p_mi media player
 968  * \param psz_name name of audio output,
 969  *               use psz_name of \see libvlc_audio_output_t
 970  * \return true if function succeded
 971  */
 972 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_media_player_t *p_mi,
 973                                             const char *psz_name );
 974
 975 /**
 976  * Get count of devices for audio output, these devices are hardware oriented
 977  * like analor or digital output of sound card
 978  *
 979  * \param p_instance libvlc instance
 980  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 981  * \return number of devices
 982  */
 983 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *p_instance,
 984                                                      const char *psz_audio_output );
 985
 986 /**
 987  * Get long name of device, if not available short name given
 988  *
 989  * \param p_instance libvlc instance
 990  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 991  * \param i_device device index
 992  * \return long name of device
 993  */
 994 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *p_instance,
 995                                                            const char *psz_audio_output,
 996                                                            int i_device );
 997
 998 /**
 999  * Get id name of device
1000  *
1001  * \param p_instance libvlc instance
1002  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1003  * \param i_device device index
1004  * \return id name of device, use for setting device, need to be free after use
1005  */
1006 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *p_instance,
1007                                                      const char *psz_audio_output,
1008                                                      int i_device );
1009
1010 /**
1011  * Set audio output device. Changes are only effective after stop and play.
1012  *
1013  * \param p_mi media player
1014  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1015  * \param psz_device_id device
1016  */
1017 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_media_player_t *p_mi,
1018                                                     const char *psz_audio_output,
1019                                                     const char *psz_device_id );
1020
1021 /**
1022  * Get current audio device type. Device type describes something like
1023  * character of output sound - stereo sound, 2.1, 5.1 etc
1024  *
1025  * \param p_mi media player
1026  * \return the audio devices type \see libvlc_audio_output_device_types_t
1027  */
1028 VLC_PUBLIC_API int libvlc_audio_output_get_device_type( libvlc_media_player_t *p_mi );
1029
1030 /**
1031  * Set current audio device type.
1032  *
1033  * \param p_mi vlc instance
1034  * \param device_type the audio device type,
1035           according to \see libvlc_audio_output_device_types_t
1036  */
1037 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_media_player_t *p_mi,
1038                                                          int device_type );
1039
1040
1041 /**
1042  * Toggle mute status.
1043  *
1044  * \param p_mi media player
1045  */
1046 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_media_player_t *p_mi );
1047
1048 /**
1049  * Get current mute status.
1050  *
1051  * \param p_mi media player
1052  * \return the mute status (boolean)
1053  */
1054 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_media_player_t *p_mi );
1055
1056 /**
1057  * Set mute status.
1058  *
1059  * \param p_mi media player
1060  * \param status If status is true then mute, otherwise unmute
1061  */
1062 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_media_player_t *p_mi, int status );
1063
1064 /**
1065  * Get current audio level.
1066  *
1067  * \param p_mi media player
1068  * \return the audio level (int)
1069  */
1070 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_media_player_t *p_mi );
1071
1072 /**
1073  * Set current audio level.
1074  *
1075  * \param p_mi media player
1076  * \param i_volume the volume (int)
1077  * \return 0 if the volume was set, -1 if it was out of range
1078  */
1079 VLC_PUBLIC_API int libvlc_audio_set_volume( libvlc_media_player_t *p_mi, int i_volume );
1080
1081 /**
1082  * Get number of available audio tracks.
1083  *
1084  * \param p_mi media player
1085  * \return the number of available audio tracks (int), or -1 if unavailable
1086  */
1087 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *p_mi );
1088
1089 /**
1090  * Get the description of available audio tracks.
1091  *
1092  * \param p_mi media player
1093  * \return list with description of available audio tracks, or NULL
1094  */
1095 VLC_PUBLIC_API libvlc_track_description_t *
1096         libvlc_audio_get_track_description( libvlc_media_player_t *p_mi );
1097
1098 /**
1099  * Get current audio track.
1100  *
1101  * \param p_mi media player
1102  * \return the audio track (int), or -1 if none.
1103  */
1104 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *p_mi );
1105
1106 /**
1107  * Set current audio track.
1108  *
1109  * \param p_mi media player
1110  * \param i_track the track (int)
1111  * \return 0 on success, -1 on error
1112  */
1113 VLC_PUBLIC_API int libvlc_audio_set_track( libvlc_media_player_t *p_mi, int i_track );
1114
1115 /**
1116  * Get current audio channel.
1117  *
1118  * \param p_mi media player
1119  * \return the audio channel \see libvlc_audio_output_channel_t
1120  */
1121 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_media_player_t *p_mi );
1122
1123 /**
1124  * Set current audio channel.
1125  *
1126  * \param p_mi media player
1127  * \param channel the audio channel, \see libvlc_audio_output_channel_t
1128  * \return 0 on success, -1 on error
1129  */
1130 VLC_PUBLIC_API int libvlc_audio_set_channel( libvlc_media_player_t *p_mi, int channel );
1131
1132 /** @} audio */
1133
1134 /** @} media_player */
1135
1136 # ifdef __cplusplus
1137 }
1138 # endif
1139
1140 #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */