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 *****************************************************************************/
28 #include "libvlc_internal.h"
30 #include <vlc/libvlc.h>
31 #include <vlc_input.h>
35 * Remember to release the returned vout_thread_t.
37 static vout_thread_t *GetVout( libvlc_media_player_t *p_mi,
38 libvlc_exception_t *p_exception )
40 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_exception );
41 vout_thread_t *p_vout = NULL;
45 p_vout = vlc_object_find( p_input_thread, VLC_OBJECT_VOUT, FIND_CHILD );
48 libvlc_exception_raise( p_exception, "No active video output" );
50 vlc_object_release( p_input_thread );
55 /**********************************************************************
57 **********************************************************************/
59 void libvlc_set_fullscreen( libvlc_media_player_t *p_mi, int b_fullscreen,
60 libvlc_exception_t *p_e )
62 /* We only work on the first vout */
63 vout_thread_t *p_vout = GetVout( p_mi, p_e );
65 /* GetVout will raise the exception for us */
68 var_SetBool( p_vout, "fullscreen", b_fullscreen );
70 vlc_object_release( p_vout );
73 int libvlc_get_fullscreen( libvlc_media_player_t *p_mi,
74 libvlc_exception_t *p_e )
76 /* We only work on the first vout */
77 vout_thread_t *p_vout = GetVout( p_mi, p_e );
80 /* GetVout will raise the exception for us */
81 if( !p_vout ) return 0;
83 i_ret = var_GetBool( p_vout, "fullscreen" );
85 vlc_object_release( p_vout );
90 void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi,
91 libvlc_exception_t *p_e )
93 /* We only work on the first vout */
94 vout_thread_t *p_vout = GetVout( p_mi, p_e );
97 /* GetVout will raise the exception for us */
100 ret = var_GetBool( p_vout, "fullscreen" );
101 var_SetBool( p_vout, "fullscreen", !ret );
103 vlc_object_release( p_vout );
107 libvlc_video_take_snapshot( libvlc_media_player_t *p_mi, char *psz_filepath,
108 unsigned int i_width, unsigned int i_height, libvlc_exception_t *p_e )
110 vout_thread_t *p_vout = GetVout( p_mi, p_e );
111 input_thread_t *p_input_thread;
113 /* GetVout will raise the exception for us */
114 if( !p_vout ) return;
118 libvlc_exception_raise( p_e, "filepath is null" );
122 var_SetInteger( p_vout, "snapshot-width", i_width );
123 var_SetInteger( p_vout, "snapshot-height", i_height );
125 p_input_thread = p_mi->p_input_thread;
126 if( !p_mi->p_input_thread )
128 libvlc_exception_raise( p_e, "Input does not exist" );
132 var_SetString( p_vout, "snapshot-path", psz_filepath );
133 var_SetString( p_vout, "snapshot-format", "png" );
135 var_TriggerCallback( p_vout, "video-snapshot" );
136 vlc_object_release( p_vout );
139 int libvlc_video_get_height( libvlc_media_player_t *p_mi,
140 libvlc_exception_t *p_e )
144 vout_thread_t *p_vout = GetVout( p_mi, p_e );
145 if( !p_vout ) return 0;
147 height = p_vout->i_window_height;
149 vlc_object_release( p_vout );
154 int libvlc_video_get_width( libvlc_media_player_t *p_mi,
155 libvlc_exception_t *p_e )
159 vout_thread_t *p_vout = GetVout( p_mi, p_e );
160 if( !p_vout ) return 0;
162 width = p_vout->i_window_width;
164 vlc_object_release( p_vout );
169 int libvlc_media_player_has_vout( libvlc_media_player_t *p_mi,
170 libvlc_exception_t *p_e )
172 input_thread_t *p_input_thread = libvlc_get_input_thread(p_mi, p_e);
173 bool has_vout = false;
177 vout_thread_t *p_vout;
179 p_vout = vlc_object_find( p_input_thread, VLC_OBJECT_VOUT, FIND_CHILD );
183 vlc_object_release( p_vout );
185 vlc_object_release( p_input_thread );
190 int libvlc_video_reparent( libvlc_media_player_t *p_mi, libvlc_drawable_t d,
191 libvlc_exception_t *p_e )
193 (void) p_mi; (void) d;
194 libvlc_exception_raise(p_e, "Reparenting not supported");
198 void libvlc_video_resize( libvlc_media_player_t *p_mi, int width, int height, libvlc_exception_t *p_e )
200 vout_thread_t *p_vout = GetVout( p_mi, p_e );
203 vout_Control( p_vout, VOUT_SET_SIZE, width, height );
204 vlc_object_release( p_vout );
208 void libvlc_video_redraw_rectangle( libvlc_media_player_t *p_mi,
209 const libvlc_rectangle_t *area,
210 libvlc_exception_t *p_e )
214 && ((area->bottom - area->top) > 0)
215 && ((area->right - area->left) > 0) )
217 vout_thread_t *p_vout = GetVout( p_mi, p_e );
220 /* tell running vout to redraw area */
221 vout_Control( p_vout , VOUT_REDRAW_RECT,
222 area->top, area->left, area->bottom, area->right );
223 vlc_object_release( p_vout );
227 (void) p_mi; (void) area; (void) p_e;
231 /* global video settings */
233 /* Deprecated use libvlc_media_player_set_drawable() */
234 void libvlc_video_set_parent( libvlc_instance_t *p_instance, libvlc_drawable_t d,
235 libvlc_exception_t *p_e )
237 /* set as default for future vout instances */
241 if( sizeof(HWND) > sizeof(libvlc_drawable_t) )
242 return; /* BOOM! we told you not to use this function! */
243 val.p_address = (void *)(uintptr_t)d;
244 var_Set( p_instance->p_libvlc_int, "drawable-hwnd", val );
245 #elif defined(__APPLE__)
246 var_SetInteger( p_instance->p_libvlc_int, "drawable-agl", d );
248 var_SetInteger( p_instance->p_libvlc_int, "drawable-xid", d );
251 libvlc_media_player_t *p_mi = libvlc_playlist_get_media_player(p_instance, p_e);
254 libvlc_media_player_set_drawable( p_mi, d, p_e );
255 libvlc_media_player_release(p_mi);
259 /* Deprecated use libvlc_media_player_get_drawable() */
260 libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
267 if( sizeof(HWND) > sizeof(libvlc_drawable_t) )
269 var_Get( p_instance->p_libvlc_int, "drawable-hwnd", &val );
270 return (uintptr_t)val.p_address;
271 #elif defined(__APPLE__)
272 return var_GetInteger( p_instance->p_libvlc_int, "drawable-agl" );
274 return var_GetInteger( p_instance->p_libvlc_int, "drawable-xid" );
278 void libvlc_video_set_size( libvlc_instance_t *p_instance, int width, int height,
279 libvlc_exception_t *p_e )
281 /* set as default for future vout instances */
282 config_PutInt(p_instance->p_libvlc_int, "width", width);
283 config_PutInt(p_instance->p_libvlc_int, "height", height);
285 libvlc_media_player_t *p_mi = libvlc_playlist_get_media_player(p_instance, p_e);
288 vout_thread_t *p_vout = GetVout( p_mi, p_e );
291 /* tell running vout to re-size */
292 vout_Control( p_vout , VOUT_SET_SIZE, width, height);
293 vlc_object_release( p_vout );
295 libvlc_media_player_release(p_mi);
299 void libvlc_video_set_viewport( libvlc_instance_t *p_instance,
300 const libvlc_rectangle_t *view, const libvlc_rectangle_t *clip,
301 libvlc_exception_t *p_e )
306 libvlc_exception_raise( p_e, "viewport is NULL" );
310 /* if clip is NULL, then use view rectangle as clip */
314 /* set as default for future vout instances */
315 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-top", view->top );
316 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-left", view->left );
317 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-bottom", view->bottom );
318 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-right", view->right );
319 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-top", clip->top );
320 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-left", clip->left );
321 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-bottom", clip->bottom );
322 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-right", clip->right );
324 libvlc_media_player_t *p_mi = libvlc_playlist_get_media_player(p_instance, p_e);
327 vout_thread_t *p_vout = GetVout( p_mi, p_e );
330 /* change viewport for running vout */
331 vout_Control( p_vout , VOUT_SET_VIEWPORT,
332 view->top, view->left, view->bottom, view->right,
333 clip->top, clip->left, clip->bottom, clip->right );
334 vlc_object_release( p_vout );
336 libvlc_media_player_release(p_mi);
339 (void) p_instance; (void) view; (void) clip; (void) p_e;
343 char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi,
344 libvlc_exception_t *p_e )
346 char *psz_aspect = 0;
347 vout_thread_t *p_vout = GetVout( p_mi, p_e );
349 if( !p_vout ) return 0;
351 psz_aspect = var_GetNonEmptyString( p_vout, "aspect-ratio" );
352 vlc_object_release( p_vout );
353 return psz_aspect ? psz_aspect : strdup("");
356 void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi,
357 char *psz_aspect, libvlc_exception_t *p_e )
359 vout_thread_t *p_vout = GetVout( p_mi, p_e );
362 if( !p_vout ) return;
364 i_ret = var_SetString( p_vout, "aspect-ratio", psz_aspect );
366 libvlc_exception_raise( p_e,
367 "Unexpected error while setting aspect-ratio value" );
369 vlc_object_release( p_vout );
372 int libvlc_video_get_spu( libvlc_media_player_t *p_mi,
373 libvlc_exception_t *p_e )
375 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
376 vlc_value_t val_list;
382 if( !p_input_thread ) return -1;
384 i_ret = var_Get( p_input_thread, "spu-es", &val );
387 libvlc_exception_raise( p_e, "Getting subtitle information failed" );
388 vlc_object_release( p_input_thread );
392 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
393 for( i = 0; i < val_list.p_list->i_count; i++ )
395 vlc_value_t spu_val = val_list.p_list->p_values[i];
396 if( val.i_int == spu_val.i_int )
402 vlc_object_release( p_input_thread );
406 int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi,
407 libvlc_exception_t *p_e )
409 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
410 vlc_value_t val_list;
412 if( !p_input_thread )
415 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
416 vlc_object_release( p_input_thread );
417 return val_list.p_list->i_count;
420 libvlc_track_description_t *
421 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi,
422 libvlc_exception_t *p_e )
424 return libvlc_get_track_description( p_mi, "spu-es", p_e);
427 void libvlc_video_set_spu( libvlc_media_player_t *p_mi, int i_spu,
428 libvlc_exception_t *p_e )
430 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
431 vlc_value_t val_list;
435 if( !p_input_thread ) return;
437 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
439 if( val_list.p_list->i_count == 0 )
441 libvlc_exception_raise( p_e, "Subtitle value out of range" );
442 vlc_object_release( p_input_thread );
446 if( (i_spu < 0) && (i_spu > val_list.p_list->i_count) )
448 libvlc_exception_raise( p_e, "Subtitle value out of range" );
449 vlc_object_release( p_input_thread );
453 newval = val_list.p_list->p_values[i_spu];
454 i_ret = var_Set( p_input_thread, "spu-es", newval );
457 libvlc_exception_raise( p_e, "Setting subtitle value failed" );
459 vlc_object_release( p_input_thread );
462 int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi,
464 libvlc_exception_t *p_e )
466 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
471 if( !input_AddSubtitle( p_input_thread, psz_subtitle, true ) )
473 vlc_object_release( p_input_thread );
478 libvlc_track_description_t *
479 libvlc_video_get_title_description( libvlc_media_player_t *p_mi,
480 libvlc_exception_t * p_e )
482 return libvlc_get_track_description( p_mi, "title", p_e);
485 libvlc_track_description_t *
486 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
488 libvlc_exception_t *p_e )
491 sprintf( psz_title, "title %2i", i_title );
492 return libvlc_get_track_description( p_mi, psz_title, p_e);
495 char *libvlc_video_get_crop_geometry( libvlc_media_player_t *p_mi,
496 libvlc_exception_t *p_e )
498 char *psz_geometry = 0;
499 vout_thread_t *p_vout = GetVout( p_mi, p_e );
501 if( !p_vout ) return 0;
503 psz_geometry = var_GetNonEmptyString( p_vout, "crop" );
504 vlc_object_release( p_vout );
505 return psz_geometry ? psz_geometry : strdup("");
508 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
509 char *psz_geometry, libvlc_exception_t *p_e )
511 vout_thread_t *p_vout = GetVout( p_mi, p_e );
514 if( !p_vout ) return;
516 i_ret = var_SetString( p_vout, "crop", psz_geometry );
518 libvlc_exception_raise( p_e,
519 "Unexpected error while setting crop geometry" );
521 vlc_object_release( p_vout );
524 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi,
525 libvlc_exception_t *p_e )
527 vout_thread_t *p_vout = GetVout( p_mi, p_e );
531 if( !p_vout ) return i_ret;
533 p_vbi = (vlc_object_t *) vlc_object_find_name( p_vout, "zvbi",
537 i_ret = var_GetInteger( p_vbi, "vbi-page" );
538 vlc_object_release( p_vbi );
541 vlc_object_release( p_vout );
545 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page,
546 libvlc_exception_t *p_e )
548 vout_thread_t *p_vout = GetVout( p_mi, p_e );
552 if( !p_vout ) return;
554 p_vbi = (vlc_object_t *) vlc_object_find_name( p_vout, "zvbi",
558 i_ret = var_SetInteger( p_vbi, "vbi-page", i_page );
559 vlc_object_release( p_vbi );
561 libvlc_exception_raise( p_e,
562 "Unexpected error while setting teletext page" );
564 vlc_object_release( p_vout );
567 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi,
568 libvlc_exception_t *p_e )
570 input_thread_t *p_input_thread;
574 p_input_thread = libvlc_get_input_thread(p_mi, p_e);
575 if( !p_input_thread ) return;
577 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
579 vlc_object_release( p_input_thread );
582 const bool b_selected = var_GetInteger( p_input_thread, "teletext-es" ) >= 0;
584 p_vbi = (vlc_object_t *)vlc_object_find_name( p_input_thread, "zvbi",
590 /* FIXME Gni, why that ? */
591 i_ret = var_SetInteger( p_vbi, "vbi-page",
592 var_GetInteger( p_vbi, "vbi-page" ) );
594 libvlc_exception_raise( p_e,
595 "Unexpected error while setting teletext page" );
600 i_ret = var_SetBool( p_vbi, "vbi-opaque",
601 !var_GetBool( p_vbi, "vbi-opaque" ) );
603 libvlc_exception_raise( p_e,
604 "Unexpected error while setting teletext transparency" );
606 vlc_object_release( p_vbi );
608 else if( b_selected )
610 var_SetInteger( p_input_thread, "spu-es", -1 );
615 if( !var_Change( p_input_thread, "teletext-es", VLC_VAR_GETLIST, &list, NULL ) )
617 if( list.p_list->i_count > 0 )
618 var_SetInteger( p_input_thread, "spu-es", list.p_list->p_values[0].i_int );
620 var_Change( p_input_thread, "teletext-es", VLC_VAR_FREELIST, &list, NULL );
623 vlc_object_release( p_input_thread );
626 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi,
627 libvlc_exception_t *p_e )
629 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
630 vlc_value_t val_list;
632 if( !p_input_thread )
635 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
636 vlc_object_release( p_input_thread );
637 return val_list.p_list->i_count;
640 libvlc_track_description_t *
641 libvlc_video_get_track_description( libvlc_media_player_t *p_mi,
642 libvlc_exception_t *p_e )
644 return libvlc_get_track_description( p_mi, "video-es", p_e);
647 int libvlc_video_get_track( libvlc_media_player_t *p_mi,
648 libvlc_exception_t *p_e )
650 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
651 vlc_value_t val_list;
657 if( !p_input_thread )
660 i_ret = var_Get( p_input_thread, "video-es", &val );
663 libvlc_exception_raise( p_e, "Getting Video track information failed" );
664 vlc_object_release( p_input_thread );
668 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
669 for( i = 0; i < val_list.p_list->i_count; i++ )
671 vlc_value_t track_val = val_list.p_list->p_values[i];
672 if( track_val.i_int == val.i_int )
678 vlc_object_release( p_input_thread );
682 void libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track,
683 libvlc_exception_t *p_e )
685 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
686 vlc_value_t val_list;
690 if( !p_input_thread )
693 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
694 for( i = 0; i < val_list.p_list->i_count; i++ )
696 vlc_value_t val = val_list.p_list->p_values[i];
697 if( i_track == val.i_int )
699 i_ret = var_Set( p_input_thread, "audio-es", val );
701 libvlc_exception_raise( p_e, "Setting video track failed" );
702 vlc_object_release( p_input_thread );
706 libvlc_exception_raise( p_e, "Video track out of range" );
707 vlc_object_release( p_input_thread );
710 int libvlc_video_destroy( libvlc_media_player_t *p_mi,
711 libvlc_exception_t *p_e )
713 vout_thread_t *p_vout = GetVout( p_mi, p_e );
714 vlc_object_detach( p_vout );
715 vlc_object_release( p_vout );
716 vlc_object_release( p_vout );