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, image_handler_t *p_image, picture_t *p_pic, const video_format_t *p_fmt_in )
464 video_format_t fmt_in = *p_fmt_in;
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 p_pip = image_Convert( p_image, p_pic, &fmt_in, &fmt_out );
479 p_subpic = subpicture_New();
480 if( p_subpic == NULL )
482 picture_Release( p_pip );
486 p_subpic->i_channel = 0;
487 p_subpic->i_start = mdate();
488 p_subpic->i_stop = mdate() + 4000000;
489 p_subpic->b_ephemer = true;
490 p_subpic->b_fade = true;
491 p_subpic->i_original_picture_width = fmt_out.i_width * 4;
492 p_subpic->i_original_picture_height = fmt_out.i_height * 4;
493 fmt_out.i_aspect = 0;
495 fmt_out.i_sar_den = 0;
497 p_subpic->p_region = subpicture_region_New( &fmt_out );
498 if( p_subpic->p_region )
500 picture_Release( p_subpic->p_region->p_picture );
501 p_subpic->p_region->p_picture = p_pip;
505 picture_Release( p_pip );
508 spu_DisplaySubpicture( p_vout->p_spu, p_subpic );
512 * This function will return the default directory used for snapshots
514 static char *VoutSnapshotGetDefaultDirectory( void )
516 char *psz_path = NULL;
517 #if defined(__APPLE__) || defined(SYS_BEOS)
519 if( asprintf( &psz_path, "%s/Desktop",
520 config_GetHomeDir() ) == -1 )
523 #elif defined(WIN32) && !defined(UNDER_CE)
525 /* Get the My Pictures folder path */
526 char *p_mypicturesdir = NULL;
527 typedef HRESULT (WINAPI *SHGETFOLDERPATH)( HWND, int, HANDLE, DWORD,
529 #ifndef CSIDL_FLAG_CREATE
530 # define CSIDL_FLAG_CREATE 0x8000
532 #ifndef CSIDL_MYPICTURES
533 # define CSIDL_MYPICTURES 0x27
535 #ifndef SHGFP_TYPE_CURRENT
536 # define SHGFP_TYPE_CURRENT 0
539 HINSTANCE shfolder_dll;
540 SHGETFOLDERPATH SHGetFolderPath ;
542 /* load the shfolder dll to retrieve SHGetFolderPath */
543 if( ( shfolder_dll = LoadLibrary( _T("SHFolder.dll") ) ) != NULL )
545 wchar_t wdir[PATH_MAX];
546 SHGetFolderPath = (void *)GetProcAddress( shfolder_dll,
547 _T("SHGetFolderPathW") );
548 if ((SHGetFolderPath != NULL )
549 && SUCCEEDED (SHGetFolderPath (NULL,
550 CSIDL_MYPICTURES | CSIDL_FLAG_CREATE,
551 NULL, SHGFP_TYPE_CURRENT,
553 p_mypicturesdir = FromWide (wdir);
555 FreeLibrary( shfolder_dll );
558 if( p_mypicturesdir == NULL )
559 psz_path = strdup( config_GetHomeDir() );
561 psz_path = p_mypicturesdir;
565 /* XXX: This saves in the data directory. Shouldn't we try saving
566 * to psz_homedir/Desktop or something nicer ? */
567 char *psz_datadir = config_GetUserDataDir();
570 if( asprintf( &psz_path, "%s", psz_datadir ) == -1 )
580 int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
582 image_handler_t *p_image = image_HandlerCreate( p_vout );
583 video_format_t fmt_in, fmt_out;
584 char *psz_filename = NULL;
585 vlc_value_t val, format;
588 bool b_embedded_snapshot;
592 val.psz_string = var_GetNonEmptyString( p_vout, "snapshot-path" );
594 /* Embedded snapshot : if snapshot-path == object:object_ptr */
595 if( val.psz_string && sscanf( val.psz_string, "object:%p", &p_obj ) > 0 )
596 b_embedded_snapshot = true;
598 b_embedded_snapshot = false;
601 memset( &fmt_in, 0, sizeof(video_format_t) );
602 fmt_in = p_vout->fmt_out;
603 if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
606 fmt_in.i_sar_den = 1;
610 memset( &fmt_out, 0, sizeof(video_format_t) );
612 fmt_out.i_sar_den = 1;
613 fmt_out.i_chroma = b_embedded_snapshot ? VLC_FOURCC('p','n','g',' ') : 0;
614 fmt_out.i_width = var_GetInteger( p_vout, "snapshot-width" );
615 fmt_out.i_height = var_GetInteger( p_vout, "snapshot-height" );
617 if( b_embedded_snapshot &&
618 fmt_out.i_width == 0 && fmt_out.i_height == 0 )
620 /* If snapshot-width and/or snapshot height were not specified,
621 use a default snapshot width of 320 */
622 fmt_out.i_width = 320;
625 if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
627 fmt_out.i_height = fmt_in.i_height * fmt_out.i_width / fmt_in.i_width;
628 const int i_height = fmt_out.i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
630 fmt_out.i_height = i_height;
634 if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
636 fmt_out.i_width = fmt_in.i_width * fmt_out.i_height / fmt_in.i_height;
640 fmt_out.i_width = fmt_in.i_width;
641 fmt_out.i_height = fmt_in.i_height;
643 const int i_width = fmt_out.i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
645 fmt_out.i_width = i_width;
649 create a snapshot_t* and store it in
650 object_ptr->p_private, then unlock and signal the
653 if( b_embedded_snapshot )
656 snapshot_t *p_snapshot = p_obj;
659 vlc_mutex_lock( &p_snapshot->p_mutex );
660 p_snapshot->p_data = NULL;
662 /* Save the snapshot to a memory zone */
663 p_block = image_Write( p_image, p_pic, &fmt_in, &fmt_out );
666 msg_Err( p_vout, "Could not get snapshot" );
667 image_HandlerDelete( p_image );
668 vlc_cond_signal( &p_snapshot->p_condvar );
669 vlc_mutex_unlock( &p_snapshot->p_mutex );
673 i_size = p_block->i_buffer;
675 p_snapshot->i_width = fmt_out.i_width;
676 p_snapshot->i_height = fmt_out.i_height;
677 p_snapshot->i_datasize = i_size;
678 p_snapshot->date = p_block->i_pts; /* FIXME ?? */
679 p_snapshot->p_data = malloc( i_size );
680 if( !p_snapshot->p_data )
682 block_Release( p_block );
683 image_HandlerDelete( p_image );
684 vlc_cond_signal( &p_snapshot->p_condvar );
685 vlc_mutex_unlock( &p_snapshot->p_mutex );
688 memcpy( p_snapshot->p_data, p_block->p_buffer, p_block->i_buffer );
690 block_Release( p_block );
692 /* Unlock the object */
693 vlc_cond_signal( &p_snapshot->p_condvar );
694 vlc_mutex_unlock( &p_snapshot->p_mutex );
696 image_HandlerDelete( p_image );
700 /* Get default directory if none provided */
701 if( !val.psz_string )
702 val.psz_string = VoutSnapshotGetDefaultDirectory( );
703 if( !val.psz_string )
705 msg_Err( p_vout, "no path specified for snapshots" );
706 image_HandlerDelete( p_image );
710 /* Get snapshot format, default being "png" */
711 format.psz_string = var_GetNonEmptyString( p_vout, "snapshot-format" );
712 if( !format.psz_string )
713 format.psz_string = strdup( "png" );
714 if( !format.psz_string )
716 free( val.psz_string );
717 image_HandlerDelete( p_image );
722 * Did the user specify a directory? If not, path = NULL.
724 path = utf8_opendir ( (const char *)val.psz_string );
727 char *psz_prefix = var_GetNonEmptyString( p_vout, "snapshot-prefix" );
728 if( psz_prefix == NULL )
729 psz_prefix = strdup( "vlcsnap-" );
732 char *psz_tmp = str_format( p_vout, psz_prefix );
733 filename_sanitize( psz_tmp );
735 psz_prefix = psz_tmp;
739 if( var_GetBool( p_vout, "snapshot-sequential" ) == true )
741 int i_num = var_GetInteger( p_vout, "snapshot-num" );
746 free( psz_filename );
747 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%05d.%s",
748 val.psz_string, psz_prefix, i_num++,
749 format.psz_string ) == -1 )
751 msg_Err( p_vout, "could not create snapshot" );
752 image_HandlerDelete( p_image );
756 while( utf8_stat( psz_filename, &st ) == 0 );
758 var_SetInteger( p_vout, "snapshot-num", i_num );
764 lcurtime = time( NULL ) ;
765 if ( ( localtime_r( &lcurtime, &curtime ) == NULL ) )
767 msg_Warn( p_vout, "failed to get current time. Falling back to legacy snapshot naming" );
768 /* failed to get current time. Fallback to old format */
769 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%u.%s",
770 val.psz_string, psz_prefix,
771 (unsigned int)(p_pic->date / 100000) & 0xFFFFFF,
772 format.psz_string ) == -1 )
774 msg_Err( p_vout, "could not create snapshot" );
775 image_HandlerDelete( p_image );
781 char psz_curtime[15] ;
782 if( strftime( psz_curtime, 15, "%y%m%d-%H%M%S", &curtime ) == 0 )
784 msg_Warn( p_vout, "snapshot date string truncated" ) ;
786 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%s%1u.%s",
787 val.psz_string, psz_prefix, psz_curtime,
788 /* suffix with the last decimal digit in 10s of seconds resolution */
789 (unsigned int)(p_pic->date / (100*1000)) & 0xFF,
790 format.psz_string ) == -1 )
792 msg_Err( p_vout, "could not create snapshot" );
793 image_HandlerDelete( p_image );
796 } //end if time() < 0
797 } //end snapshot sequential
800 else // The user specified a full path name (including file name)
802 psz_filename = str_format( p_vout, val.psz_string );
803 path_sanitize( psz_filename );
806 free( val.psz_string );
807 free( format.psz_string );
809 /* Save the snapshot */
810 i_ret = image_WriteUrl( p_image, p_pic, &fmt_in, &fmt_out, psz_filename );
811 if( i_ret != VLC_SUCCESS )
813 msg_Err( p_vout, "could not create snapshot %s", psz_filename );
814 free( psz_filename );
815 image_HandlerDelete( p_image );
820 msg_Dbg( p_vout, "snapshot taken (%s)", psz_filename );
821 vout_OSDMessage( VLC_OBJECT( p_vout ), DEFAULT_CHAN,
822 "%s", psz_filename );
824 /* Generate a media player event - Right now just trigger a global libvlc var
825 CHECK: Could not find a more local object. The goal is to communicate
826 vout_thread with libvlc_media_player or its input_thread*/
827 val.psz_string = psz_filename ;
829 var_Set( p_vout->p_libvlc, "vout-snapshottaken", val );
830 /* var_Set duplicates data for transport so we can free*/
831 free( psz_filename );
834 if( var_GetBool( p_vout, "snapshot-preview" ) )
836 if( VoutSnapshotPip( p_vout, p_image, p_pic, &fmt_in ) )
837 msg_Warn( p_vout, "Failed to display snapshot" );
839 image_HandlerDelete( p_image );
844 /*****************************************************************************
846 *****************************************************************************/
848 void vout_EnableFilter( vout_thread_t *p_vout, char *psz_name,
849 bool b_add, bool b_setconfig )
852 char *psz_string = config_GetPsz( p_vout, "vout-filter" );
854 /* Todo : Use some generic chain manipulation functions */
855 if( !psz_string ) psz_string = strdup("");
857 psz_parser = strstr( psz_string, psz_name );
862 psz_parser = psz_string;
863 if( asprintf( &psz_string, (*psz_string) ? "%s:%s" : "%s%s",
864 psz_string, psz_name ) == -1 )
878 memmove( psz_parser, psz_parser + strlen(psz_name) +
879 (*(psz_parser + strlen(psz_name)) == ':' ? 1 : 0 ),
880 strlen(psz_parser + strlen(psz_name)) + 1 );
882 /* Remove trailing : : */
883 if( *(psz_string+strlen(psz_string ) -1 ) == ':' )
885 *(psz_string+strlen(psz_string ) -1 ) = '\0';
895 config_PutPsz( p_vout, "vout-filter", psz_string );
897 var_SetString( p_vout, "vout-filter", psz_string );
901 /*****************************************************************************
902 * InitWindowSize: find the initial dimensions the video window should have.
903 *****************************************************************************
904 * This function will check the "width", "height" and "zoom" config options and
905 * will calculate the size that the video window should have.
906 *****************************************************************************/
907 static void InitWindowSize( vout_thread_t *p_vout, unsigned *pi_width,
908 unsigned *pi_height )
910 #define FP_FACTOR 1000 /* our fixed point factor */
912 int i_width = var_GetInteger( p_vout, "width" );
913 int i_height = var_GetInteger( p_vout, "height" );
914 float f_zoom = var_GetFloat( p_vout, "zoom" );
915 uint64_t ll_zoom = (uint64_t)( FP_FACTOR * f_zoom );
917 if( i_width > 0 && i_height > 0)
919 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
920 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
923 else if( i_width > 0 )
925 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
926 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom *
927 p_vout->fmt_in.i_sar_den * i_width / p_vout->fmt_in.i_sar_num /
928 FP_FACTOR / p_vout->fmt_in.i_visible_width );
931 else if( i_height > 0 )
933 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
934 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom *
935 p_vout->fmt_in.i_sar_num * i_height / p_vout->fmt_in.i_sar_den /
936 FP_FACTOR / p_vout->fmt_in.i_visible_height );
940 if( p_vout->fmt_in.i_sar_num == 0 || p_vout->fmt_in.i_sar_den == 0 ) {
941 msg_Warn( p_vout, "aspect ratio screwed up" );
942 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom / FP_FACTOR );
943 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom /FP_FACTOR);
945 else if( p_vout->fmt_in.i_sar_num >= p_vout->fmt_in.i_sar_den )
947 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom *
948 p_vout->fmt_in.i_sar_num / p_vout->fmt_in.i_sar_den / FP_FACTOR );
949 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom
954 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom
956 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom *
957 p_vout->fmt_in.i_sar_den / p_vout->fmt_in.i_sar_num / FP_FACTOR );
961 msg_Dbg( p_vout, "window size: %dx%d", p_vout->i_window_width,
962 p_vout->i_window_height );
967 /*****************************************************************************
968 * Object variables callbacks
969 *****************************************************************************/
970 static int ZoomCallback( vlc_object_t *p_this, char const *psz_cmd,
971 vlc_value_t oldval, vlc_value_t newval, void *p_data )
973 vout_thread_t *p_vout = (vout_thread_t *)p_this;
974 (void)psz_cmd; (void)oldval; (void)newval; (void)p_data;
975 InitWindowSize( p_vout, &p_vout->i_window_width,
976 &p_vout->i_window_height );
977 vout_Control( p_vout, VOUT_SET_SIZE, p_vout->i_window_width,
978 p_vout->i_window_height );
982 static int CropCallback( vlc_object_t *p_this, char const *psz_cmd,
983 vlc_value_t oldval, vlc_value_t newval, void *p_data )
985 vout_thread_t *p_vout = (vout_thread_t *)p_this;
986 int64_t i_aspect_num, i_aspect_den;
987 unsigned int i_width, i_height;
989 (void)oldval; (void)p_data;
991 /* Restore defaults */
992 p_vout->fmt_in.i_x_offset = p_vout->fmt_render.i_x_offset;
993 p_vout->fmt_in.i_visible_width = p_vout->fmt_render.i_visible_width;
994 p_vout->fmt_in.i_y_offset = p_vout->fmt_render.i_y_offset;
995 p_vout->fmt_in.i_visible_height = p_vout->fmt_render.i_visible_height;
997 if( !strcmp( psz_cmd, "crop" ) )
999 char *psz_end = NULL, *psz_parser = strchr( newval.psz_string, ':' );
1002 /* We're using the 3:4 syntax */
1003 i_aspect_num = strtol( newval.psz_string, &psz_end, 10 );
1004 if( psz_end == newval.psz_string || !i_aspect_num ) goto crop_end;
1006 i_aspect_den = strtol( ++psz_parser, &psz_end, 10 );
1007 if( psz_end == psz_parser || !i_aspect_den ) goto crop_end;
1009 i_width = p_vout->fmt_in.i_sar_den*p_vout->fmt_render.i_visible_height *
1010 i_aspect_num / i_aspect_den / p_vout->fmt_in.i_sar_num;
1011 i_height = p_vout->fmt_render.i_visible_width*p_vout->fmt_in.i_sar_num *
1012 i_aspect_den / i_aspect_num / p_vout->fmt_in.i_sar_den;
1014 if( i_width < p_vout->fmt_render.i_visible_width )
1016 p_vout->fmt_in.i_x_offset = p_vout->fmt_render.i_x_offset +
1017 (p_vout->fmt_render.i_visible_width - i_width) / 2;
1018 p_vout->fmt_in.i_visible_width = i_width;
1022 p_vout->fmt_in.i_y_offset = p_vout->fmt_render.i_y_offset +
1023 (p_vout->fmt_render.i_visible_height - i_height) / 2;
1024 p_vout->fmt_in.i_visible_height = i_height;
1029 psz_parser = strchr( newval.psz_string, 'x' );
1032 /* Maybe we're using the <width>x<height>+<left>+<top> syntax */
1033 unsigned int i_crop_width, i_crop_height, i_crop_top, i_crop_left;
1035 i_crop_width = strtol( newval.psz_string, &psz_end, 10 );
1036 if( psz_end != psz_parser ) goto crop_end;
1038 psz_parser = strchr( ++psz_end, '+' );
1039 i_crop_height = strtol( psz_end, &psz_end, 10 );
1040 if( psz_end != psz_parser ) goto crop_end;
1042 psz_parser = strchr( ++psz_end, '+' );
1043 i_crop_left = strtol( psz_end, &psz_end, 10 );
1044 if( psz_end != psz_parser ) goto crop_end;
1047 i_crop_top = strtol( psz_end, &psz_end, 10 );
1048 if( *psz_end != '\0' ) goto crop_end;
1050 i_width = i_crop_width;
1051 p_vout->fmt_in.i_visible_width = i_width;
1053 i_height = i_crop_height;
1054 p_vout->fmt_in.i_visible_height = i_height;
1056 p_vout->fmt_in.i_x_offset = i_crop_left;
1057 p_vout->fmt_in.i_y_offset = i_crop_top;
1061 /* Maybe we're using the <left>+<top>+<right>+<bottom> syntax */
1062 unsigned int i_crop_top, i_crop_left, i_crop_bottom, i_crop_right;
1064 psz_parser = strchr( newval.psz_string, '+' );
1065 i_crop_left = strtol( newval.psz_string, &psz_end, 10 );
1066 if( psz_end != psz_parser ) goto crop_end;
1068 psz_parser = strchr( ++psz_end, '+' );
1069 i_crop_top = strtol( psz_end, &psz_end, 10 );
1070 if( psz_end != psz_parser ) goto crop_end;
1072 psz_parser = strchr( ++psz_end, '+' );
1073 i_crop_right = strtol( psz_end, &psz_end, 10 );
1074 if( psz_end != psz_parser ) goto crop_end;
1077 i_crop_bottom = strtol( psz_end, &psz_end, 10 );
1078 if( *psz_end != '\0' ) goto crop_end;
1080 i_width = p_vout->fmt_render.i_visible_width
1081 - i_crop_left - i_crop_right;
1082 p_vout->fmt_in.i_visible_width = i_width;
1084 i_height = p_vout->fmt_render.i_visible_height
1085 - i_crop_top - i_crop_bottom;
1086 p_vout->fmt_in.i_visible_height = i_height;
1088 p_vout->fmt_in.i_x_offset = i_crop_left;
1089 p_vout->fmt_in.i_y_offset = i_crop_top;
1093 else if( !strcmp( psz_cmd, "crop-top" )
1094 || !strcmp( psz_cmd, "crop-left" )
1095 || !strcmp( psz_cmd, "crop-bottom" )
1096 || !strcmp( psz_cmd, "crop-right" ) )
1098 unsigned int i_crop_top, i_crop_left, i_crop_bottom, i_crop_right;
1100 i_crop_top = var_GetInteger( p_vout, "crop-top" );
1101 i_crop_left = var_GetInteger( p_vout, "crop-left" );
1102 i_crop_right = var_GetInteger( p_vout, "crop-right" );
1103 i_crop_bottom = var_GetInteger( p_vout, "crop-bottom" );
1105 i_width = p_vout->fmt_render.i_visible_width
1106 - i_crop_left - i_crop_right;
1107 p_vout->fmt_in.i_visible_width = i_width;
1109 i_height = p_vout->fmt_render.i_visible_height
1110 - i_crop_top - i_crop_bottom;
1111 p_vout->fmt_in.i_visible_height = i_height;
1113 p_vout->fmt_in.i_x_offset = i_crop_left;
1114 p_vout->fmt_in.i_y_offset = i_crop_top;
1118 InitWindowSize( p_vout, &p_vout->i_window_width,
1119 &p_vout->i_window_height );
1121 p_vout->i_changes |= VOUT_CROP_CHANGE;
1123 msg_Dbg( p_vout, "cropping picture %ix%i to %i,%i,%ix%i",
1124 p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
1125 p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
1126 p_vout->fmt_in.i_visible_width,
1127 p_vout->fmt_in.i_visible_height );
1129 var_SetVoid( p_vout, "crop-update" );
1134 static int AspectCallback( vlc_object_t *p_this, char const *psz_cmd,
1135 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1137 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1138 unsigned int i_aspect_num, i_aspect_den, i_sar_num, i_sar_den;
1141 char *psz_end, *psz_parser = strchr( newval.psz_string, ':' );
1142 (void)psz_cmd; (void)oldval; (void)p_data;
1144 /* Restore defaults */
1145 p_vout->fmt_in.i_sar_num = p_vout->fmt_render.i_sar_num;
1146 p_vout->fmt_in.i_sar_den = p_vout->fmt_render.i_sar_den;
1147 p_vout->fmt_in.i_aspect = p_vout->fmt_render.i_aspect;
1148 p_vout->render.i_aspect = p_vout->fmt_render.i_aspect;
1150 if( !psz_parser ) goto aspect_end;
1152 i_aspect_num = strtol( newval.psz_string, &psz_end, 10 );
1153 if( psz_end == newval.psz_string || !i_aspect_num ) goto aspect_end;
1155 i_aspect_den = strtol( ++psz_parser, &psz_end, 10 );
1156 if( psz_end == psz_parser || !i_aspect_den ) goto aspect_end;
1158 i_sar_num = i_aspect_num * p_vout->fmt_render.i_visible_height;
1159 i_sar_den = i_aspect_den * p_vout->fmt_render.i_visible_width;
1160 vlc_ureduce( &i_sar_num, &i_sar_den, i_sar_num, i_sar_den, 0 );
1161 p_vout->fmt_in.i_sar_num = i_sar_num;
1162 p_vout->fmt_in.i_sar_den = i_sar_den;
1163 p_vout->fmt_in.i_aspect = i_aspect_num * VOUT_ASPECT_FACTOR / i_aspect_den;
1164 p_vout->render.i_aspect = p_vout->fmt_in.i_aspect;
1167 if( p_vout->p->i_par_num && p_vout->p->i_par_den )
1169 p_vout->fmt_in.i_sar_num *= p_vout->p->i_par_den;
1170 p_vout->fmt_in.i_sar_den *= p_vout->p->i_par_num;
1171 p_vout->fmt_in.i_aspect = p_vout->fmt_in.i_aspect *
1172 p_vout->p->i_par_den / p_vout->p->i_par_num;
1173 p_vout->render.i_aspect = p_vout->fmt_in.i_aspect;
1176 p_vout->i_changes |= VOUT_ASPECT_CHANGE;
1178 vlc_ureduce( &i_aspect_num, &i_aspect_den,
1179 p_vout->fmt_in.i_aspect, VOUT_ASPECT_FACTOR, 0 );
1180 msg_Dbg( p_vout, "new aspect-ratio %i:%i, sample aspect-ratio %i:%i",
1181 i_aspect_num, i_aspect_den,
1182 p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
1184 if( var_Get( p_vout, "crop", &val ) )
1185 return VLC_EGENERIC;
1187 int i_ret = CropCallback( p_this, "crop", val, val, 0 );
1188 free( val.psz_string );
1192 static int ScalingCallback( vlc_object_t *p_this, char const *psz_cmd,
1193 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1195 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1196 (void)oldval; (void)newval; (void)p_data;
1198 vlc_mutex_lock( &p_vout->change_lock );
1200 if( !strcmp( psz_cmd, "autoscale" ) )
1202 p_vout->i_changes |= VOUT_SCALE_CHANGE;
1204 else if( !strcmp( psz_cmd, "scale" ) )
1206 p_vout->i_changes |= VOUT_ZOOM_CHANGE;
1209 vlc_mutex_unlock( &p_vout->change_lock );
1214 static int OnTopCallback( vlc_object_t *p_this, char const *psz_cmd,
1215 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1217 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1219 vlc_mutex_lock( &p_vout->change_lock );
1220 p_vout->i_changes |= VOUT_ON_TOP_CHANGE;
1221 p_vout->b_on_top = newval.b_bool;
1222 vlc_mutex_unlock( &p_vout->change_lock );
1224 /* Modify libvlc as well because the vout might have to be restarted */
1225 var_Create( p_vout->p_libvlc, "video-on-top", VLC_VAR_BOOL );
1226 var_Set( p_vout->p_libvlc, "video-on-top", newval );
1228 (void)psz_cmd; (void)oldval; (void)p_data;
1232 static int FullscreenCallback( vlc_object_t *p_this, char const *psz_cmd,
1233 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1235 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1237 (void)psz_cmd; (void)oldval; (void)p_data;
1239 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1241 /* Modify libvlc as well because the vout might have to be restarted */
1242 var_Create( p_vout->p_libvlc, "fullscreen", VLC_VAR_BOOL );
1243 var_Set( p_vout->p_libvlc, "fullscreen", newval );
1246 var_Set( p_vout, "intf-change", val );
1250 static int SnapshotCallback( vlc_object_t *p_this, char const *psz_cmd,
1251 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1253 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1255 /* FIXME: this is definitely not thread-safe */
1256 p_vout->p->b_snapshot = true;
1257 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1258 VLC_UNUSED(newval); VLC_UNUSED(p_data);
1262 static int TitleShowCallback( vlc_object_t *p_this, char const *psz_cmd,
1263 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1265 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1267 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1268 p_vout->p->b_title_show = newval.b_bool;
1272 static int TitleTimeoutCallback( vlc_object_t *p_this, char const *psz_cmd,
1273 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1275 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
1276 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1277 p_vout->p->i_title_timeout = (mtime_t) newval.i_int;
1281 static int TitlePositionCallback( vlc_object_t *p_this, char const *psz_cmd,
1282 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1284 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1286 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1287 p_vout->p->i_title_position = newval.i_int;