gavl.h

Go to the documentation of this file.

/*****************************************************************
 * gavl - a general purpose audio/video processing library
 *
 * Copyright (c) 2001 - 2008 Members of the Gmerlin project
 * gmerlin-general@lists.sourceforge.net
 * http://gmerlin.sourceforge.net
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * *****************************************************************/

#ifndef GAVL_H_INCLUDED
#define GAVL_H_INCLUDED

#include <inttypes.h>

#include "gavltime.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct gavl_video_format_s gavl_video_format_t;

#include "timecode.h"
  
/* Quality levels */
  
#define GAVL_QUALITY_FASTEST 1

#define GAVL_QUALITY_BEST    5 

#define GAVL_QUALITY_DEFAULT 2 

#define GAVL_ACCEL_MMX      (1<<0) 
#define GAVL_ACCEL_MMXEXT   (1<<1) 
#define GAVL_ACCEL_SSE      (1<<2) 
#define GAVL_ACCEL_SSE2     (1<<3) 
#define GAVL_ACCEL_SSE3     (1<<4) 
#define GAVL_ACCEL_3DNOW    (1<<5) 
#define GAVL_ACCEL_3DNOWEXT (1<<6) 
#define GAVL_ACCEL_SSSE3    (1<<7) 


int gavl_accel_supported();

/* Sample formats: all multibyte numbers are native endian */

#define GAVL_MAX_CHANNELS 128
  
typedef enum
  {
    GAVL_SAMPLE_NONE   = 0, 
    GAVL_SAMPLE_U8     = 1, 
    GAVL_SAMPLE_S8     = 2, 
    GAVL_SAMPLE_U16    = 3, 
    GAVL_SAMPLE_S16    = 4, 
    GAVL_SAMPLE_S32    = 5, 
    GAVL_SAMPLE_FLOAT  = 6,  
    GAVL_SAMPLE_DOUBLE = 7  
  } gavl_sample_format_t;

typedef enum
  {
    GAVL_INTERLEAVE_NONE = 0, 
    GAVL_INTERLEAVE_2    = 1, 
    GAVL_INTERLEAVE_ALL  = 2  
  } gavl_interleave_mode_t;

typedef enum
  {
    GAVL_CHID_NONE         = 0,   
    GAVL_CHID_FRONT_CENTER,       
    GAVL_CHID_FRONT_LEFT,         
    GAVL_CHID_FRONT_RIGHT,        
    GAVL_CHID_FRONT_CENTER_LEFT,  
    GAVL_CHID_FRONT_CENTER_RIGHT, 
    GAVL_CHID_REAR_LEFT,          
    GAVL_CHID_REAR_RIGHT,         
    GAVL_CHID_REAR_CENTER,        
    GAVL_CHID_SIDE_LEFT,          
    GAVL_CHID_SIDE_RIGHT,         
    GAVL_CHID_LFE,                
    GAVL_CHID_AUX,                
  } gavl_channel_id_t;

typedef struct 
  {
  int samples_per_frame;  
  int samplerate;         
  int num_channels;         
  gavl_sample_format_t   sample_format; 
  gavl_interleave_mode_t interleave_mode; 
  float center_level; 
  float rear_level;   
  gavl_channel_id_t channel_locations[GAVL_MAX_CHANNELS];   
  } gavl_audio_format_t;

  
/* Audio format -> string conversions */

const char * gavl_sample_format_to_string(gavl_sample_format_t format);

gavl_sample_format_t gavl_string_to_sample_format(const char * str);

int gavl_num_sample_formats();

gavl_sample_format_t gavl_get_sample_format(int index);
  
const char * gavl_channel_id_to_string(gavl_channel_id_t id);


const char * gavl_interleave_mode_to_string(gavl_interleave_mode_t mode);

void gavl_audio_format_dump(const gavl_audio_format_t * format);

int gavl_channel_index(const gavl_audio_format_t * format, gavl_channel_id_t id);

int gavl_front_channels(const gavl_audio_format_t * format);

int gavl_rear_channels(const gavl_audio_format_t * format);

int gavl_side_channels(const gavl_audio_format_t * format);

int gavl_aux_channels(const gavl_audio_format_t * format);

  
  
int gavl_lfe_channels(const gavl_audio_format_t * format);

void gavl_audio_format_copy(gavl_audio_format_t * dst,
                            const gavl_audio_format_t * src);

int gavl_audio_formats_equal(const gavl_audio_format_t * format_1,
                              const gavl_audio_format_t * format_2);

