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,
192 vout_thread_t *p_vout = GetVout (mp, num);
196 *px = var_GetInteger (p_vout, "mouse-x");
197 *py = var_GetInteger (p_vout, "mouse-y");
198 vlc_object_release (p_vout);
202 unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_mi )
205 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
206 for (size_t i = 0; i < n; i++)
207 vlc_object_release (pp_vouts[i]);
212 float libvlc_video_get_scale( libvlc_media_player_t *mp )
214 float f_scale = var_GetFloat (mp, "scale");
215 if (var_GetBool (mp, "autoscale"))
220 void libvlc_video_set_scale( libvlc_media_player_t *p_mp, float f_scale )
223 var_SetFloat (p_mp, "scale", f_scale);
224 var_SetBool (p_mp, "autoscale", f_scale != 0.);
226 /* Apply to current video outputs (if any) */
228 vout_thread_t **pp_vouts = GetVouts (p_mp, &n);
229 for (size_t i = 0; i < n; i++)
231 vout_thread_t *p_vout = pp_vouts[i];
234 var_SetFloat (p_vout, "scale", f_scale);
235 var_SetBool (p_mp, "autoscale", f_scale != 0.);
236 vlc_object_release (p_vout);
241 char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi )
243 return var_GetNonEmptyString (p_mi, "aspect-ratio");
246 void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi,
247 const char *psz_aspect )
249 if (psz_aspect == NULL)
251 var_SetString (p_mi, "aspect-ratio", psz_aspect);
254 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
255 for (size_t i = 0; i < n; i++)
257 vout_thread_t *p_vout = pp_vouts[i];
259 var_SetString (p_vout, "aspect-ratio", psz_aspect);
260 vlc_object_release (p_vout);
265 int libvlc_video_get_spu( libvlc_media_player_t *p_mi )
267 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
268 vlc_value_t val_list;
274 if( !p_input_thread )
276 libvlc_printerr( "No active input" );
280 i_ret = var_Get( p_input_thread, "spu-es", &val );
283 vlc_object_release( p_input_thread );
284 libvlc_printerr( "Subtitle informations not found" );
288 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
289 for( i = 0; i < val_list.p_list->i_count; i++ )
291 if( val.i_int == val_list.p_list->p_values[i].i_int )
297 var_FreeList( &val_list, NULL );
298 vlc_object_release( p_input_thread );
302 int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi )
304 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
307 if( !p_input_thread )
310 i_spu_count = var_CountChoices( p_input_thread, "spu-es" );
311 vlc_object_release( p_input_thread );
315 libvlc_track_description_t *
316 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi )
318 return libvlc_get_track_description( p_mi, "spu-es" );
321 int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu )
323 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
327 if( !p_input_thread )
330 var_Change (p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &list, NULL);
332 if (i_spu > (unsigned)list.p_list->i_count)
334 libvlc_printerr( "Subtitle number out of range (%u/%u)",
335 i_spu, list.p_list->i_count );
339 var_SetInteger (p_input_thread, "spu-es",
340 list.p_list->p_values[i_spu].i_int);
342 vlc_object_release (p_input_thread);
343 var_FreeList (&list, NULL);
347 int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi,
348 const char *psz_subtitle )
350 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi );
355 if( !input_AddSubtitle( p_input_thread, psz_subtitle, true ) )
357 vlc_object_release( p_input_thread );
362 libvlc_track_description_t *
363 libvlc_video_get_title_description( libvlc_media_player_t *p_mi )
365 return libvlc_get_track_description( p_mi, "title" );
368 libvlc_track_description_t *
369 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
373 sprintf( psz_title, "title %2i", i_title );
374 return libvlc_get_track_description( p_mi, psz_title );
377 char *libvlc_video_get_crop_geometry (libvlc_media_player_t *p_mi)
379 return var_GetNonEmptyString (p_mi, "crop");
382 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
383 const char *psz_geometry )
385 if (psz_geometry == NULL)
388 var_SetString (p_mi, "crop", psz_geometry);
391 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
393 for (size_t i = 0; i < n; i++)
395 vout_thread_t *p_vout = pp_vouts[i];
397 var_SetString (p_vout, "crop", psz_geometry);
398 vlc_object_release (p_vout);
403 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi )
405 return var_GetInteger (p_mi, "vbi-page");
408 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page )
410 input_thread_t *p_input_thread;
411 vlc_object_t *p_zvbi = NULL;
414 var_SetInteger (p_mi, "vbi-page", i_page);
416 p_input_thread = libvlc_get_input_thread( p_mi );
417 if( !p_input_thread ) return;
419 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
421 vlc_object_release( p_input_thread );
425 telx = var_GetInteger( p_input_thread, "teletext-es" );
426 if( input_GetEsObjects( p_input_thread, telx, &p_zvbi, NULL, NULL )
429 var_SetInteger( p_zvbi, "vbi-page", i_page );
430 vlc_object_release( p_zvbi );
432 vlc_object_release( p_input_thread );
435 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi )
437 input_thread_t *p_input_thread;
439 p_input_thread = libvlc_get_input_thread(p_mi);
440 if( !p_input_thread ) return;
442 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
444 vlc_object_release( p_input_thread );
447 const bool b_selected = var_GetInteger( p_input_thread, "teletext-es" ) >= 0;
450 var_SetInteger( p_input_thread, "spu-es", -1 );
455 if( !var_Change( p_input_thread, "teletext-es", VLC_VAR_GETLIST, &list, NULL ) )
457 if( list.p_list->i_count > 0 )
458 var_SetInteger( p_input_thread, "spu-es", list.p_list->p_values[0].i_int );
460 var_FreeList( &list, NULL );
463 vlc_object_release( p_input_thread );
466 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi )
468 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
471 if( !p_input_thread )
474 i_track_count = var_CountChoices( p_input_thread, "video-es" );
476 vlc_object_release( p_input_thread );
477 return i_track_count;
480 libvlc_track_description_t *
481 libvlc_video_get_track_description( libvlc_media_player_t *p_mi )
483 return libvlc_get_track_description( p_mi, "video-es" );
486 int libvlc_video_get_track( libvlc_media_player_t *p_mi )
488 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
489 vlc_value_t val_list;
493 if( !p_input_thread )
496 if( var_Get( p_input_thread, "video-es", &val ) < 0 )
498 libvlc_printerr( "Video track information not found" );
499 vlc_object_release( p_input_thread );
503 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
504 for( int i = 0; i < val_list.p_list->i_count; i++ )
506 if( val_list.p_list->p_values[i].i_int == val.i_int )
512 var_FreeList( &val_list, NULL );
513 vlc_object_release( p_input_thread );
517 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track )
519 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
520 vlc_value_t val_list;
523 if( !p_input_thread )
526 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
527 for( int i = 0; i < val_list.p_list->i_count; i++ )
529 if( i_track == val_list.p_list->p_values[i].i_int )
531 if( var_SetInteger( p_input_thread, "video-es", i_track ) < 0 )
537 libvlc_printerr( "Video track number out of range" );
539 var_FreeList( &val_list, NULL );
540 vlc_object_release( p_input_thread );
544 /******************************************************************************
545 * libvlc_video_set_deinterlace : enable deinterlace
546 *****************************************************************************/
547 void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
548 const char *psz_mode )
550 if (psz_mode == NULL)
553 && strcmp (psz_mode, "blend") && strcmp (psz_mode, "bob")
554 && strcmp (psz_mode, "discard") && strcmp (psz_mode, "linear")
555 && strcmp (psz_mode, "mean") && strcmp (psz_mode, "x")
556 && strcmp (psz_mode, "yadif") && strcmp (psz_mode, "yadif2x"))
561 var_SetString (p_mi, "deinterlace-mode", psz_mode);
562 var_SetInteger (p_mi, "deinterlace", 1);
565 var_SetInteger (p_mi, "deinterlace", 0);
568 vout_thread_t **pp_vouts = GetVouts (p_mi, &n);
569 for (size_t i = 0; i < n; i++)
571 vout_thread_t *p_vout = pp_vouts[i];
575 var_SetString (p_vout, "deinterlace-mode", psz_mode);
576 var_SetInteger (p_vout, "deinterlace", 1);
579 var_SetInteger (p_vout, "deinterlace", 0);
580 vlc_object_release (p_vout);
590 static vlc_object_t *get_object( libvlc_media_player_t * p_mi,
593 vlc_object_t *object;
594 vout_thread_t *vout = GetVout( p_mi, 0 );
598 object = vlc_object_find_name( vout, name, FIND_CHILD );
599 vlc_object_release(vout);
605 libvlc_printerr( "%s not enabled", name );
610 typedef const struct {
617 set_int( libvlc_media_player_t *p_mi, const char *restrict name,
618 const opt_t *restrict opt, int value )
622 if( !opt->type ) /* the enabler */
624 vout_thread_t *vout = GetVout( p_mi, 0 );
627 vout_EnableFilter( vout, opt->name, value, false );
628 vlc_object_release( vout );
633 if( opt->type != VLC_VAR_INTEGER )
635 libvlc_printerr( "Invalid argument to %s in %s", name, "set int" );
639 var_SetInteger(p_mi, opt->name, value);
640 vlc_object_t *object = get_object( p_mi, name );
643 var_SetInteger(object, opt->name, value);
644 vlc_object_release( object );
650 get_int( libvlc_media_player_t *p_mi, const char *restrict name,
651 const opt_t *restrict opt )
657 case 0: /* the enabler */
659 vlc_object_t *object = get_object( p_mi, name );
660 vlc_object_release( object );
661 return object != NULL;
663 case VLC_VAR_INTEGER:
664 return var_GetInteger(p_mi, opt->name);
666 libvlc_printerr( "Invalid argument to %s in %s", name, "get int" );
673 set_string( libvlc_media_player_t *p_mi, const char *restrict name,
674 const opt_t *restrict opt, const char *restrict psz_value )
678 if( opt->type != VLC_VAR_STRING )
680 libvlc_printerr( "Invalid argument to %s in %s", name, "set string" );
684 var_SetString( p_mi, opt->name, psz_value );
686 vlc_object_t *object = get_object( p_mi, name );
689 var_SetString(object, opt->name, psz_value );
690 vlc_object_release( object );
696 get_string( libvlc_media_player_t *p_mi, const char *restrict name,
697 const opt_t *restrict opt )
699 if( !opt ) return NULL;
701 if( opt->type != VLC_VAR_STRING )
703 libvlc_printerr( "Invalid argument to %s in %s", name, "get string" );
707 return var_GetString( p_mi, opt->name );
712 marq_option_bynumber(unsigned option)
714 static const opt_t optlist[] =
717 { "marq-marquee", VLC_VAR_STRING },
718 { "marq-color", VLC_VAR_INTEGER },
719 { "marq-opacity", VLC_VAR_INTEGER },
720 { "marq-position", VLC_VAR_INTEGER },
721 { "marq-refresh", VLC_VAR_INTEGER },
722 { "marq-size", VLC_VAR_INTEGER },
723 { "marq-timeout", VLC_VAR_INTEGER },
724 { "marq-x", VLC_VAR_INTEGER },
725 { "marq-y", VLC_VAR_INTEGER },
727 enum { num_opts = sizeof(optlist) / sizeof(*optlist) };
729 opt_t *r = option < num_opts ? optlist+option : NULL;
731 libvlc_printerr( "Unknown marquee option" );
735 static vlc_object_t *get_object( libvlc_media_player_t *, const char *);
737 /*****************************************************************************
738 * libvlc_video_get_marquee_int : get a marq option value
739 *****************************************************************************/
740 int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
743 return get_int( p_mi, "marq", marq_option_bynumber(option) );
746 /*****************************************************************************
747 * libvlc_video_get_marquee_string : get a marq option value
748 *****************************************************************************/
749 char * libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
752 return get_string( p_mi, "marq", marq_option_bynumber(option) );
755 /*****************************************************************************
756 * libvlc_video_set_marquee_int: enable, disable or set an int option
757 *****************************************************************************/
758 void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
759 unsigned option, int value )
761 set_int( p_mi, "marq", marq_option_bynumber(option), value );
764 /*****************************************************************************
765 * libvlc_video_set_marquee_string: set a string option
766 *****************************************************************************/
767 void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
768 unsigned option, const char * value )
770 set_string( p_mi, "marq", marq_option_bynumber(option), value );
774 /* logo module support */
778 logo_option_bynumber( unsigned option )
780 static const opt_t vlogo_optlist[] =
781 /* depends on libvlc_video_logo_option_t */
784 { "logo-file", VLC_VAR_STRING },
785 { "logo-x", VLC_VAR_INTEGER },
786 { "logo-y", VLC_VAR_INTEGER },
787 { "logo-delay", VLC_VAR_INTEGER },
788 { "logo-repeat", VLC_VAR_INTEGER },
789 { "logo-opacity", VLC_VAR_INTEGER },
790 { "logo-position", VLC_VAR_INTEGER },
792 enum { num_vlogo_opts = sizeof(vlogo_optlist) / sizeof(*vlogo_optlist) };
794 opt_t *r = option < num_vlogo_opts ? vlogo_optlist+option : NULL;
796 libvlc_printerr( "Unknown logo option" );
801 void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
802 unsigned option, const char *psz_value )
804 set_string( p_mi,"logo",logo_option_bynumber(option),psz_value );
808 void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
809 unsigned option, int value )
811 set_int( p_mi, "logo", logo_option_bynumber(option), value );
815 int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
818 return get_int( p_mi, "logo", logo_option_bynumber(option) );