2 * transition_composite.c -- compose one image over another using alpha channel
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Dan Dennedy <dan@dennedy.org>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library 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 GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include "transition_composite.h"
22 #include <framework/mlt.h>
30 typedef void ( *composite_line_fn )( uint8_t *dest, uint8_t *src, int width_src, uint8_t *alpha_b, uint8_t *alpha_a, int weight, uint16_t *luma, int softness, uint32_t step );
37 struct mlt_geometry_item_s item;
38 int nw; // normalised width
39 int nh; // normalised height
40 int sw; // scaled width, not including consumer scale based upon w/nw
41 int sh; // scaled height, not including consumer scale based upon h/nh
42 int halign; // horizontal alignment: 0=left, 1=center, 2=right
43 int valign; // vertical alignment: 0=top, 1=middle, 2=bottom
48 /** Parse the alignment properties into the geometry.
51 static int alignment_parse( char* align )
56 else if ( isdigit( align[ 0 ] ) )
58 else if ( align[ 0 ] == 'c' || align[ 0 ] == 'm' )
60 else if ( align[ 0 ] == 'r' || align[ 0 ] == 'b' )
66 /** Calculate real geometry.
69 static void geometry_calculate( mlt_transition this, struct geometry_s *output, double position )
71 mlt_properties properties = MLT_TRANSITION_PROPERTIES( this );
72 mlt_geometry geometry = mlt_properties_get_data( properties, "geometries", NULL );
73 int mirror_off = mlt_properties_get_int( properties, "mirror_off" );
74 int repeat_off = mlt_properties_get_int( properties, "repeat_off" );
75 int length = mlt_geometry_get_length( geometry );
78 if ( !repeat_off && position >= length && length != 0 )
80 int section = position / length;
81 position -= section * length;
82 if ( !mirror_off && section % 2 == 1 )
83 position = length - position;
86 // Fetch the key for the position
87 mlt_geometry_fetch( geometry, &output->item, position );
90 static mlt_geometry transition_parse_keys( mlt_transition this, int normalised_width, int normalised_height )
92 // Loop variable for property interrogation
95 // Get the properties of the transition
96 mlt_properties properties = MLT_TRANSITION_PROPERTIES( this );
98 // Create an empty geometries object
99 mlt_geometry geometry = mlt_geometry_init( );
101 // Get the in and out position
102 mlt_position in = mlt_transition_get_in( this );
103 mlt_position out = mlt_transition_get_out( this );
104 int length = out - in + 1;
105 double cycle = mlt_properties_get_double( properties, "cycle" );
107 // Get the new style geometry string
108 char *property = mlt_properties_get( properties, "geometry" );
110 // Allow a geometry repeat cycle
113 else if ( cycle > 0 )
116 // Parse the geometry if we have one
117 mlt_geometry_parse( geometry, property, length, normalised_width, normalised_height );
119 // Check if we're using the old style geometry
120 if ( property == NULL )
122 // DEPRECATED: Multiple keys for geometry information is inefficient and too rigid for
123 // practical use - while deprecated, it has been slightly extended too - keys can now
124 // be specified out of order, and can be blanked or NULL to simulate removal
126 // Structure to use for parsing and inserting
127 struct mlt_geometry_item_s item;
129 // Parse the start property
131 if ( mlt_geometry_parse_item( geometry, &item, mlt_properties_get( properties, "start" ) ) == 0 )
132 mlt_geometry_insert( geometry, &item );
134 // Parse the keys in between
135 for ( i = 0; i < mlt_properties_count( properties ); i ++ )
137 // Get the name of the property
138 char *name = mlt_properties_get_name( properties, i );
140 // Check that it's valid
141 if ( !strncmp( name, "key[", 4 ) )
143 // Get the value of the property
144 char *value = mlt_properties_get_value( properties, i );
146 // Determine the frame number
147 item.frame = atoi( name + 4 );
149 // Parse and add to the list
150 if ( mlt_geometry_parse_item( geometry, &item, value ) == 0 )
151 mlt_geometry_insert( geometry, &item );
153 fprintf( stderr, "Invalid Key - skipping %s = %s\n", name, value );
159 if ( mlt_geometry_parse_item( geometry, &item, mlt_properties_get( properties, "end" ) ) == 0 )
160 mlt_geometry_insert( geometry, &item );
166 /** Adjust position according to scaled size and alignment properties.
169 static void alignment_calculate( struct geometry_s *geometry )
171 geometry->item.x += ( geometry->item.w - geometry->sw ) * geometry->halign / 2;
172 geometry->item.y += ( geometry->item.h - geometry->sh ) * geometry->valign / 2;
175 /** Calculate the position for this frame.
178 static int position_calculate( mlt_transition this, mlt_position position )
180 // Get the in and out position
181 mlt_position in = mlt_transition_get_in( this );
184 return position - in;
187 /** Calculate the field delta for this frame - position between two frames.
190 static inline double delta_calculate( mlt_transition this, mlt_frame frame, mlt_position position )
192 // Get the in and out position
193 mlt_position in = mlt_transition_get_in( this );
194 mlt_position out = mlt_transition_get_out( this );
195 double length = out - in + 1;
198 double x = ( double )( position - in ) / length;
199 double y = ( double )( position + 1 - in ) / length;
201 return length * ( y - x ) / 2.0;
204 static int get_value( mlt_properties properties, const char *preferred, const char *fallback )
206 int value = mlt_properties_get_int( properties, preferred );
208 value = mlt_properties_get_int( properties, fallback );
212 /** A linear threshold determination function.
215 static inline int32_t linearstep( int32_t edge1, int32_t edge2, int32_t a )
223 return ( ( a - edge1 ) << 16 ) / ( edge2 - edge1 );
226 /** A smoother, non-linear threshold determination function.
229 static inline int32_t smoothstep( int32_t edge1, int32_t edge2, uint32_t a )
237 a = ( ( a - edge1 ) << 16 ) / ( edge2 - edge1 );
239 return ( ( ( a * a ) >> 16 ) * ( ( 3 << 16 ) - ( 2 * a ) ) ) >> 16;
242 /** Load the luma map from PGM stream.
245 static void luma_read_pgm( FILE *f, uint16_t **map, int *width, int *height )
247 uint8_t *data = NULL;
259 // get the magic code
260 if ( fgets( line, 127, f ) == NULL )
264 while ( sscanf( line, " #%s", comment ) > 0 )
265 if ( fgets( line, 127, f ) == NULL )
268 if ( line[0] != 'P' || line[1] != '5' )
271 // skip white space and see if a new line must be fetched
272 for ( i = 2; i < 127 && line[i] != '\0' && isspace( line[i] ); i++ );
273 if ( ( line[i] == '\0' || line[i] == '#' ) && fgets( line, 127, f ) == NULL )
277 while ( sscanf( line, " #%s", comment ) > 0 )
278 if ( fgets( line, 127, f ) == NULL )
281 // get the dimensions
282 if ( line[0] == 'P' )
283 i = sscanf( line, "P5 %d %d %d", width, height, &maxval );
285 i = sscanf( line, "%d %d %d", width, height, &maxval );
287 // get the height value, if not yet
290 if ( fgets( line, 127, f ) == NULL )
294 while ( sscanf( line, " #%s", comment ) > 0 )
295 if ( fgets( line, 127, f ) == NULL )
298 i = sscanf( line, "%d", height );
305 // get the maximum gray value, if not yet
308 if ( fgets( line, 127, f ) == NULL )
312 while ( sscanf( line, " #%s", comment ) > 0 )
313 if ( fgets( line, 127, f ) == NULL )
316 i = sscanf( line, "%d", &maxval );
321 // determine if this is one or two bytes per pixel
322 bpp = maxval > 255 ? 2 : 1;
324 // allocate temporary storage for the raw data
325 data = mlt_pool_alloc( *width * *height * bpp );
330 if ( fread( data, *width * *height * bpp, 1, f ) != 1 )
333 // allocate the luma bitmap
334 *map = p = (uint16_t*)mlt_pool_alloc( *width * *height * sizeof( uint16_t ) );
338 // proces the raw data into the luma bitmap
339 for ( i = 0; i < *width * *height * bpp; i += bpp )
342 *p++ = data[ i ] << 8;
344 *p++ = ( data[ i ] << 8 ) + data[ i + 1 ];
351 mlt_pool_release( data );
354 /** Generate a luma map from any YUV image.
357 static void luma_read_yuv422( uint8_t *image, uint16_t **map, int width, int height )
361 // allocate the luma bitmap
362 uint16_t *p = *map = ( uint16_t* )mlt_pool_alloc( width * height * sizeof( uint16_t ) );
366 // proces the image data into the luma bitmap
367 for ( i = 0; i < width * height * 2; i += 2 )
368 *p++ = ( image[ i ] - 16 ) * 299; // 299 = 65535 / 219
371 static inline int calculate_mix( uint16_t *luma, int j, int softness, int weight, int alpha, uint32_t step )
373 return ( ( luma ? smoothstep( luma[ j ], luma[ j ] + softness, step ) : weight ) * alpha ) >> 8;
376 static inline uint8_t sample_mix( uint8_t dest, uint8_t src, int mix )
378 return ( src * mix + dest * ( ( 1 << 16 ) - mix ) ) >> 16;
381 /** Composite a source line over a destination line
384 static void composite_line_yuv( uint8_t *dest, uint8_t *src, int width, uint8_t *alpha_b, uint8_t *alpha_a, int weight, uint16_t *luma, int soft, uint32_t step )
389 for ( j = 0; j < width; j ++ )
391 mix = calculate_mix( luma, j, soft, weight, *alpha_b ++, step );
392 *dest = sample_mix( *dest, *src++, mix );
394 *dest = sample_mix( *dest, *src++, mix );
396 *alpha_a = ( mix >> 8 ) | *alpha_a;
401 static void composite_line_yuv_or( uint8_t *dest, uint8_t *src, int width, uint8_t *alpha_b, uint8_t *alpha_a, int weight, uint16_t *luma, int soft, uint32_t step )
406 for ( j = 0; j < width; j ++ )
408 mix = calculate_mix( luma, j, soft, weight, *alpha_b ++ | *alpha_a, step );
409 *dest = sample_mix( *dest, *src++, mix );
411 *dest = sample_mix( *dest, *src++, mix );
413 *alpha_a ++ = mix >> 8;
417 static void composite_line_yuv_and( uint8_t *dest, uint8_t *src, int width, uint8_t *alpha_b, uint8_t *alpha_a, int weight, uint16_t *luma, int soft, uint32_t step )
422 for ( j = 0; j < width; j ++ )
424 mix = calculate_mix( luma, j, soft, weight, *alpha_b ++ & *alpha_a, step );
425 *dest = sample_mix( *dest, *src++, mix );
427 *dest = sample_mix( *dest, *src++, mix );
429 *alpha_a ++ = mix >> 8;
433 static void composite_line_yuv_xor( uint8_t *dest, uint8_t *src, int width, uint8_t *alpha_b, uint8_t *alpha_a, int weight, uint16_t *luma, int soft, uint32_t step )
438 for ( j = 0; j < width; j ++ )
440 mix = calculate_mix( luma, j, soft, weight, *alpha_b ++ ^ *alpha_a, step );
441 *dest = sample_mix( *dest, *src++, mix );
443 *dest = sample_mix( *dest, *src++, mix );
445 *alpha_a ++ = mix >> 8;
449 /** Composite function.
452 static int composite_yuv( uint8_t *p_dest, int width_dest, int height_dest, uint8_t *p_src, int width_src, int height_src, uint8_t *alpha_b, uint8_t *alpha_a, struct geometry_s geometry, int field, uint16_t *p_luma, double softness, composite_line_fn line_fn )
456 int x_src = -geometry.x_src, y_src = -geometry.y_src;
457 int uneven_x_src = ( x_src % 2 );
458 int step = ( field > -1 ) ? 2 : 1;
460 int stride_src = geometry.sw * bpp;
461 int stride_dest = width_dest * bpp;
462 int i_softness = ( 1 << 16 ) * softness;
463 int weight = ( ( 1 << 16 ) - 1 ) * geometry.item.mix / 100;
464 uint32_t luma_step = ( ( 1 << 16 ) - 1 ) * geometry.item.mix / 100 * ( 1.0 + softness );
466 // Adjust to consumer scale
467 int x = rint( geometry.item.x * width_dest / geometry.nw );
468 int y = rint( geometry.item.y * height_dest / geometry.nh );
469 int uneven_x = ( x % 2 );
471 // optimization points - no work to do
472 if ( width_src <= 0 || height_src <= 0 || y_src >= height_src || x_src >= width_src )
475 if ( ( x < 0 && -x >= width_src ) || ( y < 0 && -y >= height_src ) )
478 // cropping affects the source width
482 // and it implies cropping
483 if ( width_src > geometry.item.w )
484 width_src = geometry.item.w;
487 // cropping affects the source height
491 // and it implies cropping
492 if ( height_src > geometry.item.h )
493 height_src = geometry.item.h;
496 // crop overlay off the left edge of frame
504 // crop overlay beyond right edge of frame
505 if ( x + width_src > width_dest )
506 width_src = width_dest - x;
508 // crop overlay off the top edge of the frame
516 // crop overlay below bottom edge of frame
517 if ( y + height_src > height_dest )
518 height_src = height_dest - y;
520 // offset pointer into overlay buffer based on cropping
521 p_src += x_src * bpp + y_src * stride_src;
523 // offset pointer into frame buffer based upon positive coordinates only!
524 p_dest += ( x < 0 ? 0 : x ) * bpp + ( y < 0 ? 0 : y ) * stride_dest;
526 // offset pointer into alpha channel based upon cropping
527 alpha_b += x_src + y_src * stride_src / bpp;
528 alpha_a += x + y * stride_dest / bpp;
530 // offset pointer into luma channel based upon cropping
532 p_luma += x_src + y_src * stride_src / bpp;
534 // Assuming lower field first
535 // Special care is taken to make sure the b_frame is aligned to the correct field.
536 // field 0 = lower field and y should be odd (y is 0-based).
537 // field 1 = upper field and y should be even.
538 if ( ( field > -1 ) && ( y % 2 == field ) )
540 if ( ( field == 1 && y < height_dest - 1 ) || ( field == 0 && y == 0 ) )
541 p_dest += stride_dest;
543 p_dest -= stride_dest;
546 // On the second field, use the other lines from b_frame
550 alpha_b += stride_src / bpp;
551 alpha_a += stride_dest / bpp;
557 int alpha_b_stride = stride_src / bpp;
558 int alpha_a_stride = stride_dest / bpp;
560 // Align chroma of source and destination
561 if ( uneven_x != uneven_x_src )
568 // now do the compositing only to cropped extents
569 for ( i = 0; i < height_src; i += step )
571 line_fn( p_dest, p_src, width_src, alpha_b, alpha_a, weight, p_luma, i_softness, luma_step );
574 p_dest += stride_dest;
575 alpha_b += alpha_b_stride;
576 alpha_a += alpha_a_stride;
578 p_luma += alpha_b_stride;
585 /** Scale 16bit greyscale luma map using nearest neighbor.
589 scale_luma ( uint16_t *dest_buf, int dest_width, int dest_height, const uint16_t *src_buf, int src_width, int src_height, int invert )
592 register int x_step = ( src_width << 16 ) / dest_width;
593 register int y_step = ( src_height << 16 ) / dest_height;
594 register int x, y = 0;
596 for ( i = 0; i < dest_height; i++ )
598 const uint16_t *src = src_buf + ( y >> 16 ) * src_width;
601 for ( j = 0; j < dest_width; j++ )
603 *dest_buf++ = src[ x >> 16 ] ^ invert;
610 static uint16_t* get_luma( mlt_transition this, mlt_properties properties, int width, int height )
612 // The cached luma map information
613 int luma_width = mlt_properties_get_int( properties, "_luma.width" );
614 int luma_height = mlt_properties_get_int( properties, "_luma.height" );
615 uint16_t *luma_bitmap = mlt_properties_get_data( properties, "_luma.bitmap", NULL );
616 int invert = mlt_properties_get_int( properties, "luma_invert" );
618 // If the filename property changed, reload the map
619 char *resource = mlt_properties_get( properties, "luma" );
623 if ( luma_width == 0 || luma_height == 0 )
626 luma_height = height;
629 if ( resource && resource[0] && strchr( resource, '%' ) )
631 // TODO: Clean up quick and dirty compressed/existence check
633 sprintf( temp, "%s/lumas/%s/%s", mlt_environment( "MLT_DATA" ), mlt_environment( "MLT_NORMALISATION" ), strchr( resource, '%' ) + 1 );
634 test = fopen( temp, "r" );
636 strcat( temp, ".png" );
642 if ( resource && resource[0] )
644 char *old_luma = mlt_properties_get( properties, "_luma" );
645 int old_invert = mlt_properties_get_int( properties, "_luma_invert" );
647 if ( invert != old_invert || ( old_luma && old_luma[0] && strcmp( resource, old_luma ) ) )
649 mlt_properties_set_data( properties, "_luma.orig_bitmap", NULL, 0, NULL, NULL );
654 char *old_luma = mlt_properties_get( properties, "_luma" );
655 if ( old_luma && old_luma[0] )
657 mlt_properties_set_data( properties, "_luma.orig_bitmap", NULL, 0, NULL, NULL );
659 mlt_properties_set( properties, "_luma", NULL);
663 if ( resource && resource[0] && ( luma_bitmap == NULL || luma_width != width || luma_height != height ) )
665 uint16_t *orig_bitmap = mlt_properties_get_data( properties, "_luma.orig_bitmap", NULL );
666 luma_width = mlt_properties_get_int( properties, "_luma.orig_width" );
667 luma_height = mlt_properties_get_int( properties, "_luma.orig_height" );
669 // Load the original luma once
670 if ( orig_bitmap == NULL )
672 char *extension = strrchr( resource, '.' );
674 // See if it is a PGM
675 if ( extension != NULL && strcmp( extension, ".pgm" ) == 0 )
678 FILE *f = fopen( resource, "r" );
682 luma_read_pgm( f, &orig_bitmap, &luma_width, &luma_height );
685 // Remember the original size for subsequent scaling
686 mlt_properties_set_data( properties, "_luma.orig_bitmap", orig_bitmap, luma_width * luma_height * 2, mlt_pool_release, NULL );
687 mlt_properties_set_int( properties, "_luma.orig_width", luma_width );
688 mlt_properties_set_int( properties, "_luma.orig_height", luma_height );
693 // Get the factory producer service
694 char *factory = mlt_properties_get( properties, "factory" );
696 // Create the producer
697 mlt_profile profile = mlt_service_profile( MLT_TRANSITION_SERVICE( this ) );
698 mlt_producer producer = mlt_factory_producer( profile, factory, resource );
701 if ( producer != NULL )
703 // Get the producer properties
704 mlt_properties producer_properties = MLT_PRODUCER_PROPERTIES( producer );
706 // Ensure that we loop
707 mlt_properties_set( producer_properties, "eof", "loop" );
709 // Now pass all producer. properties on the transition down
710 mlt_properties_pass( producer_properties, properties, "luma." );
712 // We will get the alpha frame from the producer
713 mlt_frame luma_frame = NULL;
715 // Get the luma frame
716 if ( mlt_service_get_frame( MLT_PRODUCER_SERVICE( producer ), &luma_frame, 0 ) == 0 )
719 mlt_image_format luma_format = mlt_image_yuv422;
721 // Get image from the luma producer
722 mlt_properties_set( MLT_FRAME_PROPERTIES( luma_frame ), "rescale.interp", "none" );
723 mlt_frame_get_image( luma_frame, &luma_image, &luma_format, &luma_width, &luma_height, 0 );
725 // Generate the luma map
726 if ( luma_image != NULL && luma_format == mlt_image_yuv422 )
727 luma_read_yuv422( luma_image, &orig_bitmap, luma_width, luma_height );
729 // Remember the original size for subsequent scaling
730 mlt_properties_set_data( properties, "_luma.orig_bitmap", orig_bitmap, luma_width * luma_height * 2, mlt_pool_release, NULL );
731 mlt_properties_set_int( properties, "_luma.orig_width", luma_width );
732 mlt_properties_set_int( properties, "_luma.orig_height", luma_height );
734 // Cleanup the luma frame
735 mlt_frame_close( luma_frame );
738 // Cleanup the luma producer
739 mlt_producer_close( producer );
744 luma_bitmap = mlt_pool_alloc( width * height * sizeof( uint16_t ) );
745 scale_luma( luma_bitmap, width, height, orig_bitmap, luma_width, luma_height, invert * ( ( 1 << 16 ) - 1 ) );
747 // Remember the scaled luma size to prevent unnecessary scaling
748 mlt_properties_set_int( properties, "_luma.width", width );
749 mlt_properties_set_int( properties, "_luma.height", height );
750 mlt_properties_set_data( properties, "_luma.bitmap", luma_bitmap, width * height * 2, mlt_pool_release, NULL );
751 mlt_properties_set( properties, "_luma", resource );
752 mlt_properties_set_int( properties, "_luma_invert", invert );
757 /** Get the properly sized image from b_frame.
760 static int get_b_frame_image( mlt_transition this, mlt_frame b_frame, uint8_t **image, int *width, int *height, struct geometry_s *geometry )
763 mlt_image_format format = mlt_image_yuv422;
765 // Get the properties objects
766 mlt_properties b_props = MLT_FRAME_PROPERTIES( b_frame );
767 mlt_properties properties = MLT_TRANSITION_PROPERTIES( this );
768 uint8_t resize_alpha = mlt_properties_get_int( b_props, "resize_alpha" );
770 // Do not scale if we are cropping - the compositing rectangle can crop the b image
771 // TODO: Use the animatable w and h of the crop geometry to scale independently of crop rectangle
772 if ( mlt_properties_get( properties, "crop" ) )
774 int real_width = get_value( b_props, "real_width", "width" );
775 int real_height = get_value( b_props, "real_height", "height" );
776 double input_ar = mlt_properties_get_double( b_props, "aspect_ratio" );
777 double consumer_ar = mlt_properties_get_double( b_props, "consumer_aspect_ratio" );
778 double background_ar = mlt_properties_get_double( b_props, "output_ratio" );
779 double output_ar = background_ar != 0.0 ? background_ar : consumer_ar;
780 int scaled_width = rint( ( input_ar == 0.0 ? output_ar : input_ar ) / output_ar * real_width );
781 int scaled_height = real_height;
782 geometry->sw = scaled_width;
783 geometry->sh = scaled_height;
785 // Normalise aspect ratios and scale preserving aspect ratio
786 else if ( mlt_properties_get_int( properties, "aligned" ) && mlt_properties_get_int( properties, "distort" ) == 0 && mlt_properties_get_int( b_props, "distort" ) == 0 && geometry->item.distort == 0 )
788 // Adjust b_frame pixel aspect
789 int normalised_width = geometry->item.w;
790 int normalised_height = geometry->item.h;
791 int real_width = get_value( b_props, "real_width", "width" );
792 int real_height = get_value( b_props, "real_height", "height" );
793 double input_ar = mlt_properties_get_double( b_props, "aspect_ratio" );
794 double consumer_ar = mlt_properties_get_double( b_props, "consumer_aspect_ratio" );
795 double background_ar = mlt_properties_get_double( b_props, "output_ratio" );
796 double output_ar = background_ar != 0.0 ? background_ar : consumer_ar;
797 int scaled_width = rint( ( input_ar == 0.0 ? output_ar : input_ar ) / output_ar * real_width );
798 int scaled_height = real_height;
799 // fprintf(stderr, "%s: scaled %dx%d norm %dx%d real %dx%d output_ar %f => %f\n", __FILE__,
800 // scaled_width, scaled_height, normalised_width, normalised_height, real_width, real_height,
801 // background_ar, output_ar);
803 // Now ensure that our images fit in the normalised frame
804 if ( scaled_width > normalised_width )
806 scaled_height = rint( scaled_height * normalised_width / scaled_width );
807 scaled_width = normalised_width;
809 if ( scaled_height > normalised_height )
811 scaled_width = rint( scaled_width * normalised_height / scaled_height );
812 scaled_height = normalised_height;
815 // Honour the fill request - this will scale the image to fill width or height while maintaining a/r
816 // ????: Shouln't this be the default behaviour?
817 if ( mlt_properties_get_int( properties, "fill" ) && scaled_width > 0 && scaled_height > 0 )
819 if ( scaled_height < normalised_height && scaled_width * normalised_height / scaled_height <= normalised_width )
821 scaled_width = rint( scaled_width * normalised_height / scaled_height );
822 scaled_height = normalised_height;
824 else if ( scaled_width < normalised_width && scaled_height * normalised_width / scaled_width < normalised_height )
826 scaled_height = rint( scaled_height * normalised_width / scaled_width );
827 scaled_width = normalised_width;
831 // Save the new scaled dimensions
832 geometry->sw = scaled_width;
833 geometry->sh = scaled_height;
837 geometry->sw = geometry->item.w;
838 geometry->sh = geometry->item.h;
841 // We want to ensure that we bypass resize now...
842 if ( resize_alpha == 0 )
843 mlt_properties_set_int( b_props, "distort", mlt_properties_get_int( properties, "distort" ) );
845 // If we're not aligned, we want a non-transparent background
846 if ( mlt_properties_get_int( properties, "aligned" ) == 0 )
847 mlt_properties_set_int( b_props, "resize_alpha", 255 );
849 // Take into consideration alignment for optimisation (titles are a special case)
850 if ( !mlt_properties_get_int( properties, "titles" ) &&
851 mlt_properties_get( properties, "crop" ) == NULL )
852 alignment_calculate( geometry );
854 // Adjust to consumer scale
855 *width = rint( geometry->sw * *width / geometry->nw );
856 *height = rint( geometry->sh * *height / geometry->nh );
857 // fprintf(stderr, "%s: scaled %dx%d norm %dx%d resize %dx%d\n", __FILE__,
858 // geometry->sw, geometry->sh, geometry->nw, geometry->nh, *width, *height);
860 ret = mlt_frame_get_image( b_frame, image, &format, width, height, 1 );
862 // composite_yuv uses geometry->sw to determine source stride, which
863 // should equal the image width if not using crop property.
864 if ( !mlt_properties_get( properties, "crop" ) )
865 geometry->sw = *width;
867 // Set the frame back
868 mlt_properties_set_int( b_props, "resize_alpha", resize_alpha );
870 return ret && image != NULL;
873 static void crop_calculate( mlt_transition this, mlt_properties properties, struct geometry_s *result, double position )
875 // Initialize panning info
878 if ( mlt_properties_get( properties, "crop" ) )
880 mlt_geometry crop = mlt_properties_get_data( properties, "crop_geometry", NULL );
883 crop = mlt_geometry_init();
884 mlt_position in = mlt_transition_get_in( this );
885 mlt_position out = mlt_transition_get_out( this );
886 int length = out - in + 1;
887 double cycle = mlt_properties_get_double( properties, "cycle" );
889 // Allow a geometry repeat cycle
892 else if ( cycle > 0 )
894 mlt_geometry_parse( crop, mlt_properties_get( properties, "crop" ), length, result->sw, result->sh );
895 mlt_properties_set_data( properties, "crop_geometry", crop, 0, (mlt_destructor)mlt_geometry_close, NULL );
899 int length = mlt_geometry_get_length( crop );
900 int mirror_off = mlt_properties_get_int( properties, "mirror_off" );
901 int repeat_off = mlt_properties_get_int( properties, "repeat_off" );
902 if ( !repeat_off && position >= length && length != 0 )
904 int section = position / length;
905 position -= section * length;
906 if ( !mirror_off && section % 2 == 1 )
907 position = length - position;
911 struct mlt_geometry_item_s crop_item;
912 mlt_geometry_fetch( crop, &crop_item, position );
913 result->x_src = rint( crop_item.x );
914 result->y_src = rint( crop_item.y );
918 static mlt_geometry composite_calculate( mlt_transition this, struct geometry_s *result, mlt_frame a_frame, double position )
920 // Get the properties from the transition
921 mlt_properties properties = MLT_TRANSITION_PROPERTIES( this );
923 // Get the properties from the frame
924 mlt_properties a_props = MLT_FRAME_PROPERTIES( a_frame );
926 // Structures for geometry
927 mlt_geometry start = mlt_properties_get_data( properties, "geometries", NULL );
929 // Obtain the normalised width and height from the a_frame
930 int normalised_width = mlt_properties_get_int( a_props, "normalised_width" );
931 int normalised_height = mlt_properties_get_int( a_props, "normalised_height" );
933 char *name = mlt_properties_get( properties, "_unique_id" );
936 sprintf( key, "%s.in", name );
937 if ( mlt_properties_get( a_props, key ) )
939 sscanf( mlt_properties_get( a_props, key ), "%f,%f,%f,%f,%f,%d,%d", &result->item.x, &result->item.y, &result->item.w, &result->item.h, &result->item.mix, &result->nw, &result->nh );
943 // Now parse the geometries
946 // Parse the transitions properties
947 start = transition_parse_keys( this, normalised_width, normalised_height );
949 // Assign to properties to ensure we get destroyed
950 mlt_properties_set_data( properties, "geometries", start, 0, ( mlt_destructor )mlt_geometry_close, NULL );
954 int length = mlt_transition_get_out( this ) - mlt_transition_get_in( this ) + 1;
955 double cycle = mlt_properties_get_double( properties, "cycle" );
958 else if ( cycle > 0 )
960 mlt_geometry_refresh( start, mlt_properties_get( properties, "geometry" ), length, normalised_width, normalised_height );
963 // Do the calculation
964 geometry_calculate( this, result, position );
966 // Assign normalised info
967 result->nw = normalised_width;
968 result->nh = normalised_height;
971 // Now parse the alignment
972 result->halign = alignment_parse( mlt_properties_get( properties, "halign" ) );
973 result->valign = alignment_parse( mlt_properties_get( properties, "valign" ) );
975 crop_calculate( this, properties, result, position );
980 mlt_frame composite_copy_region( mlt_transition this, mlt_frame a_frame, mlt_position frame_position )
982 // Create a frame to return
983 mlt_frame b_frame = mlt_frame_init( MLT_TRANSITION_SERVICE( this ) );
985 // Get the properties of the a frame
986 mlt_properties a_props = MLT_FRAME_PROPERTIES( a_frame );
988 // Get the properties of the b frame
989 mlt_properties b_props = MLT_FRAME_PROPERTIES( b_frame );
992 int position = position_calculate( this, frame_position );
994 // Get the unique id of the transition
995 char *name = mlt_properties_get( MLT_TRANSITION_PROPERTIES( this ), "_unique_id" );
999 uint8_t *dest = NULL;
1001 // Get the image and dimensions
1002 uint8_t *image = mlt_properties_get_data( a_props, "image", NULL );
1003 int width = mlt_properties_get_int( a_props, "width" );
1004 int height = mlt_properties_get_int( a_props, "height" );
1005 int format = mlt_properties_get_int( a_props, "format" );
1007 // Pointers for copy operation
1019 // Will need to know region to copy
1020 struct geometry_s result;
1022 // Calculate the region now
1023 composite_calculate( this, &result, a_frame, position );
1025 // Need to scale down to actual dimensions
1026 x = rint( result.item.x * width / result.nw );
1027 y = rint( result.item.y * height / result.nh );
1028 w = rint( result.item.w * width / result.nw );
1029 h = rint( result.item.h * height / result.nh );
1038 sprintf( key, "%s.in=%d,%d,%d,%d,%f,%d,%d", name, x, y, w, h, result.item.mix, width, height );
1039 mlt_properties_parse( a_props, key );
1040 sprintf( key, "%s.out=%d,%d,%d,%d,%f,%d,%d", name, x, y, w, h, result.item.mix, width, height );
1041 mlt_properties_parse( a_props, key );
1046 // Now we need to create a new destination image
1047 dest = mlt_pool_alloc( w * h * 2 );
1049 // Assign to the new frame
1050 mlt_properties_set_data( b_props, "image", dest, w * h * 2, mlt_pool_release, NULL );
1051 mlt_properties_set_int( b_props, "width", w );
1052 mlt_properties_set_int( b_props, "height", h );
1053 mlt_properties_set_int( b_props, "format", format );
1057 dest += ( ds * -y );
1062 if ( y + h > height )
1063 h -= ( y + h - height );
1072 if ( w > 0 && h > 0 )
1074 // Copy the region of the image
1075 p = image + y * ss + x * 2;
1079 memcpy( dest, p, w * 2 );
1085 // Assign this position to the b frame
1086 mlt_frame_set_position( b_frame, frame_position );
1087 mlt_properties_set_int( b_props, "distort", 1 );
1096 static int transition_get_image( mlt_frame a_frame, uint8_t **image, mlt_image_format *format, int *width, int *height, int writable )
1098 // Get the b frame from the stack
1099 mlt_frame b_frame = mlt_frame_pop_frame( a_frame );
1101 // Get the transition from the a frame
1102 mlt_transition this = mlt_frame_pop_service( a_frame );
1105 double position = mlt_deque_pop_back_double( MLT_FRAME_IMAGE_STACK( a_frame ) );
1106 int out = mlt_frame_pop_service_int( a_frame );
1107 int in = mlt_frame_pop_service_int( a_frame );
1109 // Get the properties from the transition
1110 mlt_properties properties = MLT_TRANSITION_PROPERTIES( this );
1112 // TODO: clean up always_active behaviour
1113 if ( mlt_properties_get_int( properties, "always_active" ) )
1115 mlt_events_block( properties, properties );
1116 mlt_properties_set_int( properties, "in", in );
1117 mlt_properties_set_int( properties, "out", out );
1118 mlt_events_unblock( properties, properties );
1121 // This compositer is yuv422 only
1122 *format = mlt_image_yuv422;
1124 if ( b_frame != NULL )
1126 // Get the properties of the a frame
1127 mlt_properties a_props = MLT_FRAME_PROPERTIES( a_frame );
1129 // Get the properties of the b frame
1130 mlt_properties b_props = MLT_FRAME_PROPERTIES( b_frame );
1132 // Structures for geometry
1133 struct geometry_s result;
1135 // Calculate the position
1136 double delta = delta_calculate( this, a_frame, position );
1138 // Get the image from the b frame
1139 uint8_t *image_b = NULL;
1140 int width_b = *width;
1141 int height_b = *height;
1144 uint8_t *alpha_a = NULL;
1145 uint8_t *alpha_b = NULL;
1147 // Composites always need scaling... defaulting to lowest
1148 const char *rescale = mlt_properties_get( a_props, "rescale.interp" );
1149 if ( rescale == NULL || !strcmp( rescale, "none" ) )
1150 rescale = "nearest";
1151 mlt_properties_set( a_props, "rescale.interp", rescale );
1152 mlt_properties_set( b_props, "rescale.interp", rescale );
1154 // Do the calculation
1155 // NB: Locks needed here since the properties are being modified
1156 int invert = mlt_properties_get_int( properties, "invert" );
1157 mlt_service_lock( MLT_TRANSITION_SERVICE( this ) );
1158 composite_calculate( this, &result, invert ? b_frame : a_frame, position );
1159 mlt_service_unlock( MLT_TRANSITION_SERVICE( this ) );
1161 // Since we are the consumer of the b_frame, we must pass along these
1162 // consumer properties from the a_frame
1163 mlt_properties_set_int( b_props, "consumer_deinterlace", mlt_properties_get_int( a_props, "consumer_deinterlace" ) || mlt_properties_get_int( properties, "deinterlace" ) );
1164 mlt_properties_set( b_props, "consumer_deinterlace_method", mlt_properties_get( a_props, "consumer_deinterlace_method" ) );
1165 mlt_properties_set_double( b_props, "consumer_aspect_ratio", mlt_properties_get_double( a_props, "consumer_aspect_ratio" ) );
1167 // TODO: Dangerous/temporary optimisation - if nothing to do, then do nothing
1168 if ( mlt_properties_get_int( properties, "no_alpha" ) &&
1169 result.item.x == 0 && result.item.y == 0 && result.item.w == *width && result.item.h == *height && result.item.mix == 100 )
1171 mlt_frame_get_image( b_frame, image, format, width, height, 1 );
1172 if ( !mlt_frame_is_test_card( a_frame ) )
1173 mlt_frame_replace_image( a_frame, *image, *format, *width, *height );
1177 if ( a_frame == b_frame )
1179 double aspect_ratio = mlt_frame_get_aspect_ratio( b_frame );
1180 get_b_frame_image( this, b_frame, &image_b, &width_b, &height_b, &result );
1181 alpha_b = mlt_frame_get_alpha_mask( b_frame );
1182 mlt_properties_set_double( a_props, "aspect_ratio", aspect_ratio );
1185 // Get the image from the a frame
1186 mlt_frame_get_image( a_frame, invert ? &image_b : image, format, width, height, 1 );
1187 alpha_a = mlt_frame_get_alpha_mask( a_frame );
1189 // Optimisation - no compositing required
1190 if ( result.item.mix == 0 || ( result.item.w == 0 && result.item.h == 0 ) )
1193 // Need to keep the width/height of the a_frame on the b_frame for titling
1194 if ( mlt_properties_get( a_props, "dest_width" ) == NULL )
1196 mlt_properties_set_int( a_props, "dest_width", *width );
1197 mlt_properties_set_int( a_props, "dest_height", *height );
1198 mlt_properties_set_int( b_props, "dest_width", *width );
1199 mlt_properties_set_int( b_props, "dest_height", *height );
1203 mlt_properties_set_int( b_props, "dest_width", mlt_properties_get_int( a_props, "dest_width" ) );
1204 mlt_properties_set_int( b_props, "dest_height", mlt_properties_get_int( a_props, "dest_height" ) );
1207 // Special case for titling...
1208 if ( mlt_properties_get_int( properties, "titles" ) )
1210 if ( mlt_properties_get( b_props, "rescale.interp" ) == NULL )
1211 mlt_properties_set( b_props, "rescale.interp", "hyper" );
1212 width_b = mlt_properties_get_int( a_props, "dest_width" );
1213 height_b = mlt_properties_get_int( a_props, "dest_height" );
1216 if ( *image != image_b && ( ( invert ? 0 : image_b ) || get_b_frame_image( this, b_frame, invert ? image : &image_b, &width_b, &height_b, &result ) == 0 ) )
1218 uint8_t *dest = *image;
1219 uint8_t *src = image_b;
1221 mlt_properties_get_int( a_props, "consumer_deinterlace" ) ||
1222 mlt_properties_get_int( properties, "progressive" );
1225 double luma_softness = mlt_properties_get_double( properties, "softness" );
1226 uint16_t *luma_bitmap = get_luma( this, properties, width_b, height_b );
1227 char *operator = mlt_properties_get( properties, "operator" );
1229 alpha_b = alpha_b == NULL ? mlt_frame_get_alpha_mask( b_frame ) : alpha_b;
1231 composite_line_fn line_fn = composite_line_yuv;
1233 // Replacement and override
1234 if ( operator != NULL )
1236 if ( !strcmp( operator, "or" ) )
1237 line_fn = composite_line_yuv_or;
1238 if ( !strcmp( operator, "and" ) )
1239 line_fn = composite_line_yuv_and;
1240 if ( !strcmp( operator, "xor" ) )
1241 line_fn = composite_line_yuv_xor;
1244 // Allow the user to completely obliterate the alpha channels from both frames
1245 if ( mlt_properties_get( properties, "alpha_a" ) )
1246 memset( alpha_a, mlt_properties_get_int( properties, "alpha_a" ), *width * *height );
1248 if ( mlt_properties_get( properties, "alpha_b" ) )
1249 memset( alpha_b, mlt_properties_get_int( properties, "alpha_b" ), width_b * height_b );
1251 for ( field = 0; field < ( progressive ? 1 : 2 ); field++ )
1253 // Assume lower field (0) first
1254 double field_position = position + field * delta;
1256 // Do the calculation if we need to
1257 // NB: Locks needed here since the properties are being modified
1258 mlt_service_lock( MLT_TRANSITION_SERVICE( this ) );
1259 composite_calculate( this, &result, invert ? b_frame : a_frame, field_position );
1260 mlt_service_unlock( MLT_TRANSITION_SERVICE( this ) );
1262 if ( mlt_properties_get_int( properties, "titles" ) )
1264 result.item.w = rint( *width * ( result.item.w / result.nw ) );
1265 result.nw = result.item.w;
1266 result.item.h = rint( *height * ( result.item.h / result.nh ) );
1267 result.nh = *height;
1268 result.sw = width_b;
1269 result.sh = height_b;
1273 if ( mlt_properties_get( properties, "crop" ) )
1275 if ( result.x_src == 0 )
1276 width_b = width_b > result.item.w ? result.item.w : width_b;
1277 if ( result.y_src == 0 )
1278 height_b = height_b > result.item.h ? result.item.h : height_b;
1283 alignment_calculate( &result );
1286 // Composite the b_frame on the a_frame
1288 composite_yuv( dest, width_b, height_b, src, *width, *height, alpha_a, alpha_b, result, progressive ? -1 : field, luma_bitmap, luma_softness, line_fn );
1290 composite_yuv( dest, *width, *height, src, width_b, height_b, alpha_b, alpha_a, result, progressive ? -1 : field, luma_bitmap, luma_softness, line_fn );
1296 mlt_frame_get_image( a_frame, image, format, width, height, 1 );
1302 /** Composition transition processing.
1305 static mlt_frame composite_process( mlt_transition this, mlt_frame a_frame, mlt_frame b_frame )
1307 // UGH - this is a TODO - find a more reliable means of obtaining in/out for the always_active case
1308 if ( mlt_properties_get_int( MLT_TRANSITION_PROPERTIES( this ), "always_active" ) == 0 )
1310 mlt_frame_push_service_int( a_frame, mlt_properties_get_int( MLT_TRANSITION_PROPERTIES( this ), "in" ) );
1311 mlt_frame_push_service_int( a_frame, mlt_properties_get_int( MLT_TRANSITION_PROPERTIES( this ), "out" ) );
1312 mlt_deque_push_back_double( MLT_FRAME_IMAGE_STACK( a_frame ), position_calculate( this, mlt_frame_get_position( a_frame ) ) );
1316 mlt_properties props = mlt_properties_get_data( MLT_FRAME_PROPERTIES( b_frame ), "_producer", NULL );
1317 mlt_frame_push_service_int( a_frame, mlt_properties_get_int( props, "in" ) );
1318 mlt_frame_push_service_int( a_frame, mlt_properties_get_int( props, "out" ) );
1319 mlt_deque_push_back_double( MLT_FRAME_IMAGE_STACK( a_frame ), mlt_properties_get_int( props, "_frame" ) - mlt_properties_get_int( props, "in" ) );
1322 mlt_frame_push_service( a_frame, this );
1323 mlt_frame_push_frame( a_frame, b_frame );
1324 mlt_frame_push_get_image( a_frame, transition_get_image );
1328 /** Constructor for the filter.
1331 mlt_transition transition_composite_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
1333 mlt_transition this = calloc( sizeof( struct mlt_transition_s ), 1 );
1334 if ( this != NULL && mlt_transition_init( this, NULL ) == 0 )
1336 mlt_properties properties = MLT_TRANSITION_PROPERTIES( this );
1338 this->process = composite_process;
1340 // Default starting motion and zoom
1341 mlt_properties_set( properties, "start", arg != NULL ? arg : "0,0:100%x100%" );
1344 mlt_properties_set( properties, "factory", mlt_environment( "MLT_PRODUCER" ) );
1346 // Use alignment (and hence alpha of b frame)
1347 mlt_properties_set_int( properties, "aligned", 1 );
1349 // Inform apps and framework that this is a video only transition
1350 mlt_properties_set_int( properties, "_transition_type", 1 );