gavl.h

Go to the documentation of this file.

/*****************************************************************
 * gavl - a general purpose audio/video processing library
 *
 * Copyright (c) 2001 - 2024 Members of the Gmerlin project
 * http://github.com/bplaum
 *
 * 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 <gavl/gavldefs.h>
#include <gavl/gavltime.h>
#include <gavl/timecode.h>
#include <gavl/threadpool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Forward declarations */

  
typedef struct gavl_video_source_s gavl_video_source_t;

  
typedef struct gavl_audio_source_s gavl_audio_source_t;

 
typedef struct gavl_packet_source_s gavl_packet_source_t;

 
typedef struct 
gavl_audio_sink_s gavl_audio_sink_t;

  
typedef struct 
gavl_video_sink_s gavl_video_sink_t;

  
typedef struct 
gavl_packet_sink_s gavl_packet_sink_t;
 
typedef struct 
gavl_packet_s gavl_packet_t;
  
 
typedef struct gavl_video_format_s gavl_video_format_t;
 
typedef struct gavl_video_frame_s gavl_video_frame_t;
 
 
  
 
    
  
/* 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) 
#define GAVL_ACCEL_AVX      (1<<8) 
#define GAVL_ACCEL_AVX2     (1<<9) 
#define GAVL_ACCEL_NEON     (1<<10) 

  
GAVL_PUBLIC int gavl_accel_supported(void);

  
 
/* 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 
  {
  uint32_t samples_per_frame;  
  uint32_t samplerate;         
  uint32_t 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 */

  
GAVL_PUBLIC 
const char * gavl_sample_format_to_string(gavl_sample_format_t format);

  
GAVL_PUBLIC 
const char * gavl_sample_format_to_short_string(gavl_sample_format_t format);

 
GAVL_PUBLIC 
gavl_sample_format_t gavl_string_to_sample_format(const char * str);

  
GAVL_PUBLIC 
gavl_sample_format_t gavl_short_string_to_sample_format(const char * format);
  

 
GAVL_PUBLIC 
int gavl_num_sample_formats(void);

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

 
GAVL_PUBLIC
const char * gavl_channel_id_to_short_string(gavl_channel_id_t id);

 
GAVL_PUBLIC
gavl_channel_id_t gavl_short_string_to_channel_id(const char * id);
 
  

 
GAVL_PUBLIC
const char * gavl_interleave_mode_to_string(gavl_interleave_mode_t mode);

 
GAVL_PUBLIC
const char * gavl_interleave_mode_to_short_string(gavl_interleave_mode_t mode);

 
GAVL_PUBLIC
gavl_interleave_mode_t gavl_short_string_to_interleave_mode(const char * mode);
  
 
GAVL_PUBLIC
void gavl_audio_format_dump(const gavl_audio_format_t * format);
 
GAVL_PUBLIC
int gavl_audio_format_buffer_size(const gavl_audio_format_t * format);
 
  
 
GAVL_PUBLIC
void gavl_audio_format_dumpi(const gavl_audio_format_t * format, int indent);

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

  
GAVL_PUBLIC
int gavl_front_channels(const gavl_audio_format_t * format);

  
GAVL_PUBLIC
int gavl_rear_channels(const gavl_audio_format_t * format);

  
GAVL_PUBLIC
int gavl_side_channels(const gavl_audio_format_t * format);

 
GAVL_PUBLIC
int gavl_aux_channels(const gavl_audio_format_t * format);
 
  
  
 
GAVL_PUBLIC
int gavl_lfe_channels(const gavl_audio_format_t * format);

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

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

  
GAVL_PUBLIC
void gavl_set_channel_setup(gavl_audio_format_t * format);

 
GAVL_PUBLIC
int gavl_bytes_per_sample(gavl_sample_format_t format);

 
GAVL_PUBLIC
int gavl_nearest_samplerate(int in_rate, const int * supported);
 
  
 

  
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;            
 
  int buf_idx;
  } gavl_audio_frame_t;

  
GAVL_PUBLIC
gavl_audio_frame_t * gavl_audio_frame_create(const gavl_audio_format_t* format);

  
GAVL_PUBLIC
void gavl_audio_frame_null(gavl_audio_frame_t * frame);

  
GAVL_PUBLIC
void gavl_audio_frame_destroy(gavl_audio_frame_t * frame);

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

 
GAVL_PUBLIC
void gavl_audio_frame_mute_samples(gavl_audio_frame_t * frame,
                                   const gavl_audio_format_t * format,
                                   int num_samples);
 
  
  
  
GAVL_PUBLIC
void gavl_audio_frame_mute_channel(gavl_audio_frame_t * frame,
                                   const gavl_audio_format_t * format,
                                   int channel);
  
  
