1 /*****************************************************************************
2 * video.c: libvlc new API video functions
3 *****************************************************************************
4 * Copyright (C) 2005-2010 VLC authors and VideoLAN
8 * Authors: Clément Stenac <zorglub@videolan.org>
9 * Filippo Carone <littlejohn@videolan.org>
10 * Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
11 * Damien Fouilleul <damienf a_t videolan dot org>
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU Lesser General Public License as published by
15 * the Free Software Foundation; either version 2.1 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License for more details.
23 * You should have received a copy of the GNU Lesser General Public License
24 * along with this program; if not, write to the Free Software Foundation,
25 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
32 #include <vlc/libvlc.h>
33 #include <vlc/libvlc_media.h>
34 #include <vlc/libvlc_media_player.h>
36 #include <vlc_common.h>
37 #include <vlc_input.h>
40 #include "media_player_internal.h"
44 * Remember to release the returned vout_thread_t.
46 static vout_thread_t **GetVouts( libvlc_media_player_t *p_mi, size_t *n )
48 input_thread_t *p_input = libvlc_get_input_thread( p_mi );
55 vout_thread_t **pp_vouts;
56 if (input_Control( p_input, INPUT_GET_VOUTS, &pp_vouts, n))
61 vlc_object_release (p_input);
65 static vout_thread_t *GetVout (libvlc_media_player_t *mp, size_t num)
67 vout_thread_t *p_vout = NULL;
69 vout_thread_t **pp_vouts = GetVouts (mp, &n);
74 p_vout = pp_vouts[num];
76 for (size_t i = 0; i < n; i++)
78 vlc_object_release (pp_vouts[i]);
83 libvlc_printerr ("Video output not active");
87 /**********************************************************************
89 **********************************************************************/
91 void libvlc_set_fullscreen( libvlc_media_player_t *p_mi, int b_fullscreen )
93 /* This will work even if the video is not currently active */
94 var_SetBool (p_mi, "fullscreen", !!b_fullscreen);
96 /* Apply to current video outputs (if any) */
98 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
99 for (size_t i = 0; i < n; i++)
101 var_SetBool (pp_vouts[i], "fullscreen", b_fullscreen);
102 vlc_object_release (pp_vouts[i]);
107 int libvlc_get_fullscreen( libvlc_media_player_t *p_mi )
109 return var_GetBool (p_mi, "fullscreen");
112 void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi )
114 bool b_fullscreen = var_ToggleBool (p_mi, "fullscreen");
116 /* Apply to current video outputs (if any) */
118 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
119 for (size_t i = 0; i < n; i++)
121 vout_thread_t *p_vout = pp_vouts[i];
123 var_SetBool (p_vout, "fullscreen", b_fullscreen);
124 vlc_object_release (p_vout);
129 void libvlc_video_set_key_input( libvlc_media_player_t *p_mi, unsigned on )
131 var_SetBool (p_mi, "keyboard-events", !!on);
134 void libvlc_video_set_mouse_input( libvlc_media_player_t *p_mi, unsigned on )
136 var_SetBool (p_mi, "mouse-events", !!on);
140 libvlc_video_take_snapshot( libvlc_media_player_t *p_mi, unsigned num,
141 const char *psz_filepath,
142 unsigned int i_width, unsigned int i_height )
144 assert( psz_filepath );
146 vout_thread_t *p_vout = GetVout (p_mi, num);
150 /* FIXME: This is not atomic. Someone else could change the values,
151 * at least in theory. */
152 var_SetInteger( p_vout, "snapshot-width", i_width);
153 var_SetInteger( p_vout, "snapshot-height", i_height );
154 var_SetString( p_vout, "snapshot-path", psz_filepath );
155 var_SetString( p_vout, "snapshot-format", "png" );
156 var_TriggerCallback( p_vout, "video-snapshot" );
157 vlc_object_release( p_vout );
161 int libvlc_video_get_size( libvlc_media_player_t *p_mi, unsigned num,
162 unsigned *restrict px, unsigned *restrict py )
165 vout_thread_t *p_vout = GetVout (p_mi, num);
169 *px = p_vout->i_window_height;
170 *py = p_vout->i_window_width;
171 vlc_object_release (p_vout);
178 int libvlc_video_get_height( libvlc_media_player_t *p_mi )
180 unsigned width, height;
182 if (libvlc_video_get_size (p_mi, 0, &width, &height))
187 int libvlc_video_get_width( libvlc_media_player_t *p_mi )
189 unsigned width, height;
191 if (libvlc_video_get_size (p_mi, 0, &width, &height))
196 int libvlc_video_get_cursor( libvlc_media_player_t *mp, unsigned num,
197 int *restrict px, int *restrict py )
199 vout_thread_t *p_vout = GetVout (mp, num);
203 var_GetCoords (p_vout, "mouse-moved", px, py);
204 vlc_object_release (p_vout);
208 unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_mi )
211 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
212 for (size_t i = 0; i < n; i++)
213 vlc_object_release (pp_vouts[i]);
218 float libvlc_video_get_scale( libvlc_media_player_t *mp )
220 float f_scale = var_GetFloat (mp, "scale");
221 if (var_GetBool (mp, "autoscale"))
226 void libvlc_video_set_scale( libvlc_media_player_t *p_mp, float f_scale )
229 var_SetFloat (p_mp, "scale", f_scale);
230 var_SetBool (p_mp, "autoscale", f_scale == 0.);
232 /* Apply to current video outputs (if any) */
234 vout_thread_t **pp_vouts = GetVouts (p_mp, &n);
235 for (size_t i = 0; i < n; i++)
237 vout_thread_t *p_vout = pp_vouts[i];
240 var_SetFloat (p_vout, "scale", f_scale);
241 var_SetBool (p_vout, "autoscale", f_scale == 0.);
242 vlc_object_release (p_vout);
247 char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi )
249 return var_GetNonEmptyString (p_mi, "aspect-ratio");
252 void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi,
253 const char *psz_aspect )
255 if (psz_aspect == NULL)
257 var_SetString (p_mi, "aspect-ratio", psz_aspect);
260 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
261 for (size_t i = 0; i < n; i++)
263 vout_thread_t *p_vout = pp_vouts[i];
265 var_SetString (p_vout, "aspect-ratio", psz_aspect);
266 vlc_object_release (p_vout);
271 int libvlc_video_get_spu( libvlc_media_player_t *p_mi )
273 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
274 vlc_value_t val_list;
280 if( !p_input_thread )
282 libvlc_printerr( "No active input" );
286 i_ret = var_Get( p_input_thread, "spu-es", &val );
289 vlc_object_release( p_input_thread );
290 libvlc_printerr( "Subtitle information not found" );
294 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
295 for( i = 0; i < val_list.p_list->i_count; i++ )
297 if( val.i_int == val_list.p_list->p_values[i].i_int )
303 var_FreeList( &val_list, NULL );
304 vlc_object_release( p_input_thread );
308 int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi )
310 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
313 if( !p_input_thread )
316 i_spu_count = var_CountChoices( p_input_thread, "spu-es" );
317 vlc_object_release( p_input_thread );
321 libvlc_track_description_t *
322 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi )
324 return libvlc_get_track_description( p_mi, "spu-es" );
327 int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu )
329 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
333 if( !p_input_thread )
336 var_Change (p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &list, NULL);
338 if (i_spu > (unsigned)list.p_list->i_count)
340 libvlc_printerr( "Subtitle number out of range (%u/%u)",
341 i_spu, list.p_list->i_count );
345 var_SetInteger (p_input_thread, "spu-es",
346 list.p_list->p_values[i_spu].i_int);
348 vlc_object_release (p_input_thread);
349 var_FreeList (&list, NULL);
353 int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi,
354 const char *psz_subtitle )
356 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi );
361 if( !input_AddSubtitle( p_input_thread, psz_subtitle, true ) )
363 vlc_object_release( p_input_thread );
368 int64_t libvlc_video_get_spu_delay( libvlc_media_player_t *p_mi )
370 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
375 val = var_GetTime( p_input_thread, "spu-delay" );
376 vlc_object_release( p_input_thread );
380 libvlc_printerr( "No active input" );
386 int libvlc_video_set_spu_delay( libvlc_media_player_t *p_mi,
389 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
394 var_SetTime( p_input_thread, "spu-delay", i_delay );
395 vlc_object_release( p_input_thread );
400 libvlc_printerr( "No active input" );
406 libvlc_track_description_t *
407 libvlc_video_get_title_description( libvlc_media_player_t *p_mi )
409 return libvlc_get_track_description( p_mi, "title" );
412 libvlc_track_description_t *
413 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
417 sprintf( psz_title, "title %2i", i_title );
418 return libvlc_get_track_description( p_mi, psz_title );
421 char *libvlc_video_get_crop_geometry (libvlc_media_player_t *p_mi)
423 return var_GetNonEmptyString (p_mi, "crop");
426 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
427 const char *psz_geometry )
429 if (psz_geometry == NULL)
432 var_SetString (p_mi, "crop", psz_geometry);
435 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
437 for (size_t i = 0; i < n; i++)
439 vout_thread_t *p_vout = pp_vouts[i];
442 /* Make sure the geometry is in the choice list */
443 /* Earlier choices are removed to not grow a long list over time. */
444 /* FIXME: not atomic - lock? */
445 val.psz_string = (char *)psz_geometry;
446 var_Change (p_vout, "crop", VLC_VAR_CLEARCHOICES, NULL, NULL);
447 var_Change (p_vout, "crop", VLC_VAR_ADDCHOICE, &val, &val);
448 var_SetString (p_vout, "crop", psz_geometry);
449 vlc_object_release (p_vout);
454 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi )
456 return var_GetInteger (p_mi, "vbi-page");
459 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page )
461 input_thread_t *p_input_thread;
462 vlc_object_t *p_zvbi = NULL;
465 var_SetInteger (p_mi, "vbi-page", i_page);
467 p_input_thread = libvlc_get_input_thread( p_mi );
468 if( !p_input_thread ) return;
470 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
472 vlc_object_release( p_input_thread );
476 telx = var_GetInteger( p_input_thread, "teletext-es" );
477 if( input_GetEsObjects( p_input_thread, telx, &p_zvbi, NULL, NULL )
480 var_SetInteger( p_zvbi, "vbi-page", i_page );
481 vlc_object_release( p_zvbi );
483 vlc_object_release( p_input_thread );
486 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi )
488 input_thread_t *p_input_thread;
490 p_input_thread = libvlc_get_input_thread(p_mi);
491 if( !p_input_thread ) return;
493 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
495 vlc_object_release( p_input_thread );
498 const bool b_selected = var_GetInteger( p_input_thread, "teletext-es" ) >= 0;
501 var_SetInteger( p_input_thread, "spu-es", -1 );
506 if( !var_Change( p_input_thread, "teletext-es", VLC_VAR_GETLIST, &list, NULL ) )
508 if( list.p_list->i_count > 0 )
509 var_SetInteger( p_input_thread, "spu-es", list.p_list->p_values[0].i_int );
511 var_FreeList( &list, NULL );
514 vlc_object_release( p_input_thread );
517 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi )
519 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
522 if( !p_input_thread )
525 i_track_count = var_CountChoices( p_input_thread, "video-es" );
527 vlc_object_release( p_input_thread );
528 return i_track_count;
531 libvlc_track_description_t *
532 libvlc_video_get_track_description( libvlc_media_player_t *p_mi )
534 return libvlc_get_track_description( p_mi, "video-es" );
537 int libvlc_video_get_track( libvlc_media_player_t *p_mi )
539 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
540 vlc_value_t val_list;
544 if( !p_input_thread )
547 if( var_Get( p_input_thread, "video-es", &val ) < 0 )
549 libvlc_printerr( "Video track information not found" );
550 vlc_object_release( p_input_thread );
554 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
555 for( int i = 0; i < val_list.p_list->i_count; i++ )
557 if( val_list.p_list->p_values[i].i_int == val.i_int )
563 var_FreeList( &val_list, NULL );
564 vlc_object_release( p_input_thread );
568 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track )
570 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
571 vlc_value_t val_list;
574 if( !p_input_thread )
577 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
578 for( int i = 0; i < val_list.p_list->i_count; i++ )
580 if( i_track == val_list.p_list->p_values[i].i_int )
582 if( var_SetInteger( p_input_thread, "video-es", i_track ) < 0 )
588 libvlc_printerr( "Video track number out of range" );
590 var_FreeList( &val_list, NULL );
591 vlc_object_release( p_input_thread );
595 /******************************************************************************
596 * libvlc_video_set_deinterlace : enable deinterlace
597 *****************************************************************************/
598 void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
599 const char *psz_mode )
601 if (psz_mode == NULL)
604 && strcmp (psz_mode, "blend") && strcmp (psz_mode, "bob")
605 && strcmp (psz_mode, "discard") && strcmp (psz_mode, "linear")
606 && strcmp (psz_mode, "mean") && strcmp (psz_mode, "x")
607 && strcmp (psz_mode, "yadif") && strcmp (psz_mode, "yadif2x")
608 && strcmp (psz_mode, "phosphor") && strcmp (psz_mode, "ivtc"))
613 var_SetString (p_mi, "deinterlace-mode", psz_mode);
614 var_SetInteger (p_mi, "deinterlace", 1);
617 var_SetInteger (p_mi, "deinterlace", 0);
620 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
621 for (size_t i = 0; i < n; i++)
623 vout_thread_t *p_vout = pp_vouts[i];
627 var_SetString (p_vout, "deinterlace-mode", psz_mode);
628 var_SetInteger (p_vout, "deinterlace", 1);
631 var_SetInteger (p_vout, "deinterlace", 0);
632 vlc_object_release (p_vout);
642 static vlc_object_t *get_object( libvlc_media_player_t * p_mi,
645 vlc_object_t *object;
646 vout_thread_t *vout = GetVout( p_mi, 0 );
650 object = vlc_object_find_name( vout, name );
651 vlc_object_release(vout);
657 libvlc_printerr( "%s not enabled", name );
662 typedef const struct {
669 set_int( libvlc_media_player_t *p_mi, const char *restrict name,
670 const opt_t *restrict opt, int value )
674 if( !opt->type ) /* the enabler */
676 vout_thread_t *vout = GetVout( p_mi, 0 );
679 vout_EnableFilter( vout, opt->name, value, false );
680 vlc_object_release( vout );
685 if( opt->type != VLC_VAR_INTEGER )
687 libvlc_printerr( "Invalid argument to %s in %s", name, "set int" );
691 var_SetInteger(p_mi, opt->name, value);
692 vlc_object_t *object = get_object( p_mi, name );
695 var_SetInteger(object, opt->name, value);
696 vlc_object_release( object );
702 get_int( libvlc_media_player_t *p_mi, const char *restrict name,
703 const opt_t *restrict opt )
709 case 0: /* the enabler */
711 vlc_object_t *object = get_object( p_mi, name );
712 vlc_object_release( object );
713 return object != NULL;
715 case VLC_VAR_INTEGER:
716 return var_GetInteger(p_mi, opt->name);
718 libvlc_printerr( "Invalid argument to %s in %s", name, "get int" );
725 set_float( libvlc_media_player_t *p_mi, const char *restrict name,
726 const opt_t *restrict opt, float value )
730 if( opt->type != VLC_VAR_FLOAT )
732 libvlc_printerr( "Invalid argument to %s in %s", name, "set float" );
736 var_SetFloat( p_mi, opt->name, value );
738 vlc_object_t *object = get_object( p_mi, name );
741 var_SetFloat(object, opt->name, value );
742 vlc_object_release( object );
748 get_float( libvlc_media_player_t *p_mi, const char *restrict name,
749 const opt_t *restrict opt )
751 if( !opt ) return 0.0;
754 if( opt->type != VLC_VAR_FLOAT )
756 libvlc_printerr( "Invalid argument to %s in %s", name, "get float" );
760 return var_GetFloat( p_mi, opt->name );
765 set_string( libvlc_media_player_t *p_mi, const char *restrict name,
766 const opt_t *restrict opt, const char *restrict psz_value )
770 if( opt->type != VLC_VAR_STRING )
772 libvlc_printerr( "Invalid argument to %s in %s", name, "set string" );
776 var_SetString( p_mi, opt->name, psz_value );
778 vlc_object_t *object = get_object( p_mi, name );
781 var_SetString(object, opt->name, psz_value );
782 vlc_object_release( object );
788 get_string( libvlc_media_player_t *p_mi, const char *restrict name,
789 const opt_t *restrict opt )
791 if( !opt ) return NULL;
793 if( opt->type != VLC_VAR_STRING )
795 libvlc_printerr( "Invalid argument to %s in %s", name, "get string" );
799 return var_GetString( p_mi, opt->name );
804 marq_option_bynumber(unsigned option)
806 static const opt_t optlist[] =
809 { "marq-marquee", VLC_VAR_STRING },
810 { "marq-color", VLC_VAR_INTEGER },
811 { "marq-opacity", VLC_VAR_INTEGER },
812 { "marq-position", VLC_VAR_INTEGER },
813 { "marq-refresh", VLC_VAR_INTEGER },
814 { "marq-size", VLC_VAR_INTEGER },
815 { "marq-timeout", VLC_VAR_INTEGER },
816 { "marq-x", VLC_VAR_INTEGER },
817 { "marq-y", VLC_VAR_INTEGER },
819 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
821 const opt_t *r = option < num_opts ? optlist+option : NULL;
823 libvlc_printerr( "Unknown marquee option" );
827 static vlc_object_t *get_object( libvlc_media_player_t *, const char *);
829 /*****************************************************************************
830 * libvlc_video_get_marquee_int : get a marq option value
831 *****************************************************************************/
832 int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
835 return get_int( p_mi, "marq", marq_option_bynumber(option) );
838 /*****************************************************************************
839 * libvlc_video_get_marquee_string : get a marq option value
840 *****************************************************************************/
841 char * libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
844 return get_string( p_mi, "marq", marq_option_bynumber(option) );
847 /*****************************************************************************
848 * libvlc_video_set_marquee_int: enable, disable or set an int option
849 *****************************************************************************/
850 void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
851 unsigned option, int value )
853 set_int( p_mi, "marq", marq_option_bynumber(option), value );
856 /*****************************************************************************
857 * libvlc_video_set_marquee_string: set a string option
858 *****************************************************************************/
859 void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
860 unsigned option, const char * value )
862 set_string( p_mi, "marq", marq_option_bynumber(option), value );
866 /* logo module support */
870 logo_option_bynumber( unsigned option )
872 static const opt_t vlogo_optlist[] =
873 /* depends on libvlc_video_logo_option_t */
876 { "logo-file", VLC_VAR_STRING },
877 { "logo-x", VLC_VAR_INTEGER },
878 { "logo-y", VLC_VAR_INTEGER },
879 { "logo-delay", VLC_VAR_INTEGER },
880 { "logo-repeat", VLC_VAR_INTEGER },
881 { "logo-opacity", VLC_VAR_INTEGER },
882 { "logo-position", VLC_VAR_INTEGER },
884 enum { num_vlogo_opts = sizeof(vlogo_optlist) / sizeof(*vlogo_optlist) };
886 const opt_t *r = option < num_vlogo_opts ? vlogo_optlist+option : NULL;
888 libvlc_printerr( "Unknown logo option" );
893 void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
894 unsigned option, const char *psz_value )
896 set_string( p_mi,"logo",logo_option_bynumber(option),psz_value );
900 void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
901 unsigned option, int value )
903 set_int( p_mi, "logo", logo_option_bynumber(option), value );
907 int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
910 return get_int( p_mi, "logo", logo_option_bynumber(option) );
914 /* adjust module support */
918 adjust_option_bynumber( unsigned option )
920 static const opt_t optlist[] =
923 { "contrast", VLC_VAR_FLOAT },
924 { "brightness", VLC_VAR_FLOAT },
925 { "hue", VLC_VAR_INTEGER },
926 { "saturation", VLC_VAR_FLOAT },
927 { "gamma", VLC_VAR_FLOAT },
929 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
931 const opt_t *r = option < num_opts ? optlist+option : NULL;
933 libvlc_printerr( "Unknown adjust option" );
938 void libvlc_video_set_adjust_int( libvlc_media_player_t *p_mi,
939 unsigned option, int value )
941 set_int( p_mi, "adjust", adjust_option_bynumber(option), value );
945 int libvlc_video_get_adjust_int( libvlc_media_player_t *p_mi,
948 return get_int( p_mi, "adjust", adjust_option_bynumber(option) );
952 void libvlc_video_set_adjust_float( libvlc_media_player_t *p_mi,
953 unsigned option, float value )
955 set_float( p_mi, "adjust", adjust_option_bynumber(option), value );
959 float libvlc_video_get_adjust_float( libvlc_media_player_t *p_mi,
962 return get_float( p_mi, "adjust", adjust_option_bynumber(option) );