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 int libvlc_video_get_cursor( libvlc_media_player_t *mp, unsigned num,
190 int *restrict px, int *restrict py )
192 vout_thread_t *p_vout = GetVout (mp, num);
196 var_GetCoords (p_vout, "mouse-moved", px, py);
197 vlc_object_release (p_vout);
201 unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_mi )
204 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
205 for (size_t i = 0; i < n; i++)
206 vlc_object_release (pp_vouts[i]);
211 float libvlc_video_get_scale( libvlc_media_player_t *mp )
213 float f_scale = var_GetFloat (mp, "scale");
214 if (var_GetBool (mp, "autoscale"))
219 void libvlc_video_set_scale( libvlc_media_player_t *p_mp, float f_scale )
222 var_SetFloat (p_mp, "scale", f_scale);
223 var_SetBool (p_mp, "autoscale", f_scale != 0.);
225 /* Apply to current video outputs (if any) */
227 vout_thread_t **pp_vouts = GetVouts (p_mp, &n);
228 for (size_t i = 0; i < n; i++)
230 vout_thread_t *p_vout = pp_vouts[i];
233 var_SetFloat (p_vout, "scale", f_scale);
234 var_SetBool (p_mp, "autoscale", f_scale != 0.);
235 vlc_object_release (p_vout);
240 char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi )
242 return var_GetNonEmptyString (p_mi, "aspect-ratio");
245 void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi,
246 const char *psz_aspect )
248 if (psz_aspect == NULL)
250 var_SetString (p_mi, "aspect-ratio", psz_aspect);
253 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
254 for (size_t i = 0; i < n; i++)
256 vout_thread_t *p_vout = pp_vouts[i];
258 var_SetString (p_vout, "aspect-ratio", psz_aspect);
259 vlc_object_release (p_vout);
264 int libvlc_video_get_spu( libvlc_media_player_t *p_mi )
266 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
267 vlc_value_t val_list;
273 if( !p_input_thread )
275 libvlc_printerr( "No active input" );
279 i_ret = var_Get( p_input_thread, "spu-es", &val );
282 vlc_object_release( p_input_thread );
283 libvlc_printerr( "Subtitle informations not found" );
287 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
288 for( i = 0; i < val_list.p_list->i_count; i++ )
290 if( val.i_int == val_list.p_list->p_values[i].i_int )
296 var_FreeList( &val_list, NULL );
297 vlc_object_release( p_input_thread );
301 int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi )
303 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
306 if( !p_input_thread )
309 i_spu_count = var_CountChoices( p_input_thread, "spu-es" );
310 vlc_object_release( p_input_thread );
314 libvlc_track_description_t *
315 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi )
317 return libvlc_get_track_description( p_mi, "spu-es" );
320 int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu )
322 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
326 if( !p_input_thread )
329 var_Change (p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &list, NULL);
331 if (i_spu > (unsigned)list.p_list->i_count)
333 libvlc_printerr( "Subtitle number out of range (%u/%u)",
334 i_spu, list.p_list->i_count );
338 var_SetInteger (p_input_thread, "spu-es",
339 list.p_list->p_values[i_spu].i_int);
341 vlc_object_release (p_input_thread);
342 var_FreeList (&list, NULL);
346 int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi,
347 const char *psz_subtitle )
349 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi );
354 if( !input_AddSubtitle( p_input_thread, psz_subtitle, true ) )
356 vlc_object_release( p_input_thread );
361 libvlc_track_description_t *
362 libvlc_video_get_title_description( libvlc_media_player_t *p_mi )
364 return libvlc_get_track_description( p_mi, "title" );
367 libvlc_track_description_t *
368 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
372 sprintf( psz_title, "title %2i", i_title );
373 return libvlc_get_track_description( p_mi, psz_title );
376 char *libvlc_video_get_crop_geometry (libvlc_media_player_t *p_mi)
378 return var_GetNonEmptyString (p_mi, "crop");
381 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
382 const char *psz_geometry )
384 if (psz_geometry == NULL)
387 var_SetString (p_mi, "crop", psz_geometry);
390 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
392 for (size_t i = 0; i < n; i++)
394 vout_thread_t *p_vout = pp_vouts[i];
396 var_SetString (p_vout, "crop", psz_geometry);
397 vlc_object_release (p_vout);
402 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi )
404 return var_GetInteger (p_mi, "vbi-page");
407 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page )
409 input_thread_t *p_input_thread;
410 vlc_object_t *p_zvbi = NULL;
413 var_SetInteger (p_mi, "vbi-page", i_page);
415 p_input_thread = libvlc_get_input_thread( p_mi );
416 if( !p_input_thread ) return;
418 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
420 vlc_object_release( p_input_thread );
424 telx = var_GetInteger( p_input_thread, "teletext-es" );
425 if( input_GetEsObjects( p_input_thread, telx, &p_zvbi, NULL, NULL )
428 var_SetInteger( p_zvbi, "vbi-page", i_page );
429 vlc_object_release( p_zvbi );
431 vlc_object_release( p_input_thread );
434 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi )
436 input_thread_t *p_input_thread;
438 p_input_thread = libvlc_get_input_thread(p_mi);
439 if( !p_input_thread ) return;
441 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
443 vlc_object_release( p_input_thread );
446 const bool b_selected = var_GetInteger( p_input_thread, "teletext-es" ) >= 0;
449 var_SetInteger( p_input_thread, "spu-es", -1 );
454 if( !var_Change( p_input_thread, "teletext-es", VLC_VAR_GETLIST, &list, NULL ) )
456 if( list.p_list->i_count > 0 )
457 var_SetInteger( p_input_thread, "spu-es", list.p_list->p_values[0].i_int );
459 var_FreeList( &list, NULL );
462 vlc_object_release( p_input_thread );
465 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi )
467 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
470 if( !p_input_thread )
473 i_track_count = var_CountChoices( p_input_thread, "video-es" );
475 vlc_object_release( p_input_thread );
476 return i_track_count;
479 libvlc_track_description_t *
480 libvlc_video_get_track_description( libvlc_media_player_t *p_mi )
482 return libvlc_get_track_description( p_mi, "video-es" );
485 int libvlc_video_get_track( libvlc_media_player_t *p_mi )
487 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
488 vlc_value_t val_list;
492 if( !p_input_thread )
495 if( var_Get( p_input_thread, "video-es", &val ) < 0 )
497 libvlc_printerr( "Video track information not found" );
498 vlc_object_release( p_input_thread );
502 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
503 for( int i = 0; i < val_list.p_list->i_count; i++ )
505 if( val_list.p_list->p_values[i].i_int == val.i_int )
511 var_FreeList( &val_list, NULL );
512 vlc_object_release( p_input_thread );
516 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track )
518 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
519 vlc_value_t val_list;
522 if( !p_input_thread )
525 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
526 for( int i = 0; i < val_list.p_list->i_count; i++ )
528 if( i_track == val_list.p_list->p_values[i].i_int )
530 if( var_SetInteger( p_input_thread, "video-es", i_track ) < 0 )
536 libvlc_printerr( "Video track number out of range" );
538 var_FreeList( &val_list, NULL );
539 vlc_object_release( p_input_thread );
543 /******************************************************************************
544 * libvlc_video_set_deinterlace : enable deinterlace
545 *****************************************************************************/
546 void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
547 const char *psz_mode )
549 if (psz_mode == NULL)
552 && strcmp (psz_mode, "blend") && strcmp (psz_mode, "bob")
553 && strcmp (psz_mode, "discard") && strcmp (psz_mode, "linear")
554 && strcmp (psz_mode, "mean") && strcmp (psz_mode, "x")
555 && strcmp (psz_mode, "yadif") && strcmp (psz_mode, "yadif2x"))
560 var_SetString (p_mi, "deinterlace-mode", psz_mode);
561 var_SetInteger (p_mi, "deinterlace", 1);
564 var_SetInteger (p_mi, "deinterlace", 0);
567 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
568 for (size_t i = 0; i < n; i++)
570 vout_thread_t *p_vout = pp_vouts[i];
574 var_SetString (p_vout, "deinterlace-mode", psz_mode);
575 var_SetInteger (p_vout, "deinterlace", 1);
578 var_SetInteger (p_vout, "deinterlace", 0);
579 vlc_object_release (p_vout);
589 static vlc_object_t *get_object( libvlc_media_player_t * p_mi,
592 vlc_object_t *object;
593 vout_thread_t *vout = GetVout( p_mi, 0 );
597 object = vlc_object_find_name( vout, name, FIND_CHILD );
598 vlc_object_release(vout);
604 libvlc_printerr( "%s not enabled", name );
609 typedef const struct {
616 set_int( libvlc_media_player_t *p_mi, const char *restrict name,
617 const opt_t *restrict opt, int value )
621 if( !opt->type ) /* the enabler */
623 vout_thread_t *vout = GetVout( p_mi, 0 );
626 vout_EnableFilter( vout, opt->name, value, false );
627 vlc_object_release( vout );
632 if( opt->type != VLC_VAR_INTEGER )
634 libvlc_printerr( "Invalid argument to %s in %s", name, "set int" );
638 var_SetInteger(p_mi, opt->name, value);
639 vlc_object_t *object = get_object( p_mi, name );
642 var_SetInteger(object, opt->name, value);
643 vlc_object_release( object );
649 get_int( libvlc_media_player_t *p_mi, const char *restrict name,
650 const opt_t *restrict opt )
656 case 0: /* the enabler */
658 vlc_object_t *object = get_object( p_mi, name );
659 vlc_object_release( object );
660 return object != NULL;
662 case VLC_VAR_INTEGER:
663 return var_GetInteger(p_mi, opt->name);
665 libvlc_printerr( "Invalid argument to %s in %s", name, "get int" );
672 set_string( libvlc_media_player_t *p_mi, const char *restrict name,
673 const opt_t *restrict opt, const char *restrict psz_value )
677 if( opt->type != VLC_VAR_STRING )
679 libvlc_printerr( "Invalid argument to %s in %s", name, "set string" );
683 var_SetString( p_mi, opt->name, psz_value );
685 vlc_object_t *object = get_object( p_mi, name );
688 var_SetString(object, opt->name, psz_value );
689 vlc_object_release( object );
695 get_string( libvlc_media_player_t *p_mi, const char *restrict name,
696 const opt_t *restrict opt )
698 if( !opt ) return NULL;
700 if( opt->type != VLC_VAR_STRING )
702 libvlc_printerr( "Invalid argument to %s in %s", name, "get string" );
706 return var_GetString( p_mi, opt->name );
711 marq_option_bynumber(unsigned option)
713 static const opt_t optlist[] =
716 { "marq-marquee", VLC_VAR_STRING },
717 { "marq-color", VLC_VAR_INTEGER },
718 { "marq-opacity", VLC_VAR_INTEGER },
719 { "marq-position", VLC_VAR_INTEGER },
720 { "marq-refresh", VLC_VAR_INTEGER },
721 { "marq-size", VLC_VAR_INTEGER },
722 { "marq-timeout", VLC_VAR_INTEGER },
723 { "marq-x", VLC_VAR_INTEGER },
724 { "marq-y", VLC_VAR_INTEGER },
726 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
728 opt_t *r = option < num_opts ? optlist+option : NULL;
730 libvlc_printerr( "Unknown marquee option" );
734 static vlc_object_t *get_object( libvlc_media_player_t *, const char *);
736 /*****************************************************************************
737 * libvlc_video_get_marquee_int : get a marq option value
738 *****************************************************************************/
739 int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
742 return get_int( p_mi, "marq", marq_option_bynumber(option) );
745 /*****************************************************************************
746 * libvlc_video_get_marquee_string : get a marq option value
747 *****************************************************************************/
748 char * libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
751 return get_string( p_mi, "marq", marq_option_bynumber(option) );
754 /*****************************************************************************
755 * libvlc_video_set_marquee_int: enable, disable or set an int option
756 *****************************************************************************/
757 void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
758 unsigned option, int value )
760 set_int( p_mi, "marq", marq_option_bynumber(option), value );
763 /*****************************************************************************
764 * libvlc_video_set_marquee_string: set a string option
765 *****************************************************************************/
766 void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
767 unsigned option, const char * value )
769 set_string( p_mi, "marq", marq_option_bynumber(option), value );
773 /* logo module support */
777 logo_option_bynumber( unsigned option )
779 static const opt_t vlogo_optlist[] =
780 /* depends on libvlc_video_logo_option_t */
783 { "logo-file", VLC_VAR_STRING },
784 { "logo-x", VLC_VAR_INTEGER },
785 { "logo-y", VLC_VAR_INTEGER },
786 { "logo-delay", VLC_VAR_INTEGER },
787 { "logo-repeat", VLC_VAR_INTEGER },
788 { "logo-opacity", VLC_VAR_INTEGER },
789 { "logo-position", VLC_VAR_INTEGER },
791 enum { num_vlogo_opts = sizeof(vlogo_optlist) / sizeof(*vlogo_optlist) };
793 opt_t *r = option < num_vlogo_opts ? vlogo_optlist+option : NULL;
795 libvlc_printerr( "Unknown logo option" );
800 void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
801 unsigned option, const char *psz_value )
803 set_string( p_mi,"logo",logo_option_bynumber(option),psz_value );
807 void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
808 unsigned option, int value )
810 set_int( p_mi, "logo", logo_option_bynumber(option), value );
814 int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
817 return get_int( p_mi, "logo", logo_option_bynumber(option) );