git.sesse.net Git - mlt/blob - src/framework/mlt_frame.h

   1 /**
   2  * \file mlt_frame.h
   3  * \brief interface for all frame classes
   4  *
   5  * Copyright (C) 2003-2008 Ushodaya Enterprises Limited
   6  * \author Charles Yates <charles.yates@pandora.be>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef _MLT_FRAME_H_
  24 #define _MLT_FRAME_H_
  25
  26 #include "mlt_properties.h"
  27 #include "mlt_deque.h"
  28 #include "mlt_service.h"
  29
  30 /** callback function to get video data
  31  *
  32  */
  33
  34 typedef int ( *mlt_get_image )( mlt_frame self, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
  35
  36 /** callback function to get audio data
  37  *
  38  */
  39
  40 typedef int ( *mlt_get_audio )( mlt_frame self, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
  41
  42 /** \brief Frame class
  43  *
  44  * \properties \em test_image set if the frame holds a "test card" image
  45  * \properties \em test_audio set if the frame holds "test card" audio
  46  * \properties \em _producer holds a reference to the frame's end producer
  47  * \properties \em _speed the current speed of the producer that generated the frame
  48  * \properties \em _position the position of the frame
  49  * \properties \em meta.* holds metadata
  50  * \properties \em hide set to 1 to hide the video, 2 to mute the audio
  51  * \properties \em last_track a flag to indicate an end-of-tracks frame
  52  */
  53
  54 struct mlt_frame_s
  55 {
  56         /* We're extending properties here */
  57         struct mlt_properties_s parent;
  58
  59         /* Virtual methods */
  60         uint8_t * ( *get_alpha_mask )( mlt_frame self );
  61
  62         /* Private properties */
  63         mlt_deque stack_image;
  64         mlt_deque stack_audio;
  65         mlt_deque stack_service;
  66 };
  67
  68 #define MLT_FRAME_PROPERTIES( frame )           ( &( frame )->parent )
  69 #define MLT_FRAME_SERVICE_STACK( frame )        ( ( frame )->stack_service )
  70 #define MLT_FRAME_IMAGE_STACK( frame )          ( ( frame )->stack_image )
  71 #define MLT_FRAME_AUDIO_STACK( frame )          ( ( frame )->stack_audio )
  72
  73 extern mlt_frame mlt_frame_init( mlt_service service );
  74 extern mlt_properties mlt_frame_properties( mlt_frame self );
  75 extern int mlt_frame_is_test_card( mlt_frame self );
  76 extern int mlt_frame_is_test_audio( mlt_frame self );
  77 extern double mlt_frame_get_aspect_ratio( mlt_frame self );
  78 extern int mlt_frame_set_aspect_ratio( mlt_frame self, double value );
  79 extern mlt_position mlt_frame_get_position( mlt_frame self );
  80 extern int mlt_frame_set_position( mlt_frame self, mlt_position value );
  81 extern void mlt_frame_replace_image( mlt_frame self, uint8_t *image, mlt_image_format format, int width, int height );
  82 extern int mlt_frame_get_image( mlt_frame self, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
  83 extern uint8_t *mlt_frame_get_alpha_mask( mlt_frame self );
  84 extern int mlt_frame_get_audio( mlt_frame self, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
  85 extern unsigned char *mlt_frame_get_waveform( mlt_frame self, int w, int h );
  86 extern int mlt_frame_push_get_image( mlt_frame self, mlt_get_image get_image );
  87 extern mlt_get_image mlt_frame_pop_get_image( mlt_frame self );
  88 extern int mlt_frame_push_frame( mlt_frame self, mlt_frame that );
  89 extern mlt_frame mlt_frame_pop_frame( mlt_frame self );
  90 extern int mlt_frame_push_service( mlt_frame self, void *that );
  91 extern void *mlt_frame_pop_service( mlt_frame self );
  92 extern int mlt_frame_push_service_int( mlt_frame self, int that );
  93 extern int mlt_frame_pop_service_int( mlt_frame self );
  94 extern int mlt_frame_push_audio( mlt_frame self, void *that );
  95 extern void *mlt_frame_pop_audio( mlt_frame self );
  96 extern mlt_deque mlt_frame_service_stack( mlt_frame self );
  97 extern mlt_producer mlt_frame_get_original_producer( mlt_frame self );
  98 extern void mlt_frame_close( mlt_frame self );
  99
 100 /* convenience functions */
 101 extern int mlt_convert_yuv422_to_rgb24a( uint8_t *yuv, uint8_t *rgba, unsigned int total );
 102 extern int mlt_convert_rgb24a_to_yuv422( uint8_t *rgba, int width, int height, int stride, uint8_t *yuv, uint8_t *alpha );
 103 extern int mlt_convert_rgb24_to_yuv422( uint8_t *rgb, int width, int height, int stride, uint8_t *yuv );
 104 extern int mlt_convert_bgr24a_to_yuv422( uint8_t *rgba, int width, int height, int stride, uint8_t *yuv, uint8_t *alpha );
 105 extern int mlt_convert_argb_to_yuv422( uint8_t *rgba, int width, int height, int stride, uint8_t *yuv, uint8_t *alpha );
 106 extern int mlt_convert_bgr24_to_yuv422( uint8_t *rgb, int width, int height, int stride, uint8_t *yuv );
 107 extern int mlt_convert_yuv420p_to_yuv422( uint8_t *yuv420p, int width, int height, int stride, uint8_t *yuv );
 108 extern uint8_t *mlt_frame_resize_yuv422( mlt_frame self, int owidth, int oheight );
 109 extern uint8_t *mlt_frame_rescale_yuv422( mlt_frame self, int owidth, int oheight );
 110 extern void mlt_resize_yuv422( uint8_t *output, int owidth, int oheight, uint8_t *input, int iwidth, int iheight );
 111 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  );
 112 extern int mlt_frame_combine_audio( mlt_frame self, mlt_frame that, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples  );
 113 extern int mlt_sample_calculator( float fps, int frequency, int64_t position );
 114 extern int64_t mlt_sample_calculator_to_now( float fps, int frequency, int64_t position );
 115
 116 /** This macro scales rgb into the yuv gamut - y is scaled by 219/255 and uv by 224/255. */
 117 #define RGB2YUV(r, g, b, y, u, v)\
 118   y = ((263*r + 516*g + 100*b) >> 10) + 16;\
 119   u = ((-152*r - 298*g + 450*b) >> 10) + 128;\
 120   v = ((450*r - 377*g - 73*b) >> 10) + 128;
 121
 122 /** This macro assumes the user has already scaled their rgb down into the broadcast limits. **/
 123 #define RGB2YUV_UNSCALED(r, g, b, y, u, v)\
 124   y = (299*r + 587*g + 114*b) >> 10;\
 125   u = ((-169*r - 331*g + 500*b) >> 10) + 128;\
 126   v = ((500*r - 419*g - 81*b) >> 10) + 128;\
 127   y = y < 16 ? 16 : y;\
 128   u = u < 16 ? 16 : u;\
 129   v = v < 16 ? 16 : v;\
 130   y = y > 235 ? 235 : y;\
 131   u = u > 240 ? 240 : u;\
 132   v = v > 240 ? 240 : v
 133
 134 /** This macro converts a YUV value to the RGB color space. */
 135 #define YUV2RGB( y, u, v, r, g, b ) \
 136   r = ((1192 * ( y - 16 ) + 1634 * ( v - 128 ) ) >> 10 ); \
 137   g = ((1192 * ( y - 16 ) - 832 * ( v - 128 ) - 400 * ( u - 128 ) ) >> 10 ); \
 138   b = ((1192 * ( y - 16 ) + 2066 * ( u - 128 ) ) >> 10 ); \
 139   r = r < 0 ? 0 : r > 255 ? 255 : r; \
 140   g = g < 0 ? 0 : g > 255 ? 255 : g; \
 141   b = b < 0 ? 0 : b > 255 ? 255 : b;
 142
 143 #endif