GAVL_PUBLIC
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);

 
GAVL_PUBLIC
void gavl_audio_frame_copy_ptrs(const gavl_audio_format_t * format,
                                gavl_audio_frame_t * dst,
                                const gavl_audio_frame_t * src);

 
 
GAVL_PUBLIC
void gavl_audio_frame_get_subframe(const gavl_audio_format_t * format,
                                   gavl_audio_frame_t * src,
                                   gavl_audio_frame_t * dst,
                                   int start, int len);

 
  
GAVL_PUBLIC
int gavl_audio_frames_equal(const gavl_audio_format_t * format,
                            const gavl_audio_frame_t * f1,
                            const gavl_audio_frame_t * f2);

 
  
GAVL_PUBLIC
int gavl_audio_frame_continuous(const gavl_audio_format_t * format,
                                const gavl_audio_frame_t * f);
 

  
GAVL_PUBLIC
void gavl_audio_frame_set_channels(gavl_audio_frame_t * f,
                                   const gavl_audio_format_t * format,
                                   uint8_t * data);
 
GAVL_PUBLIC
void gavl_audio_frame_from_data(gavl_audio_frame_t * f,
                                const gavl_audio_format_t * format,
                                uint8_t * data, int len);
 
 
GAVL_PUBLIC
void gavl_audio_frame_to_packet_metadata(const gavl_audio_frame_t * frame,
                                         gavl_packet_t * pkt);
 
GAVL_PUBLIC
void gavl_packet_to_audio_frame_metadata(const gavl_packet_t * p, gavl_audio_frame_t * frame);
 
GAVL_PUBLIC
void gavl_audio_frame_set_from_packet(gavl_audio_frame_t * frame,
                                      const gavl_audio_format_t * format,
                                      gavl_packet_t * p);
 
  
  
 
 
GAVL_PUBLIC
int gavl_audio_frame_skip(const gavl_audio_format_t * format,
                          gavl_audio_frame_t * f, int num_samples);
 
  
 
GAVL_PUBLIC
int gavl_audio_frame_plot(const gavl_audio_format_t * format,
                          const gavl_audio_frame_t * frame,
                          const char * name_base);
 
  

  
  
#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) 

  
#define GAVL_AUDIO_NORMALIZE_MIX_MATRIX (1<<6) 
 
  
 
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;

  
GAVL_PUBLIC
void gavl_audio_options_set_quality(gavl_audio_options_t * opt, int quality);

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

  
GAVL_PUBLIC
gavl_audio_dither_mode_t
gavl_audio_options_get_dither_mode(const gavl_audio_options_t * opt);
 
  
  
GAVL_PUBLIC
void gavl_audio_options_set_resample_mode(gavl_audio_options_t * opt, gavl_resample_mode_t mode);

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

  
GAVL_PUBLIC
void gavl_audio_options_set_defaults(gavl_audio_options_t * opt);

  
GAVL_PUBLIC
void gavl_audio_options_set_mix_matrix(gavl_audio_options_t * opt,
                                       const double ** matrix);
  
  
GAVL_PUBLIC
const double **
gavl_audio_options_get_mix_matrix(const gavl_audio_options_t * opt);
  
  
GAVL_PUBLIC
gavl_audio_options_t * gavl_audio_options_create(void);

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

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

  
  
typedef struct gavl_audio_converter_s gavl_audio_converter_t;
  
 
GAVL_PUBLIC
gavl_audio_converter_t * gavl_audio_converter_create(void);

 
GAVL_PUBLIC
void gavl_audio_converter_destroy(gavl_audio_converter_t* cnv);

 
GAVL_PUBLIC
gavl_audio_options_t * gavl_audio_converter_get_options(gavl_audio_converter_t*cnv);
 

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

 
GAVL_PUBLIC
int gavl_audio_converter_init_resample(gavl_audio_converter_t * cnv,
                                   const gavl_audio_format_t * format);

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

 
GAVL_PUBLIC
int gavl_audio_converter_set_resample_ratio(gavl_audio_converter_t * cnv, 
                double ratio ) ;
 

  
GAVL_PUBLIC
void gavl_audio_converter_resample(gavl_audio_converter_t * cnv,
                              gavl_audio_frame_t * input_frame,
                              gavl_audio_frame_t * output_frame,
                              double ratio);
 


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

  
GAVL_PUBLIC
gavl_volume_control_t * gavl_volume_control_create(void);

 
GAVL_PUBLIC
void gavl_volume_control_destroy(gavl_volume_control_t *ctrl);

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

  
GAVL_PUBLIC
void gavl_volume_control_set_volume(gavl_volume_control_t * ctrl,
                                    float volume);

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

 
GAVL_PUBLIC
int gavl_volume_to_int(float volume, float one, int steps);

 
GAVL_PUBLIC
float gavl_volume_to_float(int volume, float one, int steps);
  
  
  
