2 * transition_luma.c -- a generic dissolve/wipe processor
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Dan Dennedy <dan@dennedy.org>
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 "transition_luma.h"
22 #include <framework/mlt.h>
30 /** Calculate the position for this frame.
33 static float position_calculate( mlt_transition this, mlt_frame frame )
35 // Get the in and out position
36 mlt_position in = mlt_transition_get_in( this );
37 mlt_position out = mlt_transition_get_out( this );
39 // Get the position of the frame
40 char *name = mlt_properties_get( MLT_TRANSITION_PROPERTIES( this ), "_unique_id" );
41 mlt_position position = mlt_properties_get_position( MLT_FRAME_PROPERTIES( frame ), name );
44 return ( float )( position - in ) / ( float )( out - in + 1 );
47 /** Calculate the field delta for this frame - position between two frames.
50 static float delta_calculate( mlt_transition this, mlt_frame frame )
52 // Get the in and out position
53 mlt_position in = mlt_transition_get_in( this );
54 mlt_position out = mlt_transition_get_out( this );
56 // Get the position of the frame
57 mlt_position position = mlt_frame_get_position( frame );
60 float x = ( float )( position - in ) / ( float )( out - in + 1 );
61 float y = ( float )( position + 1 - in ) / ( float )( out - in + 1 );
63 return ( y - x ) / 2.0;
66 static inline int dissolve_yuv( mlt_frame this, mlt_frame that, float weight, int width, int height )
69 int width_src = width, height_src = height;
70 mlt_image_format format = mlt_image_yuv422;
71 uint8_t *p_src, *p_dest;
75 int32_t weigh = weight * ( 1 << 16 );
76 int32_t weigh_complement = ( 1 - weight ) * ( 1 << 16 );
78 if ( mlt_properties_get( &this->parent, "distort" ) )
79 mlt_properties_set( &that->parent, "distort", mlt_properties_get( &this->parent, "distort" ) );
80 mlt_properties_set_int( &that->parent, "consumer_deinterlace", mlt_properties_get_int( &this->parent, "consumer_deinterlace" ) );
81 mlt_frame_get_image( this, &p_dest, &format, &width, &height, 1 );
82 mlt_frame_get_image( that, &p_src, &format, &width_src, &height_src, 0 );
84 // Pick the lesser of two evils ;-)
85 width_src = width_src > width ? width : width_src;
86 height_src = height_src > height ? height : height_src;
89 limit = p_dest + height_src * width_src * 2;
93 *p_dest++ = ( *p_src++ * weigh + *p++ * weigh_complement ) >> 16;
94 *p_dest++ = ( *p_src++ * weigh + *p++ * weigh_complement ) >> 16;
100 // image processing functions
102 static inline int32_t smoothstep( int32_t edge1, int32_t edge2, uint32_t a )
110 a = ( ( a - edge1 ) << 16 ) / ( edge2 - edge1 );
112 return ( ( ( a * a ) >> 16 ) * ( ( 3 << 16 ) - ( 2 * a ) ) ) >> 16;
117 \param field_order -1 = progressive, 0 = lower field first, 1 = top field first
119 static void luma_composite( mlt_frame a_frame, mlt_frame b_frame, int luma_width, int luma_height,
120 uint16_t *luma_bitmap, float pos, float frame_delta, float softness, int field_order,
121 int *width, int *height )
123 int width_src = *width, height_src = *height;
124 int width_dest = *width, height_dest = *height;
125 mlt_image_format format_src = mlt_image_yuv422, format_dest = mlt_image_yuv422;
126 uint8_t *p_src, *p_dest;
132 format_src = mlt_image_yuv422;
133 format_dest = mlt_image_yuv422;
135 if ( mlt_properties_get( &a_frame->parent, "distort" ) )
136 mlt_properties_set( &b_frame->parent, "distort", mlt_properties_get( &a_frame->parent, "distort" ) );
137 mlt_properties_set_int( &b_frame->parent, "consumer_deinterlace", mlt_properties_get_int( &a_frame->parent, "consumer_deinterlace" ) );
138 mlt_frame_get_image( a_frame, &p_dest, &format_dest, &width_dest, &height_dest, 1 );
139 mlt_frame_get_image( b_frame, &p_src, &format_src, &width_src, &height_src, 0 );
141 // Pick the lesser of two evils ;-)
142 width_src = width_src > width_dest ? width_dest : width_src;
143 height_src = height_src > height_dest ? height_dest : height_src;
145 stride_src = width_src * 2;
146 stride_dest = width_dest * 2;
148 // Offset the position based on which field we're looking at ...
149 int32_t field_pos[ 2 ];
150 field_pos[ 0 ] = ( pos + ( ( field_order == 0 ? 1 : 0 ) * frame_delta * 0.5 ) ) * ( 1 << 16 ) * ( 1.0 + softness );
151 field_pos[ 1 ] = ( pos + ( ( field_order == 0 ? 0 : 1 ) * frame_delta * 0.5 ) ) * ( 1 << 16 ) * ( 1.0 + softness );
160 int32_t x_diff = ( luma_width << 16 ) / *width;
161 int32_t y_diff = ( luma_height << 16 ) / *height;
162 int32_t x_offset = 0;
163 int32_t y_offset = 0;
167 int32_t i_softness = softness * ( 1 << 16 );
169 int field_count = field_order < 0 ? 1 : 2;
170 int field_stride_src = field_count * stride_src;
171 int field_stride_dest = field_count * stride_dest;
174 // composite using luma map
175 while ( field < field_count )
177 p_row = p_src + field * stride_src;
178 q_row = p_dest + field * stride_dest;
179 y_offset = field << 16;
182 while ( i < height_src )
187 l = luma_bitmap + ( y_offset >> 16 ) * ( luma_width * field_count );
193 weight = l[ x_offset >> 16 ];
194 value = smoothstep( weight, i_softness + weight, field_pos[ field ] );
195 *o ++ = ( *p ++ * value + *q++ * ( ( 1 << 16 ) - value ) ) >> 16;
196 *o ++ = ( *p ++ * value + *q++ * ( ( 1 << 16 ) - value ) ) >> 16;
202 p_row += field_stride_src;
203 q_row += field_stride_dest;
210 /** Load the luma map from PGM stream.
213 static void luma_read_pgm( FILE *f, uint16_t **map, int *width, int *height )
215 uint8_t *data = NULL;
227 // get the magic code
228 if ( fgets( line, 127, f ) == NULL )
232 while ( sscanf( line, " #%s", comment ) > 0 )
233 if ( fgets( line, 127, f ) == NULL )
236 if ( line[0] != 'P' || line[1] != '5' )
239 // skip white space and see if a new line must be fetched
240 for ( i = 2; i < 127 && line[i] != '\0' && isspace( line[i] ); i++ );
241 if ( ( line[i] == '\0' || line[i] == '#' ) && fgets( line, 127, f ) == NULL )
245 while ( sscanf( line, " #%s", comment ) > 0 )
246 if ( fgets( line, 127, f ) == NULL )
249 // get the dimensions
250 if ( line[0] == 'P' )
251 i = sscanf( line, "P5 %d %d %d", width, height, &maxval );
253 i = sscanf( line, "%d %d %d", width, height, &maxval );
255 // get the height value, if not yet
258 if ( fgets( line, 127, f ) == NULL )
262 while ( sscanf( line, " #%s", comment ) > 0 )
263 if ( fgets( line, 127, f ) == NULL )
266 i = sscanf( line, "%d", height );
273 // get the maximum gray value, if not yet
276 if ( fgets( line, 127, f ) == NULL )
280 while ( sscanf( line, " #%s", comment ) > 0 )
281 if ( fgets( line, 127, f ) == NULL )
284 i = sscanf( line, "%d", &maxval );
289 // determine if this is one or two bytes per pixel
290 bpp = maxval > 255 ? 2 : 1;
292 // allocate temporary storage for the raw data
293 data = mlt_pool_alloc( *width * *height * bpp );
298 if ( fread( data, *width * *height * bpp, 1, f ) != 1 )
301 // allocate the luma bitmap
302 *map = p = (uint16_t*)mlt_pool_alloc( *width * *height * sizeof( uint16_t ) );
306 // proces the raw data into the luma bitmap
307 for ( i = 0; i < *width * *height * bpp; i += bpp )
310 *p++ = data[ i ] << 8;
312 *p++ = ( data[ i ] << 8 ) + data[ i+1 ];
319 mlt_pool_release( data );
322 /** Generate a luma map from an RGB image.
325 static void luma_read_yuv422( uint8_t *image, uint16_t **map, int width, int height )
329 // allocate the luma bitmap
330 uint16_t *p = *map = ( uint16_t* )mlt_pool_alloc( width * height * sizeof( uint16_t ) );
334 // proces the image data into the luma bitmap
335 for ( i = 0; i < width * height * 2; i += 2 )
336 *p++ = ( image[ i ] - 16 ) * 299; // 299 = 65535 / 219
339 /** Generate a luma map from a YUV image.
341 static void luma_read_rgb24( uint8_t *image, uint16_t **map, int width, int height )
348 static int transition_get_image( mlt_frame a_frame, uint8_t **image, mlt_image_format *format, int *width, int *height, int writable )
350 // Get the b frame from the stack
351 mlt_frame b_frame = mlt_frame_pop_frame( a_frame );
353 // Get the transition object
354 mlt_transition transition = mlt_frame_pop_service( a_frame );
356 // Get the properties of the transition
357 mlt_properties properties = MLT_TRANSITION_PROPERTIES( transition );
359 // Get the properties of the a frame
360 mlt_properties a_props = MLT_FRAME_PROPERTIES( a_frame );
362 // Get the properties of the b frame
363 mlt_properties b_props = MLT_FRAME_PROPERTIES( b_frame );
365 // The cached luma map information
366 int luma_width = mlt_properties_get_int( properties, "width" );
367 int luma_height = mlt_properties_get_int( properties, "height" );
368 uint16_t *luma_bitmap = mlt_properties_get_data( properties, "bitmap", NULL );
370 // If the filename property changed, reload the map
371 char *resource = mlt_properties_get( properties, "resource" );
373 if ( luma_bitmap == NULL && resource != NULL )
376 char *extension = strrchr( resource, '.' );
378 if ( strchr( resource, '%' ) )
380 sprintf( temp, "%s/lumas/%s/%s", mlt_factory_prefix( ), mlt_environment( "MLT_NORMALISATION" ), strchr( resource, '%' ) + 1 );
382 extension = strrchr( resource, '.' );
385 // See if it is a PGM
386 if ( extension != NULL && strcmp( extension, ".pgm" ) == 0 )
389 FILE *f = fopen( resource, "r" );
393 luma_read_pgm( f, &luma_bitmap, &luma_width, &luma_height );
396 // Set the transition properties
397 mlt_properties_set_int( properties, "width", luma_width );
398 mlt_properties_set_int( properties, "height", luma_height );
399 mlt_properties_set_data( properties, "bitmap", luma_bitmap, luma_width * luma_height * 2, mlt_pool_release, NULL );
404 // Get the factory producer service
405 char *factory = mlt_properties_get( properties, "factory" );
407 // Create the producer
408 mlt_producer producer = mlt_factory_producer( factory, resource );
411 if ( producer != NULL )
413 // Get the producer properties
414 mlt_properties producer_properties = MLT_PRODUCER_PROPERTIES( producer );
416 // Ensure that we loop
417 mlt_properties_set( producer_properties, "eof", "loop" );
419 // Now pass all producer. properties on the transition down
420 mlt_properties_pass( producer_properties, properties, "producer." );
422 // We will get the alpha frame from the producer
423 mlt_frame luma_frame = NULL;
425 // Get the luma frame
426 if ( mlt_service_get_frame( MLT_PRODUCER_SERVICE( producer ), &luma_frame, 0 ) == 0 )
429 mlt_image_format luma_format = mlt_image_yuv422;
431 // Get image from the luma producer
432 mlt_properties_set( MLT_FRAME_PROPERTIES( luma_frame ), "rescale.interp", "none" );
433 mlt_frame_get_image( luma_frame, &luma_image, &luma_format, &luma_width, &luma_height, 0 );
435 // Generate the luma map
436 if ( luma_image != NULL && luma_format == mlt_image_yuv422 )
437 luma_read_yuv422( luma_image, &luma_bitmap, luma_width, luma_height );
439 else if ( luma_image != NULL && luma_format == mlt_image_rgb24 )
440 luma_read_rgb24( luma_image, &luma_bitmap, luma_width, luma_height );
442 // Set the transition properties
443 mlt_properties_set_int( properties, "width", luma_width );
444 mlt_properties_set_int( properties, "height", luma_height );
445 mlt_properties_set_data( properties, "bitmap", luma_bitmap, luma_width * luma_height * 2, mlt_pool_release, NULL );
447 // Cleanup the luma frame
448 mlt_frame_close( luma_frame );
451 // Cleanup the luma producer
452 mlt_producer_close( producer );
457 // Arbitrary composite defaults
458 float mix = position_calculate( transition, a_frame );
459 float frame_delta = delta_calculate( transition, a_frame );
461 float luma_softness = mlt_properties_get_double( properties, "softness" );
463 mlt_properties_get_int( a_props, "consumer_deinterlace" ) ||
464 mlt_properties_get_int( properties, "progressive" ) ||
465 mlt_properties_get_int( b_props, "luma.progressive" );
466 int top_field_first = mlt_properties_get_int( b_props, "top_field_first" );
467 int reverse = mlt_properties_get_int( properties, "reverse" );
468 int invert = mlt_properties_get_int( properties, "invert" );
470 if ( mlt_properties_get( a_props, "rescale.interp" ) == NULL )
471 mlt_properties_set( a_props, "rescale.interp", "nearest" );
473 // Since we are the consumer of the b_frame, we must pass along this
474 // consumer property from the a_frame
475 if ( !strcmp( mlt_properties_get( a_props, "rescale.interp" ), "none" ) )
476 mlt_properties_set_double( b_props, "consumer_aspect_ratio", mlt_properties_get_double( a_props, "aspect_ratio" ) );
478 mlt_properties_set_double( b_props, "consumer_aspect_ratio", mlt_properties_get_double( a_props, "consumer_aspect_ratio" ) );
480 // Honour the reverse here
484 mix = reverse || invert ? 1 - mix : mix;
485 frame_delta *= reverse || invert ? -1.0 : 1.0;
487 // Ensure we get scaling on the b_frame
488 mlt_properties_set( b_props, "rescale.interp", "nearest" );
490 if ( mlt_properties_get( properties, "fixed" ) )
491 mix = mlt_properties_get_double( properties, "fixed" );
493 if ( luma_width > 0 && luma_height > 0 && luma_bitmap != NULL )
494 // Composite the frames using a luma map
495 luma_composite( !invert ? a_frame : b_frame, !invert ? b_frame : a_frame, luma_width, luma_height, luma_bitmap, mix, frame_delta,
496 luma_softness, progressive ? -1 : top_field_first, width, height );
498 // Dissolve the frames using the time offset for mix value
499 dissolve_yuv( a_frame, b_frame, mix, *width, *height );
501 // Extract the a_frame image info
502 *width = mlt_properties_get_int( !invert ? a_props : b_props, "width" );
503 *height = mlt_properties_get_int( !invert ? a_props : b_props, "height" );
504 *image = mlt_properties_get_data( !invert ? a_props : b_props, "image", NULL );
510 /** Luma transition processing.
513 static mlt_frame transition_process( mlt_transition transition, mlt_frame a_frame, mlt_frame b_frame )
515 // Get a unique name to store the frame position
516 char *name = mlt_properties_get( MLT_TRANSITION_PROPERTIES( transition ), "_unique_id" );
518 // Assign the current position to the name
519 mlt_properties_set_position( MLT_FRAME_PROPERTIES( a_frame ), name, mlt_frame_get_position( a_frame ) );
521 // Push the transition on to the frame
522 mlt_frame_push_service( a_frame, transition );
524 // Push the b_frame on to the stack
525 mlt_frame_push_frame( a_frame, b_frame );
527 // Push the transition method
528 mlt_frame_push_get_image( a_frame, transition_get_image );
533 /** Constructor for the filter.
536 mlt_transition transition_luma_init( char *lumafile )
538 mlt_transition transition = mlt_transition_new( );
539 if ( transition != NULL )
542 transition->process = transition_process;
545 mlt_properties_set( MLT_TRANSITION_PROPERTIES( transition ), "factory", "fezzik" );
547 // Set the main property
548 mlt_properties_set( MLT_TRANSITION_PROPERTIES( transition ), "resource", lumafile );