* include/video_output.h, ALL: changed api for vout_Request()/vout_Create() to be...
[vlc.git] / modules / video_filter / motionblur.c
1 /*****************************************************************************
2  * motion_blur.c : motion blur filter for vlc
3  *****************************************************************************
4  * Copyright (C) 2000, 2001, 2002, 2003 VideoLAN
5  * $Id$
6  *
7  * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
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 /*****************************************************************************
36  * Local protypes
37  *****************************************************************************/
38 static int  Create    ( vlc_object_t * );
39 static void Destroy   ( vlc_object_t * );
40
41 static int  Init      ( vout_thread_t * );
42 static void End       ( vout_thread_t * );
43 static void Render    ( vout_thread_t *, picture_t * );
44
45 static void RenderBlur    ( vout_thread_t *, picture_t *, picture_t *, picture_t * );
46 static void CopyPicture ( vout_thread_t*, picture_t *, picture_t * );
47
48 static int  SendEvents( vlc_object_t *, char const *,
49                         vlc_value_t, vlc_value_t, void * );
50
51 /*****************************************************************************
52  * Module descriptor
53  *****************************************************************************/
54 #define MODE_TEXT N_("Blur factor (1-127)")
55 #define MODE_LONGTEXT N_("The degree of blurring from 1 to 127.")
56
57 vlc_module_begin();
58     set_description( _("Motion blur filter") );
59     set_capability( "video filter", 0 );
60
61     add_integer_with_range( "blur-factor", 80, 1, 127, NULL,
62         MODE_TEXT, MODE_LONGTEXT, VLC_FALSE );
63     
64     set_callbacks( Create, Destroy );
65 vlc_module_end();
66
67 /*****************************************************************************
68  * vout_sys_t: Deinterlace video output method descriptor
69  *****************************************************************************
70  * This structure is part of the video output thread descriptor.
71  * It describes the Deinterlace specific properties of an output thread.
72  *****************************************************************************/
73 struct vout_sys_t
74 {
75     int        i_factor;        /* Deinterlace mode */
76     vlc_bool_t b_double_rate; /* Shall we double the framerate? */
77
78     mtime_t    last_date;
79     mtime_t    next_date;
80
81     vout_thread_t *p_vout;
82     picture_t *p_lastpic;
83 };
84
85 /*****************************************************************************
86  * Control: control facility for the vout (forwards to child vout)
87  *****************************************************************************/
88 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
89 {
90     return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
91 }
92
93 /*****************************************************************************
94  * Create: allocates Deinterlace video thread output method
95  *****************************************************************************
96  * This function allocates and initializes a Deinterlace vout method.
97  *****************************************************************************/
98 static int Create( vlc_object_t *p_this )
99 {
100     vout_thread_t *p_vout = (vout_thread_t *)p_this;
101
102     /* Allocate structure */
103     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
104     if( p_vout->p_sys == NULL )
105     {
106         msg_Err( p_vout, "out of memory" );
107         return VLC_ENOMEM;
108     }
109
110     p_vout->pf_init = Init;
111     p_vout->pf_end = End;
112     p_vout->pf_manage = NULL;
113     p_vout->pf_render = Render;
114     p_vout->pf_display = NULL;
115     p_vout->pf_control = Control;
116
117     p_vout->p_sys->i_factor = config_GetInt( p_vout, "blur-factor" );
118     p_vout->p_sys->b_double_rate = 0;
119     p_vout->p_sys->last_date = 0;
120     p_vout->p_sys->p_lastpic = NULL;
121
122     return VLC_SUCCESS;
123 }
124
125 /*****************************************************************************
126  * Init: initialize Deinterlace video thread output method
127  *****************************************************************************/
128 static int Init( vout_thread_t *p_vout )
129 {
130     int i_index;
131     picture_t *p_pic;
132     video_format_t fmt = {0};
133
134     I_OUTPUTPICTURES = 0;
135
136     /* Initialize the output structure, full of directbuffers since we want
137      * the decoder to output directly to our structures. */
138     switch( p_vout->render.i_chroma )
139     {
140         case VLC_FOURCC('I','4','2','0'):
141         case VLC_FOURCC('I','Y','U','V'):
142         case VLC_FOURCC('Y','V','1','2'):
143         case VLC_FOURCC('I','4','2','2'):
144             p_vout->output.i_chroma = p_vout->render.i_chroma;
145             p_vout->output.i_width  = p_vout->render.i_width;
146             p_vout->output.i_height = p_vout->render.i_height;
147             p_vout->output.i_aspect = p_vout->render.i_aspect;
148             break;
149
150         default:
151             return VLC_EGENERIC; /* unknown chroma */
152             break;
153     }
154
155     msg_Dbg( p_vout, "spawning the real video output" );
156
157     fmt.i_width = fmt.i_visible_width = p_vout->output.i_width;
158     fmt.i_height = fmt.i_visible_height = p_vout->output.i_height;
159     fmt.i_x_offset = fmt.i_y_offset = 0;
160     fmt.i_chroma = p_vout->output.i_chroma;
161     fmt.i_aspect = p_vout->output.i_aspect;
162     fmt.i_sar_num = p_vout->output.i_aspect * fmt.i_height / fmt.i_width;
163     fmt.i_sar_den = VOUT_ASPECT_FACTOR;
164
165     switch( p_vout->render.i_chroma )
166     {
167     case VLC_FOURCC('I','4','2','0'):
168     case VLC_FOURCC('I','Y','U','V'):
169     case VLC_FOURCC('Y','V','1','2'):
170         p_vout->p_sys->p_vout = vout_Create( p_vout, &fmt );
171         break;
172     default:
173         break;
174     }
175
176     /* Everything failed */
177     if( p_vout->p_sys->p_vout == NULL )
178     {
179         msg_Err( p_vout, "cannot 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 Deinterlace 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 Deinterlace video thread output method
210  *****************************************************************************
211  * Terminate an output method created by DeinterlaceCreateOutputMethod
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 Deinterlace 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     picture_t * p_outpic;
239     while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
240            == NULL )
241     {
242         if( p_vout->b_die || p_vout->b_error )
243         {
244             return;
245         }
246         msleep( VOUT_OUTMEM_SLEEP );
247     }
248     vout_DatePicture( p_vout, p_outpic, p_pic->date );
249
250     if ( p_vout->p_sys->p_lastpic == NULL )
251     {
252         /* Get a new picture */
253         while( ( p_vout->p_sys->p_lastpic =
254                  vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
255                == NULL )
256         {
257             if( p_vout->b_die || p_vout->b_error )
258             {
259                 return;
260             }
261             msleep( VOUT_OUTMEM_SLEEP );
262         }
263         CopyPicture( p_vout, p_vout->p_sys->p_lastpic, p_pic );
264         CopyPicture( p_vout, p_outpic, p_pic );
265         vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
266         return;
267     }
268
269     /* Get a new picture */
270     RenderBlur( p_vout, p_vout->p_sys->p_lastpic, p_pic, p_outpic );
271     vout_DestroyPicture( p_vout, p_vout->p_sys->p_lastpic );
272
273
274     /* Get a new picture */
275     while( ( p_vout->p_sys->p_lastpic =
276              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     CopyPicture( p_vout, p_vout->p_sys->p_lastpic, p_outpic );
286     vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
287 }
288
289 /* FIXME: this is a verbatim copy from src/video_output/vout_pictures.c */
290 /* XXX: the order is fucked up!! */
291 static void CopyPicture( vout_thread_t * p_vout,
292                          picture_t *p_dest, picture_t *p_src )
293 {
294     int i;
295
296     for( i = 0; i < p_src->i_planes ; i++ )
297     {
298         if( p_src->p[i].i_pitch == p_dest->p[i].i_pitch )
299         {
300             /* There are margins, but with the same width : perfect ! */
301             p_vout->p_vlc->pf_memcpy(
302                          p_dest->p[i].p_pixels, p_src->p[i].p_pixels,
303                          p_src->p[i].i_pitch * p_src->p[i].i_visible_lines );
304         }
305         else
306         {
307             /* We need to proceed line by line */
308             uint8_t *p_in = p_src->p[i].p_pixels;
309             uint8_t *p_out = p_dest->p[i].p_pixels;
310             int i_line;
311
312             for( i_line = p_src->p[i].i_visible_lines; i_line--; )
313             {
314                 p_vout->p_vlc->pf_memcpy( p_out, p_in,
315                                           p_src->p[i].i_visible_pitch );
316                 p_in += p_src->p[i].i_pitch;
317                 p_out += p_dest->p[i].i_pitch;
318             }
319         }
320     }
321 }
322
323 /*****************************************************************************
324  * RenderBlur: renders a blurred picture
325  *****************************************************************************/
326 static void RenderBlur( vout_thread_t *p_vout, picture_t *p_oldpic,
327                         picture_t *p_newpic, picture_t *p_outpic )
328 {
329     int i_plane;
330     int i_oldfactor = p_vout->p_sys->i_factor;
331     int i_newfactor = 128 - p_vout->p_sys->i_factor;
332     for( i_plane = 0; i_plane < p_outpic->i_planes; i_plane++ )
333     {
334         uint8_t *p_old, *p_new, *p_out, *p_out_end, *p_out_line_end;
335         p_out = p_outpic->p[i_plane].p_pixels;
336         p_new = p_newpic->p[i_plane].p_pixels;
337         p_old = p_oldpic->p[i_plane].p_pixels;
338         p_out_end = p_out + p_outpic->p[i_plane].i_pitch *
339                              p_outpic->p[i_plane].i_visible_lines;
340         while ( p_out < p_out_end )
341         {
342             p_out_line_end = p_out + p_outpic->p[i_plane].i_visible_pitch;
343
344             while ( p_out < p_out_line_end )
345             {
346                 *p_out++ = (((*p_old++) * i_oldfactor) +
347                             ((*p_new++) * i_newfactor)) >> 7;
348
349 //                *p_out++ = (*p_old++ >> 1) + (*p_new++ >> 1);
350             }
351
352             p_old += p_oldpic->p[i_plane].i_pitch
353                       - p_oldpic->p[i_plane].i_visible_pitch;
354             p_new += p_newpic->p[i_plane].i_pitch
355                       - p_newpic->p[i_plane].i_visible_pitch;
356             p_out += p_outpic->p[i_plane].i_pitch
357                       - p_outpic->p[i_plane].i_visible_pitch;
358         }
359     }
360 }
361
362 /*****************************************************************************
363  * SendEvents: forward mouse and keyboard events to the parent p_vout
364  *****************************************************************************/
365 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
366                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
367 {
368     var_Set( (vlc_object_t *)p_data, psz_var, newval );
369
370     return VLC_SUCCESS;
371 }
372
373 /*****************************************************************************
374  * SendEventsToChild: forward events to the child/children vout
375  *****************************************************************************/
376 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
377                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
378 {
379     vout_thread_t *p_vout = (vout_thread_t *)p_this;
380     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
381     return VLC_SUCCESS;
382 }