#define GAVL_MAX_PLANES 4 


  
typedef struct
  {
  int32_t x; 
  int32_t y; 
  int32_t w; 
  int32_t h; 
  } gavl_rectangle_i_t;

  
typedef struct
  {
  double x; 
  double y; 
  double w; 
  double h; 
  } gavl_rectangle_f_t;
 
GAVL_PUBLIC
void gavl_rectangle_i_init(gavl_rectangle_i_t * r);
 
GAVL_PUBLIC
void gavl_rectangle_f_init(gavl_rectangle_f_t * r);
 
  
  
GAVL_PUBLIC
void gavl_rectangle_i_crop_to_format(gavl_rectangle_i_t * r,
                                   const gavl_video_format_t * format);

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

  
GAVL_PUBLIC
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);

  
GAVL_PUBLIC
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);
 
GAVL_PUBLIC
void gavl_rectangle_crop_to_format_scale_f(gavl_rectangle_f_t * src_rect,
                                           gavl_rectangle_f_t * dst_rect,
                                           const gavl_video_format_t * src_format,
                                           const gavl_video_format_t * dst_format);
 
  
  

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

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

  
GAVL_PUBLIC
void gavl_rectangle_i_crop_left(gavl_rectangle_i_t * r,   int num_pixels);

 
GAVL_PUBLIC
void gavl_rectangle_i_crop_right(gavl_rectangle_i_t * r,  int num_pixels);

 
GAVL_PUBLIC
void gavl_rectangle_i_crop_top(gavl_rectangle_i_t * r,    int num_pixels);

 
GAVL_PUBLIC
void gavl_rectangle_i_crop_bottom(gavl_rectangle_i_t * r, int num_pixels);

 
GAVL_PUBLIC
void gavl_rectangle_f_crop_left(gavl_rectangle_f_t * r,   double num_pixels);

 
GAVL_PUBLIC
void gavl_rectangle_f_crop_right(gavl_rectangle_f_t * r,  double num_pixels);

 
GAVL_PUBLIC
void gavl_rectangle_f_crop_top(gavl_rectangle_f_t * r,    double num_pixels);

 
GAVL_PUBLIC
void gavl_rectangle_f_crop_bottom(gavl_rectangle_f_t * r, double num_pixels);

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

  
GAVL_PUBLIC
void gavl_rectangle_i_align_to_format(gavl_rectangle_i_t * r,
                                      const gavl_video_format_t * format);
 
  
  
GAVL_PUBLIC
void gavl_rectangle_i_copy(gavl_rectangle_i_t * dst, const gavl_rectangle_i_t * src);

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

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

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

  
GAVL_PUBLIC
int gavl_rectangle_f_is_empty(const gavl_rectangle_f_t * r);

  
GAVL_PUBLIC
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);
 
GAVL_PUBLIC
void gavl_rectangle_fit_aspect_f(gavl_rectangle_f_t * r,
                                 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, int do_orient);
 
  
GAVL_PUBLIC
void gavl_rectangle_i_dump(const gavl_rectangle_i_t * r);

GAVL_PUBLIC
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)
  
  
enum gavl_pixelformat_e
  {
    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,
    
  };

 
typedef enum gavl_pixelformat_e 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

 
typedef enum
  {
    GAVL_CCH_NONE = 0, 
    GAVL_CCH_RED,      
    GAVL_CCH_GREEN,    
    GAVL_CCH_BLUE,     
    GAVL_CCH_Y,        
    GAVL_CCH_CB,       
    GAVL_CCH_CR,       
    GAVL_CCH_ALPHA,    
  } gavl_color_channel_t;
  
/*
 *  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)
 

  
GAVL_PUBLIC
int gavl_pixelformat_num_channels(gavl_pixelformat_t pixelformat);

  
GAVL_PUBLIC gavl_color_channel_t
gavl_pixelformat_get_channel(gavl_pixelformat_t pixelformat, int index);
 

 
GAVL_PUBLIC
int gavl_pixelformat_num_planes(gavl_pixelformat_t pixelformat);

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

  
GAVL_PUBLIC
int gavl_pixelformat_bytes_per_component(gavl_pixelformat_t pixelformat);

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

 
GAVL_PUBLIC
int gavl_pixelformat_conversion_penalty(gavl_pixelformat_t src,
                                        gavl_pixelformat_t dst);

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

 
GAVL_PUBLIC
const char * gavl_pixelformat_to_string(gavl_pixelformat_t pixelformat);

 
GAVL_PUBLIC
const char * gavl_pixelformat_to_short_string(gavl_pixelformat_t pixelformat);
 
  
 
GAVL_PUBLIC
gavl_pixelformat_t gavl_string_to_pixelformat(const char * name);

 
GAVL_PUBLIC
gavl_pixelformat_t gavl_short_string_to_pixelformat(const char * name);

 
GAVL_PUBLIC
const uint32_t * gavl_pixelformat_get_masks(gavl_pixelformat_t pixelformat);
 
  
  
 
GAVL_PUBLIC
int gavl_num_pixelformats(void);

 
GAVL_PUBLIC
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;

 
GAVL_PUBLIC
const char * gavl_chroma_placement_to_string(gavl_chroma_placement_t mode);

 
GAVL_PUBLIC
const char * gavl_chroma_placement_to_short_string(gavl_chroma_placement_t mode);

 
GAVL_PUBLIC
gavl_chroma_placement_t gavl_short_string_to_chroma_placement(const char * mode);
 
  
 
/* Changing the values alters the gmerlin-avdecoder index format */
 
