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 OnTopCallback( vlc_object_t *, char const *,
69 vlc_value_t, vlc_value_t, void * );
70 static int FullscreenCallback( vlc_object_t *, char const *,
71 vlc_value_t, vlc_value_t, void * );
72 static int SnapshotCallback( vlc_object_t *, char const *,
73 vlc_value_t, vlc_value_t, void * );
75 static int TitleShowCallback( vlc_object_t *, char const *,
76 vlc_value_t, vlc_value_t, void * );
77 static int TitleTimeoutCallback( vlc_object_t *, char const *,
78 vlc_value_t, vlc_value_t, void * );
79 static int TitlePositionCallback( vlc_object_t *, char const *,
80 vlc_value_t, vlc_value_t, void * );
83 * Creates a video output window.
84 * On Unix systems, this returns an X11 drawable handle.
85 * On Windows, this returns a Win32 window handle.
86 * Video output plugins are supposed to called this function and display the
87 * video within the resulting window, while in windowed mode.
89 * Note that a given video output thread must not allocate more than one
90 * such window at a time.
92 * @param p_vout video output thread to create a window for
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 platform-specific window handle, or NULL in case of failure.
99 * In case of success, the handle is released with vout_ReleaseWindow().
101 void *vout_RequestWindow( vout_thread_t *p_vout,
102 int *pi_x_hint, int *pi_y_hint,
103 unsigned int *pi_width_hint,
104 unsigned int *pi_height_hint )
106 assert (p_vout->p_window == NULL);
108 /* Get requested coordinates */
109 *pi_x_hint = var_GetInteger( p_vout, "video-x" );
110 *pi_y_hint = var_GetInteger( p_vout, "video-y" );
112 *pi_width_hint = p_vout->i_window_width;
113 *pi_height_hint = p_vout->i_window_height;
115 /* Check whether someone provided us with a window ID */
116 int drawable = var_CreateGetInteger( p_vout, "drawable" );
117 if( drawable ) return (void *)(intptr_t)drawable;
119 vout_window_t *wnd = vlc_custom_create (VLC_OBJECT(p_vout), sizeof (*wnd),
120 VLC_OBJECT_GENERIC, "window");
125 wnd->width = *pi_width_hint;
126 wnd->height = *pi_height_hint;
127 wnd->pos_x = *pi_x_hint;
128 wnd->pos_y = *pi_y_hint;
129 vlc_object_attach (wnd, p_vout);
131 wnd->module = module_need (wnd, "vout_window", NULL, false);
132 if (wnd->module == NULL)
134 msg_Dbg (wnd, "no window provider available");
135 vlc_object_release (wnd);
138 p_vout->p_window = wnd;
139 *pi_width_hint = wnd->width;
140 *pi_height_hint = wnd->height;
141 *pi_x_hint = wnd->pos_x;
142 *pi_y_hint = wnd->pos_y;
147 * Releases a window handle obtained with vout_RequestWindow().
148 * @param p_vout video output thread that allocated the window
149 * @param dummy unused legacy paramater
151 void vout_ReleaseWindow( vout_thread_t *p_vout, void *dummy )
153 vout_window_t *wnd = p_vout->p_window;
157 p_vout->p_window = NULL;
159 assert (wnd->module);
160 module_unneed (wnd, wnd->module);
162 vlc_object_release (wnd);
166 int vout_ControlWindow( vout_thread_t *p_vout, void *dummy,
167 int i_query, va_list args )
170 vout_window_t *wnd = p_vout->p_window;
175 assert (wnd->control);
176 return wnd->control (wnd, i_query, args);
179 /*****************************************************************************
180 * vout_IntfInit: called during the vout creation to initialise misc things.
181 *****************************************************************************/
185 const char *psz_label;
186 } p_zoom_values[] = {
187 { 0.25, N_("1:4 Quarter") },
188 { 0.5, N_("1:2 Half") },
189 { 1, N_("1:1 Original") },
190 { 2, N_("2:1 Double") },
195 const char *psz_value;
196 const char *psz_label;
197 } p_crop_values[] = {
198 { "", N_("Default") },
199 { "16:10", "16:10" },
201 { "185:100", "1.85:1" },
202 { "221:100", "2.21:1" },
203 { "235:100", "2.35:1" },
204 { "239:100", "2.39:1" },
213 const char *psz_value;
214 const char *psz_label;
215 } p_aspect_ratio_values[] = {
216 { "", N_("Default") },
220 { "16:10", "16:10" },
221 { "221:100", "2.21:1" },
225 static void AddCustomRatios( vout_thread_t *p_vout, const char *psz_var,
228 if( psz_list && *psz_list )
230 char *psz_cur = psz_list;
232 while( psz_cur && *psz_cur )
234 vlc_value_t val, text;
235 psz_next = strchr( psz_cur, ',' );
241 val.psz_string = psz_cur;
242 text.psz_string = psz_cur;
243 var_Change( p_vout, psz_var, VLC_VAR_ADDCHOICE, &val, &text);
249 void vout_IntfInit( vout_thread_t *p_vout )
251 vlc_value_t val, text, old_val;
252 bool b_force_par = false;
256 /* Create a few object variables we'll need later on */
257 var_Create( p_vout, "snapshot-path", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
258 var_Create( p_vout, "snapshot-prefix", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
259 var_Create( p_vout, "snapshot-format", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
260 var_Create( p_vout, "snapshot-preview", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
261 var_Create( p_vout, "snapshot-sequential",
262 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
263 var_Create( p_vout, "snapshot-num", VLC_VAR_INTEGER );
264 var_SetInteger( p_vout, "snapshot-num", 1 );
265 var_Create( p_vout, "snapshot-width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
266 var_Create( p_vout, "snapshot-height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
268 var_Create( p_vout, "width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
269 var_Create( p_vout, "height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
270 p_vout->i_alignment = var_CreateGetInteger( p_vout, "align" );
272 var_Create( p_vout, "video-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
273 var_Create( p_vout, "video-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
275 var_Create( p_vout, "mouse-hide-timeout",
276 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
278 p_vout->p->b_title_show = var_CreateGetBool( p_vout, "video-title-show" );
279 p_vout->p->i_title_timeout =
280 (mtime_t)var_CreateGetInteger( p_vout, "video-title-timeout" );
281 p_vout->p->i_title_position =
282 var_CreateGetInteger( p_vout, "video-title-position" );
283 p_vout->p->psz_title = NULL;
285 var_AddCallback( p_vout, "video-title-show", TitleShowCallback, NULL );
286 var_AddCallback( p_vout, "video-title-timeout", TitleTimeoutCallback, NULL );
287 var_AddCallback( p_vout, "video-title-position", TitlePositionCallback, NULL );
289 /* Zoom object var */
290 var_Create( p_vout, "zoom", VLC_VAR_FLOAT | VLC_VAR_ISCOMMAND |
291 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
293 text.psz_string = _("Zoom");
294 var_Change( p_vout, "zoom", VLC_VAR_SETTEXT, &text, NULL );
296 var_Get( p_vout, "zoom", &old_val );
298 for( i = 0; p_zoom_values[i].f_value; i++ )
300 if( old_val.f_float == p_zoom_values[i].f_value )
301 var_Change( p_vout, "zoom", VLC_VAR_DELCHOICE, &old_val, NULL );
302 val.f_float = p_zoom_values[i].f_value;
303 text.psz_string = _( p_zoom_values[i].psz_label );
304 var_Change( p_vout, "zoom", VLC_VAR_ADDCHOICE, &val, &text );
307 var_Set( p_vout, "zoom", old_val ); /* Is this really needed? */
309 var_AddCallback( p_vout, "zoom", ZoomCallback, NULL );
311 /* Crop offset vars */
312 var_Create( p_vout, "crop-left", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
313 var_Create( p_vout, "crop-top", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
314 var_Create( p_vout, "crop-right", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
315 var_Create( p_vout, "crop-bottom", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
317 var_AddCallback( p_vout, "crop-left", CropCallback, NULL );
318 var_AddCallback( p_vout, "crop-top", CropCallback, NULL );
319 var_AddCallback( p_vout, "crop-right", CropCallback, NULL );
320 var_AddCallback( p_vout, "crop-bottom", CropCallback, NULL );
322 /* Crop object var */
323 var_Create( p_vout, "crop", VLC_VAR_STRING | VLC_VAR_ISCOMMAND |
324 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
326 text.psz_string = _("Crop");
327 var_Change( p_vout, "crop", VLC_VAR_SETTEXT, &text, NULL );
329 val.psz_string = (char*)"";
330 var_Change( p_vout, "crop", VLC_VAR_DELCHOICE, &val, 0 );
332 for( i = 0; p_crop_values[i].psz_value; i++ )
334 val.psz_string = (char*)p_crop_values[i].psz_value;
335 text.psz_string = _( p_crop_values[i].psz_label );
336 var_Change( p_vout, "crop", VLC_VAR_ADDCHOICE, &val, &text );
339 /* update triggered every time the vout's crop parameters are changed */
340 var_Create( p_vout, "crop-update", VLC_VAR_VOID );
342 /* Add custom crop ratios */
343 psz_buf = config_GetPsz( p_vout, "custom-crop-ratios" );
344 AddCustomRatios( p_vout, "crop", psz_buf );
347 var_AddCallback( p_vout, "crop", CropCallback, NULL );
348 var_Get( p_vout, "crop", &old_val );
349 if( old_val.psz_string && *old_val.psz_string )
350 var_TriggerCallback( p_vout, "crop" );
351 free( old_val.psz_string );
353 /* Monitor pixel aspect-ratio */
354 var_Create( p_vout, "monitor-par", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
355 var_Get( p_vout, "monitor-par", &val );
356 if( val.psz_string && *val.psz_string )
358 char *psz_parser = strchr( val.psz_string, ':' );
359 unsigned int i_aspect_num = 0, i_aspect_den = 0;
363 i_aspect_num = strtol( val.psz_string, 0, 10 );
364 i_aspect_den = strtol( ++psz_parser, 0, 10 );
368 i_aspect = atof( val.psz_string );
369 vlc_ureduce( &i_aspect_num, &i_aspect_den,
370 i_aspect *VOUT_ASPECT_FACTOR, VOUT_ASPECT_FACTOR, 0 );
372 if( !i_aspect_num || !i_aspect_den ) i_aspect_num = i_aspect_den = 1;
374 p_vout->p->i_par_num = i_aspect_num;
375 p_vout->p->i_par_den = i_aspect_den;
377 vlc_ureduce( &p_vout->p->i_par_num, &p_vout->p->i_par_den,
378 p_vout->p->i_par_num, p_vout->p->i_par_den, 0 );
380 msg_Dbg( p_vout, "overriding monitor pixel aspect-ratio: %i:%i",
381 p_vout->p->i_par_num, p_vout->p->i_par_den );
384 free( val.psz_string );
386 /* Aspect-ratio object var */
387 var_Create( p_vout, "aspect-ratio", VLC_VAR_STRING | VLC_VAR_ISCOMMAND |
388 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
390 text.psz_string = _("Aspect-ratio");
391 var_Change( p_vout, "aspect-ratio", VLC_VAR_SETTEXT, &text, NULL );
393 val.psz_string = (char*)"";
394 var_Change( p_vout, "aspect-ratio", VLC_VAR_DELCHOICE, &val, 0 );
396 for( i = 0; p_aspect_ratio_values[i].psz_value; i++ )
398 val.psz_string = (char*)p_aspect_ratio_values[i].psz_value;
399 text.psz_string = _( p_aspect_ratio_values[i].psz_label );
400 var_Change( p_vout, "aspect-ratio", VLC_VAR_ADDCHOICE, &val, &text );
403 /* Add custom aspect ratios */
404 psz_buf = config_GetPsz( p_vout, "custom-aspect-ratios" );
405 AddCustomRatios( p_vout, "aspect-ratio", psz_buf );
408 var_AddCallback( p_vout, "aspect-ratio", AspectCallback, NULL );
409 var_Get( p_vout, "aspect-ratio", &old_val );
410 if( (old_val.psz_string && *old_val.psz_string) || b_force_par )
411 var_TriggerCallback( p_vout, "aspect-ratio" );
412 free( old_val.psz_string );
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_INTEGER );
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 )
655 vlc_object_t* p_dest = p_obj;
657 snapshot_t *p_snapshot;
660 vlc_object_lock( p_dest );
661 p_dest->p_private = NULL;
663 /* Save the snapshot to a memory zone */
664 p_block = image_Write( p_image, p_pic, &fmt_in, &fmt_out );
667 msg_Err( p_vout, "Could not get snapshot" );
668 image_HandlerDelete( p_image );
669 vlc_object_signal_unlocked( p_dest );
670 vlc_object_unlock( p_dest );
674 /* Copy the p_block data to a snapshot structure */
675 /* FIXME: get the timestamp */
676 p_snapshot = malloc( sizeof( snapshot_t ) );
679 block_Release( p_block );
680 image_HandlerDelete( p_image );
681 vlc_object_signal_unlocked( p_dest );
682 vlc_object_unlock( p_dest );
686 i_size = p_block->i_buffer;
688 p_snapshot->i_width = fmt_out.i_width;
689 p_snapshot->i_height = fmt_out.i_height;
690 p_snapshot->i_datasize = i_size;
691 p_snapshot->date = p_block->i_pts; /* FIXME ?? */
692 p_snapshot->p_data = malloc( i_size );
693 if( !p_snapshot->p_data )
695 block_Release( p_block );
697 image_HandlerDelete( p_image );
698 vlc_object_signal_unlocked( p_dest );
699 vlc_object_unlock( p_dest );
702 memcpy( p_snapshot->p_data, p_block->p_buffer, p_block->i_buffer );
704 p_dest->p_private = p_snapshot;
706 block_Release( p_block );
708 /* Unlock the object */
709 vlc_object_signal_unlocked( p_dest );
710 vlc_object_unlock( p_dest );
712 image_HandlerDelete( p_image );
716 /* Get default directory if none provided */
717 if( !val.psz_string )
718 val.psz_string = VoutSnapshotGetDefaultDirectory( );
719 if( !val.psz_string )
721 msg_Err( p_vout, "no path specified for snapshots" );
722 image_HandlerDelete( p_image );
726 /* Get snapshot format, default being "png" */
727 format.psz_string = var_GetNonEmptyString( p_vout, "snapshot-format" );
728 if( !format.psz_string )
729 format.psz_string = strdup( "png" );
730 if( !format.psz_string )
732 free( val.psz_string );
733 image_HandlerDelete( p_image );
738 * Did the user specify a directory? If not, path = NULL.
740 path = utf8_opendir ( (const char *)val.psz_string );
743 char *psz_prefix = var_GetNonEmptyString( p_vout, "snapshot-prefix" );
744 if( psz_prefix == NULL )
745 psz_prefix = strdup( "vlcsnap-" );
748 char *psz_tmp = str_format( p_vout, psz_prefix );
749 filename_sanitize( psz_tmp );
751 psz_prefix = psz_tmp;
755 if( var_GetBool( p_vout, "snapshot-sequential" ) == true )
757 int i_num = var_GetInteger( p_vout, "snapshot-num" );
762 free( psz_filename );
763 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%05d.%s",
764 val.psz_string, psz_prefix, i_num++,
765 format.psz_string ) == -1 )
767 msg_Err( p_vout, "could not create snapshot" );
768 image_HandlerDelete( p_image );
772 while( utf8_stat( psz_filename, &st ) == 0 );
774 var_SetInteger( p_vout, "snapshot-num", i_num );
780 lcurtime = time( NULL ) ;
781 if ( ( localtime_r( &lcurtime, &curtime ) == NULL ) )
783 msg_Warn( p_vout, "failed to get current time. Falling back to legacy snapshot naming" );
784 /* failed to get current time. Fallback to old format */
785 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%u.%s",
786 val.psz_string, psz_prefix,
787 (unsigned int)(p_pic->date / 100000) & 0xFFFFFF,
788 format.psz_string ) == -1 )
790 msg_Err( p_vout, "could not create snapshot" );
791 image_HandlerDelete( p_image );
797 char psz_curtime[15] ;
798 if( strftime( psz_curtime, 15, "%y%m%d-%H%M%S", &curtime ) == 0 )
800 msg_Warn( p_vout, "snapshot date string truncated" ) ;
802 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%s%1u.%s",
803 val.psz_string, psz_prefix, psz_curtime,
804 /* suffix with the last decimal digit in 10s of seconds resolution */
805 (unsigned int)(p_pic->date / (100*1000)) & 0xFF,
806 format.psz_string ) == -1 )
808 msg_Err( p_vout, "could not create snapshot" );
809 image_HandlerDelete( p_image );
812 } //end if time() < 0
813 } //end snapshot sequential
816 else // The user specified a full path name (including file name)
818 psz_filename = str_format( p_vout, val.psz_string );
819 path_sanitize( psz_filename );
822 free( val.psz_string );
823 free( format.psz_string );
825 /* Save the snapshot */
826 i_ret = image_WriteUrl( p_image, p_pic, &fmt_in, &fmt_out, psz_filename );
827 if( i_ret != VLC_SUCCESS )
829 msg_Err( p_vout, "could not create snapshot %s", psz_filename );
830 free( psz_filename );
831 image_HandlerDelete( p_image );
836 msg_Dbg( p_vout, "snapshot taken (%s)", psz_filename );
837 vout_OSDMessage( VLC_OBJECT( p_vout ), DEFAULT_CHAN,
838 "%s", psz_filename );
840 /* Generate a media player event - Right now just trigger a global libvlc var
841 CHECK: Could not find a more local object. The goal is to communicate
842 vout_thread with libvlc_media_player or its input_thread*/
843 val.psz_string = psz_filename ;
845 var_Set( p_vout->p_libvlc, "vout-snapshottaken", val );
846 /* var_Set duplicates data for transport so we can free*/
847 free( psz_filename );
850 if( var_GetBool( p_vout, "snapshot-preview" ) )
852 if( VoutSnapshotPip( p_vout, p_image, p_pic, &fmt_in ) )
853 msg_Warn( p_vout, "Failed to display snapshot" );
855 image_HandlerDelete( p_image );
860 /*****************************************************************************
862 *****************************************************************************/
864 void vout_EnableFilter( vout_thread_t *p_vout, char *psz_name,
865 bool b_add, bool b_setconfig )
868 char *psz_string = config_GetPsz( p_vout, "vout-filter" );
870 /* Todo : Use some generic chain manipulation functions */
871 if( !psz_string ) psz_string = strdup("");
873 psz_parser = strstr( psz_string, psz_name );
878 psz_parser = psz_string;
879 if( asprintf( &psz_string, (*psz_string) ? "%s:%s" : "%s%s",
880 psz_string, psz_name ) == -1 )
894 memmove( psz_parser, psz_parser + strlen(psz_name) +
895 (*(psz_parser + strlen(psz_name)) == ':' ? 1 : 0 ),
896 strlen(psz_parser + strlen(psz_name)) + 1 );
898 /* Remove trailing : : */
899 if( *(psz_string+strlen(psz_string ) -1 ) == ':' )
901 *(psz_string+strlen(psz_string ) -1 ) = '\0';
911 config_PutPsz( p_vout, "vout-filter", psz_string );
913 var_SetString( p_vout, "vout-filter", psz_string );
917 /*****************************************************************************
918 * vout_ControlDefault: default methods for video output control.
919 *****************************************************************************/
920 int vout_vaControlDefault( vout_thread_t *p_vout, int i_query, va_list args )
927 vout_ReleaseWindow( p_vout, NULL );
931 p_vout->p->b_snapshot = true;
935 msg_Dbg( p_vout, "control query not supported" );
940 /*****************************************************************************
941 * InitWindowSize: find the initial dimensions the video window should have.
942 *****************************************************************************
943 * This function will check the "width", "height" and "zoom" config options and
944 * will calculate the size that the video window should have.
945 *****************************************************************************/
946 static void InitWindowSize( vout_thread_t *p_vout, unsigned *pi_width,
947 unsigned *pi_height )
950 int i_width, i_height;
953 #define FP_FACTOR 1000 /* our fixed point factor */
955 var_Get( p_vout, "width", &val );
957 var_Get( p_vout, "height", &val );
958 i_height = val.i_int;
959 var_Get( p_vout, "zoom", &val );
960 ll_zoom = (uint64_t)( FP_FACTOR * val.f_float );
962 if( i_width > 0 && i_height > 0)
964 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
965 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
968 else if( i_width > 0 )
970 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
971 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom *
972 p_vout->fmt_in.i_sar_den * i_width / p_vout->fmt_in.i_sar_num /
973 FP_FACTOR / p_vout->fmt_in.i_visible_width );
976 else if( i_height > 0 )
978 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
979 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom *
980 p_vout->fmt_in.i_sar_num * i_height / p_vout->fmt_in.i_sar_den /
981 FP_FACTOR / p_vout->fmt_in.i_visible_height );
985 if( p_vout->fmt_in.i_sar_num == 0 || p_vout->fmt_in.i_sar_den == 0 ) {
986 msg_Warn( p_vout, "fucked up aspect" );
987 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom / FP_FACTOR );
988 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom /FP_FACTOR);
990 else if( p_vout->fmt_in.i_sar_num >= p_vout->fmt_in.i_sar_den )
992 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom *
993 p_vout->fmt_in.i_sar_num / p_vout->fmt_in.i_sar_den / FP_FACTOR );
994 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom
999 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom
1001 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom *
1002 p_vout->fmt_in.i_sar_den / p_vout->fmt_in.i_sar_num / FP_FACTOR );
1006 msg_Dbg( p_vout, "window size: %dx%d", p_vout->i_window_width,
1007 p_vout->i_window_height );
1012 /*****************************************************************************
1013 * Object variables callbacks
1014 *****************************************************************************/
1015 static int ZoomCallback( vlc_object_t *p_this, char const *psz_cmd,
1016 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1018 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1019 (void)psz_cmd; (void)oldval; (void)newval; (void)p_data;
1020 InitWindowSize( p_vout, &p_vout->i_window_width,
1021 &p_vout->i_window_height );
1022 vout_Control( p_vout, VOUT_SET_SIZE, p_vout->i_window_width,
1023 p_vout->i_window_height );
1027 static int CropCallback( vlc_object_t *p_this, char const *psz_cmd,
1028 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1030 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1031 int64_t i_aspect_num, i_aspect_den;
1032 unsigned int i_width, i_height;
1034 (void)oldval; (void)p_data;
1036 /* Restore defaults */
1037 p_vout->fmt_in.i_x_offset = p_vout->fmt_render.i_x_offset;
1038 p_vout->fmt_in.i_visible_width = p_vout->fmt_render.i_visible_width;
1039 p_vout->fmt_in.i_y_offset = p_vout->fmt_render.i_y_offset;
1040 p_vout->fmt_in.i_visible_height = p_vout->fmt_render.i_visible_height;
1042 if( !strcmp( psz_cmd, "crop" ) )
1044 char *psz_end = NULL, *psz_parser = strchr( newval.psz_string, ':' );
1047 /* We're using the 3:4 syntax */
1048 i_aspect_num = strtol( newval.psz_string, &psz_end, 10 );
1049 if( psz_end == newval.psz_string || !i_aspect_num ) goto crop_end;
1051 i_aspect_den = strtol( ++psz_parser, &psz_end, 10 );
1052 if( psz_end == psz_parser || !i_aspect_den ) goto crop_end;
1054 i_width = p_vout->fmt_in.i_sar_den*p_vout->fmt_render.i_visible_height *
1055 i_aspect_num / i_aspect_den / p_vout->fmt_in.i_sar_num;
1056 i_height = p_vout->fmt_render.i_visible_width*p_vout->fmt_in.i_sar_num *
1057 i_aspect_den / i_aspect_num / p_vout->fmt_in.i_sar_den;
1059 if( i_width < p_vout->fmt_render.i_visible_width )
1061 p_vout->fmt_in.i_x_offset = p_vout->fmt_render.i_x_offset +
1062 (p_vout->fmt_render.i_visible_width - i_width) / 2;
1063 p_vout->fmt_in.i_visible_width = i_width;
1067 p_vout->fmt_in.i_y_offset = p_vout->fmt_render.i_y_offset +
1068 (p_vout->fmt_render.i_visible_height - i_height) / 2;
1069 p_vout->fmt_in.i_visible_height = i_height;
1074 psz_parser = strchr( newval.psz_string, 'x' );
1077 /* Maybe we're using the <width>x<height>+<left>+<top> syntax */
1078 unsigned int i_crop_width, i_crop_height, i_crop_top, i_crop_left;
1080 i_crop_width = strtol( newval.psz_string, &psz_end, 10 );
1081 if( psz_end != psz_parser ) goto crop_end;
1083 psz_parser = strchr( ++psz_end, '+' );
1084 i_crop_height = strtol( psz_end, &psz_end, 10 );
1085 if( psz_end != psz_parser ) goto crop_end;
1087 psz_parser = strchr( ++psz_end, '+' );
1088 i_crop_left = strtol( psz_end, &psz_end, 10 );
1089 if( psz_end != psz_parser ) goto crop_end;
1092 i_crop_top = strtol( psz_end, &psz_end, 10 );
1093 if( *psz_end != '\0' ) goto crop_end;
1095 i_width = i_crop_width;
1096 p_vout->fmt_in.i_visible_width = i_width;
1098 i_height = i_crop_height;
1099 p_vout->fmt_in.i_visible_height = i_height;
1101 p_vout->fmt_in.i_x_offset = i_crop_left;
1102 p_vout->fmt_in.i_y_offset = i_crop_top;
1106 /* Maybe we're using the <left>+<top>+<right>+<bottom> syntax */
1107 unsigned int i_crop_top, i_crop_left, i_crop_bottom, i_crop_right;
1109 psz_parser = strchr( newval.psz_string, '+' );
1110 i_crop_left = strtol( newval.psz_string, &psz_end, 10 );
1111 if( psz_end != psz_parser ) goto crop_end;
1113 psz_parser = strchr( ++psz_end, '+' );
1114 i_crop_top = strtol( psz_end, &psz_end, 10 );
1115 if( psz_end != psz_parser ) goto crop_end;
1117 psz_parser = strchr( ++psz_end, '+' );
1118 i_crop_right = strtol( psz_end, &psz_end, 10 );
1119 if( psz_end != psz_parser ) goto crop_end;
1122 i_crop_bottom = strtol( psz_end, &psz_end, 10 );
1123 if( *psz_end != '\0' ) goto crop_end;
1125 i_width = p_vout->fmt_render.i_visible_width
1126 - i_crop_left - i_crop_right;
1127 p_vout->fmt_in.i_visible_width = i_width;
1129 i_height = p_vout->fmt_render.i_visible_height
1130 - i_crop_top - i_crop_bottom;
1131 p_vout->fmt_in.i_visible_height = i_height;
1133 p_vout->fmt_in.i_x_offset = i_crop_left;
1134 p_vout->fmt_in.i_y_offset = i_crop_top;
1138 else if( !strcmp( psz_cmd, "crop-top" )
1139 || !strcmp( psz_cmd, "crop-left" )
1140 || !strcmp( psz_cmd, "crop-bottom" )
1141 || !strcmp( psz_cmd, "crop-right" ) )
1143 unsigned int i_crop_top, i_crop_left, i_crop_bottom, i_crop_right;
1145 i_crop_top = var_GetInteger( p_vout, "crop-top" );
1146 i_crop_left = var_GetInteger( p_vout, "crop-left" );
1147 i_crop_right = var_GetInteger( p_vout, "crop-right" );
1148 i_crop_bottom = var_GetInteger( p_vout, "crop-bottom" );
1150 i_width = p_vout->fmt_render.i_visible_width
1151 - i_crop_left - i_crop_right;
1152 p_vout->fmt_in.i_visible_width = i_width;
1154 i_height = p_vout->fmt_render.i_visible_height
1155 - i_crop_top - i_crop_bottom;
1156 p_vout->fmt_in.i_visible_height = i_height;
1158 p_vout->fmt_in.i_x_offset = i_crop_left;
1159 p_vout->fmt_in.i_y_offset = i_crop_top;
1163 InitWindowSize( p_vout, &p_vout->i_window_width,
1164 &p_vout->i_window_height );
1166 p_vout->i_changes |= VOUT_CROP_CHANGE;
1168 msg_Dbg( p_vout, "cropping picture %ix%i to %i,%i,%ix%i",
1169 p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
1170 p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
1171 p_vout->fmt_in.i_visible_width,
1172 p_vout->fmt_in.i_visible_height );
1174 var_SetVoid( p_vout, "crop-update" );
1179 static int AspectCallback( vlc_object_t *p_this, char const *psz_cmd,
1180 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1182 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1183 unsigned int i_aspect_num, i_aspect_den, i_sar_num, i_sar_den;
1186 char *psz_end, *psz_parser = strchr( newval.psz_string, ':' );
1187 (void)psz_cmd; (void)oldval; (void)p_data;
1189 /* Restore defaults */
1190 p_vout->fmt_in.i_sar_num = p_vout->fmt_render.i_sar_num;
1191 p_vout->fmt_in.i_sar_den = p_vout->fmt_render.i_sar_den;
1192 p_vout->fmt_in.i_aspect = p_vout->fmt_render.i_aspect;
1193 p_vout->render.i_aspect = p_vout->fmt_render.i_aspect;
1195 if( !psz_parser ) goto aspect_end;
1197 i_aspect_num = strtol( newval.psz_string, &psz_end, 10 );
1198 if( psz_end == newval.psz_string || !i_aspect_num ) goto aspect_end;
1200 i_aspect_den = strtol( ++psz_parser, &psz_end, 10 );
1201 if( psz_end == psz_parser || !i_aspect_den ) goto aspect_end;
1203 i_sar_num = i_aspect_num * p_vout->fmt_render.i_visible_height;
1204 i_sar_den = i_aspect_den * p_vout->fmt_render.i_visible_width;
1205 vlc_ureduce( &i_sar_num, &i_sar_den, i_sar_num, i_sar_den, 0 );
1206 p_vout->fmt_in.i_sar_num = i_sar_num;
1207 p_vout->fmt_in.i_sar_den = i_sar_den;
1208 p_vout->fmt_in.i_aspect = i_aspect_num * VOUT_ASPECT_FACTOR / i_aspect_den;
1209 p_vout->render.i_aspect = p_vout->fmt_in.i_aspect;
1212 if( p_vout->p->i_par_num && p_vout->p->i_par_den )
1214 p_vout->fmt_in.i_sar_num *= p_vout->p->i_par_den;
1215 p_vout->fmt_in.i_sar_den *= p_vout->p->i_par_num;
1216 p_vout->fmt_in.i_aspect = p_vout->fmt_in.i_aspect *
1217 p_vout->p->i_par_den / p_vout->p->i_par_num;
1218 p_vout->render.i_aspect = p_vout->fmt_in.i_aspect;
1221 p_vout->i_changes |= VOUT_ASPECT_CHANGE;
1223 vlc_ureduce( &i_aspect_num, &i_aspect_den,
1224 p_vout->fmt_in.i_aspect, VOUT_ASPECT_FACTOR, 0 );
1225 msg_Dbg( p_vout, "new aspect-ratio %i:%i, sample aspect-ratio %i:%i",
1226 i_aspect_num, i_aspect_den,
1227 p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
1229 if( var_Get( p_vout, "crop", &val ) )
1230 return VLC_EGENERIC;
1232 int i_ret = CropCallback( p_this, "crop", val, val, 0 );
1233 free( val.psz_string );
1237 static int OnTopCallback( vlc_object_t *p_this, char const *psz_cmd,
1238 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1240 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1241 vout_Control( p_vout, VOUT_SET_STAY_ON_TOP, newval.b_bool );
1242 (void)psz_cmd; (void)oldval; (void)p_data;
1244 /* Modify libvlc as well because the vout might have to be restarted */
1245 var_Create( p_vout->p_libvlc, "video-on-top", VLC_VAR_BOOL );
1246 var_Set( p_vout->p_libvlc, "video-on-top", newval );
1251 static int FullscreenCallback( vlc_object_t *p_this, char const *psz_cmd,
1252 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1254 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1256 (void)psz_cmd; (void)oldval; (void)p_data;
1258 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1260 /* Modify libvlc as well because the vout might have to be restarted */
1261 var_Create( p_vout->p_libvlc, "fullscreen", VLC_VAR_BOOL );
1262 var_Set( p_vout->p_libvlc, "fullscreen", newval );
1265 var_Set( p_vout, "intf-change", val );
1269 static int SnapshotCallback( vlc_object_t *p_this, char const *psz_cmd,
1270 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1272 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1273 VLC_UNUSED(newval); VLC_UNUSED(p_data);
1274 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1275 vout_Control( p_vout, VOUT_SNAPSHOT );
1279 static int TitleShowCallback( vlc_object_t *p_this, char const *psz_cmd,
1280 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1282 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1284 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1285 p_vout->p->b_title_show = newval.b_bool;
1289 static int TitleTimeoutCallback( vlc_object_t *p_this, char const *psz_cmd,
1290 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1292 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
1293 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1294 p_vout->p->i_title_timeout = (mtime_t) newval.i_int;
1298 static int TitlePositionCallback( vlc_object_t *p_this, char const *psz_cmd,
1299 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1301 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1303 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1304 p_vout->p->i_title_position = newval.i_int;