void gavl_set_channel_setup(gavl_audio_format_t * format);

int gavl_bytes_per_sample(gavl_sample_format_t format);

typedef union 
  {
  uint8_t * u_8; 
  int8_t *  s_8; 
  uint16_t * u_16; 
  int16_t  * s_16; 
  uint32_t * u_32; 
  int32_t  * s_32; 
  float * f; 
  double * d; 
  } gavl_audio_samples_t;

typedef union
  {
  uint8_t * u_8[GAVL_MAX_CHANNELS];
  int8_t *  s_8[GAVL_MAX_CHANNELS];
  uint16_t * u_16[GAVL_MAX_CHANNELS];
  int16_t  * s_16[GAVL_MAX_CHANNELS];
  uint32_t * u_32[GAVL_MAX_CHANNELS];
  int32_t  * s_32[GAVL_MAX_CHANNELS];
  float * f[GAVL_MAX_CHANNELS];
  double * d[GAVL_MAX_CHANNELS];
  } gavl_audio_channels_t;

typedef struct 
  {
  gavl_audio_samples_t  samples; 
  gavl_audio_channels_t channels;
  int valid_samples;             
  int64_t timestamp;             
  int channel_stride;            
  } gavl_audio_frame_t;

gavl_audio_frame_t * gavl_audio_frame_create(const gavl_audio_format_t* format);

void gavl_audio_frame_null(gavl_audio_frame_t * frame);

void gavl_audio_frame_destroy(gavl_audio_frame_t * frame);

void gavl_audio_frame_mute(gavl_audio_frame_t * frame,
                           const gavl_audio_format_t * format);

void gavl_audio_frame_mute_samples(gavl_audio_frame_t * frame,
                                   const gavl_audio_format_t * format,
                                   int num_samples);

  
  
void gavl_audio_frame_mute_channel(gavl_audio_frame_t * frame,
                                   const gavl_audio_format_t * format,
                                   int channel);
  
int gavl_audio_frame_copy(const gavl_audio_format_t * format,
                          gavl_audio_frame_t * dst,
                          const gavl_audio_frame_t * src,
                          int dst_pos,
                          int src_pos,
                          int dst_size,
                          int src_size);

#define GAVL_AUDIO_FRONT_TO_REAR_COPY (1<<0) 
#define GAVL_AUDIO_FRONT_TO_REAR_MUTE (1<<1) 
#define GAVL_AUDIO_FRONT_TO_REAR_DIFF (1<<2) 
#define GAVL_AUDIO_FRONT_TO_REAR_MASK           \
(GAVL_AUDIO_FRONT_TO_REAR_COPY | \
GAVL_AUDIO_FRONT_TO_REAR_MUTE | \
 GAVL_AUDIO_FRONT_TO_REAR_DIFF) 
/* Options for mixing stereo to mono */
  
#define GAVL_AUDIO_STEREO_TO_MONO_LEFT  (1<<3) 
#define GAVL_AUDIO_STEREO_TO_MONO_RIGHT (1<<4) 
#define GAVL_AUDIO_STEREO_TO_MONO_MIX   (1<<5) 
#define GAVL_AUDIO_STEREO_TO_MONO_MASK \
(GAVL_AUDIO_STEREO_TO_MONO_LEFT | \
GAVL_AUDIO_STEREO_TO_MONO_RIGHT | \
GAVL_AUDIO_STEREO_TO_MONO_MIX) 
typedef enum
  {
    GAVL_AUDIO_DITHER_NONE   = 0,
    GAVL_AUDIO_DITHER_AUTO   = 1,
    GAVL_AUDIO_DITHER_RECT   = 2,
    GAVL_AUDIO_DITHER_TRI    = 3,
    GAVL_AUDIO_DITHER_SHAPED = 4,
  } gavl_audio_dither_mode_t;

typedef enum
  {
    GAVL_RESAMPLE_AUTO        = 0, 
    GAVL_RESAMPLE_ZOH         = 1, 
    GAVL_RESAMPLE_LINEAR      = 2, 
    GAVL_RESAMPLE_SINC_FAST   = 3, 
    GAVL_RESAMPLE_SINC_MEDIUM = 4, 
    GAVL_RESAMPLE_SINC_BEST   = 5  
  } gavl_resample_mode_t;
  
typedef struct gavl_audio_options_s gavl_audio_options_t;

void gavl_audio_options_set_quality(gavl_audio_options_t * opt, int quality);

int gavl_audio_options_get_quality(gavl_audio_options_t * opt);
  