typedef enum
  {
    GAVL_FRAMERATE_UNKNOWN     = -1, 
    GAVL_FRAMERATE_CONSTANT    = 0,  
    GAVL_FRAMERATE_VARIABLE    = 1,  
    GAVL_FRAMERATE_STILL       = 2,  
  } gavl_framerate_mode_t;

 
GAVL_PUBLIC
const char * gavl_framerate_mode_to_string(gavl_framerate_mode_t mode);

 
GAVL_PUBLIC
const char * gavl_framerate_mode_to_short_string(gavl_framerate_mode_t mode);

 
GAVL_PUBLIC
gavl_framerate_mode_t gavl_short_string_to_framerate_mode(const char * mode);
  
 
/* Changing the values alters the gmerlin-avdecoder index format */
  
typedef enum
  {
    GAVL_INTERLACE_UNKNOWN       = -1,
    GAVL_INTERLACE_NONE          = 0, 
    GAVL_INTERLACE_TOP_FIRST     = 1, 
    GAVL_INTERLACE_BOTTOM_FIRST  = 2, 
    GAVL_INTERLACE_MIXED         = (0x10 | 1), 
    GAVL_INTERLACE_MIXED_TOP     = (0x10 | 2), 
    GAVL_INTERLACE_MIXED_BOTTOM  = (0x10 | 3), 
  } gavl_interlace_mode_t;

 
GAVL_PUBLIC
const char * gavl_interlace_mode_to_string(gavl_interlace_mode_t mode);

 
GAVL_PUBLIC
const char * gavl_interlace_mode_to_short_string(gavl_interlace_mode_t mode);

 
GAVL_PUBLIC
gavl_interlace_mode_t gavl_short_string_to_interlace_mode(const char * mode);
  
  
GAVL_PUBLIC
int gavl_interlace_mode_is_mixed(gavl_interlace_mode_t mode);
  
#include <gavl/hw.h> // Needs forward declarations
 
/* Video format structure */
 
#define GAVL_IMAGE_ORIENT_FLIP_H     (1<<2)
 
typedef enum
  {
 
    GAVL_IMAGE_ORIENT_NORMAL      = 0, // EXIF: 1
    GAVL_IMAGE_ORIENT_ROT90_CW    = 1, // EXIF: 8
    GAVL_IMAGE_ORIENT_ROT180_CW   = 2, // EXIF: 3
    GAVL_IMAGE_ORIENT_ROT270_CW   = 3, // EXIF: 6
    
    GAVL_IMAGE_ORIENT_FH           = (GAVL_IMAGE_ORIENT_FLIP_H | GAVL_IMAGE_ORIENT_NORMAL),    // EXIF: 2
    GAVL_IMAGE_ORIENT_FH_ROT90_CW  = (GAVL_IMAGE_ORIENT_FLIP_H | GAVL_IMAGE_ORIENT_ROT90_CW),  // EXIF: 7
    GAVL_IMAGE_ORIENT_FH_ROT180_CW = (GAVL_IMAGE_ORIENT_FLIP_H | GAVL_IMAGE_ORIENT_ROT180_CW), // EXIF: 4
    GAVL_IMAGE_ORIENT_FH_ROT270_CW = (GAVL_IMAGE_ORIENT_FLIP_H | GAVL_IMAGE_ORIENT_ROT270_CW), // EXIF: 5
    
  } gavl_image_orientation_t;
  
  
struct gavl_video_format_s
  {
  uint32_t frame_width;
  uint32_t frame_height;
   
  uint32_t image_width;
  uint32_t image_height;
  
  /* Support for nonsquare pixels */
    
  uint32_t pixel_width;
  uint32_t pixel_height;
  
  gavl_pixelformat_t pixelformat;
 
  uint32_t frame_duration;
  uint32_t 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;
 
  gavl_hw_context_t * hwctx;         
  
  gavl_image_orientation_t orientation;
  };

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

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

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

  
GAVL_PUBLIC
int gavl_video_format_get_image_size(const gavl_video_format_t * format);
  
