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" );
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 height, width;
182 if (libvlc_video_get_size (p_mi, 0, &height, &width))
187 int libvlc_video_get_width( libvlc_media_player_t *p_mi )
189 unsigned height, width;
191 if (libvlc_video_get_size (p_mi, 0, &height, &width))
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 libvlc_track_description_t *
369 libvlc_video_get_title_description( libvlc_media_player_t *p_mi )
371 return libvlc_get_track_description( p_mi, "title" );
374 libvlc_track_description_t *
375 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
379 sprintf( psz_title, "title %2i", i_title );
380 return libvlc_get_track_description( p_mi, psz_title );
383 char *libvlc_video_get_crop_geometry (libvlc_media_player_t *p_mi)
385 return var_GetNonEmptyString (p_mi, "crop");
388 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
389 const char *psz_geometry )
391 if (psz_geometry == NULL)
394 var_SetString (p_mi, "crop", psz_geometry);
397 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
399 for (size_t i = 0; i < n; i++)
401 vout_thread_t *p_vout = pp_vouts[i];
404 /* Make sure the geometry is in the choice list */
405 /* Earlier choices are removed to not grow a long list over time. */
406 /* FIXME: not atomic - lock? */
407 val.psz_string = (char *)psz_geometry;
408 var_Change (p_vout, "crop", VLC_VAR_CLEARCHOICES, NULL, NULL);
409 var_Change (p_vout, "crop", VLC_VAR_ADDCHOICE, &val, &val);
410 var_SetString (p_vout, "crop", psz_geometry);
411 vlc_object_release (p_vout);
416 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi )
418 return var_GetInteger (p_mi, "vbi-page");
421 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page )
423 input_thread_t *p_input_thread;
424 vlc_object_t *p_zvbi = NULL;
427 var_SetInteger (p_mi, "vbi-page", i_page);
429 p_input_thread = libvlc_get_input_thread( p_mi );
430 if( !p_input_thread ) return;
432 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
434 vlc_object_release( p_input_thread );
438 telx = var_GetInteger( p_input_thread, "teletext-es" );
439 if( input_GetEsObjects( p_input_thread, telx, &p_zvbi, NULL, NULL )
442 var_SetInteger( p_zvbi, "vbi-page", i_page );
443 vlc_object_release( p_zvbi );
445 vlc_object_release( p_input_thread );
448 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi )
450 input_thread_t *p_input_thread;
452 p_input_thread = libvlc_get_input_thread(p_mi);
453 if( !p_input_thread ) return;
455 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
457 vlc_object_release( p_input_thread );
460 const bool b_selected = var_GetInteger( p_input_thread, "teletext-es" ) >= 0;
463 var_SetInteger( p_input_thread, "spu-es", -1 );
468 if( !var_Change( p_input_thread, "teletext-es", VLC_VAR_GETLIST, &list, NULL ) )
470 if( list.p_list->i_count > 0 )
471 var_SetInteger( p_input_thread, "spu-es", list.p_list->p_values[0].i_int );
473 var_FreeList( &list, NULL );
476 vlc_object_release( p_input_thread );
479 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi )
481 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
484 if( !p_input_thread )
487 i_track_count = var_CountChoices( p_input_thread, "video-es" );
489 vlc_object_release( p_input_thread );
490 return i_track_count;
493 libvlc_track_description_t *
494 libvlc_video_get_track_description( libvlc_media_player_t *p_mi )
496 return libvlc_get_track_description( p_mi, "video-es" );
499 int libvlc_video_get_track( libvlc_media_player_t *p_mi )
501 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
502 vlc_value_t val_list;
506 if( !p_input_thread )
509 if( var_Get( p_input_thread, "video-es", &val ) < 0 )
511 libvlc_printerr( "Video track information not found" );
512 vlc_object_release( p_input_thread );
516 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
517 for( int i = 0; i < val_list.p_list->i_count; i++ )
519 if( val_list.p_list->p_values[i].i_int == val.i_int )
525 var_FreeList( &val_list, NULL );
526 vlc_object_release( p_input_thread );
530 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track )
532 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
533 vlc_value_t val_list;
536 if( !p_input_thread )
539 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
540 for( int i = 0; i < val_list.p_list->i_count; i++ )
542 if( i_track == val_list.p_list->p_values[i].i_int )
544 if( var_SetInteger( p_input_thread, "video-es", i_track ) < 0 )
550 libvlc_printerr( "Video track number out of range" );
552 var_FreeList( &val_list, NULL );
553 vlc_object_release( p_input_thread );
557 /******************************************************************************
558 * libvlc_video_set_deinterlace : enable deinterlace
559 *****************************************************************************/
560 void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
561 const char *psz_mode )
563 if (psz_mode == NULL)
566 && strcmp (psz_mode, "blend") && strcmp (psz_mode, "bob")
567 && strcmp (psz_mode, "discard") && strcmp (psz_mode, "linear")
568 && strcmp (psz_mode, "mean") && strcmp (psz_mode, "x")
569 && strcmp (psz_mode, "yadif") && strcmp (psz_mode, "yadif2x"))
574 var_SetString (p_mi, "deinterlace-mode", psz_mode);
575 var_SetInteger (p_mi, "deinterlace", 1);
578 var_SetInteger (p_mi, "deinterlace", 0);
581 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
582 for (size_t i = 0; i < n; i++)
584 vout_thread_t *p_vout = pp_vouts[i];
588 var_SetString (p_vout, "deinterlace-mode", psz_mode);
589 var_SetInteger (p_vout, "deinterlace", 1);
592 var_SetInteger (p_vout, "deinterlace", 0);
593 vlc_object_release (p_vout);
603 static vlc_object_t *get_object( libvlc_media_player_t * p_mi,
606 vlc_object_t *object;
607 vout_thread_t *vout = GetVout( p_mi, 0 );
611 object = vlc_object_find_name( vout, name, FIND_CHILD );
612 vlc_object_release(vout);
618 libvlc_printerr( "%s not enabled", name );
623 typedef const struct {
630 set_int( libvlc_media_player_t *p_mi, const char *restrict name,
631 const opt_t *restrict opt, int value )
635 if( !opt->type ) /* the enabler */
637 vout_thread_t *vout = GetVout( p_mi, 0 );
640 vout_EnableFilter( vout, opt->name, value, false );
641 vlc_object_release( vout );
646 if( opt->type != VLC_VAR_INTEGER )
648 libvlc_printerr( "Invalid argument to %s in %s", name, "set int" );
652 var_SetInteger(p_mi, opt->name, value);
653 vlc_object_t *object = get_object( p_mi, name );
656 var_SetInteger(object, opt->name, value);
657 vlc_object_release( object );
663 get_int( libvlc_media_player_t *p_mi, const char *restrict name,
664 const opt_t *restrict opt )
670 case 0: /* the enabler */
672 vlc_object_t *object = get_object( p_mi, name );
673 vlc_object_release( object );
674 return object != NULL;
676 case VLC_VAR_INTEGER:
677 return var_GetInteger(p_mi, opt->name);
679 libvlc_printerr( "Invalid argument to %s in %s", name, "get int" );
686 set_float( libvlc_media_player_t *p_mi, const char *restrict name,
687 const opt_t *restrict opt, float value )
691 if( opt->type != VLC_VAR_FLOAT )
693 libvlc_printerr( "Invalid argument to %s in %s", name, "set float" );
697 var_SetFloat( p_mi, opt->name, value );
699 vlc_object_t *object = get_object( p_mi, name );
702 var_SetFloat(object, opt->name, value );
703 vlc_object_release( object );
709 get_float( libvlc_media_player_t *p_mi, const char *restrict name,
710 const opt_t *restrict opt )
712 if( !opt ) return 0.0;
715 if( opt->type != VLC_VAR_FLOAT )
717 libvlc_printerr( "Invalid argument to %s in %s", name, "get float" );
721 return var_GetFloat( p_mi, opt->name );
726 set_string( libvlc_media_player_t *p_mi, const char *restrict name,
727 const opt_t *restrict opt, const char *restrict psz_value )
731 if( opt->type != VLC_VAR_STRING )
733 libvlc_printerr( "Invalid argument to %s in %s", name, "set string" );
737 var_SetString( p_mi, opt->name, psz_value );
739 vlc_object_t *object = get_object( p_mi, name );
742 var_SetString(object, opt->name, psz_value );
743 vlc_object_release( object );
749 get_string( libvlc_media_player_t *p_mi, const char *restrict name,
750 const opt_t *restrict opt )
752 if( !opt ) return NULL;
754 if( opt->type != VLC_VAR_STRING )
756 libvlc_printerr( "Invalid argument to %s in %s", name, "get string" );
760 return var_GetString( p_mi, opt->name );
765 marq_option_bynumber(unsigned option)
767 static const opt_t optlist[] =
770 { "marq-marquee", VLC_VAR_STRING },
771 { "marq-color", VLC_VAR_INTEGER },
772 { "marq-opacity", VLC_VAR_INTEGER },
773 { "marq-position", VLC_VAR_INTEGER },
774 { "marq-refresh", VLC_VAR_INTEGER },
775 { "marq-size", VLC_VAR_INTEGER },
776 { "marq-timeout", VLC_VAR_INTEGER },
777 { "marq-x", VLC_VAR_INTEGER },
778 { "marq-y", VLC_VAR_INTEGER },
780 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
782 const opt_t *r = option < num_opts ? optlist+option : NULL;
784 libvlc_printerr( "Unknown marquee option" );
788 static vlc_object_t *get_object( libvlc_media_player_t *, const char *);
790 /*****************************************************************************
791 * libvlc_video_get_marquee_int : get a marq option value
792 *****************************************************************************/
793 int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
796 return get_int( p_mi, "marq", marq_option_bynumber(option) );
799 /*****************************************************************************
800 * libvlc_video_get_marquee_string : get a marq option value
801 *****************************************************************************/
802 char * libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
805 return get_string( p_mi, "marq", marq_option_bynumber(option) );
808 /*****************************************************************************
809 * libvlc_video_set_marquee_int: enable, disable or set an int option
810 *****************************************************************************/
811 void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
812 unsigned option, int value )
814 set_int( p_mi, "marq", marq_option_bynumber(option), value );
817 /*****************************************************************************
818 * libvlc_video_set_marquee_string: set a string option
819 *****************************************************************************/
820 void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
821 unsigned option, const char * value )
823 set_string( p_mi, "marq", marq_option_bynumber(option), value );
827 /* logo module support */
831 logo_option_bynumber( unsigned option )
833 static const opt_t vlogo_optlist[] =
834 /* depends on libvlc_video_logo_option_t */
837 { "logo-file", VLC_VAR_STRING },
838 { "logo-x", VLC_VAR_INTEGER },
839 { "logo-y", VLC_VAR_INTEGER },
840 { "logo-delay", VLC_VAR_INTEGER },
841 { "logo-repeat", VLC_VAR_INTEGER },
842 { "logo-opacity", VLC_VAR_INTEGER },
843 { "logo-position", VLC_VAR_INTEGER },
845 enum { num_vlogo_opts = sizeof(vlogo_optlist) / sizeof(*vlogo_optlist) };
847 const opt_t *r = option < num_vlogo_opts ? vlogo_optlist+option : NULL;
849 libvlc_printerr( "Unknown logo option" );
854 void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
855 unsigned option, const char *psz_value )
857 set_string( p_mi,"logo",logo_option_bynumber(option),psz_value );
861 void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
862 unsigned option, int value )
864 set_int( p_mi, "logo", logo_option_bynumber(option), value );
868 int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
871 return get_int( p_mi, "logo", logo_option_bynumber(option) );
875 /* adjust module support */
879 adjust_option_bynumber( unsigned option )
881 static const opt_t optlist[] =
884 { "contrast", VLC_VAR_FLOAT },
885 { "brightness", VLC_VAR_FLOAT },
886 { "hue", VLC_VAR_INTEGER },
887 { "saturation", VLC_VAR_FLOAT },
888 { "gamma", VLC_VAR_FLOAT },
890 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
892 const opt_t *r = option < num_opts ? optlist+option : NULL;
894 libvlc_printerr( "Unknown adjust option" );
899 void libvlc_video_set_adjust_int( libvlc_media_player_t *p_mi,
900 unsigned option, int value )
902 set_int( p_mi, "adjust", adjust_option_bynumber(option), value );
906 int libvlc_video_get_adjust_int( libvlc_media_player_t *p_mi,
909 return get_int( p_mi, "adjust", adjust_option_bynumber(option) );
913 void libvlc_video_set_adjust_float( libvlc_media_player_t *p_mi,
914 unsigned option, float value )
916 set_float( p_mi, "adjust", adjust_option_bynumber(option), value );
920 float libvlc_video_get_adjust_float( libvlc_media_player_t *p_mi,
923 return get_float( p_mi, "adjust", adjust_option_bynumber(option) );