void gavl_audio_options_set_dither_mode(gavl_audio_options_t * opt, gavl_audio_dither_mode_t mode);

gavl_audio_dither_mode_t gavl_audio_options_get_dither_mode(gavl_audio_options_t * opt);

  
void gavl_audio_options_set_resample_mode(gavl_audio_options_t * opt, gavl_resample_mode_t mode);

gavl_resample_mode_t gavl_audio_options_get_resample_mode(gavl_audio_options_t * opt);
  
void gavl_audio_options_set_conversion_flags(gavl_audio_options_t * opt,
                                             int flags);
  
int gavl_audio_options_get_conversion_flags(gavl_audio_options_t * opt);

void gavl_audio_options_set_defaults(gavl_audio_options_t * opt);

gavl_audio_options_t * gavl_audio_options_create();

void gavl_audio_options_copy(gavl_audio_options_t * dst,
                             const gavl_audio_options_t * src);

void gavl_audio_options_destroy(gavl_audio_options_t * opt);
  
  
  
/* Audio converter */

typedef struct gavl_audio_converter_s gavl_audio_converter_t;
  
gavl_audio_converter_t * gavl_audio_converter_create();

void gavl_audio_converter_destroy(gavl_audio_converter_t* cnv);

gavl_audio_options_t * gavl_audio_converter_get_options(gavl_audio_converter_t*cnv);


int gavl_audio_converter_init(gavl_audio_converter_t* cnv,
                              const gavl_audio_format_t * input_format,
                              const gavl_audio_format_t * output_format);

int gavl_audio_converter_reinit(gavl_audio_converter_t* cnv);

  
void gavl_audio_convert(gavl_audio_converter_t * cnv,
                        const gavl_audio_frame_t * input_frame,
                        gavl_audio_frame_t * output_frame);




typedef struct gavl_volume_control_s gavl_volume_control_t;
  
/* Create / destroy */

gavl_volume_control_t * gavl_volume_control_create();

void gavl_volume_control_destroy(gavl_volume_control_t *ctrl);

void gavl_volume_control_set_format(gavl_volume_control_t *ctrl,
                                    const gavl_audio_format_t * format);

void gavl_volume_control_set_volume(gavl_volume_control_t * ctrl,
                                    float volume);

void gavl_volume_control_apply(gavl_volume_control_t *ctrl,
                               gavl_audio_frame_t * frame);

typedef struct gavl_peak_detector_s gavl_peak_detector_t;
  
/* Create / destroy */

gavl_peak_detector_t * gavl_peak_detector_create();

void gavl_peak_detector_destroy(gavl_peak_detector_t *pd);

void gavl_peak_detector_set_format(gavl_peak_detector_t *pd,
                                   const gavl_audio_format_t * format);

void gavl_peak_detector_update(gavl_peak_detector_t *pd,
                              gavl_audio_frame_t * frame);
  
void gavl_peak_detector_get_peak(gavl_peak_detector_t * pd,
                                 double * min, double * max,
                                 double * abs);

void gavl_peak_detector_get_peaks(gavl_peak_detector_t * pd,
                                  double * min, double * max,
                                  double * abs);
  
void gavl_peak_detector_reset(gavl_peak_detector_t * pd);
  
#define GAVL_MAX_PLANES 4 
typedef struct
  {
  int x; 
  int y; 
  int w; 
  int h; 
  } gavl_rectangle_i_t;

typedef struct
  {
  double x; 
  double y; 
  double w; 
  double h; 
  } gavl_rectangle_f_t;

void gavl_rectangle_i_crop_to_format(gavl_rectangle_i_t * r,
                                   const gavl_video_format_t * format);

void gavl_rectangle_f_crop_to_format(gavl_rectangle_f_t * r,
                                     const gavl_video_format_t * format);

void gavl_rectangle_crop_to_format_noscale(gavl_rectangle_i_t * src_rect,
                                           gavl_rectangle_i_t * dst_rect,
                                           const gavl_video_format_t * src_format,
                                           const gavl_video_format_t * dst_format);

void gavl_rectangle_crop_to_format_scale(gavl_rectangle_f_t * src_rect,
                                         gavl_rectangle_i_t * dst_rect,
                                         const gavl_video_format_t * src_format,
                                         const gavl_video_format_t * dst_format);

  

void gavl_rectangle_i_set_all(gavl_rectangle_i_t * r, const gavl_video_format_t * format);

void gavl_rectangle_f_set_all(gavl_rectangle_f_t * r, const gavl_video_format_t * format);