GAVL_PUBLIC
void gavl_video_format_get_frame_layout(const gavl_video_format_t * format,
                                        int * offsets,
                                        int * strides,
                                        int * buffersizes,
                                        int multiplane);
 
  
 
GAVL_PUBLIC
void gavl_video_format_set_frame_size(gavl_video_format_t * format,
                                      int pad_h, int pad_v);
 
  
 
GAVL_PUBLIC
int gavl_get_color_channel_format(const gavl_video_format_t * frame_format,
                                  gavl_video_format_t * channel_format,
                                  gavl_color_channel_t ch);
 

 
GAVL_PUBLIC
void gavl_get_field_format(const gavl_video_format_t * frame_format,
                          gavl_video_format_t * field_format,
                          int field);
  
  
  
GAVL_PUBLIC
void gavl_video_format_dump(const gavl_video_format_t * format);

 
GAVL_PUBLIC
void gavl_video_format_dumpi(const gavl_video_format_t * format, int indent);
 
GAVL_PUBLIC
void gavl_video_format_normalize_orientation(gavl_video_format_t * in_format,
                                             gavl_video_format_t * out_format);
 
  
GAVL_PUBLIC const char *
gavl_image_orientation_to_string(gavl_image_orientation_t orient);
 
GAVL_PUBLIC int 
gavl_image_orientation_is_transposed(gavl_image_orientation_t orient);
 
  

  
struct gavl_video_frame_s
  {
  uint8_t * planes[GAVL_MAX_PLANES]; 
  int strides[GAVL_MAX_PLANES];      
  
  void * client_data;    
  int64_t timestamp; 
  int64_t duration; 
  gavl_interlace_mode_t   interlace_mode;
  gavl_timecode_t timecode; 
 
  int dummy;             // !< Used to be reference count. Was renamed to keep ABI compatibility
  
  gavl_rectangle_i_t src_rect;   
  int32_t dst_x;                     
  int32_t dst_y;                     
 
  gavl_hw_context_t * hwctx;         
  void * storage;               
  
  int buf_idx;
  };
 

  
GAVL_PUBLIC
gavl_video_frame_t * gavl_video_frame_create(const gavl_video_format_t * format);

  
GAVL_PUBLIC
gavl_video_frame_t * gavl_video_frame_create_nopad(const gavl_video_format_t*format);
 
  

 
GAVL_PUBLIC
void gavl_video_frame_destroy(gavl_video_frame_t*frame);

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

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

  
GAVL_PUBLIC
void gavl_video_frame_absdiff(gavl_video_frame_t * dst,
                              const gavl_video_frame_t * src1,
                              const gavl_video_frame_t * src2,
                              const gavl_video_format_t * format);

  
GAVL_PUBLIC
void gavl_video_frame_psnr(double * psnr,
                           const gavl_video_frame_t * src1,
                           const gavl_video_frame_t * src2,
                           const gavl_video_format_t * format);

 
GAVL_PUBLIC
int gavl_video_frame_ssim(const gavl_video_frame_t * src1,
                          const gavl_video_frame_t * src2,
                          gavl_video_frame_t * dst,
                          const gavl_video_format_t * format);

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

  
GAVL_PUBLIC
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);

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

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

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

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

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

 
GAVL_PUBLIC
void gavl_video_frame_dump(gavl_video_frame_t * frame,
                           const gavl_video_format_t * format,
                           const char * namebase);

 
GAVL_PUBLIC
void gavl_video_frame_dump_metadata(const gavl_video_format_t * format,
                                    const gavl_video_frame_t * frame);

 
GAVL_PUBLIC
void gavl_video_frame_set_strides(gavl_video_frame_t * frame,
                                  const gavl_video_format_t * format);

 
  
GAVL_PUBLIC
void gavl_video_frame_set_planes(gavl_video_frame_t * frame,
                                 const gavl_video_format_t * format,
                                 uint8_t * buffer);

  
GAVL_PUBLIC
int gavl_video_frame_continuous(const gavl_video_format_t * format,
                                const gavl_video_frame_t * frame);
 
  
  
GAVL_PUBLIC
int gavl_video_frame_extract_channel(const gavl_video_format_t * format,
                                     gavl_color_channel_t ch,
                                     const gavl_video_frame_t * src,
                                     gavl_video_frame_t * dst);

 
  
GAVL_PUBLIC
int gavl_video_frame_insert_channel(const gavl_video_format_t * format,
                                    gavl_color_channel_t ch,
                                    const gavl_video_frame_t * src,
                                    gavl_video_frame_t * dst);
  
  
 
