transition region
[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 enum
28 {
29 mlt_video_standard_pal = 0,
30 mlt_video_standard_ntsc
31 }
32 mlt_video_standard;
33
34 typedef enum
35 {
36 mlt_audio_none = 0,
37 mlt_audio_pcm
38 }
39 mlt_audio_format;
40
41 typedef int ( *mlt_get_image )( mlt_frame this, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
42
43 struct mlt_frame_s
44 {
45 // We're extending properties here
46 struct mlt_properties_s parent;
47
48 // Virtual methods
49 int ( *get_audio )( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
50 uint8_t * ( *get_alpha_mask )( mlt_frame this );
51
52 // Private properties
53 mlt_deque stack_get_image;
54 mlt_deque stack_frame;
55 mlt_deque stack_service;
56 };
57
58 extern mlt_frame mlt_frame_init( );
59 extern mlt_properties mlt_frame_properties( mlt_frame this );
60 extern int mlt_frame_is_test_card( mlt_frame this );
61 extern int mlt_frame_is_test_audio( mlt_frame this );
62 extern double mlt_frame_get_aspect_ratio( mlt_frame this );
63 extern int mlt_frame_set_aspect_ratio( mlt_frame this, double value );
64 extern mlt_position mlt_frame_get_position( mlt_frame this );
65 extern int mlt_frame_set_position( mlt_frame this, mlt_position value );
66
67 extern int mlt_frame_get_image( mlt_frame this, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
68 extern uint8_t *mlt_frame_get_alpha_mask( mlt_frame this );
69 extern int mlt_frame_get_audio( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
70
71 extern int mlt_frame_push_get_image( mlt_frame this, mlt_get_image get_image );
72 extern mlt_get_image mlt_frame_pop_get_image( mlt_frame this );
73 extern int mlt_frame_push_frame( mlt_frame this, mlt_frame that );
74 extern mlt_frame mlt_frame_pop_frame( mlt_frame this );
75 extern int mlt_frame_push_service( mlt_frame this, void *that );
76 extern void *mlt_frame_pop_service( mlt_frame this );
77 extern void mlt_frame_close( mlt_frame this );
78
79 /* convenience functions */
80 extern int mlt_convert_rgb24a_to_yuv422( uint8_t *rgba, int width, int height, int stride, uint8_t *yuv, uint8_t *alpha );
81 extern int mlt_convert_rgb24_to_yuv422( uint8_t *rgb, int width, int height, int stride, uint8_t *yuv );
82 extern int mlt_convert_yuv420p_to_yuv422( uint8_t *yuv420p, int width, int height, int stride, uint8_t *yuv );
83 extern uint8_t *mlt_frame_resize_yuv422( mlt_frame this, int owidth, int oheight );
84 extern uint8_t *mlt_frame_rescale_yuv422( mlt_frame this, int owidth, int oheight );
85 extern void mlt_resize_yuv422( uint8_t *output, int owidth, int oheight, uint8_t *input, int iwidth, int iheight );
86 extern 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 );
87 extern int mlt_sample_calculator( float fps, int frequency, int64_t position );
88
89 /* this macro scales rgb into the yuv gamut, y is scaled by 219/255 and uv by 224/255 */
90 #define RGB2YUV(r, g, b, y, u, v)\
91 y = ((257*r + 504*g + 98*b) >> 10) + 16;\
92 u = ((-148*r - 291*g + 439*b) >> 10) + 128;\
93 v = ((439*r - 368*g - 71*b) >> 10) + 128;\
94 y = y < 16 ? 16 : y;\
95 u = u < 16 ? 16 : u;\
96 v = v < 16 ? 16 : v;\
97 y = y > 235 ? 235 : y;\
98 u = u > 240 ? 240 : u;\
99 v = v > 240 ? 240 : v
100
101 /* this macro assumes the user has already scaled their rgb down into the broadcast limits */
102 #define RGB2YUV_UNSCALED(r, g, b, y, u, v)\
103 y = (299*r + 587*g + 114*b) >> 10;\
104 u = ((-169*r - 331*g + 500*b) >> 10) + 128;\
105 v = ((500*r - 419*g - 81*b) >> 10) + 128;\
106 y = y < 16 ? 16 : y;\
107 u = u < 16 ? 16 : u;\
108 v = v < 16 ? 16 : v;\
109 y = y > 235 ? 235 : y;\
110 u = u > 240 ? 240 : u;\
111 v = v > 240 ? 240 : v
112
113 #endif
114