]> git.sesse.net Git - vlc/blob - src/video_output/vout_intf.c
Use var_Inherit* instead of var_CreateGet*.
[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 #include <vlc_modules.h>
44
45 #include <vlc_vout.h>
46 #include <vlc_image.h>
47 #include <vlc_vout_osd.h>
48 #include <vlc_strings.h>
49 #include <vlc_charset.h>
50 #include "../libvlc.h"
51 #include "vout_internal.h"
52
53 /*****************************************************************************
54  * Local prototypes
55  *****************************************************************************/
56 /* Object variables callbacks */
57 static int ZoomCallback( vlc_object_t *, char const *,
58                          vlc_value_t, vlc_value_t, void * );
59 static int CropCallback( vlc_object_t *, char const *,
60                          vlc_value_t, vlc_value_t, void * );
61 static int CropBorderCallback( vlc_object_t *, char const *,
62                                vlc_value_t, vlc_value_t, void * );
63 static int AspectCallback( vlc_object_t *, char const *,
64                            vlc_value_t, vlc_value_t, void * );
65 static int ScalingCallback( vlc_object_t *, char const *,
66                             vlc_value_t, vlc_value_t, void * );
67 static int OnTopCallback( vlc_object_t *, char const *,
68                           vlc_value_t, vlc_value_t, void * );
69 static int FullscreenCallback( vlc_object_t *, char const *,
70                                vlc_value_t, vlc_value_t, void * );
71 static int SnapshotCallback( vlc_object_t *, char const *,
72                              vlc_value_t, vlc_value_t, void * );
73 static int VideoFilterCallback( vlc_object_t *, char const *,
74                                 vlc_value_t, vlc_value_t, void * );
75 static int VideoSplitterCallback( vlc_object_t *, char const *,
76                                   vlc_value_t, vlc_value_t, void * );
77 static int SubFilterCallback( vlc_object_t *, char const *,
78                               vlc_value_t, vlc_value_t, void * );
79 static int SubMarginCallback( vlc_object_t *, char const *,
80                               vlc_value_t, vlc_value_t, void * );
81 static int TitleShowCallback( vlc_object_t *, char const *,
82                               vlc_value_t, vlc_value_t, void * );
83 static int TitleTimeoutCallback( vlc_object_t *, char const *,
84                                  vlc_value_t, vlc_value_t, void * );
85 static int TitlePositionCallback( vlc_object_t *, char const *,
86                                   vlc_value_t, vlc_value_t, void * );
87
88 /*****************************************************************************
89  * vout_IntfInit: called during the vout creation to initialise misc things.
90  *****************************************************************************/
91 static const struct
92 {
93     double f_value;
94     const char *psz_label;
95 } p_zoom_values[] = {
96     { 0.25, N_("1:4 Quarter") },
97     { 0.5, N_("1:2 Half") },
98     { 1, N_("1:1 Original") },
99     { 2, N_("2:1 Double") },
100     { 0, NULL } };
101
102 static const struct
103 {
104     const char *psz_value;
105     const char *psz_label;
106 } p_crop_values[] = {
107     { "", N_("Default") },
108     { "16:10", "16:10" },
109     { "16:9", "16:9" },
110     { "185:100", "1.85:1" },
111     { "221:100", "2.21:1" },
112     { "235:100", "2.35:1" },
113     { "239:100", "2.39:1" },
114     { "5:3", "5:3" },
115     { "4:3", "4:3" },
116     { "5:4", "5:4" },
117     { "1:1", "1:1" },
118     { NULL, NULL } };
119
120 static const struct
121 {
122     const char *psz_value;
123     const char *psz_label;
124 } p_aspect_ratio_values[] = {
125     { "", N_("Default") },
126     { "1:1", "1:1" },
127     { "4:3", "4:3" },
128     { "16:9", "16:9" },
129     { "16:10", "16:10" },
130     { "221:100", "2.21:1" },
131     { "235:100", "2.35:1" },
132     { "239:100", "2.39:1" },
133     { "5:4", "5:4" },
134     { NULL, NULL } };
135
136 static void AddCustomRatios( vout_thread_t *p_vout, const char *psz_var,
137                              char *psz_list )
138 {
139     assert( psz_list );
140
141     char *psz_cur = psz_list;
142     char *psz_next;
143     while( psz_cur && *psz_cur )
144     {
145         vlc_value_t val, text;
146         psz_next = strchr( psz_cur, ',' );
147         if( psz_next )
148         {
149             *psz_next = '\0';
150             psz_next++;
151         }
152         val.psz_string = psz_cur;
153         text.psz_string = psz_cur;
154         var_Change( p_vout, psz_var, VLC_VAR_ADDCHOICE, &val, &text);
155         psz_cur = psz_next;
156     }
157 }
158
159 void vout_IntfInit( vout_thread_t *p_vout )
160 {
161     vlc_value_t val, text, old_val;
162     bool b_force_par = false;
163     char *psz_buf;
164     int i;
165
166     /* Create a few object variables we'll need later on */
167     var_Create( p_vout, "snapshot-path", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
168     var_Create( p_vout, "snapshot-prefix", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
169     var_Create( p_vout, "snapshot-format", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
170     var_Create( p_vout, "snapshot-preview", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
171     var_Create( p_vout, "snapshot-sequential",
172                 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
173     var_Create( p_vout, "snapshot-num", VLC_VAR_INTEGER );
174     var_SetInteger( p_vout, "snapshot-num", 1 );
175     var_Create( p_vout, "snapshot-width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
176     var_Create( p_vout, "snapshot-height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
177
178     var_Create( p_vout, "width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
179     var_Create( p_vout, "height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
180     var_Create( p_vout, "align", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
181
182     var_Create( p_vout, "video-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
183     var_Create( p_vout, "video-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
184
185     var_Create( p_vout, "mouse-hide-timeout",
186                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
187
188     p_vout->p->title.show = var_CreateGetBool( p_vout, "video-title-show" );
189     p_vout->p->title.timeout = var_CreateGetInteger( p_vout,
190                                                      "video-title-timeout" );
191     p_vout->p->title.position = var_CreateGetInteger( p_vout,
192                                                       "video-title-position" );
193     var_AddCallback( p_vout, "video-title-show", TitleShowCallback, NULL );
194     var_AddCallback( p_vout, "video-title-timeout", TitleTimeoutCallback, NULL );
195     var_AddCallback( p_vout, "video-title-position", TitlePositionCallback, NULL );
196
197     /* Zoom object var */
198     var_Create( p_vout, "zoom", VLC_VAR_FLOAT | VLC_VAR_ISCOMMAND |
199                 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
200
201     text.psz_string = _("Zoom");
202     var_Change( p_vout, "zoom", VLC_VAR_SETTEXT, &text, NULL );
203
204     var_Get( p_vout, "zoom", &old_val );
205
206     for( i = 0; p_zoom_values[i].f_value; i++ )
207     {
208         if( old_val.f_float == p_zoom_values[i].f_value )
209             var_Change( p_vout, "zoom", VLC_VAR_DELCHOICE, &old_val, NULL );
210         val.f_float = p_zoom_values[i].f_value;
211         text.psz_string = _( p_zoom_values[i].psz_label );
212         var_Change( p_vout, "zoom", VLC_VAR_ADDCHOICE, &val, &text );
213     }
214
215     var_Set( p_vout, "zoom", old_val ); /* Is this really needed? */
216
217     var_AddCallback( p_vout, "zoom", ZoomCallback, NULL );
218
219     /* Crop offset vars */
220     var_Create( p_vout, "crop-left", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
221     var_Create( p_vout, "crop-top", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
222     var_Create( p_vout, "crop-right", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
223     var_Create( p_vout, "crop-bottom", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
224
225     var_AddCallback( p_vout, "crop-left", CropBorderCallback, NULL );
226     var_AddCallback( p_vout, "crop-top", CropBorderCallback, NULL );
227     var_AddCallback( p_vout, "crop-right", CropBorderCallback, NULL );
228     var_AddCallback( p_vout, "crop-bottom", CropBorderCallback, NULL );
229
230     /* Crop object var */
231     var_Create( p_vout, "crop", VLC_VAR_STRING | VLC_VAR_ISCOMMAND |
232                 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
233
234     text.psz_string = _("Crop");
235     var_Change( p_vout, "crop", VLC_VAR_SETTEXT, &text, NULL );
236
237     val.psz_string = (char*)"";
238     var_Change( p_vout, "crop", VLC_VAR_DELCHOICE, &val, 0 );
239
240     for( i = 0; p_crop_values[i].psz_value; i++ )
241     {
242         val.psz_string = (char*)p_crop_values[i].psz_value;
243         text.psz_string = _( p_crop_values[i].psz_label );
244         var_Change( p_vout, "crop", VLC_VAR_ADDCHOICE, &val, &text );
245     }
246
247     /* Add custom crop ratios */
248     psz_buf = var_CreateGetNonEmptyString( p_vout, "custom-crop-ratios" );
249     if( psz_buf )
250     {
251         AddCustomRatios( p_vout, "crop", psz_buf );
252         free( psz_buf );
253     }
254
255     var_AddCallback( p_vout, "crop", CropCallback, NULL );
256     var_Get( p_vout, "crop", &old_val );
257     if( old_val.psz_string && *old_val.psz_string )
258         var_TriggerCallback( p_vout, "crop" );
259     free( old_val.psz_string );
260
261     /* Monitor pixel aspect-ratio */
262     var_Create( p_vout, "monitor-par", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
263     var_Get( p_vout, "monitor-par", &val );
264     if( val.psz_string && *val.psz_string )
265     {
266         char *psz_parser = strchr( val.psz_string, ':' );
267         unsigned int i_aspect_num = 0, i_aspect_den = 0;
268         float i_aspect = 0;
269         if( psz_parser )
270         {
271             i_aspect_num = strtol( val.psz_string, 0, 10 );
272             i_aspect_den = strtol( ++psz_parser, 0, 10 );
273         }
274         else
275         {
276             i_aspect = us_atof( val.psz_string );
277             vlc_ureduce( &i_aspect_num, &i_aspect_den,
278                          i_aspect *VOUT_ASPECT_FACTOR, VOUT_ASPECT_FACTOR, 0 );
279         }
280         if( !i_aspect_num || !i_aspect_den ) i_aspect_num = i_aspect_den = 1;
281
282         p_vout->p->i_par_num = i_aspect_num;
283         p_vout->p->i_par_den = i_aspect_den;
284
285         vlc_ureduce( &p_vout->p->i_par_num, &p_vout->p->i_par_den,
286                      p_vout->p->i_par_num, p_vout->p->i_par_den, 0 );
287
288         msg_Dbg( p_vout, "overriding monitor pixel aspect-ratio: %i:%i",
289                  p_vout->p->i_par_num, p_vout->p->i_par_den );
290         b_force_par = true;
291     }
292     free( val.psz_string );
293
294     /* Aspect-ratio object var */
295     var_Create( p_vout, "aspect-ratio", VLC_VAR_STRING | VLC_VAR_ISCOMMAND |
296                 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT );
297
298     text.psz_string = _("Aspect-ratio");
299     var_Change( p_vout, "aspect-ratio", VLC_VAR_SETTEXT, &text, NULL );
300
301     val.psz_string = (char*)"";
302     var_Change( p_vout, "aspect-ratio", VLC_VAR_DELCHOICE, &val, 0 );
303
304     for( i = 0; p_aspect_ratio_values[i].psz_value; i++ )
305     {
306         val.psz_string = (char*)p_aspect_ratio_values[i].psz_value;
307         text.psz_string = _( p_aspect_ratio_values[i].psz_label );
308         var_Change( p_vout, "aspect-ratio", VLC_VAR_ADDCHOICE, &val, &text );
309     }
310
311     /* Add custom aspect ratios */
312     psz_buf = var_CreateGetNonEmptyString( p_vout, "custom-aspect-ratios" );
313     if( psz_buf )
314     {
315         AddCustomRatios( p_vout, "aspect-ratio", psz_buf );
316         free( psz_buf );
317     }
318
319     var_AddCallback( p_vout, "aspect-ratio", AspectCallback, NULL );
320     var_Get( p_vout, "aspect-ratio", &old_val );
321     if( (old_val.psz_string && *old_val.psz_string) || b_force_par )
322         var_TriggerCallback( p_vout, "aspect-ratio" );
323     free( old_val.psz_string );
324
325     /* Add variables to manage scaling video */
326     var_Create( p_vout, "autoscale", VLC_VAR_BOOL | VLC_VAR_DOINHERIT
327                 | VLC_VAR_ISCOMMAND );
328     text.psz_string = _("Autoscale video");
329     var_Change( p_vout, "autoscale", VLC_VAR_SETTEXT, &text, NULL );
330     var_AddCallback( p_vout, "autoscale", ScalingCallback, NULL );
331
332     var_Create( p_vout, "scale", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
333                 | VLC_VAR_ISCOMMAND );
334     text.psz_string = _("Scale factor");
335     var_Change( p_vout, "scale", VLC_VAR_SETTEXT, &text, NULL );
336     var_AddCallback( p_vout, "scale", ScalingCallback, NULL );
337
338     /* Add a variable to indicate if the window should be on top of others */
339     var_Create( p_vout, "video-on-top", VLC_VAR_BOOL | VLC_VAR_DOINHERIT
340                 | VLC_VAR_ISCOMMAND );
341     text.psz_string = _("Always on top");
342     var_Change( p_vout, "video-on-top", VLC_VAR_SETTEXT, &text, NULL );
343     var_AddCallback( p_vout, "video-on-top", OnTopCallback, NULL );
344     var_TriggerCallback( p_vout, "video-on-top" );
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     var_Create( p_vout, "fullscreen",
351                 VLC_VAR_BOOL | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
352     text.psz_string = _("Fullscreen");
353     var_Change( p_vout, "fullscreen", VLC_VAR_SETTEXT, &text, NULL );
354     var_AddCallback( p_vout, "fullscreen", FullscreenCallback, NULL );
355
356     /* Add a snapshot variable */
357     var_Create( p_vout, "video-snapshot", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
358     text.psz_string = _("Snapshot");
359     var_Change( p_vout, "video-snapshot", VLC_VAR_SETTEXT, &text, NULL );
360     var_AddCallback( p_vout, "video-snapshot", SnapshotCallback, NULL );
361
362     /* Add a video-filter variable */
363     var_Create( p_vout, "video-filter",
364                 VLC_VAR_STRING | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
365     var_AddCallback( p_vout, "video-filter", VideoFilterCallback, NULL );
366     var_TriggerCallback( p_vout, "video-filter" );
367
368     /* Add a video-splitter variable
369      * TODO rename vout-filter into vout-splitter */
370     var_Create( p_vout, "vout-filter",
371                 VLC_VAR_STRING | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
372     text.psz_string = _("Video splitter");
373     var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
374     var_AddCallback( p_vout, "vout-filter", VideoSplitterCallback, NULL );
375
376     /* Add a sub-filter variable */
377     var_Create( p_vout, "sub-filter",
378                 VLC_VAR_STRING | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
379     var_AddCallback( p_vout, "sub-filter", SubFilterCallback, NULL );
380     var_TriggerCallback( p_vout, "sub-filter" );
381
382     /* Add sub-margin variable */
383     var_Create( p_vout, "sub-margin",
384                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
385     var_AddCallback( p_vout, "sub-margin", SubMarginCallback, NULL );
386     var_TriggerCallback( p_vout, "sub-margin" );
387
388     /* Mouse coordinates */
389     var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
390     var_Create( p_vout, "mouse-moved", VLC_VAR_COORDS );
391     var_Create( p_vout, "mouse-clicked", VLC_VAR_COORDS );
392     var_Create( p_vout, "mouse-object", VLC_VAR_BOOL );
393 }
394
395 /*****************************************************************************
396  * vout_Snapshot: generates a snapshot.
397  *****************************************************************************/
398 /**
399  * This function will inject a subpicture into the vout with the provided
400  * picture
401  */
402 static int VoutSnapshotPip( vout_thread_t *p_vout, picture_t *p_pic )
403 {
404     subpicture_t *p_subpic = subpicture_NewFromPicture( VLC_OBJECT(p_vout),
405                                                         p_pic, VLC_CODEC_YUVA );
406     if( !p_subpic )
407         return VLC_EGENERIC;
408
409     /* FIXME SPU_DEFAULT_CHANNEL is not good (used by the text) but
410      * hardcoded 0 doesn't seem right */
411     p_subpic->i_channel = 0;
412     p_subpic->i_start = mdate();
413     p_subpic->i_stop  = p_subpic->i_start + 4000000;
414     p_subpic->b_ephemer = true;
415     p_subpic->b_fade = true;
416
417     /* Reduce the picture to 1/4^2 of the screen */
418     p_subpic->i_original_picture_width  *= 4;
419     p_subpic->i_original_picture_height *= 4;
420
421     vout_PutSubpicture( p_vout, p_subpic );
422     return VLC_SUCCESS;
423 }
424
425 /**
426  * This function will display the name and a PIP of the provided snapshot
427  */
428 static void VoutOsdSnapshot( vout_thread_t *p_vout, picture_t *p_pic, const char *psz_filename )
429 {
430     msg_Dbg( p_vout, "snapshot taken (%s)", psz_filename );
431     vout_OSDMessage( p_vout, SPU_DEFAULT_CHANNEL, "%s", psz_filename );
432
433     if( var_GetBool( p_vout, "snapshot-preview" ) )
434     {
435         if( VoutSnapshotPip( p_vout, p_pic ) )
436             msg_Warn( p_vout, "Failed to display snapshot" );
437     }
438 }
439
440 /* */
441 int vout_GetSnapshot( vout_thread_t *p_vout,
442                       block_t **pp_image, picture_t **pp_picture,
443                       video_format_t *p_fmt,
444                       const char *psz_format, mtime_t i_timeout )
445 {
446     picture_t *p_picture = vout_snapshot_Get( &p_vout->p->snapshot, i_timeout );
447     if( !p_picture )
448     {
449         msg_Err( p_vout, "Failed to grab a snapshot" );
450         return VLC_EGENERIC;
451     }
452
453     if( pp_image )
454     {
455         vlc_fourcc_t i_format = VLC_CODEC_PNG;
456         if( psz_format && image_Type2Fourcc( psz_format ) )
457             i_format = image_Type2Fourcc( psz_format );
458
459         const int i_override_width  = var_GetInteger( p_vout, "snapshot-width" );
460         const int i_override_height = var_GetInteger( p_vout, "snapshot-height" );
461
462         if( picture_Export( VLC_OBJECT(p_vout), pp_image, p_fmt,
463                             p_picture, i_format, i_override_width, i_override_height ) )
464         {
465             msg_Err( p_vout, "Failed to convert image for snapshot" );
466             picture_Release( p_picture );
467             return VLC_EGENERIC;
468         }
469     }
470     if( pp_picture )
471         *pp_picture = p_picture;
472     else
473         picture_Release( p_picture );
474     return VLC_SUCCESS;
475 }
476
477 /**
478  * This function will handle a snapshot request
479  */
480 static void VoutSaveSnapshot( vout_thread_t *p_vout )
481 {
482     char *psz_path = var_GetNonEmptyString( p_vout, "snapshot-path" );
483     char *psz_format = var_GetNonEmptyString( p_vout, "snapshot-format" );
484     char *psz_prefix = var_GetNonEmptyString( p_vout, "snapshot-prefix" );
485
486     /* */
487     picture_t *p_picture;
488     block_t *p_image;
489     video_format_t fmt;
490
491     /* 500ms timeout
492      * XXX it will cause trouble with low fps video (< 2fps) */
493     if( vout_GetSnapshot( p_vout, &p_image, &p_picture, &fmt, psz_format, 500*1000 ) )
494     {
495         p_picture = NULL;
496         p_image = NULL;
497         goto exit;
498     }
499
500     if( !psz_path )
501     {
502         psz_path = vout_snapshot_GetDirectory();
503         if( !psz_path )
504         {
505             msg_Err( p_vout, "no path specified for snapshots" );
506             goto exit;
507         }
508     }
509
510     vout_snapshot_save_cfg_t cfg;
511     memset( &cfg, 0, sizeof(cfg) );
512     cfg.is_sequential = var_GetBool( p_vout, "snapshot-sequential" );
513     cfg.sequence = var_GetInteger( p_vout, "snapshot-num" );
514     cfg.path = psz_path;
515     cfg.format = psz_format;
516     cfg.prefix_fmt = psz_prefix;
517
518     char *psz_filename;
519     int  i_sequence;
520     if (vout_snapshot_SaveImage( &psz_filename, &i_sequence,
521                                  p_image, VLC_OBJECT(p_vout), &cfg ) )
522         goto exit;
523     if( cfg.is_sequential )
524         var_SetInteger( p_vout, "snapshot-num", i_sequence + 1 );
525
526     VoutOsdSnapshot( p_vout, p_picture, psz_filename );
527
528     /* signal creation of a new snapshot file */
529     var_SetString( p_vout->p_libvlc, "snapshot-file", psz_filename );
530
531     free( psz_filename );
532
533 exit:
534     if( p_image )
535         block_Release( p_image );
536     if( p_picture )
537         picture_Release( p_picture );
538     free( psz_prefix );
539     free( psz_format );
540     free( psz_path );
541 }
542
543 /*****************************************************************************
544  * Handle filters
545  *****************************************************************************/
546
547 void vout_EnableFilter( vout_thread_t *p_vout, const char *psz_name,
548                         bool b_add, bool b_setconfig )
549 {
550     char *psz_parser;
551     char *psz_string;
552     const char *psz_filter_type;
553
554     /* FIXME temporary hack */
555     const char *psz_module_name = psz_name;
556     if( !strcmp( psz_name, "magnify" ) ||
557         !strcmp( psz_name, "puzzle" ) ||
558         !strcmp( psz_name, "logo" ) ||
559         !strcmp( psz_name, "wall" ) ||
560         !strcmp( psz_name, "clone" ) )
561         psz_module_name = "video_filter_wrapper";
562
563     module_t *p_obj = module_find( psz_module_name );
564     if( !p_obj )
565     {
566         msg_Err( p_vout, "Unable to find filter module \"%s\".", psz_name );
567         return;
568     }
569
570     if( module_provides( p_obj, "video filter" ) )
571     {
572         psz_filter_type = "vout-filter";
573     }
574     else if( module_provides( p_obj, "video filter2" ) )
575     {
576         psz_filter_type = "video-filter";
577     }
578     else if( module_provides( p_obj, "sub filter" ) )
579     {
580         psz_filter_type = "sub-filter";
581     }
582     else
583     {
584         module_release( p_obj );
585         msg_Err( p_vout, "Unknown video filter type." );
586         return;
587     }
588     module_release( p_obj );
589
590     psz_string = var_GetString( p_vout, psz_filter_type );
591
592     /* Todo : Use some generic chain manipulation functions */
593     if( !psz_string ) psz_string = strdup("");
594
595     psz_parser = strstr( psz_string, psz_name );
596     if( b_add )
597     {
598         if( !psz_parser )
599         {
600             psz_parser = psz_string;
601             if( asprintf( &psz_string, (*psz_string) ? "%s:%s" : "%s%s",
602                           psz_string, psz_name ) == -1 )
603             {
604                 free( psz_parser );
605                 return;
606             }
607             free( psz_parser );
608         }
609         else
610             return;
611     }
612     else
613     {
614         if( psz_parser )
615         {
616             memmove( psz_parser, psz_parser + strlen(psz_name) +
617                             (*(psz_parser + strlen(psz_name)) == ':' ? 1 : 0 ),
618                             strlen(psz_parser + strlen(psz_name)) + 1 );
619
620             /* Remove trailing : : */
621             if( *(psz_string+strlen(psz_string ) -1 ) == ':' )
622             {
623                 *(psz_string+strlen(psz_string ) -1 ) = '\0';
624             }
625          }
626          else
627          {
628              free( psz_string );
629              return;
630          }
631     }
632
633     if( b_setconfig )
634     {
635         config_PutPsz( p_vout, psz_filter_type, psz_string );
636     }
637
638     var_SetString( p_vout, psz_filter_type, psz_string );
639
640     free( psz_string );
641 }
642
643 /*****************************************************************************
644  * Object variables callbacks
645  *****************************************************************************/
646 static int ZoomCallback( vlc_object_t *p_this, char const *psz_cmd,
647                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
648 {
649     (void)psz_cmd; (void)oldval; (void)p_data;
650
651     return var_SetFloat( p_this, "scale", newval.f_float );
652 }
653
654 static int CropCallback( vlc_object_t *object, char const *cmd,
655                          vlc_value_t oldval, vlc_value_t newval, void *data )
656 {
657     vout_thread_t *vout = (vout_thread_t *)object;
658     VLC_UNUSED(cmd); VLC_UNUSED(oldval); VLC_UNUSED(data);
659     unsigned num, den;
660     unsigned y, x;
661     unsigned width, height;
662     unsigned left, top, right, bottom;
663
664     if (sscanf(newval.psz_string, "%u:%u", &num, &den) == 2) {
665         vout_ControlChangeCropRatio(vout, num, den);
666     } else if (sscanf(newval.psz_string, "%ux%u+%u+%u",
667                       &width, &height, &x, &y) == 4) {
668         vout_ControlChangeCropWindow(vout, x, y, width, height);
669     } else if (sscanf(newval.psz_string, "%u+%u+%u+%u",
670                     &left, &top, &right, &bottom) == 4) {
671         vout_ControlChangeCropBorder(vout, left, top, right, bottom);
672     } else if (*newval.psz_string == '\0') {
673         vout_ControlChangeCropRatio(vout, 0, 0);
674     } else {
675         msg_Err(object, "Unknown crop format (%s)", newval.psz_string);
676     }
677     return VLC_SUCCESS;
678 }
679
680 static int CropBorderCallback(vlc_object_t *object, char const *cmd,
681                               vlc_value_t oldval, vlc_value_t newval, void *data)
682 {
683     vout_thread_t *vout = (vout_thread_t *)object;
684     VLC_UNUSED(cmd); VLC_UNUSED(oldval); VLC_UNUSED(data); VLC_UNUSED(newval);
685
686     vout_ControlChangeCropBorder(vout,
687                                  var_GetInteger(object, "crop-left"),
688                                  var_GetInteger(object, "crop-top"),
689                                  var_GetInteger(object, "crop-right"),
690                                  var_GetInteger(object, "crop-bottom"));
691     return VLC_SUCCESS;
692 }
693
694 static int AspectCallback( vlc_object_t *object, char const *cmd,
695                          vlc_value_t oldval, vlc_value_t newval, void *data )
696 {
697     vout_thread_t *vout = (vout_thread_t *)object;
698     VLC_UNUSED(cmd); VLC_UNUSED(oldval); VLC_UNUSED(data);
699     unsigned num, den;
700
701     if (sscanf(newval.psz_string, "%u:%u", &num, &den) == 2 &&
702         (num > 0) == (den > 0))
703         vout_ControlChangeSampleAspectRatio(vout, num, den);
704     else if (*newval.psz_string == '\0')
705         vout_ControlChangeSampleAspectRatio(vout, 0, 0);
706     return VLC_SUCCESS;
707 }
708
709 static int ScalingCallback( vlc_object_t *p_this, char const *psz_cmd,
710                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
711 {
712     vout_thread_t *p_vout = (vout_thread_t *)p_this;
713     (void)oldval; (void)newval; (void)p_data;
714
715     if( !strcmp( psz_cmd, "autoscale" ) )
716         vout_ControlChangeDisplayFilled( p_vout, newval.b_bool );
717     else if( !strcmp( psz_cmd, "scale" ) )
718         vout_ControlChangeZoom( p_vout, 1000 * newval.f_float, 1000 );
719
720     return VLC_SUCCESS;
721 }
722
723 static int OnTopCallback( vlc_object_t *p_this, char const *psz_cmd,
724                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
725 {
726     vout_thread_t *p_vout = (vout_thread_t *)p_this;
727     (void)psz_cmd; (void)oldval; (void)p_data;
728
729     vout_ControlChangeOnTop( p_vout, newval.b_bool );
730     return VLC_SUCCESS;
731 }
732
733 static int FullscreenCallback( vlc_object_t *p_this, char const *psz_cmd,
734                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
735 {
736     vout_thread_t *p_vout = (vout_thread_t *)p_this;
737     (void)psz_cmd; (void)p_data;
738
739     if( oldval.b_bool != newval.b_bool )
740         vout_ControlChangeFullscreen( p_vout, newval.b_bool );
741     return VLC_SUCCESS;
742 }
743
744 static int SnapshotCallback( vlc_object_t *p_this, char const *psz_cmd,
745                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
746 {
747     vout_thread_t *p_vout = (vout_thread_t *)p_this;
748     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
749     VLC_UNUSED(newval); VLC_UNUSED(p_data);
750
751     VoutSaveSnapshot( p_vout );
752     return VLC_SUCCESS;
753 }
754
755 static int VideoFilterCallback( vlc_object_t *p_this, char const *psz_cmd,
756                                 vlc_value_t oldval, vlc_value_t newval, void *p_data)
757 {
758     vout_thread_t *p_vout = (vout_thread_t *)p_this;
759     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
760
761     vout_ControlChangeFilters( p_vout, newval.psz_string );
762     return VLC_SUCCESS;
763 }
764
765 static int VideoSplitterCallback( vlc_object_t *p_this, char const *psz_cmd,
766                                   vlc_value_t oldval, vlc_value_t newval, void *p_data )
767 {
768     vout_thread_t *p_vout = (vout_thread_t *)p_this;
769     input_thread_t *p_input;
770     (void)psz_cmd; (void)oldval; (void)p_data;
771
772     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
773                                                  FIND_PARENT );
774     if (!p_input)
775     {
776         msg_Err( p_vout, "Input not found" );
777         return VLC_EGENERIC;
778     }
779
780     /* Modify input as well because the vout might have to be restarted */
781     var_Create( p_input, "vout-filter", VLC_VAR_STRING );
782     var_SetString( p_input, "vout-filter", newval.psz_string );
783
784     /* Now restart current video stream */
785     input_Control( p_input, INPUT_RESTART_ES, -VIDEO_ES );
786     vlc_object_release( p_input );
787
788     return VLC_SUCCESS;
789 }
790
791 static int SubFilterCallback( vlc_object_t *p_this, char const *psz_cmd,
792                               vlc_value_t oldval, vlc_value_t newval, void *p_data)
793 {
794     vout_thread_t *p_vout = (vout_thread_t *)p_this;
795     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
796
797     vout_ControlChangeSubFilters( p_vout, newval.psz_string );
798     return VLC_SUCCESS;
799 }
800
801 static int SubMarginCallback( vlc_object_t *p_this, char const *psz_cmd,
802                               vlc_value_t oldval, vlc_value_t newval, void *p_data)
803 {
804     vout_thread_t *p_vout = (vout_thread_t *)p_this;
805     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
806
807     vout_ControlChangeSubMargin( p_vout, newval.i_int );
808     return VLC_SUCCESS;
809 }
810
811 static int TitleShowCallback( vlc_object_t *p_this, char const *psz_cmd,
812                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
813 {
814     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
815     VLC_UNUSED(p_data);
816     vout_thread_t *p_vout = (vout_thread_t *)p_this;
817     p_vout->p->title.show = newval.b_bool;
818     return VLC_SUCCESS;
819 }
820
821 static int TitleTimeoutCallback( vlc_object_t *p_this, char const *psz_cmd,
822                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
823 {
824     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
825     vout_thread_t *p_vout = (vout_thread_t *)p_this;
826     p_vout->p->title.timeout = (mtime_t) newval.i_int;
827     return VLC_SUCCESS;
828 }
829
830 static int TitlePositionCallback( vlc_object_t *p_this, char const *psz_cmd,
831                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
832 {
833     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
834     VLC_UNUSED(p_data);
835     vout_thread_t *p_vout = (vout_thread_t *)p_this;
836     p_vout->p->title.position = newval.i_int;
837     return VLC_SUCCESS;
838 }