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"
23 #include "mlt_producer.h"
24 #include "mlt_factory.h"
29 /** Constructor for a frame.
32 mlt_frame mlt_frame_init( )
35 mlt_frame this = calloc( sizeof( struct mlt_frame_s ), 1 );
39 // Get the normalisation
40 char *normalisation = mlt_environment( "MLT_NORMALISATION" );
42 // Initialise the properties
43 mlt_properties properties = &this->parent;
44 mlt_properties_init( properties, this );
46 // Set default properties on the frame
47 mlt_properties_set_position( properties, "_position", 0.0 );
48 mlt_properties_set_data( properties, "image", NULL, 0, NULL, NULL );
50 if ( normalisation == NULL || strcmp( normalisation, "NTSC" ) )
52 mlt_properties_set_int( properties, "width", 720 );
53 mlt_properties_set_int( properties, "height", 576 );
54 mlt_properties_set_int( properties, "normalised_width", 720 );
55 mlt_properties_set_int( properties, "normalised_height", 576 );
56 mlt_properties_set_double( properties, "aspect_ratio", 72.0/79.0 );
60 mlt_properties_set_int( properties, "width", 720 );
61 mlt_properties_set_int( properties, "height", 480 );
62 mlt_properties_set_int( properties, "normalised_width", 720 );
63 mlt_properties_set_int( properties, "normalised_height", 480 );
64 mlt_properties_set_double( properties, "aspect_ratio", 128.0/117.0 );
67 mlt_properties_set_data( properties, "audio", NULL, 0, NULL, NULL );
68 mlt_properties_set_data( properties, "alpha", NULL, 0, NULL, NULL );
70 // Construct stacks for frames and methods
71 this->stack_image = mlt_deque_init( );
72 this->stack_audio = mlt_deque_init( );
78 /** Fetch the frames properties.
81 mlt_properties mlt_frame_properties( mlt_frame this )
83 return this != NULL ? &this->parent : NULL;
86 /** Check if we have a way to derive something other than a test card.
89 int mlt_frame_is_test_card( mlt_frame this )
91 return mlt_deque_count( this->stack_image ) == 0 || mlt_properties_get_int( mlt_frame_properties( this ), "test_image" );
94 /** Check if we have a way to derive something than test audio.
97 int mlt_frame_is_test_audio( mlt_frame this )
99 return this->get_audio == NULL || mlt_properties_get_int( mlt_frame_properties( this ), "test_audio" );
102 /** Get the aspect ratio of the frame.
105 double mlt_frame_get_aspect_ratio( mlt_frame this )
107 return mlt_properties_get_double( mlt_frame_properties( this ), "aspect_ratio" );
110 /** Set the aspect ratio of the frame.
113 int mlt_frame_set_aspect_ratio( mlt_frame this, double value )
115 return mlt_properties_set_double( mlt_frame_properties( this ), "aspect_ratio", value );
118 /** Get the position of this frame.
121 mlt_position mlt_frame_get_position( mlt_frame this )
123 return mlt_properties_get_position( mlt_frame_properties( this ), "_position" );
126 /** Set the position of this frame.
129 int mlt_frame_set_position( mlt_frame this, mlt_position value )
131 return mlt_properties_set_position( mlt_frame_properties( this ), "_position", value );
134 /** Stack a get_image callback.
137 int mlt_frame_push_get_image( mlt_frame this, mlt_get_image get_image )
139 return mlt_deque_push_back( this->stack_image, get_image );
142 /** Pop a get_image callback.
145 mlt_get_image mlt_frame_pop_get_image( mlt_frame this )
147 return mlt_deque_pop_back( this->stack_image );
153 int mlt_frame_push_frame( mlt_frame this, mlt_frame that )
155 return mlt_deque_push_back( this->stack_image, that );
161 mlt_frame mlt_frame_pop_frame( mlt_frame this )
163 return mlt_deque_pop_back( this->stack_image );
169 int mlt_frame_push_service( mlt_frame this, void *that )
171 return mlt_deque_push_back( this->stack_image, that );
177 void *mlt_frame_pop_service( mlt_frame this )
179 return mlt_deque_pop_back( this->stack_image );
182 /** Push an audio item on the stack.
185 int mlt_frame_push_audio( mlt_frame this, void *that )
187 return mlt_deque_push_back( this->stack_audio, that );
190 /** Pop an audio item from the stack
193 void *mlt_frame_pop_audio( mlt_frame this )
195 return mlt_deque_pop_back( this->stack_audio );
198 int mlt_frame_get_image( mlt_frame this, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable )
200 mlt_properties properties = mlt_frame_properties( this );
201 mlt_get_image get_image = mlt_frame_pop_get_image( this );
202 mlt_producer producer = mlt_properties_get_data( properties, "test_card_producer", NULL );
204 *width = *width >> 1 << 1;
206 if ( get_image != NULL )
209 mlt_position position = mlt_frame_get_position( this );
210 error = get_image( this, buffer, format, width, height, writable );
211 mlt_frame_set_position( this, position );
214 else if ( mlt_properties_get_data( properties, "image", NULL ) != NULL )
216 *format = mlt_image_yuv422;
217 *buffer = mlt_properties_get_data( properties, "image", NULL );
218 *width = mlt_properties_get_int( properties, "width" );
219 *height = mlt_properties_get_int( properties, "height" );
221 else if ( producer != NULL )
223 mlt_frame test_frame = NULL;
224 mlt_service_get_frame( mlt_producer_service( producer ), &test_frame, 0 );
225 if ( test_frame != NULL )
227 mlt_properties test_properties = mlt_frame_properties( test_frame );
228 mlt_properties_set_double( test_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "consumer_aspect_ratio" ) );
229 mlt_properties_set( test_properties, "rescale.interp", mlt_properties_get( properties, "rescale.interp" ) );
230 mlt_frame_get_image( test_frame, buffer, format, width, height, writable );
231 mlt_properties_set_data( properties, "test_card_frame", test_frame, 0, ( mlt_destructor )mlt_frame_close, NULL );
232 mlt_properties_set_data( properties, "image", *buffer, *width * *height * 2, NULL, NULL );
233 mlt_properties_set_int( properties, "width", *width );
234 mlt_properties_set_int( properties, "height", *height );
235 mlt_properties_set_double( properties, "aspect_ratio", mlt_frame_get_aspect_ratio( test_frame ) );
236 mlt_properties_set( properties, "rescale.interp", "none" );
237 mlt_properties_set( properties, "scale", "off" );
241 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
242 mlt_frame_get_image( this, buffer, format, width, height, writable );
251 *width = *width == 0 ? 720 : *width;
252 *height = *height == 0 ? 576 : *height;
253 size = *width * *height;
255 mlt_properties_set_int( properties, "width", *width );
256 mlt_properties_set_int( properties, "height", *height );
257 mlt_properties_set_int( properties, "aspect_ratio", 1 );
265 case mlt_image_rgb24:
268 *buffer = mlt_pool_alloc( size );
270 memset( *buffer, 255, size );
272 case mlt_image_rgb24a:
275 *buffer = mlt_pool_alloc( size );
277 memset( *buffer, 255, size );
279 case mlt_image_yuv422:
282 *buffer = mlt_pool_alloc( size );
285 while ( p != NULL && p != q )
291 case mlt_image_yuv420p:
293 *buffer = mlt_pool_alloc( size );
295 memset( *buffer, 255, size );
299 mlt_properties_set_data( properties, "image", *buffer, size, ( mlt_destructor )mlt_pool_release, NULL );
300 mlt_properties_set_int( properties, "test_image", 1 );
306 uint8_t *mlt_frame_get_alpha_mask( mlt_frame this )
308 if ( this->get_alpha_mask != NULL )
309 return this->get_alpha_mask( this );
313 int mlt_frame_get_audio( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples )
315 mlt_properties properties = mlt_frame_properties( this );
317 if ( this->get_audio != NULL )
319 this->get_audio( this, buffer, format, frequency, channels, samples );
321 else if ( mlt_properties_get_data( properties, "audio", NULL ) )
323 *buffer = mlt_properties_get_data( properties, "audio", NULL );
324 *frequency = mlt_properties_get_int( properties, "audio_frequency" );
325 *channels = mlt_properties_get_int( properties, "audio_channels" );
326 *samples = mlt_properties_get_int( properties, "audio_samples" );
331 *samples = *samples <= 0 ? 1920 : *samples;
332 *channels = *channels <= 0 ? 2 : *channels;
333 *frequency = *frequency <= 0 ? 48000 : *frequency;
334 size = *samples * *channels * sizeof( int16_t );
335 *buffer = mlt_pool_alloc( size );
336 if ( *buffer != NULL )
337 memset( *buffer, 0, size );
338 mlt_properties_set_data( properties, "audio", *buffer, size, ( mlt_destructor )mlt_pool_release, NULL );
339 mlt_properties_set_int( properties, "test_audio", 1 );
342 mlt_properties_set_int( properties, "audio_frequency", *frequency );
343 mlt_properties_set_int( properties, "audio_channels", *channels );
344 mlt_properties_set_int( properties, "audio_samples", *samples );
349 unsigned char *mlt_frame_get_waveform( mlt_frame this, int w, int h )
352 mlt_properties properties = mlt_frame_properties( this );
353 mlt_audio_format format = mlt_audio_pcm;
354 int frequency = 32000; // lower frequency available?
356 double fps = mlt_properties_get_double( properties, "fps" );
357 int samples = mlt_sample_calculator( fps, frequency, mlt_frame_get_position( this ) );
360 mlt_frame_get_audio( this, &pcm, &format, &frequency, &channels, &samples );
362 // Make an 8-bit buffer large enough to hold rendering
364 unsigned char *bitmap = ( unsigned char* )mlt_pool_alloc( size );
365 if ( bitmap != NULL )
366 memset( bitmap, 0, size );
367 mlt_properties_set_data( properties, "waveform", bitmap, size, ( mlt_destructor )mlt_pool_release, NULL );
369 // Render vertical lines
370 int16_t *ubound = pcm + samples * channels;
371 int skip = samples / w - 1;
374 // Iterate sample stream and along x coordinate
375 for ( i = 0; i < w && pcm < ubound; i++ )
377 // pcm data has channels interleaved
378 for ( j = 0; j < channels; j++ )
380 // Determine sample's magnitude from 2s complement;
381 int pcm_magnitude = *pcm < 0 ? ~(*pcm) + 1 : *pcm;
382 // The height of a line is the ratio of the magnitude multiplied by
383 // half the vertical resolution
384 int height = ( int )( ( double )( pcm_magnitude ) / 32768 * h / 2 );
385 // Determine the starting y coordinate - left channel above center,
386 // right channel below - currently assumes 2 channels
387 int displacement = ( h / 2 ) - ( 1 - j ) * height;
388 // Position buffer pointer using y coordinate, stride, and x coordinate
389 unsigned char *p = &bitmap[ i + displacement * w ];
391 // Draw vertical line
392 for ( k = 0; k < height; k++ )
397 pcm += skip * channels;
403 mlt_producer mlt_frame_get_original_producer( mlt_frame this )
406 return mlt_properties_get_data( mlt_frame_properties( this ), "_producer", NULL );
410 void mlt_frame_close( mlt_frame this )
412 if ( this != NULL && mlt_properties_dec_ref( mlt_frame_properties( this ) ) <= 0 )
414 mlt_deque_close( this->stack_image );
415 mlt_deque_close( this->stack_audio );
416 mlt_properties_close( &this->parent );
421 /***** convenience functions *****/
423 int mlt_convert_rgb24a_to_yuv422( uint8_t *rgba, int width, int height, int stride, uint8_t *yuv, uint8_t *alpha )
426 register int y0, y1, u0, u1, v0, v1;
427 register int r, g, b;
428 register uint8_t *d = yuv;
431 for ( i = 0; i < height; i++ )
433 register uint8_t *s = rgba + ( stride * i );
434 for ( j = 0; j < ( width / 2 ); j++ )
440 RGB2YUV (r, g, b, y0, u0 , v0);
445 RGB2YUV (r, g, b, y1, u1 , v1);
457 RGB2YUV (r, g, b, y0, u0 , v0);
465 int mlt_convert_rgb24_to_yuv422( uint8_t *rgb, int width, int height, int stride, uint8_t *yuv )
468 register int y0, y1, u0, u1, v0, v1;
469 register int r, g, b;
470 register uint8_t *d = yuv;
473 for ( i = 0; i < height; i++ )
475 register uint8_t *s = rgb + ( stride * i );
476 for ( j = 0; j < ( width / 2 ); j++ )
481 RGB2YUV (r, g, b, y0, u0 , v0);
485 RGB2YUV (r, g, b, y1, u1 , v1);
496 RGB2YUV (r, g, b, y0, u0 , v0);
504 int mlt_convert_yuv420p_to_yuv422( uint8_t *yuv420p, int width, int height, int stride, uint8_t *yuv )
509 int half = width >> 1;
511 uint8_t *Y = yuv420p;
512 uint8_t *U = Y + width * height;
513 uint8_t *V = U + width * height / 4;
515 register uint8_t *d = yuv;
517 for ( i = 0; i < height; i++ )
519 register uint8_t *u = U + ( i / 2 ) * ( half );
520 register uint8_t *v = V + ( i / 2 ) * ( half );
522 for ( j = 0; j < half; j++ )
533 void mlt_resize_yuv422( uint8_t *output, int owidth, int oheight, uint8_t *input, int iwidth, int iheight )
536 int istride = iwidth * 2;
537 int ostride = owidth * 2;
539 iwidth = iwidth - ( iwidth % 4 );
540 owidth = owidth - ( owidth % 4 );
541 iheight = iheight - ( iheight % 2 );
542 oheight = oheight - ( oheight % 2 );
544 // Optimisation point
545 if ( iwidth == owidth && iheight == oheight )
546 memcpy( output, input, iheight * istride );
548 // Coordinates (0,0 is middle of output)
552 int out_x_range = owidth / 2;
553 int out_y_range = oheight / 2;
554 int in_x_range = iwidth / 2 < out_x_range ? iwidth / 2 : out_x_range;
555 int in_y_range = iheight / 2 < out_y_range ? iheight / 2 : out_y_range;
558 uint8_t *out_line = output;
559 uint8_t *out_ptr = out_line;
561 // Calculate a middle and possibly invalid pointer in the input
562 uint8_t *in_middle = input + istride * ( iheight / 2 ) + ( iwidth / 2 ) * 2;
563 int in_line = - in_y_range * istride - in_x_range * 2;
567 // Fill whole section with black
568 y = out_y_range - ( iheight / 2 );
569 int blank_elements = ostride * y / 2;
570 elements = blank_elements;
571 while ( elements -- )
577 int active_width = 2 * iwidth;
578 int inactive_width = out_x_range - in_x_range;
582 // Loop for the entirety of our output height.
585 // Start at the beginning of the line
588 // Fill the outer part with black
589 elements = inactive_width;
590 while ( elements -- )
596 // We're in the input range for this row.
597 p = in_middle + in_line;
598 end = out_ptr + active_width;
599 while ( out_ptr != end )
605 // Fill the outer part with black
606 elements = inactive_width;
607 while ( elements -- )
613 // Move to next input line
616 // Move to next output line
620 // Fill whole section with black
621 elements = blank_elements;
622 while ( elements -- )
629 /** A resizing function for yuv422 frames - this does not rescale, but simply
630 resizes. It assumes yuv422 images available on the frame so use with care.
633 uint8_t *mlt_frame_resize_yuv422( mlt_frame this, int owidth, int oheight )
636 mlt_properties properties = mlt_frame_properties( this );
638 // Get the input image, width and height
639 uint8_t *input = mlt_properties_get_data( properties, "image", NULL );
640 int iwidth = mlt_properties_get_int( properties, "width" );
641 int iheight = mlt_properties_get_int( properties, "height" );
643 // If width and height are correct, don't do anything
644 if ( iwidth != owidth || iheight != oheight )
646 // Create the output image
647 uint8_t *output = mlt_pool_alloc( owidth * ( oheight + 1 ) * 2 );
649 // Call the generic resize
650 mlt_resize_yuv422( output, owidth, oheight, input, iwidth, iheight );
652 // Now update the frame
653 mlt_properties_set_data( properties, "image", output, owidth * ( oheight + 1 ) * 2, ( mlt_destructor )mlt_pool_release, NULL );
654 mlt_properties_set_int( properties, "width", owidth );
655 mlt_properties_set_int( properties, "height", oheight );
660 // No change, return input
664 /** A rescaling function for yuv422 frames - low quality, and provided for testing
665 only. It assumes yuv422 images available on the frame so use with care.
668 uint8_t *mlt_frame_rescale_yuv422( mlt_frame this, int owidth, int oheight )
671 mlt_properties properties = mlt_frame_properties( this );
673 // Get the input image, width and height
674 uint8_t *input = mlt_properties_get_data( properties, "image", NULL );
675 int iwidth = mlt_properties_get_int( properties, "width" );
676 int iheight = mlt_properties_get_int( properties, "height" );
678 // If width and height are correct, don't do anything
679 if ( iwidth != owidth || iheight != oheight )
681 // Create the output image
682 uint8_t *output = mlt_pool_alloc( owidth * ( oheight + 1 ) * 2 );
685 int istride = iwidth * 2;
686 int ostride = owidth * 2;
688 iwidth = iwidth - ( iwidth % 4 );
690 // Derived coordinates
694 int out_x_range = owidth / 2;
695 int out_y_range = oheight / 2;
696 int in_x_range = iwidth / 2;
697 int in_y_range = iheight / 2;
700 register uint8_t *out_line = output;
701 register uint8_t *out_ptr;
703 // Calculate a middle pointer
704 uint8_t *in_middle = input + istride * in_y_range + in_x_range * 2;
707 // Generate the affine transform scaling values
708 register int scale_width = ( iwidth << 16 ) / owidth;
709 register int scale_height = ( iheight << 16 ) / oheight;
710 register int base = 0;
712 int outer = out_x_range * scale_width;
713 int bottom = out_y_range * scale_height;
715 // Loop for the entirety of our output height.
716 for ( dy = - bottom; dy < bottom; dy += scale_height )
718 // Start at the beginning of the line
721 // Pointer to the middle of the input line
722 in_line = in_middle + ( dy >> 16 ) * istride;
724 // Loop for the entirety of our output row.
725 for ( dx = - outer; dx < outer; dx += scale_width )
729 *out_ptr ++ = *( in_line + base );
731 *out_ptr ++ = *( in_line + base + 1 );
735 *out_ptr ++ = *( in_line + base );
737 *out_ptr ++ = *( in_line + base + 3 );
740 // Move to next output line
744 // Now update the frame
745 mlt_properties_set_data( properties, "image", output, owidth * ( oheight + 1 ) * 2, ( mlt_destructor )mlt_pool_release, NULL );
746 mlt_properties_set_int( properties, "width", owidth );
747 mlt_properties_set_int( properties, "height", oheight );
753 // No change, return input
757 int mlt_frame_mix_audio( mlt_frame this, mlt_frame that, float weight_start, float weight_end, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples )
761 int frequency_src = *frequency, frequency_dest = *frequency;
762 int channels_src = *channels, channels_dest = *channels;
763 int samples_src = *samples, samples_dest = *samples;
767 mlt_frame_get_audio( this, &dest, format, &frequency_dest, &channels_dest, &samples_dest );
768 //fprintf( stderr, "mix: frame dest samples %d channels %d position %lld\n", samples_dest, channels_dest, mlt_properties_get_position( mlt_frame_properties( this ), "_position" ) );
769 mlt_frame_get_audio( that, &src, format, &frequency_src, &channels_src, &samples_src );
770 //fprintf( stderr, "mix: frame src samples %d channels %d\n", samples_src, channels_src );
772 if ( channels_src > 6 )
774 if ( channels_dest > 6 )
776 if ( samples_src > 4000 )
778 if ( samples_dest > 4000 )
781 // determine number of samples to process
782 *samples = samples_src < samples_dest ? samples_src : samples_dest;
783 *channels = channels_src < channels_dest ? channels_src : channels_dest;
785 *frequency = frequency_dest;
787 // Compute a smooth ramp over start to end
788 float weight = weight_start;
789 float weight_step = ( weight_end - weight_start ) / *samples;
792 for ( i = 0; i < *samples; i++ )
794 for ( j = 0; j < *channels; j++ )
796 if ( j < channels_dest )
797 d = (double) dest[ i * channels_dest + j ];
798 if ( j < channels_src )
799 s = (double) src[ i * channels_src + j ];
800 dest[ i * channels_dest + j ] = s * weight + d * ( 1.0 - weight );
802 weight += weight_step;
808 int mlt_sample_calculator( float fps, int frequency, int64_t position )
812 if ( ( int )( fps * 100 ) == 2997 )
814 samples = frequency / 30;
819 if ( position % 5 != 0 )
823 if ( position % 300 == 0 )
825 else if ( position % 30 == 0 )
827 else if ( position % 2 == 0 )
833 if ( position % 30 == 0 )
835 else if ( position % 29 == 0 )
837 else if ( position % 4 == 2 )
848 samples = frequency / fps;