CLK/Storage/Disk/PCMPatchedTrack.cpp

//
//  PCMPatchedTrack.cpp
//  Clock Signal
//
//  Created by Thomas Harte on 15/12/2016.
//  Copyright © 2016 Thomas Harte. All rights reserved.
//

#include "PCMPatchedTrack.hpp"

#include <cassert>

using namespace Storage::Disk;

PCMPatchedTrack::PCMPatchedTrack(std::shared_ptr<Track> underlying_track) :
		underlying_track_(underlying_track) {
	const Time zero(0);
	const Time one(1);
	periods_.emplace_back(zero, one, zero, nullptr);
	active_period_ = periods_.begin();
	underlying_track_->seek_to(zero);
}

PCMPatchedTrack::PCMPatchedTrack(const PCMPatchedTrack &original) {
	underlying_track_.reset(original.underlying_track_->clone());
	periods_ = original.periods_;
	active_period_ = periods_.begin();
}

Track *PCMPatchedTrack::clone() {
	return new PCMPatchedTrack(*this);
}

void PCMPatchedTrack::add_segment(const Time &start_time, const PCMSegment &segment, bool clamp_to_index_hole) {
	std::shared_ptr<PCMSegmentEventSource> event_source(new PCMSegmentEventSource(segment));

	Time zero(0);
	Time one(1);
	Time end_time = start_time + event_source->get_length();
	if(clamp_to_index_hole && end_time > one) {
		end_time = one;
	}
	Period insertion_period(start_time, end_time, zero, event_source);

	// the new segment may wrap around, so divide it up into track-length parts if required
	assert(insertion_period.start_time <= one);
	while(insertion_period.end_time > one) {
		Time next_end_time = insertion_period.end_time - one;
		insertion_period.end_time = one;
		insert_period(insertion_period);

		insertion_period.segment_start_time += one;
		insertion_period.start_time = zero;
		insertion_period.end_time = next_end_time;
	}
	insert_period(insertion_period);

	// the vector may have been resized, potentially invalidating active_period_ even if
	// the thing it pointed to is still the same thing. So work it out afresh.
	insertion_error_ = current_time_ - seek_to(current_time_);
}

void PCMPatchedTrack::insert_period(const Period &period) {
	// find the existing period that the new period starts in
	std::vector<Period>::iterator start_period = periods_.begin();
	while(start_period->end_time <= period.start_time) start_period++;

	// find the existing period that the new period end in
	std::vector<Period>::iterator end_period = start_period;
	while(end_period->end_time < period.end_time) end_period++;

	// perform a division if called for
	if(start_period == end_period) {
		if(start_period->start_time == period.start_time) {
			if(start_period->end_time == period.end_time) {
				// period has the same start and end time as start_period. So just replace it.
				*start_period = period;
			} else {
				// period has the same start time as start_period but a different end time.
				// So trim the left-hand side of start_period and insert the new period in front.
				start_period->push_start_to_time(period.end_time);
				periods_.insert(start_period, period);
			}
		} else {
			if(start_period->end_time == period.end_time) {
				// period has the same end time as start_period but a different start time.
				// So trim the right-hand side of start_period and insert the new period afterwards
				start_period->trim_end_to_time(period.start_time);
				periods_.insert(start_period + 1, period);
			} else {
				// start_period has an earlier start and a later end than period. So copy it,
				// trim the right off the original and the left off the copy, then insert the
				// new period and the copy after start_period
				Period right_period = *start_period;

				right_period.push_start_to_time(period.end_time);
				start_period->trim_end_to_time(period.start_time);

				// the iterator isn't guaranteed to survive the insert, e.g. if it causes a resize
				std::vector<Period>::difference_type offset = start_period - periods_.begin();
				periods_.insert(start_period + 1, period);
				periods_.insert(periods_.begin() + offset + 2, right_period);
			}
		}
	} else {
		bool should_insert = false;
		std::vector<Period>::difference_type insertion_offset = 0;

		if(start_period->start_time == period.start_time) {
			// start_period starts at the same place as period. Period then
			// ends after start_period. So replace.
			*start_period = period;
			should_insert = false;
		} else {
			// start_period starts before period. So trim and plan to insert afterwards.
			start_period->trim_end_to_time(period.start_time);
			should_insert = true;
			insertion_offset = start_period + 1 - periods_.begin();
		}

		if(end_period->end_time == period.end_time) {
			// end_period ends exactly when period does. So include it from the list to delete
			end_period++;
		} else {
			end_period->push_start_to_time(period.end_time);
		}

		// remove everything that is exiting in between
		periods_.erase(start_period + 1, end_period);

		// insert the new period if required
		if(should_insert)
			periods_.insert(periods_.begin()+insertion_offset, period);
	}
}

