]> git.sesse.net Git - vlc/blob - src/video_output/vout_intf.c
playlist: allow video-on-top variable to be preserved across vouts
[vlc] / src / video_output / vout_intf.c
1 /*****************************************************************************
2  * vout_intf.c : video output interface
3  *****************************************************************************
4  * Copyright (C) 2000-2007 the VideoLAN team
5  *
6  * Authors: Gildas Bazin <gbazin@videolan.org>
7  *
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.
12  *
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.
17  *
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  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32
33 #include <stdio.h>
34 #include <stdlib.h>                                                /* free() */
35 #include <sys/types.h>                                          /* opendir() */
36 #include <dirent.h>                                             /* opendir() */
37 #include <assert.h>
38 #include <time.h>                                           /* strftime */
39
40 #include <vlc_interface.h>
41 #include <vlc_block.h>
42 #include <vlc_playlist.h>
43
44 #include <vlc_vout.h>
45 #include <vlc_image.h>
46 #include <vlc_osd.h>
47 #include <vlc_strings.h>
48 #include <vlc_charset.h>
49 #include "../libvlc.h"
50 #include "vout_internal.h"
51
52 /*****************************************************************************
53  * Local prototypes
54  *****************************************************************************/
55 static void InitWindowSize( vout_thread_t *, unsigned *, unsigned * );
56
57 /* Object variables callbacks */
58 static int ZoomCallback( vlc_object_t *, char const *,
59                          vlc_value_t, vlc_value_t, void * );
60 static int CropCallback( vlc_object_t *, char const *,
61                          vlc_value_t, vlc_value_t, void * );
62 static int AspectCallback( vlc_object_t *, char const *,
63                            vlc_value_t, vlc_value_t, void * );
64 static int ScalingCallback( vlc_object_t *, char const *,
65                             vlc_value_t, vlc_value_t, void * );
66 static int OnTopCallback( vlc_object_t *, char const *,
67                           vlc_value_t, vlc_value_t, void * );
68 static int FullscreenCallback( vlc_object_t *, char const *,
69                                vlc_value_t, vlc_value_t, void * );
70 static int SnapshotCallback( vlc_object_t *, char const *,
71                              vlc_value_t, vlc_value_t, void * );
72
73 static int TitleShowCallback( vlc_object_t *, char const *,
74                               vlc_value_t, vlc_value_t, void * );
75 static int TitleTimeoutCallback( vlc_object_t *, char const *,
76                                  vlc_value_t, vlc_value_t, void * );
77 static int TitlePositionCallback( vlc_object_t *, char const *,
78                                   vlc_value_t, vlc_value_t, void * );
79
80 /*****************************************************************************
81  * vout_IntfInit: called during the vout creation to initialise misc things.
82  *****************************************************************************/
83 static const struct
84 {
85     double f_value;
86     const char *psz_label;
87 } p_zoom_values[] = {
88     { 0.25, N_("1:4 Quarter") },
89     { 0.5, N_("1:2 Half") },
90     { 1, N_("1:1 Original") },
91     { 2, N_("2:1 Double") },
92     { 0, NULL } };
93
94 static const struct
95 {
96     const char *psz_value;
97     const char *psz_label;
98 } p_crop_values[] = {
99     { "", N_("Default") },
100     { "16:10", "16:10" },
101     { "16:9", "16:9" },
102     { "185:100", "1.85:1" },
103     { "221:100", "2.21:1" },
104     { "235:100", "2.35:1" },
105     { "239:100", "2.39:1" },
106     { "5:3", "5:3" },
107     { "4:3", "4:3" },
108     { "5:4", "5:4" },
109     { "1:1", "1:1" },
110     { NULL, NULL } };
111
112 static const struct
113 {
114     const char *psz_value;
115     const char *psz_label;
116 } p_aspect_ratio_values[] = {
117     { "", N_("Default") },
118     { "1:1", "1:1" },
119     { "4:3", "4:3" },
120     { "16:9", "16:9" },
121     { "16:10", "16:10" },
122     { "221:100", "2.21:1" },
123     { "5:4", "5:4" },
124     { NULL, NULL } };
125
126 static void AddCustomRatios( vout_thread_t *p_vout, const char *psz_var,
127                              char *psz_list )
128 {
129     assert( psz_list );
130
131     char *psz_cur = psz_list;
132     char *psz_next;
133     while( psz_cur && *psz_cur )
134     {
135         vlc_value_t val, text;
136         psz_next = strchr( psz_cur, ',' );
137         if( psz_next )
138         {
139             *psz_next = '\0';
140             psz_next++;
141         }
142         val.psz_string = psz_cur;
143         text.psz_string = psz_cur;
144         var_Change( p_vout, psz_var, VLC_VAR_ADDCHOICE, &val, &text);
145         psz_cur = psz_next;
146     }
147 }
148
149 void vout_IntfInit( vout_thread_t *p_vout )
150 {
151     vlc_value_t val, text, old_val;
152     bool b_force_par = false;
153     char *psz_buf;
154     int i;
155
156     /* Create a few object variables we'll need later on */
157     var_Create( p_vout, "snapshot-path", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
158     var_Create( p_vout, "snapshot-prefix", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
159     var_Create( p_vout, "snapshot-format", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
160     var_Create( p_vout, "snapshot-preview", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
161     var_Create( p_vout, "snapshot-sequential",
162                 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
163     var_Create( p_vout, "snapshot-num", VLC_VAR_INTEGER );
164     var_SetInteger( p_vout, "snapshot-num", 1 );
165     var_Create( p_vout, "snapshot-width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
166     var_Create( p_vout, "snapshot-height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
167
168     var_Create( p_vout, "width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
169     var_Create( p_vout, "height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
170     p_vout->i_alignment = var_CreateGetInteger( p_vout, "align" );
171
172     var_Create( p_vout, "video-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
173     var_Create( p_vout, "video-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
174
175     var_Create( p_vout, "mouse-hide-timeout",
176                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
177
178     p_vout->p->b_title_show = var_CreateGetBool( p_vout, "video-title-show" );
179     p_vout->p->i_title_timeout =
180         (mtime_t)var_CreateGetInteger( p_vout, "video-title-timeout" );
181     p_vout->p->i_title_position =
182         var_CreateGetInteger( p_vout, "video-title-position" );
183     p_vout->p->psz_title =  NULL;
184
185     var_AddCallback( p_vout, "video-title-show", TitleShowCallback, NULL );
186     var_AddCallback( p_vout, "video-title-timeout", TitleTimeoutCallback, NULL );
187     var_AddCallback( p_vout, "video-title-position", TitlePositionCallback, NULL );
188
189     /* Zoom object var */
190     var_Create( p_vout, "zoom", VLC_VAR_FLOAT | VLC_VAR_ISCOMMAND |
191                 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
192
193     text.psz_string = _("Zoom");
194     var_Change( p_vout, "zoom", VLC_VAR_SETTEXT, &text, NULL );
195
196     var_Get( p_vout, "zoom", &old_val );
197
198     for( i = 0; p_zoom_values[i].f_value; i++ )
199     {
200         if( old_val.f_float == p_zoom_values[i].f_value )
201             var_Change( p_vout, "zoom", VLC_VAR_DELCHOICE, &old_val, NULL );
202         val.f_float = p_zoom_values[i].f_value;
203         text.psz_string = _( p_zoom_values[i].psz_label );
204         var_Change( p_vout, "zoom", VLC_VAR_ADDCHOICE, &val, &text );
205     }
206
207     var_Set( p_vout, "zoom", old_val ); /* Is this really needed? */
208
209     var_AddCallback( p_vout, "zoom", ZoomCallback, NULL );
210
211     /* Crop offset vars */
212     var_Create( p_vout, "crop-left", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
213     var_Create( p_vout, "crop-top", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
214     var_Create( p_vout, "crop-right", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
215     var_Create( p_vout, "crop-bottom", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
216
217     var_AddCallback( p_vout, "crop-left", CropCallback, NULL );
218     var_AddCallback( p_vout, "crop-top", CropCallback, NULL );
219     var_AddCallback( p_vout, "crop-right", CropCallback, NULL );
220     var_AddCallback( p_vout, "crop-bottom", CropCallback, NULL );
221
222     /* Crop object var */
223     var_Create( p_vout, "crop", VLC_VAR_STRING | VLC_VAR_ISCOMMAND |
224                 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
225
226     text.psz_string = _("Crop");
227     var_Change( p_vout, "crop", VLC_VAR_SETTEXT, &text, NULL );
228
229     val.psz_string = (char*)"";
230     var_Change( p_vout, "crop", VLC_VAR_DELCHOICE, &val, 0 );
231
232     for( i = 0; p_crop_values[i].psz_value; i++ )
233     {
234         val.psz_string = (char*)p_crop_values[i].psz_value;
235         text.psz_string = _( p_crop_values[i].psz_label );
236         var_Change( p_vout, "crop", VLC_VAR_ADDCHOICE, &val, &text );
237     }
238
239     /* update triggered every time the vout's crop parameters are changed */
240     var_Create( p_vout, "crop-update", VLC_VAR_VOID );
241
242     /* Add custom crop ratios */
243     psz_buf = var_CreateGetNonEmptyString( p_vout, "custom-crop-ratios" );
244     if( psz_buf )
245     {
246         AddCustomRatios( p_vout, "crop", psz_buf );
247         free( psz_buf );
248     }
249
250     var_AddCallback( p_vout, "crop", CropCallback, NULL );
251     var_Get( p_vout, "crop", &old_val );
252     if( old_val.psz_string && *old_val.psz_string )
253         var_TriggerCallback( p_vout, "crop" );
254     free( old_val.psz_string );
255
256     /* Monitor pixel aspect-ratio */
257     var_Create( p_vout, "monitor-par", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
258     var_Get( p_vout, "monitor-par", &val );
259     if( val.psz_string && *val.psz_string )
260     {
261         char *psz_parser = strchr( val.psz_string, ':' );
262         unsigned int i_aspect_num = 0, i_aspect_den = 0;
263         float i_aspect = 0;
264         if( psz_parser )
265         {
266             i_aspect_num = strtol( val.psz_string, 0, 10 );
267             i_aspect_den = strtol( ++psz_parser, 0, 10 );
268         }
269         else
270         {
271             i_aspect = us_atof( val.psz_string );
272             vlc_ureduce( &i_aspect_num, &i_aspect_den,
273                          i_aspect *VOUT_ASPECT_FACTOR, VOUT_ASPECT_FACTOR, 0 );
274         }
275         if( !i_aspect_num || !i_aspect_den ) i_aspect_num = i_aspect_den = 1;
276
277         p_vout->p->i_par_num = i_aspect_num;
278         p_vout->p->i_par_den = i_aspect_den;
279
280         vlc_ureduce( &p_vout->p->i_par_num, &p_vout->p->i_par_den,
281                      p_vout->p->i_par_num, p_vout->p->i_par_den, 0 );
282
283         msg_Dbg( p_vout, "overriding monitor pixel aspect-ratio: %i:%i",
284                  p_vout->p->i_par_num, p_vout->p->i_par_den );
285         b_force_par = true;
286     }
287     free( val.psz_string );
288
289     /* Aspect-ratio object var */
290     var_Create( p_vout, "aspect-ratio", VLC_VAR_STRING | VLC_VAR_ISCOMMAND |
291                 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
292
293     text.psz_string = _("Aspect-ratio");
294     var_Change( p_vout, "aspect-ratio", VLC_VAR_SETTEXT, &text, NULL );
295
296     val.psz_string = (char*)"";
297     var_Change( p_vout, "aspect-ratio", VLC_VAR_DELCHOICE, &val, 0 );
298
299     for( i = 0; p_aspect_ratio_values[i].psz_value; i++ )
300     {
301         val.psz_string = (char*)p_aspect_ratio_values[i].psz_value;
302         text.psz_string = _( p_aspect_ratio_values[i].psz_label );
303         var_Change( p_vout, "aspect-ratio", VLC_VAR_ADDCHOICE, &val, &text );
304     }
305
306     /* Add custom aspect ratios */
307     psz_buf = var_CreateGetNonEmptyString( p_vout, "custom-aspect-ratios" );
308     if( psz_buf )
309     {
310         AddCustomRatios( p_vout, "aspect-ratio", psz_buf );
311         free( psz_buf );
312     }
313
314     var_AddCallback( p_vout, "aspect-ratio", AspectCallback, NULL );
315     var_Get( p_vout, "aspect-ratio", &old_val );
316     if( (old_val.psz_string && *old_val.psz_string) || b_force_par )
317         var_TriggerCallback( p_vout, "aspect-ratio" );
318     free( old_val.psz_string );
319
320     /* Add variables to manage scaling video */
321     var_Create( p_vout, "autoscale", VLC_VAR_BOOL | VLC_VAR_DOINHERIT
322                 | VLC_VAR_ISCOMMAND );
323     text.psz_string = _("Autoscale video");
324     var_Change( p_vout, "autoscale", VLC_VAR_SETTEXT, &text, NULL );
325     var_AddCallback( p_vout, "autoscale", ScalingCallback, NULL );
326     p_vout->b_autoscale = var_GetBool( p_vout, "autoscale" );
327
328     var_Create( p_vout, "scale", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
329                 | VLC_VAR_ISCOMMAND );
330     text.psz_string = _("Scale factor");
331     var_Change( p_vout, "scale", VLC_VAR_SETTEXT, &text, NULL );
332     var_AddCallback( p_vout, "scale", ScalingCallback, NULL );
333     p_vout->i_zoom = (int)( ZOOM_FP_FACTOR * var_GetFloat( p_vout, "scale" ) );
334
335     /* Initialize the dimensions of the video window */
336     InitWindowSize( p_vout, &p_vout->i_window_width,
337                     &p_vout->i_window_height );
338
339     /* Add a variable to indicate if the window should be on top of others */
340     var_Create( p_vout, "video-on-top", VLC_VAR_BOOL | VLC_VAR_DOINHERIT
341                 | VLC_VAR_ISCOMMAND );
342     text.psz_string = _("Always on top");
343     var_Change( p_vout, "video-on-top", VLC_VAR_SETTEXT, &text, NULL );
344     var_AddCallback( p_vout, "video-on-top", OnTopCallback, NULL );
345
346     /* Add a variable to indicate whether we want window decoration or not */
347     var_Create( p_vout, "video-deco", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
348
349     /* Add a fullscreen variable */
350     if( var_CreateGetBoolCommand( p_vout, "fullscreen" ) )
351     {
352         /* user requested fullscreen */
353         p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
354     }
355     text.psz_string = _("Fullscreen");
356     var_Change( p_vout, "fullscreen", VLC_VAR_SETTEXT, &text, NULL );
357     var_AddCallback( p_vout, "fullscreen", FullscreenCallback, NULL );
358
359     /* Add a snapshot variable */
360     var_Create( p_vout, "video-snapshot", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
361     text.psz_string = _("Snapshot");
362     var_Change( p_vout, "video-snapshot", VLC_VAR_SETTEXT, &text, NULL );
363     var_AddCallback( p_vout, "video-snapshot", SnapshotCallback, NULL );
364
365     /* Mouse coordinates */
366     var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
367     var_Create( p_vout, "mouse-moved", VLC_VAR_COORDS );
368     var_Create( p_vout, "mouse-clicked", VLC_VAR_COORDS );
369     var_Create( p_vout, "mouse-object", VLC_VAR_BOOL );
370
371     var_Create( p_vout, "intf-change", VLC_VAR_BOOL );
372     var_SetBool( p_vout, "intf-change", true );
373 }
374
375 /*****************************************************************************
376  * vout_Snapshot: generates a snapshot.
377  *****************************************************************************/
378 /**
379  * This function will inject a subpicture into the vout with the provided
380  * picture
381  */
382 static int VoutSnapshotPip( vout_thread_t *p_vout, picture_t *p_pic )
383 {
384     subpicture_t *p_subpic = subpicture_NewFromPicture( VLC_OBJECT(p_vout),
385                                                         p_pic, VLC_CODEC_YUVA );
386     if( !p_subpic )
387         return VLC_EGENERIC;
388
389     /* FIXME DEFAULT_CHAN is not good (used by the text) but
390      * hardcoded 0 doesn't seem right */
391     p_subpic->i_channel = 0;
392     p_subpic->i_start = mdate();
393     p_subpic->i_stop  = p_subpic->i_start + 4000000;
394     p_subpic->b_ephemer = true;
395     p_subpic->b_fade = true;
396
397     /* Reduce the picture to 1/4^2 of the screen */
398     p_subpic->i_original_picture_width  *= 4;
399     p_subpic->i_original_picture_height *= 4;
400
401     spu_DisplaySubpicture( p_vout->p_spu, p_subpic );
402     return VLC_SUCCESS;
403 }
404
405 /**
406  * This function will display the name and a PIP of the provided snapshot
407  */
408 static void VoutOsdSnapshot( vout_thread_t *p_vout, picture_t *p_pic, const char *psz_filename )
409 {
410     msg_Dbg( p_vout, "snapshot taken (%s)", psz_filename );
411     vout_OSDMessage( VLC_OBJECT( p_vout ), DEFAULT_CHAN, "%s", psz_filename );
412
413     if( var_GetBool( p_vout, "snapshot-preview" ) )
414     {
415         if( VoutSnapshotPip( p_vout, p_pic ) )
416             msg_Warn( p_vout, "Failed to display snapshot" );
417     }
418 }
419
420 /* */
421 int vout_GetSnapshot( vout_thread_t *p_vout,
422                       block_t **pp_image, picture_t **pp_picture,
423                       video_format_t *p_fmt,
424                       const char *psz_format, mtime_t i_timeout )
425 {
426     picture_t *p_picture = vout_snapshot_Get( &p_vout->p->snapshot, i_timeout );
427     if( !p_picture )
428     {
429         msg_Err( p_vout, "Failed to grab a snapshot" );
430         return VLC_EGENERIC;
431     }
432
433     if( pp_image )
434     {
435         vlc_fourcc_t i_format = VLC_CODEC_PNG;
436         if( psz_format && image_Type2Fourcc( psz_format ) )
437             i_format = image_Type2Fourcc( psz_format );
438
439         const int i_override_width  = var_GetInteger( p_vout, "snapshot-width" );
440         const int i_override_height = var_GetInteger( p_vout, "snapshot-height" );
441
442         if( picture_Export( VLC_OBJECT(p_vout), pp_image, p_fmt,
443                             p_picture, i_format, i_override_width, i_override_height ) )
444         {
445             msg_Err( p_vout, "Failed to convert image for snapshot" );
446             picture_Release( p_picture );
447             return VLC_EGENERIC;
448         }
449     }
450     if( pp_picture )
451         *pp_picture = p_picture;
452     else
453         picture_Release( p_picture );
454     return VLC_SUCCESS;
455 }
456
457 /**
458  * This function will handle a snapshot request
459  */
460 static void VoutSaveSnapshot( vout_thread_t *p_vout )
461 {
462     char *psz_path = var_GetNonEmptyString( p_vout, "snapshot-path" );
463     char *psz_format = var_GetNonEmptyString( p_vout, "snapshot-format" );
464     char *psz_prefix = var_GetNonEmptyString( p_vout, "snapshot-prefix" );
465
466     /* */
467     picture_t *p_picture;
468     block_t *p_image;
469     video_format_t fmt;
470
471     /* 500ms timeout
472      * XXX it will cause trouble with low fps video (< 2fps) */
473     if( vout_GetSnapshot( p_vout, &p_image, &p_picture, &fmt, psz_format, 500*1000 ) )
474     {
475         p_picture = NULL;
476         p_image = NULL;
477         goto exit;
478     }
479
480     if( !psz_path )
481     {
482         psz_path = vout_snapshot_GetDirectory();
483         if( !psz_path )
484         {
485             msg_Err( p_vout, "no path specified for snapshots" );
486             goto exit;
487         }
488     }
489
490     vout_snapshot_save_cfg_t cfg;
491     memset( &cfg, 0, sizeof(cfg) );
492     cfg.is_sequential = var_GetBool( p_vout, "snapshot-sequential" );
493     cfg.sequence = var_GetInteger( p_vout, "snapshot-num" );
494     cfg.path = psz_path;
495     cfg.format = psz_format;
496     cfg.prefix_fmt = psz_prefix;
497
498     char *psz_filename;
499     int  i_sequence;
500     if (vout_snapshot_SaveImage( &psz_filename, &i_sequence,
501                                  p_image, VLC_OBJECT(p_vout), &cfg ) )
502         goto exit;
503     if( cfg.is_sequential )
504         var_SetInteger( p_vout, "snapshot-num", i_sequence + 1 );
505
506     VoutOsdSnapshot( p_vout, p_picture, psz_filename );
507
508     /* signal creation of a new snapshot file */
509     var_SetString( p_vout->p_libvlc, "snapshot-file", psz_filename );
510
511     free( psz_filename );
512
513 exit:
514     if( p_image )
515         block_Release( p_image );
516     if( p_picture )
517         picture_Release( p_picture );
518     free( psz_prefix );
519     free( psz_format );
520     free( psz_path );
521 }
522
523 /*****************************************************************************
524  * Handle filters
525  *****************************************************************************/
526
527 void vout_EnableFilter( vout_thread_t *p_vout, const char *psz_name,
528                         bool b_add, bool b_setconfig )
529 {
530     char *psz_parser;
531     char *psz_string;
532     const char *psz_filter_type;
533
534     /* FIXME temporary hack */
535     const char *psz_module_name = psz_name;
536     if( !strcmp( psz_name, "magnify" ) ||
537         !strcmp( psz_name, "puzzle" ) ||
538         !strcmp( psz_name, "logo" ) ||
539         !strcmp( psz_name, "wall" ) ||
540         !strcmp( psz_name, "clone" ) )
541         psz_module_name = "video_filter_wrapper";
542
543     module_t *p_obj = module_find( psz_module_name );
544     if( !p_obj )
545     {
546         msg_Err( p_vout, "Unable to find filter module \"%s\".", psz_name );
547         return;
548     }
549
550     if( module_provides( p_obj, "video filter" ) )
551     {
552         psz_filter_type = "vout-filter";
553     }
554     else if( module_provides( p_obj, "video filter2" ) )
555     {
556         psz_filter_type = "video-filter";
557     }
558     else if( module_provides( p_obj, "sub filter" ) )
559     {
560         psz_filter_type = "sub-filter";
561     }
562     else
563     {
564         module_release( p_obj );
565         msg_Err( p_vout, "Unknown video filter type." );
566         return;
567     }
568     module_release( p_obj );
569
570     if( !strcmp( psz_filter_type, "sub-filter") )
571         psz_string = var_GetString( vout_GetSpu( p_vout ), psz_filter_type );
572     else
573         psz_string = var_GetString( p_vout, psz_filter_type );
574
575     /* Todo : Use some generic chain manipulation functions */
576     if( !psz_string ) psz_string = strdup("");
577
578     psz_parser = strstr( psz_string, psz_name );
579     if( b_add )
580     {
581         if( !psz_parser )
582         {
583             psz_parser = psz_string;
584             if( asprintf( &psz_string, (*psz_string) ? "%s:%s" : "%s%s",
585                           psz_string, psz_name ) == -1 )
586             {
587                 free( psz_parser );
588                 return;
589             }
590             free( psz_parser );
591         }
592         else
593             return;
594     }
595     else
596     {
597         if( psz_parser )
598         {
599             memmove( psz_parser, psz_parser + strlen(psz_name) +
600                             (*(psz_parser + strlen(psz_name)) == ':' ? 1 : 0 ),
601                             strlen(psz_parser + strlen(psz_name)) + 1 );
602
603             /* Remove trailing : : */
604             if( *(psz_string+strlen(psz_string ) -1 ) == ':' )
605             {
606                 *(psz_string+strlen(psz_string ) -1 ) = '\0';
607             }
608          }
609          else
610          {
611              free( psz_string );
612              return;
613          }
614     }
615
616     if( b_setconfig )
617     {
618         if( !strcmp( psz_filter_type, "sub-filter") )
619             config_PutPsz( vout_GetSpu( p_vout ), psz_filter_type, psz_string );
620         else
621             config_PutPsz( p_vout, psz_filter_type, psz_string );
622     }
623
624     if( !strcmp( psz_filter_type, "sub-filter") )
625         var_SetString( vout_GetSpu( p_vout ), psz_filter_type, psz_string );
626     else
627         var_SetString( p_vout, psz_filter_type, psz_string );
628
629     free( psz_string );
630 }
631
632 /*****************************************************************************
633  * InitWindowSize: find the initial dimensions the video window should have.
634  *****************************************************************************
635  * This function will check the "width", "height" and "zoom" config options and
636  * will calculate the size that the video window should have.
637  *****************************************************************************/
638 static void InitWindowSize( vout_thread_t *p_vout, unsigned *pi_width,
639                             unsigned *pi_height )
640 {
641 #define FP_FACTOR 1000                             /* our fixed point factor */
642
643     int i_width = var_GetInteger( p_vout, "width" );
644     int i_height = var_GetInteger( p_vout, "height" );
645     float f_zoom = var_GetFloat( p_vout, "zoom" );
646     uint64_t ll_zoom = (uint64_t)( FP_FACTOR * f_zoom );
647
648     if( i_width > 0 && i_height > 0)
649     {
650         *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
651         *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
652     }
653     else if( i_width > 0 )
654     {
655         *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
656         *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom *
657             p_vout->fmt_in.i_sar_den * i_width / p_vout->fmt_in.i_sar_num /
658             FP_FACTOR / p_vout->fmt_in.i_visible_width );
659     }
660     else if( i_height > 0 )
661     {
662         *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
663         *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom *
664             p_vout->fmt_in.i_sar_num * i_height / p_vout->fmt_in.i_sar_den /
665             FP_FACTOR / p_vout->fmt_in.i_visible_height );
666     }
667     else if( p_vout->fmt_in.i_sar_num == 0 || p_vout->fmt_in.i_sar_den == 0 )
668     {
669         msg_Warn( p_vout, "aspect ratio screwed up" );
670         *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom / FP_FACTOR );
671         *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom /FP_FACTOR);
672     }
673     else if( p_vout->fmt_in.i_sar_num >= p_vout->fmt_in.i_sar_den )
674     {
675         *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom *
676             p_vout->fmt_in.i_sar_num / p_vout->fmt_in.i_sar_den / FP_FACTOR );
677         *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom
678             / FP_FACTOR );
679     }
680     else
681     {
682         *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom
683             / FP_FACTOR );
684         *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom *
685             p_vout->fmt_in.i_sar_den / p_vout->fmt_in.i_sar_num / FP_FACTOR );
686     }
687
688     msg_Dbg( p_vout, "window size: %ux%u", *pi_width, *pi_height );
689
690 #undef FP_FACTOR
691 }
692
693 /*****************************************************************************
694  * Object variables callbacks
695  *****************************************************************************/
696 static int ZoomCallback( vlc_object_t *p_this, char const *psz_cmd,
697                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
698 {
699     (void)psz_cmd; (void)oldval; (void)p_data;
700
701     return var_SetFloat( p_this, "scale", newval.f_float );
702 }
703
704 static int CropCallback( vlc_object_t *p_this, char const *psz_cmd,
705                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
706 {
707     vout_thread_t *p_vout = (vout_thread_t *)p_this;
708     int64_t i_aspect_num, i_aspect_den;
709     unsigned int i_width, i_height;
710
711     (void)oldval; (void)p_data;
712
713     /* Restore defaults */
714     p_vout->fmt_in.i_x_offset = p_vout->fmt_render.i_x_offset;
715     p_vout->fmt_in.i_visible_width = p_vout->fmt_render.i_visible_width;
716     p_vout->fmt_in.i_y_offset = p_vout->fmt_render.i_y_offset;
717     p_vout->fmt_in.i_visible_height = p_vout->fmt_render.i_visible_height;
718
719     if( !strcmp( psz_cmd, "crop" ) )
720     {
721         char *psz_end = NULL, *psz_parser = strchr( newval.psz_string, ':' );
722         if( psz_parser )
723         {
724             /* We're using the 3:4 syntax */
725             i_aspect_num = strtol( newval.psz_string, &psz_end, 10 );
726             if( psz_end == newval.psz_string || !i_aspect_num ) goto crop_end;
727
728             i_aspect_den = strtol( ++psz_parser, &psz_end, 10 );
729             if( psz_end == psz_parser || !i_aspect_den ) goto crop_end;
730
731             i_width = p_vout->fmt_in.i_sar_den*p_vout->fmt_render.i_visible_height *
732                 i_aspect_num / i_aspect_den / p_vout->fmt_in.i_sar_num;
733             i_height = p_vout->fmt_render.i_visible_width*p_vout->fmt_in.i_sar_num *
734                 i_aspect_den / i_aspect_num / p_vout->fmt_in.i_sar_den;
735
736             if( i_width < p_vout->fmt_render.i_visible_width )
737             {
738                 p_vout->fmt_in.i_x_offset = p_vout->fmt_render.i_x_offset +
739                     (p_vout->fmt_render.i_visible_width - i_width) / 2;
740                 p_vout->fmt_in.i_visible_width = i_width;
741             }
742             else
743             {
744                 p_vout->fmt_in.i_y_offset = p_vout->fmt_render.i_y_offset +
745                     (p_vout->fmt_render.i_visible_height - i_height) / 2;
746                 p_vout->fmt_in.i_visible_height = i_height;
747             }
748         }
749         else
750         {
751             psz_parser = strchr( newval.psz_string, 'x' );
752             if( psz_parser )
753             {
754                 /* Maybe we're using the <width>x<height>+<left>+<top> syntax */
755                 unsigned int i_crop_width, i_crop_height, i_crop_top, i_crop_left;
756
757                 i_crop_width = strtol( newval.psz_string, &psz_end, 10 );
758                 if( psz_end != psz_parser ) goto crop_end;
759
760                 psz_parser = strchr( ++psz_end, '+' );
761                 i_crop_height = strtol( psz_end, &psz_end, 10 );
762                 if( psz_end != psz_parser ) goto crop_end;
763
764                 psz_parser = strchr( ++psz_end, '+' );
765                 i_crop_left = strtol( psz_end, &psz_end, 10 );
766                 if( psz_end != psz_parser ) goto crop_end;
767
768                 psz_end++;
769                 i_crop_top = strtol( psz_end, &psz_end, 10 );
770                 if( *psz_end != '\0' ) goto crop_end;
771
772                 if( i_crop_top + i_crop_height >= p_vout->fmt_render.i_visible_height ||
773                     i_crop_left + i_crop_width >= p_vout->fmt_render.i_visible_width )
774                 {
775                     msg_Err( p_vout, "Unable to crop over picture boundaries");
776                     return VLC_EGENERIC;
777                 }
778
779                 i_width = i_crop_width;
780                 p_vout->fmt_in.i_visible_width = i_width;
781
782                 i_height = i_crop_height;
783                 p_vout->fmt_in.i_visible_height = i_height;
784
785                 p_vout->fmt_in.i_x_offset = i_crop_left;
786                 p_vout->fmt_in.i_y_offset = i_crop_top;
787             }
788             else
789             {
790                 /* Maybe we're using the <left>+<top>+<right>+<bottom> syntax */
791                 unsigned int i_crop_top, i_crop_left, i_crop_bottom, i_crop_right;
792
793                 psz_parser = strchr( newval.psz_string, '+' );
794                 i_crop_left = strtol( newval.psz_string, &psz_end, 10 );
795                 if( psz_end != psz_parser ) goto crop_end;
796
797                 psz_parser = strchr( ++psz_end, '+' );
798                 i_crop_top = strtol( psz_end, &psz_end, 10 );
799                 if( psz_end != psz_parser ) goto crop_end;
800
801                 psz_parser = strchr( ++psz_end, '+' );
802                 i_crop_right = strtol( psz_end, &psz_end, 10 );
803                 if( psz_end != psz_parser ) goto crop_end;
804
805                 psz_end++;
806                 i_crop_bottom = strtol( psz_end, &psz_end, 10 );
807                 if( *psz_end != '\0' ) goto crop_end;
808
809                 if( i_crop_top + i_crop_bottom >= p_vout->fmt_render.i_visible_height ||
810                     i_crop_right + i_crop_left >= p_vout->fmt_render.i_visible_width )
811                 {
812                     msg_Err( p_vout, "Unable to crop over picture boundaries" );
813                     return VLC_EGENERIC;
814                 }
815
816                 i_width = p_vout->fmt_render.i_visible_width
817                           - i_crop_left - i_crop_right;
818                 p_vout->fmt_in.i_visible_width = i_width;
819
820                 i_height = p_vout->fmt_render.i_visible_height
821                            - i_crop_top - i_crop_bottom;
822                 p_vout->fmt_in.i_visible_height = i_height;
823
824                 p_vout->fmt_in.i_x_offset = i_crop_left;
825                 p_vout->fmt_in.i_y_offset = i_crop_top;
826             }
827         }
828     }
829     else if( !strcmp( psz_cmd, "crop-top" )
830           || !strcmp( psz_cmd, "crop-left" )
831           || !strcmp( psz_cmd, "crop-bottom" )
832           || !strcmp( psz_cmd, "crop-right" ) )
833     {
834         unsigned int i_crop_top, i_crop_left, i_crop_bottom, i_crop_right;
835
836         i_crop_top = var_GetInteger( p_vout, "crop-top" );
837         i_crop_left = var_GetInteger( p_vout, "crop-left" );
838         i_crop_right = var_GetInteger( p_vout, "crop-right" );
839         i_crop_bottom = var_GetInteger( p_vout, "crop-bottom" );
840
841         if( i_crop_top + i_crop_bottom >= p_vout->fmt_render.i_visible_height ||
842             i_crop_right + i_crop_left >= p_vout->fmt_render.i_visible_width )
843         {
844             msg_Err( p_vout, "Unable to crop over picture boundaries" );
845             return VLC_EGENERIC;
846         }
847
848         i_width = p_vout->fmt_render.i_visible_width
849                   - i_crop_left - i_crop_right;
850         p_vout->fmt_in.i_visible_width = i_width;
851
852         i_height = p_vout->fmt_render.i_visible_height
853                    - i_crop_top - i_crop_bottom;
854         p_vout->fmt_in.i_visible_height = i_height;
855
856         p_vout->fmt_in.i_x_offset = i_crop_left;
857         p_vout->fmt_in.i_y_offset = i_crop_top;
858     }
859
860  crop_end:
861     InitWindowSize( p_vout, &p_vout->i_window_width,
862                     &p_vout->i_window_height );
863
864     p_vout->i_changes |= VOUT_CROP_CHANGE;
865
866     msg_Dbg( p_vout, "cropping picture %ix%i to %i,%i,%ix%i",
867              p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
868              p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
869              p_vout->fmt_in.i_visible_width,
870              p_vout->fmt_in.i_visible_height );
871
872     var_TriggerCallback( p_vout, "crop-update" );
873
874     return VLC_SUCCESS;
875 }
876
877 static int AspectCallback( vlc_object_t *p_this, char const *psz_cmd,
878                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
879 {
880     vout_thread_t *p_vout = (vout_thread_t *)p_this;
881     unsigned int i_aspect_num, i_aspect_den, i_sar_num, i_sar_den;
882     vlc_value_t val;
883
884     char *psz_end, *psz_parser = strchr( newval.psz_string, ':' );
885     (void)psz_cmd; (void)oldval; (void)p_data;
886
887     /* Restore defaults */
888     p_vout->fmt_in.i_sar_num = p_vout->fmt_render.i_sar_num;
889     p_vout->fmt_in.i_sar_den = p_vout->fmt_render.i_sar_den;
890     p_vout->render.i_aspect = (int64_t)p_vout->fmt_render.i_sar_num *
891                                        p_vout->fmt_render.i_width *
892                                        VOUT_ASPECT_FACTOR /
893                                        p_vout->fmt_render.i_sar_den / p_vout->fmt_render.i_height;
894
895     if( !psz_parser ) goto aspect_end;
896
897     i_aspect_num = strtol( newval.psz_string, &psz_end, 10 );
898     if( psz_end == newval.psz_string || !i_aspect_num ) goto aspect_end;
899
900     i_aspect_den = strtol( ++psz_parser, &psz_end, 10 );
901     if( psz_end == psz_parser || !i_aspect_den ) goto aspect_end;
902
903     i_sar_num = i_aspect_num * p_vout->fmt_render.i_visible_height;
904     i_sar_den = i_aspect_den * p_vout->fmt_render.i_visible_width;
905     vlc_ureduce( &i_sar_num, &i_sar_den, i_sar_num, i_sar_den, 0 );
906     p_vout->fmt_in.i_sar_num = i_sar_num;
907     p_vout->fmt_in.i_sar_den = i_sar_den;
908     p_vout->render.i_aspect = i_aspect_num * VOUT_ASPECT_FACTOR / i_aspect_den;
909
910  aspect_end:
911     if( p_vout->p->i_par_num && p_vout->p->i_par_den )
912     {
913         p_vout->fmt_in.i_sar_num *= p_vout->p->i_par_den;
914         p_vout->fmt_in.i_sar_den *= p_vout->p->i_par_num;
915         p_vout->render.i_aspect = (int64_t)p_vout->fmt_in.i_sar_num *
916                                            p_vout->fmt_in.i_width *
917                                            VOUT_ASPECT_FACTOR /
918                                            p_vout->fmt_in.i_sar_den /
919                                            p_vout->fmt_in.i_height;
920     }
921
922     p_vout->i_changes |= VOUT_ASPECT_CHANGE;
923
924     msg_Dbg( p_vout, "new aspect-ratio %i:%i, sample aspect-ratio %i:%i",
925              p_vout->fmt_in.i_sar_num * p_vout->fmt_in.i_width,
926              p_vout->fmt_in.i_sar_den * p_vout->fmt_in.i_height,
927              p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
928
929     if( var_Get( p_vout, "crop", &val ) )
930         return VLC_EGENERIC;
931
932     int i_ret = CropCallback( p_this, "crop", val, val, 0 );
933     free( val.psz_string );
934     return i_ret;
935 }
936
937 static int ScalingCallback( vlc_object_t *p_this, char const *psz_cmd,
938                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
939 {
940     vout_thread_t *p_vout = (vout_thread_t *)p_this;
941     (void)oldval; (void)newval; (void)p_data;
942
943     vlc_mutex_lock( &p_vout->change_lock );
944
945     if( !strcmp( psz_cmd, "autoscale" ) )
946     {
947         p_vout->i_changes |= VOUT_SCALE_CHANGE;
948     }
949     else if( !strcmp( psz_cmd, "scale" ) )
950     {
951         p_vout->i_changes |= VOUT_ZOOM_CHANGE;
952     }
953
954     vlc_mutex_unlock( &p_vout->change_lock );
955
956     return VLC_SUCCESS;
957 }
958
959 static int OnTopCallback( vlc_object_t *p_this, char const *psz_cmd,
960                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
961 {
962     vout_thread_t *p_vout = (vout_thread_t *)p_this;
963
964     vlc_mutex_lock( &p_vout->change_lock );
965     p_vout->i_changes |= VOUT_ON_TOP_CHANGE;
966     p_vout->b_on_top = newval.b_bool;
967     vlc_mutex_unlock( &p_vout->change_lock );
968
969     (void)psz_cmd; (void)oldval; (void)p_data;
970     return VLC_SUCCESS;
971 }
972
973 static int FullscreenCallback( vlc_object_t *p_this, char const *psz_cmd,
974                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
975 {
976     vout_thread_t *p_vout = (vout_thread_t *)p_this;
977     vlc_value_t val;
978     (void)psz_cmd; (void)p_data;
979
980     if( oldval.b_bool == newval.b_bool )
981         return VLC_SUCCESS; /* no-op */
982     p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
983
984     val.b_bool = true;
985     var_Set( p_vout, "intf-change", val );
986     return VLC_SUCCESS;
987 }
988
989 static int SnapshotCallback( vlc_object_t *p_this, char const *psz_cmd,
990                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
991 {
992     vout_thread_t *p_vout = (vout_thread_t *)p_this;
993     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
994     VLC_UNUSED(newval); VLC_UNUSED(p_data);
995
996     VoutSaveSnapshot( p_vout );
997     return VLC_SUCCESS;
998 }
999
1000 static int TitleShowCallback( vlc_object_t *p_this, char const *psz_cmd,
1001                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1002 {
1003     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1004     VLC_UNUSED(p_data);
1005     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1006     p_vout->p->b_title_show = newval.b_bool;
1007     return VLC_SUCCESS;
1008 }
1009
1010 static int TitleTimeoutCallback( vlc_object_t *p_this, char const *psz_cmd,
1011                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1012 {
1013     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
1014     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1015     p_vout->p->i_title_timeout = (mtime_t) newval.i_int;
1016     return VLC_SUCCESS;
1017 }
1018
1019 static int TitlePositionCallback( vlc_object_t *p_this, char const *psz_cmd,
1020                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1021 {
1022     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
1023     VLC_UNUSED(p_data);
1024     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1025     p_vout->p->i_title_position = newval.i_int;
1026     return VLC_SUCCESS;
1027 }