2 * filter_deinterlace.c -- deinterlace filter
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
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.
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.
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.
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"
28 #include <framework/mlt_frame.h>
33 #define YADIF_MODE_TEMPORAL_SPATIAL (0)
34 #define YADIF_MODE_TEMPORAL (2)
36 static yadif_filter *init_yadif( int width, int height )
38 yadif_filter *yadif = mlt_pool_alloc( sizeof( *yadif ) );
40 yadif->cpu = 0; // Pure C
42 yadif->cpu |= AVS_CPU_INTEGER_SSE;
45 yadif->cpu |= AVS_CPU_SSE2;
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 );
69 static void close_yadif(yadif_filter *yadif)
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 );
85 #if defined(__GNUC__) && !defined(PIC)
86 // Set SSSE3 bit to cpu
92 "mov %%ecx, %%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");
102 static int deinterlace_yadif( mlt_frame frame, mlt_filter filter, uint8_t **image, mlt_image_format *format, int *width, int *height, int mode )
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;
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);
119 if ( !previous_frame || !next_frame )
122 // Get the preceding frame's image
123 int error = mlt_frame_get_image( previous_frame, &previous_image, format, &previous_width, &previous_height, 0 );
124 int progressive = mlt_properties_get_int( MLT_FRAME_PROPERTIES( previous_frame ), "progressive" );
126 // Check that we aren't already progressive
127 if ( !error && previous_image && !progressive )
129 // OK, now we know we have work to do and can request the image in our format
130 frame->convert_image( previous_frame, &previous_image, format, mlt_image_yuv422 );
132 // Get the current frame's image
133 *format = mlt_image_yuv422;
134 error = mlt_frame_get_image( frame, image, format, width, height, 0 );
136 if ( !error && *image && *format == mlt_image_yuv422 )
138 // Get the following frame's image
139 error = mlt_frame_get_image( next_frame, &next_image, format, &next_width, &next_height, 0 );
141 if ( !error && next_image && *format == mlt_image_yuv422 )
143 yadif_filter *yadif = init_yadif( *width, *height );
146 const int order = mlt_properties_get_int( properties, "top_field_first" );
147 const int pitch = *width << 1;
148 const int parity = 0;
150 // Convert packed to planar
151 YUY2ToPlanes( *image, pitch, *width, *height, yadif->ysrc,
152 yadif->ypitch, yadif->usrc, yadif->vsrc, yadif->uvpitch, yadif->cpu );
153 YUY2ToPlanes( previous_image, pitch, *width, *height, yadif->yprev,
154 yadif->ypitch, yadif->uprev, yadif->vprev, yadif->uvpitch, yadif->cpu );
155 YUY2ToPlanes( next_image, pitch, *width, *height, yadif->ynext,
156 yadif->ypitch, yadif->unext, yadif->vnext, yadif->uvpitch, yadif->cpu );
158 // Deinterlace each plane
159 filter_plane( mode, yadif->ydest, yadif->ypitch, yadif->yprev, yadif->ysrc,
160 yadif->ynext, yadif->ypitch, *width, *height, parity, order, yadif->cpu);
161 filter_plane( mode, yadif->udest, yadif->uvpitch,yadif->uprev, yadif->usrc,
162 yadif->unext, yadif->uvpitch, *width >> 1, *height, parity, order, yadif->cpu);
163 filter_plane( mode, yadif->vdest, yadif->uvpitch, yadif->vprev, yadif->vsrc,
164 yadif->vnext, yadif->uvpitch, *width >> 1, *height, parity, order, yadif->cpu);
166 // Convert planar to packed
167 YUY2FromPlanes( *image, pitch, *width, *height, yadif->ydest,
168 yadif->ypitch, yadif->udest, yadif->vdest, yadif->uvpitch, yadif->cpu);
170 close_yadif( yadif );
177 // Get the current frame's image
178 error = mlt_frame_get_image( frame, image, format, width, height, 0 );
186 static int filter_get_image( mlt_frame frame, uint8_t **image, mlt_image_format *format, int *width, int *height, int writable )
189 mlt_filter filter = mlt_frame_pop_service( frame );
190 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
191 int deinterlace = mlt_properties_get_int( properties, "consumer_deinterlace" );
192 // The progressive var should only represent the frame's original state and not the state
193 // as modified by this filter!
194 int progressive = mlt_properties_get_int( properties, "progressive" );
195 // At this point - before image was requested - (progressive == 0) cannot be trusted because
196 // some producers (avformat) do not yet know.
198 if ( deinterlace && !mlt_properties_get_int( properties, "test_image" ) )
200 // Determine deinterlace method
201 char *method_str = mlt_properties_get( MLT_FILTER_PROPERTIES( filter ), "method" );
202 int method = DEINTERLACE_NONE;
203 char *frame_method_str = mlt_properties_get( properties, "deinterlace_method" );
205 if ( frame_method_str )
206 method_str = frame_method_str;
208 if ( !method_str || strcmp( method_str, "yadif" ) == 0 )
209 method = DEINTERLACE_YADIF;
210 else if ( strcmp( method_str, "yadif-nospatial" ) == 0 )
211 method = DEINTERLACE_YADIF_NOSPATIAL;
212 else if ( strcmp( method_str, "onefield" ) == 0 )
213 method = DEINTERLACE_ONEFIELD;
214 else if ( strcmp( method_str, "linearblend" ) == 0 )
215 method = DEINTERLACE_LINEARBLEND;
216 else if ( strcmp( method_str, "bob" ) == 0 )
217 method = DEINTERLACE_BOB;
218 else if ( strcmp( method_str, "weave" ) == 0 )
219 method = DEINTERLACE_BOB;
220 else if ( strcmp( method_str, "greedy" ) == 0 )
221 method = DEINTERLACE_GREEDY;
223 // Some producers like pixbuf want rescale_width & _height, but will not get them if you request
224 // the previous image first. So, on the first iteration, we use linearblend.
225 if ( ( method == DEINTERLACE_YADIF || method == DEINTERLACE_YADIF_NOSPATIAL ) &&
226 !mlt_properties_get_int( MLT_FILTER_PROPERTIES(filter), "_notfirst" ) )
228 mlt_properties_set_int( MLT_FILTER_PROPERTIES(filter), "_notfirst", 1 );
229 method = DEINTERLACE_LINEARBLEND;
233 if ( method == DEINTERLACE_YADIF )
235 error = deinterlace_yadif( frame, filter, image, format, width, height, YADIF_MODE_TEMPORAL_SPATIAL );
237 else if ( method == DEINTERLACE_YADIF_NOSPATIAL )
239 error = deinterlace_yadif( frame, filter, image, format, width, height, YADIF_MODE_TEMPORAL );
241 if ( error || ( method > DEINTERLACE_NONE && method < DEINTERLACE_YADIF ) )
243 mlt_service service = mlt_properties_get_data( MLT_FILTER_PROPERTIES(filter), "service", NULL );
245 // Get the current frame's image
246 int error2 = mlt_frame_get_image( frame, image, format, width, height, writable );
247 progressive = mlt_properties_get_int( properties, "progressive" );
251 method = DEINTERLACE_LINEARBLEND;
252 // If YADIF requested, prev/next cancelled because some previous frames were progressive,
253 // but new frames are interlaced, then turn prev/next frames back on.
255 mlt_properties_set_int( MLT_SERVICE_PROPERTIES(service), "_need_previous_next", 1 );
259 // Signal that we no longer need previous and next frames
260 mlt_properties_set_int( MLT_SERVICE_PROPERTIES(service), "_need_previous_next", 0 );
264 if ( !error && !progressive )
266 // OK, now we know we have work to do and can request the image in our format
267 error = frame->convert_image( frame, image, format, mlt_image_yuv422 );
269 // Check that we aren't already progressive
270 if ( !error && *image && *format == mlt_image_yuv422 )
272 // Deinterlace the image using one of the Xine deinterlacers
273 int image_size = *width * *height * 2;
274 uint8_t *new_image = mlt_pool_alloc( image_size );
276 deinterlace_yuv( new_image, image, *width * 2, *height, method );
277 mlt_frame_set_image( frame, new_image, image_size, mlt_pool_release );
282 else if ( method == DEINTERLACE_NONE )
284 error = mlt_frame_get_image( frame, image, format, width, height, writable );
287 // update progressive flag after having obtained image
288 progressive = mlt_properties_get_int( properties, "progressive" );
290 mlt_log_debug( MLT_FILTER_SERVICE( filter ), "error %d deint %d prog %d fmt %s method %s\n",
291 error, deinterlace, progressive, mlt_image_format_name( *format ), method_str ? method_str : "yadif" );
295 // Make sure that others know the frame is deinterlaced
296 mlt_properties_set_int( properties, "progressive", 1 );
302 error = mlt_frame_get_image( frame, image, format, width, height, writable );
305 if ( !deinterlace || progressive )
307 // Signal that we no longer need previous and next frames
308 mlt_service service = mlt_properties_get_data( MLT_FILTER_PROPERTIES(filter), "service", NULL );
310 mlt_properties_set_int( MLT_SERVICE_PROPERTIES(service), "_need_previous_next", 0 );
316 /** Deinterlace filter processing - this should be lazy evaluation here...
319 static mlt_frame deinterlace_process( mlt_filter filter, mlt_frame frame )
321 // Push filter on to the service stack
322 mlt_frame_push_service( frame, filter );
324 // Push the get_image method on to the stack
325 mlt_frame_push_get_image( frame, filter_get_image );
330 static void on_service_changed( mlt_service owner, mlt_service filter )
332 mlt_service service = mlt_properties_get_data( MLT_SERVICE_PROPERTIES(filter), "service", NULL );
333 mlt_properties_set_int( MLT_SERVICE_PROPERTIES(service), "_need_previous_next", 1 );
336 /** Constructor for the filter.
339 mlt_filter filter_deinterlace_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
341 mlt_filter filter = mlt_filter_new( );
342 if ( filter != NULL )
344 filter->process = deinterlace_process;
345 mlt_properties_set( MLT_FILTER_PROPERTIES( filter ), "method", arg );
346 mlt_events_listen( MLT_FILTER_PROPERTIES( filter ), filter, "service-changed", (mlt_listener) on_service_changed );