sstvmode.h

Go to the documentation of this file.

#ifndef _SSTVENC_SSTVMODE_H
#define _SSTVENC_SSTVMODE_H
 
/*
 * © Stuart Longland VK4MSL
 * SPDX-License-Identifier: MIT
 */
 
#include <assert.h>
#include <stdint.h>
#include <string.h>
 
#define SSTVENC_PERIOD_VIS_START (300000u)
#define SSTVENC_PERIOD_VIS_SYNC  (10000u)
#define SSTVENC_PERIOD_VIS_BIT   (30000u)
 
#define SSTVENC_PERIOD_FSKID_BIT (22000u)
 
#define SSTVENC_CSO_BIT_MODE     (12)
 
#define SSTVENC_CSO_BIT_C(n)     ((n) * 3)
 
#define SSTVENC_CSO_MASK_MODE    (0170000)
 
#define SSTVENC_CSO_MASK_C(n)    (07 << ((n) * 3))
 
#define SSTVENC_CSO_MODE_MONO    (0 << SSTVENC_CSO_BIT_MODE)
 
#define SSTVENC_CSO_MODE_RGB     (1 << SSTVENC_CSO_BIT_MODE)
 
#define SSTVENC_CSO_MODE_YUV     (2 << SSTVENC_CSO_BIT_MODE)
 
#define SSTVENC_CSO_MODE_YUV2    (3 << SSTVENC_CSO_BIT_MODE)
 
#define SSTVENC_CSO_CH_NONE      (0) 
#define SSTVENC_CSO_CH_Y         (1) 
#define SSTVENC_CSO_CH_U         (2) 
#define SSTVENC_CSO_CH_V         (3) 
#define SSTVENC_CSO_CH_R         (4) 
#define SSTVENC_CSO_CH_G         (5) 
#define SSTVENC_CSO_CH_B         (6) 
#define SSTVENC_CSO_CH_Y2        (7) 
#define SSTVENC_MODE_GET_CH(n, mode)                                         \
        (((mode) & SSTVENC_CSO_MASK_C(n)) >> SSTVENC_CSO_BIT_C(n))
 
#define SSTVENC_MODE_ORDER(cs, c0, c1, c2, c3)                               \
        (((cs) & SSTVENC_CSO_MASK_MODE)                                      \
         | (((c0) << SSTVENC_CSO_BIT_C(0)) & SSTVENC_CSO_MASK_C(0))          \
         | (((c1) << SSTVENC_CSO_BIT_C(1)) & SSTVENC_CSO_MASK_C(1))          \
         | (((c2) << SSTVENC_CSO_BIT_C(2)) & SSTVENC_CSO_MASK_C(2))          \
         | (((c3) << SSTVENC_CSO_BIT_C(3)) & SSTVENC_CSO_MASK_C(3)))
 
struct sstvenc_encoder_pulse {
        uint32_t frequency;
        uint32_t duration_ns;
};
 
struct sstvenc_mode {
        const char*                         description;
 
        const char*                         name;
 
        const struct sstvenc_encoder_pulse* initseq;
 
        const struct sstvenc_encoder_pulse* frontporch;
 
        const struct sstvenc_encoder_pulse* gap01;
 
        const struct sstvenc_encoder_pulse* gap12;
 
        const struct sstvenc_encoder_pulse* gap23;
 
        const struct sstvenc_encoder_pulse* backporch;
 
        const struct sstvenc_encoder_pulse* finalseq;
 
        uint32_t                            scanline_period_ns[4];
 
        uint16_t                            width;
 
        uint16_t                            height;
 
        uint16_t                            colour_space_order;
 
        uint8_t                             vis_code;
};
 
uint8_t                    sstvenc_get_mode_count();
 
const struct sstvenc_mode* sstvenc_get_mode_by_idx(uint8_t idx);
 
const struct sstvenc_mode* sstvenc_get_mode_by_name(const char* name);
 
uint64_t sstvenc_pulseseq_get_txtime(const struct sstvenc_encoder_pulse* seq);
 
uint64_t sstvenc_mode_get_txtime(const struct sstvenc_mode* const mode,
                                 const char*                      fsk_id);
 
size_t   sstvenc_mode_get_fb_sz(const struct sstvenc_mode* const mode);
 
uint32_t sstvenc_get_pixel_posn(const struct sstvenc_mode* const mode,
                                uint16_t x, uint16_t y);
 
#endif