Fix a bug with preferences
[vlc.git] / modules / video_filter / transform.c
1 /*****************************************************************************
2  * transform.c : transform image module for vlc
3  *****************************************************************************
4  * Copyright (C) 2000-2004 VideoLAN
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                                      /* malloc(), free() */
28 #include <string.h>
29
30 #include <vlc/vlc.h>
31 #include <vlc/vout.h>
32
33 #include "filter_common.h"
34
35 #define TRANSFORM_MODE_HFLIP   1
36 #define TRANSFORM_MODE_VFLIP   2
37 #define TRANSFORM_MODE_90      3
38 #define TRANSFORM_MODE_180     4
39 #define TRANSFORM_MODE_270     5
40
41 /*****************************************************************************
42  * Local prototypes
43  *****************************************************************************/
44 static int  Create    ( vlc_object_t * );
45 static void Destroy   ( vlc_object_t * );
46
47 static int  Init      ( vout_thread_t * );
48 static void End       ( vout_thread_t * );
49 static void Render    ( vout_thread_t *, picture_t * );
50
51 static int  SendEvents( vlc_object_t *, char const *,
52                         vlc_value_t, vlc_value_t, void * );
53
54 /*****************************************************************************
55  * Module descriptor
56  *****************************************************************************/
57 #define TYPE_TEXT N_("Transform type")
58 #define TYPE_LONGTEXT N_("One of '90', '180', '270', 'hflip' and 'vflip'")
59
60 static char *type_list[] = { "90", "180", "270", "hflip", "vflip" };
61 static char *type_list_text[] = { N_("Rotate by 90 degrees"),
62   N_("Rotate by 180 degrees"), N_("Rotate by 270 degrees"),
63   N_("Flip horizontally"), N_("Flip vertically") };
64
65 vlc_module_begin();
66     set_description( _("Video transformation filter") );
67     set_shortname( N_("Transformation"));
68     set_capability( "video filter", 0 );
69     set_category( CAT_VIDEO );
70     set_subcategory( SUBCAT_VIDEO_VFILTER );
71
72     add_string( "transform-type", "90", NULL,
73                           TYPE_TEXT, TYPE_LONGTEXT, VLC_FALSE);
74         change_string_list( type_list, type_list_text, 0);
75
76     add_shortcut( "transform" );
77     set_callbacks( Create, Destroy );
78 vlc_module_end();
79
80 /*****************************************************************************
81  * vout_sys_t: Transform video output method descriptor
82  *****************************************************************************
83  * This structure is part of the video output thread descriptor.
84  * It describes the Transform specific properties of an output thread.
85  *****************************************************************************/
86 struct vout_sys_t
87 {
88     int i_mode;
89     vlc_bool_t b_rotation;
90     vout_thread_t *p_vout;
91 };
92
93 /*****************************************************************************
94  * Control: control facility for the vout (forwards to child vout)
95  *****************************************************************************/
96 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
97 {
98     return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
99 }
100
101 /*****************************************************************************
102  * Create: allocates Transform video thread output method
103  *****************************************************************************
104  * This function allocates and initializes a Transform vout method.
105  *****************************************************************************/
106 static int Create( vlc_object_t *p_this )
107 {
108     vout_thread_t *p_vout = (vout_thread_t *)p_this;
109     char *psz_method;
110
111     /* Allocate structure */
112     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
113     if( p_vout->p_sys == NULL )
114     {
115         msg_Err( p_vout, "out of memory" );
116         return VLC_ENOMEM;
117     }
118
119     p_vout->pf_init = Init;
120     p_vout->pf_end = End;
121     p_vout->pf_manage = NULL;
122     p_vout->pf_render = Render;
123     p_vout->pf_display = NULL;
124     p_vout->pf_control = Control;
125
126     /* Look what method was requested */
127     psz_method = config_GetPsz( p_vout, "transform-type" );
128
129     if( psz_method == NULL )
130     {
131         msg_Err( p_vout, "configuration variable %s empty", "transform-type" );
132         msg_Err( p_vout, "no valid transform mode provided, using '90'" );
133         p_vout->p_sys->i_mode = TRANSFORM_MODE_90;
134         p_vout->p_sys->b_rotation = 1;
135     }
136     else
137     {
138         if( !strcmp( psz_method, "hflip" ) )
139         {
140             p_vout->p_sys->i_mode = TRANSFORM_MODE_HFLIP;
141             p_vout->p_sys->b_rotation = 0;
142         }
143         else if( !strcmp( psz_method, "vflip" ) )
144         {
145             p_vout->p_sys->i_mode = TRANSFORM_MODE_VFLIP;
146             p_vout->p_sys->b_rotation = 0;
147         }
148         else if( !strcmp( psz_method, "90" ) )
149         {
150             p_vout->p_sys->i_mode = TRANSFORM_MODE_90;
151             p_vout->p_sys->b_rotation = 1;
152         }
153         else if( !strcmp( psz_method, "180" ) )
154         {
155             p_vout->p_sys->i_mode = TRANSFORM_MODE_180;
156             p_vout->p_sys->b_rotation = 0;
157         }
158         else if( !strcmp( psz_method, "270" ) )
159         {
160             p_vout->p_sys->i_mode = TRANSFORM_MODE_270;
161             p_vout->p_sys->b_rotation = 1;
162         }
163         else
164         {
165             msg_Err( p_vout, "no valid transform mode provided, using '90'" );
166             p_vout->p_sys->i_mode = TRANSFORM_MODE_90;
167             p_vout->p_sys->b_rotation = 1;
168         }
169
170         free( psz_method );
171     }
172
173     return VLC_SUCCESS;
174 }
175
176 /*****************************************************************************
177  * Init: initialize Transform video thread output method
178  *****************************************************************************/
179 static int Init( vout_thread_t *p_vout )
180 {
181     int i_index;
182     picture_t *p_pic;
183
184     I_OUTPUTPICTURES = 0;
185
186     /* Initialize the output structure */
187     p_vout->output.i_chroma = p_vout->render.i_chroma;
188     p_vout->output.i_width  = p_vout->render.i_width;
189     p_vout->output.i_height = p_vout->render.i_height;
190     p_vout->output.i_aspect = p_vout->render.i_aspect;
191
192     /* Try to open the real video output */
193     msg_Dbg( p_vout, "spawning the real video output" );
194
195     if( p_vout->p_sys->b_rotation )
196     {
197         p_vout->p_sys->p_vout = vout_Create( p_vout,
198                            p_vout->render.i_height, p_vout->render.i_width,
199                            p_vout->render.i_chroma,
200                            (uint64_t)VOUT_ASPECT_FACTOR
201                             * (uint64_t)VOUT_ASPECT_FACTOR
202                             / (uint64_t)p_vout->render.i_aspect );
203     }
204     else
205     {
206         p_vout->p_sys->p_vout = vout_Create( p_vout,
207                            p_vout->render.i_width, p_vout->render.i_height,
208                            p_vout->render.i_chroma, p_vout->render.i_aspect );
209     }
210
211     /* Everything failed */
212     if( p_vout->p_sys->p_vout == NULL )
213     {
214         msg_Err( p_vout, "cannot open vout, aborting" );
215         return VLC_EGENERIC;
216     }
217
218     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
219
220     ADD_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
221
222     ADD_PARENT_CALLBACKS( SendEventsToChild );
223
224     return VLC_SUCCESS;
225 }
226
227 /*****************************************************************************
228  * End: terminate Transform video thread output method
229  *****************************************************************************/
230 static void End( vout_thread_t *p_vout )
231 {
232     int i_index;
233
234     /* Free the fake output buffers we allocated */
235     for( i_index = I_OUTPUTPICTURES ; i_index ; )
236     {
237         i_index--;
238         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
239     }
240 }
241
242 /*****************************************************************************
243  * Destroy: destroy Transform video thread output method
244  *****************************************************************************
245  * Terminate an output method created by TransformCreateOutputMethod
246  *****************************************************************************/
247 static void Destroy( vlc_object_t *p_this )
248 {
249     vout_thread_t *p_vout = (vout_thread_t *)p_this;
250
251     if( p_vout->p_sys->p_vout )
252     {
253         DEL_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
254         vlc_object_detach( p_vout->p_sys->p_vout );
255         vout_Destroy( p_vout->p_sys->p_vout );
256     }
257
258     DEL_PARENT_CALLBACKS( SendEventsToChild );
259
260     free( p_vout->p_sys );
261 }
262
263 /*****************************************************************************
264  * Render: displays previously rendered output
265  *****************************************************************************
266  * This function send the currently rendered image to Transform image, waits
267  * until it is displayed and switch the two rendering buffers, preparing next
268  * frame.
269  *****************************************************************************/
270 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
271 {
272     picture_t *p_outpic;
273     int i_index;
274
275     /* This is a new frame. Get a structure from the video_output. */
276     while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
277               == NULL )
278     {
279         if( p_vout->b_die || p_vout->b_error )
280         {
281             return;
282         }
283         msleep( VOUT_OUTMEM_SLEEP );
284     }
285
286     vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
287     vout_LinkPicture( p_vout->p_sys->p_vout, p_outpic );
288
289     switch( p_vout->p_sys->i_mode )
290     {
291         case TRANSFORM_MODE_90:
292             for( i_index = 0 ; i_index < p_pic->i_planes ; i_index++ )
293             {
294                 int i_pitch = p_pic->p[i_index].i_pitch;
295
296                 uint8_t *p_in = p_pic->p[i_index].p_pixels;
297
298                 uint8_t *p_out = p_outpic->p[i_index].p_pixels;
299                 uint8_t *p_out_end = p_out +
300                     p_outpic->p[i_index].i_visible_lines *
301                     p_outpic->p[i_index].i_pitch;
302
303                 for( ; p_out < p_out_end ; )
304                 {
305                     uint8_t *p_line_end;
306
307                     p_out_end -= p_outpic->p[i_index].i_pitch
308                                   - p_outpic->p[i_index].i_visible_pitch;
309                     p_line_end = p_in + p_pic->p[i_index].i_visible_lines *
310                         i_pitch;
311
312                     for( ; p_in < p_line_end ; )
313                     {
314                         p_line_end -= i_pitch;
315                         *(--p_out_end) = *p_line_end;
316                     }
317
318                     p_in++;
319                 }
320             }
321             break;
322
323         case TRANSFORM_MODE_180:
324             for( i_index = 0 ; i_index < p_pic->i_planes ; i_index++ )
325             {
326                 uint8_t *p_in = p_pic->p[i_index].p_pixels;
327                 uint8_t *p_in_end = p_in + p_pic->p[i_index].i_visible_lines
328                                             * p_pic->p[i_index].i_pitch;
329
330                 uint8_t *p_out = p_outpic->p[i_index].p_pixels;
331
332                 for( ; p_in < p_in_end ; )
333                 {
334                     uint8_t *p_line_start = p_in_end
335                                              - p_pic->p[i_index].i_pitch;
336                     p_in_end -= p_pic->p[i_index].i_pitch
337                                  - p_pic->p[i_index].i_visible_pitch;
338
339                     for( ; p_line_start < p_in_end ; )
340                     {
341                         *p_out++ = *(--p_in_end);
342                     }
343
344                     p_out += p_outpic->p[i_index].i_pitch
345                               - p_outpic->p[i_index].i_visible_pitch;
346                 }
347             }
348             break;
349
350         case TRANSFORM_MODE_270:
351             for( i_index = 0 ; i_index < p_pic->i_planes ; i_index++ )
352             {
353                 int i_pitch = p_pic->p[i_index].i_pitch;
354
355                 uint8_t *p_in = p_pic->p[i_index].p_pixels;
356
357                 uint8_t *p_out = p_outpic->p[i_index].p_pixels;
358                 uint8_t *p_out_end = p_out +
359                     p_outpic->p[i_index].i_visible_lines *
360                     p_outpic->p[i_index].i_pitch;
361
362                 for( ; p_out < p_out_end ; )
363                 {
364                     uint8_t *p_in_end;
365
366                     p_in_end = p_in + p_pic->p[i_index].i_visible_lines *
367                         i_pitch;
368
369                     for( ; p_in < p_in_end ; )
370                     {
371                         p_in_end -= i_pitch;
372                         *p_out++ = *p_in_end;
373                     }
374
375                     p_out += p_outpic->p[i_index].i_pitch
376                               - p_outpic->p[i_index].i_visible_pitch;
377                     p_in++;
378                 }
379             }
380             break;
381
382         case TRANSFORM_MODE_HFLIP:
383             for( i_index = 0 ; i_index < p_pic->i_planes ; i_index++ )
384             {
385                 uint8_t *p_in = p_pic->p[i_index].p_pixels;
386                 uint8_t *p_in_end = p_in + p_pic->p[i_index].i_visible_lines
387                                             * p_pic->p[i_index].i_pitch;
388
389                 uint8_t *p_out = p_outpic->p[i_index].p_pixels;
390
391                 for( ; p_in < p_in_end ; )
392                 {
393                     p_in_end -= p_pic->p[i_index].i_pitch;
394                     p_vout->p_vlc->pf_memcpy( p_out, p_in_end,
395                                            p_pic->p[i_index].i_visible_pitch );
396                     p_out += p_pic->p[i_index].i_pitch;
397                 }
398             }
399             break;
400
401         case TRANSFORM_MODE_VFLIP:
402             for( i_index = 0 ; i_index < p_pic->i_planes ; i_index++ )
403             {
404                 uint8_t *p_in = p_pic->p[i_index].p_pixels;
405                 uint8_t *p_in_end = p_in + p_pic->p[i_index].i_visible_lines
406                                             * p_pic->p[i_index].i_pitch;
407
408                 uint8_t *p_out = p_outpic->p[i_index].p_pixels;
409
410                 for( ; p_in < p_in_end ; )
411                 {
412                     uint8_t *p_line_end = p_in
413                                            + p_pic->p[i_index].i_visible_pitch;
414
415                     for( ; p_in < p_line_end ; )
416                     {
417                         *p_out++ = *(--p_line_end);
418                     }
419
420                     p_in += p_pic->p[i_index].i_pitch;
421                 }
422             }
423             break;
424
425         default:
426             break;
427     }
428
429     vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
430
431     vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
432 }
433
434 /*****************************************************************************
435  * SendEvents: forward mouse and keyboard events to the parent p_vout
436  *****************************************************************************/
437 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
438                        vlc_value_t oldval, vlc_value_t newval, void *_p_vout )
439 {
440     vout_thread_t *p_vout = (vout_thread_t *)_p_vout;
441     vlc_value_t sentval = newval;
442
443     /* Translate the mouse coordinates */
444     if( !strcmp( psz_var, "mouse-x" ) )
445     {
446         switch( p_vout->p_sys->i_mode )
447         {
448         case TRANSFORM_MODE_270:
449             sentval.i_int = p_vout->p_sys->p_vout->output.i_width
450                              - sentval.i_int;
451         case TRANSFORM_MODE_90:
452             var_Set( p_vout, "mouse-y", sentval );
453             return VLC_SUCCESS;
454
455         case TRANSFORM_MODE_180:
456         case TRANSFORM_MODE_HFLIP:
457             sentval.i_int = p_vout->p_sys->p_vout->output.i_width
458                              - sentval.i_int;
459             break;
460
461         case TRANSFORM_MODE_VFLIP:
462         default:
463             break;
464         }
465     }
466     else if( !strcmp( psz_var, "mouse-y" ) )
467     {
468         switch( p_vout->p_sys->i_mode )
469         {
470         case TRANSFORM_MODE_90:
471             sentval.i_int = p_vout->p_sys->p_vout->output.i_height
472                              - sentval.i_int;
473         case TRANSFORM_MODE_270:
474             var_Set( p_vout, "mouse-x", sentval );
475             return VLC_SUCCESS;
476
477         case TRANSFORM_MODE_180:
478         case TRANSFORM_MODE_VFLIP:
479             sentval.i_int = p_vout->p_sys->p_vout->output.i_height
480                              - sentval.i_int;
481             break;
482
483         case TRANSFORM_MODE_HFLIP:
484         default:
485             break;
486         }
487     }
488
489     var_Set( p_vout, psz_var, sentval );
490
491     return VLC_SUCCESS;
492 }
493
494 /*****************************************************************************
495  * SendEventsToChild: forward events to the child/children vout
496  *****************************************************************************/
497 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
498                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
499 {
500     vout_thread_t *p_vout = (vout_thread_t *)p_this;
501     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
502     return VLC_SUCCESS;
503 }