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 );
246 var_SetInteger( p_instance->p_libvlc_int, "drawable-xid", d );
249 libvlc_media_player_t *p_mi = libvlc_playlist_get_media_player(p_instance, p_e);
252 libvlc_media_player_set_drawable( p_mi, d, p_e );
253 libvlc_media_player_release(p_mi);
257 /* Deprecated use libvlc_media_player_get_drawable() */
258 libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
265 if( sizeof(HWND) > sizeof(libvlc_drawable_t) )
267 var_Get( p_instance->p_libvlc_int, "drawable-hwnd", &val );
268 return (uintptr_t)val.p_address;
270 return var_GetInteger( p_instance->p_libvlc_int, "drawable-xid" );
275 void libvlc_video_set_size( libvlc_instance_t *p_instance, int width, int height,
276 libvlc_exception_t *p_e )
278 /* set as default for future vout instances */
279 config_PutInt(p_instance->p_libvlc_int, "width", width);
280 config_PutInt(p_instance->p_libvlc_int, "height", height);
282 libvlc_media_player_t *p_mi = libvlc_playlist_get_media_player(p_instance, p_e);
285 vout_thread_t *p_vout = GetVout( p_mi, p_e );
288 /* tell running vout to re-size */
289 vout_Control( p_vout , VOUT_SET_SIZE, width, height);
290 vlc_object_release( p_vout );
292 libvlc_media_player_release(p_mi);
296 void libvlc_video_set_viewport( libvlc_instance_t *p_instance,
297 const libvlc_rectangle_t *view, const libvlc_rectangle_t *clip,
298 libvlc_exception_t *p_e )
303 libvlc_exception_raise( p_e, "viewport is NULL" );
307 /* if clip is NULL, then use view rectangle as clip */
311 /* set as default for future vout instances */
312 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-top", view->top );
313 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-left", view->left );
314 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-bottom", view->bottom );
315 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-right", view->right );
316 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-top", clip->top );
317 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-left", clip->left );
318 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-bottom", clip->bottom );
319 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-right", clip->right );
321 libvlc_media_player_t *p_mi = libvlc_playlist_get_media_player(p_instance, p_e);
324 vout_thread_t *p_vout = GetVout( p_mi, p_e );
327 /* change viewport for running vout */
328 vout_Control( p_vout , VOUT_SET_VIEWPORT,
329 view->top, view->left, view->bottom, view->right,
330 clip->top, clip->left, clip->bottom, clip->right );
331 vlc_object_release( p_vout );
333 libvlc_media_player_release(p_mi);
336 (void) p_instance; (void) view; (void) clip; (void) p_e;
340 char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi,
341 libvlc_exception_t *p_e )
343 char *psz_aspect = 0;
344 vout_thread_t *p_vout = GetVout( p_mi, p_e );
346 if( !p_vout ) return 0;
348 psz_aspect = var_GetNonEmptyString( p_vout, "aspect-ratio" );
349 vlc_object_release( p_vout );
350 return psz_aspect ? psz_aspect : strdup("");
353 void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi,
354 char *psz_aspect, libvlc_exception_t *p_e )
356 vout_thread_t *p_vout = GetVout( p_mi, p_e );
359 if( !p_vout ) return;
361 i_ret = var_SetString( p_vout, "aspect-ratio", psz_aspect );
363 libvlc_exception_raise( p_e,
364 "Unexpected error while setting aspect-ratio value" );
366 vlc_object_release( p_vout );
369 int libvlc_video_get_spu( libvlc_media_player_t *p_mi,
370 libvlc_exception_t *p_e )
372 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
373 vlc_value_t val_list;
379 if( !p_input_thread ) return -1;
381 i_ret = var_Get( p_input_thread, "spu-es", &val );
384 libvlc_exception_raise( p_e, "Getting subtitle information failed" );
385 vlc_object_release( p_input_thread );
389 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
390 for( i = 0; i < val_list.p_list->i_count; i++ )
392 vlc_value_t spu_val = val_list.p_list->p_values[i];
393 if( val.i_int == spu_val.i_int )
399 vlc_object_release( p_input_thread );
403 int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi,
404 libvlc_exception_t *p_e )
406 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
407 vlc_value_t val_list;
409 if( !p_input_thread )
412 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
413 vlc_object_release( p_input_thread );
414 return val_list.p_list->i_count;
417 libvlc_track_description_t *
418 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi,
419 libvlc_exception_t *p_e )
421 return libvlc_get_track_description( p_mi, "spu-es", p_e);
424 void libvlc_video_set_spu( libvlc_media_player_t *p_mi, int i_spu,
425 libvlc_exception_t *p_e )
427 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
428 vlc_value_t val_list;
432 if( !p_input_thread ) return;
434 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
436 if( val_list.p_list->i_count == 0 )
438 libvlc_exception_raise( p_e, "Subtitle value out of range" );
439 vlc_object_release( p_input_thread );
443 if( (i_spu < 0) && (i_spu > val_list.p_list->i_count) )
445 libvlc_exception_raise( p_e, "Subtitle value out of range" );
446 vlc_object_release( p_input_thread );
450 newval = val_list.p_list->p_values[i_spu];
451 i_ret = var_Set( p_input_thread, "spu-es", newval );
454 libvlc_exception_raise( p_e, "Setting subtitle value failed" );
456 vlc_object_release( p_input_thread );
459 int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi,
461 libvlc_exception_t *p_e )
463 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
468 if( !input_AddSubtitle( p_input_thread, psz_subtitle, true ) )
470 vlc_object_release( p_input_thread );
475 libvlc_track_description_t *
476 libvlc_video_get_title_description( libvlc_media_player_t *p_mi,
477 libvlc_exception_t * p_e )
479 return libvlc_get_track_description( p_mi, "title", p_e);
482 libvlc_track_description_t *
483 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
485 libvlc_exception_t *p_e )
488 sprintf( psz_title, "title %2i", i_title );
489 return libvlc_get_track_description( p_mi, psz_title, p_e);
492 char *libvlc_video_get_crop_geometry( libvlc_media_player_t *p_mi,
493 libvlc_exception_t *p_e )
495 char *psz_geometry = 0;
496 vout_thread_t *p_vout = GetVout( p_mi, p_e );
498 if( !p_vout ) return 0;
500 psz_geometry = var_GetNonEmptyString( p_vout, "crop" );
501 vlc_object_release( p_vout );
502 return psz_geometry ? psz_geometry : strdup("");
505 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
506 char *psz_geometry, libvlc_exception_t *p_e )
508 vout_thread_t *p_vout = GetVout( p_mi, p_e );
511 if( !p_vout ) return;
513 i_ret = var_SetString( p_vout, "crop", psz_geometry );
515 libvlc_exception_raise( p_e,
516 "Unexpected error while setting crop geometry" );
518 vlc_object_release( p_vout );
521 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi,
522 libvlc_exception_t *p_e )
524 vout_thread_t *p_vout = GetVout( p_mi, p_e );
528 if( !p_vout ) return i_ret;
530 p_vbi = (vlc_object_t *) vlc_object_find_name( p_vout, "zvbi",
534 i_ret = var_GetInteger( p_vbi, "vbi-page" );
535 vlc_object_release( p_vbi );
538 vlc_object_release( p_vout );
542 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page,
543 libvlc_exception_t *p_e )
545 vout_thread_t *p_vout = GetVout( p_mi, p_e );
549 if( !p_vout ) return;
551 p_vbi = (vlc_object_t *) vlc_object_find_name( p_vout, "zvbi",
555 i_ret = var_SetInteger( p_vbi, "vbi-page", i_page );
556 vlc_object_release( p_vbi );
558 libvlc_exception_raise( p_e,
559 "Unexpected error while setting teletext page" );
561 vlc_object_release( p_vout );
564 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi,
565 libvlc_exception_t *p_e )
567 input_thread_t *p_input_thread;
571 p_input_thread = libvlc_get_input_thread(p_mi, p_e);
572 if( !p_input_thread ) return;
574 if( var_CountChoices( p_input_thread, "teletext-es" ) <= 0 )
576 vlc_object_release( p_input_thread );
579 const bool b_selected = var_GetInteger( p_input_thread, "teletext-es" ) >= 0;
581 p_vbi = (vlc_object_t *)vlc_object_find_name( p_input_thread, "zvbi",
587 /* FIXME Gni, why that ? */
588 i_ret = var_SetInteger( p_vbi, "vbi-page",
589 var_GetInteger( p_vbi, "vbi-page" ) );
591 libvlc_exception_raise( p_e,
592 "Unexpected error while setting teletext page" );
597 i_ret = var_SetBool( p_vbi, "vbi-opaque",
598 !var_GetBool( p_vbi, "vbi-opaque" ) );
600 libvlc_exception_raise( p_e,
601 "Unexpected error while setting teletext transparency" );
603 vlc_object_release( p_vbi );
605 else if( b_selected )
607 var_SetInteger( p_input_thread, "spu-es", -1 );
612 if( !var_Change( p_input_thread, "teletext-es", VLC_VAR_GETLIST, &list, NULL ) )
614 if( list.p_list->i_count > 0 )
615 var_SetInteger( p_input_thread, "spu-es", list.p_list->p_values[0].i_int );
617 var_Change( p_input_thread, "teletext-es", VLC_VAR_FREELIST, &list, NULL );
620 vlc_object_release( p_input_thread );
623 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi,
624 libvlc_exception_t *p_e )
626 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
627 vlc_value_t val_list;
629 if( !p_input_thread )
632 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
633 vlc_object_release( p_input_thread );
634 return val_list.p_list->i_count;
637 libvlc_track_description_t *
638 libvlc_video_get_track_description( libvlc_media_player_t *p_mi,
639 libvlc_exception_t *p_e )
641 return libvlc_get_track_description( p_mi, "video-es", p_e);
644 int libvlc_video_get_track( libvlc_media_player_t *p_mi,
645 libvlc_exception_t *p_e )
647 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
648 vlc_value_t val_list;
654 if( !p_input_thread )
657 i_ret = var_Get( p_input_thread, "video-es", &val );
660 libvlc_exception_raise( p_e, "Getting Video track information failed" );
661 vlc_object_release( p_input_thread );
665 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
666 for( i = 0; i < val_list.p_list->i_count; i++ )
668 vlc_value_t track_val = val_list.p_list->p_values[i];
669 if( track_val.i_int == val.i_int )
675 vlc_object_release( p_input_thread );
679 void libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track,
680 libvlc_exception_t *p_e )
682 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
683 vlc_value_t val_list;
687 if( !p_input_thread )
690 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
691 for( i = 0; i < val_list.p_list->i_count; i++ )
693 vlc_value_t val = val_list.p_list->p_values[i];
694 if( i_track == val.i_int )
696 i_ret = var_Set( p_input_thread, "audio-es", val );
698 libvlc_exception_raise( p_e, "Setting video track failed" );
699 vlc_object_release( p_input_thread );
703 libvlc_exception_raise( p_e, "Video track out of range" );
704 vlc_object_release( p_input_thread );
707 int libvlc_video_destroy( libvlc_media_player_t *p_mi,
708 libvlc_exception_t *p_e )
710 vout_thread_t *p_vout = GetVout( p_mi, p_e );
711 vlc_object_detach( p_vout );
712 vlc_object_release( p_vout );
713 vlc_object_release( p_vout );