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 )
164 libvlc_media_track_info_t *info;
166 int infos = libvlc_media_get_tracks_info(p_mi->p_md, &info);
170 for (int i = 0; i < infos; i++)
171 if (info[i].i_type == libvlc_track_video && num-- == 0) {
172 *px = info[i].u.video.i_width;
173 *py = info[i].u.video.i_height;
182 int libvlc_video_get_height( libvlc_media_player_t *p_mi )
184 unsigned width, height;
186 if (libvlc_video_get_size (p_mi, 0, &width, &height))
191 int libvlc_video_get_width( libvlc_media_player_t *p_mi )
193 unsigned width, height;
195 if (libvlc_video_get_size (p_mi, 0, &width, &height))
200 int libvlc_video_get_cursor( libvlc_media_player_t *mp, unsigned num,
201 int *restrict px, int *restrict py )
203 vout_thread_t *p_vout = GetVout (mp, num);
207 var_GetCoords (p_vout, "mouse-moved", px, py);
208 vlc_object_release (p_vout);
212 unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_mi )
215 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
216 for (size_t i = 0; i < n; i++)
217 vlc_object_release (pp_vouts[i]);
222 float libvlc_video_get_scale( libvlc_media_player_t *mp )
224 float f_scale = var_GetFloat (mp, "scale");
225 if (var_GetBool (mp, "autoscale"))
230 void libvlc_video_set_scale( libvlc_media_player_t *p_mp, float f_scale )
233 var_SetFloat (p_mp, "scale", f_scale);
234 var_SetBool (p_mp, "autoscale", f_scale == 0.);
236 /* Apply to current video outputs (if any) */
238 vout_thread_t **pp_vouts = GetVouts (p_mp, &n);
239 for (size_t i = 0; i < n; i++)
241 vout_thread_t *p_vout = pp_vouts[i];
244 var_SetFloat (p_vout, "scale", f_scale);
245 var_SetBool (p_vout, "autoscale", f_scale == 0.);
246 vlc_object_release (p_vout);
251 char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi )
253 return var_GetNonEmptyString (p_mi, "aspect-ratio");
256 void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi,
257 const char *psz_aspect )
259 if (psz_aspect == NULL)
261 var_SetString (p_mi, "aspect-ratio", psz_aspect);
264 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
265 for (size_t i = 0; i < n; i++)
267 vout_thread_t *p_vout = pp_vouts[i];
269 var_SetString (p_vout, "aspect-ratio", psz_aspect);
270 vlc_object_release (p_vout);
275 int libvlc_video_get_spu( libvlc_media_player_t *p_mi )
277 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
278 vlc_value_t val_list;
284 if( !p_input_thread )
286 libvlc_printerr( "No active input" );
290 i_ret = var_Get( p_input_thread, "spu-es", &val );
293 vlc_object_release( p_input_thread );
294 libvlc_printerr( "Subtitle information not found" );
298 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
299 for( i = 0; i < val_list.p_list->i_count; i++ )
301 if( val.i_int == val_list.p_list->p_values[i].i_int )
307 var_FreeList( &val_list, NULL );
308 vlc_object_release( p_input_thread );
312 int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi )
314 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
317 if( !p_input_thread )
320 i_spu_count = var_CountChoices( p_input_thread, "spu-es" );
321 vlc_object_release( p_input_thread );
325 libvlc_track_description_t *
326 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi )
328 return libvlc_get_track_description( p_mi, "spu-es" );
331 int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu )
333 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
337 if( !p_input_thread )
340 var_Change (p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &list, NULL);
342 if (i_spu > (unsigned)list.p_list->i_count)
344 libvlc_printerr( "Subtitle number out of range (%u/%u)",
345 i_spu, list.p_list->i_count );
349 var_SetInteger (p_input_thread, "spu-es",
350 list.p_list->p_values[i_spu].i_int);
352 vlc_object_release (p_input_thread);
353 var_FreeList (&list, NULL);
357 int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi,
358 const char *psz_subtitle )
360 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi );
365 if( !input_AddSubtitle( p_input_thread, psz_subtitle, true ) )
367 vlc_object_release( p_input_thread );
372 int64_t libvlc_video_get_spu_delay( libvlc_media_player_t *p_mi )
374 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
379 val = var_GetTime( p_input_thread, "spu-delay" );
380 vlc_object_release( p_input_thread );
384 libvlc_printerr( "No active input" );
390 int libvlc_video_set_spu_delay( libvlc_media_player_t *p_mi,
393 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
398 var_SetTime( p_input_thread, "spu-delay", i_delay );
399 vlc_object_release( p_input_thread );
404 libvlc_printerr( "No active input" );
410 libvlc_track_description_t *
411 libvlc_video_get_title_description( libvlc_media_player_t *p_mi )
413 return libvlc_get_track_description( p_mi, "title" );
416 libvlc_track_description_t *
417 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
421 sprintf( psz_title, "title %2i", i_title );
422 return libvlc_get_track_description( p_mi, psz_title );
425 char *libvlc_video_get_crop_geometry (libvlc_media_player_t *p_mi)
427 return var_GetNonEmptyString (p_mi, "crop");
430 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
431 const char *psz_geometry )
433 if (psz_geometry == NULL)
436 var_SetString (p_mi, "crop", psz_geometry);
439 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
441 for (size_t i = 0; i < n; i++)
443 vout_thread_t *p_vout = pp_vouts[i];
446 /* Make sure the geometry is in the choice list */
447 /* Earlier choices are removed to not grow a long list over time. */
448 /* FIXME: not atomic - lock? */
449 val.psz_string = (char *)psz_geometry;
450 var_Change (p_vout, "crop", VLC_VAR_CLEARCHOICES, NULL, NULL);
451 var_Change (p_vout, "crop", VLC_VAR_ADDCHOICE, &val, &val);
452 var_SetString (p_vout, "crop", psz_geometry);
453 vlc_object_release (p_vout);
458 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi )
460 return var_GetInteger (p_mi, "vbi-page");
463 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page )
465 input_thread_t *p_input_thread;
466 vlc_object_t *p_zvbi = NULL;
469 var_SetInteger (p_mi, "vbi-page", i_page);
471 p_input_thread = libvlc_get_input_thread( p_mi );
472 if( !p_input_thread ) return;
474 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
476 vlc_object_release( p_input_thread );
480 telx = var_GetInteger( p_input_thread, "teletext-es" );
481 if( input_GetEsObjects( p_input_thread, telx, &p_zvbi, NULL, NULL )
484 var_SetInteger( p_zvbi, "vbi-page", i_page );
485 vlc_object_release( p_zvbi );
487 vlc_object_release( p_input_thread );
490 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi )
492 input_thread_t *p_input_thread;
494 p_input_thread = libvlc_get_input_thread(p_mi);
495 if( !p_input_thread ) return;
497 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
499 vlc_object_release( p_input_thread );
502 const bool b_selected = var_GetInteger( p_input_thread, "teletext-es" ) >= 0;
505 var_SetInteger( p_input_thread, "spu-es", -1 );
510 if( !var_Change( p_input_thread, "teletext-es", VLC_VAR_GETLIST, &list, NULL ) )
512 if( list.p_list->i_count > 0 )
513 var_SetInteger( p_input_thread, "spu-es", list.p_list->p_values[0].i_int );
515 var_FreeList( &list, NULL );
518 vlc_object_release( p_input_thread );
521 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi )
523 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
526 if( !p_input_thread )
529 i_track_count = var_CountChoices( p_input_thread, "video-es" );
531 vlc_object_release( p_input_thread );
532 return i_track_count;
535 libvlc_track_description_t *
536 libvlc_video_get_track_description( libvlc_media_player_t *p_mi )
538 return libvlc_get_track_description( p_mi, "video-es" );
541 int libvlc_video_get_track( libvlc_media_player_t *p_mi )
543 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
544 vlc_value_t val_list;
548 if( !p_input_thread )
551 if( var_Get( p_input_thread, "video-es", &val ) < 0 )
553 libvlc_printerr( "Video track information not found" );
554 vlc_object_release( p_input_thread );
558 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
559 for( int i = 0; i < val_list.p_list->i_count; i++ )
561 if( val_list.p_list->p_values[i].i_int == val.i_int )
567 var_FreeList( &val_list, NULL );
568 vlc_object_release( p_input_thread );
572 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track )
574 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
575 vlc_value_t val_list;
578 if( !p_input_thread )
581 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
582 for( int i = 0; i < val_list.p_list->i_count; i++ )
584 if( i_track == val_list.p_list->p_values[i].i_int )
586 if( var_SetInteger( p_input_thread, "video-es", i_track ) < 0 )
592 libvlc_printerr( "Video track number out of range" );
594 var_FreeList( &val_list, NULL );
595 vlc_object_release( p_input_thread );
599 /******************************************************************************
600 * libvlc_video_set_deinterlace : enable deinterlace
601 *****************************************************************************/
602 void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
603 const char *psz_mode )
605 if (psz_mode == NULL)
608 && strcmp (psz_mode, "blend") && strcmp (psz_mode, "bob")
609 && strcmp (psz_mode, "discard") && strcmp (psz_mode, "linear")
610 && strcmp (psz_mode, "mean") && strcmp (psz_mode, "x")
611 && strcmp (psz_mode, "yadif") && strcmp (psz_mode, "yadif2x")
612 && strcmp (psz_mode, "phosphor") && strcmp (psz_mode, "ivtc"))
617 var_SetString (p_mi, "deinterlace-mode", psz_mode);
618 var_SetInteger (p_mi, "deinterlace", 1);
621 var_SetInteger (p_mi, "deinterlace", 0);
624 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
625 for (size_t i = 0; i < n; i++)
627 vout_thread_t *p_vout = pp_vouts[i];
631 var_SetString (p_vout, "deinterlace-mode", psz_mode);
632 var_SetInteger (p_vout, "deinterlace", 1);
635 var_SetInteger (p_vout, "deinterlace", 0);
636 vlc_object_release (p_vout);
646 static vlc_object_t *get_object( libvlc_media_player_t * p_mi,
649 vlc_object_t *object;
650 vout_thread_t *vout = GetVout( p_mi, 0 );
654 object = vlc_object_find_name( vout, name );
655 vlc_object_release(vout);
661 libvlc_printerr( "%s not enabled", name );
666 typedef const struct {
673 set_int( libvlc_media_player_t *p_mi, const char *restrict name,
674 const opt_t *restrict opt, int value )
678 if( !opt->type ) /* the enabler */
680 vout_thread_t *vout = GetVout( p_mi, 0 );
683 vout_EnableFilter( vout, opt->name, value, false );
684 vlc_object_release( vout );
689 if( opt->type != VLC_VAR_INTEGER )
691 libvlc_printerr( "Invalid argument to %s in %s", name, "set int" );
695 var_SetInteger(p_mi, opt->name, value);
696 vlc_object_t *object = get_object( p_mi, name );
699 var_SetInteger(object, opt->name, value);
700 vlc_object_release( object );
706 get_int( libvlc_media_player_t *p_mi, const char *restrict name,
707 const opt_t *restrict opt )
713 case 0: /* the enabler */
715 vlc_object_t *object = get_object( p_mi, name );
716 vlc_object_release( object );
717 return object != NULL;
719 case VLC_VAR_INTEGER:
720 return var_GetInteger(p_mi, opt->name);
722 libvlc_printerr( "Invalid argument to %s in %s", name, "get int" );
729 set_float( libvlc_media_player_t *p_mi, const char *restrict name,
730 const opt_t *restrict opt, float value )
734 if( opt->type != VLC_VAR_FLOAT )
736 libvlc_printerr( "Invalid argument to %s in %s", name, "set float" );
740 var_SetFloat( p_mi, opt->name, value );
742 vlc_object_t *object = get_object( p_mi, name );
745 var_SetFloat(object, opt->name, value );
746 vlc_object_release( object );
752 get_float( libvlc_media_player_t *p_mi, const char *restrict name,
753 const opt_t *restrict opt )
755 if( !opt ) return 0.0;
758 if( opt->type != VLC_VAR_FLOAT )
760 libvlc_printerr( "Invalid argument to %s in %s", name, "get float" );
764 return var_GetFloat( p_mi, opt->name );
769 set_string( libvlc_media_player_t *p_mi, const char *restrict name,
770 const opt_t *restrict opt, const char *restrict psz_value )
774 if( opt->type != VLC_VAR_STRING )
776 libvlc_printerr( "Invalid argument to %s in %s", name, "set string" );
780 var_SetString( p_mi, opt->name, psz_value );
782 vlc_object_t *object = get_object( p_mi, name );
785 var_SetString(object, opt->name, psz_value );
786 vlc_object_release( object );
792 get_string( libvlc_media_player_t *p_mi, const char *restrict name,
793 const opt_t *restrict opt )
795 if( !opt ) return NULL;
797 if( opt->type != VLC_VAR_STRING )
799 libvlc_printerr( "Invalid argument to %s in %s", name, "get string" );
803 return var_GetString( p_mi, opt->name );
808 marq_option_bynumber(unsigned option)
810 static const opt_t optlist[] =
813 { "marq-marquee", VLC_VAR_STRING },
814 { "marq-color", VLC_VAR_INTEGER },
815 { "marq-opacity", VLC_VAR_INTEGER },
816 { "marq-position", VLC_VAR_INTEGER },
817 { "marq-refresh", VLC_VAR_INTEGER },
818 { "marq-size", VLC_VAR_INTEGER },
819 { "marq-timeout", VLC_VAR_INTEGER },
820 { "marq-x", VLC_VAR_INTEGER },
821 { "marq-y", VLC_VAR_INTEGER },
823 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
825 const opt_t *r = option < num_opts ? optlist+option : NULL;
827 libvlc_printerr( "Unknown marquee option" );
831 static vlc_object_t *get_object( libvlc_media_player_t *, const char *);
833 /*****************************************************************************
834 * libvlc_video_get_marquee_int : get a marq option value
835 *****************************************************************************/
836 int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
839 return get_int( p_mi, "marq", marq_option_bynumber(option) );
842 /*****************************************************************************
843 * libvlc_video_get_marquee_string : get a marq option value
844 *****************************************************************************/
845 char * libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
848 return get_string( p_mi, "marq", marq_option_bynumber(option) );
851 /*****************************************************************************
852 * libvlc_video_set_marquee_int: enable, disable or set an int option
853 *****************************************************************************/
854 void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
855 unsigned option, int value )
857 set_int( p_mi, "marq", marq_option_bynumber(option), value );
860 /*****************************************************************************
861 * libvlc_video_set_marquee_string: set a string option
862 *****************************************************************************/
863 void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
864 unsigned option, const char * value )
866 set_string( p_mi, "marq", marq_option_bynumber(option), value );
870 /* logo module support */
874 logo_option_bynumber( unsigned option )
876 static const opt_t vlogo_optlist[] =
877 /* depends on libvlc_video_logo_option_t */
880 { "logo-file", VLC_VAR_STRING },
881 { "logo-x", VLC_VAR_INTEGER },
882 { "logo-y", VLC_VAR_INTEGER },
883 { "logo-delay", VLC_VAR_INTEGER },
884 { "logo-repeat", VLC_VAR_INTEGER },
885 { "logo-opacity", VLC_VAR_INTEGER },
886 { "logo-position", VLC_VAR_INTEGER },
888 enum { num_vlogo_opts = sizeof(vlogo_optlist) / sizeof(*vlogo_optlist) };
890 const opt_t *r = option < num_vlogo_opts ? vlogo_optlist+option : NULL;
892 libvlc_printerr( "Unknown logo option" );
897 void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
898 unsigned option, const char *psz_value )
900 set_string( p_mi,"logo",logo_option_bynumber(option),psz_value );
904 void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
905 unsigned option, int value )
907 set_int( p_mi, "logo", logo_option_bynumber(option), value );
911 int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
914 return get_int( p_mi, "logo", logo_option_bynumber(option) );
918 /* adjust module support */
922 adjust_option_bynumber( unsigned option )
924 static const opt_t optlist[] =
927 { "contrast", VLC_VAR_FLOAT },
928 { "brightness", VLC_VAR_FLOAT },
929 { "hue", VLC_VAR_INTEGER },
930 { "saturation", VLC_VAR_FLOAT },
931 { "gamma", VLC_VAR_FLOAT },
933 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
935 const opt_t *r = option < num_opts ? optlist+option : NULL;
937 libvlc_printerr( "Unknown adjust option" );
942 void libvlc_video_set_adjust_int( libvlc_media_player_t *p_mi,
943 unsigned option, int value )
945 set_int( p_mi, "adjust", adjust_option_bynumber(option), value );
949 int libvlc_video_get_adjust_int( libvlc_media_player_t *p_mi,
952 return get_int( p_mi, "adjust", adjust_option_bynumber(option) );
956 void libvlc_video_set_adjust_float( libvlc_media_player_t *p_mi,
957 unsigned option, float value )
959 set_float( p_mi, "adjust", adjust_option_bynumber(option), value );
963 float libvlc_video_get_adjust_float( libvlc_media_player_t *p_mi,
966 return get_float( p_mi, "adjust", adjust_option_bynumber(option) );