void gavl_rectangle_i_crop_left(gavl_rectangle_i_t * r,   int num_pixels);

void gavl_rectangle_i_crop_right(gavl_rectangle_i_t * r,  int num_pixels);

void gavl_rectangle_i_crop_top(gavl_rectangle_i_t * r,    int num_pixels);

void gavl_rectangle_i_crop_bottom(gavl_rectangle_i_t * r, int num_pixels);

void gavl_rectangle_f_crop_left(gavl_rectangle_f_t * r,   double num_pixels);

void gavl_rectangle_f_crop_right(gavl_rectangle_f_t * r,  double num_pixels);

void gavl_rectangle_f_crop_top(gavl_rectangle_f_t * r,    double num_pixels);

void gavl_rectangle_f_crop_bottom(gavl_rectangle_f_t * r, double num_pixels);

void gavl_rectangle_i_align(gavl_rectangle_i_t * r, int h_align, int v_align);

void gavl_rectangle_i_align_to_format(gavl_rectangle_i_t * r,
                                      const gavl_video_format_t * format);

  
void gavl_rectangle_i_copy(gavl_rectangle_i_t * dst, const gavl_rectangle_i_t * src);

void gavl_rectangle_f_copy(gavl_rectangle_f_t * dst, const gavl_rectangle_f_t * src);



void gavl_rectangle_i_to_f(gavl_rectangle_f_t * dst, const gavl_rectangle_i_t * src);

void gavl_rectangle_f_to_i(gavl_rectangle_i_t * dst, const gavl_rectangle_f_t * src);
  
int gavl_rectangle_i_is_empty(const gavl_rectangle_i_t * r);

int gavl_rectangle_f_is_empty(const gavl_rectangle_f_t * r);

void gavl_rectangle_fit_aspect(gavl_rectangle_i_t * dst_rect,
                               const gavl_video_format_t * src_format,
                               const gavl_rectangle_f_t * src_rect,
                               const gavl_video_format_t * dst_format,
                               float zoom, float squeeze);

void gavl_rectangle_i_dump(const gavl_rectangle_i_t * r);

void gavl_rectangle_f_dump(const gavl_rectangle_f_t * r);

  
#define GAVL_PIXFMT_PLANAR (1<<8)

#define GAVL_PIXFMT_RGB    (1<<9)

#define GAVL_PIXFMT_YUV    (1<<10)

#define GAVL_PIXFMT_YUVJ   (1<<11)

#define GAVL_PIXFMT_ALPHA  (1<<12)

#define GAVL_PIXFMT_GRAY   (1<<13)
  
