portapack-mayhem/firmware/common/pocsag_packet.hpp

/*
 * Copyright (C) 2015 Jared Boone, ShareBrained Technology, Inc.
 * Copyright (C) 2016 Furrtek
 *
 * This file is part of PortaPack.
 *
 * 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, 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; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __POCSAG_PACKET_H__
#define __POCSAG_PACKET_H__

#include <cstdint>
#include <cstddef>

#include "optional.hpp"

#include "baseband.hpp"

namespace pocsag {

enum BitRate : uint32_t {
	UNKNOWN,
	FSK512 = 512,
	FSK1200 = 1200,
	FSK2400 = 2400
};

enum PacketFlag : uint32_t {
	NORMAL,
	IDLE,
	TIMED_OUT,
	TOO_LONG
};

class POCSAGPacket {
public:
	void set_timestamp(const Timestamp& value) {
		timestamp_ = value;
	}
	
	Timestamp timestamp() const {
		return timestamp_;
	}

	void set(const size_t index, const uint32_t data) {
		if (index < 16)
			codewords[index] = data;
	}

	uint32_t operator[](const size_t index) const {
		return (index < 16) ? codewords[index] : 0;
	}
	
	void set_bitrate(const BitRate bitrate) {
		bitrate_ = bitrate;
	}
	
	BitRate bitrate() const {
		return bitrate_;
	}
	
	void set_flag(const PacketFlag flag) {
		flag_ = flag;
	}
	
	PacketFlag flag() const {
		return flag_;
	}

	void clear() {
		for (uint32_t c = 0; c < 16; c++)
			codewords[c] = 0;
		bitrate_ = UNKNOWN;
		flag_ = NORMAL;
	}

private:
	BitRate bitrate_ { UNKNOWN };
	PacketFlag flag_ { NORMAL };
	uint32_t codewords[16];
	Timestamp timestamp_ { };
};

} /* namespace pocsag */

#endif/*__POCSAG_PACKET_H__*/