GAVL_PUBLIC
int gavl_video_frames_equal(const gavl_video_format_t * format,
                             const gavl_video_frame_t * f1,
                             const gavl_video_frame_t * f2);
 
GAVL_PUBLIC
void gavl_video_frame_normalize_orientation(const gavl_video_format_t * in_format,
                                            const gavl_video_format_t * out_format,
                                            const gavl_video_frame_t * in_frame,
                                            gavl_video_frame_t * out_frame);
 
GAVL_PUBLIC
void gavl_video_frame_to_packet_metadata(const gavl_video_frame_t * frame,
                                         gavl_packet_t * pkt);
 
GAVL_PUBLIC
void gavl_packet_to_video_frame_metadata(const gavl_packet_t * p, gavl_video_frame_t * frame);
 
GAVL_PUBLIC
void gavl_video_frame_set_from_packet(gavl_video_frame_t * frame,
                                      const gavl_video_format_t * format,
                                      gavl_packet_t * p);
  
/*****************************
 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)

 
#define GAVL_FORCE_SW          (1<<4)
  
  
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 enum
  {
    GAVL_DOWNSCALE_FILTER_AUTO = 0, 
    GAVL_DOWNSCALE_FILTER_NONE, 
    GAVL_DOWNSCALE_FILTER_WIDE, 
    GAVL_DOWNSCALE_FILTER_GAUSS, 
  } gavl_downscale_filter_t;
  
 
typedef struct gavl_video_options_s gavl_video_options_t;
 
/* Default Options */

  
GAVL_PUBLIC
void gavl_video_options_set_defaults(gavl_video_options_t * opt);

  
GAVL_PUBLIC
gavl_video_options_t * gavl_video_options_create(void);

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

 
GAVL_PUBLIC
void gavl_video_options_destroy(gavl_video_options_t * opt);
  
  
  
GAVL_PUBLIC
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);

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

 
GAVL_PUBLIC
int gavl_video_options_get_quality(const gavl_video_options_t * opt);
 
  
  
GAVL_PUBLIC
void gavl_video_options_set_conversion_flags(gavl_video_options_t * opt,
                                             int conversion_flags);

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

 
GAVL_PUBLIC gavl_alpha_mode_t
gavl_video_options_get_alpha_mode(const gavl_video_options_t * opt);
 
  
  
GAVL_PUBLIC
void gavl_video_options_set_scale_mode(gavl_video_options_t * opt,
                                       gavl_scale_mode_t scale_mode);

  
GAVL_PUBLIC gavl_scale_mode_t
gavl_video_options_get_scale_mode(const gavl_video_options_t * opt);
 
  
  
GAVL_PUBLIC
void gavl_video_options_set_scale_order(gavl_video_options_t * opt,
                                        int order);

  
GAVL_PUBLIC
int gavl_video_options_get_scale_order(const gavl_video_options_t * opt);
 
  
 
GAVL_PUBLIC
void gavl_video_options_set_background_color(gavl_video_options_t * opt,
                                             const double * color);

 
GAVL_PUBLIC
void gavl_video_options_get_background_color(const gavl_video_options_t * opt,
                                             double * color);
  
  
GAVL_PUBLIC
void gavl_video_options_set_deinterlace_mode(gavl_video_options_t * opt,
                                             gavl_deinterlace_mode_t deinterlace_mode);

  
GAVL_PUBLIC gavl_deinterlace_mode_t
gavl_video_options_get_deinterlace_mode(const gavl_video_options_t * opt);

  
GAVL_PUBLIC
void gavl_video_options_set_deinterlace_drop_mode(gavl_video_options_t * opt,
                                                  gavl_deinterlace_drop_mode_t deinterlace_drop_mode);

  
GAVL_PUBLIC gavl_deinterlace_drop_mode_t
gavl_video_options_get_deinterlace_drop_mode(const gavl_video_options_t * opt);

 
GAVL_PUBLIC
void gavl_video_options_set_downscale_filter(gavl_video_options_t * opt,
                                             gavl_downscale_filter_t f);
  

  
GAVL_PUBLIC gavl_downscale_filter_t
gavl_video_options_get_downscale_filter(const gavl_video_options_t * opt);

 
GAVL_PUBLIC
void gavl_video_options_set_downscale_blur(gavl_video_options_t * opt,
                                           float f);

  
GAVL_PUBLIC
float gavl_video_options_get_downscale_blur(const gavl_video_options_t * opt);
 
/* Set an externally created thread pool. If this is not called, a private thread pool will be created if needed.
   This function has the advantage that one thread pool can be shared among different elements of a video
   pipeline, which will reduce the overhead */
  