typedef enum 
  {
    GAVL_PIXELFORMAT_NONE =  0, 

    GAVL_GRAY_8          =  1 | GAVL_PIXFMT_GRAY,

    GAVL_GRAY_16          =  2 | GAVL_PIXFMT_GRAY,
    
    GAVL_GRAY_FLOAT       =  3 | GAVL_PIXFMT_GRAY,
    
    GAVL_GRAYA_16          =  1 | GAVL_PIXFMT_GRAY | GAVL_PIXFMT_ALPHA,

    GAVL_GRAYA_32          =  2 | GAVL_PIXFMT_GRAY | GAVL_PIXFMT_ALPHA,
    
    GAVL_GRAYA_FLOAT       =  3 | GAVL_PIXFMT_GRAY | GAVL_PIXFMT_ALPHA,
    
    GAVL_RGB_15          =  1 | GAVL_PIXFMT_RGB,
    GAVL_BGR_15          =  2 | GAVL_PIXFMT_RGB,
    GAVL_RGB_16          =  3 | GAVL_PIXFMT_RGB,
    GAVL_BGR_16          =  4 | GAVL_PIXFMT_RGB,
    GAVL_RGB_24          =  5 | GAVL_PIXFMT_RGB,
    GAVL_BGR_24          =  6 | GAVL_PIXFMT_RGB,
    GAVL_RGB_32          =  7 | GAVL_PIXFMT_RGB,
    GAVL_BGR_32          =  8 | GAVL_PIXFMT_RGB,
    GAVL_RGBA_32         =  9 | GAVL_PIXFMT_RGB | GAVL_PIXFMT_ALPHA,

    GAVL_RGB_48       = 10 | GAVL_PIXFMT_RGB,
    GAVL_RGBA_64      = 11 | GAVL_PIXFMT_RGB | GAVL_PIXFMT_ALPHA,
        
    GAVL_RGB_FLOAT    = 12 | GAVL_PIXFMT_RGB,
    GAVL_RGBA_FLOAT   = 13 | GAVL_PIXFMT_RGB  | GAVL_PIXFMT_ALPHA,

    GAVL_YUY2            = 1 | GAVL_PIXFMT_YUV,
    GAVL_UYVY            = 2 | GAVL_PIXFMT_YUV,
    GAVL_YUVA_32         = 3 | GAVL_PIXFMT_YUV | GAVL_PIXFMT_ALPHA,
    GAVL_YUVA_64         = 4 | GAVL_PIXFMT_YUV | GAVL_PIXFMT_ALPHA,
    GAVL_YUV_FLOAT       = 5 | GAVL_PIXFMT_YUV,

    GAVL_YUVA_FLOAT       = 6 | GAVL_PIXFMT_YUV | GAVL_PIXFMT_ALPHA,
    
    GAVL_YUV_420_P       = 1 | GAVL_PIXFMT_PLANAR | GAVL_PIXFMT_YUV,
    GAVL_YUV_422_P       = 2 | GAVL_PIXFMT_PLANAR | GAVL_PIXFMT_YUV,
    GAVL_YUV_444_P       = 3 | GAVL_PIXFMT_PLANAR | GAVL_PIXFMT_YUV,
    GAVL_YUV_411_P       = 4 | GAVL_PIXFMT_PLANAR | GAVL_PIXFMT_YUV,
    GAVL_YUV_410_P       = 5 | GAVL_PIXFMT_PLANAR | GAVL_PIXFMT_YUV,
    
    GAVL_YUVJ_420_P      = 6 | GAVL_PIXFMT_PLANAR | GAVL_PIXFMT_YUV | GAVL_PIXFMT_YUVJ,
    GAVL_YUVJ_422_P      = 7 | GAVL_PIXFMT_PLANAR | GAVL_PIXFMT_YUV | GAVL_PIXFMT_YUVJ,
    GAVL_YUVJ_444_P      = 8 | GAVL_PIXFMT_PLANAR | GAVL_PIXFMT_YUV | GAVL_PIXFMT_YUVJ,

    GAVL_YUV_444_P_16 = 9 | GAVL_PIXFMT_PLANAR | GAVL_PIXFMT_YUV,
    GAVL_YUV_422_P_16 = 10 | GAVL_PIXFMT_PLANAR | GAVL_PIXFMT_YUV,
    
  } gavl_pixelformat_t;

#define GAVL_PIXELFORMAT_1D_8 GAVL_GRAY_8

#define GAVL_PIXELFORMAT_2D_8 GAVL_GRAYA_16

#define GAVL_PIXELFORMAT_3D_8 GAVL_RGB_24

#define GAVL_PIXELFORMAT_4D_8 GAVL_RGBA_32

#define GAVL_PIXELFORMAT_1D_16 GAVL_GRAY_16

#define GAVL_PIXELFORMAT_2D_16 GAVL_GRAYA_32

#define GAVL_PIXELFORMAT_3D_16 GAVL_RGB_48

#define GAVL_PIXELFORMAT_4D_16 GAVL_RGBA_64

#define GAVL_PIXELFORMAT_1D_FLOAT GAVL_GRAY_FLOAT

#define GAVL_PIXELFORMAT_2D_FLOAT GAVL_GRAYA_FLOAT

#define GAVL_PIXELFORMAT_3D_FLOAT GAVL_RGB_FLOAT

#define GAVL_PIXELFORMAT_4D_FLOAT GAVL_RGBA_FLOAT

  
/*
 *  Colormodel related functions
 */

#define gavl_pixelformat_is_gray(fmt) ((fmt) & GAVL_PIXFMT_GRAY)

  
#define gavl_pixelformat_is_rgb(fmt) ((fmt) & GAVL_PIXFMT_RGB)

#define gavl_pixelformat_is_yuv(fmt) ((fmt) & GAVL_PIXFMT_YUV)

#define gavl_pixelformat_is_jpeg_scaled(fmt) ((fmt) & GAVL_PIXFMT_YUVJ)

#define gavl_pixelformat_has_alpha(fmt) ((fmt) & GAVL_PIXFMT_ALPHA)

#define  gavl_pixelformat_is_planar(fmt) ((fmt) & GAVL_PIXFMT_PLANAR)

int gavl_pixelformat_num_planes(gavl_pixelformat_t pixelformat);

void gavl_pixelformat_chroma_sub(gavl_pixelformat_t pixelformat, int * sub_h, int * sub_v);

