From 55290f4dad12865def778d2dd9bf05b7cdc91a8a Mon Sep 17 00:00:00 2001
From: Thomas Harte <thomas.harte@gmail.com>
Date: Mon, 14 Jan 2019 21:42:45 -0500
Subject: [PATCH] Attempts a fix of frame_was_complete_ logic, to try to
 eliminate black flashes.

---
 .../xcshareddata/xcschemes/Clock Signal.xcscheme    |  2 +-
 Outputs/OpenGL/ScanTarget.cpp                       | 13 ++++++++++---
 Outputs/OpenGL/ScanTarget.hpp                       |  3 ++-
 3 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/OSBindings/Mac/Clock Signal.xcodeproj/xcshareddata/xcschemes/Clock Signal.xcscheme b/OSBindings/Mac/Clock Signal.xcodeproj/xcshareddata/xcschemes/Clock Signal.xcscheme
index 782b17c09..f9049689f 100644
--- a/OSBindings/Mac/Clock Signal.xcodeproj/xcshareddata/xcschemes/Clock Signal.xcscheme	
+++ b/OSBindings/Mac/Clock Signal.xcodeproj/xcshareddata/xcschemes/Clock Signal.xcscheme	
@@ -68,7 +68,7 @@
       </AdditionalOptions>
    </TestAction>
    <LaunchAction
-      buildConfiguration = "Release"
+      buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       enableASanStackUseAfterReturn = "YES"
diff --git a/Outputs/OpenGL/ScanTarget.cpp b/Outputs/OpenGL/ScanTarget.cpp
index 45116ac4c..930daa9f3 100644
--- a/Outputs/OpenGL/ScanTarget.cpp
+++ b/Outputs/OpenGL/ScanTarget.cpp
@@ -202,7 +202,7 @@ void ScanTarget::submit() {
 		// Reset all pointers to where they were; this also means
 		// the stencil won't be properly populated.
 		write_pointers_ = submit_pointers_.load();
-		frame_was_complete_ = false;
+		frame_is_complete_ = false;
 	} else {
 		// Advance submit pointer.
 		submit_pointers_.store(write_pointers_);
@@ -213,8 +213,15 @@ void ScanTarget::submit() {
 
 void ScanTarget::announce(Event event, bool is_visible, const Outputs::Display::ScanTarget::Scan::EndPoint &location, uint8_t composite_amplitude) {
 	if(event == ScanTarget::Event::EndVerticalRetrace) {
+		// The previous-frame-is-complete flag is subject to a two-slot queue because
+		// measurement for *this* frame needs to begin now, meaning that the previous
+		// result needs to be put somewhere. Setting frame_is_complete_ back to true
+		// only after it has been put somewhere also doesn't work, since if the first
+		// few lines of a frame are skipped for any reason, there'll be nowhere to
+		// put it.
 		is_first_in_frame_ = true;
-		frame_was_complete_ = true;
+		previous_frame_was_complete_ = frame_is_complete_;
+		frame_is_complete_ = true;
 	}
 
 	if(output_is_visible_ == is_visible) return;
@@ -225,7 +232,7 @@ void ScanTarget::announce(Event event, bool is_visible, const Outputs::Display::
 			// Store metadata if concluding a previous line.
 			if(active_line_) {
 				line_metadata_buffer_[size_t(write_pointers_.line)].is_first_in_frame = is_first_in_frame_;
-				line_metadata_buffer_[size_t(write_pointers_.line)].previous_frame_was_complete = frame_was_complete_;
+				line_metadata_buffer_[size_t(write_pointers_.line)].previous_frame_was_complete = previous_frame_was_complete_;
 				is_first_in_frame_ = false;
 			}
 
diff --git a/Outputs/OpenGL/ScanTarget.hpp b/Outputs/OpenGL/ScanTarget.hpp
index 59ac9c2d5..6dedc7c6a 100644
--- a/Outputs/OpenGL/ScanTarget.hpp
+++ b/Outputs/OpenGL/ScanTarget.hpp
@@ -123,7 +123,8 @@ class ScanTarget: public Outputs::Display::ScanTarget {
 		Line *active_line_ = nullptr;
 		int provided_scans_ = 0;
 		bool is_first_in_frame_ = true;
-		bool frame_was_complete_ = true;
+		bool frame_is_complete_ = true;
+		bool previous_frame_was_complete_ = true;
 
 		// OpenGL storage handles for buffer data.
 		GLuint scan_buffer_name_ = 0, scan_vertex_array_ = 0;