git.sesse.net Git - mlt/blob - 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_image_none = 0,
  30         mlt_image_rgb24,
  31         mlt_image_rgb24a,
  32         mlt_image_yuv422,
  33         mlt_image_yuv420p
  34 }
  35 mlt_image_format;
  36
  37 typedef enum
  38 {
  39         mlt_video_standard_pal = 0,
  40         mlt_video_standard_ntsc
  41 }
  42 mlt_video_standard;
  43
  44 typedef enum
  45 {
  46         mlt_audio_none = 0,
  47         mlt_audio_pcm
  48 }
  49 mlt_audio_format;
  50
  51 typedef int ( *mlt_get_image )( mlt_frame this, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
  52
  53 struct mlt_frame_s
  54 {
  55         // We're extending properties here
  56         struct mlt_properties_s parent;
  57
  58         // Virtual methods
  59         int ( *get_audio )( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
  60         uint8_t * ( *get_alpha_mask )( mlt_frame this );
  61
  62         // Private properties
  63         mlt_deque stack_get_image;
  64         mlt_deque stack_frame;
  65 };
  66
  67 extern mlt_frame mlt_frame_init( );
  68 extern mlt_properties mlt_frame_properties( mlt_frame this );
  69 extern int mlt_frame_is_test_card( mlt_frame this );
  70 extern int mlt_frame_is_test_audio( mlt_frame this );
  71 extern double mlt_frame_get_aspect_ratio( mlt_frame this );
  72 extern int mlt_frame_set_aspect_ratio( mlt_frame this, double value );
  73 extern mlt_position mlt_frame_get_position( mlt_frame this );
  74 extern int mlt_frame_set_position( mlt_frame this, mlt_position value );
  75
  76 extern int mlt_frame_get_image( mlt_frame this, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
  77 extern uint8_t *mlt_frame_get_alpha_mask( mlt_frame this );
  78 extern int mlt_frame_get_audio( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
  79
  80 extern int mlt_frame_push_get_image( mlt_frame this, mlt_get_image get_image );
  81 extern mlt_get_image mlt_frame_pop_get_image( mlt_frame this );
  82 extern int mlt_frame_push_frame( mlt_frame this, mlt_frame that );
  83 extern mlt_frame mlt_frame_pop_frame( mlt_frame this );
  84 extern void mlt_frame_close( mlt_frame this );
  85
  86 /* convenience functions */
  87 extern int mlt_convert_rgb24a_to_yuv422( uint8_t *rgba, int width, int height, int stride, uint8_t *yuv, uint8_t *alpha );
  88 extern int mlt_convert_rgb24_to_yuv422( uint8_t *rgb, int width, int height, int stride, uint8_t *yuv );
  89 extern int mlt_convert_yuv420p_to_yuv422( uint8_t *yuv420p, int width, int height, int stride, uint8_t *yuv );
  90 extern uint8_t *mlt_frame_resize_yuv422( mlt_frame this, int owidth, int oheight );
  91 extern uint8_t *mlt_frame_rescale_yuv422( mlt_frame this, int owidth, int oheight );
  92 extern void mlt_resize_yuv422( uint8_t *output, int owidth, int oheight, uint8_t *input, int iwidth, int iheight );
  93 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  );
  94 extern int mlt_sample_calculator( float fps, int frequency, int64_t position );
  95
  96 #endif
  97