int gavl_pixelformat_bytes_per_component(gavl_pixelformat_t pixelformat);

int gavl_pixelformat_bytes_per_pixel(gavl_pixelformat_t pixelformat);
  
int gavl_pixelformat_bits_per_pixel(gavl_pixelformat_t pixelformat);

int gavl_pixelformat_conversion_penalty(gavl_pixelformat_t src,
                                        gavl_pixelformat_t dst);

gavl_pixelformat_t 
gavl_pixelformat_get_best(gavl_pixelformat_t src,
                          const gavl_pixelformat_t * dst_supported,
                          int * penalty);
  


const char * gavl_pixelformat_to_string(gavl_pixelformat_t pixelformat);

gavl_pixelformat_t gavl_string_to_pixelformat(const char * name);

int gavl_num_pixelformats();

gavl_pixelformat_t gavl_get_pixelformat(int index);

/*  */

typedef enum
  {
    GAVL_CHROMA_PLACEMENT_DEFAULT = 0, 
    GAVL_CHROMA_PLACEMENT_MPEG2,       
    GAVL_CHROMA_PLACEMENT_DVPAL        
  } gavl_chroma_placement_t;

const char * gavl_chroma_placement_to_string(gavl_chroma_placement_t mode);
  
typedef enum
  {
    GAVL_FRAMERATE_CONSTANT    = 0, 
    GAVL_FRAMERATE_VARIABLE    = 1, 
    GAVL_FRAMERATE_STILL       = 2, 
  } gavl_framerate_mode_t;

typedef enum
  {
    GAVL_INTERLACE_NONE = 0,    
    GAVL_INTERLACE_TOP_FIRST,   
    GAVL_INTERLACE_BOTTOM_FIRST,
    GAVL_INTERLACE_MIXED        
  } gavl_interlace_mode_t;

const char * gavl_interlace_mode_to_string(gavl_interlace_mode_t mode);
  
  
/* Video format structure */
  
struct gavl_video_format_s
  {
  int frame_width;
  int frame_height;
  int image_width;
  int image_height;
  /* Support for nonsquare pixels */
    
  int pixel_width;
  int pixel_height;
  gavl_pixelformat_t pixelformat;
  int frame_duration;
  int timescale;
  gavl_framerate_mode_t   framerate_mode;
  gavl_chroma_placement_t chroma_placement;
  gavl_interlace_mode_t   interlace_mode;
  gavl_timecode_format_t  timecode_format;
  };

void gavl_video_format_copy(gavl_video_format_t * dst,
                            const gavl_video_format_t * src);

int gavl_video_formats_equal(const gavl_video_format_t * format_1,
                             const gavl_video_format_t * format_2);

  
void gavl_video_format_get_chroma_offset(const gavl_video_format_t * format, int field, int plane,
                                         float * off_x, float * off_y);
  

  
void gavl_video_format_dump(const gavl_video_format_t * format);

void gavl_video_format_fit_to_source(gavl_video_format_t * dst,
                                     const gavl_video_format_t * src);

  
typedef struct
  {
  uint8_t * planes[GAVL_MAX_PLANES]; 
  int strides[GAVL_MAX_PLANES];      
  void * user_data;    
  int64_t timestamp; 
  int64_t duration; 
  gavl_interlace_mode_t   interlace_mode;
  gavl_timecode_t timecode; 
  } gavl_video_frame_t;


gavl_video_frame_t * gavl_video_frame_create(const gavl_video_format_t*format);

gavl_video_frame_t * gavl_video_frame_create_nopad(const gavl_video_format_t*format);

  

void gavl_video_frame_destroy(gavl_video_frame_t*frame);

void gavl_video_frame_null(gavl_video_frame_t*frame);
  
void gavl_video_frame_clear(gavl_video_frame_t * frame,
                            const gavl_video_format_t * format);

void gavl_video_frame_fill(gavl_video_frame_t * frame,
                           const gavl_video_format_t * format,
                           float * color);

  
void gavl_video_frame_copy(const gavl_video_format_t * format,
                           gavl_video_frame_t * dst,
                           const gavl_video_frame_t * src);

void gavl_video_frame_copy_plane(const gavl_video_format_t * format,
                                 gavl_video_frame_t * dst,
                                 const gavl_video_frame_t * src, int plane);

void gavl_video_frame_copy_flip_x(const gavl_video_format_t * format,
                                  gavl_video_frame_t * dst,
                                  const gavl_video_frame_t * src);

void gavl_video_frame_copy_flip_y(const gavl_video_format_t * format,
                                  gavl_video_frame_t * dst,
                                  const gavl_video_frame_t * src);

