Add video name setting (CLI and Lua) (#109)

Author: Jerboa-app

include/commandLine.h

@@ -315,6 +315,7 @@ struct CommandLine
         extractArgument(script, arguments);
         extractArgument(globalAtomAlpha, arguments);
         extractArgument(globalBondAlpha, arguments);
+        extractArgument(videoName, arguments);
 
         #ifdef WITH_FFMPEG
         extractArgument(cq, arguments);
@@ -345,6 +346,7 @@ struct CommandLine
     Argument<float> bondClipCorrection = {"bondClipCorrection", "Correction for bond impostors.", "Increase if atoms clipped.", 5.0f};
     Argument<std::filesystem::path> colourmap = {"colourmap", "The colourmap path.", "", {}};
     Argument<std::filesystem::path> atomColours = {"atomColours", "Path for per-atom colour overrides.", "", {}};
+    Argument<std::string> videoName = {"videoName", "Name of saved video.", "", ""};
     Argument<vec<2>> resolution = {"resolution", "Window resolution in pixels.", "", {512, 512}};
     Argument<uint64_t> bondFocus = {"bondFocus", "Only draw bonds for this atom.", "", NULL_INDEX};
     Argument<uint64_t> focus = {"focus", "Centre on a particular atom.", "", NULL_INDEX};
@@ -462,8 +464,10 @@ struct CommandLine
         std::string * sval = stringFromName(s.characters);
         if (sval != nullptr)
         {
+            std::cout << "yes\n";
             if (lua_isstring(lua, 2))
             {
+                std::cout << "yes2\n";
                 LuaString v; v.read(lua, 2);
                 *sval = v.characters;
                 return 0;
@@ -619,6 +623,8 @@ struct CommandLine
           << "\n"
           << sidebyside(argumentHelp(levelOfDetail), argumentHelp(hideInfoText), 42)
           << "\n"
+          << argumentHelp(videoName)
+          << "\n"
           #ifdef WITH_FFMPEG
           << "\n FFMPEG recording options:\n\n"
           << "   See here for advice https://trac.ffmpeg.org/wiki/Encode/H.264\n\n"
@@ -1013,16 +1019,17 @@ END OF TERMS AND CONDITIONS)";
         {
             {preset.name, preset},
             {codec.name, codec},
-            {profile.name, profile}
+            {profile.name, profile},
+            {videoName.name, videoName}
         };
         if (values.find(name) != values.cend())
         {
             return &values.at(name).value;
         }
-        return nullptr;
         #else
-        return nullptr;
+        if (name == videoName.name) { return &videoName.value; }
         #endif
+        return nullptr;
     }
 };
 

include/visualisationState.h

