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() */
39 #include <time.h> /* strftime */
41 #include <vlc_interface.h>
42 #include <vlc_block.h>
43 #include <vlc_playlist.h>
46 #include <vlc_window.h>
47 #include <vlc_image.h>
49 #include <vlc_charset.h>
51 #include <vlc_strings.h>
52 #include <vlc_charset.h>
53 #include "../libvlc.h"
54 #include "vout_internal.h"
56 /*****************************************************************************
58 *****************************************************************************/
59 static void InitWindowSize( vout_thread_t *, unsigned *, unsigned * );
61 /* Object variables callbacks */
62 static int ZoomCallback( vlc_object_t *, char const *,
63 vlc_value_t, vlc_value_t, void * );
64 static int CropCallback( vlc_object_t *, char const *,
65 vlc_value_t, vlc_value_t, void * );
66 static int AspectCallback( vlc_object_t *, char const *,
67 vlc_value_t, vlc_value_t, void * );
68 static int ScalingCallback( vlc_object_t *, char const *,
69 vlc_value_t, vlc_value_t, void * );
70 static int OnTopCallback( vlc_object_t *, char const *,
71 vlc_value_t, vlc_value_t, void * );
72 static int FullscreenCallback( vlc_object_t *, char const *,
73 vlc_value_t, vlc_value_t, void * );
74 static int SnapshotCallback( vlc_object_t *, char const *,
75 vlc_value_t, vlc_value_t, void * );
77 static int TitleShowCallback( vlc_object_t *, char const *,
78 vlc_value_t, vlc_value_t, void * );
79 static int TitleTimeoutCallback( vlc_object_t *, char const *,
80 vlc_value_t, vlc_value_t, void * );
81 static int TitlePositionCallback( vlc_object_t *, char const *,
82 vlc_value_t, vlc_value_t, void * );
85 * Creates a video output window.
86 * On Unix systems, this is an X11 drawable (handle).
87 * On Windows, this is a Win32 window (handle).
88 * Video output plugins are supposed to called this function and display the
89 * video within the resulting window, while in windowed mode.
91 * @param p_vout video output thread to create a window for
92 * @param psz_cap VLC module capability (window system type)
93 * @param pi_x_hint pointer to store the recommended horizontal position [OUT]
94 * @param pi_y_hint pointer to store the recommended vertical position [OUT]
95 * @param pi_width_hint pointer to store the recommended width [OUT]
96 * @param pi_height_hint pointer to store the recommended height [OUT]
98 * @return a vout_window_t object, or NULL in case of failure.
99 * The window is released with vout_ReleaseWindow().
101 vout_window_t *vout_RequestWindow( vout_thread_t *p_vout, const char *psz_cap,
102 int *pi_x_hint, int *pi_y_hint,
103 unsigned int *pi_width_hint,
104 unsigned int *pi_height_hint )
106 /* Get requested coordinates */
107 *pi_x_hint = var_GetInteger( p_vout, "video-x" );
108 *pi_y_hint = var_GetInteger( p_vout, "video-y" );
110 *pi_width_hint = p_vout->i_window_width;
111 *pi_height_hint = p_vout->i_window_height;
113 vout_window_t *wnd = vlc_custom_create (VLC_OBJECT(p_vout), sizeof (*wnd),
114 VLC_OBJECT_GENERIC, "window");
119 wnd->width = *pi_width_hint;
120 wnd->height = *pi_height_hint;
121 wnd->pos_x = *pi_x_hint;
122 wnd->pos_y = *pi_y_hint;
123 vlc_object_attach (wnd, p_vout);
125 wnd->module = module_need (wnd, psz_cap, NULL, false);
126 if (wnd->module == NULL)
128 msg_Dbg (wnd, "no \"%s\" window provider available", psz_cap);
129 vlc_object_release (wnd);
132 *pi_width_hint = wnd->width;
133 *pi_height_hint = wnd->height;
134 *pi_x_hint = wnd->pos_x;
135 *pi_y_hint = wnd->pos_y;
140 * Releases a window handle obtained with vout_RequestWindow().
141 * @param p_vout video output thread that allocated the window
142 * (if this is NULL; this fnction is a no-op).
144 void vout_ReleaseWindow( vout_window_t *wnd )
149 assert (wnd->module);
150 module_unneed (wnd, wnd->module);
152 vlc_object_release (wnd);
155 int vout_ControlWindow( vout_window_t *wnd, int i_query, va_list args )
160 assert (wnd->control);
161 return wnd->control (wnd, i_query, args);
164 /*****************************************************************************
165 * vout_IntfInit: called during the vout creation to initialise misc things.
166 *****************************************************************************/
170 const char *psz_label;
171 } p_zoom_values[] = {
172 { 0.25, N_("1:4 Quarter") },
173 { 0.5, N_("1:2 Half") },
174 { 1, N_("1:1 Original") },
175 { 2, N_("2:1 Double") },
180 const char *psz_value;
181 const char *psz_label;
182 } p_crop_values[] = {
183 { "", N_("Default") },
184 { "16:10", "16:10" },
186 { "185:100", "1.85:1" },
187 { "221:100", "2.21:1" },
188 { "235:100", "2.35:1" },
189 { "239:100", "2.39:1" },
198 const char *psz_value;
199 const char *psz_label;
200 } p_aspect_ratio_values[] = {
201 { "", N_("Default") },
205 { "16:10", "16:10" },
206 { "221:100", "2.21:1" },
210 static void AddCustomRatios( vout_thread_t *p_vout, const char *psz_var,
213 if( psz_list && *psz_list )
215 char *psz_cur = psz_list;
217 while( psz_cur && *psz_cur )
219 vlc_value_t val, text;
220 psz_next = strchr( psz_cur, ',' );
226 val.psz_string = psz_cur;
227 text.psz_string = psz_cur;
228 var_Change( p_vout, psz_var, VLC_VAR_ADDCHOICE, &val, &text);
234 void vout_IntfInit( vout_thread_t *p_vout )
236 vlc_value_t val, text, old_val;
237 bool b_force_par = false;
241 /* Create a few object variables we'll need later on */
242 var_Create( p_vout, "snapshot-path", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
243 var_Create( p_vout, "snapshot-prefix", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
244 var_Create( p_vout, "snapshot-format", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
245 var_Create( p_vout, "snapshot-preview", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
246 var_Create( p_vout, "snapshot-sequential",
247 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
248 var_Create( p_vout, "snapshot-num", VLC_VAR_INTEGER );
249 var_SetInteger( p_vout, "snapshot-num", 1 );
250 var_Create( p_vout, "snapshot-width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
251 var_Create( p_vout, "snapshot-height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
253 var_Create( p_vout, "width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
254 var_Create( p_vout, "height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
255 p_vout->i_alignment = var_CreateGetInteger( p_vout, "align" );
257 var_Create( p_vout, "video-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
258 var_Create( p_vout, "video-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
260 var_Create( p_vout, "mouse-hide-timeout",
261 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
263 p_vout->p->b_title_show = var_CreateGetBool( p_vout, "video-title-show" );
264 p_vout->p->i_title_timeout =
265 (mtime_t)var_CreateGetInteger( p_vout, "video-title-timeout" );
266 p_vout->p->i_title_position =
267 var_CreateGetInteger( p_vout, "video-title-position" );
268 p_vout->p->psz_title = NULL;
270 var_AddCallback( p_vout, "video-title-show", TitleShowCallback, NULL );
271 var_AddCallback( p_vout, "video-title-timeout", TitleTimeoutCallback, NULL );
272 var_AddCallback( p_vout, "video-title-position", TitlePositionCallback, NULL );
274 /* Zoom object var */
275 var_Create( p_vout, "zoom", VLC_VAR_FLOAT | VLC_VAR_ISCOMMAND |
276 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
278 text.psz_string = _("Zoom");
279 var_Change( p_vout, "zoom", VLC_VAR_SETTEXT, &text, NULL );
281 var_Get( p_vout, "zoom", &old_val );
283 for( i = 0; p_zoom_values[i].f_value; i++ )
285 if( old_val.f_float == p_zoom_values[i].f_value )
286 var_Change( p_vout, "zoom", VLC_VAR_DELCHOICE, &old_val, NULL );
287 val.f_float = p_zoom_values[i].f_value;
288 text.psz_string = _( p_zoom_values[i].psz_label );
289 var_Change( p_vout, "zoom", VLC_VAR_ADDCHOICE, &val, &text );
292 var_Set( p_vout, "zoom", old_val ); /* Is this really needed? */
294 var_AddCallback( p_vout, "zoom", ZoomCallback, NULL );
296 /* Crop offset vars */
297 var_Create( p_vout, "crop-left", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
298 var_Create( p_vout, "crop-top", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
299 var_Create( p_vout, "crop-right", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
300 var_Create( p_vout, "crop-bottom", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
302 var_AddCallback( p_vout, "crop-left", CropCallback, NULL );
303 var_AddCallback( p_vout, "crop-top", CropCallback, NULL );
304 var_AddCallback( p_vout, "crop-right", CropCallback, NULL );
305 var_AddCallback( p_vout, "crop-bottom", CropCallback, NULL );
307 /* Crop object var */
308 var_Create( p_vout, "crop", VLC_VAR_STRING | VLC_VAR_ISCOMMAND |
309 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
311 text.psz_string = _("Crop");
312 var_Change( p_vout, "crop", VLC_VAR_SETTEXT, &text, NULL );
314 val.psz_string = (char*)"";
315 var_Change( p_vout, "crop", VLC_VAR_DELCHOICE, &val, 0 );
317 for( i = 0; p_crop_values[i].psz_value; i++ )
319 val.psz_string = (char*)p_crop_values[i].psz_value;
320 text.psz_string = _( p_crop_values[i].psz_label );
321 var_Change( p_vout, "crop", VLC_VAR_ADDCHOICE, &val, &text );
324 /* update triggered every time the vout's crop parameters are changed */
325 var_Create( p_vout, "crop-update", VLC_VAR_VOID );
327 /* Add custom crop ratios */
328 psz_buf = config_GetPsz( p_vout, "custom-crop-ratios" );
329 AddCustomRatios( p_vout, "crop", psz_buf );
332 var_AddCallback( p_vout, "crop", CropCallback, NULL );
333 var_Get( p_vout, "crop", &old_val );
334 if( old_val.psz_string && *old_val.psz_string )
335 var_TriggerCallback( p_vout, "crop" );
336 free( old_val.psz_string );
338 /* Monitor pixel aspect-ratio */
339 var_Create( p_vout, "monitor-par", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
340 var_Get( p_vout, "monitor-par", &val );
341 if( val.psz_string && *val.psz_string )
343 char *psz_parser = strchr( val.psz_string, ':' );
344 unsigned int i_aspect_num = 0, i_aspect_den = 0;
348 i_aspect_num = strtol( val.psz_string, 0, 10 );
349 i_aspect_den = strtol( ++psz_parser, 0, 10 );
353 i_aspect = atof( val.psz_string );
354 vlc_ureduce( &i_aspect_num, &i_aspect_den,
355 i_aspect *VOUT_ASPECT_FACTOR, VOUT_ASPECT_FACTOR, 0 );
357 if( !i_aspect_num || !i_aspect_den ) i_aspect_num = i_aspect_den = 1;
359 p_vout->p->i_par_num = i_aspect_num;
360 p_vout->p->i_par_den = i_aspect_den;
362 vlc_ureduce( &p_vout->p->i_par_num, &p_vout->p->i_par_den,
363 p_vout->p->i_par_num, p_vout->p->i_par_den, 0 );
365 msg_Dbg( p_vout, "overriding monitor pixel aspect-ratio: %i:%i",
366 p_vout->p->i_par_num, p_vout->p->i_par_den );
369 free( val.psz_string );
371 /* Aspect-ratio object var */
372 var_Create( p_vout, "aspect-ratio", VLC_VAR_STRING | VLC_VAR_ISCOMMAND |
373 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
375 text.psz_string = _("Aspect-ratio");
376 var_Change( p_vout, "aspect-ratio", VLC_VAR_SETTEXT, &text, NULL );
378 val.psz_string = (char*)"";
379 var_Change( p_vout, "aspect-ratio", VLC_VAR_DELCHOICE, &val, 0 );
381 for( i = 0; p_aspect_ratio_values[i].psz_value; i++ )
383 val.psz_string = (char*)p_aspect_ratio_values[i].psz_value;
384 text.psz_string = _( p_aspect_ratio_values[i].psz_label );
385 var_Change( p_vout, "aspect-ratio", VLC_VAR_ADDCHOICE, &val, &text );
388 /* Add custom aspect ratios */
389 psz_buf = config_GetPsz( p_vout, "custom-aspect-ratios" );
390 AddCustomRatios( p_vout, "aspect-ratio", psz_buf );
393 var_AddCallback( p_vout, "aspect-ratio", AspectCallback, NULL );
394 var_Get( p_vout, "aspect-ratio", &old_val );
395 if( (old_val.psz_string && *old_val.psz_string) || b_force_par )
396 var_TriggerCallback( p_vout, "aspect-ratio" );
397 free( old_val.psz_string );
399 /* Add variables to manage scaling video */
400 var_Create( p_vout, "autoscale", VLC_VAR_BOOL | VLC_VAR_DOINHERIT
401 | VLC_VAR_ISCOMMAND );
402 text.psz_string = _("Autoscale video");
403 var_Change( p_vout, "autoscale", VLC_VAR_SETTEXT, &text, NULL );
404 var_AddCallback( p_vout, "autoscale", ScalingCallback, NULL );
405 p_vout->b_autoscale = var_GetBool( p_vout, "autoscale" );
407 var_Create( p_vout, "scale", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
408 | VLC_VAR_ISCOMMAND );
409 text.psz_string = _("Scale factor");
410 var_Change( p_vout, "scale", VLC_VAR_SETTEXT, &text, NULL );
411 var_AddCallback( p_vout, "scale", ScalingCallback, NULL );
412 p_vout->i_zoom = (int)( ZOOM_FP_FACTOR * var_GetFloat( p_vout, "scale" ) );
414 /* Initialize the dimensions of the video window */
415 InitWindowSize( p_vout, &p_vout->i_window_width,
416 &p_vout->i_window_height );
418 /* Add a variable to indicate if the window should be on top of others */
419 var_Create( p_vout, "video-on-top", VLC_VAR_BOOL | VLC_VAR_DOINHERIT
420 | VLC_VAR_ISCOMMAND );
421 text.psz_string = _("Always on top");
422 var_Change( p_vout, "video-on-top", VLC_VAR_SETTEXT, &text, NULL );
423 var_AddCallback( p_vout, "video-on-top", OnTopCallback, NULL );
425 /* Add a variable to indicate whether we want window decoration or not */
426 var_Create( p_vout, "video-deco", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
428 /* Add a fullscreen variable */
429 if( var_CreateGetBoolCommand( p_vout, "fullscreen" ) )
431 /* user requested fullscreen */
432 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
434 text.psz_string = _("Fullscreen");
435 var_Change( p_vout, "fullscreen", VLC_VAR_SETTEXT, &text, NULL );
436 var_AddCallback( p_vout, "fullscreen", FullscreenCallback, NULL );
438 /* Add a snapshot variable */
439 var_Create( p_vout, "video-snapshot", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
440 text.psz_string = _("Snapshot");
441 var_Change( p_vout, "video-snapshot", VLC_VAR_SETTEXT, &text, NULL );
442 var_AddCallback( p_vout, "video-snapshot", SnapshotCallback, NULL );
444 /* Mouse coordinates */
445 var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
446 var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
447 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
448 var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
449 var_Create( p_vout, "mouse-clicked", VLC_VAR_BOOL );
451 var_Create( p_vout, "intf-change", VLC_VAR_BOOL );
452 var_SetBool( p_vout, "intf-change", true );
455 /*****************************************************************************
456 * vout_Snapshot: generates a snapshot.
457 *****************************************************************************/
459 * This function will inject a subpicture into the vout with the provided
462 static int VoutSnapshotPip( vout_thread_t *p_vout, picture_t *p_pic )
464 video_format_t fmt_in = p_pic->format;
465 video_format_t fmt_out;
467 subpicture_t *p_subpic;
470 memset( &fmt_out, 0, sizeof(fmt_out) );
472 fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
475 image_handler_t *p_image = image_HandlerCreate( p_vout );
479 p_pip = image_Convert( p_image, p_pic, &fmt_in, &fmt_out );
481 image_HandlerDelete( p_image );
486 p_subpic = subpicture_New();
489 picture_Release( p_pip );
493 p_subpic->i_channel = 0;
494 p_subpic->i_start = mdate();
495 p_subpic->i_stop = mdate() + 4000000;
496 p_subpic->b_ephemer = true;
497 p_subpic->b_fade = true;
498 p_subpic->i_original_picture_width = fmt_out.i_width * 4;
499 p_subpic->i_original_picture_height = fmt_out.i_height * 4;
500 fmt_out.i_aspect = 0;
502 fmt_out.i_sar_den = 0;
504 p_subpic->p_region = subpicture_region_New( &fmt_out );
505 if( p_subpic->p_region )
507 picture_Release( p_subpic->p_region->p_picture );
508 p_subpic->p_region->p_picture = p_pip;
512 picture_Release( p_pip );
515 spu_DisplaySubpicture( p_vout->p_spu, p_subpic );
519 * This function will return the default directory used for snapshots
521 static char *VoutSnapshotGetDefaultDirectory( void )
523 char *psz_path = NULL;
524 #if defined(__APPLE__) || defined(SYS_BEOS)
526 if( asprintf( &psz_path, "%s/Desktop",
527 config_GetHomeDir() ) == -1 )
530 #elif defined(WIN32) && !defined(UNDER_CE)
532 /* Get the My Pictures folder path */
533 char *p_mypicturesdir = NULL;
534 typedef HRESULT (WINAPI *SHGETFOLDERPATH)( HWND, int, HANDLE, DWORD,
536 #ifndef CSIDL_FLAG_CREATE
537 # define CSIDL_FLAG_CREATE 0x8000
539 #ifndef CSIDL_MYPICTURES
540 # define CSIDL_MYPICTURES 0x27
542 #ifndef SHGFP_TYPE_CURRENT
543 # define SHGFP_TYPE_CURRENT 0
546 HINSTANCE shfolder_dll;
547 SHGETFOLDERPATH SHGetFolderPath ;
549 /* load the shfolder dll to retrieve SHGetFolderPath */
550 if( ( shfolder_dll = LoadLibrary( _T("SHFolder.dll") ) ) != NULL )
552 wchar_t wdir[PATH_MAX];
553 SHGetFolderPath = (void *)GetProcAddress( shfolder_dll,
554 _T("SHGetFolderPathW") );
555 if ((SHGetFolderPath != NULL )
556 && SUCCEEDED (SHGetFolderPath (NULL,
557 CSIDL_MYPICTURES | CSIDL_FLAG_CREATE,
558 NULL, SHGFP_TYPE_CURRENT,
560 p_mypicturesdir = FromWide (wdir);
562 FreeLibrary( shfolder_dll );
565 if( p_mypicturesdir == NULL )
566 psz_path = strdup( config_GetHomeDir() );
568 psz_path = p_mypicturesdir;
572 /* XXX: This saves in the data directory. Shouldn't we try saving
573 * to psz_homedir/Desktop or something nicer ? */
574 char *psz_datadir = config_GetUserDataDir();
577 if( asprintf( &psz_path, "%s", psz_datadir ) == -1 )
587 * This function will save a video snapshot to a file
589 static int VoutWriteSnapshot( vout_thread_t *p_vout, char **ppsz_filename,
590 const block_t *p_image,
591 const char *psz_path,
592 const char *psz_format,
593 const char *psz_prefix_fmt )
597 DIR *p_path = utf8_opendir( psz_path );
600 /* The use specified a directory path */
604 char *psz_prefix = NULL;
606 psz_prefix = str_format( p_vout, psz_prefix_fmt );
609 psz_prefix = strdup( "vlcsnap-" );
614 if( var_GetBool( p_vout, "snapshot-sequential" ) )
616 int i_num = var_GetInteger( p_vout, "snapshot-num" );
621 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%05d.%s",
622 psz_path, psz_prefix, i_num++, psz_format ) < 0 )
627 if( utf8_stat( psz_filename, &st ) )
629 free( psz_filename );
632 var_SetInteger( p_vout, "snapshot-num", i_num );
637 time_t lcurtime = time( NULL ) ;
639 if( !localtime_r( &lcurtime, &curtime ) )
641 const unsigned int i_id = (p_image->i_pts / 100000) & 0xFFFFFF;
643 msg_Warn( p_vout, "failed to get current time. Falling back to legacy snapshot naming" );
645 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%u.%s",
646 psz_path, psz_prefix, i_id, psz_format ) < 0 )
651 /* suffix with the last decimal digit in 10s of seconds resolution
653 const int i_id = (p_image->i_pts / (100*1000)) & 0xFF;
654 char psz_curtime[128];
656 if( !strftime( psz_curtime, sizeof(psz_curtime), "%Y-%m-%d-%Hh%Mm%Ss", &curtime ) )
657 strcpy( psz_curtime, "error" );
659 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%s%1u.%s",
660 psz_path, psz_prefix, psz_curtime, i_id, psz_format ) < 0 )
668 /* The user specified a full path name (including file name) */
669 psz_filename = str_format( p_vout, psz_path );
670 path_sanitize( psz_filename );
676 /* Save the snapshot */
677 FILE *p_file = utf8_fopen( psz_filename, "wb" );
680 msg_Err( p_vout, "Failed to open '%s'", psz_filename );
681 free( psz_filename );
684 if( fwrite( p_image->p_buffer, p_image->i_buffer, 1, p_file ) != 1 )
686 msg_Err( p_vout, "Failed to write to '%s'", psz_filename );
688 free( psz_filename );
695 *ppsz_filename = psz_filename;
697 free( psz_filename );
702 msg_Err( p_vout, "could not save snapshot" );
707 * This function will display the name and a PIP of the provided snapshot
709 static void VoutOsdSnapshot( vout_thread_t *p_vout, picture_t *p_pic, const char *psz_filename )
711 msg_Dbg( p_vout, "snapshot taken (%s)", psz_filename );
712 vout_OSDMessage( VLC_OBJECT( p_vout ), DEFAULT_CHAN, "%s", psz_filename );
714 if( var_GetBool( p_vout, "snapshot-preview" ) )
716 if( VoutSnapshotPip( p_vout, p_pic ) )
717 msg_Warn( p_vout, "Failed to display snapshot" );
722 int vout_GetSnapshot( vout_thread_t *p_vout,
723 block_t **pp_image, picture_t **pp_picture,
724 video_format_t *p_fmt,
725 const char *psz_format, mtime_t i_timeout )
727 vout_thread_sys_t *p_sys = p_vout->p;
729 vlc_mutex_lock( &p_sys->snapshot.lock );
730 p_sys->snapshot.i_request++;
732 const mtime_t i_deadline = mdate() + i_timeout;
733 while( p_sys->snapshot.b_available && !p_sys->snapshot.p_picture &&
734 mdate() < i_deadline )
736 vlc_cond_timedwait( &p_sys->snapshot.wait, &p_sys->snapshot.lock,
740 picture_t *p_picture = p_sys->snapshot.p_picture;
742 p_sys->snapshot.p_picture = p_picture->p_next;
743 else if( p_sys->snapshot.i_request > 0 )
744 p_sys->snapshot.i_request--;
745 vlc_mutex_unlock( &p_sys->snapshot.lock );
749 msg_Err( p_vout, "Failed to grab a snapshot" );
755 vlc_fourcc_t i_format = VLC_FOURCC('p','n','g',' ');
756 if( psz_format && image_Type2Fourcc( psz_format ) )
757 i_format = image_Type2Fourcc( psz_format );
759 const int i_override_width = var_GetInteger( p_vout, "snapshot-width" );
760 const int i_override_height = var_GetInteger( p_vout, "snapshot-height" );
762 if( picture_Export( VLC_OBJECT(p_vout), pp_image, p_fmt,
763 p_picture, i_format, i_override_width, i_override_height ) )
765 msg_Err( p_vout, "Failed to convert image for snapshot" );
766 picture_Release( p_picture );
771 *pp_picture = p_picture;
773 picture_Release( p_picture );
778 * This function will handle a snapshot request
780 static void VoutSaveSnapshot( vout_thread_t *p_vout )
782 char *psz_path = var_GetNonEmptyString( p_vout, "snapshot-path" );
783 char *psz_format = var_GetNonEmptyString( p_vout, "snapshot-format" );
784 char *psz_prefix = var_GetNonEmptyString( p_vout, "snapshot-prefix" );
787 picture_t *p_picture;
792 * XXX it will cause trouble with low fps video (< 2fps) */
793 if( vout_GetSnapshot( p_vout, &p_image, &p_picture, &fmt, psz_format, 500*1000 ) )
802 psz_path = VoutSnapshotGetDefaultDirectory();
805 msg_Err( p_vout, "no path specified for snapshots" );
811 if( VoutWriteSnapshot( p_vout, &psz_filename,
813 psz_path, psz_format, psz_prefix ) )
816 VoutOsdSnapshot( p_vout, p_picture, psz_filename );
818 /* Generate a media player event - Right now just trigger a global libvlc var
819 CHECK: Could not find a more local object. The goal is to communicate
820 vout_thread with libvlc_media_player or its input_thread */
821 var_SetString( p_vout->p_libvlc, "vout-snapshottaken", psz_filename );
822 free( psz_filename );
826 block_Release( p_image );
828 picture_Release( p_picture );
834 /*****************************************************************************
836 *****************************************************************************/
838 void vout_EnableFilter( vout_thread_t *p_vout, char *psz_name,
839 bool b_add, bool b_setconfig )
842 char *psz_string = config_GetPsz( p_vout, "vout-filter" );
844 /* Todo : Use some generic chain manipulation functions */
845 if( !psz_string ) psz_string = strdup("");
847 psz_parser = strstr( psz_string, psz_name );
852 psz_parser = psz_string;
853 if( asprintf( &psz_string, (*psz_string) ? "%s:%s" : "%s%s",
854 psz_string, psz_name ) == -1 )
868 memmove( psz_parser, psz_parser + strlen(psz_name) +
869 (*(psz_parser + strlen(psz_name)) == ':' ? 1 : 0 ),
870 strlen(psz_parser + strlen(psz_name)) + 1 );
872 /* Remove trailing : : */
873 if( *(psz_string+strlen(psz_string ) -1 ) == ':' )
875 *(psz_string+strlen(psz_string ) -1 ) = '\0';
885 config_PutPsz( p_vout, "vout-filter", psz_string );
887 var_SetString( p_vout, "vout-filter", psz_string );
891 /*****************************************************************************
892 * InitWindowSize: find the initial dimensions the video window should have.
893 *****************************************************************************
894 * This function will check the "width", "height" and "zoom" config options and
895 * will calculate the size that the video window should have.
896 *****************************************************************************/
897 static void InitWindowSize( vout_thread_t *p_vout, unsigned *pi_width,
898 unsigned *pi_height )
900 #define FP_FACTOR 1000 /* our fixed point factor */
902 int i_width = var_GetInteger( p_vout, "width" );
903 int i_height = var_GetInteger( p_vout, "height" );
904 float f_zoom = var_GetFloat( p_vout, "zoom" );
905 uint64_t ll_zoom = (uint64_t)( FP_FACTOR * f_zoom );
907 if( i_width > 0 && i_height > 0)
909 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
910 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
912 else if( i_width > 0 )
914 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
915 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom *
916 p_vout->fmt_in.i_sar_den * i_width / p_vout->fmt_in.i_sar_num /
917 FP_FACTOR / p_vout->fmt_in.i_visible_width );
919 else if( i_height > 0 )
921 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
922 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom *
923 p_vout->fmt_in.i_sar_num * i_height / p_vout->fmt_in.i_sar_den /
924 FP_FACTOR / p_vout->fmt_in.i_visible_height );
926 else if( p_vout->fmt_in.i_sar_num == 0 || p_vout->fmt_in.i_sar_den == 0 )
928 msg_Warn( p_vout, "aspect ratio screwed up" );
929 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom / FP_FACTOR );
930 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom /FP_FACTOR);
932 else if( p_vout->fmt_in.i_sar_num >= p_vout->fmt_in.i_sar_den )
934 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom *
935 p_vout->fmt_in.i_sar_num / p_vout->fmt_in.i_sar_den / FP_FACTOR );
936 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom
941 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom
943 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom *
944 p_vout->fmt_in.i_sar_den / p_vout->fmt_in.i_sar_num / FP_FACTOR );
947 msg_Dbg( p_vout, "window size: %ux%u", *pi_width, *pi_height );
952 /*****************************************************************************
953 * Object variables callbacks
954 *****************************************************************************/
955 static int ZoomCallback( vlc_object_t *p_this, char const *psz_cmd,
956 vlc_value_t oldval, vlc_value_t newval, void *p_data )
958 vout_thread_t *p_vout = (vout_thread_t *)p_this;
959 (void)psz_cmd; (void)oldval; (void)newval; (void)p_data;
960 InitWindowSize( p_vout, &p_vout->i_window_width,
961 &p_vout->i_window_height );
962 vout_Control( p_vout, VOUT_SET_SIZE, p_vout->i_window_width,
963 p_vout->i_window_height );
967 static int CropCallback( vlc_object_t *p_this, char const *psz_cmd,
968 vlc_value_t oldval, vlc_value_t newval, void *p_data )
970 vout_thread_t *p_vout = (vout_thread_t *)p_this;
971 int64_t i_aspect_num, i_aspect_den;
972 unsigned int i_width, i_height;
974 (void)oldval; (void)p_data;
976 /* Restore defaults */
977 p_vout->fmt_in.i_x_offset = p_vout->fmt_render.i_x_offset;
978 p_vout->fmt_in.i_visible_width = p_vout->fmt_render.i_visible_width;
979 p_vout->fmt_in.i_y_offset = p_vout->fmt_render.i_y_offset;
980 p_vout->fmt_in.i_visible_height = p_vout->fmt_render.i_visible_height;
982 if( !strcmp( psz_cmd, "crop" ) )
984 char *psz_end = NULL, *psz_parser = strchr( newval.psz_string, ':' );
987 /* We're using the 3:4 syntax */
988 i_aspect_num = strtol( newval.psz_string, &psz_end, 10 );
989 if( psz_end == newval.psz_string || !i_aspect_num ) goto crop_end;
991 i_aspect_den = strtol( ++psz_parser, &psz_end, 10 );
992 if( psz_end == psz_parser || !i_aspect_den ) goto crop_end;
994 i_width = p_vout->fmt_in.i_sar_den*p_vout->fmt_render.i_visible_height *
995 i_aspect_num / i_aspect_den / p_vout->fmt_in.i_sar_num;
996 i_height = p_vout->fmt_render.i_visible_width*p_vout->fmt_in.i_sar_num *
997 i_aspect_den / i_aspect_num / p_vout->fmt_in.i_sar_den;
999 if( i_width < p_vout->fmt_render.i_visible_width )
1001 p_vout->fmt_in.i_x_offset = p_vout->fmt_render.i_x_offset +
1002 (p_vout->fmt_render.i_visible_width - i_width) / 2;
1003 p_vout->fmt_in.i_visible_width = i_width;
1007 p_vout->fmt_in.i_y_offset = p_vout->fmt_render.i_y_offset +
1008 (p_vout->fmt_render.i_visible_height - i_height) / 2;
1009 p_vout->fmt_in.i_visible_height = i_height;
1014 psz_parser = strchr( newval.psz_string, 'x' );
1017 /* Maybe we're using the <width>x<height>+<left>+<top> syntax */
1018 unsigned int i_crop_width, i_crop_height, i_crop_top, i_crop_left;
1020 i_crop_width = strtol( newval.psz_string, &psz_end, 10 );
1021 if( psz_end != psz_parser ) goto crop_end;
1023 psz_parser = strchr( ++psz_end, '+' );
1024 i_crop_height = strtol( psz_end, &psz_end, 10 );
1025 if( psz_end != psz_parser ) goto crop_end;
1027 psz_parser = strchr( ++psz_end, '+' );
1028 i_crop_left = strtol( psz_end, &psz_end, 10 );
1029 if( psz_end != psz_parser ) goto crop_end;
1032 i_crop_top = strtol( psz_end, &psz_end, 10 );
1033 if( *psz_end != '\0' ) goto crop_end;
1035 if( i_crop_top + i_crop_height >= p_vout->fmt_render.i_visible_height ||
1036 i_crop_left + i_crop_width >= p_vout->fmt_render.i_visible_width )
1038 msg_Err( p_vout, "Unable to crop over picture boundaries");
1039 return VLC_EGENERIC;
1042 i_width = i_crop_width;
1043 p_vout->fmt_in.i_visible_width = i_width;
1045 i_height = i_crop_height;
1046 p_vout->fmt_in.i_visible_height = i_height;
1048 p_vout->fmt_in.i_x_offset = i_crop_left;
1049 p_vout->fmt_in.i_y_offset = i_crop_top;
1053 /* Maybe we're using the <left>+<top>+<right>+<bottom> syntax */
1054 unsigned int i_crop_top, i_crop_left, i_crop_bottom, i_crop_right;
1056 psz_parser = strchr( newval.psz_string, '+' );
1057 i_crop_left = strtol( newval.psz_string, &psz_end, 10 );
1058 if( psz_end != psz_parser ) goto crop_end;
1060 psz_parser = strchr( ++psz_end, '+' );
1061 i_crop_top = strtol( psz_end, &psz_end, 10 );
1062 if( psz_end != psz_parser ) goto crop_end;
1064 psz_parser = strchr( ++psz_end, '+' );
1065 i_crop_right = strtol( psz_end, &psz_end, 10 );
1066 if( psz_end != psz_parser ) goto crop_end;
1069 i_crop_bottom = strtol( psz_end, &psz_end, 10 );
1070 if( *psz_end != '\0' ) goto crop_end;
1072 if( i_crop_top + i_crop_bottom >= p_vout->fmt_render.i_visible_height ||
1073 i_crop_right + i_crop_left >= p_vout->fmt_render.i_visible_width )
1075 msg_Err( p_vout, "Unable to crop over picture boundaries" );
1076 return VLC_EGENERIC;
1079 i_width = p_vout->fmt_render.i_visible_width
1080 - i_crop_left - i_crop_right;
1081 p_vout->fmt_in.i_visible_width = i_width;
1083 i_height = p_vout->fmt_render.i_visible_height
1084 - i_crop_top - i_crop_bottom;
1085 p_vout->fmt_in.i_visible_height = i_height;
1087 p_vout->fmt_in.i_x_offset = i_crop_left;
1088 p_vout->fmt_in.i_y_offset = i_crop_top;
1092 else if( !strcmp( psz_cmd, "crop-top" )
1093 || !strcmp( psz_cmd, "crop-left" )
1094 || !strcmp( psz_cmd, "crop-bottom" )
1095 || !strcmp( psz_cmd, "crop-right" ) )
1097 unsigned int i_crop_top, i_crop_left, i_crop_bottom, i_crop_right;
1099 i_crop_top = var_GetInteger( p_vout, "crop-top" );
1100 i_crop_left = var_GetInteger( p_vout, "crop-left" );
1101 i_crop_right = var_GetInteger( p_vout, "crop-right" );
1102 i_crop_bottom = var_GetInteger( p_vout, "crop-bottom" );
1104 if( i_crop_top + i_crop_bottom >= p_vout->fmt_render.i_visible_height ||
1105 i_crop_right + i_crop_left >= p_vout->fmt_render.i_visible_width )
1107 msg_Err( p_vout, "Unable to crop over picture boundaries" );
1108 return VLC_EGENERIC;
1111 i_width = p_vout->fmt_render.i_visible_width
1112 - i_crop_left - i_crop_right;
1113 p_vout->fmt_in.i_visible_width = i_width;
1115 i_height = p_vout->fmt_render.i_visible_height
1116 - i_crop_top - i_crop_bottom;
1117 p_vout->fmt_in.i_visible_height = i_height;
1119 p_vout->fmt_in.i_x_offset = i_crop_left;
1120 p_vout->fmt_in.i_y_offset = i_crop_top;
1124 InitWindowSize( p_vout, &p_vout->i_window_width,
1125 &p_vout->i_window_height );
1127 p_vout->i_changes |= VOUT_CROP_CHANGE;
1129 msg_Dbg( p_vout, "cropping picture %ix%i to %i,%i,%ix%i",
1130 p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
1131 p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
1132 p_vout->fmt_in.i_visible_width,
1133 p_vout->fmt_in.i_visible_height );
1135 var_SetVoid( p_vout, "crop-update" );
1140 static int AspectCallback( vlc_object_t *p_this, char const *psz_cmd,
1141 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1143 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1144 unsigned int i_aspect_num, i_aspect_den, i_sar_num, i_sar_den;
1147 char *psz_end, *psz_parser = strchr( newval.psz_string, ':' );
1148 (void)psz_cmd; (void)oldval; (void)p_data;
1150 /* Restore defaults */
1151 p_vout->fmt_in.i_sar_num = p_vout->fmt_render.i_sar_num;
1152 p_vout->fmt_in.i_sar_den = p_vout->fmt_render.i_sar_den;
1153 p_vout->fmt_in.i_aspect = p_vout->fmt_render.i_aspect;
1154 p_vout->render.i_aspect = p_vout->fmt_render.i_aspect;
1156 if( !psz_parser ) goto aspect_end;
1158 i_aspect_num = strtol( newval.psz_string, &psz_end, 10 );
1159 if( psz_end == newval.psz_string || !i_aspect_num ) goto aspect_end;
1161 i_aspect_den = strtol( ++psz_parser, &psz_end, 10 );
1162 if( psz_end == psz_parser || !i_aspect_den ) goto aspect_end;
1164 i_sar_num = i_aspect_num * p_vout->fmt_render.i_visible_height;
1165 i_sar_den = i_aspect_den * p_vout->fmt_render.i_visible_width;
1166 vlc_ureduce( &i_sar_num, &i_sar_den, i_sar_num, i_sar_den, 0 );
1167 p_vout->fmt_in.i_sar_num = i_sar_num;
1168 p_vout->fmt_in.i_sar_den = i_sar_den;
1169 p_vout->fmt_in.i_aspect = i_aspect_num * VOUT_ASPECT_FACTOR / i_aspect_den;
1170 p_vout->render.i_aspect = p_vout->fmt_in.i_aspect;
1173 if( p_vout->p->i_par_num && p_vout->p->i_par_den )
1175 p_vout->fmt_in.i_sar_num *= p_vout->p->i_par_den;
1176 p_vout->fmt_in.i_sar_den *= p_vout->p->i_par_num;
1177 p_vout->fmt_in.i_aspect = p_vout->fmt_in.i_aspect *
1178 p_vout->p->i_par_den / p_vout->p->i_par_num;
1179 p_vout->render.i_aspect = p_vout->fmt_in.i_aspect;
1182 p_vout->i_changes |= VOUT_ASPECT_CHANGE;
1184 vlc_ureduce( &i_aspect_num, &i_aspect_den,
1185 p_vout->fmt_in.i_aspect, VOUT_ASPECT_FACTOR, 0 );
1186 msg_Dbg( p_vout, "new aspect-ratio %i:%i, sample aspect-ratio %i:%i",
1187 i_aspect_num, i_aspect_den,
1188 p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
1190 if( var_Get( p_vout, "crop", &val ) )
1191 return VLC_EGENERIC;
1193 int i_ret = CropCallback( p_this, "crop", val, val, 0 );
1194 free( val.psz_string );
1198 static int ScalingCallback( vlc_object_t *p_this, char const *psz_cmd,
1199 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1201 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1202 (void)oldval; (void)newval; (void)p_data;
1204 vlc_mutex_lock( &p_vout->change_lock );
1206 if( !strcmp( psz_cmd, "autoscale" ) )
1208 p_vout->i_changes |= VOUT_SCALE_CHANGE;
1210 else if( !strcmp( psz_cmd, "scale" ) )
1212 p_vout->i_changes |= VOUT_ZOOM_CHANGE;
1215 vlc_mutex_unlock( &p_vout->change_lock );
1220 static int OnTopCallback( vlc_object_t *p_this, char const *psz_cmd,
1221 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1223 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1225 vlc_mutex_lock( &p_vout->change_lock );
1226 p_vout->i_changes |= VOUT_ON_TOP_CHANGE;
1227 p_vout->b_on_top = newval.b_bool;
1228 vlc_mutex_unlock( &p_vout->change_lock );
1230 /* Modify libvlc as well because the vout might have to be restarted */
1231 var_Create( p_vout->p_libvlc, "video-on-top", VLC_VAR_BOOL );
1232 var_Set( p_vout->p_libvlc, "video-on-top", newval );
1234 (void)psz_cmd; (void)oldval; (void)p_data;
1238 static int FullscreenCallback( vlc_object_t *p_this, char const *psz_cmd,
1239 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1241 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1243 (void)psz_cmd; (void)oldval; (void)p_data;
1245 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1247 /* Modify libvlc as well because the vout might have to be restarted */
1248 var_Create( p_vout->p_libvlc, "fullscreen", VLC_VAR_BOOL );
1249 var_Set( p_vout->p_libvlc, "fullscreen", newval );
1252 var_Set( p_vout, "intf-change", val );
1256 static int SnapshotCallback( vlc_object_t *p_this, char const *psz_cmd,
1257 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1259 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1260 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1261 VLC_UNUSED(newval); VLC_UNUSED(p_data);
1263 VoutSaveSnapshot( p_vout );
1267 static int TitleShowCallback( vlc_object_t *p_this, char const *psz_cmd,
1268 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1270 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1272 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1273 p_vout->p->b_title_show = newval.b_bool;
1277 static int TitleTimeoutCallback( vlc_object_t *p_this, char const *psz_cmd,
1278 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1280 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
1281 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1282 p_vout->p->i_title_timeout = (mtime_t) newval.i_int;
1286 static int TitlePositionCallback( vlc_object_t *p_this, char const *psz_cmd,
1287 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1289 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1291 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1292 p_vout->p->i_title_position = newval.i_int;