Recorder: improve direct export robustness.

Detect if requested output format is supported and sanitize the output path.
kosua20 · Dec 12, 2020 · 6ef0b65 · 6ef0b65
1 parent 9515054
commit 6ef0b65
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 7 deletions.
diff --git a/src/helpers/Recorder.cpp b/src/helpers/Recorder.cpp
@@ -259,12 +259,29 @@ void Recorder::setSize(const glm::ivec2 & size){
 	_size[1] += _size[1]%2;
 }
 
-void Recorder::setParameters(const std::string & path, Format format, int framerate, int bitrate, bool skipBackground){
+bool Recorder::setParameters(const std::string & path, Format format, int framerate, int bitrate, bool skipBackground){
+	// Check if the format is supported.
+	if(int(format) >= _formats.size()){
+		std::cerr << "[EXPORT]: The requested output format is not supported by this executable. If this is a video format, make sure MIDIVisualizer has been compiled with ffmpeg enabled by checking the output of ./MIDIVisualizer --version" << std::endl;
+		return false;
+	}
+
 	_exportPath = path;
 	_outFormat = format;
 	_exportFramerate = framerate;
 	_bitRate = bitrate;
 	_exportNoBackground = skipBackground;
+
+	if(_outFormat != Format::PNG){
+		// Check that the export path is valid.
+		const std::string & ext = _formats.at(int(_outFormat)).ext;
+		const std::string fullExt = "." + ext;
+		// Append extension if needed.
+		if(_exportPath.size() < 5 || (_exportPath.substr(_exportPath.size()-4) != fullExt)){
+			_exportPath.append(fullExt);
+		}
+	}
+	return true;
 }
 
 bool Recorder::videoExportSupported(){

diff --git a/src/helpers/Recorder.h b/src/helpers/Recorder.h
@@ -52,7 +52,8 @@ class Recorder {
 
 	void setSize(const glm::ivec2 & size);
 
-	void setParameters(const std::string & path, Format format, int framerate, int bitrate, bool skipBackground);
+	bool setParameters(const std::string & path, Format format, int framerate, int bitrate, bool skipBackground);
+
 	static bool videoExportSupported();
 
 private:

diff --git a/src/main.cpp b/src/main.cpp
@@ -288,7 +288,11 @@ int main( int argc, char** argv) {
 					format = Recorder::Format::MPEG4;
 				}
 			}
-			renderer.startDirectRecording(exportPath, format, framerate, bitrate, pngAlpha, glm::vec2(isw, ish));
+			const bool success = renderer.startDirectRecording(exportPath, format, framerate, bitrate, pngAlpha, glm::vec2(isw, ish));
+			if(!success){
+				// Quit.
+				performAction(SystemAction::QUIT, window, frame);
+			}
 		}
 
 		if(fullscreen){

diff --git a/src/rendering/Renderer.cpp b/src/rendering/Renderer.cpp
@@ -1222,11 +1222,16 @@ void  Renderer::setGUIScale(float scale){
 	ImGui::GetStyle().FrameRounding = 3 * _guiScale;
 }
 
-void Renderer::startDirectRecording(const std::string & path, Recorder::Format format, int framerate, int bitrate, bool skipBackground, const glm::vec2 & size){
-	_recorder.setParameters(path, format, framerate, bitrate, skipBackground);
+bool Renderer::startDirectRecording(const std::string & path, Recorder::Format format, int framerate, int bitrate, bool skipBackground, const glm::vec2 & size){
+	const bool success = _recorder.setParameters(path, format, framerate, bitrate, skipBackground);
+	if(!success){
+		std::cerr << "[EXPORT]: Unable to start direct export." << std::endl;
+		return false;
+	}
 	_recorder.setSize(size);
 	startRecording();
 	_exitAfterRecording = true;
+	return true;
 }
 
 void Renderer::startRecording(){

diff --git a/src/rendering/Renderer.h b/src/rendering/Renderer.h
@@ -59,8 +59,8 @@ class Renderer {
 	/// Handle keyboard inputs
 	void keyPressed(int key, int action);
 
-	/// Diretly start recording.
-	void startDirectRecording(const std::string & path, Recorder::Format format, int framerate, int bitrate, bool skipBackground, const glm::vec2 & size);
+	/// Directly start recording.
+	bool startDirectRecording(const std::string & path, Recorder::Format format, int framerate, int bitrate, bool skipBackground, const glm::vec2 & size);
 
 	void setGUIScale(float scale);