* ./modules/video_filter/adjust.c: rehandled code and enhanced the
[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 VideoLAN
5  * $Id: adjust.c,v 1.6 2003/01/09 15:38:09 sam Exp $
6  *
7  * Authors: Simon Latapie <garf@via.ecp.fr>, 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 <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 /*****************************************************************************
54  * Module descriptor
55  *****************************************************************************/
56
57 #define CONT_TEXT N_("set image contrast")
58 #define CONT_LONGTEXT N_("Set the image contrast. Defaults to 1")
59 #define HUE_TEXT N_("set image hue")
60 #define HUE_LONGTEXT N_("Set the image hue, between 0 and 360. Defaults to 0")
61 #define SAT_TEXT N_("set image saturation")
62 #define SAT_LONGTEXT N_("Set the image saturation. Defaults to 1")
63 #define LUM_TEXT N_("set image brightness")
64 #define LUM_LONGTEXT N_("Set the image brightness. Defaults to 1")
65
66
67 vlc_module_begin();
68     add_category_hint( N_("Adjust"), NULL );
69     add_float_with_range( "contrast", 1.0, 0.0, 2.0, NULL, CONT_TEXT, CONT_LONGTEXT );
70     add_float_with_range( "brightness", 1.0, 0.0, 2.0, NULL, LUM_TEXT, LUM_LONGTEXT );
71     add_integer_with_range( "hue", 0, 0, 360, NULL, HUE_TEXT, HUE_LONGTEXT );
72     add_float_with_range( "saturation", 1.0, 0.0, 3.0, NULL, SAT_TEXT, SAT_LONGTEXT );
73     set_description( _("contrast/hue/saturation/brightness filter") );
74     set_capability( "video filter", 0 );
75     add_shortcut( "adjust" );
76     set_callbacks( Create, Destroy );
77 vlc_module_end();
78
79 /*****************************************************************************
80  * vout_sys_t: adjust video output method descriptor
81  *****************************************************************************
82  * This structure is part of the video output thread descriptor.
83  * It describes the adjust specific properties of an output thread.
84  *****************************************************************************/
85 struct vout_sys_t
86 {
87     vout_thread_t *p_vout;
88 };
89
90 inline static int32_t clip( int32_t a )
91 {
92     return (a > 255) ? 255 : (a < 0) ? 0 : a;
93 }
94
95 /*****************************************************************************
96  * Create: allocates adjust video thread output method
97  *****************************************************************************
98  * This function allocates and initializes a adjust vout method.
99  *****************************************************************************/
100 static int Create( vlc_object_t *p_this )
101 {
102     vout_thread_t *p_vout = (vout_thread_t *)p_this;
103
104     /* Allocate structure */
105     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
106     if( p_vout->p_sys == NULL )
107     {
108         msg_Err( p_vout, "out of memory" );
109         return VLC_ENOMEM;
110     }
111
112     p_vout->pf_init = Init;
113     p_vout->pf_end = End;
114     p_vout->pf_manage = NULL;
115     p_vout->pf_render = Render;
116     p_vout->pf_display = NULL;
117
118     return VLC_SUCCESS;
119 }
120
121 /*****************************************************************************
122  * Init: initialize adjust video thread output method
123  *****************************************************************************/
124 static int Init( vout_thread_t *p_vout )
125 {
126     int i_index;
127     picture_t *p_pic;
128
129     I_OUTPUTPICTURES = 0;
130
131     /* Initialize the output structure */
132     p_vout->output.i_chroma = p_vout->render.i_chroma;
133     p_vout->output.i_width  = p_vout->render.i_width;
134     p_vout->output.i_height = p_vout->render.i_height;
135     p_vout->output.i_aspect = p_vout->render.i_aspect;
136
137     /* Try to open the real video output */
138     msg_Dbg( p_vout, "spawning the real video output" );
139
140     p_vout->p_sys->p_vout = vout_Create( p_vout,
141                      p_vout->render.i_width, p_vout->render.i_height,
142                      p_vout->render.i_chroma, p_vout->render.i_aspect );
143
144     /* Everything failed */
145     if( p_vout->p_sys->p_vout == NULL )
146     {
147         msg_Err( p_vout, "can't open vout, aborting" );
148
149         return VLC_EGENERIC;
150     }
151
152     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
153
154     return VLC_SUCCESS;
155 }
156
157 /*****************************************************************************
158  * End: terminate adjust video thread output method
159  *****************************************************************************/
160 static void End( vout_thread_t *p_vout )
161 {
162     int i_index;
163
164     /* Free the fake output buffers we allocated */
165     for( i_index = I_OUTPUTPICTURES ; i_index ; )
166     {
167         i_index--;
168         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
169     }
170 }
171
172 /*****************************************************************************
173  * Destroy: destroy adjust video thread output method
174  *****************************************************************************
175  * Terminate an output method created by adjustCreateOutputMethod
176  *****************************************************************************/
177 static void Destroy( vlc_object_t *p_this )
178 {
179     vout_thread_t *p_vout = (vout_thread_t *)p_this;
180
181     vout_Destroy( p_vout->p_sys->p_vout );
182
183     free( p_vout->p_sys );
184 }
185
186 /*****************************************************************************
187  * Render: displays previously rendered output
188  *****************************************************************************
189  * This function send the currently rendered image to adjust modified image,
190  * waits until it is displayed and switch the two rendering buffers, preparing
191  * next frame.
192  *****************************************************************************/
193 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
194 {
195     int pi_luma[256];
196
197     picture_t *p_outpic;
198     uint8_t *p_in, *p_out, *p_in_u, *p_in_v, *p_in_end, *p_out_u, *p_out_v;
199
200     double  f_hue;
201     int32_t i_cont, i_lum;
202     int i_sat, i_sin, i_cos, i_x, i_y;
203     int i;
204
205     /* This is a new frame. Get a structure from the video_output. */
206     while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
207               == NULL )
208     {
209         if( p_vout->b_die || p_vout->b_error )
210         {
211             return;
212         }
213         msleep( VOUT_OUTMEM_SLEEP );
214     }
215
216     vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
217     vout_LinkPicture( p_vout->p_sys->p_vout, p_outpic );
218
219     /* Get configuration variables */
220     i_cont = config_GetFloat( p_vout, "contrast" ) * 255;
221     i_lum = (config_GetFloat( p_vout, "brightness" ) - 1.0) * 255;
222     f_hue = config_GetInt( p_vout, "hue" ) * M_PI / 180;
223     i_sat = config_GetFloat( p_vout, "saturation" ) * 256;
224
225     /* Contrast is a fast but kludged function, so I put this gap to be
226      * cleaner :) */
227     i_lum += 128 - i_cont / 2;
228
229     /* Fill the luma lookup table */
230     for( i = 0 ; i < 256 ; i++ )
231     {
232         pi_luma[ i ] = clip( i_lum + i_cont * i / 256 );
233     }
234
235     /* Do the Y plane */
236     p_in = p_pic->p[0].p_pixels;
237     p_in_end = p_in + p_pic->p[0].i_lines * p_pic->p[0].i_pitch - 8;
238
239     p_out = p_outpic->p[0].p_pixels;
240
241     for( ; p_in < p_in_end ; )
242     {
243         /* Do 8 pixels at a time */
244         *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
245         *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
246         *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
247         *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
248     }
249
250     p_in_end += 8;
251
252     for( ; p_in < p_in_end ; )
253     {
254         *p_out++ = pi_luma[ *p_in++ ];
255     }
256
257     /* Do the U and V planes */
258     p_in_u = p_pic->p[1].p_pixels;
259     p_in_v = p_pic->p[2].p_pixels;
260     p_in_end = p_in_u + p_pic->p[1].i_lines * p_pic->p[1].i_pitch - 8;
261
262     p_out_u = p_outpic->p[1].p_pixels;
263     p_out_v = p_outpic->p[2].p_pixels;
264
265     i_sin = sin(f_hue) * 256;
266     i_cos = cos(f_hue) * 256;
267
268     i_x = ( cos(f_hue) + sin(f_hue) ) * 32768;
269     i_y = ( cos(f_hue) - sin(f_hue) ) * 32768;
270
271     if ( i_sat > 256 )
272     {
273 #define WRITE_UV_CLIP() \
274     i_u = *p_in_u++ ; i_v = *p_in_v++ ; \
275     *p_out_u++ = clip( (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
276                            * i_sat) >> 8) + 128); \
277     *p_out_v++ = clip( (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
278                            * i_sat) >> 8) + 128)
279
280         uint8_t i_u, i_v;
281
282         for( ; p_in_u < p_in_end ; )
283         {
284             /* Do 8 pixels at a time */
285             WRITE_UV_CLIP(); WRITE_UV_CLIP(); WRITE_UV_CLIP(); WRITE_UV_CLIP();
286             WRITE_UV_CLIP(); WRITE_UV_CLIP(); WRITE_UV_CLIP(); WRITE_UV_CLIP();
287         }
288
289         p_in_end += 8;
290
291         for( ; p_in_u < p_in_end ; )
292         {
293             WRITE_UV_CLIP();
294         }
295     }
296     else
297     {
298 #define WRITE_UV() \
299     i_u = *p_in_u++ ; i_v = *p_in_v++ ; \
300     *p_out_u++ = (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
301                        * i_sat) >> 8) + 128; \
302     *p_out_v++ = (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
303                        * i_sat) >> 8) + 128
304
305         uint8_t i_u, i_v;
306
307         for( ; p_in_u < p_in_end ; )
308         {
309             /* Do 8 pixels at a time */
310             WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
311             WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
312         }
313
314         p_in_end += 8;
315
316         for( ; p_in_u < p_in_end ; )
317         {
318             WRITE_UV();
319         }
320     }
321
322     vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
323
324     vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
325 }
326