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
  26 typedef enum
  27 {
  28         mlt_image_none = 0,
  29         mlt_image_rgb24,
  30         mlt_image_rgb24a,
  31         mlt_image_yuv422,
  32         mlt_image_yuv420p
  33 }
  34 mlt_image_format;
  35
  36 typedef enum
  37 {
  38         mlt_video_standard_pal = 0,
  39         mlt_video_standard_ntsc
  40 }
  41 mlt_video_standard;
  42
  43 typedef enum
  44 {
  45         mlt_audio_none = 0,
  46         mlt_audio_pcm
  47 }
  48 mlt_audio_format;
  49
  50 typedef int ( *mlt_get_image )( mlt_frame this, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
  51
  52 struct mlt_frame_s
  53 {
  54         // We're extending properties here
  55         struct mlt_properties_s parent;
  56
  57         // Virtual methods
  58         int ( *get_audio )( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
  59         uint8_t * ( *get_alpha_mask )( mlt_frame this );
  60
  61         // Private properties
  62         mlt_get_image stack_get_image[ 10 ];
  63         int stack_get_image_size;
  64         mlt_frame stack_frame[ 10 ];
  65         int stack_frame_size;
  66 };
  67
  68 extern mlt_frame mlt_frame_init( );
  69 extern mlt_properties mlt_frame_properties( mlt_frame this );
  70 extern int mlt_frame_is_test_card( 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_timecode mlt_frame_get_timecode( mlt_frame this );
  74 extern int mlt_frame_set_timecode( mlt_frame this, mlt_timecode 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_frame_composite_yuv( mlt_frame this, mlt_frame that, int x, int y, float weight );
  90
  91 #endif
  92