Make Zorglub less unhappy
[vlc.git] / modules / video_filter / adjust.c
1 /*****************************************************************************
2  * adjust.c : Contrast/Hue/Saturation/Brightness video plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2000, 2001, 2002, 2003 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Simon Latapie <garf@via.ecp.fr>
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 <errno.h>
28 #include <stdlib.h>                                      /* malloc(), free() */
29 #include <string.h>
30 #include <math.h>
31
32 #include <vlc/vlc.h>
33 #include <vlc/vout.h>
34
35 #include "filter_common.h"
36
37 #ifndef M_PI
38 #   define M_PI 3.14159265358979323846
39 #endif
40
41 #define eight_times( x )    x x x x x x x x
42
43 /*****************************************************************************
44  * Local prototypes
45  *****************************************************************************/
46 static int  Create    ( vlc_object_t * );
47 static void Destroy   ( vlc_object_t * );
48
49 static int  Init      ( vout_thread_t * );
50 static void End       ( vout_thread_t * );
51 static void Render    ( vout_thread_t *, picture_t * );
52
53 static int  SendEvents( vlc_object_t *, char const *,
54                         vlc_value_t, vlc_value_t, void * );
55
56 /*****************************************************************************
57  * Module descriptor
58  *****************************************************************************/
59
60 #define CONT_TEXT N_("Image contrast (0-2)")
61 #define CONT_LONGTEXT N_("Set the image contrast, between 0 and 2. Defaults to 1")
62 #define HUE_TEXT N_("Image hue (0-360)")
63 #define HUE_LONGTEXT N_("Set the image hue, between 0 and 360. Defaults to 0")
64 #define SAT_TEXT N_("Image saturation (0-3)")
65 #define SAT_LONGTEXT N_("Set the image saturation, between 0 and 3. Defaults to 1")
66 #define LUM_TEXT N_("Image brightness (0-2)")
67 #define LUM_LONGTEXT N_("Set the image brightness, between 0 and 2. Defaults to 1")
68 #define GAMMA_TEXT N_("Image gamma (0-10)")
69 #define GAMMA_LONGTEXT N_("Set the image gamma, between 0.01 and 10. Defaults to 1")
70
71
72 vlc_module_begin();
73     set_description( _("Image properties filter") );
74     set_shortname( N_("Image adjust" ));
75     set_category( CAT_VIDEO );
76     set_subcategory( SUBCAT_VIDEO_VFILTER );
77     set_capability( "video filter", 0 );
78
79     add_float_with_range( "contrast", 1.0, 0.0, 2.0, NULL, CONT_TEXT, CONT_LONGTEXT, VLC_FALSE );
80     add_float_with_range( "brightness", 1.0, 0.0, 2.0, NULL, LUM_TEXT, LUM_LONGTEXT, VLC_FALSE );
81     add_integer_with_range( "hue", 0, 0, 360, NULL, HUE_TEXT, HUE_LONGTEXT, VLC_FALSE );
82     add_float_with_range( "saturation", 1.0, 0.0, 3.0, NULL, SAT_TEXT, SAT_LONGTEXT, VLC_FALSE );
83     add_float_with_range( "gamma", 1.0, 0.01, 10.0, NULL, GAMMA_TEXT, GAMMA_LONGTEXT, VLC_FALSE );
84
85     add_shortcut( "adjust" );
86     set_callbacks( Create, Destroy );
87 vlc_module_end();
88
89 /*****************************************************************************
90  * vout_sys_t: adjust video output method descriptor
91  *****************************************************************************
92  * This structure is part of the video output thread descriptor.
93  * It describes the adjust specific properties of an output thread.
94  *****************************************************************************/
95 struct vout_sys_t
96 {
97     vout_thread_t *p_vout;
98 };
99
100 inline static int32_t clip( int32_t a )
101 {
102     return (a > 255) ? 255 : (a < 0) ? 0 : a;
103 }
104
105 /*****************************************************************************
106  * Control: control facility for the vout (forwards to child vout)
107  *****************************************************************************/
108 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
109 {
110     return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
111 }
112
113 /*****************************************************************************
114  * Create: allocates adjust video thread output method
115  *****************************************************************************
116  * This function allocates and initializes a adjust vout method.
117  *****************************************************************************/
118 static int Create( vlc_object_t *p_this )
119 {
120     vout_thread_t *p_vout = (vout_thread_t *)p_this;
121
122     /* Allocate structure */
123     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
124     if( p_vout->p_sys == NULL )
125     {
126         msg_Err( p_vout, "out of memory" );
127         return VLC_ENOMEM;
128     }
129
130     p_vout->pf_init = Init;
131     p_vout->pf_end = End;
132     p_vout->pf_manage = NULL;
133     p_vout->pf_render = Render;
134     p_vout->pf_display = NULL;
135     p_vout->pf_control = Control;
136     
137     var_Create( p_vout, "contrast", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
138     var_Create( p_vout, "brightness", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
139     var_Create( p_vout, "hue", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
140     var_Create( p_vout, "saturation", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
141     var_Create( p_vout, "gamma", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
142
143     return VLC_SUCCESS;
144 }
145
146 /*****************************************************************************
147  * Init: initialize adjust video thread output method
148  *****************************************************************************/
149 static int Init( vout_thread_t *p_vout )
150 {
151     int i_index;
152     picture_t *p_pic;
153     video_format_t fmt = {0};
154
155     I_OUTPUTPICTURES = 0;
156
157     /* Initialize the output structure */
158     p_vout->output.i_chroma = p_vout->render.i_chroma;
159     p_vout->output.i_width  = p_vout->render.i_width;
160     p_vout->output.i_height = p_vout->render.i_height;
161     p_vout->output.i_aspect = p_vout->render.i_aspect;
162
163     fmt.i_width = fmt.i_visible_width = p_vout->render.i_width;
164     fmt.i_height = fmt.i_visible_height = p_vout->render.i_height;
165     fmt.i_x_offset = fmt.i_y_offset = 0;
166     fmt.i_chroma = p_vout->render.i_chroma;
167     fmt.i_aspect = p_vout->render.i_aspect;
168     fmt.i_sar_num = p_vout->render.i_aspect * fmt.i_height / fmt.i_width;
169     fmt.i_sar_den = VOUT_ASPECT_FACTOR;
170
171     /* Try to open the real video output */
172     msg_Dbg( p_vout, "spawning the real video output" );
173
174     p_vout->p_sys->p_vout = vout_Create( p_vout, &fmt );
175
176     /* Everything failed */
177     if( p_vout->p_sys->p_vout == NULL )
178     {
179         msg_Err( p_vout, "can't open vout, aborting" );
180
181         return VLC_EGENERIC;
182     }
183
184     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
185
186     ADD_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
187
188     ADD_PARENT_CALLBACKS( SendEventsToChild );
189
190     return VLC_SUCCESS;
191 }
192
193 /*****************************************************************************
194  * End: terminate adjust video thread output method
195  *****************************************************************************/
196 static void End( vout_thread_t *p_vout )
197 {
198     int i_index;
199
200     /* Free the fake output buffers we allocated */
201     for( i_index = I_OUTPUTPICTURES ; i_index ; )
202     {
203         i_index--;
204         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
205     }
206 }
207
208 /*****************************************************************************
209  * Destroy: destroy adjust video thread output method
210  *****************************************************************************
211  * Terminate an output method created by adjustCreateOutputMethod
212  *****************************************************************************/
213 static void Destroy( vlc_object_t *p_this )
214 {
215     vout_thread_t *p_vout = (vout_thread_t *)p_this;
216
217     if( p_vout->p_sys->p_vout )
218     {
219         DEL_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
220         vlc_object_detach( p_vout->p_sys->p_vout );
221         vout_Destroy( p_vout->p_sys->p_vout );
222     }
223
224     DEL_PARENT_CALLBACKS( SendEventsToChild );
225
226     free( p_vout->p_sys );
227 }
228
229 /*****************************************************************************
230  * Render: displays previously rendered output
231  *****************************************************************************
232  * This function send the currently rendered image to adjust modified image,
233  * waits until it is displayed and switch the two rendering buffers, preparing
234  * next frame.
235  *****************************************************************************/
236 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
237 {
238     int pi_luma[256];
239     int pi_gamma[256];
240
241     picture_t *p_outpic;
242     uint8_t *p_in, *p_in_v, *p_in_end, *p_line_end;
243     uint8_t *p_out, *p_out_v;
244
245     double  f_hue;
246     double  f_gamma;
247     int32_t i_cont, i_lum;
248     int i_sat, i_sin, i_cos, i_x, i_y;
249     int i;
250     vlc_value_t val;
251
252     /* This is a new frame. Get a structure from the video_output. */
253     while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
254               == NULL )
255     {
256         if( p_vout->b_die || p_vout->b_error )
257         {
258             return;
259         }
260         msleep( VOUT_OUTMEM_SLEEP );
261     }
262
263     vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
264     vout_LinkPicture( p_vout->p_sys->p_vout, p_outpic );
265
266     /* Getvariables */
267     var_Get( p_vout, "contrast", &val );
268     i_cont = (int) ( val.f_float * 255 );
269     var_Get( p_vout, "brightness", &val );
270     i_lum = (int) (( val.f_float - 1.0 ) * 255 );
271     var_Get( p_vout, "hue", &val );
272     f_hue = (float) ( val.i_int * M_PI / 180 );
273     var_Get( p_vout, "saturation", &val );
274     i_sat = (int) (val.f_float * 256 );
275     var_Get( p_vout, "gamma", &val );
276     f_gamma = 1.0 / val.f_float;
277
278     /* Contrast is a fast but kludged function, so I put this gap to be
279      * cleaner :) */
280     i_lum += 128 - i_cont / 2;
281
282     /* Fill the gamma lookup table */
283     for( i = 0 ; i < 256 ; i++ )
284     {
285       pi_gamma[ i ] = clip( pow(i / 255.0, f_gamma) * 255.0);
286     }
287
288     /* Fill the luma lookup table */
289     for( i = 0 ; i < 256 ; i++ )
290     {
291         pi_luma[ i ] = pi_gamma[clip( i_lum + i_cont * i / 256)];
292     }
293
294     /*
295      * Do the Y plane
296      */
297
298     p_in = p_pic->p[0].p_pixels;
299     p_in_end = p_in + p_pic->p[0].i_visible_lines * p_pic->p[0].i_pitch - 8;
300
301     p_out = p_outpic->p[0].p_pixels;
302
303     for( ; p_in < p_in_end ; )
304     {
305         p_line_end = p_in + p_pic->p[0].i_visible_pitch - 8;
306
307         for( ; p_in < p_line_end ; )
308         {
309             /* Do 8 pixels at a time */
310             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
311             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
312             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
313             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
314         }
315
316         p_line_end += 8;
317
318         for( ; p_in < p_line_end ; )
319         {
320             *p_out++ = pi_luma[ *p_in++ ];
321         }
322
323         p_in += p_pic->p[0].i_pitch - p_pic->p[0].i_visible_pitch;
324         p_out += p_outpic->p[0].i_pitch - p_outpic->p[0].i_visible_pitch;
325     }
326
327     /*
328      * Do the U and V planes
329      */
330
331     p_in = p_pic->p[1].p_pixels;
332     p_in_v = p_pic->p[2].p_pixels;
333     p_in_end = p_in + p_pic->p[1].i_visible_lines * p_pic->p[1].i_pitch - 8;
334
335     p_out = p_outpic->p[1].p_pixels;
336     p_out_v = p_outpic->p[2].p_pixels;
337
338     i_sin = sin(f_hue) * 256;
339     i_cos = cos(f_hue) * 256;
340
341     i_x = ( cos(f_hue) + sin(f_hue) ) * 32768;
342     i_y = ( cos(f_hue) - sin(f_hue) ) * 32768;
343
344     if ( i_sat > 256 )
345     {
346 #define WRITE_UV_CLIP() \
347     i_u = *p_in++ ; i_v = *p_in_v++ ; \
348     *p_out++ = clip( (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
349                            * i_sat) >> 8) + 128); \
350     *p_out_v++ = clip( (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
351                            * i_sat) >> 8) + 128)
352
353         uint8_t i_u, i_v;
354
355         for( ; p_in < p_in_end ; )
356         {
357             p_line_end = p_in + p_pic->p[1].i_visible_pitch - 8;
358
359             for( ; p_in < p_line_end ; )
360             {
361                 /* Do 8 pixels at a time */
362                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
363                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
364                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
365                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
366             }
367
368             p_line_end += 8;
369
370             for( ; p_in < p_line_end ; )
371             {
372                 WRITE_UV_CLIP();
373             }
374
375             p_in += p_pic->p[1].i_pitch - p_pic->p[1].i_visible_pitch;
376             p_in_v += p_pic->p[2].i_pitch - p_pic->p[2].i_visible_pitch;
377             p_out += p_outpic->p[1].i_pitch - p_outpic->p[1].i_visible_pitch;
378             p_out_v += p_outpic->p[2].i_pitch - p_outpic->p[2].i_visible_pitch;
379         }
380     }
381     else
382     {
383 #define WRITE_UV() \
384     i_u = *p_in++ ; i_v = *p_in_v++ ; \
385     *p_out++ = (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
386                        * i_sat) >> 8) + 128; \
387     *p_out_v++ = (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
388                        * i_sat) >> 8) + 128
389
390         uint8_t i_u, i_v;
391
392         for( ; p_in < p_in_end ; )
393         {
394             p_line_end = p_in + p_pic->p[1].i_visible_pitch - 8;
395
396             for( ; p_in < p_line_end ; )
397             {
398                 /* Do 8 pixels at a time */
399                 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
400                 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
401             }
402
403             p_line_end += 8;
404
405             for( ; p_in < p_line_end ; )
406             {
407                 WRITE_UV();
408             }
409
410             p_in += p_pic->p[1].i_pitch - p_pic->p[1].i_visible_pitch;
411             p_in_v += p_pic->p[2].i_pitch - p_pic->p[2].i_visible_pitch;
412             p_out += p_outpic->p[1].i_pitch - p_outpic->p[1].i_visible_pitch;
413             p_out_v += p_outpic->p[2].i_pitch - p_outpic->p[2].i_visible_pitch;
414         }
415     }
416
417     vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
418
419     vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
420 }
421
422 /*****************************************************************************
423  * SendEvents: forward mouse and keyboard events to the parent p_vout
424  *****************************************************************************/
425 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
426                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
427 {
428     var_Set( (vlc_object_t *)p_data, psz_var, newval );
429
430     return VLC_SUCCESS;
431 }
432
433 /*****************************************************************************
434  * SendEventsToChild: forward events to the child/children vout
435  *****************************************************************************/
436 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
437                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
438 {
439     vout_thread_t *p_vout = (vout_thread_t *)p_this;
440     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
441     return VLC_SUCCESS;
442 }