void gavl_video_frame_copy_flip_xy(const gavl_video_format_t * format,
                                   gavl_video_frame_t * dst,
                                  const gavl_video_frame_t * src);

void gavl_video_frame_copy_metadata(gavl_video_frame_t * dst,
                                    const gavl_video_frame_t * src);

  
void gavl_video_frame_get_subframe(gavl_pixelformat_t pixelformat,
                                   const gavl_video_frame_t * src,
                                   gavl_video_frame_t * dst,
                                   gavl_rectangle_i_t * src_rect);

void gavl_video_frame_get_field(gavl_pixelformat_t pixelformat,
                                const gavl_video_frame_t * src,
                                gavl_video_frame_t * dst,
                                int field);

  

void gavl_video_frame_dump(gavl_video_frame_t * frame,
                           const gavl_video_format_t * format,
                           const char * namebase);
  
/*****************************
 Conversion options
******************************/

#define GAVL_FORCE_DEINTERLACE (1<<0)

#define GAVL_CONVOLVE_CHROMA   (1<<1)

#define GAVL_CONVOLVE_NORMALIZE (1<<2)

#define GAVL_RESAMPLE_CHROMA    (1<<3)
  
typedef enum
  {
    GAVL_ALPHA_IGNORE      = 0, 
    GAVL_ALPHA_BLEND_COLOR      
  } gavl_alpha_mode_t;

typedef enum
  {
    GAVL_DEINTERLACE_NONE      = 0, 
    GAVL_DEINTERLACE_COPY      = 1, 
    GAVL_DEINTERLACE_SCALE     = 2, 
    GAVL_DEINTERLACE_BLEND     = 3  
  } gavl_deinterlace_mode_t;

typedef enum
  {
    GAVL_DEINTERLACE_DROP_TOP,    
    GAVL_DEINTERLACE_DROP_BOTTOM, 
  } gavl_deinterlace_drop_mode_t;
  
typedef enum
  {
    GAVL_SCALE_AUTO,          
    GAVL_SCALE_NEAREST,       
    GAVL_SCALE_BILINEAR,      
    GAVL_SCALE_QUADRATIC,     
    GAVL_SCALE_CUBIC_BSPLINE, 
    GAVL_SCALE_CUBIC_MITCHELL,
    GAVL_SCALE_CUBIC_CATMULL, 
    GAVL_SCALE_SINC_LANCZOS,  
    GAVL_SCALE_NONE,          
  } gavl_scale_mode_t;

typedef struct gavl_video_options_s gavl_video_options_t;

/* Default Options */

void gavl_video_options_set_defaults(gavl_video_options_t * opt);

gavl_video_options_t * gavl_video_options_create();

void gavl_video_options_copy(gavl_video_options_t * dst,
                             const gavl_video_options_t * src);

void gavl_video_options_destroy(gavl_video_options_t * opt);
  
  
void gavl_video_options_set_rectangles(gavl_video_options_t * opt,
                                       const gavl_rectangle_f_t * src_rect,
                                       const gavl_rectangle_i_t * dst_rect);

void gavl_video_options_get_rectangles(gavl_video_options_t * opt,
                                       gavl_rectangle_f_t * src_rect,
                                       gavl_rectangle_i_t * dst_rect);
  
void gavl_video_options_set_quality(gavl_video_options_t * opt, int quality);

int gavl_video_options_get_quality(gavl_video_options_t * opt);

  
void gavl_video_options_set_conversion_flags(gavl_video_options_t * opt,
                                             int conversion_flags);

int gavl_video_options_get_conversion_flags(gavl_video_options_t * opt);
  
void gavl_video_options_set_alpha_mode(gavl_video_options_t * opt,
                                       gavl_alpha_mode_t alpha_mode);

gavl_alpha_mode_t
gavl_video_options_get_alpha_mode(gavl_video_options_t * opt);

  
void gavl_video_options_set_scale_mode(gavl_video_options_t * opt,
                                       gavl_scale_mode_t scale_mode);

gavl_scale_mode_t
gavl_video_options_get_scale_mode(gavl_video_options_t * opt);

  
void gavl_video_options_set_scale_order(gavl_video_options_t * opt,
                                        int order);

int gavl_video_options_get_scale_order(gavl_video_options_t * opt);

  
void gavl_video_options_set_background_color(gavl_video_options_t * opt,
                                             const float * color);

void gavl_video_options_get_background_color(gavl_video_options_t * opt,
                                             float * color);
  
