]> git.sesse.net Git - mlt/blob - src/modules/xine/filter_deinterlace.c
fix yadif deinterlacer on streams with progressive & interlace
[mlt] / src / modules / xine / filter_deinterlace.c
1 /*
2  * filter_deinterlace.c -- deinterlace filter
3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4  * Author: Charles Yates <charles.yates@pandora.be>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  */
20
21 #include <framework/mlt_filter.h>
22 #include <framework/mlt_log.h>
23 #include <framework/mlt_producer.h>
24 #include <framework/mlt_events.h>
25 #include "deinterlace.h"
26 #include "yadif.h"
27
28 #include <framework/mlt_frame.h>
29
30 #include <string.h>
31 #include <stdlib.h>
32
33 #define YADIF_MODE_TEMPORAL_SPATIAL (0)
34 #define YADIF_MODE_TEMPORAL (2)
35
36 static yadif_filter *init_yadif( int width, int height )
37 {
38         yadif_filter *yadif = mlt_pool_alloc( sizeof( *yadif ) );
39
40         yadif->cpu = 0; // Pure C
41 #ifdef USE_SSE
42         yadif->cpu |= AVS_CPU_INTEGER_SSE;
43 #endif
44 #ifdef USE_SSE2
45         yadif->cpu |= AVS_CPU_SSE2;
46 #endif
47         // Create intermediate planar planes
48         yadif->yheight = height;
49         yadif->ywidth  = width;
50         yadif->uvwidth = yadif->ywidth / 2;
51         yadif->ypitch  = ( yadif->ywidth +  15 ) / 16 * 16;
52         yadif->uvpitch = ( yadif->uvwidth + 15 ) / 16 * 16;
53         yadif->ysrc  = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->ypitch );
54         yadif->usrc  = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->uvpitch);
55         yadif->vsrc  = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->uvpitch );
56         yadif->yprev = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->ypitch );
57         yadif->uprev = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->uvpitch );
58         yadif->vprev = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->uvpitch );
59         yadif->ynext = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->ypitch );
60         yadif->unext = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->uvpitch );
61         yadif->vnext = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->uvpitch );
62         yadif->ydest = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->ypitch );
63         yadif->udest = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->uvpitch );
64         yadif->vdest = (unsigned char *) mlt_pool_alloc( yadif->yheight * yadif->uvpitch );
65
66         return yadif;
67 }
68
69 static void close_yadif(yadif_filter *yadif)
70 {
71         mlt_pool_release( yadif->ysrc );
72         mlt_pool_release( yadif->usrc );
73         mlt_pool_release( yadif->vsrc );
74         mlt_pool_release( yadif->yprev );
75         mlt_pool_release( yadif->uprev );
76         mlt_pool_release( yadif->vprev );
77         mlt_pool_release( yadif->ynext );
78         mlt_pool_release( yadif->unext );
79         mlt_pool_release( yadif->vnext );
80         mlt_pool_release( yadif->ydest );
81         mlt_pool_release( yadif->udest );
82         mlt_pool_release( yadif->vdest );
83         mlt_pool_release( yadif );
84
85 #if defined(__GNUC__) && !defined(PIC)
86         // Set SSSE3 bit to cpu
87         asm (\
88         "mov $1, %%eax \n\t"\
89         "push %%ebx \n\t"\
90         "cpuid \n\t"\
91         "pop %%ebx \n\t"\
92         "mov %%ecx, %%edx \n\t"\
93         "shr $9, %%edx \n\t"\
94         "and $1, %%edx \n\t"\
95         "shl $9, %%edx \n\t"\
96         "and $511, %%ebx \n\t"\
97         "or %%edx, %%ebx \n\t"\
98         : "=b"(yadif->cpu) : "p"(yadif->cpu) : "%eax", "%ecx", "%edx");
99 #endif
100 }
101
102 static int deinterlace_yadif( mlt_frame frame, mlt_filter filter, uint8_t **image, mlt_image_format *format, int *width, int *height, int mode )
103 {
104         mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
105         mlt_frame previous_frame = mlt_properties_get_data( properties, "previous frame", NULL );
106         uint8_t* previous_image = NULL;
107         int previous_width = *width;
108         int previous_height = *height;
109         mlt_frame next_frame = mlt_properties_get_data( properties, "next frame", NULL );
110         uint8_t* next_image = NULL;
111         int next_width = *width;
112         int next_height = *height;
113         
114         mlt_log_debug( MLT_FILTER_SERVICE(filter), "previous %d current %d next %d\n",
115                 previous_frame? mlt_frame_original_position(previous_frame) : -1,
116                 mlt_frame_original_position(frame),
117                 next_frame?  mlt_frame_original_position(next_frame) : -1);
118
119         if ( !previous_frame || !next_frame )
120                 return 1;
121
122         // Some producers like pixbuf want rescale_width & _height, but will not get them if you request
123         // the previous image first. So, on the first iteration, we make the previous frame the same
124         // as the current frame.
125         if ( !mlt_properties_get_int( MLT_FILTER_PROPERTIES(filter), "_notfirst" ) )
126         {
127                 previous_frame = frame;
128                 mlt_properties_set_int( MLT_FILTER_PROPERTIES(filter), "_notfirst", 1 );
129         }
130
131         // Get the preceding frame's image
132         int error = mlt_frame_get_image( previous_frame, &previous_image, format, &previous_width, &previous_height, 0 );
133         int progressive = mlt_properties_get_int( MLT_FRAME_PROPERTIES( previous_frame ), "progressive" );
134
135         // Check that we aren't already progressive
136         if ( !error && previous_image && !progressive )
137         {
138                 // OK, now we know we have work to do and can request the image in our format
139                 frame->convert_image( previous_frame, &previous_image, format, mlt_image_yuv422 );
140
141                 // Get the current frame's image
142                 *format = mlt_image_yuv422;
143                 error = mlt_frame_get_image( frame, image, format, width, height, 0 );
144
145                 if ( !error && *image && *format == mlt_image_yuv422 )
146                 {
147                         // Get the following frame's image
148                         error = mlt_frame_get_image( next_frame, &next_image, format, &next_width, &next_height, 0 );
149                 
150                         if ( !error && next_image && *format == mlt_image_yuv422 )
151                         {
152                                 yadif_filter *yadif = init_yadif( *width, *height );
153                                 if ( yadif )
154                                 {
155                                         const int order = mlt_properties_get_int( properties, "top_field_first" );
156                                         const int pitch = *width << 1;
157                                         const int parity = 0;
158
159                                         // Convert packed to planar
160                                         YUY2ToPlanes( *image, pitch, *width, *height, yadif->ysrc,
161                                                 yadif->ypitch, yadif->usrc, yadif->vsrc, yadif->uvpitch, yadif->cpu );
162                                         YUY2ToPlanes( previous_image, pitch, *width, *height, yadif->yprev,
163                                                 yadif->ypitch, yadif->uprev, yadif->vprev, yadif->uvpitch, yadif->cpu );
164                                         YUY2ToPlanes( next_image, pitch, *width, *height, yadif->ynext,
165                                                 yadif->ypitch, yadif->unext, yadif->vnext, yadif->uvpitch, yadif->cpu );
166
167                                         // Deinterlace each plane
168                                         filter_plane( mode, yadif->ydest, yadif->ypitch, yadif->yprev, yadif->ysrc,
169                                                 yadif->ynext, yadif->ypitch, *width, *height, parity, order, yadif->cpu);
170                                         filter_plane( mode, yadif->udest, yadif->uvpitch,yadif->uprev, yadif->usrc,
171                                                 yadif->unext, yadif->uvpitch, *width >> 1, *height, parity, order, yadif->cpu);
172                                         filter_plane( mode, yadif->vdest, yadif->uvpitch, yadif->vprev, yadif->vsrc,
173                                                 yadif->vnext, yadif->uvpitch, *width >> 1, *height, parity, order, yadif->cpu);
174
175                                         // Convert planar to packed
176                                         YUY2FromPlanes( *image, pitch, *width, *height, yadif->ydest,
177                                                 yadif->ypitch, yadif->udest, yadif->vdest, yadif->uvpitch, yadif->cpu);
178
179                                         close_yadif( yadif );
180                                 }
181                         }
182                 }
183         }
184         else
185         {
186                 // Get the current frame's image
187                 error = mlt_frame_get_image( frame, image, format, width, height, 0 );
188         }
189         return error;
190 }
191
192 /** Do it :-).
193 */
194
195 static int filter_get_image( mlt_frame frame, uint8_t **image, mlt_image_format *format, int *width, int *height, int writable )
196 {
197         int error = 0;
198         mlt_filter filter = mlt_frame_pop_service( frame );
199         mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
200         int deinterlace = mlt_properties_get_int( properties, "consumer_deinterlace" );
201         // The progressive var should only represent the frame's original state and not the state
202         // as modified by this filter!
203         int progressive = mlt_properties_get_int( properties, "progressive" );
204         // At this point - before image was requested - (progressive == 0) cannot be trusted because
205         // some producers (avformat) do not yet know.
206
207         if ( deinterlace )
208         {
209                 // Determine deinterlace method
210                 char *method_str = mlt_properties_get( MLT_FILTER_PROPERTIES( filter ), "method" );
211                 int method = DEINTERLACE_NONE;
212                 char *frame_method_str = mlt_properties_get( properties, "deinterlace_method" );
213                 
214                 if ( frame_method_str )
215                         method_str = frame_method_str;
216                 
217                 if ( !method_str || strcmp( method_str, "yadif" ) == 0 )
218                         method = DEINTERLACE_YADIF;
219                 else if ( strcmp( method_str, "yadif-nospatial" ) == 0 )
220                         method = DEINTERLACE_YADIF_NOSPATIAL;
221                 else if ( strcmp( method_str, "onefield" ) == 0 )
222                         method = DEINTERLACE_ONEFIELD;
223                 else if ( strcmp( method_str, "linearblend" ) == 0 )
224                         method = DEINTERLACE_LINEARBLEND;
225                 else if ( strcmp( method_str, "bob" ) == 0 )
226                         method = DEINTERLACE_BOB;
227                 else if ( strcmp( method_str, "weave" ) == 0 )
228                         method = DEINTERLACE_BOB;
229                 else if ( strcmp( method_str, "greedy" ) == 0 )
230                         method = DEINTERLACE_GREEDY;
231
232                 if ( method == DEINTERLACE_YADIF )
233                 {
234                         error = deinterlace_yadif( frame, filter, image, format, width, height, YADIF_MODE_TEMPORAL_SPATIAL );
235                 }
236                 else if ( method == DEINTERLACE_YADIF_NOSPATIAL )
237                 {
238                         error = deinterlace_yadif( frame, filter, image, format, width, height, YADIF_MODE_TEMPORAL );
239                 }
240                 if ( error || ( method > DEINTERLACE_NONE && method < DEINTERLACE_YADIF ) )
241                 {
242                         mlt_service service = mlt_properties_get_data( MLT_FILTER_PROPERTIES(filter), "service", NULL );
243
244                         // Get the current frame's image
245                         int error2 = mlt_frame_get_image( frame, image, format, width, height, writable );
246                         progressive = mlt_properties_get_int( properties, "progressive" );
247
248                         if ( error )
249                         {
250                                 method = DEINTERLACE_ONEFIELD;
251                                 // If YADIF requested, prev/next cancelled because some previous frames were progressive,
252                                 // but new frames are interlaced, then turn prev/next frames back on.
253                                 if ( !progressive )
254                                         mlt_properties_set_int( MLT_SERVICE_PROPERTIES(service), "_need_previous_next", 1 );
255                         }
256                         else
257                         {
258                                 // Signal that we no longer need previous and next frames
259                                 mlt_properties_set_int( MLT_SERVICE_PROPERTIES(service), "_need_previous_next", 0 );
260                         }
261                         
262                         if ( !error2 && !progressive )
263                         {
264                                 // OK, now we know we have work to do and can request the image in our format
265                                 error2 = frame->convert_image( frame, image, format, mlt_image_yuv422 );
266
267                                 // Check that we aren't already progressive
268                                 if ( !error2 && *image && *format == mlt_image_yuv422 )
269                                 {
270                                         // Deinterlace the image using one of the Xine deinterlacers
271                                         int image_size = *width * *height * 2;
272                                         uint8_t *new_image = mlt_pool_alloc( image_size );
273
274                                         deinterlace_yuv( new_image, image, *width * 2, *height, method );
275                                         mlt_frame_set_image( frame, new_image, image_size, mlt_pool_release );
276                                         *image = new_image;
277                                 }
278                         }
279                 }
280                 else if ( method == DEINTERLACE_NONE )
281                 {
282                         error = mlt_frame_get_image( frame, image, format, width, height, writable );
283                 }
284
285                 // update progressive flag after having obtained image
286                 progressive = mlt_properties_get_int( properties, "progressive" );
287
288                 mlt_log_debug( MLT_FILTER_SERVICE( filter ), "error %d deint %d prog %d fmt %s method %s\n",
289                         error, deinterlace, progressive, mlt_image_format_name( *format ), method_str ? method_str : "yadif" );
290
291                 if ( !error )
292                 {
293                         // Make sure that others know the frame is deinterlaced
294                         mlt_properties_set_int( properties, "progressive", 1 );
295                 }
296         }
297         else
298         {
299                 // Pass through
300                 error = mlt_frame_get_image( frame, image, format, width, height, writable );
301         }
302
303         if ( !deinterlace || progressive )
304         {
305                 // Signal that we no longer need previous and next frames
306                 mlt_service service = mlt_properties_get_data( MLT_FILTER_PROPERTIES(filter), "service", NULL );
307                 if ( service )
308                         mlt_properties_set_int( MLT_SERVICE_PROPERTIES(service), "_need_previous_next", 0 );
309         }
310
311         return error;
312 }
313
314 /** Deinterlace filter processing - this should be lazy evaluation here...
315 */
316
317 static mlt_frame deinterlace_process( mlt_filter filter, mlt_frame frame )
318 {
319         // Push filter on to the service stack
320         mlt_frame_push_service( frame, filter );
321
322         // Push the get_image method on to the stack
323         mlt_frame_push_get_image( frame, filter_get_image );
324         
325         return frame;
326 }
327
328 static void on_service_changed( mlt_service owner, mlt_service filter )
329 {
330         mlt_service service = mlt_properties_get_data( MLT_SERVICE_PROPERTIES(filter), "service", NULL );
331         mlt_properties_set_int( MLT_SERVICE_PROPERTIES(service), "_need_previous_next", 1 );
332 }
333
334 /** Constructor for the filter.
335 */
336
337 mlt_filter filter_deinterlace_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
338 {
339         mlt_filter filter = mlt_filter_new( );
340         if ( filter != NULL )
341         {
342                 filter->process = deinterlace_process;
343                 mlt_properties_set( MLT_FILTER_PROPERTIES( filter ), "method", arg );
344                 mlt_events_listen( MLT_FILTER_PROPERTIES( filter ), filter, "service-changed", (mlt_listener) on_service_changed );
345         }
346         return filter;
347 }
348