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_double( properties
, "aspect_ratio", mlt_frame_get_aspect_ratio( test_frame
) );
232 mlt_properties_set( properties
, "rescale.interp", "none" );
233 mlt_properties_set( properties
, "scale", "off" );
237 mlt_properties_set_data( properties
, "test_card_producer", NULL
, 0, NULL
, NULL
);
238 mlt_frame_get_image( this, buffer
, format
, width
, height
, writable
);
247 *width
= *width
== 0 ?
720 : *width
;
248 *height
= *height
== 0 ?
576 : *height
;
249 size
= *width
* *height
;
251 mlt_properties_set_int( properties
, "width", *width
);
252 mlt_properties_set_int( properties
, "height", *height
);
253 mlt_properties_set_int( properties
, "aspect_ratio", 1 );
261 case mlt_image_rgb24
:
264 *buffer
= mlt_pool_alloc( size
);
266 memset( *buffer
, 255, size
);
268 case mlt_image_rgb24a
:
271 *buffer
= mlt_pool_alloc( size
);
273 memset( *buffer
, 255, size
);
275 case mlt_image_yuv422
:
278 *buffer
= mlt_pool_alloc( size
);
281 while ( p
!= NULL
&& p
!= q
)
287 case mlt_image_yuv420p
:
289 *buffer
= mlt_pool_alloc( size
);
291 memset( *buffer
, 255, size
);
295 mlt_properties_set_data( properties
, "image", *buffer
, size
, ( mlt_destructor
)mlt_pool_release
, NULL
);
296 mlt_properties_set_int( properties
, "test_image", 1 );
302 uint8_t *mlt_frame_get_alpha_mask( mlt_frame
this )
304 if ( this->get_alpha_mask
!= NULL
)
305 return this->get_alpha_mask( this );
309 int mlt_frame_get_audio( mlt_frame
this, int16_t **buffer
, mlt_audio_format
*format
, int *frequency
, int *channels
, int *samples
)
311 mlt_properties properties
= mlt_frame_properties( this );
313 if ( this->get_audio
!= NULL
)
315 this->get_audio( this, buffer
, format
, frequency
, channels
, samples
);
317 else if ( mlt_properties_get_data( properties
, "audio", NULL
) )
319 *buffer
= mlt_properties_get_data( properties
, "audio", NULL
);
320 *frequency
= mlt_properties_get_int( properties
, "audio_frequency" );
321 *channels
= mlt_properties_get_int( properties
, "audio_channels" );
322 *samples
= mlt_properties_get_int( properties
, "audio_samples" );
327 *samples
= *samples
<= 0 ?
1920 : *samples
;
328 *channels
= *channels
<= 0 ?
2 : *channels
;
329 *frequency
= *frequency
<= 0 ?
48000 : *frequency
;
330 size
= *samples
* *channels
* sizeof( int16_t );
331 *buffer
= mlt_pool_alloc( size
);
332 if ( *buffer
!= NULL
)
333 memset( *buffer
, 0, size
);
334 mlt_properties_set_data( properties
, "audio", *buffer
, size
, ( mlt_destructor
)mlt_pool_release
, NULL
);
335 mlt_properties_set_int( properties
, "test_audio", 1 );
338 mlt_properties_set_int( properties
, "audio_frequency", *frequency
);
339 mlt_properties_set_int( properties
, "audio_channels", *channels
);
340 mlt_properties_set_int( properties
, "audio_samples", *samples
);
345 unsigned char *mlt_frame_get_waveform( mlt_frame
this, int w
, int h
)
348 mlt_properties properties
= mlt_frame_properties( this );
349 mlt_audio_format format
= mlt_audio_pcm
;
350 int frequency
= 32000; // lower frequency available?
352 double fps
= mlt_properties_get_double( properties
, "fps" );
353 int samples
= mlt_sample_calculator( fps
, frequency
, mlt_frame_get_position( this ) );
356 mlt_frame_get_audio( this, &pcm
, &format
, &frequency
, &channels
, &samples
);
358 // Make an 8-bit buffer large enough to hold rendering
360 unsigned char *bitmap
= ( unsigned char* )mlt_pool_alloc( size
);
361 if ( bitmap
!= NULL
)
362 memset( bitmap
, 0, size
);
363 mlt_properties_set_data( properties
, "waveform", bitmap
, size
, ( mlt_destructor
)mlt_pool_release
, NULL
);
365 // Render vertical lines
366 int16_t *ubound
= pcm
+ samples
* channels
;
367 int skip
= samples
/ w
- 1;
370 // Iterate sample stream and along x coordinate
371 for ( i
= 0; i
< w
&& pcm
< ubound
; i
++ )
373 // pcm data has channels interleaved
374 for ( j
= 0; j
< channels
; j
++ )
376 // Determine sample's magnitude from 2s complement;
377 int pcm_magnitude
= *pcm
< 0 ?
~(*pcm
) + 1 : *pcm
;
378 // The height of a line is the ratio of the magnitude multiplied by
379 // half the vertical resolution
380 int height
= ( int )( ( double )( pcm_magnitude
) / 32768 * h
/ 2 );
381 // Determine the starting y coordinate - left channel above center,
382 // right channel below - currently assumes 2 channels
383 int displacement
= ( h
/ 2 ) - ( 1 - j
) * height
;
384 // Position buffer pointer using y coordinate, stride, and x coordinate
385 unsigned char *p
= &bitmap
[ i
+ displacement
* w
];
387 // Draw vertical line
388 for ( k
= 0; k
< height
; k
++ )
393 pcm
+= skip
* channels
;
400 void mlt_frame_close( mlt_frame
this )
402 if ( this != NULL
&& mlt_properties_dec_ref( mlt_frame_properties( this ) ) <= 0 )
404 mlt_deque_close( this->stack_image
);
405 mlt_deque_close( this->stack_audio
);
406 mlt_properties_close( &this->parent
);
411 /***** convenience functions *****/
413 int mlt_convert_rgb24a_to_yuv422( uint8_t *rgba
, int width
, int height
, int stride
, uint8_t *yuv
, uint8_t *alpha
)
416 register int y0
, y1
, u0
, u1
, v0
, v1
;
417 register int r
, g
, b
;
418 register uint8_t *d
= yuv
;
421 for ( i
= 0; i
< height
; i
++ )
423 register uint8_t *s
= rgba
+ ( stride
* i
);
424 for ( j
= 0; j
< ( width
/ 2 ); j
++ )
430 RGB2YUV (r
, g
, b
, y0
, u0
, v0
);
435 RGB2YUV (r
, g
, b
, y1
, u1
, v1
);
447 RGB2YUV (r
, g
, b
, y0
, u0
, v0
);
455 int mlt_convert_rgb24_to_yuv422( uint8_t *rgb
, int width
, int height
, int stride
, uint8_t *yuv
)
458 register int y0
, y1
, u0
, u1
, v0
, v1
;
459 register int r
, g
, b
;
460 register uint8_t *d
= yuv
;
463 for ( i
= 0; i
< height
; i
++ )
465 register uint8_t *s
= rgb
+ ( stride
* i
);
466 for ( j
= 0; j
< ( width
/ 2 ); j
++ )
471 RGB2YUV (r
, g
, b
, y0
, u0
, v0
);
475 RGB2YUV (r
, g
, b
, y1
, u1
, v1
);
486 RGB2YUV (r
, g
, b
, y0
, u0
, v0
);
494 int mlt_convert_yuv420p_to_yuv422( uint8_t *yuv420p
, int width
, int height
, int stride
, uint8_t *yuv
)
499 int half
= width
>> 1;
501 uint8_t *Y
= yuv420p
;
502 uint8_t *U
= Y
+ width
* height
;
503 uint8_t *V
= U
+ width
* height
/ 4;
505 register uint8_t *d
= yuv
;
507 for ( i
= 0; i
< height
; i
++ )
509 register uint8_t *u
= U
+ ( i
/ 2 ) * ( half
);
510 register uint8_t *v
= V
+ ( i
/ 2 ) * ( half
);
512 for ( j
= 0; j
< half
; j
++ )
523 void mlt_resize_yuv422( uint8_t *output
, int owidth
, int oheight
, uint8_t *input
, int iwidth
, int iheight
)
526 int istride
= iwidth
* 2;
527 int ostride
= owidth
* 2;
529 iwidth
= iwidth
- ( iwidth
% 4 );
530 owidth
= owidth
- ( owidth
% 4 );
531 iheight
= iheight
- ( iheight
% 2 );
532 oheight
= oheight
- ( oheight
% 2 );
534 // Optimisation point
535 if ( iwidth
== owidth
&& iheight
== oheight
)
536 memcpy( output
, input
, iheight
* istride
);
538 // Coordinates (0,0 is middle of output)
542 int out_x_range
= owidth
/ 2;
543 int out_y_range
= oheight
/ 2;
544 int in_x_range
= iwidth
/ 2 < out_x_range ? iwidth
/ 2 : out_x_range
;
545 int in_y_range
= iheight
/ 2 < out_y_range ? iheight
/ 2 : out_y_range
;
548 uint8_t *out_line
= output
;
549 uint8_t *out_ptr
= out_line
;
551 // Calculate a middle and possibly invalid pointer in the input
552 uint8_t *in_middle
= input
+ istride
* ( iheight
/ 2 ) + ( iwidth
/ 2 ) * 2;
553 int in_line
= - in_y_range
* istride
- in_x_range
* 2;
557 // Fill whole section with black
558 y
= out_y_range
- ( iheight
/ 2 );
559 int blank_elements
= ostride
* y
/ 2;
560 elements
= blank_elements
;
561 while ( elements
-- )
567 int active_width
= 2 * iwidth
;
568 int inactive_width
= out_x_range
- in_x_range
;
572 // Loop for the entirety of our output height.
575 // Start at the beginning of the line
578 // Fill the outer part with black
579 elements
= inactive_width
;
580 while ( elements
-- )
586 // We're in the input range for this row.
587 p
= in_middle
+ in_line
;
588 end
= out_ptr
+ active_width
;
589 while ( out_ptr
!= end
)
595 // Fill the outer part with black
596 elements
= inactive_width
;
597 while ( elements
-- )
603 // Move to next input line
606 // Move to next output line
610 // Fill whole section with black
611 elements
= blank_elements
;
612 while ( elements
-- )
619 /** A resizing function for yuv422 frames - this does not rescale, but simply
620 resizes. It assumes yuv422 images available on the frame so use with care.
623 uint8_t *mlt_frame_resize_yuv422( mlt_frame
this, int owidth
, int oheight
)
626 mlt_properties properties
= mlt_frame_properties( this );
628 // Get the input image, width and height
629 uint8_t *input
= mlt_properties_get_data( properties
, "image", NULL
);
630 int iwidth
= mlt_properties_get_int( properties
, "width" );
631 int iheight
= mlt_properties_get_int( properties
, "height" );
633 // If width and height are correct, don't do anything
634 if ( iwidth
!= owidth
|| iheight
!= oheight
)
636 // Create the output image
637 uint8_t *output
= mlt_pool_alloc( owidth
* ( oheight
+ 1 ) * 2 );
639 // Call the generic resize
640 mlt_resize_yuv422( output
, owidth
, oheight
, input
, iwidth
, iheight
);
642 // Now update the frame
643 mlt_properties_set_data( properties
, "image", output
, owidth
* ( oheight
+ 1 ) * 2, ( mlt_destructor
)mlt_pool_release
, NULL
);
644 mlt_properties_set_int( properties
, "width", owidth
);
645 mlt_properties_set_int( properties
, "height", oheight
);
650 // No change, return input
654 /** A rescaling function for yuv422 frames - low quality, and provided for testing
655 only. It assumes yuv422 images available on the frame so use with care.
658 uint8_t *mlt_frame_rescale_yuv422( mlt_frame
this, int owidth
, int oheight
)
661 mlt_properties properties
= mlt_frame_properties( this );
663 // Get the input image, width and height
664 uint8_t *input
= mlt_properties_get_data( properties
, "image", NULL
);
665 int iwidth
= mlt_properties_get_int( properties
, "width" );
666 int iheight
= mlt_properties_get_int( properties
, "height" );
668 // If width and height are correct, don't do anything
669 if ( iwidth
!= owidth
|| iheight
!= oheight
)
671 // Create the output image
672 uint8_t *output
= mlt_pool_alloc( owidth
* ( oheight
+ 1 ) * 2 );
675 int istride
= iwidth
* 2;
676 int ostride
= owidth
* 2;
678 iwidth
= iwidth
- ( iwidth
% 4 );
680 // Derived coordinates
684 int out_x_range
= owidth
/ 2;
685 int out_y_range
= oheight
/ 2;
686 int in_x_range
= iwidth
/ 2;
687 int in_y_range
= iheight
/ 2;
690 register uint8_t *out_line
= output
;
691 register uint8_t *out_ptr
;
693 // Calculate a middle pointer
694 uint8_t *in_middle
= input
+ istride
* in_y_range
+ in_x_range
* 2;
697 // Generate the affine transform scaling values
698 register int scale_width
= ( iwidth
<< 16 ) / owidth
;
699 register int scale_height
= ( iheight
<< 16 ) / oheight
;
700 register int base
= 0;
702 int outer
= out_x_range
* scale_width
;
703 int bottom
= out_y_range
* scale_height
;
705 // Loop for the entirety of our output height.
706 for ( dy
= - bottom
; dy
< bottom
; dy
+= scale_height
)
708 // Start at the beginning of the line
711 // Pointer to the middle of the input line
712 in_line
= in_middle
+ ( dy
>> 16 ) * istride
;
714 // Loop for the entirety of our output row.
715 for ( dx
= - outer
; dx
< outer
; dx
+= scale_width
)
719 *out_ptr
++ = *( in_line
+ base
);
721 *out_ptr
++ = *( in_line
+ base
+ 1 );
725 *out_ptr
++ = *( in_line
+ base
);
727 *out_ptr
++ = *( in_line
+ base
+ 3 );
730 // Move to next output line
734 // Now update the frame
735 mlt_properties_set_data( properties
, "image", output
, owidth
* ( oheight
+ 1 ) * 2, ( mlt_destructor
)mlt_pool_release
, NULL
);
736 mlt_properties_set_int( properties
, "width", owidth
);
737 mlt_properties_set_int( properties
, "height", oheight
);
743 // No change, return input
747 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
)
751 int frequency_src
= *frequency
, frequency_dest
= *frequency
;
752 int channels_src
= *channels
, channels_dest
= *channels
;
753 int samples_src
= *samples
, samples_dest
= *samples
;
757 mlt_frame_get_audio( this, &dest
, format
, &frequency_dest
, &channels_dest
, &samples_dest
);
758 //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" ) );
759 mlt_frame_get_audio( that
, &src
, format
, &frequency_src
, &channels_src
, &samples_src
);
760 //fprintf( stderr, "mix: frame src samples %d channels %d\n", samples_src, channels_src );
762 if ( channels_src
> 6 )
764 if ( channels_dest
> 6 )
766 if ( samples_src
> 4000 )
768 if ( samples_dest
> 4000 )
771 // determine number of samples to process
772 *samples
= samples_src
< samples_dest ? samples_src
: samples_dest
;
773 *channels
= channels_src
< channels_dest ? channels_src
: channels_dest
;
775 *frequency
= frequency_dest
;
777 // Compute a smooth ramp over start to end
778 float weight
= weight_start
;
779 float weight_step
= ( weight_end
- weight_start
) / *samples
;
782 for ( i
= 0; i
< *samples
; i
++ )
784 for ( j
= 0; j
< *channels
; j
++ )
786 if ( j
< channels_dest
)
787 d
= (double) dest
[ i
* channels_dest
+ j
];
788 if ( j
< channels_src
)
789 s
= (double) src
[ i
* channels_src
+ j
];
790 dest
[ i
* channels_dest
+ j
] = s
* weight
+ d
* ( 1.0 - weight
);
792 weight
+= weight_step
;
798 int mlt_sample_calculator( float fps
, int frequency
, int64_t position
)
802 if ( ( int )( fps
* 100 ) == 2997 )
804 samples
= frequency
/ 30;
809 if ( position
% 5 != 0 )
813 if ( position
% 300 == 0 )
815 else if ( position
% 30 == 0 )
817 else if ( position
% 2 == 0 )
823 if ( position
% 30 == 0 )
825 else if ( position
% 29 == 0 )
827 else if ( position
% 4 == 2 )
838 samples
= frequency
/ fps
;