vbidecoder.h

/************************************************************************

    vbidecoder.cpp

    ld-decode-tools TBC library
    Copyright (C) 2018-2019 Simon Inns

    This file is part of ld-decode-tools.

    ld-decode-tools 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 3 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 VBIDECODER_H
#define VBIDECODER_H

#include <QDebug>

class VbiDecoder
{
public:
    // VBI Metadata definition
    enum VbiDiscTypes {
        unknownDiscType,    // 0
        clv,                // 1
        cav                 // 2
    };

    // VBI Sound modes
    enum VbiSoundModes {
        stereo,                 // 0
        mono,                   // 1
        audioSubCarriersOff,    // 2
        bilingual,              // 3
        stereo_stereo,          // 4
        stereo_bilingual,       // 5
        crossChannelStereo,     // 6
        bilingual_bilingual,    // 7
        mono_dump,              // 8
        stereo_dump,            // 9
        bilingual_dump,         // 10
        futureUse               // 11
    };

    // Overall container struct for VBI information, with default values
    struct Vbi {
        VbiDiscTypes type = VbiDiscTypes::unknownDiscType;
        QString userCode = "";
        qint32 picNo = -1;
        qint32 chNo = -1;
        qint32 clvHr = -1;
        qint32 clvMin = -1;
        qint32 clvSec = -1;
        qint32 clvPicNo = -1;
        VbiSoundModes soundMode = VbiSoundModes::futureUse;
        VbiSoundModes soundModeAm2 = VbiSoundModes::futureUse;

        bool leadIn = false;
        bool leadOut = false;
        bool picStop = false;
        bool cx = false;
        bool size = false;
        bool side = false;
        bool teletext = false;
        bool dump = false;
        bool fm = false;
        bool digital = false;
        bool parity = false;
        bool copyAm2 = false;
        bool standardAm2 = false;
    };

    VbiDecoder();
    Vbi decodeFrame(qint32 vbi16_1, qint32 vbi17_1, qint32 vbi18_1,
                    qint32 vbi16_2, qint32 vbi17_2, qint32 vbi18_2);
    Vbi decode(qint32 vbi16, qint32 vbi17, qint32 vbi18);

private:
    bool verboseDebug;
    bool parity(quint32 x4, quint32 x5);
    bool decodeBCD(quint32 bcd, qint32 &output);
};

#endif // VBIDECODER_H