forward port [17012] and make update-po
[vlc.git] / modules / video_filter / transform.c
1 /*****************************************************************************
2  * transform.c : transform image module for vlc
3  *****************************************************************************
4  * Copyright (C) 2000-2004 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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( _("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     video_format_t fmt = {0};
184
185     I_OUTPUTPICTURES = 0;
186
187     /* Initialize the output structure */
188     p_vout->output.i_chroma = p_vout->render.i_chroma;
189     p_vout->output.i_width  = p_vout->render.i_width;
190     p_vout->output.i_height = p_vout->render.i_height;
191     p_vout->output.i_aspect = p_vout->render.i_aspect;
192     p_vout->fmt_out = p_vout->fmt_in;
193     fmt = p_vout->fmt_out;
194
195     /* Try to open the real video output */
196     msg_Dbg( p_vout, "spawning the real video output" );
197
198     if( p_vout->p_sys->b_rotation )
199     {
200         fmt.i_width = p_vout->fmt_out.i_height;
201         fmt.i_visible_width = p_vout->fmt_out.i_visible_height;
202         fmt.i_x_offset = p_vout->fmt_out.i_y_offset;
203
204         fmt.i_height = p_vout->fmt_out.i_width;
205         fmt.i_visible_height = p_vout->fmt_out.i_visible_width;
206         fmt.i_y_offset = p_vout->fmt_out.i_x_offset;
207
208         fmt.i_aspect = VOUT_ASPECT_FACTOR *
209             (uint64_t)VOUT_ASPECT_FACTOR / fmt.i_aspect;
210
211         fmt.i_sar_num = p_vout->fmt_out.i_sar_den;
212         fmt.i_sar_den = p_vout->fmt_out.i_sar_num;
213     }
214
215     p_vout->p_sys->p_vout = vout_Create( p_vout, &fmt );
216
217     /* Everything failed */
218     if( p_vout->p_sys->p_vout == NULL )
219     {
220         msg_Err( p_vout, "cannot open vout, aborting" );
221         return VLC_EGENERIC;
222     }
223
224     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
225
226     ADD_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
227
228     ADD_PARENT_CALLBACKS( SendEventsToChild );
229
230     return VLC_SUCCESS;
231 }
232
233 /*****************************************************************************
234  * End: terminate Transform video thread output method
235  *****************************************************************************/
236 static void End( vout_thread_t *p_vout )
237 {
238     int i_index;
239
240     /* Free the fake output buffers we allocated */
241     for( i_index = I_OUTPUTPICTURES ; i_index ; )
242     {
243         i_index--;
244         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
245     }
246 }
247
248 /*****************************************************************************
249  * Destroy: destroy Transform video thread output method
250  *****************************************************************************
251  * Terminate an output method created by TransformCreateOutputMethod
252  *****************************************************************************/
253 static void Destroy( vlc_object_t *p_this )
254 {
255     vout_thread_t *p_vout = (vout_thread_t *)p_this;
256
257     if( p_vout->p_sys->p_vout )
258     {
259         DEL_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
260         vlc_object_detach( p_vout->p_sys->p_vout );
261         vout_Destroy( p_vout->p_sys->p_vout );
262     }
263
264     DEL_PARENT_CALLBACKS( SendEventsToChild );
265
266     free( p_vout->p_sys );
267 }
268
269 /*****************************************************************************
270  * Render: displays previously rendered output
271  *****************************************************************************
272  * This function send the currently rendered image to Transform image, waits
273  * until it is displayed and switch the two rendering buffers, preparing next
274  * frame.
275  *****************************************************************************/
276 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
277 {
278     picture_t *p_outpic;
279     int i_index;
280
281     /* This is a new frame. Get a structure from the video_output. */
282     while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
283               == NULL )
284     {
285         if( p_vout->b_die || p_vout->b_error )
286         {
287             return;
288         }
289         msleep( VOUT_OUTMEM_SLEEP );
290     }
291
292     vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
293     vout_LinkPicture( p_vout->p_sys->p_vout, p_outpic );
294
295     switch( p_vout->p_sys->i_mode )
296     {
297         case TRANSFORM_MODE_90:
298             for( i_index = 0 ; i_index < p_pic->i_planes ; i_index++ )
299             {
300                 int i_pitch = p_pic->p[i_index].i_pitch;
301
302                 uint8_t *p_in = p_pic->p[i_index].p_pixels;
303
304                 uint8_t *p_out = p_outpic->p[i_index].p_pixels;
305                 uint8_t *p_out_end = p_out +
306                     p_outpic->p[i_index].i_visible_lines *
307                     p_outpic->p[i_index].i_pitch;
308
309                 for( ; p_out < p_out_end ; )
310                 {
311                     uint8_t *p_line_end;
312
313                     p_out_end -= p_outpic->p[i_index].i_pitch
314                                   - p_outpic->p[i_index].i_visible_pitch;
315                     p_line_end = p_in + p_pic->p[i_index].i_visible_lines *
316                         i_pitch;
317
318                     for( ; p_in < p_line_end ; )
319                     {
320                         p_line_end -= i_pitch;
321                         *(--p_out_end) = *p_line_end;
322                     }
323
324                     p_in++;
325                 }
326             }
327             break;
328
329         case TRANSFORM_MODE_180:
330             for( i_index = 0 ; i_index < p_pic->i_planes ; i_index++ )
331             {
332                 uint8_t *p_in = p_pic->p[i_index].p_pixels;
333                 uint8_t *p_in_end = p_in + p_pic->p[i_index].i_visible_lines
334                                             * p_pic->p[i_index].i_pitch;
335
336                 uint8_t *p_out = p_outpic->p[i_index].p_pixels;
337
338                 for( ; p_in < p_in_end ; )
339                 {
340                     uint8_t *p_line_start = p_in_end
341                                              - p_pic->p[i_index].i_pitch;
342                     p_in_end -= p_pic->p[i_index].i_pitch
343                                  - p_pic->p[i_index].i_visible_pitch;
344
345                     for( ; p_line_start < p_in_end ; )
346                     {
347                         *p_out++ = *(--p_in_end);
348                     }
349
350                     p_out += p_outpic->p[i_index].i_pitch
351                               - p_outpic->p[i_index].i_visible_pitch;
352                 }
353             }
354             break;
355
356         case TRANSFORM_MODE_270:
357             for( i_index = 0 ; i_index < p_pic->i_planes ; i_index++ )
358             {
359                 int i_pitch = p_pic->p[i_index].i_pitch;
360
361                 uint8_t *p_in = p_pic->p[i_index].p_pixels;
362
363                 uint8_t *p_out = p_outpic->p[i_index].p_pixels;
364                 uint8_t *p_out_end = p_out +
365                     p_outpic->p[i_index].i_visible_lines *
366                     p_outpic->p[i_index].i_pitch;
367
368                 for( ; p_out < p_out_end ; )
369                 {
370                     uint8_t *p_in_end;
371
372                     p_in_end = p_in + p_pic->p[i_index].i_visible_lines *
373                         i_pitch;
374
375                     for( ; p_in < p_in_end ; )
376                     {
377                         p_in_end -= i_pitch;
378                         *p_out++ = *p_in_end;
379                     }
380
381                     p_out += p_outpic->p[i_index].i_pitch
382                               - p_outpic->p[i_index].i_visible_pitch;
383                     p_in++;
384                 }
385             }
386             break;
387
388         case TRANSFORM_MODE_HFLIP:
389             for( i_index = 0 ; i_index < p_pic->i_planes ; i_index++ )
390             {
391                 uint8_t *p_in = p_pic->p[i_index].p_pixels;
392                 uint8_t *p_in_end = p_in + p_pic->p[i_index].i_visible_lines
393                                             * p_pic->p[i_index].i_pitch;
394
395                 uint8_t *p_out = p_outpic->p[i_index].p_pixels;
396
397                 for( ; p_in < p_in_end ; )
398                 {
399                     p_in_end -= p_pic->p[i_index].i_pitch;
400                     p_vout->p_libvlc->pf_memcpy( p_out, p_in_end,
401                                            p_pic->p[i_index].i_visible_pitch );
402                     p_out += p_pic->p[i_index].i_pitch;
403                 }
404             }
405             break;
406
407         case TRANSFORM_MODE_VFLIP:
408             for( i_index = 0 ; i_index < p_pic->i_planes ; i_index++ )
409             {
410                 uint8_t *p_in = p_pic->p[i_index].p_pixels;
411                 uint8_t *p_in_end = p_in + p_pic->p[i_index].i_visible_lines
412                                             * p_pic->p[i_index].i_pitch;
413
414                 uint8_t *p_out = p_outpic->p[i_index].p_pixels;
415
416                 for( ; p_in < p_in_end ; )
417                 {
418                     uint8_t *p_line_end = p_in
419                                            + p_pic->p[i_index].i_visible_pitch;
420
421                     for( ; p_in < p_line_end ; )
422                     {
423                         *p_out++ = *(--p_line_end);
424                     }
425
426                     p_in += p_pic->p[i_index].i_pitch;
427                 }
428             }
429             break;
430
431         default:
432             break;
433     }
434
435     vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
436
437     vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
438 }
439
440 /*****************************************************************************
441  * SendEvents: forward mouse and keyboard events to the parent p_vout
442  *****************************************************************************/
443 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
444                        vlc_value_t oldval, vlc_value_t newval, void *_p_vout )
445 {
446     vout_thread_t *p_vout = (vout_thread_t *)_p_vout;
447     vlc_value_t sentval = newval;
448
449     /* Translate the mouse coordinates */
450     if( !strcmp( psz_var, "mouse-x" ) )
451     {
452         switch( p_vout->p_sys->i_mode )
453         {
454         case TRANSFORM_MODE_270:
455             sentval.i_int = p_vout->p_sys->p_vout->output.i_width
456                              - sentval.i_int;
457         case TRANSFORM_MODE_90:
458             var_Set( p_vout, "mouse-y", sentval );
459             return VLC_SUCCESS;
460
461         case TRANSFORM_MODE_180:
462         case TRANSFORM_MODE_HFLIP:
463             sentval.i_int = p_vout->p_sys->p_vout->output.i_width
464                              - sentval.i_int;
465             break;
466
467         case TRANSFORM_MODE_VFLIP:
468         default:
469             break;
470         }
471     }
472     else if( !strcmp( psz_var, "mouse-y" ) )
473     {
474         switch( p_vout->p_sys->i_mode )
475         {
476         case TRANSFORM_MODE_90:
477             sentval.i_int = p_vout->p_sys->p_vout->output.i_height
478                              - sentval.i_int;
479         case TRANSFORM_MODE_270:
480             var_Set( p_vout, "mouse-x", sentval );
481             return VLC_SUCCESS;
482
483         case TRANSFORM_MODE_180:
484         case TRANSFORM_MODE_VFLIP:
485             sentval.i_int = p_vout->p_sys->p_vout->output.i_height
486                              - sentval.i_int;
487             break;
488
489         case TRANSFORM_MODE_HFLIP:
490         default:
491             break;
492         }
493     }
494
495     var_Set( p_vout, psz_var, sentval );
496
497     return VLC_SUCCESS;
498 }
499
500 /*****************************************************************************
501  * SendEventsToChild: forward events to the child/children vout
502  *****************************************************************************/
503 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
504                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
505 {
506     vout_thread_t *p_vout = (vout_thread_t *)p_this;
507     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
508     return VLC_SUCCESS;
509 }