P25Clients/P25Gateway/Voice.cpp

/*
*   Copyright (C) 2017,2018,2019 by Jonathan Naylor G4KLX
*
*   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, write to the Free Software
*   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include "Voice.h"
#include "Log.h"

#include <cstdio>
#include <cstring>
#include <cstdlib>
#include <cassert>

#include <sys/stat.h>

const unsigned char REC62[] = {
    0x62U, 0x02U, 0x02U, 0x0CU, 0x0BU, 0x12U, 0x64U, 0x00U, 0x00U, 0x80U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U,
    0x00U, 0x00U, 0x00U, 0x00U, 0x00U };

const unsigned char REC63[] = {
    0x63U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC64[] = {
    0x64U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC65[] = {
    0x65U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC66[] = {
    0x66U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC67[] = {
    0x67U, 0xF0U, 0x9DU, 0x6AU, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC68[] = {
    0x68U, 0x19U, 0xD4U, 0x26U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC69[] = {
    0x69U, 0xE0U, 0xEBU, 0x7BU, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC6A[] = {
    0x6AU, 0x00U, 0x00U, 0x02U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U };

const unsigned char REC6B[] = {
    0x6BU, 0x02U, 0x02U, 0x0CU, 0x0BU, 0x12U, 0x64U, 0x00U, 0x00U, 0x80U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U,
    0x00U, 0x00U, 0x00U, 0x00U, 0x00U };

const unsigned char REC6C[] = {
    0x6CU, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC6D[] = {
    0x6DU, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC6E[] = {
    0x6EU, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC6F[] = {
    0x6FU, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC70[] = {
    0x70U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC71[] = {
    0x71U, 0xACU, 0xB8U, 0xA4U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC72[] = {
    0x72U, 0x9BU, 0xDCU, 0x75U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x02U };

const unsigned char REC73[] = {
    0x73U, 0x00U, 0x00U, 0x02U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U };

const unsigned char REC80[] = {
    0x80U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U, 0x00U };

const unsigned char SILENCE[] = { 0x04U, 0x0CU, 0xFDU, 0x7BU, 0xFBU, 0x7DU, 0xF2U, 0x7BU, 0x3DU, 0x9EU, 0x44U };

const unsigned int P25_FRAME_TIME = 20U;

const unsigned int SILENCE_LENGTH = 4U;
const unsigned int IMBE_LENGTH = 11U;

const unsigned int LDU_LENGTH = 9U;

CVoice::CVoice(const std::string& directory, const std::string& language, unsigned int srcId) :
m_language(language),
m_indxFile(),
m_imbeFile(),
m_srcId(srcId),
m_status(VS_NONE),
m_timer(1000U, 1U),
m_stopWatch(),
m_sent(0U),
m_n(0x62U),
m_dstId(0U),
m_imbe(NULL),
m_voiceData(NULL),
m_voiceLength(0U),
m_positions()
{
	assert(!directory.empty());
	assert(!language.empty());

#if defined(_WIN32) || defined(_WIN64)
	m_indxFile = directory + "\\" + language + ".indx";
	m_imbeFile = directory + "\\" + language + ".imbe";
#else
	m_indxFile = directory + "/" + language + ".indx";
	m_imbeFile = directory + "/" + language + ".imbe";
#endif

	// Approximately 10 seconds worth
	m_voiceData = new unsigned char[10U * 50U * IMBE_LENGTH];
}

CVoice::~CVoice()
{
	for (std::unordered_map<std::string, CPositions*>::iterator it = m_positions.begin(); it != m_positions.end(); ++it)
		delete it->second;

	m_positions.clear();

	delete[] m_imbe;
	delete[] m_voiceData;
}

bool CVoice::open()
{
	FILE* fpindx = ::fopen(m_indxFile.c_str(), "rt");
	if (fpindx == NULL) {
		LogError("Unable to open the index file - %s", m_indxFile.c_str());
		return false;
	}

	struct stat statStruct;
	int ret = ::stat(m_imbeFile.c_str(), &statStruct);
	if (ret != 0) {
		LogError("Unable to stat the IMBE file - %s", m_imbeFile.c_str());
		::fclose(fpindx);
		return false;
	}

	FILE* fpimbe = ::fopen(m_imbeFile.c_str(), "rb");
	if (fpimbe == NULL) {
		LogError("Unable to open the IMBE file - %s", m_imbeFile.c_str());
		::fclose(fpindx);
		return false;
	}

	m_imbe = new unsigned char[statStruct.st_size];

	size_t sizeRead = ::fread(m_imbe, 1U, statStruct.st_size, fpimbe);
	if (sizeRead != 0U) {
		char buffer[80U];
		while (::fgets(buffer, 80, fpindx) != NULL) {
			char* p1 = ::strtok(buffer, "\t\r\n");
			char* p2 = ::strtok(NULL, "\t\r\n");
			char* p3 = ::strtok(NULL, "\t\r\n");

			if (p1 != NULL && p2 != NULL && p3 != NULL) {
				std::string symbol  = std::string(p1);
				unsigned int start  = ::atoi(p2) * IMBE_LENGTH;
				unsigned int length = ::atoi(p3) * IMBE_LENGTH;

				CPositions* pos = new CPositions;
				pos->m_start = start;
				pos->m_length = length;

				m_positions[symbol] = pos;
			}
		}
	}

	::fclose(fpindx);
	::fclose(fpimbe);

	LogInfo("Loaded the audio and index file for %s", m_language.c_str());

	return true;
}

void CVoice::linkedTo(unsigned int tg)
{
	char letters[10U];
	::sprintf(letters, "%u", tg);

	std::vector<std::string> words;
	if (m_positions.count("linkedto") == 0U) {
		words.push_back("linked");
		words.push_back("2");
	} else {
		words.push_back("linkedto");
	}

	for (unsigned int i = 0U; letters[i] != 0x00U; i++)
		words.push_back(std::string(1U, letters[i]));

	createVoice(tg, words);
}

void CVoice::unlinked()
{
	std::vector<std::string> words;
	words.push_back("notlinked");

	createVoice(9999U, words);
}

void CVoice::createVoice(unsigned int tg, const std::vector<std::string>& words)
{
	m_dstId = tg;

	m_voiceLength = 0U;
	for (std::vector<std::string>::const_iterator it = words.begin(); it != words.end(); ++it) {
		if (m_positions.count(*it) > 0U) {
			CPositions* position = m_positions.at(*it);
			m_voiceLength += position->m_length;
		} else {
			LogWarning("Unable to find character/phrase \"%s\" in the index", (*it).c_str());
		}
	}

	// Add space for silence before and after the voice
	m_voiceLength += SILENCE_LENGTH * IMBE_LENGTH;
	m_voiceLength += SILENCE_LENGTH * IMBE_LENGTH;

	// Round to the next highest LDU frame length
	unsigned int n = (m_voiceLength / IMBE_LENGTH) % LDU_LENGTH;
	if (n > 0U)
		m_voiceLength += (LDU_LENGTH - n) * IMBE_LENGTH;

	// Fill the IMBE data with silence
	unsigned int offset = 0U;
	for (unsigned int i = 0U; i < (m_voiceLength / IMBE_LENGTH); i++, offset += IMBE_LENGTH)
		::memcpy(m_voiceData + offset, SILENCE, IMBE_LENGTH);

	// Put offset in for silence at the beginning
	unsigned int pos = SILENCE_LENGTH * IMBE_LENGTH;
	for (std::vector<std::string>::const_iterator it = words.begin(); it != words.end(); ++it) {
		if (m_positions.count(*it) > 0U) {
			CPositions* position = m_positions.at(*it);
			unsigned int start  = position->m_start;
			unsigned int length = position->m_length;
			::memcpy(m_voiceData + pos, m_imbe + start, length);
			pos += length;
		}
	}
}

unsigned int CVoice::read(unsigned char* data)
{
	assert(data != NULL);

	if (m_status != VS_SENDING)
		return 0U;

	unsigned int offset = m_sent * IMBE_LENGTH;

	if (offset >= m_voiceLength) {
		::memcpy(data, REC80, 17U);
		m_timer.stop();
		m_voiceLength = 0U;
		m_status = VS_NONE;
		return 17U;
	}

	unsigned int count = m_stopWatch.elapsed() / P25_FRAME_TIME;

	unsigned int length = 0U;

	if (m_sent < count) {
		switch (m_n) {
		case 0x62U:
			::memcpy(data, REC62, 22U);
			::memcpy(data + 10U, m_voiceData + offset, IMBE_LENGTH);
			length = 22U;
			m_n = 0x63U;
			break;
		case 0x63U:
			::memcpy(data, REC63, 14U);
			::memcpy(data + 1U, m_voiceData + offset, IMBE_LENGTH);
			length = 14U;
			m_n = 0x64U;
			break;
		case 0x64U:
			::memcpy(data, REC64, 17U);
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x65U;
			break;
		case 0x65U:
			::memcpy(data, REC65, 17U);
			data[1U] = (m_dstId >> 16) & 0xFFU;
			data[2U] = (m_dstId >> 8) & 0xFFU;
			data[3U] = (m_dstId >> 0) & 0xFFU;
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x66U;
			break;
		case 0x66U:
			::memcpy(data, REC66, 17U);
			data[1U] = (m_srcId >> 16) & 0xFFU;
			data[2U] = (m_srcId >> 8) & 0xFFU;
			data[3U] = (m_srcId >> 0) & 0xFFU;
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x67U;
			break;
		case 0x67U:
			::memcpy(data, REC67, 17U);
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x68U;
			break;
		case 0x68U:
			::memcpy(data, REC68, 17U);
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x69U;
			break;
		case 0x69U:
			::memcpy(data, REC69, 17U);
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x6AU;
			break;
		case 0x6AU:
			::memcpy(data, REC6A, 16U);
			::memcpy(data + 4U, m_voiceData + offset, IMBE_LENGTH);
			length = 16U;
			m_n = 0x6BU;
			break;
		case 0x6BU:
			::memcpy(data, REC6B, 22U);
			::memcpy(data + 10U, m_voiceData + offset, IMBE_LENGTH);
			length = 22U;
			m_n = 0x6CU;
			break;
		case 0x6CU:
			::memcpy(data, REC6C, 14U);
			::memcpy(data + 1U, m_voiceData + offset, IMBE_LENGTH);
			length = 14U;
			m_n = 0x6DU;
			break;
		case 0x6DU:
			::memcpy(data, REC6D, 17U);
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x6EU;
			break;
		case 0x6EU:
			::memcpy(data, REC6E, 17U);
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x6FU;
			break;
		case 0x6FU:
			::memcpy(data, REC6F, 17U);
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x70U;
			break;
		case 0x70U:
			::memcpy(data, REC70, 17U);
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x71U;
			break;
		case 0x71U:
			::memcpy(data, REC71, 17U);
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x72U;
			break;
		case 0x72U:
			::memcpy(data, REC72, 17U);
			::memcpy(data + 5U, m_voiceData + offset, IMBE_LENGTH);
			length = 17U;
			m_n = 0x73U;
			break;
		default:
			::memcpy(data, REC73, 16U);
			::memcpy(data + 4U, m_voiceData + offset, IMBE_LENGTH);
			length = 16U;
			m_n = 0x62U;
			break;
		}

		m_sent++;
	}

	return length;
}

void CVoice::eof()
{
	if (m_voiceLength == 0U)
		return;

	m_status = VS_WAITING;

	m_timer.start();
}

void CVoice::clock(unsigned int ms)
{
	m_timer.clock(ms);
	if (m_timer.isRunning() && m_timer.hasExpired()) {
		if (m_status == VS_WAITING) {
			m_stopWatch.start();
			m_status = VS_SENDING;
			m_sent = 0U;
			m_n = 0x62U;
		}
	}
}