CLK/Storage/Tape/Formats/CSW.hpp

//
//  CSW.hpp
//  Clock Signal
//
//  Created by Thomas Harte on 10/07/2017.
//  Copyright 2017 Thomas Harte. All rights reserved.
//

#pragma once

#include "../Tape.hpp"

#include <string>
#include <vector>
#include <zlib.h>

namespace Storage::Tape {

/*!
	Provides a @c Tape containing a CSW tape image, which is a compressed 1-bit sampling.
*/
class CSW: public Tape {
public:
	/*!
		Constructs a @c CSW containing content from the file with name @c file_name.

		@throws ErrorNotCSW if this file could not be opened and recognised as a valid CSW file.
	*/
	CSW(const std::string &file_name);

	enum class CompressionType {
		RLE,
		ZRLE
	};

	/*!
		Constructs a @c CSW containing content as specified. Does not throw.
	*/
	CSW(const std::vector<uint8_t> &&data, CompressionType compression_type, bool initial_level, uint32_t sampling_rate);

	enum {
		ErrorNotCSW
	};

	// implemented to satisfy @c Tape
	bool is_at_end();

private:
	void virtual_reset();
	Pulse virtual_get_next_pulse();

	Pulse pulse_;
	CompressionType compression_type_;

	uint8_t get_next_byte();
	uint32_t get_next_int32le();
	void invert_pulse();

	std::vector<uint8_t> source_data_;
	std::size_t source_data_pointer_;
};

}