1 /*****************************************************************************
2 * video.c: libvlc new API video functions
3 *****************************************************************************
4 * Copyright (C) 2005 the VideoLAN team
8 * Authors: Cl�ent 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 vout_Control( p_vout, VOUT_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 vout_thread_t *p_vout = GetVout( p_mi, p_e );
197 vout_Control( p_vout , VOUT_REPARENT, d);
198 vlc_object_release( p_vout );
203 void libvlc_video_resize( libvlc_media_player_t *p_mi, int width, int height, libvlc_exception_t *p_e )
205 vout_thread_t *p_vout = GetVout( p_mi, p_e );
208 vout_Control( p_vout, VOUT_SET_SIZE, width, height );
209 vlc_object_release( p_vout );
213 void libvlc_video_redraw_rectangle( libvlc_media_player_t *p_mi,
214 const libvlc_rectangle_t *area,
215 libvlc_exception_t *p_e )
218 && ((area->bottom - area->top) > 0)
219 && ((area->right - area->left) > 0) )
221 vout_thread_t *p_vout = GetVout( p_mi, p_e );
224 /* tell running vout to redraw area */
225 vout_Control( p_vout , VOUT_REDRAW_RECT,
226 area->top, area->left, area->bottom, area->right );
227 vlc_object_release( p_vout );
232 /* global video settings */
234 /* Deprecated use libvlc_media_player_set_drawable() */
235 void libvlc_video_set_parent( libvlc_instance_t *p_instance, libvlc_drawable_t d,
236 libvlc_exception_t *p_e )
238 /* set as default for future vout instances */
239 var_SetInteger(p_instance->p_libvlc_int, "drawable", (int)d);
241 libvlc_media_player_t *p_mi = libvlc_playlist_get_media_player(p_instance, p_e);
244 libvlc_media_player_set_drawable( p_mi, d, p_e );
245 libvlc_media_player_release(p_mi);
249 /* Deprecated use libvlc_media_player_get_drawable() */
250 libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
254 libvlc_drawable_t result;
256 result = var_GetInteger( p_instance->p_libvlc_int, "drawable" );
262 void libvlc_video_set_size( libvlc_instance_t *p_instance, int width, int height,
263 libvlc_exception_t *p_e )
265 /* set as default for future vout instances */
266 config_PutInt(p_instance->p_libvlc_int, "width", width);
267 config_PutInt(p_instance->p_libvlc_int, "height", height);
269 libvlc_media_player_t *p_mi = libvlc_playlist_get_media_player(p_instance, p_e);
272 vout_thread_t *p_vout = GetVout( p_mi, p_e );
275 /* tell running vout to re-size */
276 vout_Control( p_vout , VOUT_SET_SIZE, width, height);
277 vlc_object_release( p_vout );
279 libvlc_media_player_release(p_mi);
283 void libvlc_video_set_viewport( libvlc_instance_t *p_instance,
284 const libvlc_rectangle_t *view, const libvlc_rectangle_t *clip,
285 libvlc_exception_t *p_e )
289 libvlc_exception_raise( p_e, "viewport is NULL" );
293 /* if clip is NULL, then use view rectangle as clip */
297 /* set as default for future vout instances */
298 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-top", view->top );
299 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-left", view->left );
300 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-bottom", view->bottom );
301 var_SetInteger( p_instance->p_libvlc_int, "drawable-view-right", view->right );
302 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-top", clip->top );
303 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-left", clip->left );
304 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-bottom", clip->bottom );
305 var_SetInteger( p_instance->p_libvlc_int, "drawable-clip-right", clip->right );
307 libvlc_media_player_t *p_mi = libvlc_playlist_get_media_player(p_instance, p_e);
310 vout_thread_t *p_vout = GetVout( p_mi, p_e );
313 /* change viewport for running vout */
314 vout_Control( p_vout , VOUT_SET_VIEWPORT,
315 view->top, view->left, view->bottom, view->right,
316 clip->top, clip->left, clip->bottom, clip->right );
317 vlc_object_release( p_vout );
319 libvlc_media_player_release(p_mi);
323 char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi,
324 libvlc_exception_t *p_e )
326 char *psz_aspect = 0;
327 vout_thread_t *p_vout = GetVout( p_mi, p_e );
329 if( !p_vout ) return 0;
331 psz_aspect = var_GetNonEmptyString( p_vout, "aspect-ratio" );
332 vlc_object_release( p_vout );
333 return psz_aspect ? psz_aspect : strdup("");
336 void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi,
337 char *psz_aspect, libvlc_exception_t *p_e )
339 vout_thread_t *p_vout = GetVout( p_mi, p_e );
342 if( !p_vout ) return;
344 i_ret = var_SetString( p_vout, "aspect-ratio", psz_aspect );
346 libvlc_exception_raise( p_e,
347 "Unexpected error while setting aspect-ratio value" );
349 vlc_object_release( p_vout );
352 int libvlc_video_get_spu( libvlc_media_player_t *p_mi,
353 libvlc_exception_t *p_e )
355 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
356 vlc_value_t val_list;
362 if( !p_input_thread ) return -1;
364 i_ret = var_Get( p_input_thread, "spu-es", &val );
367 libvlc_exception_raise( p_e, "Getting subtitle information failed" );
368 vlc_object_release( p_input_thread );
372 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
373 for( i = 0; i < val_list.p_list->i_count; i++ )
375 vlc_value_t spu_val = val_list.p_list->p_values[i];
376 if( val.i_int == spu_val.i_int )
382 vlc_object_release( p_input_thread );
386 int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi,
387 libvlc_exception_t *p_e )
389 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
390 vlc_value_t val_list;
392 if( !p_input_thread )
395 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
396 vlc_object_release( p_input_thread );
397 return val_list.p_list->i_count;
400 libvlc_track_description_t *
401 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi,
402 libvlc_exception_t *p_e )
404 return libvlc_get_track_description( p_mi, "spu-es", p_e);
407 void libvlc_video_set_spu( libvlc_media_player_t *p_mi, int i_spu,
408 libvlc_exception_t *p_e )
410 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
411 vlc_value_t val_list;
415 if( !p_input_thread ) return;
417 var_Change( p_input_thread, "spu-es", VLC_VAR_GETCHOICES, &val_list, NULL );
418 if( (i_spu < 0) && (i_spu > val_list.p_list->i_count) )
420 libvlc_exception_raise( p_e, "Subtitle value out of range" );
421 vlc_object_release( p_input_thread );
425 newval = val_list.p_list->p_values[i_spu];
426 i_ret = var_Set( p_input_thread, "spu-es", newval );
429 libvlc_exception_raise( p_e, "Setting subtitle value failed" );
431 vlc_object_release( p_input_thread );
434 int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi,
436 libvlc_exception_t *p_e )
438 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
443 if( input_AddSubtitles( p_input_thread, psz_subtitle, true ) )
445 vlc_object_release( p_input_thread );
450 libvlc_track_description_t *
451 libvlc_video_get_title_description( libvlc_media_player_t *p_mi,
452 libvlc_exception_t * p_e )
454 return libvlc_get_track_description( p_mi, "title", p_e);
457 libvlc_track_description_t *
458 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi,
460 libvlc_exception_t *p_e )
463 sprintf( psz_title, "title %2i", i_title );
464 return libvlc_get_track_description( p_mi, psz_title, p_e);
467 char *libvlc_video_get_crop_geometry( libvlc_media_player_t *p_mi,
468 libvlc_exception_t *p_e )
470 char *psz_geometry = 0;
471 vout_thread_t *p_vout = GetVout( p_mi, p_e );
473 if( !p_vout ) return 0;
475 psz_geometry = var_GetNonEmptyString( p_vout, "crop" );
476 vlc_object_release( p_vout );
477 return psz_geometry ? psz_geometry : strdup("");
480 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi,
481 char *psz_geometry, libvlc_exception_t *p_e )
483 vout_thread_t *p_vout = GetVout( p_mi, p_e );
486 if( !p_vout ) return;
488 i_ret = var_SetString( p_vout, "crop", psz_geometry );
490 libvlc_exception_raise( p_e,
491 "Unexpected error while setting crop geometry" );
493 vlc_object_release( p_vout );
496 int libvlc_video_get_teletext( libvlc_media_player_t *p_mi,
497 libvlc_exception_t *p_e )
499 vout_thread_t *p_vout = GetVout( p_mi, p_e );
503 if( !p_vout ) return i_ret;
505 p_vbi = (vlc_object_t *) vlc_object_find_name( p_vout, "zvbi",
509 i_ret = var_GetInteger( p_vbi, "vbi-page" );
510 vlc_object_release( p_vbi );
513 vlc_object_release( p_vout );
517 void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page,
518 libvlc_exception_t *p_e )
520 vout_thread_t *p_vout = GetVout( p_mi, p_e );
524 if( !p_vout ) return;
526 p_vbi = (vlc_object_t *) vlc_object_find_name( p_vout, "zvbi",
530 i_ret = var_SetInteger( p_vbi, "vbi-page", i_page );
531 vlc_object_release( p_vbi );
533 libvlc_exception_raise( p_e,
534 "Unexpected error while setting teletext page" );
536 vlc_object_release( p_vout );
539 void libvlc_toggle_teletext( libvlc_media_player_t *p_mi,
540 libvlc_exception_t *p_e )
542 input_thread_t *p_input_thread;
546 p_input_thread = libvlc_get_input_thread(p_mi, p_e);
547 if( !p_input_thread ) return;
549 p_vbi = (vlc_object_t *) vlc_object_find_name( p_input_thread, "zvbi",
553 const int i_teletext_es = var_GetInteger( p_input_thread, "teletext-es" );
554 const int i_spu_es = var_GetInteger( p_input_thread, "spu-es" );
556 if( (i_teletext_es >= 0) && (i_teletext_es == i_spu_es) )
560 i_page = var_GetInteger( p_vbi, "vbi-page" );
561 i_page = (i_teletext_es >= 0) ? i_page : 0;
563 i_ret = var_SetInteger( p_vbi, "vbi-page", i_page );
565 libvlc_exception_raise( p_e,
566 "Unexpected error while setting teletext page" );
568 else if( i_teletext_es >= 0 )
572 opaque = var_GetBool( p_vbi, "vbi-opaque" );
573 i_ret = var_SetBool( p_vbi, "vbi-opaque", !opaque );
575 libvlc_exception_raise( p_e,
576 "Unexpected error while setting teletext transparency" );
578 vlc_object_release( p_vbi );
582 /* Teletext is not enabled yet, so enable it.
583 * Only after it is enable it is possible to view teletext pages
585 const int i_teletext_es = var_GetInteger( p_input_thread, "teletext-es" );
587 if( i_teletext_es >= 0 )
589 const int i_spu_es = var_GetInteger( p_input_thread, "spu-es" );
591 if( i_teletext_es == i_spu_es )
592 var_SetInteger( p_input_thread, "spu-es", -1 );
594 var_SetInteger( p_input_thread, "spu-es", i_teletext_es );
597 vlc_object_release( p_input_thread );
600 int libvlc_video_get_track_count( libvlc_media_player_t *p_mi,
601 libvlc_exception_t *p_e )
603 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
604 vlc_value_t val_list;
606 if( !p_input_thread )
609 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
610 vlc_object_release( p_input_thread );
611 return val_list.p_list->i_count;
614 libvlc_track_description_t *
615 libvlc_video_get_track_description( libvlc_media_player_t *p_mi,
616 libvlc_exception_t *p_e )
618 return libvlc_get_track_description( p_mi, "video-es", p_e);
621 int libvlc_video_get_track( libvlc_media_player_t *p_mi,
622 libvlc_exception_t *p_e )
624 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
625 vlc_value_t val_list;
631 if( !p_input_thread )
634 i_ret = var_Get( p_input_thread, "video-es", &val );
637 libvlc_exception_raise( p_e, "Getting Video track information failed" );
638 vlc_object_release( p_input_thread );
642 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
643 for( i = 0; i < val_list.p_list->i_count; i++ )
645 vlc_value_t track_val = val_list.p_list->p_values[i];
646 if( track_val.i_int == val.i_int )
652 vlc_object_release( p_input_thread );
656 void libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track,
657 libvlc_exception_t *p_e )
659 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
660 vlc_value_t val_list;
664 if( !p_input_thread )
667 var_Change( p_input_thread, "video-es", VLC_VAR_GETCHOICES, &val_list, NULL );
668 for( i = 0; i < val_list.p_list->i_count; i++ )
670 vlc_value_t val = val_list.p_list->p_values[i];
671 if( i_track == val.i_int )
673 i_ret = var_Set( p_input_thread, "audio-es", val );
675 libvlc_exception_raise( p_e, "Setting video track failed" );
676 vlc_object_release( p_input_thread );
680 libvlc_exception_raise( p_e, "Video track out of range" );
681 vlc_object_release( p_input_thread );
684 int libvlc_video_destroy( libvlc_media_player_t *p_mi,
685 libvlc_exception_t *p_e )
687 vout_thread_t *p_vout = GetVout( p_mi, p_e );
688 vlc_object_detach( p_vout );
689 vlc_object_release( p_vout );
690 vlc_object_release( p_vout );