@@ -148,7 +148,8 @@ struct VisualisationState
     {
         if (!recording)
         {
-            std::string name = timeStamp()+std::string(".mp4");
+            std::string name = options.videoName.value;
+            if (name == "") {  name = timeStamp()+std::string(".mp4"); }
             #ifdef WITH_FFMPEG
             record = std::make_unique<FFmpegRecord>
             (

tests/generate_lua_options_interop_tests.py

@@ -52,12 +52,21 @@
         test = test.replace(k, v)
     tests += test+"\n"
 
+for (option, default) in [("videoName", "\"\"")]:
+    test = generate_test
+    for (k, v) in [("meshes", option), ("DEFAULT", str(default)),
+                   ("SET", "\\\"TEST\\\""), ("TYPE", "LuaString"),
+                   ("MEMBER", "characters"),
+                   ("CONDITION", "REQUIRE(\"TEST\" == console.getGlobal<LuaString>(\"v\").characters);")]:
+        test = test.replace(k, v)
+    tests += test+"\n"
+
 tests += "        #ifdef WITH_FFMPEG\n"
 for (option, default) in [("preset", "slow"), ("codec", "libx264"),
                           ("profile", "main")]:
     test = generate_test
     for (k, v) in [("meshes", option), ("DEFAULT", str(default)),
-                   ("SET", "TEST"), ("TYPE", "LuaString"),
+                   ("SET", "\\\"TEST\\\""), ("TYPE", "LuaString"),
                    ("MEMBER", "characters"),
                    ("CONDITION", "REQUIRE(\"TEST\" == console.getGlobal<LuaString>(\"v\").characters);")]:
         test = test.replace(k, v)

tests/test_console/test_console.cpp

@@ -759,6 +759,23 @@ SCENARIO("Lua options interop")
             }
         }
 
+        WHEN("The script \"v = sfoav.getOption(\"videoName\");\"")
+        {
+            console.runString("v = sfoav.getOption(\"videoName\");");
+            THEN("v is """)
+            {
+                REQUIRE(console.getGlobal<LuaString>("v").characters == "");
+            }
+            WHEN("The script \"sfoav.setOption(\"videoName\", \"TEST\"); v = sfoav.getOption(\"videoName\");\"")
+            {
+                console.runString("sfoav.setOption(\"videoName\", \"TEST\"); v = sfoav.getOption(\"videoName\");");
+                THEN("v is \"TEST\"")
+                {
+                    REQUIRE("TEST" == console.getGlobal<LuaString>("v").characters);
+                }
+            }
+        }
+
         #ifdef WITH_FFMPEG
         WHEN("The script \"v = sfoav.getOption(\"preset\");\"")
         {
@@ -767,10 +784,10 @@ SCENARIO("Lua options interop")
             {
                 REQUIRE(console.getGlobal<LuaString>("v").characters == slow);
             }
-            WHEN("The script \"sfoav.setOption(\"preset\", TEST); v = sfoav.getOption(\"preset\");\"")
+            WHEN("The script \"sfoav.setOption(\"preset\", \"TEST\"); v = sfoav.getOption(\"preset\");\"")
             {
-                console.runString("sfoav.setOption(\"preset\", TEST); v = sfoav.getOption(\"preset\");");
-                THEN("v is TEST")
+                console.runString("sfoav.setOption(\"preset\", \"TEST\"); v = sfoav.getOption(\"preset\");");
+                THEN("v is \"TEST\"")
                 {
                     REQUIRE("TEST" == console.getGlobal<LuaString>("v").characters);
                 }
@@ -783,10 +800,10 @@ SCENARIO("Lua options interop")
             {
                 REQUIRE(console.getGlobal<LuaString>("v").characters == libx264);
             }
-            WHEN("The script \"sfoav.setOption(\"codec\", TEST); v = sfoav.getOption(\"codec\");\"")
+            WHEN("The script \"sfoav.setOption(\"codec\", \"TEST\"); v = sfoav.getOption(\"codec\");\"")
             {
-                console.runString("sfoav.setOption(\"codec\", TEST); v = sfoav.getOption(\"codec\");");
-                THEN("v is TEST")
+                console.runString("sfoav.setOption(\"codec\", \"TEST\"); v = sfoav.getOption(\"codec\");");
+                THEN("v is \"TEST\"")
                 {
                     REQUIRE("TEST" == console.getGlobal<LuaString>("v").characters);
                 }
@@ -799,10 +816,10 @@ SCENARIO("Lua options interop")
             {
                 REQUIRE(console.getGlobal<LuaString>("v").characters == main);
             }
-            WHEN("The script \"sfoav.setOption(\"profile\", TEST); v = sfoav.getOption(\"profile\");\"")
+            WHEN("The script \"sfoav.setOption(\"profile\", \"TEST\"); v = sfoav.getOption(\"profile\");\"")
             {
-                console.runString("sfoav.setOption(\"profile\", TEST); v = sfoav.getOption(\"profile\");");
-                THEN("v is TEST")
+                console.runString("sfoav.setOption(\"profile\", \"TEST\"); v = sfoav.getOption(\"profile\");");
+                THEN("v is \"TEST\"")
                 {
                     REQUIRE("TEST" == console.getGlobal<LuaString>("v").characters);
                 }