CLK/StaticAnalyser/Acorn/Tape.cpp

//
//  Tape.cpp
//  Clock Signal
//
//  Created by Thomas Harte on 29/08/2016.
//  Copyright © 2016 Thomas Harte. All rights reserved.
//

#include "Tape.hpp"

using namespace StaticAnalyser::Acorn;

struct TapeParser {

	TapeParser(const std::shared_ptr<Storage::Tape::Tape> &tape) : _wave_length_pointer(0), _tape(tape) {}

	int get_next_bit()
	{
		while(!_tape->is_at_end())
		{
			// skip any gaps
			Storage::Tape::Tape::Pulse next_pulse = _tape->get_next_pulse();
			while(!_tape->is_at_end() && next_pulse.type == Storage::Tape::Tape::Pulse::Zero)
			{
				next_pulse = _tape->get_next_pulse();
			}

			_wave_lengths[_wave_length_pointer] = next_pulse.length.get_float();
			_wave_length_pointer++;

			// if first wave is too short or too long, drop it
			if(_wave_lengths[0] < 1.0f / 4800.0f || _wave_lengths[0] >= 5.0f / 4800.0f)
			{
				rotate(1);
			}

			// if first two waves add up to a correct-length cycle, pop them and this is a 0
			if(_wave_length_pointer >= 2)
			{
				float length = _wave_lengths[0] + _wave_lengths[1];
				if(length >= 3.0f / 4800.0f && length < 5.0f / 4800.0f)
				{
					rotate(2);
					return 0;
				}
			}

			// if all four waves add up to a correct-length cycle, pop them and this is a 1
			if(_wave_length_pointer == 4)
			{
				float length = _wave_lengths[0] + _wave_lengths[1] + _wave_lengths[2] + _wave_lengths[3];
				if(length >= 3.0f / 4800.0f && length < 5.0f / 4800.0f)
				{
					rotate(4);
					return 1;
				}
				else
				{
					rotate(1);
				}
			}
		}

		return 0;
	}

	int get_next_byte()
	{
		int value = 0;
		int c = 8;
		if(get_next_bit())
		{
			_error_flag = true;
			return -1;
		}
		while(c--)
		{
			value = (value >> 1) | (get_next_bit() << 7);
		}
		if(!get_next_bit())
		{
			_error_flag = true;
			return -1;
		}
		add_to_crc((uint8_t)value);
		return value;
	}

	int get_next_short()
	{
		int result = get_next_byte();
		result |= get_next_byte() << 8;
		return result;
	}

	int get_next_word()
	{
		int result = get_next_short();
		result |= get_next_short() << 8;
		return result;
	}

	void reset_error_flag()
	{
		_error_flag = false;
	}

	bool get_error_flag()
	{
		return _error_flag;
	}

	void reset_crc()
	{
		_crc = 0;
	}

		void add_to_crc(uint8_t value)
		{
			_crc ^= (uint16_t)value << 8;
			for(int c = 0; c < 8; c++)
			{
				uint16_t exclusive_or = (_crc&0x8000) ? 0x1021 : 0x0000;
				_crc = (uint16_t)(_crc << 1) ^ exclusive_or;
			}
		}

	uint16_t get_crc()
	{
		return _crc;
	}

	bool is_at_end()
	{
		return _tape->is_at_end();
	}

	private:
		void rotate(int places)
		{
			_wave_length_pointer -= places;
			if(places < 4) memmove(_wave_lengths, &_wave_lengths[places], (size_t)(4 - places) * sizeof(float));
		}


		uint16_t _crc;
		bool _error_flag;

		float _wave_lengths[4];
		int _wave_length_pointer;
		std::shared_ptr<Storage::Tape::Tape> _tape;
};