void gavl_video_options_set_deinterlace_mode(gavl_video_options_t * opt,
                                             gavl_deinterlace_mode_t deinterlace_mode);

gavl_deinterlace_mode_t
gavl_video_options_get_deinterlace_mode(gavl_video_options_t * opt);

void gavl_video_options_set_deinterlace_drop_mode(gavl_video_options_t * opt,
                                                  gavl_deinterlace_drop_mode_t deinterlace_drop_mode);

gavl_deinterlace_drop_mode_t
gavl_video_options_get_deinterlace_drop_mode(gavl_video_options_t * opt);
 
  
/***************************************************
 * Create and destroy video converters
 ***************************************************/
  
typedef struct gavl_video_converter_s gavl_video_converter_t;

gavl_video_converter_t * gavl_video_converter_create();

void gavl_video_converter_destroy(gavl_video_converter_t*cnv);

/**************************************************
 * Get options. Change the options with the gavl_video_options_set_*
 * functions above
 **************************************************/

gavl_video_options_t *
gavl_video_converter_get_options(gavl_video_converter_t*cnv);


int gavl_video_converter_init(gavl_video_converter_t* cnv,
                              const gavl_video_format_t * input_format,
                              const gavl_video_format_t * output_format);

int gavl_video_converter_reinit(gavl_video_converter_t* cnv);
 
  
/***************************************************
 * Convert a frame
 ***************************************************/

void gavl_video_convert(gavl_video_converter_t * cnv,
                        const gavl_video_frame_t * input_frame,
                        gavl_video_frame_t * output_frame);

typedef struct gavl_video_scaler_s gavl_video_scaler_t;

gavl_video_scaler_t * gavl_video_scaler_create();

void gavl_video_scaler_destroy(gavl_video_scaler_t * scaler);

gavl_video_options_t *
gavl_video_scaler_get_options(gavl_video_scaler_t * scaler);

int gavl_video_scaler_init(gavl_video_scaler_t * scaler,
                           const gavl_video_format_t * src_format,
                           const gavl_video_format_t * dst_format);

int gavl_video_scaler_init_convolve(gavl_video_scaler_t * scaler,
                                    const gavl_video_format_t * format,
                                    int h_radius, float * h_coeffs,
                                    int v_radius, float * v_coeffs);
  
void gavl_video_scaler_scale(gavl_video_scaler_t * scaler,
                             const gavl_video_frame_t * input_frame,
                             gavl_video_frame_t * output_frame);

typedef struct gavl_video_deinterlacer_s gavl_video_deinterlacer_t;

gavl_video_deinterlacer_t * gavl_video_deinterlacer_create();

void gavl_video_deinterlacer_destroy(gavl_video_deinterlacer_t * deinterlacer);

gavl_video_options_t *
gavl_video_deinterlacer_get_options(gavl_video_deinterlacer_t * deinterlacer);

int gavl_video_deinterlacer_init(gavl_video_deinterlacer_t * deinterlacer,
                                 const gavl_video_format_t * src_format);

  
void gavl_video_deinterlacer_deinterlace(gavl_video_deinterlacer_t * deinterlacer,
                                         const gavl_video_frame_t * input_frame,
                                         gavl_video_frame_t * output_frame);

  
  
/**************************************************
 * Transparent overlays 
 **************************************************/

/* Overlay struct */

typedef struct
  {
  gavl_video_frame_t * frame;    
  gavl_rectangle_i_t ovl_rect;   
  int dst_x;                     
  int dst_y;                     
  } gavl_overlay_t;

typedef struct gavl_overlay_blend_context_s gavl_overlay_blend_context_t;

gavl_overlay_blend_context_t * gavl_overlay_blend_context_create();

void gavl_overlay_blend_context_destroy(gavl_overlay_blend_context_t * ctx);

gavl_video_options_t *
gavl_overlay_blend_context_get_options(gavl_overlay_blend_context_t * ctx);

int gavl_overlay_blend_context_init(gavl_overlay_blend_context_t * ctx,
                                    const gavl_video_format_t * frame_format,
                                    gavl_video_format_t * overlay_format);

void gavl_overlay_blend_context_set_overlay(gavl_overlay_blend_context_t * ctx,
                                            gavl_overlay_t * ovl);

void gavl_overlay_blend(gavl_overlay_blend_context_t * ctx,
                        gavl_video_frame_t * dst_frame);
  
#ifdef __cplusplus
}
#endif

#endif /* GAVL_H_INCLUDED */

---