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 )
208 return get_image( this, buffer, format, width, height, writable );
210 else if ( mlt_properties_get_data( properties, "image", NULL ) != NULL )
212 *format = mlt_image_yuv422;
213 *buffer = mlt_properties_get_data( properties, "image", NULL );
214 *width = mlt_properties_get_int( properties, "width" );
215 *height = mlt_properties_get_int( properties, "height" );
217 else if ( producer != NULL )
219 mlt_frame test_frame = NULL;
220 mlt_service_get_frame( mlt_producer_service( producer ), &test_frame, 0 );
221 if ( test_frame != NULL )
223 mlt_properties test_properties = mlt_frame_properties( test_frame );
224 mlt_properties_set_double( test_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "consumer_aspect_ratio" ) );
225 mlt_properties_set( test_properties, "rescale.interp", mlt_properties_get( properties, "rescale.interp" ) );
226 mlt_frame_get_image( test_frame, buffer, format, width, height, writable );
227 mlt_properties_set_data( properties, "test_card_frame", test_frame, 0, ( mlt_destructor )mlt_frame_close, NULL );
228 mlt_properties_set_data( properties, "image", *buffer, *width * *height * 2, NULL, NULL );
229 mlt_properties_set_int( properties, "width", *width );
230 mlt_properties_set_int( properties, "height", *height );
231 mlt_properties_set( properties, "rescale.interp", "none" );
232 mlt_properties_set( properties, "scale", "off" );
236 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
237 mlt_frame_get_image( this, buffer, format, width, height, writable );
246 *width = *width == 0 ? 720 : *width;
247 *height = *height == 0 ? 576 : *height;
248 size = *width * *height;
250 mlt_properties_set_int( properties, "width", *width );
251 mlt_properties_set_int( properties, "height", *height );
252 mlt_properties_set_int( properties, "aspect_ratio", 1 );
260 case mlt_image_rgb24:
263 *buffer = mlt_pool_alloc( size );
265 memset( *buffer, 255, size );
267 case mlt_image_rgb24a:
270 *buffer = mlt_pool_alloc( size );
272 memset( *buffer, 255, size );
274 case mlt_image_yuv422:
277 *buffer = mlt_pool_alloc( size );
280 while ( p != NULL && p != q )
286 case mlt_image_yuv420p:
288 *buffer = mlt_pool_alloc( size );
290 memset( *buffer, 255, size );
294 mlt_properties_set_data( properties, "image", *buffer, size, ( mlt_destructor )mlt_pool_release, NULL );
295 mlt_properties_set_int( properties, "test_image", 1 );
301 uint8_t *mlt_frame_get_alpha_mask( mlt_frame this )
303 if ( this->get_alpha_mask != NULL )
304 return this->get_alpha_mask( this );
308 int mlt_frame_get_audio( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples )
310 mlt_properties properties = mlt_frame_properties( this );
312 if ( this->get_audio != NULL )
314 this->get_audio( this, buffer, format, frequency, channels, samples );
316 else if ( mlt_properties_get_data( properties, "audio", NULL ) )
318 *buffer = mlt_properties_get_data( properties, "audio", NULL );
319 *frequency = mlt_properties_get_int( properties, "audio_frequency" );
320 *channels = mlt_properties_get_int( properties, "audio_channels" );
321 *samples = mlt_properties_get_int( properties, "audio_samples" );
326 *samples = *samples <= 0 ? 1920 : *samples;
327 *channels = *channels <= 0 ? 2 : *channels;
328 *frequency = *frequency <= 0 ? 48000 : *frequency;
329 size = *samples * *channels * sizeof( int16_t );
330 *buffer = mlt_pool_alloc( size );
331 if ( *buffer != NULL )
332 memset( *buffer, 0, size );
333 mlt_properties_set_data( properties, "audio", *buffer, size, ( mlt_destructor )mlt_pool_release, NULL );
334 mlt_properties_set_int( properties, "test_audio", 1 );
337 mlt_properties_set_int( properties, "audio_frequency", *frequency );
338 mlt_properties_set_int( properties, "audio_channels", *channels );
339 mlt_properties_set_int( properties, "audio_samples", *samples );
344 unsigned char *mlt_frame_get_waveform( mlt_frame this, int w, int h )
347 mlt_properties properties = mlt_frame_properties( this );
348 mlt_audio_format format = mlt_audio_pcm;
349 int frequency = 32000; // lower frequency available?
351 double fps = mlt_properties_get_double( properties, "fps" );
352 int samples = mlt_sample_calculator( fps, frequency, mlt_frame_get_position( this ) );
355 mlt_frame_get_audio( this, &pcm, &format, &frequency, &channels, &samples );
357 // Make an 8-bit buffer large enough to hold rendering
359 unsigned char *bitmap = ( unsigned char* )mlt_pool_alloc( size );
360 if ( bitmap != NULL )
361 memset( bitmap, 0, size );
362 mlt_properties_set_data( properties, "waveform", bitmap, size, ( mlt_destructor )mlt_pool_release, NULL );
364 // Render vertical lines
365 int16_t *ubound = pcm + samples * channels;
366 int skip = samples / w - 1;
369 // Iterate sample stream and along x coordinate
370 for ( i = 0; i < w && pcm < ubound; i++ )
372 // pcm data has channels interleaved
373 for ( j = 0; j < channels; j++ )
375 // Determine sample's magnitude from 2s complement;
376 int pcm_magnitude = *pcm < 0 ? ~(*pcm) + 1 : *pcm;
377 // The height of a line is the ratio of the magnitude multiplied by
378 // half the vertical resolution
379 int height = ( int )( ( double )( pcm_magnitude ) / 32768 * h / 2 );
380 // Determine the starting y coordinate - left channel above center,
381 // right channel below - currently assumes 2 channels
382 int displacement = ( h / 2 ) - ( 1 - j ) * height;
383 // Position buffer pointer using y coordinate, stride, and x coordinate
384 unsigned char *p = &bitmap[ i + displacement * w ];
386 // Draw vertical line
387 for ( k = 0; k < height; k++ )
392 pcm += skip * channels;
399 void mlt_frame_close( mlt_frame this )
401 if ( this != NULL && mlt_properties_dec_ref( mlt_frame_properties( this ) ) <= 0 )
403 mlt_deque_close( this->stack_image );
404 mlt_deque_close( this->stack_audio );
405 mlt_properties_close( &this->parent );
410 /***** convenience functions *****/
412 int mlt_convert_rgb24a_to_yuv422( uint8_t *rgba, int width, int height, int stride, uint8_t *yuv, uint8_t *alpha )
415 register int y0, y1, u0, u1, v0, v1;
416 register int r, g, b;
417 register uint8_t *d = yuv;
420 for ( i = 0; i < height; i++ )
422 register uint8_t *s = rgba + ( stride * i );
423 for ( j = 0; j < ( width / 2 ); j++ )
429 RGB2YUV (r, g, b, y0, u0 , v0);
434 RGB2YUV (r, g, b, y1, u1 , v1);
446 RGB2YUV (r, g, b, y0, u0 , v0);
454 int mlt_convert_rgb24_to_yuv422( uint8_t *rgb, int width, int height, int stride, uint8_t *yuv )
457 register int y0, y1, u0, u1, v0, v1;
458 register int r, g, b;
459 register uint8_t *d = yuv;
462 for ( i = 0; i < height; i++ )
464 register uint8_t *s = rgb + ( stride * i );
465 for ( j = 0; j < ( width / 2 ); j++ )
470 RGB2YUV (r, g, b, y0, u0 , v0);
474 RGB2YUV (r, g, b, y1, u1 , v1);
485 RGB2YUV (r, g, b, y0, u0 , v0);
493 int mlt_convert_yuv420p_to_yuv422( uint8_t *yuv420p, int width, int height, int stride, uint8_t *yuv )
498 int half = width >> 1;
500 uint8_t *Y = yuv420p;
501 uint8_t *U = Y + width * height;
502 uint8_t *V = U + width * height / 4;
504 register uint8_t *d = yuv;
506 for ( i = 0; i < height; i++ )
508 register uint8_t *u = U + ( i / 2 ) * ( half );
509 register uint8_t *v = V + ( i / 2 ) * ( half );
511 for ( j = 0; j < half; j++ )
522 void mlt_resize_yuv422( uint8_t *output, int owidth, int oheight, uint8_t *input, int iwidth, int iheight )
525 int istride = iwidth * 2;
526 int ostride = owidth * 2;
528 iwidth = iwidth - ( iwidth % 4 );
529 owidth = owidth - ( owidth % 4 );
530 iheight = iheight - ( iheight % 2 );
531 oheight = oheight - ( oheight % 2 );
533 // Optimisation point
534 if ( iwidth == owidth && iheight == oheight )
535 memcpy( output, input, iheight * istride );
537 // Coordinates (0,0 is middle of output)
541 int out_x_range = owidth / 2;
542 int out_y_range = oheight / 2;
543 int in_x_range = iwidth / 2 < out_x_range ? iwidth / 2 : out_x_range;
544 int in_y_range = iheight / 2 < out_y_range ? iheight / 2 : out_y_range;
547 uint8_t *out_line = output;
548 uint8_t *out_ptr = out_line;
550 // Calculate a middle and possibly invalid pointer in the input
551 uint8_t *in_middle = input + istride * ( iheight / 2 ) + ( iwidth / 2 ) * 2;
552 int in_line = - in_y_range * istride - in_x_range * 2;
556 // Fill whole section with black
557 y = out_y_range - ( iheight / 2 );
558 int blank_elements = ostride * y / 2;
559 elements = blank_elements;
560 while ( elements -- )
566 int active_width = 2 * iwidth;
567 int inactive_width = out_x_range - in_x_range;
571 // Loop for the entirety of our output height.
574 // Start at the beginning of the line
577 // Fill the outer part with black
578 elements = inactive_width;
579 while ( elements -- )
585 // We're in the input range for this row.
586 p = in_middle + in_line;
587 end = out_ptr + active_width;
588 while ( out_ptr != end )
594 // Fill the outer part with black
595 elements = inactive_width;
596 while ( elements -- )
602 // Move to next input line
605 // Move to next output line
609 // Fill whole section with black
610 elements = blank_elements;
611 while ( elements -- )
618 /** A resizing function for yuv422 frames - this does not rescale, but simply
619 resizes. It assumes yuv422 images available on the frame so use with care.
622 uint8_t *mlt_frame_resize_yuv422( mlt_frame this, int owidth, int oheight )
625 mlt_properties properties = mlt_frame_properties( this );
627 // Get the input image, width and height
628 uint8_t *input = mlt_properties_get_data( properties, "image", NULL );
629 int iwidth = mlt_properties_get_int( properties, "width" );
630 int iheight = mlt_properties_get_int( properties, "height" );
632 // If width and height are correct, don't do anything
633 if ( iwidth != owidth || iheight != oheight )
635 // Create the output image
636 uint8_t *output = mlt_pool_alloc( owidth * ( oheight + 1 ) * 2 );
638 // Call the generic resize
639 mlt_resize_yuv422( output, owidth, oheight, input, iwidth, iheight );
641 // Now update the frame
642 mlt_properties_set_data( properties, "image", output, owidth * ( oheight + 1 ) * 2, ( mlt_destructor )mlt_pool_release, NULL );
643 mlt_properties_set_int( properties, "width", owidth );
644 mlt_properties_set_int( properties, "height", oheight );
649 // No change, return input
653 /** A rescaling function for yuv422 frames - low quality, and provided for testing
654 only. It assumes yuv422 images available on the frame so use with care.
657 uint8_t *mlt_frame_rescale_yuv422( mlt_frame this, int owidth, int oheight )
660 mlt_properties properties = mlt_frame_properties( this );
662 // Get the input image, width and height
663 uint8_t *input = mlt_properties_get_data( properties, "image", NULL );
664 int iwidth = mlt_properties_get_int( properties, "width" );
665 int iheight = mlt_properties_get_int( properties, "height" );
667 // If width and height are correct, don't do anything
668 if ( iwidth != owidth || iheight != oheight )
670 // Create the output image
671 uint8_t *output = mlt_pool_alloc( owidth * ( oheight + 1 ) * 2 );
674 int istride = iwidth * 2;
675 int ostride = owidth * 2;
677 iwidth = iwidth - ( iwidth % 4 );
679 // Derived coordinates
683 int out_x_range = owidth / 2;
684 int out_y_range = oheight / 2;
685 int in_x_range = iwidth / 2;
686 int in_y_range = iheight / 2;
689 register uint8_t *out_line = output;
690 register uint8_t *out_ptr;
692 // Calculate a middle pointer
693 uint8_t *in_middle = input + istride * in_y_range + in_x_range * 2;
696 // Generate the affine transform scaling values
697 register int scale_width = ( iwidth << 16 ) / owidth;
698 register int scale_height = ( iheight << 16 ) / oheight;
699 register int base = 0;
701 int outer = out_x_range * scale_width;
702 int bottom = out_y_range * scale_height;
704 // Loop for the entirety of our output height.
705 for ( dy = - bottom; dy < bottom; dy += scale_height )
707 // Start at the beginning of the line
710 // Pointer to the middle of the input line
711 in_line = in_middle + ( dy >> 16 ) * istride;
713 // Loop for the entirety of our output row.
714 for ( dx = - outer; dx < outer; dx += scale_width )
718 *out_ptr ++ = *( in_line + base );
720 *out_ptr ++ = *( in_line + base + 1 );
724 *out_ptr ++ = *( in_line + base );
726 *out_ptr ++ = *( in_line + base + 3 );
729 // Move to next output line
733 // Now update the frame
734 mlt_properties_set_data( properties, "image", output, owidth * ( oheight + 1 ) * 2, ( mlt_destructor )mlt_pool_release, NULL );
735 mlt_properties_set_int( properties, "width", owidth );
736 mlt_properties_set_int( properties, "height", oheight );
742 // No change, return input
746 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 )
750 int frequency_src = *frequency, frequency_dest = *frequency;
751 int channels_src = *channels, channels_dest = *channels;
752 int samples_src = *samples, samples_dest = *samples;
756 mlt_frame_get_audio( this, &dest, format, &frequency_dest, &channels_dest, &samples_dest );
757 //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" ) );
758 mlt_frame_get_audio( that, &src, format, &frequency_src, &channels_src, &samples_src );
759 //fprintf( stderr, "mix: frame src samples %d channels %d\n", samples_src, channels_src );
761 if ( channels_src > 6 )
763 if ( channels_dest > 6 )
765 if ( samples_src > 4000 )
767 if ( samples_dest > 4000 )
770 // determine number of samples to process
771 *samples = samples_src < samples_dest ? samples_src : samples_dest;
772 *channels = channels_src < channels_dest ? channels_src : channels_dest;
774 *frequency = frequency_dest;
776 // Compute a smooth ramp over start to end
777 float weight = weight_start;
778 float weight_step = ( weight_end - weight_start ) / *samples;
781 for ( i = 0; i < *samples; i++ )
783 for ( j = 0; j < *channels; j++ )
785 if ( j < channels_dest )
786 d = (double) dest[ i * channels_dest + j ];
787 if ( j < channels_src )
788 s = (double) src[ i * channels_src + j ];
789 dest[ i * channels_dest + j ] = s * weight + d * ( 1.0 - weight );
791 weight += weight_step;
797 int mlt_sample_calculator( float fps, int frequency, int64_t position )
801 if ( ( int )( fps * 100 ) == 2997 )
803 samples = frequency / 30;
808 if ( position % 5 != 0 )
812 if ( position % 300 == 0 )
814 else if ( position % 30 == 0 )
816 else if ( position % 2 == 0 )
822 if ( position % 30 == 0 )
824 else if ( position % 29 == 0 )
826 else if ( position % 4 == 2 )
837 samples = frequency / fps;