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"
45 * Remember to release the returned vout_thread_t.
47 static vout_thread_t **GetVouts( libvlc_media_player_t *p_mi, size_t *n )
49 input_thread_t *p_input = libvlc_get_input_thread( p_mi );
53 vout_thread_t **pp_vouts;
54 if (input_Control( p_input, INPUT_GET_VOUTS, &pp_vouts, n))
59 vlc_object_release (p_input);
63 static vout_thread_t *GetVout (libvlc_media_player_t *mp, size_t num)
65 vout_thread_t *p_vout = NULL;
67 vout_thread_t **pp_vouts = GetVouts (mp, &n);
72 p_vout = pp_vouts[num];
74 for (size_t i = 0; i < n; i++)
76 vlc_object_release (pp_vouts[i]);
81 libvlc_printerr ("Video output not active");
85 /**********************************************************************
87 **********************************************************************/
89 void libvlc_set_fullscreen( libvlc_media_player_t *p_mi, int b_fullscreen )
91 /* This will work even if the video is not currently active */
92 var_SetBool (p_mi, "fullscreen", !!b_fullscreen);
94 /* Apply to current video outputs (if any) */
96 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
97 for (size_t i = 0; i < n; i++)
99 var_SetBool (pp_vouts[i], "fullscreen", b_fullscreen);
100 vlc_object_release (pp_vouts[i]);
105 int libvlc_get_fullscreen( libvlc_media_player_t *p_mi )
107 return var_GetBool (p_mi, "fullscreen");
110 void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi )
112 bool b_fullscreen = var_ToggleBool (p_mi, "fullscreen");
114 /* Apply to current video outputs (if any) */
116 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
117 for (size_t i = 0; i < n; i++)
119 vout_thread_t *p_vout = pp_vouts[i];
121 var_SetBool (p_vout, "fullscreen", b_fullscreen);
122 vlc_object_release (p_vout);
127 void libvlc_video_set_key_input( libvlc_media_player_t *p_mi, unsigned on )
129 var_SetBool (p_mi, "keyboard-events", !!on);
132 void libvlc_video_set_mouse_input( libvlc_media_player_t *p_mi, unsigned on )
134 var_SetBool (p_mi, "mouse-events", !!on);
138 libvlc_video_take_snapshot( libvlc_media_player_t *p_mi, unsigned num,
139 const char *psz_filepath,
140 unsigned int i_width, unsigned int i_height )
142 assert( psz_filepath );
144 vout_thread_t *p_vout = GetVout (p_mi, num);
148 /* FIXME: This is not atomic. Someone else could change the values,
149 * at least in theory. */
150 var_SetInteger( p_vout, "snapshot-width", i_width);
151 var_SetInteger( p_vout, "snapshot-height", i_height );
152 var_SetString( p_vout, "snapshot-path", psz_filepath );
153 var_SetString( p_vout, "snapshot-format", "png" );
154 var_TriggerCallback (p_vout, "video-snapshot" );
158 int libvlc_video_get_size( libvlc_media_player_t *p_mi, unsigned num,
159 unsigned *restrict px, unsigned *restrict py )
161 vout_thread_t *p_vout = GetVout (p_mi, num);
165 *px = p_vout->i_window_height;
166 *py = p_vout->i_window_width;
167 vlc_object_release (p_vout);
171 int libvlc_video_get_height( libvlc_media_player_t *p_mi )
173 unsigned height, width;
175 if (libvlc_video_get_size (p_mi, 0, &height, &width))
180 int libvlc_video_get_width( libvlc_media_player_t *p_mi )
182 unsigned height, width;
184 if (libvlc_video_get_size (p_mi, 0, &height, &width))
189 unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_mi )
192 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
193 for (size_t i = 0; i < n; i++)
194 vlc_object_release (pp_vouts[i]);
199 float libvlc_video_get_scale( libvlc_media_player_t *mp )
201 float f_scale = var_GetFloat (mp, "scale");
202 if (var_GetBool (mp, "autoscale"))
207 void libvlc_video_set_scale( libvlc_media_player_t *p_mp, float f_scale )
210 var_SetFloat (p_mp, "scale", f_scale);
211 var_SetBool (p_mp, "autoscale", f_scale != 0.);
213 /* Apply to current video outputs (if any) */
215 vout_thread_t **pp_vouts = GetVouts (p_mp, &n);
216 for (size_t i = 0; i < n; i++)
218 vout_thread_t *p_vout = pp_vouts[i];
221 var_SetFloat (p_vout, "scale", f_scale);
222 var_SetBool (p_mp, "autoscale", f_scale != 0.);
223 vlc_object_release (p_vout);
228 char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi )
230 return var_GetNonEmptyString (p_mi, "aspect-ratio");
233 void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi,
234 const char *psz_aspect )
236 if (psz_aspect == NULL)
238 var_SetString (p_mi, "aspect-ratio", psz_aspect);
241 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
242 for (size_t i = 0; i < n; i++)
244 vout_thread_t *p_vout = pp_vouts[i];
246 var_SetString (p_vout, "aspect-ratio", psz_aspect);
247 vlc_object_release (p_vout);
252 int libvlc_video_get_spu( libvlc_media_player_t *p_mi )
254 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
255 vlc_value_t val_list;
261 if( !p_input_thread )
263 libvlc_printerr( "No active input" );
267 i_ret = var_Get( p_input_thread, "spu-es", &val );
270 vlc_object_release( p_input_thread );
271 libvlc_printerr( "Subtitle informations not found" );
275 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
276 for( i = 0; i < val_list.p_list->i_count; i++ )
278 if( val.i_int == val_list.p_list->p_values[i].i_int )
284 var_FreeList( &val_list, NULL );
285 vlc_object_release( p_input_thread );
289 int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi )
291 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
294 if( !p_input_thread )
297 i_spu_count = var_CountChoices( p_input_thread, "spu-es" );
298 vlc_object_release( p_input_thread );
302 libvlc_track_description_t *
303 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi )
305 return libvlc_get_track_description( p_mi, "spu-es" );
308 int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu )
310 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
314 if( !p_input_thread )
317 var_Change (p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &list, NULL);
319 if (i_spu > (unsigned)list.p_list->i_count)
321 libvlc_printerr( "Subtitle number out of range (%u/%u)",
322 i_spu, list.p_list->i_count );
326 var_SetInteger (p_input_thread, "spu-es",
327 list.p_list->p_values[i_spu].i_int);
329 vlc_object_release (p_input_thread);
330 var_FreeList (&list, NULL);
334 int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi,
335 const char *psz_subtitle )
337 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi );
342 if( !input_AddSubtitle( p_input_thread, psz_subtitle, true ) )
344 vlc_object_release( p_input_thread );
349 libvlc_track_description_t *
350 libvlc_video_get_title_description( libvlc_media_player_t *p_mi )
352 return libvlc_get_track_description( p_mi, "title" );
355 libvlc_track_description_t *
356 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
360 sprintf( psz_title, "title %2i", i_title );
361 return libvlc_get_track_description( p_mi, psz_title );
364 char *libvlc_video_get_crop_geometry (libvlc_media_player_t *p_mi)
366 return var_GetNonEmptyString (p_mi, "crop");
369 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
370 const char *psz_geometry )
372 if (psz_geometry == NULL)
375 var_SetString (p_mi, "crop", psz_geometry);
378 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
380 for (size_t i = 0; i < n; i++)
382 vout_thread_t *p_vout = pp_vouts[i];
384 var_SetString (p_vout, "crop", psz_geometry);
385 vlc_object_release (p_vout);
390 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi )
392 return var_GetInteger (p_mi, "vbi-page");
395 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page )
397 input_thread_t *p_input_thread;
398 vlc_object_t *p_zvbi = NULL;
401 var_SetInteger (p_mi, "vbi-page", i_page);
403 p_input_thread = libvlc_get_input_thread( p_mi );
404 if( !p_input_thread ) return;
406 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
408 vlc_object_release( p_input_thread );
412 telx = var_GetInteger( p_input_thread, "teletext-es" );
413 if( input_GetEsObjects( p_input_thread, telx, &p_zvbi, NULL, NULL )
416 var_SetInteger( p_zvbi, "vbi-page", i_page );
417 vlc_object_release( p_zvbi );
419 vlc_object_release( p_input_thread );
422 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi )
424 input_thread_t *p_input_thread;
426 p_input_thread = libvlc_get_input_thread(p_mi);
427 if( !p_input_thread ) return;
429 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
431 vlc_object_release( p_input_thread );
434 const bool b_selected = var_GetInteger( p_input_thread, "teletext-es" ) >= 0;
437 var_SetInteger( p_input_thread, "spu-es", -1 );
442 if( !var_Change( p_input_thread, "teletext-es", VLC_VAR_GETLIST, &list, NULL ) )
444 if( list.p_list->i_count > 0 )
445 var_SetInteger( p_input_thread, "spu-es", list.p_list->p_values[0].i_int );
447 var_FreeList( &list, NULL );
450 vlc_object_release( p_input_thread );
453 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi )
455 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
458 if( !p_input_thread )
461 i_track_count = var_CountChoices( p_input_thread, "video-es" );
463 vlc_object_release( p_input_thread );
464 return i_track_count;
467 libvlc_track_description_t *
468 libvlc_video_get_track_description( libvlc_media_player_t *p_mi )
470 return libvlc_get_track_description( p_mi, "video-es" );
473 int libvlc_video_get_track( libvlc_media_player_t *p_mi )
475 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
476 vlc_value_t val_list;
480 if( !p_input_thread )
483 if( var_Get( p_input_thread, "video-es", &val ) < 0 )
485 libvlc_printerr( "Video track information not found" );
486 vlc_object_release( p_input_thread );
490 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
491 for( int i = 0; i < val_list.p_list->i_count; i++ )
493 if( val_list.p_list->p_values[i].i_int == val.i_int )
499 var_FreeList( &val_list, NULL );
500 vlc_object_release( p_input_thread );
504 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track )
506 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
507 vlc_value_t val_list;
510 if( !p_input_thread )
513 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
514 for( int i = 0; i < val_list.p_list->i_count; i++ )
516 if( i_track == val_list.p_list->p_values[i].i_int )
518 if( var_SetInteger( p_input_thread, "video-es", i_track ) < 0 )
524 libvlc_printerr( "Video track number out of range" );
526 var_FreeList( &val_list, NULL );
527 vlc_object_release( p_input_thread );
531 /******************************************************************************
532 * libvlc_video_set_deinterlace : enable deinterlace
533 *****************************************************************************/
534 void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
535 const char *psz_mode )
537 if (psz_mode == NULL)
540 && strcmp (psz_mode, "blend") && strcmp (psz_mode, "bob")
541 && strcmp (psz_mode, "discard") && strcmp (psz_mode, "linear")
542 && strcmp (psz_mode, "mean") && strcmp (psz_mode, "x")
543 && strcmp (psz_mode, "yadif") && strcmp (psz_mode, "yadif2x"))
548 var_SetString (p_mi, "deinterlace-mode", psz_mode);
549 var_SetInteger (p_mi, "deinterlace", 1);
552 var_SetInteger (p_mi, "deinterlace", 0);
555 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
556 for (size_t i = 0; i < n; i++)
558 vout_thread_t *p_vout = pp_vouts[i];
562 var_SetString (p_vout, "deinterlace-mode", psz_mode);
563 var_SetInteger (p_vout, "deinterlace", 1);
566 var_SetInteger (p_vout, "deinterlace", 0);
567 vlc_object_release (p_vout);
577 static vlc_object_t *get_object( libvlc_media_player_t * p_mi,
580 vlc_object_t *object;
581 vout_thread_t *vout = GetVout( p_mi, 0 );
585 object = vlc_object_find_name( vout, name, FIND_CHILD );
586 vlc_object_release(vout);
592 libvlc_printerr( "%s not enabled", name );
597 typedef const struct {
604 set_int( libvlc_media_player_t *p_mi, const char *restrict name,
605 const opt_t *restrict opt, int value )
609 if( !opt->type ) /* the enabler */
611 vout_thread_t *vout = GetVout( p_mi, 0 );
614 vout_EnableFilter( vout, opt->name, value, false );
615 vlc_object_release( vout );
620 if( opt->type != VLC_VAR_INTEGER )
622 libvlc_printerr( "Invalid argument to %s in %s", name, "set int" );
626 var_SetInteger(p_mi, opt->name, value);
627 vlc_object_t *object = get_object( p_mi, name );
630 var_SetInteger(object, opt->name, value);
631 vlc_object_release( object );
637 get_int( libvlc_media_player_t *p_mi, const char *restrict name,
638 const opt_t *restrict opt )
644 case 0: /* the enabler */
646 vlc_object_t *object = get_object( p_mi, name );
647 vlc_object_release( object );
648 return object != NULL;
650 case VLC_VAR_INTEGER:
651 return var_GetInteger(p_mi, opt->name);
653 libvlc_printerr( "Invalid argument to %s in %s", name, "get int" );
660 set_string( libvlc_media_player_t *p_mi, const char *restrict name,
661 const opt_t *restrict opt, const char *restrict psz_value )
665 if( opt->type != VLC_VAR_STRING )
667 libvlc_printerr( "Invalid argument to %s in %s", name, "set string" );
671 var_SetString( p_mi, opt->name, psz_value );
673 vlc_object_t *object = get_object( p_mi, name );
676 var_SetString(object, opt->name, psz_value );
677 vlc_object_release( object );
683 get_string( libvlc_media_player_t *p_mi, const char *restrict name,
684 const opt_t *restrict opt )
686 if( !opt ) return NULL;
688 if( opt->type != VLC_VAR_STRING )
690 libvlc_printerr( "Invalid argument to %s in %s", name, "get string" );
694 return var_GetString( p_mi, opt->name );
699 marq_option_bynumber(unsigned option)
701 static const opt_t optlist[] =
704 { "marq-marquee", VLC_VAR_STRING },
705 { "marq-color", VLC_VAR_INTEGER },
706 { "marq-opacity", VLC_VAR_INTEGER },
707 { "marq-position", VLC_VAR_INTEGER },
708 { "marq-refresh", VLC_VAR_INTEGER },
709 { "marq-size", VLC_VAR_INTEGER },
710 { "marq-timeout", VLC_VAR_INTEGER },
711 { "marq-x", VLC_VAR_INTEGER },
712 { "marq-y", VLC_VAR_INTEGER },
714 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
716 opt_t *r = option < num_opts ? optlist+option : NULL;
718 libvlc_printerr( "Unknown marquee option" );
722 static vlc_object_t *get_object( libvlc_media_player_t *, const char *);
724 /*****************************************************************************
725 * libvlc_video_get_marquee_int : get a marq option value
726 *****************************************************************************/
727 int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
730 return get_int( p_mi, "marq", marq_option_bynumber(option) );
733 /*****************************************************************************
734 * libvlc_video_get_marquee_string : get a marq option value
735 *****************************************************************************/
736 char * libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
739 return get_string( p_mi, "marq", marq_option_bynumber(option) );
742 /*****************************************************************************
743 * libvlc_video_set_marquee_int: enable, disable or set an int option
744 *****************************************************************************/
745 void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
746 unsigned option, int value )
748 set_int( p_mi, "marq", marq_option_bynumber(option), value );
751 /*****************************************************************************
752 * libvlc_video_set_marquee_string: set a string option
753 *****************************************************************************/
754 void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
755 unsigned option, const char * value )
757 set_string( p_mi, "marq", marq_option_bynumber(option), value );
761 /* logo module support */
765 logo_option_bynumber( unsigned option )
767 static const opt_t vlogo_optlist[] =
768 /* depends on libvlc_video_logo_option_t */
771 { "logo-file", VLC_VAR_STRING },
772 { "logo-x", VLC_VAR_INTEGER },
773 { "logo-y", VLC_VAR_INTEGER },
774 { "logo-delay", VLC_VAR_INTEGER },
775 { "logo-repeat", VLC_VAR_INTEGER },
776 { "logo-opacity", VLC_VAR_INTEGER },
777 { "logo-position", VLC_VAR_INTEGER },
779 enum { num_vlogo_opts = sizeof(vlogo_optlist) / sizeof(*vlogo_optlist) };
781 opt_t *r = option < num_vlogo_opts ? vlogo_optlist+option : NULL;
783 libvlc_printerr( "Unknown logo option" );
788 void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
789 unsigned option, const char *psz_value )
791 set_string( p_mi,"logo",logo_option_bynumber(option),psz_value );
795 void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
796 unsigned option, int value )
798 set_int( p_mi, "logo", logo_option_bynumber(option), value );
802 int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
805 return get_int( p_mi, "logo", logo_option_bynumber(option) );