GAVL_PUBLIC
void gavl_video_options_set_thread_pool(gavl_video_options_t * opt, gavl_thread_pool_t * tp);
 
GAVL_PUBLIC
gavl_thread_pool_t * gavl_video_options_get_thread_pool(const gavl_video_options_t * opt);
  
/***************************************************
 * Create and destroy video converters
 ***************************************************/
  

  
typedef struct gavl_video_converter_s gavl_video_converter_t;

 
GAVL_PUBLIC
gavl_video_converter_t * gavl_video_converter_create(void);

  
GAVL_PUBLIC
void gavl_video_converter_destroy(gavl_video_converter_t*cnv);
 
/**************************************************
 * Get options. Change the options with the gavl_video_options_set_*
 * functions above
 **************************************************/

  
GAVL_PUBLIC gavl_video_options_t *
gavl_video_converter_get_options(gavl_video_converter_t*cnv);
 

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

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

  
GAVL_PUBLIC
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_PUBLIC
gavl_video_scaler_t * gavl_video_scaler_create(void);

 
GAVL_PUBLIC
void gavl_video_scaler_destroy(gavl_video_scaler_t * scaler);

  
GAVL_PUBLIC gavl_video_options_t *
gavl_video_scaler_get_options(gavl_video_scaler_t * scaler);

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

 
 
GAVL_PUBLIC
int gavl_video_scaler_init_convolve(gavl_video_scaler_t * scaler,
                                    const gavl_video_format_t * format,
                                    int h_radius, const float * h_coeffs,
                                    int v_radius, const float * v_coeffs);
  
  
GAVL_PUBLIC
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_PUBLIC
gavl_video_deinterlacer_t * gavl_video_deinterlacer_create(void);

 
GAVL_PUBLIC
void gavl_video_deinterlacer_destroy(gavl_video_deinterlacer_t * deinterlacer);

  
GAVL_PUBLIC gavl_video_options_t *
gavl_video_deinterlacer_get_options(gavl_video_deinterlacer_t * deinterlacer);

  
GAVL_PUBLIC
int gavl_video_deinterlacer_init(gavl_video_deinterlacer_t * deinterlacer,
                                 const gavl_video_format_t * src_format);
 
  
  
GAVL_PUBLIC
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 gavl_video_frame_t gavl_overlay_t;

  
typedef struct gavl_overlay_blend_context_s gavl_overlay_blend_context_t;

  
GAVL_PUBLIC
gavl_overlay_blend_context_t * gavl_overlay_blend_context_create(void);

 
GAVL_PUBLIC
void gavl_overlay_blend_context_destroy(gavl_overlay_blend_context_t * ctx);

  
GAVL_PUBLIC gavl_video_options_t *
gavl_overlay_blend_context_get_options(gavl_overlay_blend_context_t * ctx);

 
GAVL_PUBLIC
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);

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

  
GAVL_PUBLIC
void gavl_overlay_blend(gavl_overlay_blend_context_t * ctx,
                        gavl_video_frame_t * dst_frame);

 
GAVL_PUBLIC gavl_video_sink_t *
gavl_overlay_blend_context_get_sink(gavl_overlay_blend_context_t * ctx);
  

 
typedef struct gavl_image_transform_s gavl_image_transform_t;

 
typedef void (*gavl_image_transform_func)(void * priv,
                                          double xdst,
                                          double ydst,
                                          double * xsrc,
                                          double * ysrc);
 

  
GAVL_PUBLIC
gavl_image_transform_t * gavl_image_transform_create(void);

 
GAVL_PUBLIC
void gavl_image_transform_destroy(gavl_image_transform_t * t);

 
  
GAVL_PUBLIC
int gavl_image_transform_init(gavl_image_transform_t * t,
                              gavl_video_format_t * format,
                              gavl_image_transform_func func, void * priv);

  
GAVL_PUBLIC
void gavl_image_transform_transform(gavl_image_transform_t * t,
                                    gavl_video_frame_t * in_frame,
                                    gavl_video_frame_t * out_frame);

 
GAVL_PUBLIC gavl_video_options_t *
gavl_image_transform_get_options(gavl_image_transform_t * t);
  


  
typedef struct
  {
  int64_t offset; 
  /* Primary */
  int64_t num_entries; 
  int64_t entries_alloc; 
  
  struct
    {
    int64_t num_frames; 
    int64_t duration;   
    } * entries;        
  
  int num_timecodes; 
  int timecodes_alloc; 
 
  struct
    {
    int64_t pts;          
    gavl_timecode_t tc;   
    } * timecodes;        
  
  /* Secondary */
  
  } gavl_frame_table_t;

GAVL_PUBLIC gavl_frame_table_t * gavl_frame_table_create(void);

 
GAVL_PUBLIC gavl_frame_table_t *
gavl_frame_table_create_audio(int samplerate, int64_t offset, int64_t duration,
                              gavl_timecode_format_t * fmt_ret);

 
