SSTV.h

#if !defined(_RADIOLIB_SSTV_H)
#define _RADIOLIB_SSTV_H

#include "../../TypeDef.h"

#if !defined(RADIOLIB_EXCLUDE_SSTV)

#include "../PhysicalLayer/PhysicalLayer.h"
#include "../AFSK/AFSK.h"

// the following implementation is based on information from
// http://www.barberdsp.com/downloads/Dayton%20Paper.pdf

// VIS codes
#define SSTV_SCOTTIE_1                                60
#define SSTV_SCOTTIE_2                                56
#define SSTV_SCOTTIE_DX                               76
#define SSTV_MARTIN_1                                 44
#define SSTV_MARTIN_2                                 40
#define SSTV_WRASSE_SC2_180                           55
#define SSTV_PASOKON_P3                               113
#define SSTV_PASOKON_P5                               114
#define SSTV_PASOKON_P7                               115

// SSTV tones in Hz
#define SSTV_TONE_LEADER                              1900
#define SSTV_TONE_BREAK                               1200
#define SSTV_TONE_VIS_1                               1100
#define SSTV_TONE_VIS_0                               1300
#define SSTV_TONE_BRIGHTNESS_MIN                      1500
#define SSTV_TONE_BRIGHTNESS_MAX                      2300

// calibration header timing in us
#define SSTV_HEADER_LEADER_LENGTH                     300000
#define SSTV_HEADER_BREAK_LENGTH                      10000
#define SSTV_HEADER_BIT_LENGTH                        30000

struct tone_t {

  enum {
    GENERIC = 0,
    SCAN_GREEN,
    SCAN_BLUE,
    SCAN_RED
  } type;

  uint32_t len;

  uint16_t freq;
};

struct SSTVMode_t {

  uint8_t visCode;

  uint16_t width;

  uint16_t height;

  uint16_t scanPixelLen;

  uint8_t numTones;

  tone_t tones[8];
};

// all currently supported SSTV modes
extern const SSTVMode_t Scottie1;
extern const SSTVMode_t Scottie2;
extern const SSTVMode_t ScottieDX;
extern const SSTVMode_t Martin1;
extern const SSTVMode_t Martin2;
extern const SSTVMode_t Wrasse;
extern const SSTVMode_t PasokonP3;
extern const SSTVMode_t PasokonP5;
extern const SSTVMode_t PasokonP7;

class SSTVClient {
  public:
    explicit SSTVClient(PhysicalLayer* phy);

    #if !defined(RADIOLIB_EXCLUDE_AFSK)

    explicit SSTVClient(AFSKClient* audio);
    #endif

    // basic methods

    int16_t begin(float base, const SSTVMode_t& mode, float correction = 1.0);

    #if !defined(RADIOLIB_EXCLUDE_AFSK)

    int16_t begin(const SSTVMode_t& mode, float correction = 1.0);
    #endif

    void idle();

    void sendHeader();

    void sendLine(uint32_t* imgLine);

    uint16_t getPictureHeight() const;

#ifndef RADIOLIB_GODMODE
  private:
#endif
    PhysicalLayer* _phy;
    #if !defined(RADIOLIB_EXCLUDE_AFSK)
    AFSKClient* _audio;
    #endif

    uint32_t _base = 0;
    SSTVMode_t _mode = Scottie1;
    bool _firstLine = true;

    void tone(float freq, uint32_t len = 0);
};

#endif

#endif