Transitions reworked (always_active capabilities); remaining audio handling switched...
[melted] / src / framework / mlt_frame.h
1 /*
2 * mlt_frame.h -- interface for all frame classes
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
5 *
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.
10 *
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.
15 *
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.
19 */
20
21 #ifndef _MLT_FRAME_H_
22 #define _MLT_FRAME_H_
23
24 #include "mlt_properties.h"
25 #include "mlt_deque.h"
26
27 typedef int ( *mlt_get_image )( mlt_frame self, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
28 typedef int ( *mlt_get_audio )( mlt_frame self, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
29
30 struct mlt_frame_s
31 {
32 // We're extending properties here
33 struct mlt_properties_s parent;
34
35 // Virtual methods
36 uint8_t * ( *get_alpha_mask )( mlt_frame self );
37
38 // Private properties
39 mlt_deque stack_image;
40 mlt_deque stack_audio;
41 mlt_deque stack_service;
42 };
43
44 #define MLT_FRAME_PROPERTIES( frame ) ( &( frame )->parent )
45 #define MLT_FRAME_SERVICE_STACK( frame ) ( ( frame )->stack_service )
46
47 extern mlt_frame mlt_frame_init( );
48 extern mlt_properties mlt_frame_properties( mlt_frame self );
49 extern int mlt_frame_is_test_card( mlt_frame self );
50 extern int mlt_frame_is_test_audio( mlt_frame self );
51 extern double mlt_frame_get_aspect_ratio( mlt_frame self );
52 extern int mlt_frame_set_aspect_ratio( mlt_frame self, double value );
53 extern mlt_position mlt_frame_get_position( mlt_frame self );
54 extern int mlt_frame_set_position( mlt_frame self, mlt_position value );
55 extern void mlt_frame_replace_image( mlt_frame self, uint8_t *image, mlt_image_format format, int width, int height );
56 extern int mlt_frame_get_image( mlt_frame self, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
57 extern uint8_t *mlt_frame_get_alpha_mask( mlt_frame self );
58 extern int mlt_frame_get_audio( mlt_frame self, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
59 extern unsigned char *mlt_frame_get_waveform( mlt_frame self, int w, int h );
60 extern int mlt_frame_push_get_image( mlt_frame self, mlt_get_image get_image );
61 extern mlt_get_image mlt_frame_pop_get_image( mlt_frame self );
62 extern int mlt_frame_push_frame( mlt_frame self, mlt_frame that );
63 extern mlt_frame mlt_frame_pop_frame( mlt_frame self );
64 extern int mlt_frame_push_service( mlt_frame self, void *that );
65 extern void *mlt_frame_pop_service( mlt_frame self );
66 extern int mlt_frame_push_audio( mlt_frame self, void *that );
67 extern void *mlt_frame_pop_audio( mlt_frame self );
68 extern mlt_deque mlt_frame_service_stack( mlt_frame self );
69 extern mlt_producer mlt_frame_get_original_producer( mlt_frame self );
70 extern void mlt_frame_close( mlt_frame self );
71
72 /* convenience functions */
73 extern int mlt_convert_rgb24a_to_yuv422( uint8_t *rgba, int width, int height, int stride, uint8_t *yuv, uint8_t *alpha );
74 extern int mlt_convert_rgb24_to_yuv422( uint8_t *rgb, int width, int height, int stride, uint8_t *yuv );
75 extern int mlt_convert_yuv420p_to_yuv422( uint8_t *yuv420p, int width, int height, int stride, uint8_t *yuv );
76 extern uint8_t *mlt_frame_resize_yuv422( mlt_frame self, int owidth, int oheight );
77 extern uint8_t *mlt_frame_rescale_yuv422( mlt_frame self, int owidth, int oheight );
78 extern void mlt_resize_yuv422( uint8_t *output, int owidth, int oheight, uint8_t *input, int iwidth, int iheight );
79 extern int mlt_frame_mix_audio( mlt_frame self, mlt_frame that, float weight_start, float weight_end, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
80 extern int mlt_sample_calculator( float fps, int frequency, int64_t position );
81
82 /* this macro scales rgb into the yuv gamut, y is scaled by 219/255 and uv by 224/255 */
83 #define RGB2YUV(r, g, b, y, u, v)\
84 y = ((257*r + 504*g + 98*b) >> 10) + 16;\
85 u = ((-148*r - 291*g + 439*b) >> 10) + 128;\
86 v = ((439*r - 368*g - 71*b) >> 10) + 128;\
87 y = y < 16 ? 16 : y;\
88 u = u < 16 ? 16 : u;\
89 v = v < 16 ? 16 : v;\
90 y = y > 235 ? 235 : y;\
91 u = u > 240 ? 240 : u;\
92 v = v > 240 ? 240 : v
93
94 /* this macro assumes the user has already scaled their rgb down into the broadcast limits */
95 #define RGB2YUV_UNSCALED(r, g, b, y, u, v)\
96 y = (299*r + 587*g + 114*b) >> 10;\
97 u = ((-169*r - 331*g + 500*b) >> 10) + 128;\
98 v = ((500*r - 419*g - 81*b) >> 10) + 128;\
99 y = y < 16 ? 16 : y;\
100 u = u < 16 ? 16 : u;\
101 v = v < 16 ? 16 : v;\
102 y = y > 235 ? 235 : y;\
103 u = u > 240 ? 240 : u;\
104 v = v > 240 ? 240 : v
105
106 #endif