1 /*****************************************************************************
2 * video.c: libvlc new API video functions
3 *****************************************************************************
4 * Copyright (C) 2005-2010 the VideoLAN team
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
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 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 General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, 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" );
160 int libvlc_video_get_size( libvlc_media_player_t *p_mi, unsigned num,
161 unsigned *restrict px, unsigned *restrict py )
164 vout_thread_t *p_vout = GetVout (p_mi, num);
168 *px = p_vout->i_window_height;
169 *py = p_vout->i_window_width;
170 vlc_object_release (p_vout);
177 int libvlc_video_get_height( libvlc_media_player_t *p_mi )
179 unsigned height, width;
181 if (libvlc_video_get_size (p_mi, 0, &height, &width))
186 int libvlc_video_get_width( libvlc_media_player_t *p_mi )
188 unsigned height, width;
190 if (libvlc_video_get_size (p_mi, 0, &height, &width))
195 int libvlc_video_get_cursor( libvlc_media_player_t *mp, unsigned num,
196 int *restrict px, int *restrict py )
198 vout_thread_t *p_vout = GetVout (mp, num);
202 var_GetCoords (p_vout, "mouse-moved", px, py);
203 vlc_object_release (p_vout);
207 unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_mi )
210 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
211 for (size_t i = 0; i < n; i++)
212 vlc_object_release (pp_vouts[i]);
217 float libvlc_video_get_scale( libvlc_media_player_t *mp )
219 float f_scale = var_GetFloat (mp, "scale");
220 if (var_GetBool (mp, "autoscale"))
225 void libvlc_video_set_scale( libvlc_media_player_t *p_mp, float f_scale )
228 var_SetFloat (p_mp, "scale", f_scale);
229 var_SetBool (p_mp, "autoscale", f_scale == 0.);
231 /* Apply to current video outputs (if any) */
233 vout_thread_t **pp_vouts = GetVouts (p_mp, &n);
234 for (size_t i = 0; i < n; i++)
236 vout_thread_t *p_vout = pp_vouts[i];
239 var_SetFloat (p_vout, "scale", f_scale);
240 var_SetBool (p_vout, "autoscale", f_scale == 0.);
241 vlc_object_release (p_vout);
246 char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi )
248 return var_GetNonEmptyString (p_mi, "aspect-ratio");
251 void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi,
252 const char *psz_aspect )
254 if (psz_aspect == NULL)
256 var_SetString (p_mi, "aspect-ratio", psz_aspect);
259 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
260 for (size_t i = 0; i < n; i++)
262 vout_thread_t *p_vout = pp_vouts[i];
264 var_SetString (p_vout, "aspect-ratio", psz_aspect);
265 vlc_object_release (p_vout);
270 int libvlc_video_get_spu( libvlc_media_player_t *p_mi )
272 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
273 vlc_value_t val_list;
279 if( !p_input_thread )
281 libvlc_printerr( "No active input" );
285 i_ret = var_Get( p_input_thread, "spu-es", &val );
288 vlc_object_release( p_input_thread );
289 libvlc_printerr( "Subtitle information not found" );
293 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
294 for( i = 0; i < val_list.p_list->i_count; i++ )
296 if( val.i_int == val_list.p_list->p_values[i].i_int )
302 var_FreeList( &val_list, NULL );
303 vlc_object_release( p_input_thread );
307 int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi )
309 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
312 if( !p_input_thread )
315 i_spu_count = var_CountChoices( p_input_thread, "spu-es" );
316 vlc_object_release( p_input_thread );
320 libvlc_track_description_t *
321 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi )
323 return libvlc_get_track_description( p_mi, "spu-es" );
326 int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu )
328 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
332 if( !p_input_thread )
335 var_Change (p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &list, NULL);
337 if (i_spu > (unsigned)list.p_list->i_count)
339 libvlc_printerr( "Subtitle number out of range (%u/%u)",
340 i_spu, list.p_list->i_count );
344 var_SetInteger (p_input_thread, "spu-es",
345 list.p_list->p_values[i_spu].i_int);
347 vlc_object_release (p_input_thread);
348 var_FreeList (&list, NULL);
352 int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi,
353 const char *psz_subtitle )
355 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi );
360 if( !input_AddSubtitle( p_input_thread, psz_subtitle, true ) )
362 vlc_object_release( p_input_thread );
367 libvlc_track_description_t *
368 libvlc_video_get_title_description( libvlc_media_player_t *p_mi )
370 return libvlc_get_track_description( p_mi, "title" );
373 libvlc_track_description_t *
374 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
378 sprintf( psz_title, "title %2i", i_title );
379 return libvlc_get_track_description( p_mi, psz_title );
382 char *libvlc_video_get_crop_geometry (libvlc_media_player_t *p_mi)
384 return var_GetNonEmptyString (p_mi, "crop");
387 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
388 const char *psz_geometry )
390 if (psz_geometry == NULL)
393 var_SetString (p_mi, "crop", psz_geometry);
396 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
398 for (size_t i = 0; i < n; i++)
400 vout_thread_t *p_vout = pp_vouts[i];
403 /* Make sure the geometry is in the choice list */
404 /* Earlier choices are removed to not grow a long list over time. */
405 /* FIXME: not atomic - lock? */
406 val.psz_string = (char *)psz_geometry;
407 var_Change (p_vout, "crop", VLC_VAR_CLEARCHOICES, NULL, NULL);
408 var_Change (p_vout, "crop", VLC_VAR_ADDCHOICE, &val, &val);
409 var_SetString (p_vout, "crop", psz_geometry);
410 vlc_object_release (p_vout);
415 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi )
417 return var_GetInteger (p_mi, "vbi-page");
420 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page )
422 input_thread_t *p_input_thread;
423 vlc_object_t *p_zvbi = NULL;
426 var_SetInteger (p_mi, "vbi-page", i_page);
428 p_input_thread = libvlc_get_input_thread( p_mi );
429 if( !p_input_thread ) return;
431 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
433 vlc_object_release( p_input_thread );
437 telx = var_GetInteger( p_input_thread, "teletext-es" );
438 if( input_GetEsObjects( p_input_thread, telx, &p_zvbi, NULL, NULL )
441 var_SetInteger( p_zvbi, "vbi-page", i_page );
442 vlc_object_release( p_zvbi );
444 vlc_object_release( p_input_thread );
447 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi )
449 input_thread_t *p_input_thread;
451 p_input_thread = libvlc_get_input_thread(p_mi);
452 if( !p_input_thread ) return;
454 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
456 vlc_object_release( p_input_thread );
459 const bool b_selected = var_GetInteger( p_input_thread, "teletext-es" ) >= 0;
462 var_SetInteger( p_input_thread, "spu-es", -1 );
467 if( !var_Change( p_input_thread, "teletext-es", VLC_VAR_GETLIST, &list, NULL ) )
469 if( list.p_list->i_count > 0 )
470 var_SetInteger( p_input_thread, "spu-es", list.p_list->p_values[0].i_int );
472 var_FreeList( &list, NULL );
475 vlc_object_release( p_input_thread );
478 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi )
480 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
483 if( !p_input_thread )
486 i_track_count = var_CountChoices( p_input_thread, "video-es" );
488 vlc_object_release( p_input_thread );
489 return i_track_count;
492 libvlc_track_description_t *
493 libvlc_video_get_track_description( libvlc_media_player_t *p_mi )
495 return libvlc_get_track_description( p_mi, "video-es" );
498 int libvlc_video_get_track( libvlc_media_player_t *p_mi )
500 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
501 vlc_value_t val_list;
505 if( !p_input_thread )
508 if( var_Get( p_input_thread, "video-es", &val ) < 0 )
510 libvlc_printerr( "Video track information not found" );
511 vlc_object_release( p_input_thread );
515 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
516 for( int i = 0; i < val_list.p_list->i_count; i++ )
518 if( val_list.p_list->p_values[i].i_int == val.i_int )
524 var_FreeList( &val_list, NULL );
525 vlc_object_release( p_input_thread );
529 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track )
531 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
532 vlc_value_t val_list;
535 if( !p_input_thread )
538 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
539 for( int i = 0; i < val_list.p_list->i_count; i++ )
541 if( i_track == val_list.p_list->p_values[i].i_int )
543 if( var_SetInteger( p_input_thread, "video-es", i_track ) < 0 )
549 libvlc_printerr( "Video track number out of range" );
551 var_FreeList( &val_list, NULL );
552 vlc_object_release( p_input_thread );
556 /******************************************************************************
557 * libvlc_video_set_deinterlace : enable deinterlace
558 *****************************************************************************/
559 void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
560 const char *psz_mode )
562 if (psz_mode == NULL)
565 && strcmp (psz_mode, "blend") && strcmp (psz_mode, "bob")
566 && strcmp (psz_mode, "discard") && strcmp (psz_mode, "linear")
567 && strcmp (psz_mode, "mean") && strcmp (psz_mode, "x")
568 && strcmp (psz_mode, "yadif") && strcmp (psz_mode, "yadif2x"))
573 var_SetString (p_mi, "deinterlace-mode", psz_mode);
574 var_SetInteger (p_mi, "deinterlace", 1);
577 var_SetInteger (p_mi, "deinterlace", 0);
580 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
581 for (size_t i = 0; i < n; i++)
583 vout_thread_t *p_vout = pp_vouts[i];
587 var_SetString (p_vout, "deinterlace-mode", psz_mode);
588 var_SetInteger (p_vout, "deinterlace", 1);
591 var_SetInteger (p_vout, "deinterlace", 0);
592 vlc_object_release (p_vout);
602 static vlc_object_t *get_object( libvlc_media_player_t * p_mi,
605 vlc_object_t *object;
606 vout_thread_t *vout = GetVout( p_mi, 0 );
610 object = vlc_object_find_name( vout, name, FIND_CHILD );
611 vlc_object_release(vout);
617 libvlc_printerr( "%s not enabled", name );
622 typedef const struct {
629 set_int( libvlc_media_player_t *p_mi, const char *restrict name,
630 const opt_t *restrict opt, int value )
634 if( !opt->type ) /* the enabler */
636 vout_thread_t *vout = GetVout( p_mi, 0 );
639 vout_EnableFilter( vout, opt->name, value, false );
640 vlc_object_release( vout );
645 if( opt->type != VLC_VAR_INTEGER )
647 libvlc_printerr( "Invalid argument to %s in %s", name, "set int" );
651 var_SetInteger(p_mi, opt->name, value);
652 vlc_object_t *object = get_object( p_mi, name );
655 var_SetInteger(object, opt->name, value);
656 vlc_object_release( object );
662 get_int( libvlc_media_player_t *p_mi, const char *restrict name,
663 const opt_t *restrict opt )
669 case 0: /* the enabler */
671 vlc_object_t *object = get_object( p_mi, name );
672 vlc_object_release( object );
673 return object != NULL;
675 case VLC_VAR_INTEGER:
676 return var_GetInteger(p_mi, opt->name);
678 libvlc_printerr( "Invalid argument to %s in %s", name, "get int" );
685 set_float( libvlc_media_player_t *p_mi, const char *restrict name,
686 const opt_t *restrict opt, float value )
690 if( opt->type != VLC_VAR_FLOAT )
692 libvlc_printerr( "Invalid argument to %s in %s", name, "set float" );
696 var_SetFloat( p_mi, opt->name, value );
698 vlc_object_t *object = get_object( p_mi, name );
701 var_SetFloat(object, opt->name, value );
702 vlc_object_release( object );
708 get_float( libvlc_media_player_t *p_mi, const char *restrict name,
709 const opt_t *restrict opt )
711 if( !opt ) return 0.0;
714 if( opt->type != VLC_VAR_FLOAT )
716 libvlc_printerr( "Invalid argument to %s in %s", name, "get float" );
720 return var_GetFloat( p_mi, opt->name );
725 set_string( libvlc_media_player_t *p_mi, const char *restrict name,
726 const opt_t *restrict opt, const char *restrict psz_value )
730 if( opt->type != VLC_VAR_STRING )
732 libvlc_printerr( "Invalid argument to %s in %s", name, "set string" );
736 var_SetString( p_mi, opt->name, psz_value );
738 vlc_object_t *object = get_object( p_mi, name );
741 var_SetString(object, opt->name, psz_value );
742 vlc_object_release( object );
748 get_string( libvlc_media_player_t *p_mi, const char *restrict name,
749 const opt_t *restrict opt )
751 if( !opt ) return NULL;
753 if( opt->type != VLC_VAR_STRING )
755 libvlc_printerr( "Invalid argument to %s in %s", name, "get string" );
759 return var_GetString( p_mi, opt->name );
764 marq_option_bynumber(unsigned option)
766 static const opt_t optlist[] =
769 { "marq-marquee", VLC_VAR_STRING },
770 { "marq-color", VLC_VAR_INTEGER },
771 { "marq-opacity", VLC_VAR_INTEGER },
772 { "marq-position", VLC_VAR_INTEGER },
773 { "marq-refresh", VLC_VAR_INTEGER },
774 { "marq-size", VLC_VAR_INTEGER },
775 { "marq-timeout", VLC_VAR_INTEGER },
776 { "marq-x", VLC_VAR_INTEGER },
777 { "marq-y", VLC_VAR_INTEGER },
779 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
781 const opt_t *r = option < num_opts ? optlist+option : NULL;
783 libvlc_printerr( "Unknown marquee option" );
787 static vlc_object_t *get_object( libvlc_media_player_t *, const char *);
789 /*****************************************************************************
790 * libvlc_video_get_marquee_int : get a marq option value
791 *****************************************************************************/
792 int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
795 return get_int( p_mi, "marq", marq_option_bynumber(option) );
798 /*****************************************************************************
799 * libvlc_video_get_marquee_string : get a marq option value
800 *****************************************************************************/
801 char * libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
804 return get_string( p_mi, "marq", marq_option_bynumber(option) );
807 /*****************************************************************************
808 * libvlc_video_set_marquee_int: enable, disable or set an int option
809 *****************************************************************************/
810 void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
811 unsigned option, int value )
813 set_int( p_mi, "marq", marq_option_bynumber(option), value );
816 /*****************************************************************************
817 * libvlc_video_set_marquee_string: set a string option
818 *****************************************************************************/
819 void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
820 unsigned option, const char * value )
822 set_string( p_mi, "marq", marq_option_bynumber(option), value );
826 /* logo module support */
830 logo_option_bynumber( unsigned option )
832 static const opt_t vlogo_optlist[] =
833 /* depends on libvlc_video_logo_option_t */
836 { "logo-file", VLC_VAR_STRING },
837 { "logo-x", VLC_VAR_INTEGER },
838 { "logo-y", VLC_VAR_INTEGER },
839 { "logo-delay", VLC_VAR_INTEGER },
840 { "logo-repeat", VLC_VAR_INTEGER },
841 { "logo-opacity", VLC_VAR_INTEGER },
842 { "logo-position", VLC_VAR_INTEGER },
844 enum { num_vlogo_opts = sizeof(vlogo_optlist) / sizeof(*vlogo_optlist) };
846 const opt_t *r = option < num_vlogo_opts ? vlogo_optlist+option : NULL;
848 libvlc_printerr( "Unknown logo option" );
853 void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
854 unsigned option, const char *psz_value )
856 set_string( p_mi,"logo",logo_option_bynumber(option),psz_value );
860 void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
861 unsigned option, int value )
863 set_int( p_mi, "logo", logo_option_bynumber(option), value );
867 int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
870 return get_int( p_mi, "logo", logo_option_bynumber(option) );
874 /* adjust module support */
878 adjust_option_bynumber( unsigned option )
880 static const opt_t optlist[] =
883 { "contrast", VLC_VAR_FLOAT },
884 { "brightness", VLC_VAR_FLOAT },
885 { "hue", VLC_VAR_INTEGER },
886 { "saturation", VLC_VAR_FLOAT },
887 { "gamma", VLC_VAR_FLOAT },
889 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
891 const opt_t *r = option < num_opts ? optlist+option : NULL;
893 libvlc_printerr( "Unknown adjust option" );
898 void libvlc_video_set_adjust_int( libvlc_media_player_t *p_mi,
899 unsigned option, int value )
901 set_int( p_mi, "adjust", adjust_option_bynumber(option), value );
905 int libvlc_video_get_adjust_int( libvlc_media_player_t *p_mi,
908 return get_int( p_mi, "adjust", adjust_option_bynumber(option) );
912 void libvlc_video_set_adjust_float( libvlc_media_player_t *p_mi,
913 unsigned option, float value )
915 set_float( p_mi, "adjust", adjust_option_bynumber(option), value );
919 float libvlc_video_get_adjust_float( libvlc_media_player_t *p_mi,
922 return get_float( p_mi, "adjust", adjust_option_bynumber(option) );