1 /*****************************************************************************
2 * vout_intf.c : video output interface
3 *****************************************************************************
4 * Copyright (C) 2000-2007 the VideoLAN team
6 * Authors: Gildas Bazin <gbazin@videolan.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
23 /*****************************************************************************
25 *****************************************************************************/
31 #include <vlc_common.h>
34 #include <stdlib.h> /* free() */
35 #include <sys/types.h> /* opendir() */
37 #include <dirent.h> /* opendir() */
40 #include <vlc_interface.h>
41 #include <vlc_block.h>
42 #include <vlc_playlist.h>
45 #include <vlc_window.h>
46 #include <vlc_image.h>
48 #include <vlc_charset.h>
50 #include <vlc_strings.h>
51 #include <vlc_charset.h>
52 #include "../libvlc.h"
53 #include "vout_internal.h"
55 /*****************************************************************************
57 *****************************************************************************/
58 static void InitWindowSize( vout_thread_t *, unsigned *, unsigned * );
60 /* Object variables callbacks */
61 static int ZoomCallback( vlc_object_t *, char const *,
62 vlc_value_t, vlc_value_t, void * );
63 static int CropCallback( vlc_object_t *, char const *,
64 vlc_value_t, vlc_value_t, void * );
65 static int AspectCallback( vlc_object_t *, char const *,
66 vlc_value_t, vlc_value_t, void * );
67 static int OnTopCallback( vlc_object_t *, char const *,
68 vlc_value_t, vlc_value_t, void * );
69 static int FullscreenCallback( vlc_object_t *, char const *,
70 vlc_value_t, vlc_value_t, void * );
71 static int SnapshotCallback( vlc_object_t *, char const *,
72 vlc_value_t, vlc_value_t, void * );
74 static int TitleShowCallback( vlc_object_t *, char const *,
75 vlc_value_t, vlc_value_t, void * );
76 static int TitleTimeoutCallback( vlc_object_t *, char const *,
77 vlc_value_t, vlc_value_t, void * );
78 static int TitlePositionCallback( vlc_object_t *, char const *,
79 vlc_value_t, vlc_value_t, void * );
81 /*****************************************************************************
82 * vout_RequestWindow: Create/Get a video window if possible.
83 *****************************************************************************
84 * This function looks for the main interface and tries to request
85 * a new video window. If it fails then the vout will still need to create the
87 *****************************************************************************/
88 void *vout_RequestWindow( vout_thread_t *p_vout,
89 int *pi_x_hint, int *pi_y_hint,
90 unsigned int *pi_width_hint,
91 unsigned int *pi_height_hint )
94 if( !var_Type( p_vout, "aspect-ratio" ) ) vout_IntfInit( p_vout );
96 /* Get requested coordinates */
97 *pi_x_hint = var_GetInteger( p_vout, "video-x" );
98 *pi_y_hint = var_GetInteger( p_vout, "video-y" );
100 *pi_width_hint = p_vout->i_window_width;
101 *pi_height_hint = p_vout->i_window_height;
103 /* Check whether someone provided us with a window ID */
104 int drawable = var_CreateGetInteger( p_vout, "drawable" );
105 if( drawable ) return (void *)(intptr_t)drawable;
107 vout_window_t *wnd = vlc_custom_create (VLC_OBJECT(p_vout), sizeof (*wnd),
108 VLC_OBJECT_GENERIC, "window");
113 wnd->width = *pi_width_hint;
114 wnd->height = *pi_height_hint;
115 wnd->pos_x = *pi_x_hint;
116 wnd->pos_y = *pi_y_hint;
117 vlc_object_attach (wnd, p_vout);
119 wnd->module = module_need (wnd, "vout window", 0, 0);
120 if (wnd->module == NULL)
122 msg_Dbg (wnd, "no window provider available");
123 vlc_object_release (wnd);
126 p_vout->p_window = wnd;
127 *pi_width_hint = wnd->width;
128 *pi_height_hint = wnd->height;
129 *pi_x_hint = wnd->pos_x;
130 *pi_y_hint = wnd->pos_y;
134 void vout_ReleaseWindow( vout_thread_t *p_vout, void *dummy )
136 vout_window_t *wnd = p_vout->p_window;
140 p_vout->p_window = NULL;
142 assert (wnd->module);
143 module_unneed (wnd, wnd->module);
145 vlc_object_release (wnd);
149 int vout_ControlWindow( vout_thread_t *p_vout, void *dummy,
150 int i_query, va_list args )
153 vout_window_t *wnd = p_vout->p_window;
158 assert (wnd->control);
159 return wnd->control (wnd, i_query, args);
162 /*****************************************************************************
163 * vout_IntfInit: called during the vout creation to initialise misc things.
164 *****************************************************************************/
168 const char *psz_label;
169 } p_zoom_values[] = {
170 { 0.25, N_("1:4 Quarter") },
171 { 0.5, N_("1:2 Half") },
172 { 1, N_("1:1 Original") },
173 { 2, N_("2:1 Double") },
178 const char *psz_value;
179 const char *psz_label;
180 } p_crop_values[] = {
181 { "", N_("Default") },
182 { "16:10", "16:10" },
184 { "185:100", "1.85:1" },
185 { "221:100", "2.21:1" },
186 { "235:100", "2.35:1" },
187 { "239:100", "2.39:1" },
196 const char *psz_value;
197 const char *psz_label;
198 } p_aspect_ratio_values[] = {
199 { "", N_("Default") },
203 { "16:10", "16:10" },
204 { "221:100", "2.21:1" },
208 static void AddCustomRatios( vout_thread_t *p_vout, const char *psz_var,
211 if( psz_list && *psz_list )
213 char *psz_cur = psz_list;
215 while( psz_cur && *psz_cur )
217 vlc_value_t val, text;
218 psz_next = strchr( psz_cur, ',' );
224 val.psz_string = psz_cur;
225 text.psz_string = psz_cur;
226 var_Change( p_vout, psz_var, VLC_VAR_ADDCHOICE, &val, &text);
232 void vout_IntfInit( vout_thread_t *p_vout )
234 vlc_value_t val, text, old_val;
235 bool b_force_par = false;
239 /* Create a few object variables we'll need later on */
240 var_Create( p_vout, "snapshot-path", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
241 var_Create( p_vout, "snapshot-prefix", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
242 var_Create( p_vout, "snapshot-format", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
243 var_Create( p_vout, "snapshot-preview", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
244 var_Create( p_vout, "snapshot-sequential",
245 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
246 var_Create( p_vout, "snapshot-num", VLC_VAR_INTEGER );
247 var_SetInteger( p_vout, "snapshot-num", 1 );
248 var_Create( p_vout, "snapshot-width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
249 var_Create( p_vout, "snapshot-height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
251 var_Create( p_vout, "width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
252 var_Create( p_vout, "height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
253 p_vout->i_alignment = var_CreateGetInteger( p_vout, "align" );
255 var_Create( p_vout, "video-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
256 var_Create( p_vout, "video-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
258 var_Create( p_vout, "mouse-hide-timeout",
259 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
261 p_vout->p->b_title_show = var_CreateGetBool( p_vout, "video-title-show" );
262 p_vout->p->i_title_timeout =
263 (mtime_t)var_CreateGetInteger( p_vout, "video-title-timeout" );
264 p_vout->p->i_title_position =
265 var_CreateGetInteger( p_vout, "video-title-position" );
267 var_AddCallback( p_vout, "video-title-show", TitleShowCallback, NULL );
268 var_AddCallback( p_vout, "video-title-timeout", TitleTimeoutCallback, NULL );
269 var_AddCallback( p_vout, "video-title-position", TitlePositionCallback, NULL );
271 /* Zoom object var */
272 var_Create( p_vout, "zoom", VLC_VAR_FLOAT | VLC_VAR_ISCOMMAND |
273 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
275 text.psz_string = _("Zoom");
276 var_Change( p_vout, "zoom", VLC_VAR_SETTEXT, &text, NULL );
278 var_Get( p_vout, "zoom", &old_val );
280 for( i = 0; p_zoom_values[i].f_value; i++ )
282 if( old_val.f_float == p_zoom_values[i].f_value )
283 var_Change( p_vout, "zoom", VLC_VAR_DELCHOICE, &old_val, NULL );
284 val.f_float = p_zoom_values[i].f_value;
285 text.psz_string = _( p_zoom_values[i].psz_label );
286 var_Change( p_vout, "zoom", VLC_VAR_ADDCHOICE, &val, &text );
289 var_Set( p_vout, "zoom", old_val ); /* Is this really needed? */
291 var_AddCallback( p_vout, "zoom", ZoomCallback, NULL );
293 /* Crop offset vars */
294 var_Create( p_vout, "crop-left", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
295 var_Create( p_vout, "crop-top", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
296 var_Create( p_vout, "crop-right", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
297 var_Create( p_vout, "crop-bottom", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
299 var_AddCallback( p_vout, "crop-left", CropCallback, NULL );
300 var_AddCallback( p_vout, "crop-top", CropCallback, NULL );
301 var_AddCallback( p_vout, "crop-right", CropCallback, NULL );
302 var_AddCallback( p_vout, "crop-bottom", CropCallback, NULL );
304 /* Crop object var */
305 var_Create( p_vout, "crop", VLC_VAR_STRING | VLC_VAR_ISCOMMAND |
306 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
308 text.psz_string = _("Crop");
309 var_Change( p_vout, "crop", VLC_VAR_SETTEXT, &text, NULL );
311 val.psz_string = (char*)"";
312 var_Change( p_vout, "crop", VLC_VAR_DELCHOICE, &val, 0 );
314 for( i = 0; p_crop_values[i].psz_value; i++ )
316 val.psz_string = (char*)p_crop_values[i].psz_value;
317 text.psz_string = _( p_crop_values[i].psz_label );
318 var_Change( p_vout, "crop", VLC_VAR_ADDCHOICE, &val, &text );
321 /* update triggered every time the vout's crop parameters are changed */
322 var_Create( p_vout, "crop-update", VLC_VAR_VOID );
324 /* Add custom crop ratios */
325 psz_buf = config_GetPsz( p_vout, "custom-crop-ratios" );
326 AddCustomRatios( p_vout, "crop", psz_buf );
329 var_AddCallback( p_vout, "crop", CropCallback, NULL );
330 var_Get( p_vout, "crop", &old_val );
331 if( old_val.psz_string && *old_val.psz_string )
332 var_Change( p_vout, "crop", VLC_VAR_TRIGGER_CALLBACKS, 0, 0 );
333 free( old_val.psz_string );
335 /* Monitor pixel aspect-ratio */
336 var_Create( p_vout, "monitor-par", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
337 var_Get( p_vout, "monitor-par", &val );
338 if( val.psz_string && *val.psz_string )
340 char *psz_parser = strchr( val.psz_string, ':' );
341 unsigned int i_aspect_num = 0, i_aspect_den = 0;
345 i_aspect_num = strtol( val.psz_string, 0, 10 );
346 i_aspect_den = strtol( ++psz_parser, 0, 10 );
350 i_aspect = atof( val.psz_string );
351 vlc_ureduce( &i_aspect_num, &i_aspect_den,
352 i_aspect *VOUT_ASPECT_FACTOR, VOUT_ASPECT_FACTOR, 0 );
354 if( !i_aspect_num || !i_aspect_den ) i_aspect_num = i_aspect_den = 1;
356 p_vout->p->i_par_num = i_aspect_num;
357 p_vout->p->i_par_den = i_aspect_den;
359 vlc_ureduce( &p_vout->p->i_par_num, &p_vout->p->i_par_den,
360 p_vout->p->i_par_num, p_vout->p->i_par_den, 0 );
362 msg_Dbg( p_vout, "overriding monitor pixel aspect-ratio: %i:%i",
363 p_vout->p->i_par_num, p_vout->p->i_par_den );
366 free( val.psz_string );
368 /* Aspect-ratio object var */
369 var_Create( p_vout, "aspect-ratio", VLC_VAR_STRING | VLC_VAR_ISCOMMAND |
370 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
372 text.psz_string = _("Aspect-ratio");
373 var_Change( p_vout, "aspect-ratio", VLC_VAR_SETTEXT, &text, NULL );
375 val.psz_string = (char*)"";
376 var_Change( p_vout, "aspect-ratio", VLC_VAR_DELCHOICE, &val, 0 );
378 for( i = 0; p_aspect_ratio_values[i].psz_value; i++ )
380 val.psz_string = (char*)p_aspect_ratio_values[i].psz_value;
381 text.psz_string = _( p_aspect_ratio_values[i].psz_label );
382 var_Change( p_vout, "aspect-ratio", VLC_VAR_ADDCHOICE, &val, &text );
385 /* Add custom aspect ratios */
386 psz_buf = config_GetPsz( p_vout, "custom-aspect-ratios" );
387 AddCustomRatios( p_vout, "aspect-ratio", psz_buf );
390 var_AddCallback( p_vout, "aspect-ratio", AspectCallback, NULL );
391 var_Get( p_vout, "aspect-ratio", &old_val );
392 if( (old_val.psz_string && *old_val.psz_string) || b_force_par )
393 var_Change( p_vout, "aspect-ratio", VLC_VAR_TRIGGER_CALLBACKS, 0, 0 );
394 free( old_val.psz_string );
396 /* Initialize the dimensions of the video window */
397 InitWindowSize( p_vout, &p_vout->i_window_width,
398 &p_vout->i_window_height );
400 /* Add a variable to indicate if the window should be on top of others */
401 var_Create( p_vout, "video-on-top", VLC_VAR_BOOL | VLC_VAR_DOINHERIT
402 | VLC_VAR_ISCOMMAND );
403 text.psz_string = _("Always on top");
404 var_Change( p_vout, "video-on-top", VLC_VAR_SETTEXT, &text, NULL );
405 var_AddCallback( p_vout, "video-on-top", OnTopCallback, NULL );
407 /* Add a variable to indicate whether we want window decoration or not */
408 var_Create( p_vout, "video-deco", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
410 /* Add a fullscreen variable */
411 if( var_CreateGetBoolCommand( p_vout, "fullscreen" ) )
413 /* user requested fullscreen */
414 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
416 text.psz_string = _("Fullscreen");
417 var_Change( p_vout, "fullscreen", VLC_VAR_SETTEXT, &text, NULL );
418 var_AddCallback( p_vout, "fullscreen", FullscreenCallback, NULL );
420 /* Add a snapshot variable */
421 var_Create( p_vout, "video-snapshot", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
422 text.psz_string = _("Snapshot");
423 var_Change( p_vout, "video-snapshot", VLC_VAR_SETTEXT, &text, NULL );
424 var_AddCallback( p_vout, "video-snapshot", SnapshotCallback, NULL );
426 /* Mouse coordinates */
427 var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
428 var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
429 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
430 var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
431 var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
433 var_Create( p_vout, "intf-change", VLC_VAR_BOOL );
434 var_SetBool( p_vout, "intf-change", true );
437 /*****************************************************************************
438 * vout_Snapshot: generates a snapshot.
439 *****************************************************************************/
441 * This function will inject a subpicture into the vout with the provided
444 static int VoutSnapshotPip( vout_thread_t *p_vout, image_handler_t *p_image, picture_t *p_pic, const video_format_t *p_fmt_in )
446 video_format_t fmt_in = *p_fmt_in;
447 video_format_t fmt_out;
449 subpicture_t *p_subpic;
452 memset( &fmt_out, 0, sizeof(fmt_out) );
454 fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
457 p_pip = image_Convert( p_image, p_pic, &fmt_in, &fmt_out );
461 p_subpic = subpicture_New();
462 if( p_subpic == NULL )
464 picture_Release( p_pip );
468 p_subpic->i_channel = 0;
469 p_subpic->i_start = mdate();
470 p_subpic->i_stop = mdate() + 4000000;
471 p_subpic->b_ephemer = true;
472 p_subpic->b_fade = true;
473 p_subpic->i_original_picture_width = fmt_out.i_width * 4;
474 p_subpic->i_original_picture_height = fmt_out.i_height * 4;
475 fmt_out.i_aspect = 0;
477 fmt_out.i_sar_den = 0;
479 p_subpic->p_region = subpicture_region_New( &fmt_out );
480 if( p_subpic->p_region )
482 picture_Release( p_subpic->p_region->p_picture );
483 p_subpic->p_region->p_picture = p_pip;
487 picture_Release( p_pip );
490 spu_DisplaySubpicture( p_vout->p_spu, p_subpic );
494 * This function will return the default directory used for snapshots
496 static char *VoutSnapshotGetDefaultDirectory( void )
498 char *psz_path = NULL;
499 #if defined(__APPLE__) || defined(SYS_BEOS)
501 if( asprintf( &psz_path, "%s/Desktop",
502 config_GetHomeDir() ) == -1 )
505 #elif defined(WIN32) && !defined(UNDER_CE)
507 /* Get the My Pictures folder path */
508 char *p_mypicturesdir = NULL;
509 typedef HRESULT (WINAPI *SHGETFOLDERPATH)( HWND, int, HANDLE, DWORD,
511 #ifndef CSIDL_FLAG_CREATE
512 # define CSIDL_FLAG_CREATE 0x8000
514 #ifndef CSIDL_MYPICTURES
515 # define CSIDL_MYPICTURES 0x27
517 #ifndef SHGFP_TYPE_CURRENT
518 # define SHGFP_TYPE_CURRENT 0
521 HINSTANCE shfolder_dll;
522 SHGETFOLDERPATH SHGetFolderPath ;
524 /* load the shfolder dll to retrieve SHGetFolderPath */
525 if( ( shfolder_dll = LoadLibrary( _T("SHFolder.dll") ) ) != NULL )
527 wchar_t wdir[PATH_MAX];
528 SHGetFolderPath = (void *)GetProcAddress( shfolder_dll,
529 _T("SHGetFolderPathW") );
530 if ((SHGetFolderPath != NULL )
531 && SUCCEEDED (SHGetFolderPath (NULL,
532 CSIDL_MYPICTURES | CSIDL_FLAG_CREATE,
533 NULL, SHGFP_TYPE_CURRENT,
535 p_mypicturesdir = FromWide (wdir);
537 FreeLibrary( shfolder_dll );
540 if( p_mypicturesdir == NULL )
541 psz_path = strdup( config_GetHomeDir() );
543 psz_path = p_mypicturesdir;
547 /* XXX: This saves in the data directory. Shouldn't we try saving
548 * to psz_homedir/Desktop or something nicer ? */
549 char *psz_datadir = config_GetUserDataDir();
552 if( asprintf( &psz_path, "%s", psz_datadir ) == -1 )
562 int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
564 image_handler_t *p_image = image_HandlerCreate( p_vout );
565 video_format_t fmt_in, fmt_out;
566 char *psz_filename = NULL;
567 vlc_value_t val, format;
570 bool b_embedded_snapshot;
571 uintmax_t i_id = (uintptr_t)NULL;
574 val.psz_string = var_GetNonEmptyString( p_vout, "snapshot-path" );
576 /* Embedded snapshot : if snapshot-path == object:object_ptr */
577 if( val.psz_string && sscanf( val.psz_string, "object:%ju", &i_id ) > 0 )
578 b_embedded_snapshot = true;
580 b_embedded_snapshot = false;
583 memset( &fmt_in, 0, sizeof(video_format_t) );
584 fmt_in = p_vout->fmt_out;
585 if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
588 fmt_in.i_sar_den = 1;
592 memset( &fmt_out, 0, sizeof(video_format_t) );
594 fmt_out.i_sar_den = 1;
595 fmt_out.i_chroma = b_embedded_snapshot ? VLC_FOURCC('p','n','g',' ') : 0;
596 fmt_out.i_width = var_GetInteger( p_vout, "snapshot-width" );
597 fmt_out.i_height = var_GetInteger( p_vout, "snapshot-height" );
599 if( b_embedded_snapshot &&
600 fmt_out.i_width == 0 && fmt_out.i_height == 0 )
602 /* If snapshot-width and/or snapshot height were not specified,
603 use a default snapshot width of 320 */
604 fmt_out.i_width = 320;
607 if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
609 fmt_out.i_height = fmt_in.i_height * fmt_out.i_width / fmt_in.i_width;
610 const int i_height = fmt_out.i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
612 fmt_out.i_height = i_height;
616 if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
618 fmt_out.i_width = fmt_in.i_width * fmt_out.i_height / fmt_in.i_height;
622 fmt_out.i_width = fmt_in.i_width;
623 fmt_out.i_height = fmt_in.i_height;
625 const int i_width = fmt_out.i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
627 fmt_out.i_width = i_width;
631 create a snapshot_t* and store it in
632 object_ptr->p_private, then unlock and signal the
635 if( b_embedded_snapshot )
637 vlc_object_t* p_dest = (vlc_object_t *)(uintptr_t)i_id;
639 snapshot_t *p_snapshot;
642 vlc_object_lock( p_dest );
643 p_dest->p_private = NULL;
645 /* Save the snapshot to a memory zone */
646 p_block = image_Write( p_image, p_pic, &fmt_in, &fmt_out );
649 msg_Err( p_vout, "Could not get snapshot" );
650 image_HandlerDelete( p_image );
651 vlc_object_signal_unlocked( p_dest );
652 vlc_object_unlock( p_dest );
656 /* Copy the p_block data to a snapshot structure */
657 /* FIXME: get the timestamp */
658 p_snapshot = malloc( sizeof( snapshot_t ) );
661 block_Release( p_block );
662 image_HandlerDelete( p_image );
663 vlc_object_signal_unlocked( p_dest );
664 vlc_object_unlock( p_dest );
668 i_size = p_block->i_buffer;
670 p_snapshot->i_width = fmt_out.i_width;
671 p_snapshot->i_height = fmt_out.i_height;
672 p_snapshot->i_datasize = i_size;
673 p_snapshot->date = p_block->i_pts; /* FIXME ?? */
674 p_snapshot->p_data = malloc( i_size );
675 if( !p_snapshot->p_data )
677 block_Release( p_block );
679 image_HandlerDelete( p_image );
680 vlc_object_signal_unlocked( p_dest );
681 vlc_object_unlock( p_dest );
684 memcpy( p_snapshot->p_data, p_block->p_buffer, p_block->i_buffer );
686 p_dest->p_private = p_snapshot;
688 block_Release( p_block );
690 /* Unlock the object */
691 vlc_object_signal_unlocked( p_dest );
692 vlc_object_unlock( p_dest );
694 image_HandlerDelete( p_image );
698 /* Get default directory if none provided */
699 if( !val.psz_string )
700 val.psz_string = VoutSnapshotGetDefaultDirectory( );
701 if( !val.psz_string )
703 msg_Err( p_vout, "no path specified for snapshots" );
704 image_HandlerDelete( p_image );
708 /* Get snapshot format, default being "png" */
709 format.psz_string = var_GetNonEmptyString( p_vout, "snapshot-format" );
710 if( !format.psz_string )
711 format.psz_string = strdup( "png" );
712 if( !format.psz_string )
714 free( val.psz_string );
715 image_HandlerDelete( p_image );
720 * Did the user specify a directory? If not, path = NULL.
722 path = utf8_opendir ( (const char *)val.psz_string );
725 char *psz_prefix = var_GetNonEmptyString( p_vout, "snapshot-prefix" );
726 if( psz_prefix == NULL )
727 psz_prefix = strdup( "vlcsnap-" );
730 char *psz_tmp = str_format( p_vout, psz_prefix );
731 filename_sanitize( psz_tmp );
733 psz_prefix = psz_tmp;
737 if( var_GetBool( p_vout, "snapshot-sequential" ) == true )
739 int i_num = var_GetInteger( p_vout, "snapshot-num" );
744 free( psz_filename );
745 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%05d.%s",
746 val.psz_string, psz_prefix, i_num++,
747 format.psz_string ) == -1 )
749 msg_Err( p_vout, "could not create snapshot" );
750 image_HandlerDelete( p_image );
754 while( utf8_stat( psz_filename, &st ) == 0 );
756 var_SetInteger( p_vout, "snapshot-num", i_num );
760 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%u.%s",
761 val.psz_string, psz_prefix,
762 (unsigned int)(p_pic->date / 100000) & 0xFFFFFF,
763 format.psz_string ) == -1 )
765 msg_Err( p_vout, "could not create snapshot" );
766 image_HandlerDelete( p_image );
773 else // The user specified a full path name (including file name)
775 psz_filename = str_format( p_vout, val.psz_string );
776 path_sanitize( psz_filename );
779 free( val.psz_string );
780 free( format.psz_string );
782 /* Save the snapshot */
783 i_ret = image_WriteUrl( p_image, p_pic, &fmt_in, &fmt_out, psz_filename );
784 if( i_ret != VLC_SUCCESS )
786 msg_Err( p_vout, "could not create snapshot %s", psz_filename );
787 free( psz_filename );
788 image_HandlerDelete( p_image );
793 msg_Dbg( p_vout, "snapshot taken (%s)", psz_filename );
794 vout_OSDMessage( VLC_OBJECT( p_vout ), DEFAULT_CHAN,
795 "%s", psz_filename );
796 free( psz_filename );
799 if( var_GetBool( p_vout, "snapshot-preview" ) )
801 if( VoutSnapshotPip( p_vout, p_image, p_pic, &fmt_in ) )
802 msg_Warn( p_vout, "Failed to display snapshot" );
804 image_HandlerDelete( p_image );
809 /*****************************************************************************
811 *****************************************************************************/
813 void vout_EnableFilter( vout_thread_t *p_vout, char *psz_name,
814 bool b_add, bool b_setconfig )
817 char *psz_string = config_GetPsz( p_vout, "vout-filter" );
819 /* Todo : Use some generic chain manipulation functions */
820 if( !psz_string ) psz_string = strdup("");
822 psz_parser = strstr( psz_string, psz_name );
827 psz_parser = psz_string;
828 if( asprintf( &psz_string, (*psz_string) ? "%s:%s" : "%s%s",
829 psz_string, psz_name ) == -1 )
843 memmove( psz_parser, psz_parser + strlen(psz_name) +
844 (*(psz_parser + strlen(psz_name)) == ':' ? 1 : 0 ),
845 strlen(psz_parser + strlen(psz_name)) + 1 );
847 /* Remove trailing : : */
848 if( *(psz_string+strlen(psz_string ) -1 ) == ':' )
850 *(psz_string+strlen(psz_string ) -1 ) = '\0';
860 config_PutPsz( p_vout, "vout-filter", psz_string );
862 var_SetString( p_vout, "vout-filter", psz_string );
866 /*****************************************************************************
867 * vout_ControlDefault: default methods for video output control.
868 *****************************************************************************/
869 int vout_vaControlDefault( vout_thread_t *p_vout, int i_query, va_list args )
876 vout_ReleaseWindow( p_vout, NULL );
880 p_vout->p->b_snapshot = true;
884 msg_Dbg( p_vout, "control query not supported" );
889 /*****************************************************************************
890 * InitWindowSize: find the initial dimensions the video window should have.
891 *****************************************************************************
892 * This function will check the "width", "height" and "zoom" config options and
893 * will calculate the size that the video window should have.
894 *****************************************************************************/
895 static void InitWindowSize( vout_thread_t *p_vout, unsigned *pi_width,
896 unsigned *pi_height )
899 int i_width, i_height;
902 #define FP_FACTOR 1000 /* our fixed point factor */
904 var_Get( p_vout, "width", &val );
906 var_Get( p_vout, "height", &val );
907 i_height = val.i_int;
908 var_Get( p_vout, "zoom", &val );
909 ll_zoom = (uint64_t)( FP_FACTOR * val.f_float );
911 if( i_width > 0 && i_height > 0)
913 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
914 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
917 else if( i_width > 0 )
919 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
920 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom *
921 p_vout->fmt_in.i_sar_den * i_width / p_vout->fmt_in.i_sar_num /
922 FP_FACTOR / p_vout->fmt_in.i_visible_width );
925 else if( i_height > 0 )
927 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
928 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom *
929 p_vout->fmt_in.i_sar_num * i_height / p_vout->fmt_in.i_sar_den /
930 FP_FACTOR / p_vout->fmt_in.i_visible_height );
934 if( p_vout->fmt_in.i_sar_num == 0 || p_vout->fmt_in.i_sar_den == 0 ) {
935 msg_Warn( p_vout, "fucked up aspect" );
936 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom / FP_FACTOR );
937 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom /FP_FACTOR);
939 else if( p_vout->fmt_in.i_sar_num >= p_vout->fmt_in.i_sar_den )
941 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom *
942 p_vout->fmt_in.i_sar_num / p_vout->fmt_in.i_sar_den / FP_FACTOR );
943 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom
948 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom
950 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom *
951 p_vout->fmt_in.i_sar_den / p_vout->fmt_in.i_sar_num / FP_FACTOR );
955 msg_Dbg( p_vout, "window size: %dx%d", p_vout->i_window_width,
956 p_vout->i_window_height );
961 /*****************************************************************************
962 * Object variables callbacks
963 *****************************************************************************/
964 static int ZoomCallback( vlc_object_t *p_this, char const *psz_cmd,
965 vlc_value_t oldval, vlc_value_t newval, void *p_data )
967 vout_thread_t *p_vout = (vout_thread_t *)p_this;
968 (void)psz_cmd; (void)oldval; (void)newval; (void)p_data;
969 InitWindowSize( p_vout, &p_vout->i_window_width,
970 &p_vout->i_window_height );
971 vout_Control( p_vout, VOUT_SET_SIZE, p_vout->i_window_width,
972 p_vout->i_window_height );
976 static int CropCallback( vlc_object_t *p_this, char const *psz_cmd,
977 vlc_value_t oldval, vlc_value_t newval, void *p_data )
979 vout_thread_t *p_vout = (vout_thread_t *)p_this;
980 int64_t i_aspect_num, i_aspect_den;
981 unsigned int i_width, i_height;
983 (void)oldval; (void)p_data;
985 /* Restore defaults */
986 p_vout->fmt_in.i_x_offset = p_vout->fmt_render.i_x_offset;
987 p_vout->fmt_in.i_visible_width = p_vout->fmt_render.i_visible_width;
988 p_vout->fmt_in.i_y_offset = p_vout->fmt_render.i_y_offset;
989 p_vout->fmt_in.i_visible_height = p_vout->fmt_render.i_visible_height;
991 if( !strcmp( psz_cmd, "crop" ) )
993 char *psz_end = NULL, *psz_parser = strchr( newval.psz_string, ':' );
996 /* We're using the 3:4 syntax */
997 i_aspect_num = strtol( newval.psz_string, &psz_end, 10 );
998 if( psz_end == newval.psz_string || !i_aspect_num ) goto crop_end;
1000 i_aspect_den = strtol( ++psz_parser, &psz_end, 10 );
1001 if( psz_end == psz_parser || !i_aspect_den ) goto crop_end;
1003 i_width = p_vout->fmt_in.i_sar_den*p_vout->fmt_render.i_visible_height *
1004 i_aspect_num / i_aspect_den / p_vout->fmt_in.i_sar_num;
1005 i_height = p_vout->fmt_render.i_visible_width*p_vout->fmt_in.i_sar_num *
1006 i_aspect_den / i_aspect_num / p_vout->fmt_in.i_sar_den;
1008 if( i_width < p_vout->fmt_render.i_visible_width )
1010 p_vout->fmt_in.i_x_offset = p_vout->fmt_render.i_x_offset +
1011 (p_vout->fmt_render.i_visible_width - i_width) / 2;
1012 p_vout->fmt_in.i_visible_width = i_width;
1016 p_vout->fmt_in.i_y_offset = p_vout->fmt_render.i_y_offset +
1017 (p_vout->fmt_render.i_visible_height - i_height) / 2;
1018 p_vout->fmt_in.i_visible_height = i_height;
1023 psz_parser = strchr( newval.psz_string, 'x' );
1026 /* Maybe we're using the <width>x<height>+<left>+<top> syntax */
1027 unsigned int i_crop_width, i_crop_height, i_crop_top, i_crop_left;
1029 i_crop_width = strtol( newval.psz_string, &psz_end, 10 );
1030 if( psz_end != psz_parser ) goto crop_end;
1032 psz_parser = strchr( ++psz_end, '+' );
1033 i_crop_height = strtol( psz_end, &psz_end, 10 );
1034 if( psz_end != psz_parser ) goto crop_end;
1036 psz_parser = strchr( ++psz_end, '+' );
1037 i_crop_left = strtol( psz_end, &psz_end, 10 );
1038 if( psz_end != psz_parser ) goto crop_end;
1041 i_crop_top = strtol( psz_end, &psz_end, 10 );
1042 if( *psz_end != '\0' ) goto crop_end;
1044 i_width = i_crop_width;
1045 p_vout->fmt_in.i_visible_width = i_width;
1047 i_height = i_crop_height;
1048 p_vout->fmt_in.i_visible_height = i_height;
1050 p_vout->fmt_in.i_x_offset = i_crop_left;
1051 p_vout->fmt_in.i_y_offset = i_crop_top;
1055 /* Maybe we're using the <left>+<top>+<right>+<bottom> syntax */
1056 unsigned int i_crop_top, i_crop_left, i_crop_bottom, i_crop_right;
1058 psz_parser = strchr( newval.psz_string, '+' );
1059 i_crop_left = strtol( newval.psz_string, &psz_end, 10 );
1060 if( psz_end != psz_parser ) goto crop_end;
1062 psz_parser = strchr( ++psz_end, '+' );
1063 i_crop_top = strtol( psz_end, &psz_end, 10 );
1064 if( psz_end != psz_parser ) goto crop_end;
1066 psz_parser = strchr( ++psz_end, '+' );
1067 i_crop_right = strtol( psz_end, &psz_end, 10 );
1068 if( psz_end != psz_parser ) goto crop_end;
1071 i_crop_bottom = strtol( psz_end, &psz_end, 10 );
1072 if( *psz_end != '\0' ) goto crop_end;
1074 i_width = p_vout->fmt_render.i_visible_width
1075 - i_crop_left - i_crop_right;
1076 p_vout->fmt_in.i_visible_width = i_width;
1078 i_height = p_vout->fmt_render.i_visible_height
1079 - i_crop_top - i_crop_bottom;
1080 p_vout->fmt_in.i_visible_height = i_height;
1082 p_vout->fmt_in.i_x_offset = i_crop_left;
1083 p_vout->fmt_in.i_y_offset = i_crop_top;
1087 else if( !strcmp( psz_cmd, "crop-top" )
1088 || !strcmp( psz_cmd, "crop-left" )
1089 || !strcmp( psz_cmd, "crop-bottom" )
1090 || !strcmp( psz_cmd, "crop-right" ) )
1092 unsigned int i_crop_top, i_crop_left, i_crop_bottom, i_crop_right;
1094 i_crop_top = var_GetInteger( p_vout, "crop-top" );
1095 i_crop_left = var_GetInteger( p_vout, "crop-left" );
1096 i_crop_right = var_GetInteger( p_vout, "crop-right" );
1097 i_crop_bottom = var_GetInteger( p_vout, "crop-bottom" );
1099 i_width = p_vout->fmt_render.i_visible_width
1100 - i_crop_left - i_crop_right;
1101 p_vout->fmt_in.i_visible_width = i_width;
1103 i_height = p_vout->fmt_render.i_visible_height
1104 - i_crop_top - i_crop_bottom;
1105 p_vout->fmt_in.i_visible_height = i_height;
1107 p_vout->fmt_in.i_x_offset = i_crop_left;
1108 p_vout->fmt_in.i_y_offset = i_crop_top;
1112 InitWindowSize( p_vout, &p_vout->i_window_width,
1113 &p_vout->i_window_height );
1115 p_vout->i_changes |= VOUT_CROP_CHANGE;
1117 msg_Dbg( p_vout, "cropping picture %ix%i to %i,%i,%ix%i",
1118 p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
1119 p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
1120 p_vout->fmt_in.i_visible_width,
1121 p_vout->fmt_in.i_visible_height );
1123 var_SetVoid( p_vout, "crop-update" );
1128 static int AspectCallback( vlc_object_t *p_this, char const *psz_cmd,
1129 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1131 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1132 unsigned int i_aspect_num, i_aspect_den, i_sar_num, i_sar_den;
1135 char *psz_end, *psz_parser = strchr( newval.psz_string, ':' );
1136 (void)psz_cmd; (void)oldval; (void)p_data;
1138 /* Restore defaults */
1139 p_vout->fmt_in.i_sar_num = p_vout->fmt_render.i_sar_num;
1140 p_vout->fmt_in.i_sar_den = p_vout->fmt_render.i_sar_den;
1141 p_vout->fmt_in.i_aspect = p_vout->fmt_render.i_aspect;
1142 p_vout->render.i_aspect = p_vout->fmt_render.i_aspect;
1144 if( !psz_parser ) goto aspect_end;
1146 i_aspect_num = strtol( newval.psz_string, &psz_end, 10 );
1147 if( psz_end == newval.psz_string || !i_aspect_num ) goto aspect_end;
1149 i_aspect_den = strtol( ++psz_parser, &psz_end, 10 );
1150 if( psz_end == psz_parser || !i_aspect_den ) goto aspect_end;
1152 i_sar_num = i_aspect_num * p_vout->fmt_render.i_visible_height;
1153 i_sar_den = i_aspect_den * p_vout->fmt_render.i_visible_width;
1154 vlc_ureduce( &i_sar_num, &i_sar_den, i_sar_num, i_sar_den, 0 );
1155 p_vout->fmt_in.i_sar_num = i_sar_num;
1156 p_vout->fmt_in.i_sar_den = i_sar_den;
1157 p_vout->fmt_in.i_aspect = i_aspect_num * VOUT_ASPECT_FACTOR / i_aspect_den;
1158 p_vout->render.i_aspect = p_vout->fmt_in.i_aspect;
1161 if( p_vout->p->i_par_num && p_vout->p->i_par_den )
1163 p_vout->fmt_in.i_sar_num *= p_vout->p->i_par_den;
1164 p_vout->fmt_in.i_sar_den *= p_vout->p->i_par_num;
1165 p_vout->fmt_in.i_aspect = p_vout->fmt_in.i_aspect *
1166 p_vout->p->i_par_den / p_vout->p->i_par_num;
1167 p_vout->render.i_aspect = p_vout->fmt_in.i_aspect;
1170 p_vout->i_changes |= VOUT_ASPECT_CHANGE;
1172 vlc_ureduce( &i_aspect_num, &i_aspect_den,
1173 p_vout->fmt_in.i_aspect, VOUT_ASPECT_FACTOR, 0 );
1174 msg_Dbg( p_vout, "new aspect-ratio %i:%i, sample aspect-ratio %i:%i",
1175 i_aspect_num, i_aspect_den,
1176 p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
1178 if( var_Get( p_vout, "crop", &val ) )
1179 return VLC_EGENERIC;
1181 int i_ret = CropCallback( p_this, "crop", val, val, 0 );
1182 free( val.psz_string );
1186 static int OnTopCallback( vlc_object_t *p_this, char const *psz_cmd,
1187 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1189 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1190 vout_Control( p_vout, VOUT_SET_STAY_ON_TOP, newval.b_bool );
1191 (void)psz_cmd; (void)oldval; (void)p_data;
1193 /* Modify libvlc as well because the vout might have to be restarted */
1194 var_Create( p_vout->p_libvlc, "video-on-top", VLC_VAR_BOOL );
1195 var_Set( p_vout->p_libvlc, "video-on-top", newval );
1200 static int FullscreenCallback( vlc_object_t *p_this, char const *psz_cmd,
1201 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1203 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1205 (void)psz_cmd; (void)oldval; (void)p_data;
1207 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1209 /* Modify libvlc as well because the vout might have to be restarted */
1210 var_Create( p_vout->p_libvlc, "fullscreen", VLC_VAR_BOOL );
1211 var_Set( p_vout->p_libvlc, "fullscreen", newval );
1214 var_Set( p_vout, "intf-change", val );
1218 static int SnapshotCallback( vlc_object_t *p_this, char const *psz_cmd,
1219 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1221 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1222 VLC_UNUSED(newval); VLC_UNUSED(p_data);
1223 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1224 vout_Control( p_vout, VOUT_SNAPSHOT );
1228 static int TitleShowCallback( vlc_object_t *p_this, char const *psz_cmd,
1229 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1231 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1233 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1234 p_vout->p->b_title_show = newval.b_bool;
1238 static int TitleTimeoutCallback( vlc_object_t *p_this, char const *psz_cmd,
1239 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1241 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
1242 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1243 p_vout->p->i_title_timeout = (mtime_t) newval.i_int;
1247 static int TitlePositionCallback( vlc_object_t *p_this, char const *psz_cmd,
1248 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1250 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1252 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1253 p_vout->p->i_title_position = newval.i_int;