static std::unique_ptr<File::Chunk> GetNextChunk(TapeParser &parser)
{
	std::unique_ptr<File::Chunk> new_chunk(new File::Chunk);
	int shift_register = 0;

// TODO: move this into the parser
#define shift()	shift_register = (shift_register >> 1) |  (parser.get_next_bit() << 9)

	// find next area of high tone
	while(!parser.is_at_end() && (shift_register != 0x3ff))
	{
		shift();
	}

	// find next 0x2a (swallowing stop bit)
	while(!parser.is_at_end() && (shift_register != 0x254))
	{
		shift();
	}

#undef shift

	parser.reset_crc();
	parser.reset_error_flag();

	// read out name
	char name[10];
	int name_ptr = 0;
	while(!parser.is_at_end() && name_ptr < 10)
	{
		name[name_ptr] = (char)parser.get_next_byte();
		if(!name[name_ptr]) break;
		name_ptr++;
	}
	new_chunk->name = name;

	// addresses
	new_chunk->load_address = (uint32_t)parser.get_next_word();
	new_chunk->execution_address = (uint32_t)parser.get_next_word();
	new_chunk->block_number = (uint16_t)parser.get_next_short();
	new_chunk->block_length = (uint16_t)parser.get_next_short();
	new_chunk->block_flag = (uint8_t)parser.get_next_byte();
	new_chunk->next_address = (uint32_t)parser.get_next_word();

	uint16_t calculated_header_crc = parser.get_crc();
	uint16_t stored_header_crc = (uint16_t)parser.get_next_short();
	stored_header_crc = (uint16_t)((stored_header_crc >> 8) | (stored_header_crc << 8));
	new_chunk->header_crc_matched = stored_header_crc == calculated_header_crc;

	parser.reset_crc();
	new_chunk->data.reserve(new_chunk->block_length);
	for(int c = 0; c < new_chunk->block_length; c++)
	{
		new_chunk->data.push_back((uint8_t)parser.get_next_byte());
	}

	if(new_chunk->block_length && !new_chunk->block_flag&0x40)
	{
		uint16_t calculated_data_crc = parser.get_crc();
		uint16_t stored_data_crc = (uint16_t)parser.get_next_short();
		stored_data_crc = (uint16_t)((stored_data_crc >> 8) | (stored_data_crc << 8));
		new_chunk->data_crc_matched = stored_data_crc == calculated_data_crc;
	}
	else
	{
		new_chunk->data_crc_matched = true;
	}

	return parser.get_error_flag() ? nullptr : std::move(new_chunk);
}

std::unique_ptr<File> GetNextFile(TapeParser &parser)
{
	std::unique_ptr<File::Chunk> chunk;

	// find next chunk with a block number of 0
	while(!parser.is_at_end())
	{
		chunk = GetNextChunk(parser);
		if(!chunk) continue;
		if(!chunk->block_number) break;
	}

	if(!chunk) return nullptr;

	// accumulate chunks for as long as block number is sequential and the end-of-file bit isn't set
	std::unique_ptr<File> file(new File);
	file->chunks.push_back(*chunk);
	while(!parser.is_at_end())
	{
		std::unique_ptr<File::Chunk> next_chunk = GetNextChunk(parser);
		if(!next_chunk) return nullptr;
		if(next_chunk->block_number != chunk->block_number + 1) return nullptr;
		file->chunks.push_back(*next_chunk);
		chunk = std::move(next_chunk);
		if(chunk->block_flag&0x80) break;
	}

	// accumulate total data, copy flags appropriately
	file->name = file->chunks.front().name;
	file->load_address = file->chunks.front().load_address;
	file->execution_address = file->chunks.front().execution_address;
	file->is_protected = !!(file->chunks.back().block_flag & 0x01);	// I think the last flags are the ones that count; TODO: check.

	// copy all data into a single big block
	for(File::Chunk chunk : file->chunks)
	{
		file->data.insert(file->data.end(), chunk.data.begin(), chunk.data.end());
	}

	return file;
}

std::list<File> StaticAnalyser::Acorn::GetFiles(const std::shared_ptr<Storage::Tape::Tape> &tape)
{
	TapeParser parser(tape);
	std::list<File> file_list;

	while(!parser.is_at_end())
	{
		std::unique_ptr<File> next_file = GetNextFile(parser);
		if(next_file)
		{
			file_list.push_back(*next_file);
		}
	}

	return file_list;
}