1 /*****************************************************************************
2 * video.c: libvlc new API video functions
3 *****************************************************************************
4 * Copyright (C) 2005 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 *GetVout( libvlc_media_player_t *p_mi,
48 libvlc_exception_t *p_exception )
50 input_thread_t *p_input = libvlc_get_input_thread( p_mi, p_exception );
51 vout_thread_t *p_vout = NULL;
55 p_vout = input_GetVout( p_input );
58 libvlc_exception_raise( p_exception );
59 libvlc_printerr( "No active video output" );
61 vlc_object_release( p_input );
66 /**********************************************************************
68 **********************************************************************/
70 void libvlc_set_fullscreen( libvlc_media_player_t *p_mi, int b_fullscreen,
71 libvlc_exception_t *p_e )
73 /* We only work on the first vout */
74 vout_thread_t *p_vout = GetVout( p_mi, p_e );
76 /* GetVout will raise the exception for us */
79 var_SetBool( p_vout, "fullscreen", b_fullscreen );
81 vlc_object_release( p_vout );
84 int libvlc_get_fullscreen( libvlc_media_player_t *p_mi,
85 libvlc_exception_t *p_e )
87 /* We only work on the first vout */
88 vout_thread_t *p_vout = GetVout( p_mi, p_e );
91 /* GetVout will raise the exception for us */
92 if( !p_vout ) return 0;
94 i_ret = var_GetBool( p_vout, "fullscreen" );
96 vlc_object_release( p_vout );
101 void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi,
102 libvlc_exception_t *p_e )
104 /* We only work on the first vout */
105 vout_thread_t *p_vout = GetVout( p_mi, p_e );
107 /* GetVout will raise the exception for us */
108 if( !p_vout ) return;
110 var_ToggleBool( p_vout, "fullscreen" );
112 vlc_object_release( p_vout );
115 void libvlc_video_set_key_input( libvlc_media_player_t *p_mi, unsigned on )
117 p_mi->keyboard_events = !!on;
120 void libvlc_video_set_mouse_input( libvlc_media_player_t *p_mi, unsigned on )
122 p_mi->mouse_events = !!on;
126 libvlc_video_take_snapshot( libvlc_media_player_t *p_mi, const char *psz_filepath,
127 unsigned int i_width, unsigned int i_height, libvlc_exception_t *p_e )
129 vout_thread_t *p_vout;
131 assert( psz_filepath );
133 /* We must have an input */
134 if( !p_mi->p_input_thread )
136 libvlc_exception_raise( p_e );
137 libvlc_printerr( "Input does not exist" );
141 /* GetVout will raise the exception for us */
142 p_vout = GetVout( p_mi, p_e );
143 if( !p_vout ) return;
145 var_SetInteger( p_vout, "snapshot-width", i_width );
146 var_SetInteger( p_vout, "snapshot-height", i_height );
148 var_SetString( p_vout, "snapshot-path", psz_filepath );
149 var_SetString( p_vout, "snapshot-format", "png" );
151 var_TriggerCallback( p_vout, "video-snapshot" );
152 vlc_object_release( p_vout );
155 int libvlc_video_get_height( libvlc_media_player_t *p_mi,
156 libvlc_exception_t *p_e )
160 vout_thread_t *p_vout = GetVout( p_mi, p_e );
161 if( !p_vout ) return 0;
163 height = p_vout->i_window_height;
165 vlc_object_release( p_vout );
170 int libvlc_video_get_width( libvlc_media_player_t *p_mi,
171 libvlc_exception_t *p_e )
175 vout_thread_t *p_vout = GetVout( p_mi, p_e );
176 if( !p_vout ) return 0;
178 width = p_vout->i_window_width;
180 vlc_object_release( p_vout );
185 int libvlc_media_player_has_vout( libvlc_media_player_t *p_mi,
186 libvlc_exception_t *p_e )
188 input_thread_t *p_input_thread = libvlc_get_input_thread(p_mi, p_e);
189 bool has_vout = false;
193 vout_thread_t *p_vout;
195 p_vout = input_GetVout( p_input_thread );
199 vlc_object_release( p_vout );
201 vlc_object_release( p_input_thread );
206 float libvlc_video_get_scale( libvlc_media_player_t *p_mp,
207 libvlc_exception_t *p_e )
209 vout_thread_t *p_vout = GetVout( p_mp, p_e );
213 float f_scale = var_GetFloat( p_vout, "scale" );
214 if( var_GetBool( p_vout, "autoscale" ) )
216 vlc_object_release( p_vout );
220 void libvlc_video_set_scale( libvlc_media_player_t *p_mp, float f_scale,
221 libvlc_exception_t *p_e )
223 vout_thread_t *p_vout = GetVout( p_mp, p_e );
228 var_SetFloat( p_vout, "scale", f_scale );
229 var_SetBool( p_vout, "autoscale", f_scale != 0. );
230 vlc_object_release( p_vout );
233 char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi,
234 libvlc_exception_t *p_e )
236 char *psz_aspect = NULL;
237 vout_thread_t *p_vout = GetVout( p_mi, p_e );
239 if( !p_vout ) return NULL;
241 psz_aspect = var_GetNonEmptyString( p_vout, "aspect-ratio" );
242 vlc_object_release( p_vout );
243 return psz_aspect ? psz_aspect : strdup("");
246 void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi,
247 const char *psz_aspect, libvlc_exception_t *p_e )
249 vout_thread_t *p_vout = GetVout( p_mi, p_e );
252 if( !p_vout ) return;
254 i_ret = var_SetString( p_vout, "aspect-ratio", psz_aspect );
255 vlc_object_release( p_vout );
258 libvlc_exception_raise( p_e );
259 libvlc_printerr( "Bad or unsupported aspect ratio" );
263 int libvlc_video_get_spu( libvlc_media_player_t *p_mi,
264 libvlc_exception_t *p_e )
266 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
267 vlc_value_t val_list;
273 if( !p_input_thread ) return -1;
275 i_ret = var_Get( p_input_thread, "spu-es", &val );
278 vlc_object_release( p_input_thread );
279 libvlc_exception_raise( p_e );
280 libvlc_printerr( "Subtitle informations not found" );
284 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
285 for( i = 0; i < val_list.p_list->i_count; i++ )
287 if( val.i_int == val_list.p_list->p_values[i].i_int )
293 var_FreeList( &val_list, NULL );
294 vlc_object_release( p_input_thread );
298 int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi,
299 libvlc_exception_t *p_e )
301 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
304 if( !p_input_thread )
307 i_spu_count = var_CountChoices( p_input_thread, "spu-es" );
309 vlc_object_release( p_input_thread );
313 libvlc_track_description_t *
314 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi,
315 libvlc_exception_t *p_e )
317 return libvlc_get_track_description( p_mi, "spu-es", p_e);
320 void libvlc_video_set_spu( libvlc_media_player_t *p_mi, int i_spu,
321 libvlc_exception_t *p_e )
323 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
324 vlc_value_t val_list;
328 if( !p_input_thread ) return;
330 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
332 if( ( val_list.p_list->i_count == 0 )
333 || (i_spu < 0) || (i_spu > val_list.p_list->i_count) )
335 libvlc_exception_raise( p_e );
336 libvlc_printerr( "Subtitle number out of range" );
340 newval = val_list.p_list->p_values[i_spu];
341 i_ret = var_Set( p_input_thread, "spu-es", newval );
344 libvlc_exception_raise( p_e );
345 libvlc_printerr( "Subtitle selection error" );
349 var_FreeList( &val_list, NULL );
350 vlc_object_release( p_input_thread );
353 int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi,
354 const char *psz_subtitle,
355 libvlc_exception_t *p_e )
357 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
362 if( !input_AddSubtitle( p_input_thread, psz_subtitle, true ) )
364 vlc_object_release( p_input_thread );
369 libvlc_track_description_t *
370 libvlc_video_get_title_description( libvlc_media_player_t *p_mi,
371 libvlc_exception_t * p_e )
373 return libvlc_get_track_description( p_mi, "title", p_e);
376 libvlc_track_description_t *
377 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
379 libvlc_exception_t *p_e )
382 sprintf( psz_title, "title %2i", i_title );
383 return libvlc_get_track_description( p_mi, psz_title, p_e);
386 char *libvlc_video_get_crop_geometry( libvlc_media_player_t *p_mi,
387 libvlc_exception_t *p_e )
389 char *psz_geometry = 0;
390 vout_thread_t *p_vout = GetVout( p_mi, p_e );
392 if( !p_vout ) return 0;
394 psz_geometry = var_GetNonEmptyString( p_vout, "crop" );
395 vlc_object_release( p_vout );
396 return psz_geometry ? psz_geometry : strdup("");
399 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
400 const char *psz_geometry, libvlc_exception_t *p_e )
402 vout_thread_t *p_vout = GetVout( p_mi, p_e );
405 if( !p_vout ) return;
407 i_ret = var_SetString( p_vout, "crop", psz_geometry );
408 vlc_object_release( p_vout );
412 libvlc_exception_raise( p_e );
413 libvlc_printerr( "Bad or unsupported cropping geometry" );
417 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi,
418 libvlc_exception_t *p_e )
421 vout_thread_t *p_vout = GetVout( p_mi, p_e );
425 if( !p_vout ) return i_ret;
427 p_vbi = (vlc_object_t *) vlc_object_find_name( p_vout, "zvbi",
431 i_ret = var_GetInteger( p_vbi, "vbi-page" );
432 vlc_object_release( p_vbi );
435 vlc_object_release( p_vout );
444 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page,
445 libvlc_exception_t *p_e )
448 vout_thread_t *p_vout = GetVout( p_mi, p_e );
452 if( !p_vout ) return;
454 p_vbi = (vlc_object_t *) vlc_object_find_name( p_vout, "zvbi",
458 i_ret = var_SetInteger( p_vbi, "vbi-page", i_page );
459 vlc_object_release( p_vbi );
461 libvlc_exception_raise( p_e,
462 "Unexpected error while setting teletext page" );
464 vlc_object_release( p_vout );
468 VLC_UNUSED( i_page );
472 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi,
473 libvlc_exception_t *p_e )
475 input_thread_t *p_input_thread;
477 p_input_thread = libvlc_get_input_thread(p_mi, p_e);
478 if( !p_input_thread ) return;
480 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
482 vlc_object_release( p_input_thread );
485 const bool b_selected = var_GetInteger( p_input_thread, "teletext-es" ) >= 0;
489 p_vbi = (vlc_object_t *)vlc_object_find_name( p_input_thread, "zvbi",
495 /* FIXME Gni, why that ? */
496 i_ret = var_SetInteger( p_vbi, "vbi-page",
497 var_GetInteger( p_vbi, "vbi-page" ) );
499 libvlc_exception_raise( p_e,
500 "Unexpected error while setting teletext page" );
505 i_ret = var_SetBool( p_vbi, "vbi-opaque",
506 !var_GetBool( p_vbi, "vbi-opaque" ) );
508 libvlc_exception_raise( p_e,
509 "Unexpected error while setting teletext transparency" );
511 vlc_object_release( p_vbi );
517 var_SetInteger( p_input_thread, "spu-es", -1 );
522 if( !var_Change( p_input_thread, "teletext-es", VLC_VAR_GETLIST, &list, NULL ) )
524 if( list.p_list->i_count > 0 )
525 var_SetInteger( p_input_thread, "spu-es", list.p_list->p_values[0].i_int );
527 var_FreeList( &list, NULL );
530 vlc_object_release( p_input_thread );
533 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi,
534 libvlc_exception_t *p_e )
536 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
539 if( !p_input_thread )
542 i_track_count = var_CountChoices( p_input_thread, "video-es" );
544 vlc_object_release( p_input_thread );
545 return i_track_count;
548 libvlc_track_description_t *
549 libvlc_video_get_track_description( libvlc_media_player_t *p_mi,
550 libvlc_exception_t *p_e )
552 return libvlc_get_track_description( p_mi, "video-es", p_e);
555 int libvlc_video_get_track( libvlc_media_player_t *p_mi,
556 libvlc_exception_t *p_e )
558 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
559 vlc_value_t val_list;
565 if( !p_input_thread )
568 i_ret = var_Get( p_input_thread, "video-es", &val );
571 libvlc_exception_raise( p_e );
572 libvlc_printerr( "Video track information not found" );
573 vlc_object_release( p_input_thread );
577 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
578 for( i = 0; i < val_list.p_list->i_count; i++ )
580 if( val_list.p_list->p_values[i].i_int == val.i_int )
586 var_FreeList( &val_list, NULL );
587 vlc_object_release( p_input_thread );
591 void libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track,
592 libvlc_exception_t *p_e )
594 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
595 vlc_value_t val_list;
599 if( !p_input_thread )
602 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
603 for( i = 0; i < val_list.p_list->i_count; i++ )
605 if( i_track == val_list.p_list->p_values[i].i_int )
607 i_ret = var_SetInteger( p_input_thread, "video-es", i_track );
613 libvlc_exception_raise( p_e );
614 libvlc_printerr( "Video track number out of range" );
616 var_FreeList( &val_list, NULL );
617 vlc_object_release( p_input_thread );
620 /******************************************************************************
621 * libvlc_video_set_deinterlace : enable deinterlace
622 *****************************************************************************/
623 void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi, int b_enable,
624 const char *psz_mode,
625 libvlc_exception_t *p_e )
627 vout_thread_t *p_vout = GetVout( p_mi, p_e );
634 /* be sure that the filter name given is supported */
635 if( !strcmp(psz_mode, "blend") || !strcmp(psz_mode, "bob")
636 || !strcmp(psz_mode, "discard") || !strcmp(psz_mode, "linear")
637 || !strcmp(psz_mode, "mean") || !strcmp(psz_mode, "x")
638 || !strcmp(psz_mode, "yadif") || !strcmp(psz_mode, "yadif2x") )
640 /* set deinterlace filter chosen */
641 var_SetString( p_vout, "deinterlace-mode", psz_mode );
642 var_SetInteger( p_vout, "deinterlace", 1 );
646 libvlc_exception_raise( p_e );
647 libvlc_printerr( "Bad or unsupported deinterlacing mode" );
652 /* disable deinterlace filter */
653 var_SetInteger( p_vout, "deinterlace", 0 );
656 vlc_object_release( p_vout );
659 /*****************************************************************************
660 * Marquee: FIXME: That implementation has no persistent state and requires
662 *****************************************************************************/
664 static const char *get_marquee_int_option_identifier(unsigned option)
666 static const char tab[][16] =
678 if( option >= sizeof( tab ) / sizeof( tab[0] ) )
683 static const char *get_marquee_string_option_identifier(unsigned option)
685 static const char tab[][16] =
689 if( option >= sizeof( tab ) / sizeof( tab[0] ) )
695 static vlc_object_t *get_marquee_object( libvlc_media_player_t * p_mi )
697 libvlc_exception_t e;
698 libvlc_exception_init(&e);
699 vout_thread_t * vout = GetVout( p_mi, &e );
700 libvlc_exception_clear(&e);
703 vlc_object_t * object = vlc_object_find_name( vout, "marq", FIND_CHILD );
704 vlc_object_release(vout);
708 /*****************************************************************************
709 * libvlc_video_get_marquee_option_as_int : get a marq option value
710 *****************************************************************************/
711 int libvlc_video_get_marquee_option_as_int( libvlc_media_player_t *p_mi,
712 libvlc_video_marquee_int_option_t option,
713 libvlc_exception_t *p_e )
715 const char * identifier = get_marquee_int_option_identifier(option);
718 libvlc_exception_raise( p_e );
719 libvlc_printerr( "Unknown marquee option" );
722 vlc_object_t * marquee = get_marquee_object(p_mi);
724 /* Handle the libvlc_marquee_Enabled separately */
725 if(option == libvlc_marquee_Enabled)
727 bool isEnabled = marquee != NULL;
728 vlc_object_release(marquee);
735 libvlc_exception_raise( p_e );
736 libvlc_printerr( "Marquee not enabled" );
739 #warning This and the next function may crash due to type checking!
740 int ret = var_GetInteger(marquee, identifier);
741 vlc_object_release(marquee);
745 /*****************************************************************************
746 * libvlc_video_get_marquee_option_as_string : get a marq option value
747 *****************************************************************************/
748 char * libvlc_video_get_marquee_option_as_string( libvlc_media_player_t *p_mi,
749 libvlc_video_marquee_string_option_t option,
750 libvlc_exception_t *p_e )
752 const char * identifier = get_marquee_string_option_identifier(option);
755 libvlc_exception_raise( p_e );
756 libvlc_printerr( "Unknown marquee option" );
760 vlc_object_t * marquee = get_marquee_object(p_mi);
763 libvlc_exception_raise( p_e );
764 libvlc_printerr( "Marquee not enabled" );
767 char *ret = var_GetString(marquee, identifier);
768 vlc_object_release(marquee);
772 /*****************************************************************************
773 * libvlc_video_set_marquee_option_as_int: enable, disable or set an int option
774 *****************************************************************************/
775 void libvlc_video_set_marquee_option_as_int( libvlc_media_player_t *p_mi,
776 libvlc_video_marquee_int_option_t option,
777 int value, libvlc_exception_t *p_e )
779 const char * identifier = get_marquee_int_option_identifier(option);
782 libvlc_exception_raise( p_e );
783 libvlc_printerr( "Unknown marquee option" );
787 /* Handle the libvlc_marquee_Enabled separately */
788 if(option == libvlc_marquee_Enabled)
790 libvlc_exception_t e;
791 libvlc_exception_init(&e);
792 vout_thread_t * vout = GetVout( p_mi, &e );
793 libvlc_exception_clear(&e);
796 vout_EnableFilter(vout, identifier, value, false);
797 vlc_object_release(vout);
802 vlc_object_t * marquee = get_marquee_object(p_mi);
805 libvlc_exception_raise( p_e );
806 libvlc_printerr( "Marquee not enabled" );
809 var_SetInteger(marquee, identifier, value);
810 vlc_object_release(marquee);
813 /*****************************************************************************
814 * libvlc_video_set_marquee_option_as_string: set a string option
815 *****************************************************************************/
816 void libvlc_video_set_marquee_option_as_string( libvlc_media_player_t *p_mi,
817 libvlc_video_marquee_string_option_t option,
819 libvlc_exception_t *p_e )
821 const char * identifier = get_marquee_string_option_identifier(option);
824 libvlc_exception_raise( p_e );
825 libvlc_printerr( "Unknown marquee option" );
828 vlc_object_t * marquee = get_marquee_object(p_mi);
831 libvlc_exception_raise( p_e );
832 libvlc_printerr( "Marquee not enabled" );
835 var_SetString(marquee, identifier, value);
836 vlc_object_release(marquee);