2 * mlt_frame.c -- interface for all frame classes
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.
22 #include "mlt_frame.h"
29 mlt_image_format vfmt;
34 mlt_audio_format afmt;
39 static frame_test test_card = { mlt_image_none, 0, 0, NULL, NULL, mlt_audio_none, NULL };
41 /** Constructor for a frame.
44 mlt_frame mlt_frame_init( )
47 mlt_frame this = calloc( sizeof( struct mlt_frame_s ), 1 );
51 // Initialise the properties
52 mlt_properties properties = &this->parent;
53 mlt_properties_init( properties, this );
55 // Set default properties on the frame
56 mlt_properties_set_timecode( properties, "timecode", 0.0 );
57 mlt_properties_set_data( properties, "image", NULL, 0, NULL, NULL );
58 mlt_properties_set_int( properties, "width", 720 );
59 mlt_properties_set_int( properties, "height", 576 );
60 mlt_properties_set_double( properties, "aspect_ratio", 4.0 / 3.0 );
61 mlt_properties_set_data( properties, "audio", NULL, 0, NULL, NULL );
62 mlt_properties_set_data( properties, "alpha", NULL, 0, NULL, NULL );
67 /** Fetch the frames properties.
70 mlt_properties mlt_frame_properties( mlt_frame this )
75 /** Check if we have a way to derive something other than a test card.
78 int mlt_frame_is_test_card( mlt_frame this )
80 return this->stack_get_image_size == 0;
83 /** Get the aspect ratio of the frame.
86 double mlt_frame_get_aspect_ratio( mlt_frame this )
88 mlt_properties properties = mlt_frame_properties( this );
89 return mlt_properties_get_double( properties, "aspect_ratio" );
92 /** Set the aspect ratio of the frame.
95 int mlt_frame_set_aspect_ratio( mlt_frame this, double value )
97 mlt_properties properties = mlt_frame_properties( this );
98 return mlt_properties_set_double( properties, "aspect_ratio", value );
101 /** Get the timecode of this frame.
104 mlt_timecode mlt_frame_get_timecode( mlt_frame this )
106 mlt_properties properties = mlt_frame_properties( this );
107 return mlt_properties_get_timecode( properties, "timecode" );
110 /** Set the timecode of this frame.
113 int mlt_frame_set_timecode( mlt_frame this, mlt_timecode value )
115 mlt_properties properties = mlt_frame_properties( this );
116 return mlt_properties_set_timecode( properties, "timecode", value );
119 /** Stack a get_image callback.
122 int mlt_frame_push_get_image( mlt_frame this, mlt_get_image get_image )
124 int ret = this->stack_get_image_size >= 10;
126 this->stack_get_image[ this->stack_get_image_size ++ ] = get_image;
130 /** Pop a get_image callback.
133 mlt_get_image mlt_frame_pop_get_image( mlt_frame this )
135 mlt_get_image result = NULL;
136 if ( this->stack_get_image_size > 0 )
137 result = this->stack_get_image[ -- this->stack_get_image_size ];
144 int mlt_frame_push_frame( mlt_frame this, mlt_frame that )
146 int ret = this->stack_frame_size >= 10;
148 this->stack_frame[ this->stack_frame_size ++ ] = that;
155 mlt_frame mlt_frame_pop_frame( mlt_frame this )
157 mlt_frame result = NULL;
158 if ( this->stack_frame_size > 0 )
159 result = this->stack_frame[ -- this->stack_frame_size ];
163 int mlt_frame_get_image( mlt_frame this, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable )
165 mlt_properties properties = mlt_frame_properties( this );
166 mlt_get_image get_image = mlt_frame_pop_get_image( this );
168 if ( get_image != NULL )
170 return get_image( this, buffer, format, width, height, writable );
172 else if ( mlt_properties_get_data( properties, "image", NULL ) != NULL )
174 *format = mlt_image_yuv422;
175 *buffer = mlt_properties_get_data( properties, "image", NULL );
176 *width = mlt_properties_get_int( properties, "width" );
177 *height = mlt_properties_get_int( properties, "height" );
181 if ( test_card.vfmt != *format )
186 test_card.vfmt = *format;
187 test_card.width = *width == 0 ? 720 : *width;
188 test_card.height = *height == 0 ? 576 : *height;
194 case mlt_image_rgb24:
195 test_card.image = realloc( test_card.image, test_card.width * test_card.height * 3 );
196 memset( test_card.image, 255, test_card.width * test_card.height * 3 );
198 case mlt_image_rgb24a:
199 test_card.image = realloc( test_card.image, test_card.width * test_card.height * 4 );
200 memset( test_card.image, 255, test_card.width * test_card.height * 4 );
202 case mlt_image_yuv422:
203 test_card.image = realloc( test_card.image, test_card.width * test_card.height * 2 );
205 q = test_card.image + test_card.width * test_card.height * 2;
212 case mlt_image_yuv420p:
213 test_card.image = realloc( test_card.image, test_card.width * test_card.height * 3 / 2 );
214 memset( test_card.image, 255, test_card.width * test_card.height * 3 / 2 );
219 *width = test_card.width;
220 *height = test_card.height;
221 *buffer = test_card.image;
227 uint8_t *mlt_frame_get_alpha_mask( mlt_frame this )
229 if ( this->get_alpha_mask != NULL )
230 return this->get_alpha_mask( this );
231 return test_card.alpha;
234 int mlt_frame_get_audio( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples )
236 if ( this->get_audio != NULL )
238 return this->get_audio( this, buffer, format, frequency, channels, samples );
242 if ( test_card.afmt != *format )
244 test_card.afmt = *format;
245 test_card.audio = realloc( test_card.audio, 1920 * 2 * sizeof( int16_t ) );
246 memset( test_card.audio, 0, 1920 * 2 * sizeof( int16_t ) );
249 *buffer = test_card.audio;
257 void mlt_frame_close( mlt_frame this )
259 mlt_frame frame = mlt_frame_pop_frame( this );
261 while ( frame != NULL )
263 mlt_frame_close( frame);
264 frame = mlt_frame_pop_frame( this );
267 mlt_properties_close( &this->parent );
272 /***** convenience functions *****/
273 #define RGB2YUV(r, g, b, y, u, v)\
274 y = (306*r + 601*g + 117*b) >> 10;\
275 u = ((-172*r - 340*g + 512*b) >> 10) + 128;\
276 v = ((512*r - 429*g - 83*b) >> 10) + 128;\
280 y = y > 255 ? 255 : y;\
281 u = u > 255 ? 255 : u;\
282 v = v > 255 ? 255 : v
284 int mlt_convert_rgb24a_to_yuv422( uint8_t *rgba, int width, int height, int stride, uint8_t *yuv, uint8_t *alpha )
287 register int y0, y1, u0, u1, v0, v1;
288 register int r, g, b;
289 register uint8_t *d = yuv;
292 for ( i = 0; i < height; i++ )
294 register uint8_t *s = rgba + ( stride * i );
295 for ( j = 0; j < ( width / 2 ); j++ )
301 RGB2YUV (r, g, b, y0, u0 , v0);
306 RGB2YUV (r, g, b, y1, u1 , v1);
318 RGB2YUV (r, g, b, y0, u0 , v0);
326 int mlt_convert_rgb24_to_yuv422( uint8_t *rgb, int width, int height, int stride, uint8_t *yuv )
329 register int y0, y1, u0, u1, v0, v1;
330 register int r, g, b;
331 register uint8_t *d = yuv;
334 for ( i = 0; i < height; i++ )
336 register uint8_t *s = rgb + ( stride * i );
337 for ( j = 0; j < ( width / 2 ); j++ )
342 RGB2YUV (r, g, b, y0, u0 , v0);
346 RGB2YUV (r, g, b, y1, u1 , v1);
357 RGB2YUV (r, g, b, y0, u0 , v0);
365 int mlt_convert_yuv420p_to_yuv422( uint8_t *yuv420p, int width, int height, int stride, uint8_t *yuv )
370 int half = width >> 1;
372 uint8_t *Y = yuv420p;
373 uint8_t *U = Y + width * height;
374 uint8_t *V = U + width * height / 4;
376 register uint8_t *d = yuv;
378 for ( i = 0; i < height; i++ )
380 register uint8_t *u = U + ( i / 2 ) * ( half );
381 register uint8_t *v = V + ( i / 2 ) * ( half );
383 for ( j = 0; j < half; j++ )
394 int mlt_frame_composite_yuv( mlt_frame this, mlt_frame that, int x, int y, float weight )
397 int width_src, height_src;
398 int width_dest, height_dest;
399 mlt_image_format format_src, format_dest;
400 uint8_t *p_src, *p_dest;
404 int x_src = 0, y_src = 0;
406 // optimization point - no work to do
407 if ( ( x < 0 && -x >= width_src ) || ( y < 0 && -y >= height_src ) )
410 format_src = mlt_image_yuv422;
411 format_dest = mlt_image_yuv422;
413 mlt_frame_get_image( this, &p_dest, &format_dest, &width_dest, &height_dest, 1 /* writable */ );
414 mlt_frame_get_image( that, &p_src, &format_src, &width_src, &height_src, 0 /* writable */ );
416 stride_src = width_src * 2;
417 stride_dest = width_dest * 2;
419 // crop overlay off the left edge of frame
427 // crop overlay beyond right edge of frame
428 else if ( x + width_src > width_dest )
429 width_src = width_dest - x;
431 // crop overlay off the top edge of the frame
437 // crop overlay below bottom edge of frame
438 else if ( y + height_src > height_dest )
439 height_src = height_dest - y;
441 // offset pointer into overlay buffer based on cropping
442 p_src += x_src * 2 + y_src * stride_src;
444 // offset pointer into frame buffer based upon positive, even coordinates only!
445 // if ( interlaced && y % 2 )
447 p_dest += ( x < 0 ? 0 : x ) * 2 + ( y < 0 ? 0 : y ) * stride_dest;
449 // Get the alpha channel of the overlay
450 uint8_t *p_alpha = mlt_frame_get_alpha_mask( that );
452 // offset pointer into alpha channel based upon cropping
454 p_alpha += x_src + y_src * stride_src / 2;
456 // now do the compositing only to cropped extents
457 for ( i = 0; i < height_src; i++ )
462 uint8_t *z = p_alpha;
464 for ( j = 0; j < width_src; j ++ )
468 uint8_t a = ( z == NULL ) ? 255 : *z ++;
469 float value = ( weight * ( float ) a / 255.0 );
470 *o ++ = (uint8_t)( y * value + *q++ * ( 1 - value ) );
471 *o ++ = (uint8_t)( uv * value + *q++ * ( 1 - value ) );
475 p_dest += stride_dest;
477 p_alpha += stride_src / 2;
483 void *memfill( void *dst, void *src, int l, int elements )
486 for ( i = 0; i < elements; i ++ )
487 dst = memcpy( dst, src, l ) + l;
491 void mlt_resize_yuv422( uint8_t *output, int owidth, int oheight, uint8_t *input, int iwidth, int iheight )
494 int istride = iwidth * 2;
495 int ostride = owidth * 2;
497 iwidth = iwidth - ( iwidth % 4 );
498 owidth = owidth - ( owidth % 4 );
499 iheight = iheight - ( iheight % 2 );
500 oheight = oheight - ( oheight % 2 );
502 // Coordinates (0,0 is middle of output)
506 int out_x_range = owidth / 2;
507 int out_y_range = oheight / 2;
508 int in_x_range = iwidth / 2 < out_x_range ? iwidth / 2 : out_x_range;
509 int in_y_range = iheight / 2 < out_y_range ? iheight / 2 : out_y_range;
512 uint8_t *out_line = output;
513 uint8_t *out_ptr = out_line;
515 // Calculate a middle and possibly invalid pointer in the input
516 uint8_t *in_middle = input + istride * ( iheight / 2 ) + ( iwidth / 2 ) * 2;
517 int in_line = - in_y_range * istride - in_x_range * 2;
519 uint8_t black[ 2 ] = { 16, 128 };
521 // Loop for the entirety of our output height.
522 for ( y = - out_y_range; y < out_y_range ; y ++ )
524 // Start at the beginning of the line
527 if ( abs( y ) < iheight / 2 )
529 // Fill the outer part with black
530 out_ptr = memfill( out_ptr, black, 2, out_x_range - in_x_range );
532 // We're in the input range for this row.
533 memcpy( out_ptr, in_middle + in_line, 2 * iwidth );
534 out_ptr += 2 * iwidth;
536 // Fill the outer part with black
537 out_ptr = memfill( out_ptr, black, 2, out_x_range - in_x_range );
539 // Move to next input line
544 // Fill whole line with black
545 out_ptr = memfill( out_ptr, black, 2, owidth );
548 // Move to next output line
553 /** A resizing function for yuv422 frames - this does not rescale, but simply
554 resizes. It assumes yuv422 images available on the frame so use with care.
557 uint8_t *mlt_frame_resize_yuv422( mlt_frame this, int owidth, int oheight )
560 mlt_properties properties = mlt_frame_properties( this );
562 // Get the input image, width and height
563 uint8_t *input = mlt_properties_get_data( properties, "image", NULL );
564 int iwidth = mlt_properties_get_int( properties, "width" );
565 int iheight = mlt_properties_get_int( properties, "height" );
567 // If width and height are correct, don't do anything
568 if ( iwidth != owidth || iheight != oheight )
570 // Create the output image
571 uint8_t *output = malloc( owidth * oheight * 2 );
573 // Call the generic resize
574 mlt_resize_yuv422( output, owidth, oheight, input, iwidth, iheight );
576 // Now update the frame
577 mlt_properties_set_data( properties, "image", output, owidth * oheight * 2, free, NULL );
578 mlt_properties_set_int( properties, "width", owidth );
579 mlt_properties_set_int( properties, "height", oheight );
585 // No change, return input
589 /** A rescaling function for yuv422 frames - low quality, and provided for testing
590 only. It assumes yuv422 images available on the frame so use with care.
593 uint8_t *mlt_frame_rescale_yuv422( mlt_frame this, int owidth, int oheight )
596 mlt_properties properties = mlt_frame_properties( this );
598 // Get the input image, width and height
599 uint8_t *input = mlt_properties_get_data( properties, "image", NULL );
600 int iwidth = mlt_properties_get_int( properties, "width" );
601 int iheight = mlt_properties_get_int( properties, "height" );
603 // If width and height are correct, don't do anything
604 if ( iwidth != owidth || iheight != oheight )
606 // Create the output image
607 uint8_t *output = malloc( owidth * oheight * 2 );
610 int istride = iwidth * 2;
611 int ostride = owidth * 2;
613 iwidth = iwidth - ( iwidth % 4 );
615 // Coordinates (0,0 is middle of output)
618 // Derived coordinates
622 int out_x_range = owidth / 2;
623 int out_y_range = oheight / 2;
624 int in_x_range = iwidth / 2;
625 int in_y_range = iheight / 2;
628 uint8_t *out_line = output;
631 // Calculate a middle pointer
632 uint8_t *in_middle = input + istride * in_y_range + in_x_range * 2;
636 // Generate the affine transform scaling values
637 float scale_width = ( float )iwidth / ( float )owidth;
638 float scale_height = ( float )iheight / ( float )oheight;
640 // Loop for the entirety of our output height.
641 for ( y = - out_y_range; y < out_y_range ; y ++ )
643 // Calculate the derived y value
644 dy = scale_height * y;
646 // Start at the beginning of the line
649 // Pointer to the middle of the input line
650 in_line = in_middle + dy * istride;
652 // Loop for the entirety of our output row.
653 for ( x = - out_x_range; x < out_x_range; x += 1 )
655 // Calculated the derived x
656 dx = scale_width * x;
658 // Check if x and y are in the valid input range.
659 if ( abs( dx ) < in_x_range && abs( dy ) < in_y_range )
661 // We're in the input range for this row.
662 in_ptr = in_line + ( dx >> 1 ) * 4 + 2 * ( x & 1 );
663 *out_ptr ++ = *in_ptr ++;
664 *out_ptr ++ = *in_ptr ++;
668 // We're not in the input range for this row.
674 // Move to next output line
678 // Now update the frame
679 mlt_properties_set_data( properties, "image", output, owidth * oheight * 2, free, NULL );
680 mlt_properties_set_int( properties, "width", owidth );
681 mlt_properties_set_int( properties, "height", oheight );
687 // No change, return input