Track::Event PCMPatchedTrack::get_next_event() {
	const Time one(1);
	const Time zero(0);
	Time extra_time(0);
	Time period_error(0);

	while(1) {
		// get the next event from the current active period
		Track::Event event;
		if(active_period_->event_source) event = active_period_->event_source->get_next_event();
		else event = underlying_track_->get_next_event();

		// see what time that gets us to. If it's still within the current period, return the found event
		Time event_time = current_time_ + event.length - period_error - insertion_error_;
		if(event_time < active_period_->end_time) {
			current_time_ = event_time;
			// TODO: this is spelt out in three steps because times don't necessarily do the sensible
			// thing when 'negative' if intermediate result get simplified in the meantime. So fix Time.
			event.length += extra_time;
			event.length -= period_error;
			event.length -= insertion_error_;
			return event;
		}
		insertion_error_.set_zero();

		// otherwise move time back to the end of the outgoing period, accumulating the error into
		// extra_time, and advance the extra period
		extra_time += (active_period_->end_time - current_time_);
		current_time_ = active_period_->end_time;
		active_period_++;

		// test for having reached the end of the track
		if(active_period_ == periods_.end()) {
			// if this is the end of the track then jump the active pointer back to the beginning
			// of the list of periods and reset current_time_ to zero
			active_period_ = periods_.begin();
			if(active_period_->event_source) active_period_->event_source->reset();
			else underlying_track_->seek_to(zero);
			current_time_ = zero;

			// then return an index hole that is the aggregation of accumulated extra_time away
			event.type = Storage::Disk::Track::Event::IndexHole;
			event.length = extra_time;
			return event;
		} else {
			// if this is not the end of the track then move to the next period and note how much will need
			// to be subtracted if an event is found here
			if(active_period_->event_source) period_error = active_period_->segment_start_time - active_period_->event_source->seek_to(active_period_->segment_start_time);
			else period_error = current_time_ - underlying_track_->seek_to(current_time_);
		}
	}
}

Storage::Time PCMPatchedTrack::seek_to(const Time &time_since_index_hole) {
	// start at the beginning and continue while segments end before reaching the time sought
	active_period_ = periods_.begin();
	while(active_period_->end_time < time_since_index_hole) {
		assert(active_period_ != periods_.end());
		active_period_++;
	}

	// allow whatever storage represents the period found to perform its seek; calculation for periods
	// with an event source is, in effect: seek_to(offset_into_segment + distance_into_period) - offset_into_segment.
	if(active_period_->event_source)
		current_time_ = active_period_->event_source->seek_to(active_period_->segment_start_time + time_since_index_hole - active_period_->start_time) + active_period_->start_time - active_period_->segment_start_time;
	else
		current_time_ = underlying_track_->seek_to(time_since_index_hole);

	assert(current_time_ <= time_since_index_hole);
	return current_time_;
}

PCMPatchedTrack::Period::Period(const Period &original) :
		start_time(original.start_time), end_time(original.end_time), segment_start_time(original.segment_start_time) {
	if(original.event_source) event_source.reset(new PCMSegmentEventSource(*original.event_source));
}

void PCMPatchedTrack::Period::push_start_to_time(const Storage::Time &new_start_time) {
	segment_start_time += new_start_time - start_time;
	start_time = new_start_time;
}

void PCMPatchedTrack::Period::trim_end_to_time(const Storage::Time &new_end_time) {
	end_time = new_end_time;
}