]> git.sesse.net Git - vlc/blob - include/vlc/libvlc_media_player.h
libvlc: fix doxygen documentation
[vlc] / 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 \func 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 current video scaling factor.
593  * See also libvlc_video_set_scale().
594  *
595  * \param p_mi 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 *p_mi );
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_mi the media player
610  * \param f_factor the scaling factor, or zero
611  */
612 VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *p_mi, float f_factor );
613
614 /**
615  * Get current video aspect ratio.
616  *
617  * \param p_mi 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 *p_mi );
622
623 /**
624  * Set new video aspect ratio.
625  *
626  * \param p_mi 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 *p_mi, const char *psz_aspect );
631
632 /**
633  * Get current video subtitle.
634  *
635  * \param p_mi 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 *p_mi );
639
640 /**
641  * Get the number of available video subtitles.
642  *
643  * \param p_mi 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 *p_mi );
647
648 /**
649  * Get the description of available video subtitles.
650  *
651  * \param p_mi the media player
652  * \return list containing description of available video subtitles
653  */
654 VLC_PUBLIC_API libvlc_track_description_t *
655         libvlc_video_get_spu_description( libvlc_media_player_t *p_mi );
656
657 /**
658  * Set new video subtitle.
659  *
660  * \param p_mi the media player
661  * \param i_spu new video subtitle to select
662  * \return 0 on success, -1 if out of range
663  */
664 VLC_PUBLIC_API int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu );
665
666 /**
667  * Set new video subtitle file.
668  *
669  * \param p_mi the media player
670  * \param psz_subtitle new video subtitle file
671  * \return the success status (boolean)
672  */
673 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi, const char *psz_subtitle );
674
675 /**
676  * Get the description of available titles.
677  *
678  * \param p_mi the media player
679  * \return list containing description of available titles
680  */
681 VLC_PUBLIC_API libvlc_track_description_t *
682         libvlc_video_get_title_description( libvlc_media_player_t *p_mi );
683
684 /**
685  * Get the description of available chapters for specific title.
686  *
687  * \param p_mi the media player
688  * \param i_title selected title
689  * \return list containing description of available chapter for title i_title
690  */
691 VLC_PUBLIC_API libvlc_track_description_t *
692         libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi, int i_title );
693
694 /**
695  * Get current crop filter geometry.
696  *
697  * \param p_mi the media player
698  * \return the crop filter geometry or NULL if unset
699  */
700 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *p_mi );
701
702 /**
703  * Set new crop filter geometry.
704  *
705  * \param p_mi the media player
706  * \param psz_geometry new crop filter geometry (NULL to unset)
707  */
708 VLC_PUBLIC_API
709 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi, const char *psz_geometry );
710
711 /**
712  * Get current teletext page requested.
713  *
714  * \param p_mi the media player
715  * \return the current teletext page requested.
716  */
717 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *p_mi );
718
719 /**
720  * Set new teletext page to retrieve.
721  *
722  * \param p_mi the media player
723  * \param i_page teletex page number requested
724  */
725 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page );
726
727 /**
728  * Toggle teletext transparent status on video output.
729  *
730  * \param p_mi the media player
731  */
732 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *p_mi );
733
734 /**
735  * Get number of available video tracks.
736  *
737  * \param p_mi media player
738  * \return the number of available video tracks (int)
739  */
740 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *p_mi );
741
742 /**
743  * Get the description of available video tracks.
744  *
745  * \param p_mi media player
746  * \return list with description of available video tracks, or NULL on error
747  */
748 VLC_PUBLIC_API libvlc_track_description_t *
749         libvlc_video_get_track_description( libvlc_media_player_t *p_mi );
750
751 /**
752  * Get current video track.
753  *
754  * \param p_mi media player
755  * \return the video track (int) or -1 if none
756  */
757 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *p_mi );
758
759 /**
760  * Set video track.
761  *
762  * \param p_mi media player
763  * \param i_track the track (int)
764  * \return 0 on success, -1 if out of range
765  */
766 VLC_PUBLIC_API
767 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track );
768
769 /**
770  * Take a snapshot of the current video window.
771  *
772  * If i_width AND i_height is 0, original size is used.
773  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
774  *
775  * \param p_mi media player instance
776  * \param num number of video output (typically 0 for the first/only one)
777  * \param psz_filepath the path where to save the screenshot to
778  * \param i_width the snapshot's width
779  * \param i_height the snapshot's height
780  * \return 0 on success, -1 if the video was not found
781  */
782 VLC_PUBLIC_API
783 int libvlc_video_take_snapshot( libvlc_media_player_t *p_mi, unsigned num,
784                                 const char *psz_filepath, unsigned int i_width,
785                                 unsigned int i_height );
786
787 /**
788  * Enable or disable deinterlace filter
789  *
790  * \param p_mi libvlc media player
791  * \param psz_mode type of deinterlace filter, NULL to disable
792  */
793 VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
794                                                   const char *psz_mode );
795
796 /**
797  * Get an integer marquee option value
798  *
799  * \param p_mi libvlc media player
800  * \param option marq option to get \see libvlc_video_marquee_int_option_t
801  */
802 VLC_PUBLIC_API int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
803                                                  unsigned option );
804
805 /**
806  * Get a string marquee option value
807  *
808  * \param p_mi libvlc media player
809  * \param option marq option to get \see libvlc_video_marquee_string_option_t
810  */
811 VLC_PUBLIC_API char *libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
812                                                       unsigned option );
813
814 /**
815  * Enable, disable or set an integer marquee option
816  *
817  * Setting libvlc_marquee_Enable has the side effect of enabling (arg !0)
818  * or disabling (arg 0) the marq filter.
819  *
820  * \param p_mi libvlc media player
821  * \param option marq option to set \see libvlc_video_marquee_int_option_t
822  * \param i_val marq option value
823  */
824 VLC_PUBLIC_API void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
825                                                   unsigned option, int i_val );
826
827 /**
828  * Set a marquee string option
829  *
830  * \param p_mi libvlc media player
831  * \param option marq option to set \see libvlc_video_marquee_string_option_t
832  * \param psz_text marq option value
833  */
834 VLC_PUBLIC_API void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
835                                                      unsigned option, const char *psz_text );
836
837 /** option values for libvlc_video_{get,set}_logo_{int,string} */
838 enum libvlc_video_logo_option_t {
839     libvlc_logo_enable,
840     libvlc_logo_file,           /**< string argument, "file,d,t;file,d,t;..." */
841     libvlc_logo_x,
842     libvlc_logo_y,
843     libvlc_logo_delay,
844     libvlc_logo_repeat,
845     libvlc_logo_opacity,
846     libvlc_logo_position,
847 };
848
849 /**
850  * Get integer logo option.
851  *
852  * \param p_mi libvlc media player instance
853  * \param option logo option to get, values of libvlc_video_logo_option_t
854  */
855 VLC_PUBLIC_API int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
856                                               unsigned option );
857
858 /**
859  * Set logo option as integer. Options that take a different type value
860  * are ignored.
861  * Passing libvlc_logo_enable as option value has the side effect of
862  * starting (arg !0) or stopping (arg 0) the logo filter.
863  *
864  * \param p_mi libvlc media player instance
865  * \param option logo option to set, values of libvlc_video_logo_option_t
866  * \param value logo option value
867  */
868 VLC_PUBLIC_API void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
869                                                unsigned option, int value );
870
871 /**
872  * Set logo option as string. Options that take a different type value
873  * are ignored.
874  *
875  * \param p_mi libvlc media player instance
876  * \param option logo option to set, values of libvlc_video_logo_option_t
877  * \param psz_value logo option value
878  */
879 VLC_PUBLIC_API void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
880                                       unsigned option, const char *psz_value );
881
882
883 /** @} video */
884
885 /** \defgroup libvlc_audio libvlc_audio
886  * \ingroup libvlc_media_player
887  * LibVLC Audio handling
888  * @{
889  */
890
891 /**
892  * Audio device types
893  */
894 typedef enum libvlc_audio_output_device_types_t {
895     libvlc_AudioOutputDevice_Error  = -1,
896     libvlc_AudioOutputDevice_Mono   =  1,
897     libvlc_AudioOutputDevice_Stereo =  2,
898     libvlc_AudioOutputDevice_2F2R   =  4,
899     libvlc_AudioOutputDevice_3F2R   =  5,
900     libvlc_AudioOutputDevice_5_1    =  6,
901     libvlc_AudioOutputDevice_6_1    =  7,
902     libvlc_AudioOutputDevice_7_1    =  8,
903     libvlc_AudioOutputDevice_SPDIF  = 10
904 } libvlc_audio_output_device_types_t;
905
906 /**
907  * Audio channels
908  */
909 typedef enum libvlc_audio_output_channel_t {
910     libvlc_AudioChannel_Error   = -1,
911     libvlc_AudioChannel_Stereo  =  1,
912     libvlc_AudioChannel_RStereo =  2,
913     libvlc_AudioChannel_Left    =  3,
914     libvlc_AudioChannel_Right   =  4,
915     libvlc_AudioChannel_Dolbys  =  5
916 } libvlc_audio_output_channel_t;
917
918
919 /**
920  * Get the list of available audio outputs
921  *
922  * \param p_instance libvlc instance
923  * \return list of available audio outputs. It must be freed it with
924 *          \see libvlc_audio_output_list_release \see libvlc_audio_output_t .
925  *         In case of error, NULL is returned.
926  */
927 VLC_PUBLIC_API libvlc_audio_output_t *
928         libvlc_audio_output_list_get( libvlc_instance_t *p_instance );
929
930 /**
931  * Free the list of available audio outputs
932  *
933  * \param p_list list with audio outputs for release
934  */
935 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t *p_list );
936
937 /**
938  * Set the audio output.
939  * Change will be applied after stop and play.
940  *
941  * \param p_mi media player
942  * \param psz_name name of audio output,
943  *               use psz_name of \see libvlc_audio_output_t
944  * \return true if function succeded
945  */
946 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_media_player_t *p_mi,
947                                             const char *psz_name );
948
949 /**
950  * Get count of devices for audio output, these devices are hardware oriented
951  * like analor or digital output of sound card
952  *
953  * \param p_instance libvlc instance
954  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
955  * \return number of devices
956  */
957 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *p_instance,
958                                                      const char *psz_audio_output );
959
960 /**
961  * Get long name of device, if not available short name given
962  *
963  * \param p_instance libvlc instance
964  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
965  * \param i_device device index
966  * \return long name of device
967  */
968 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *p_instance,
969                                                            const char *psz_audio_output,
970                                                            int i_device );
971
972 /**
973  * Get id name of device
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 id name of device, use for setting device, need to be free after use
979  */
980 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *p_instance,
981                                                      const char *psz_audio_output,
982                                                      int i_device );
983
984 /**
985  * Set audio output device. Changes are only effective after stop and play.
986  *
987  * \param p_mi media player
988  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
989  * \param psz_device_id device
990  */
991 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_media_player_t *p_mi,
992                                                     const char *psz_audio_output,
993                                                     const char *psz_device_id );
994
995 /**
996  * Get current audio device type. Device type describes something like
997  * character of output sound - stereo sound, 2.1, 5.1 etc
998  *
999  * \param p_mi media player
1000  * \return the audio devices type \see libvlc_audio_output_device_types_t
1001  */
1002 VLC_PUBLIC_API int libvlc_audio_output_get_device_type( libvlc_media_player_t *p_mi );
1003
1004 /**
1005  * Set current audio device type.
1006  *
1007  * \param p_mi vlc instance
1008  * \param device_type the audio device type,
1009           according to \see libvlc_audio_output_device_types_t
1010  */
1011 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_media_player_t *p_mi,
1012                                                          int device_type );
1013
1014
1015 /**
1016  * Toggle mute status.
1017  *
1018  * \param p_mi media player
1019  */
1020 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_media_player_t *p_mi );
1021
1022 /**
1023  * Get current mute status.
1024  *
1025  * \param p_mi media player
1026  * \return the mute status (boolean)
1027  */
1028 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_media_player_t *p_mi );
1029
1030 /**
1031  * Set mute status.
1032  *
1033  * \param p_mi media player
1034  * \param status If status is true then mute, otherwise unmute
1035  */
1036 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_media_player_t *p_mi, int status );
1037
1038 /**
1039  * Get current audio level.
1040  *
1041  * \param p_mi media player
1042  * \return the audio level (int)
1043  */
1044 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_media_player_t *p_mi );
1045
1046 /**
1047  * Set current audio level.
1048  *
1049  * \param p_mi media player
1050  * \param i_volume the volume (int)
1051  * \return 0 if the volume was set, -1 if it was out of range
1052  */
1053 VLC_PUBLIC_API int libvlc_audio_set_volume( libvlc_media_player_t *p_mi, int i_volume );
1054
1055 /**
1056  * Get number of available audio tracks.
1057  *
1058  * \param p_mi media player
1059  * \return the number of available audio tracks (int), or -1 if unavailable
1060  */
1061 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *p_mi );
1062
1063 /**
1064  * Get the description of available audio tracks.
1065  *
1066  * \param p_mi media player
1067  * \return list with description of available audio tracks, or NULL
1068  */
1069 VLC_PUBLIC_API libvlc_track_description_t *
1070         libvlc_audio_get_track_description( libvlc_media_player_t *p_mi );
1071
1072 /**
1073  * Get current audio track.
1074  *
1075  * \param p_mi media player
1076  * \return the audio track (int), or -1 if none.
1077  */
1078 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *p_mi );
1079
1080 /**
1081  * Set current audio track.
1082  *
1083  * \param p_mi media player
1084  * \param i_track the track (int)
1085  * \return 0 on success, -1 on error
1086  */
1087 VLC_PUBLIC_API int libvlc_audio_set_track( libvlc_media_player_t *p_mi, int i_track );
1088
1089 /**
1090  * Get current audio channel.
1091  *
1092  * \param p_mi media player
1093  * \return the audio channel \see libvlc_audio_output_channel_t
1094  */
1095 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_media_player_t *p_mi );
1096
1097 /**
1098  * Set current audio channel.
1099  *
1100  * \param p_mi media player
1101  * \param channel the audio channel, \see libvlc_audio_output_channel_t
1102  * \return 0 on success, -1 on error
1103  */
1104 VLC_PUBLIC_API int libvlc_audio_set_channel( libvlc_media_player_t *p_mi, int channel );
1105
1106 /** @} audio */
1107
1108 /** @} media_player */
1109
1110 # ifdef __cplusplus
1111 }
1112 # endif
1113
1114 #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */