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  * \see mlt_frame_s
   5  *
   6  * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
   7  * \author Charles Yates <charles.yates@pandora.be>
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 #ifndef _MLT_FRAME_H_
  25 #define _MLT_FRAME_H_
  26
  27 #include "mlt_properties.h"
  28 #include "mlt_deque.h"
  29 #include "mlt_service.h"
  30
  31 /** Callback function to get video data.
  32  *
  33  */
  34
  35 typedef int ( *mlt_get_image )( mlt_frame self, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
  36
  37 /** Callback function to get audio data.
  38  *
  39  */
  40
  41 typedef int ( *mlt_get_audio )( mlt_frame self, void **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
  42
  43 /** \brief Frame class
  44  *
  45  * The frame is the primary data object that gets passed around to and through services.
  46  *
  47  * \extends mlt_properties
  48  * \properties \em test_image set if the frame holds a "test card" image
  49  * \properties \em test_audio set if the frame holds "test card" audio
  50  * \properties \em _producer holds a reference to the frame's end producer
  51  * \properties \em _speed the current speed of the producer that generated the frame
  52  * \properties \em _position the position of the frame
  53  * \properties \em meta.* holds metadata
  54  * \properties \em hide set to 1 to hide the video, 2 to mute the audio
  55  * \properties \em last_track a flag to indicate an end-of-tracks frame
  56  * \properties \em previous \em frame a reference to the unfiltered preceding frame
  57  * (no speed factor applied, only available when \em _need_previous_next is set on the producer)
  58  * \properties \em next \em frame a reference to the unfiltered following frame
  59  * (no speed factor applied, only available when \em _need_previous_next is set on the producer)
  60  * \properties \em colorspace the standard for luma coefficients
  61  * \properties \em force_full_luma luma range handling, set to -1 for pass-through, 1 for full range, 0 for scaling
  62  * \properties \em audio_frequency the sample rate of the audio
  63  * \properties \em audio_channels the number of audio channels
  64  * \properties \em audio_samples the number of audio samples
  65  * \properties \em audio_format the mlt_audio_format for the audio on this frame
  66  * \properties \em format the mlt_image_format of the image on this frame
  67  * \properties \em width the horizontal resolution of the image
  68  * \properties \em height the vertical resolution of the image
  69  * \properties \em aspect_ratio the sample aspect ratio of the image
  70  */
  71
  72 struct mlt_frame_s
  73 {
  74         struct mlt_properties_s parent; /**< \private A frame extends properties. */
  75
  76         /** Get the alpha channel (callback function).
  77          * \param self a frame
  78          * \return the 8-bit alpha channel
  79          */
  80         uint8_t * ( *get_alpha_mask )( mlt_frame self );
  81
  82         /** Convert the image format (callback function).
  83          * \param self a frame
  84          * \param[in,out] image a buffer of image data
  85          * \param[in,out] input the image format of supplied image data
  86          * \param output the image format to which to convert
  87          * \return true if error
  88          */
  89         int ( *convert_image )( mlt_frame self, uint8_t **image, mlt_image_format *input, mlt_image_format output );
  90
  91         /** Convert the audio format (callback function).
  92          * \param self a frame
  93          * \param[in,out] audio a buffer of audio data
  94          * \param[in,out] input the audio format of supplied data
  95          * \param output the audio format to which to convert
  96          * \return true if error
  97          */
  98         int ( *convert_audio )( mlt_frame self, void **audio, mlt_audio_format *input, mlt_audio_format output );
  99
 100         mlt_deque stack_image;   /**< \private the image processing stack of operations and data */
 101         mlt_deque stack_audio;   /**< \private the audio processing stack of operations and data */
 102         mlt_deque stack_service; /**< \private a general purpose data stack */
 103         int is_processing;       /**< \private indicates if a frame is or was processed by the parallel consumer */
 104 };
 105
 106 #define MLT_FRAME_PROPERTIES( frame )           ( &( frame )->parent )
 107 #define MLT_FRAME_SERVICE_STACK( frame )        ( ( frame )->stack_service )
 108 #define MLT_FRAME_IMAGE_STACK( frame )          ( ( frame )->stack_image )
 109 #define MLT_FRAME_AUDIO_STACK( frame )          ( ( frame )->stack_audio )
 110
 111 extern mlt_frame mlt_frame_init( mlt_service service );
 112 extern mlt_properties mlt_frame_properties( mlt_frame self );
 113 extern int mlt_frame_is_test_card( mlt_frame self );
 114 extern int mlt_frame_is_test_audio( mlt_frame self );
 115 extern double mlt_frame_get_aspect_ratio( mlt_frame self );
 116 extern int mlt_frame_set_aspect_ratio( mlt_frame self, double value );
 117 extern mlt_position mlt_frame_get_position( mlt_frame self );
 118 extern mlt_position mlt_frame_original_position( mlt_frame self );
 119 extern int mlt_frame_set_position( mlt_frame self, mlt_position value );
 120 extern int mlt_frame_set_image( mlt_frame self, uint8_t *image, int size, mlt_destructor destroy );
 121 extern int mlt_frame_set_alpha( mlt_frame self, uint8_t *alpha, int size, mlt_destructor destroy );
 122 extern void mlt_frame_replace_image( mlt_frame self, uint8_t *image, mlt_image_format format, int width, int height );
 123 extern int mlt_frame_get_image( mlt_frame self, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
 124 extern uint8_t *mlt_frame_get_alpha_mask( mlt_frame self );
 125 extern int mlt_frame_get_audio( mlt_frame self, void **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples );
 126 extern int mlt_frame_set_audio( mlt_frame self, void *buffer, mlt_audio_format, int size, mlt_destructor );
 127 extern unsigned char *mlt_frame_get_waveform( mlt_frame self, int w, int h );
 128 extern int mlt_frame_push_get_image( mlt_frame self, mlt_get_image get_image );
 129 extern mlt_get_image mlt_frame_pop_get_image( mlt_frame self );
 130 extern int mlt_frame_push_frame( mlt_frame self, mlt_frame that );
 131 extern mlt_frame mlt_frame_pop_frame( mlt_frame self );
 132 extern int mlt_frame_push_service( mlt_frame self, void *that );
 133 extern void *mlt_frame_pop_service( mlt_frame self );
 134 extern int mlt_frame_push_service_int( mlt_frame self, int that );
 135 extern int mlt_frame_pop_service_int( mlt_frame self );
 136 extern int mlt_frame_push_audio( mlt_frame self, void *that );
 137 extern void *mlt_frame_pop_audio( mlt_frame self );
 138 extern mlt_deque mlt_frame_service_stack( mlt_frame self );
 139 extern mlt_producer mlt_frame_get_original_producer( mlt_frame self );
 140 extern void mlt_frame_close( mlt_frame self );
 141 extern mlt_properties mlt_frame_unique_properties( mlt_frame self, mlt_service service );
 142 extern mlt_frame mlt_frame_clone( mlt_frame self, int is_deep );
 143
 144 /* convenience functions */
 145 extern int mlt_sample_calculator( float fps, int frequency, int64_t position );
 146 extern int64_t mlt_sample_calculator_to_now( float fps, int frequency, int64_t position );
 147 extern const char * mlt_image_format_name( mlt_image_format format );
 148 extern int mlt_image_format_size( mlt_image_format format, int width, int height, int *bpp );
 149 extern const char * mlt_audio_format_name( mlt_audio_format format );
 150 extern int mlt_audio_format_size( mlt_audio_format format, int samples, int channels );
 151 extern void mlt_frame_write_ppm( mlt_frame frame );
 152
 153 /** This macro scales RGB into the YUV gamut - y is scaled by 219/255 and uv by 224/255. */
 154 #define RGB2YUV_601_SCALED(r, g, b, y, u, v)\
 155   y = ((263*r + 516*g + 100*b) >> 10) + 16;\
 156   u = ((-152*r - 300*g + 450*b) >> 10) + 128;\
 157   v = ((450*r - 377*g - 73*b) >> 10) + 128;
 158
 159 #endif