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 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_composite.h"
22 #include <framework/mlt_frame.h>
37 int nw; // normalised width
38 int nh; // normalised height
39 int sw; // scaled width, not including consumer scale based upon w/nw
40 int sh; // scaled height, not including consumer scale based upon h/nh
45 int halign; // horizontal alignment: 0=left, 1=center, 2=right
46 int valign; // vertical alignment: 0=top, 1=middle, 2=bottom
48 struct geometry_s *next;
51 /** Parse a value from a geometry string.
54 static float parse_value( char **ptr, int normalisation, char delim, float defaults )
56 float value = defaults;
58 if ( *ptr != NULL && **ptr != '\0' )
61 value = strtod( *ptr, &end );
65 value = ( value / 100.0 ) * normalisation;
66 while ( *end == delim || *end == '%' )
75 /** Parse a geometry property string with the syntax X,Y:WxH:MIX. Any value can be
76 expressed as a percentage by appending a % after the value, otherwise values are
77 assumed to be relative to the normalised dimensions of the consumer.
80 static void geometry_parse( struct geometry_s *geometry, struct geometry_s *defaults, char *property, int nw, int nh )
82 // Assign normalised width and height
86 // Assign from defaults if available
87 if ( defaults != NULL )
89 geometry->x = defaults->x;
90 geometry->y = defaults->y;
91 geometry->w = geometry->sw = defaults->w;
92 geometry->h = geometry->sh = defaults->h;
93 geometry->distort = defaults->distort;
94 geometry->mix = defaults->mix;
95 defaults->next = geometry;
102 // Parse the geomtry string
103 if ( property != NULL && strcmp( property, "" ) )
105 char *ptr = property;
106 geometry->x = parse_value( &ptr, nw, ',', geometry->x );
107 geometry->y = parse_value( &ptr, nh, ':', geometry->y );
108 geometry->w = geometry->sw = parse_value( &ptr, nw, 'x', geometry->w );
109 geometry->h = geometry->sh = parse_value( &ptr, nh, ':', geometry->h );
112 geometry->distort = 1;
117 geometry->mix = parse_value( &ptr, 100, ' ', geometry->mix );
121 /** Calculate real geometry.
124 static void geometry_calculate( struct geometry_s *output, struct geometry_s *in, float position )
126 // Search in for position
127 struct geometry_s *out = in->next;
129 if ( position >= 1.0 )
131 int section = floor( position );
133 if ( section % 2 == 1 )
134 position = 1.0 - position;
137 while ( out->next != NULL )
139 if ( position >= in->position && position < out->position )
146 position = ( position - in->position ) / ( out->position - in->position );
148 // Calculate this frames geometry
151 output->x = in->x + ( out->x - in->x ) * position;
152 output->y = in->y + ( out->y - in->y ) * position;
153 output->w = in->w + ( out->w - in->w ) * position;
154 output->h = in->h + ( out->h - in->h ) * position;
155 output->sw = output->w;
156 output->sh = output->h;
157 output->mix = in->mix + ( out->mix - in->mix ) * position;
158 output->distort = in->distort;
160 output->x = ( int )floor( output->x ) & 0xfffffffe;
161 output->w = ( int )floor( output->w ) & 0xfffffffe;
162 output->sw &= 0xfffffffe;
165 void transition_destroy_keys( void *arg )
167 struct geometry_s *ptr = arg;
168 struct geometry_s *next = NULL;
170 while ( ptr != NULL )
178 static struct geometry_s *transition_parse_keys( mlt_transition this, int normalised_width, int normalised_height )
180 // Loop variable for property interrogation
183 // Get the properties of the transition
184 mlt_properties properties = mlt_transition_properties( this );
186 // Get the in and out position
187 mlt_position in = mlt_transition_get_in( this );
188 mlt_position out = mlt_transition_get_out( this );
191 struct geometry_s *start = calloc( 1, sizeof( struct geometry_s ) );
193 // Create the end (we always need two entries)
194 struct geometry_s *end = calloc( 1, sizeof( struct geometry_s ) );
197 struct geometry_s *ptr = start;
199 // Parse the start property
200 geometry_parse( start, NULL, mlt_properties_get( properties, "start" ), normalised_width, normalised_height );
202 // Parse the keys in between
203 for ( i = 0; i < mlt_properties_count( properties ); i ++ )
205 // Get the name of the property
206 char *name = mlt_properties_get_name( properties, i );
208 // Check that it's valid
209 if ( !strncmp( name, "key[", 4 ) )
211 // Get the value of the property
212 char *value = mlt_properties_get_value( properties, i );
214 // Determine the frame number
215 int frame = atoi( name + 4 );
217 // Determine the position
220 if ( frame >= 0 && frame < ( out - in ) )
221 position = ( float )frame / ( float )( out - in + 1 );
222 else if ( frame < 0 && - frame < ( out - in ) )
223 position = ( float )( out - in + frame ) / ( float )( out - in + 1 );
225 // For now, we'll exclude all keys received out of order
226 if ( position > ptr->position )
228 // Create a new geometry
229 struct geometry_s *temp = calloc( 1, sizeof( struct geometry_s ) );
231 // Parse and add to the list
232 geometry_parse( temp, ptr, value, normalised_width, normalised_height );
234 // Assign the position
235 temp->position = position;
237 // Allow the next to be appended after this one
242 fprintf( stderr, "Key out of order - skipping %s\n", name );
248 geometry_parse( end, ptr, mlt_properties_get( properties, "end" ), normalised_width, normalised_height );
250 end->position = ( float )( out - in ) / ( float )( out - in + 1 );
254 // Assign to properties to ensure we get destroyed
255 mlt_properties_set_data( properties, "geometries", start, 0, transition_destroy_keys, NULL );
260 /** Parse the alignment properties into the geometry.
263 static int alignment_parse( char* align )
267 if ( align == NULL );
268 else if ( isdigit( align[ 0 ] ) )
270 else if ( align[ 0 ] == 'c' || align[ 0 ] == 'm' )
272 else if ( align[ 0 ] == 'r' || align[ 0 ] == 'b' )
278 /** Adjust position according to scaled size and alignment properties.
281 static void alignment_calculate( struct geometry_s *geometry )
283 geometry->x += ( geometry->w - geometry->sw ) * geometry->halign / 2;
284 geometry->y += ( geometry->h - geometry->sh ) * geometry->valign / 2;
287 /** Calculate the position for this frame.
290 static float position_calculate( mlt_transition this, mlt_frame frame )
292 // Get the in and out position
293 mlt_position in = mlt_transition_get_in( this );
294 mlt_position out = mlt_transition_get_out( this );
297 mlt_position position = mlt_frame_get_position( frame );
300 return ( float )( position - in ) / ( float )( out - in + 1 );
303 /** Calculate the field delta for this frame - position between two frames.
306 static inline float delta_calculate( mlt_transition this, mlt_frame frame )
308 // Get the in and out position
309 mlt_position in = mlt_transition_get_in( this );
310 mlt_position out = mlt_transition_get_out( this );
312 // Get the position of the frame
313 mlt_position position = mlt_frame_get_position( frame );
316 float x = ( float )( position - in ) / ( float )( out - in + 1 );
317 float y = ( float )( position + 1 - in ) / ( float )( out - in + 1 );
319 return ( y - x ) / 2.0;
322 static int get_value( mlt_properties properties, char *preferred, char *fallback )
324 int value = mlt_properties_get_int( properties, preferred );
326 value = mlt_properties_get_int( properties, fallback );
330 /** Composite function.
333 static int composite_yuv( uint8_t *p_dest, int width_dest, int height_dest, int bpp, uint8_t *p_src, int width_src, int height_src, uint8_t *p_alpha, struct geometry_s geometry, int field )
337 int x_src = 0, y_src = 0;
338 int32_t weight = ( 1 << 16 ) * ( geometry.mix / 100 );
339 int stride_src = width_src * bpp;
340 int stride_dest = width_dest * bpp;
342 // Adjust to consumer scale
343 int x = geometry.x * width_dest / geometry.nw;
344 int y = geometry.y * height_dest / geometry.nh;
347 width_src &= 0xfffffffe;
349 // optimization points - no work to do
350 if ( width_src <= 0 || height_src <= 0 )
353 if ( ( x < 0 && -x >= width_src ) || ( y < 0 && -y >= height_src ) )
356 // crop overlay off the left edge of frame
364 // crop overlay beyond right edge of frame
365 else if ( x + width_src > width_dest )
366 width_src = width_dest - x;
368 // crop overlay off the top edge of the frame
374 // crop overlay below bottom edge of frame
375 else if ( y + height_src > height_dest )
376 height_src = height_dest - y;
378 // offset pointer into overlay buffer based on cropping
379 p_src += x_src * bpp + y_src * stride_src;
381 // offset pointer into frame buffer based upon positive coordinates only!
382 p_dest += ( x < 0 ? 0 : x ) * bpp + ( y < 0 ? 0 : y ) * stride_dest;
384 // offset pointer into alpha channel based upon cropping
386 p_alpha += x_src + y_src * stride_src / bpp;
388 // Assuming lower field first
389 // Special care is taken to make sure the b_frame is aligned to the correct field.
390 // field 0 = lower field and y should be odd (y is 0-based).
391 // field 1 = upper field and y should be even.
392 if ( ( field > -1 ) && ( y % 2 == field ) )
394 //fprintf( stderr, "field %d y %d\n", field, y );
395 if ( ( field == 1 && y < height_dest - 1 ) || ( field == 0 && y == 0 ) )
396 p_dest += stride_dest;
398 p_dest -= stride_dest;
401 // On the second field, use the other lines from b_frame
406 p_alpha += stride_src / bpp;
413 uint8_t *z = p_alpha;
417 int step = ( field > -1 ) ? 2 : 1;
419 stride_src = stride_src * step;
420 int alpha_stride = stride_src / bpp;
421 stride_dest = stride_dest * step;
423 // now do the compositing only to cropped extents
424 for ( i = 0; i < height_src; i += step )
431 for ( j = 0; j < width_src; j ++ )
433 a = ( z == NULL ) ? 255 : *z ++;
434 value = ( weight * ( a + 1 ) ) >> 8;
435 *o ++ = ( *p++ * value + *q++ * ( ( 1 << 16 ) - value ) ) >> 16;
436 *o ++ = ( *p++ * value + *q++ * ( ( 1 << 16 ) - value ) ) >> 16;
440 p_dest += stride_dest;
442 p_alpha += alpha_stride;
449 /** Get the properly sized image from b_frame.
452 static int get_b_frame_image( mlt_transition this, mlt_frame b_frame, uint8_t **image, int *width, int *height, struct geometry_s *geometry )
455 mlt_image_format format = mlt_image_yuv422;
457 // Get the properties objects
458 mlt_properties b_props = mlt_frame_properties( b_frame );
459 mlt_properties properties = mlt_transition_properties( this );
461 if ( mlt_properties_get( properties, "distort" ) == NULL && geometry->distort == 0 )
463 // Adjust b_frame pixel aspect
464 int normalised_width = geometry->w;
465 int normalised_height = geometry->h;
466 int real_width = get_value( b_props, "real_width", "width" );
467 int real_height = get_value( b_props, "real_height", "height" );
468 double input_ar = mlt_frame_get_aspect_ratio( b_frame );
469 double output_ar = mlt_properties_get_double( b_props, "consumer_aspect_ratio" );
470 int scaled_width = real_width;
471 int scaled_height = real_height;
472 double output_sar = ( double ) geometry->nw / geometry->nh / output_ar;
474 // If the output is fat pixels (NTSC) then stretch our input horizontally
475 // derived from: output_sar / input_sar * real_width
476 scaled_width = output_sar * real_height * input_ar;
478 // Now ensure that our images fit in the normalised frame
479 if ( scaled_width > normalised_width )
481 scaled_height = scaled_height * normalised_width / scaled_width;
482 scaled_width = normalised_width;
484 if ( scaled_height > normalised_height )
486 scaled_width = scaled_width * normalised_height / scaled_height;
487 scaled_height = normalised_height;
490 // Now apply the fill
491 // TODO: Should combine fill/distort in one property
492 if ( mlt_properties_get( properties, "fill" ) != NULL )
494 scaled_width = ( geometry->w / scaled_width ) * scaled_width;
495 scaled_height = ( geometry->h / scaled_height ) * scaled_height;
498 // Save the new scaled dimensions
499 geometry->sw = scaled_width;
500 geometry->sh = scaled_height;
503 // We want to ensure that we bypass resize now...
504 mlt_properties_set( b_props, "distort", "true" );
506 // Take into consideration alignment for optimisation
507 alignment_calculate( geometry );
509 // Adjust to consumer scale
510 int x = geometry->x * *width / geometry->nw;
511 int y = geometry->y * *height / geometry->nh;
512 *width = geometry->sw * *width / geometry->nw;
513 *height = geometry->sh * *height / geometry->nh;
517 // optimization points - no work to do
518 if ( *width <= 0 || *height <= 0 )
521 if ( ( x < 0 && -x >= *width ) || ( y < 0 && -y >= *height ) )
524 ret = mlt_frame_get_image( b_frame, image, &format, width, height, 1 );
530 static uint8_t *transition_get_alpha_mask( mlt_frame this )
532 // Obtain properties of frame
533 mlt_properties properties = mlt_frame_properties( this );
535 // Return the alpha mask
536 return mlt_properties_get_data( properties, "alpha", NULL );
539 struct geometry_s *composite_calculate( struct geometry_s *result, mlt_transition this, mlt_frame a_frame, float position )
541 // Get the properties from the transition
542 mlt_properties properties = mlt_transition_properties( this );
544 // Get the properties from the frame
545 mlt_properties a_props = mlt_frame_properties( a_frame );
547 // Structures for geometry
548 struct geometry_s *start = mlt_properties_get_data( properties, "geometries", NULL );
550 // Now parse the geometries
553 // Obtain the normalised width and height from the a_frame
554 int normalised_width = mlt_properties_get_int( a_props, "normalised_width" );
555 int normalised_height = mlt_properties_get_int( a_props, "normalised_height" );
557 // Parse the transitions properties
558 start = transition_parse_keys( this, normalised_width, normalised_height );
561 // Do the calculation
562 geometry_calculate( result, start, position );
564 // Now parse the alignment
565 result->halign = alignment_parse( mlt_properties_get( properties, "halign" ) );
566 result->valign = alignment_parse( mlt_properties_get( properties, "valign" ) );
571 mlt_frame composite_copy_region( mlt_transition this, mlt_frame a_frame )
573 // Create a frame to return
574 mlt_frame b_frame = mlt_frame_init( );
576 // Get the properties of the a frame
577 mlt_properties a_props = mlt_frame_properties( a_frame );
579 // Get the properties of the b frame
580 mlt_properties b_props = mlt_frame_properties( b_frame );
583 float position = position_calculate( this, a_frame );
586 uint8_t *dest = NULL;
588 // Get the image and dimensions
589 uint8_t *image = mlt_properties_get_data( a_props, "image", NULL );
590 int width = mlt_properties_get_int( a_props, "width" );
591 int height = mlt_properties_get_int( a_props, "height" );
593 // Pointers for copy operation
604 // Will need to know region to copy
605 struct geometry_s result;
607 // Calculate the region now
608 composite_calculate( &result, this, a_frame, position );
610 // Need to scale down to actual dimensions
611 x = result.x * width / result.nw ;
612 y = result.y * height / result.nh;
613 w = result.sw * width / result.nw;
614 h = result.sh * height / result.nh;
619 // Now we need to create a new destination image
620 dest = mlt_pool_alloc( w * h * 2 );
622 // Copy the region of the image
623 p = image + y * width * 2 + x * 2;
625 r = dest + w * h * 2;
629 memcpy( q, p, w * 2 );
634 // Assign to the new frame
635 mlt_properties_set_data( b_props, "image", dest, w * h * 2, mlt_pool_release, NULL );
636 mlt_properties_set_int( b_props, "width", w );
637 mlt_properties_set_int( b_props, "height", h );
646 static int transition_get_image( mlt_frame a_frame, uint8_t **image, mlt_image_format *format, int *width, int *height, int writable )
648 // Get the b frame from the stack
649 mlt_frame b_frame = mlt_frame_pop_frame( a_frame );
651 // Get the transition from the a frame
652 mlt_transition this = mlt_frame_pop_service( a_frame );
654 // This compositer is yuv422 only
655 *format = mlt_image_yuv422;
657 // Get the image from the a frame
658 mlt_frame_get_image( a_frame, image, format, width, height, 1 );
660 if ( b_frame != NULL )
662 // Get the properties of the a frame
663 mlt_properties a_props = mlt_frame_properties( a_frame );
665 // Get the properties of the b frame
666 mlt_properties b_props = mlt_frame_properties( b_frame );
668 // Get the properties from the transition
669 mlt_properties properties = mlt_transition_properties( this );
671 // Structures for geometry
672 struct geometry_s result;
674 // Calculate the position
675 float position = mlt_properties_get_double( b_props, "relative_position" );
676 float delta = delta_calculate( this, a_frame );
678 // Do the calculation
679 struct geometry_s *start = composite_calculate( &result, this, a_frame, position );
681 // Since we are the consumer of the b_frame, we must pass along these
682 // consumer properties from the a_frame
683 mlt_properties_set_double( b_props, "consumer_aspect_ratio", mlt_properties_get_double( a_props, "consumer_aspect_ratio" ) );
684 mlt_properties_set_double( b_props, "consumer_scale", mlt_properties_get_double( a_props, "consumer_scale" ) );
686 // Get the image from the b frame
687 uint8_t *image_b = NULL;
688 int width_b = *width;
689 int height_b = *height;
691 if ( get_b_frame_image( this, b_frame, &image_b, &width_b, &height_b, &result ) == 0 )
693 uint8_t *dest = *image;
694 uint8_t *src = image_b;
696 uint8_t *alpha = mlt_frame_get_alpha_mask( b_frame );
697 int progressive = mlt_properties_get_int( a_props, "progressive" ) ||
698 mlt_properties_get_int( a_props, "consumer_progressive" ) ||
699 mlt_properties_get_int( properties, "progressive" );
702 for ( field = 0; field < ( progressive ? 1 : 2 ); field++ )
704 // Assume lower field (0) first
705 float field_position = position + field * delta;
707 // Do the calculation if we need to
708 geometry_calculate( &result, start, field_position );
711 alignment_calculate( &result );
713 // Composite the b_frame on the a_frame
714 composite_yuv( dest, *width, *height, bpp, src, width_b, height_b, alpha, result, progressive ? -1 : field );
722 /** Composition transition processing.
725 static mlt_frame composite_process( mlt_transition this, mlt_frame a_frame, mlt_frame b_frame )
727 // Propogate the transition properties to the b frame
728 mlt_properties_set_double( mlt_frame_properties( b_frame ), "relative_position", position_calculate( this, a_frame ) );
729 mlt_frame_push_service( a_frame, this );
730 mlt_frame_push_get_image( a_frame, transition_get_image );
731 mlt_frame_push_frame( a_frame, b_frame );
735 /** Constructor for the filter.
738 mlt_transition transition_composite_init( char *arg )
740 mlt_transition this = calloc( sizeof( struct mlt_transition_s ), 1 );
741 if ( this != NULL && mlt_transition_init( this, NULL ) == 0 )
743 this->process = composite_process;
744 mlt_properties_set( mlt_transition_properties( this ), "start", arg != NULL ? arg : "85%,5%:10%x10%" );