GAVL_PUBLIC gavl_frame_table_t *
gavl_frame_table_create_cfr(int64_t offset, int64_t frame_duration,
                            int64_t num_frames,
                            gavl_timecode_t start_timecode);
  
 
GAVL_PUBLIC gavl_frame_table_t *
gavl_frame_table_copy(const gavl_frame_table_t * tab);
 
 
  
  
GAVL_PUBLIC void gavl_frame_table_destroy(gavl_frame_table_t * t);

  
GAVL_PUBLIC void gavl_frame_table_append_entry(gavl_frame_table_t * t, int64_t duration);

 
GAVL_PUBLIC void
gavl_frame_table_append_timecode(gavl_frame_table_t * t,
                                 int64_t pts, gavl_timecode_t tc);

 
GAVL_PUBLIC int64_t
gavl_frame_table_frame_to_time(const gavl_frame_table_t * t,
                               int64_t frame, int * duration);

 
GAVL_PUBLIC int64_t
gavl_frame_table_time_to_frame(const gavl_frame_table_t * t,
                               int64_t time,
                               int64_t * start_time);

 
GAVL_PUBLIC gavl_timecode_t
gavl_frame_table_time_to_timecode(const gavl_frame_table_t * t,
                                  int64_t time,
                                  int64_t * start_time,
                                  const gavl_timecode_format_t * fmt);

 
GAVL_PUBLIC int64_t
gavl_frame_table_timecode_to_time(const gavl_frame_table_t * t,
                                  gavl_timecode_t tc,
                                  const gavl_timecode_format_t * fmt);
 

 
GAVL_PUBLIC gavl_timecode_t
gavl_frame_table_frame_to_timecode(const gavl_frame_table_t * t,
                                   int64_t frame,
                                   int64_t * start_time,
                                   const gavl_timecode_format_t * fmt);
 
  
  
  
GAVL_PUBLIC int64_t
gavl_frame_table_num_frames(const gavl_frame_table_t * t);

 
GAVL_PUBLIC int64_t
gavl_frame_table_duration(const gavl_frame_table_t * t);

 
GAVL_PUBLIC int64_t
gavl_frame_table_end_time(const gavl_frame_table_t * t);
  
  
GAVL_PUBLIC
int gavl_frame_table_save(const gavl_frame_table_t * t,
                          const char * filename);

 
GAVL_PUBLIC
gavl_frame_table_t * gavl_frame_table_load(const char * filename);
  
 
GAVL_PUBLIC void
gavl_frame_table_dump(const gavl_frame_table_t * t);
  


 
typedef struct gavl_video_frame_pool_s gavl_video_frame_pool_t;

  
GAVL_PUBLIC
gavl_video_frame_pool_t *
gavl_video_frame_pool_create(gavl_hw_context_t * hwctx);

 
GAVL_PUBLIC
gavl_video_frame_t * gavl_video_frame_pool_get(gavl_video_frame_pool_t *p);
 
GAVL_PUBLIC
void gavl_video_frame_pool_release(gavl_video_frame_t * frame);
 
GAVL_PUBLIC
int gavl_video_frame_pool_set_format(gavl_video_frame_pool_t *p, const gavl_video_format_t * fmt);
 
GAVL_PUBLIC
const gavl_video_format_t * gavl_video_frame_pool_get_format(const gavl_video_frame_pool_t *p);
  
  
GAVL_PUBLIC
void gavl_video_frame_pool_destroy(gavl_video_frame_pool_t *p);

 
GAVL_PUBLIC
void gavl_video_frame_pool_reset(gavl_video_frame_pool_t *p);
 
/* Debayer routines */
 
#define GAVL_BAYER_GREEN_FIRST (1<<0)
#define GAVL_BAYER_BLUE_LINE   (1<<1)
  
// GB
// RG
#define GAVL_BAYER_GBRG (GAVL_BAYER_GREEN_FIRST|GAVL_BAYER_BLUE_LINE)
 
// GR
// BG
#define GAVL_BAYER_GRBG (GAVL_BAYER_GREEN_FIRST)
 
// BG
// GR
#define GAVL_BAYER_BGGR (GAVL_BAYER_BLUE_LINE)
 
// RG
// GB
#define GAVL_BAYER_RGGB 0
  
GAVL_PUBLIC
void gavl_video_frame_debayer(gavl_video_options_t * opt,
                              gavl_video_frame_t * src, gavl_video_frame_t * dst,
                              int bayer_format, gavl_video_format_t * dst_format);
  
  
 
  
#ifdef __cplusplus
}
#endif
 
#endif /* GAVL_H_INCLUDED */