* \brief interface for all frame classes
* \see mlt_frame_s
*
- * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * Copyright (C) 2003-2013 Ushodaya Enterprises Limited
* \author Charles Yates <charles.yates@pandora.be>
+ * \author Dan Dennedy <dan@dennedy.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
#include "mlt_deque.h"
#include "mlt_service.h"
-/** callback function to get video data
+/** Callback function to get video data.
*
*/
typedef int ( *mlt_get_image )( mlt_frame self, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
-/** callback function to get audio data
+/** Callback function to get audio data.
*
*/
/** \brief Frame class
*
+ * The frame is the primary data object that gets passed around to and through services.
+ *
+ * \extends mlt_properties
* \properties \em test_image set if the frame holds a "test card" image
* \properties \em test_audio set if the frame holds "test card" audio
* \properties \em _producer holds a reference to the frame's end producer
* \properties \em meta.* holds metadata
* \properties \em hide set to 1 to hide the video, 2 to mute the audio
* \properties \em last_track a flag to indicate an end-of-tracks frame
+ * \properties \em previous \em frame a reference to the unfiltered preceding frame
+ * (no speed factor applied, only available when \em _need_previous_next is set on the producer)
+ * \properties \em next \em frame a reference to the unfiltered following frame
+ * (no speed factor applied, only available when \em _need_previous_next is set on the producer)
+ * \properties \em colorspace the standard for luma coefficients
+ * \properties \em force_full_luma luma range handling, set to -1 for pass-through, 1 for full range, 0 for scaling
+ * \properties \em audio_frequency the sample rate of the audio
+ * \properties \em audio_channels the number of audio channels
+ * \properties \em audio_samples the number of audio samples
+ * \properties \em audio_format the mlt_audio_format for the audio on this frame
+ * \properties \em format the mlt_image_format of the image on this frame
+ * \properties \em width the horizontal resolution of the image
+ * \properties \em height the vertical resolution of the image
+ * \properties \em aspect_ratio the sample aspect ratio of the image
*/
struct mlt_frame_s
{
- /* We're extending properties here */
- struct mlt_properties_s parent;
+ struct mlt_properties_s parent; /**< \private A frame extends properties. */
- /* Virtual methods */
+ /** Get the alpha channel (callback function).
+ * \param self a frame
+ * \return the 8-bit alpha channel
+ */
uint8_t * ( *get_alpha_mask )( mlt_frame self );
+
+ /** Convert the image format (callback function).
+ * \param self a frame
+ * \param[in,out] image a buffer of image data
+ * \param[in,out] input the image format of supplied image data
+ * \param output the image format to which to convert
+ * \return true if error
+ */
int ( *convert_image )( mlt_frame self, uint8_t **image, mlt_image_format *input, mlt_image_format output );
+
+ /** Convert the audio format (callback function).
+ * \param self a frame
+ * \param[in,out] audio a buffer of audio data
+ * \param[in,out] input the audio format of supplied data
+ * \param output the audio format to which to convert
+ * \return true if error
+ */
int ( *convert_audio )( mlt_frame self, void **audio, mlt_audio_format *input, mlt_audio_format output );
- /* Private properties */
- mlt_deque stack_image;
- mlt_deque stack_audio;
- mlt_deque stack_service;
+ mlt_deque stack_image; /**< \private the image processing stack of operations and data */
+ mlt_deque stack_audio; /**< \private the audio processing stack of operations and data */
+ mlt_deque stack_service; /**< \private a general purpose data stack */
+ int is_processing; /**< \private indicates if a frame is or was processed by the parallel consumer */
};
#define MLT_FRAME_PROPERTIES( frame ) ( &( frame )->parent )
extern double mlt_frame_get_aspect_ratio( mlt_frame self );
extern int mlt_frame_set_aspect_ratio( mlt_frame self, double value );
extern mlt_position mlt_frame_get_position( mlt_frame self );
+extern mlt_position mlt_frame_original_position( mlt_frame self );
extern int mlt_frame_set_position( mlt_frame self, mlt_position value );
+extern int mlt_frame_set_image( mlt_frame self, uint8_t *image, int size, mlt_destructor destroy );
+extern int mlt_frame_set_alpha( mlt_frame self, uint8_t *alpha, int size, mlt_destructor destroy );
extern void mlt_frame_replace_image( mlt_frame self, uint8_t *image, mlt_image_format format, int width, int height );
extern int mlt_frame_get_image( mlt_frame self, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable );
extern uint8_t *mlt_frame_get_alpha_mask( mlt_frame self );
extern mlt_deque mlt_frame_service_stack( mlt_frame self );
extern mlt_producer mlt_frame_get_original_producer( mlt_frame self );
extern void mlt_frame_close( mlt_frame self );
+extern mlt_properties mlt_frame_unique_properties( mlt_frame self, mlt_service service );
+extern mlt_frame mlt_frame_clone( mlt_frame self, int is_deep );
/* convenience functions */
extern int mlt_sample_calculator( float fps, int frequency, int64_t position );
extern int64_t mlt_sample_calculator_to_now( float fps, int frequency, int64_t position );
extern const char * mlt_image_format_name( mlt_image_format format );
+extern int mlt_image_format_size( mlt_image_format format, int width, int height, int *bpp );
extern const char * mlt_audio_format_name( mlt_audio_format format );
+extern int mlt_audio_format_size( mlt_audio_format format, int samples, int channels );
+extern void mlt_frame_write_ppm( mlt_frame frame );
-/** This macro scales rgb into the yuv gamut - y is scaled by 219/255 and uv by 224/255. */
-#define RGB2YUV(r, g, b, y, u, v)\
+/** This macro scales RGB into the YUV gamut - y is scaled by 219/255 and uv by 224/255. */
+#define RGB2YUV_601_SCALED(r, g, b, y, u, v)\
y = ((263*r + 516*g + 100*b) >> 10) + 16;\
- u = ((-152*r - 298*g + 450*b) >> 10) + 128;\
+ u = ((-152*r - 300*g + 450*b) >> 10) + 128;\
v = ((450*r - 377*g - 73*b) >> 10) + 128;
-/** This macro assumes the user has already scaled their rgb down into the broadcast limits. **/
-#define RGB2YUV_UNSCALED(r, g, b, y, u, v)\
- y = (299*r + 587*g + 114*b) >> 10;\
- u = ((-169*r - 331*g + 500*b) >> 10) + 128;\
- v = ((500*r - 419*g - 81*b) >> 10) + 128;\
- y = y < 16 ? 16 : y;\
- u = u < 16 ? 16 : u;\
- v = v < 16 ? 16 : v;\
- y = y > 235 ? 235 : y;\
- u = u > 240 ? 240 : u;\
- v = v > 240 ? 240 : v
-
-/** This macro converts a YUV value to the RGB color space. */
-#define YUV2RGB( y, u, v, r, g, b ) \
+/** This macro scales YUV up into the full gamut of the RGB color space. */
+#define YUV2RGB_601_SCALED( y, u, v, r, g, b ) \
r = ((1192 * ( y - 16 ) + 1634 * ( v - 128 ) ) >> 10 ); \
- g = ((1192 * ( y - 16 ) - 832 * ( v - 128 ) - 400 * ( u - 128 ) ) >> 10 ); \
+ g = ((1192 * ( y - 16 ) - 832 * ( v - 128 ) - 401 * ( u - 128 ) ) >> 10 ); \
b = ((1192 * ( y - 16 ) + 2066 * ( u - 128 ) ) >> 10 ); \
r = r < 0 ? 0 : r > 255 ? 255 : r; \
g = g < 0 ? 0 : g > 255 ? 255 : g; \
projects / mlt / blobdiff