Added configurable naming scheme for screenshots

Author: Aemony

include/utility/registry.h

@@ -369,6 +369,10 @@ struct SKIF_RegistrySettings {
     SKIF_MakeRegKeyWS ( LR"(SOFTWARE\Kaldaien\Special K\Viewer\)",
                          LR"(Screenshots)" );
 
+  KeyValue <std::wstring> regKVScreenshotsPattern =
+    SKIF_MakeRegKeyWS ( LR"(SOFTWARE\Kaldaien\Special K\Viewer\)",
+                         LR"(Screenshots Pattern)" );
+
   KeyValue <std::wstring> regKVAutoUpdateVersion =
     SKIF_MakeRegKeyWS ( LR"(SOFTWARE\Kaldaien\Special K\Viewer\)",
                          LR"(Auto-Update Version)" );
@@ -470,8 +474,9 @@ struct SKIF_RegistrySettings {
   std::wstring wsUpdateChannel  = L"Website"; // Default to stable channel
   std::wstring wsIgnoreUpdate;
   std::wstring wsPathViewer;
-  std::wstring wsPathScreenshots;
   std::wstring wsPathSpecialK;
+  std::wstring wsPathScreenshots;
+  std::wstring wsScreenshotsPattern = L"<app>_<date>_<time>";
   std::wstring wsAutoUpdateVersion; // Holds the version the auto-updater is trying to install
   std::wstring wsDefaultHDRExt = L".png";
   std::wstring wsDefaultSDRExt = L".png";

src/tabs/settings.cpp

@@ -16,6 +16,7 @@
 #include <utility/gamepad.h>
 #include "../../version.h"
 #include <tabs/common_ui.h>
+#include <ImGuiNotify.hpp>
 #include <set>
 
 extern bool allowShortcutCtrlA;
@@ -100,13 +101,76 @@ SKIF_UI_Tab_DrawSettings (void)
       ImGuiCol_Text, ImGui::GetStyleColorVec4(ImGuiCol_SKIF_TextBase)
                               );
     SKIF_ImGui_Spacing      ( );
+
+    static float folderPosX = 0.0f;
+
+    ImGui::TextColored (
+      ImGui::GetStyleColorVec4(ImGuiCol_SKIF_TextCaption),
+        "Name Pattern: "
+    );
+
+    constexpr int       maxChars  = 50;
+    static char pattern[maxChars] = {};
+    static bool warnNonUnique = false;
+           bool savePattern   = false;
+
+    SK_RunOnce (strncpy_s (pattern, maxChars, SK_WideCharToUTF8 (_registry.wsScreenshotsPattern).data(), _TRUNCATE));
 
-    
+    ImGui::SameLine ( );
+    ImGui::SetCursorPosX(folderPosX);
+
+    if (ImGui::InputTextEx ("###PatternInput", "<app>_<date>_<time>", pattern, maxChars, ImVec2(250.0f * SKIF_ImGui_GlobalDPIScale, 0.0f), ImGuiInputTextFlags_EnterReturnsTrue))
+      savePattern = true;
+
+    if (! ImGui::IsItemActive ())
+    {
+      if (pattern[0] == '\0')
+        strncpy (pattern, "<app>_<date>_<time>", maxChars);
+    }
+    else if (ImGui::GetIO().KeyCtrl && ImGui::GetKeyData(ImGuiKey_S)->DownDuration == 0.0f)
+    {
+      savePattern = true;
+
+      if (pattern[0] == '\0')
+        ImGui::SetWindowFocus (NULL);
+    }
+
+    ImGui::SameLine ( );
+
+    ImGui::PushStyleColor (ImGuiCol_Text, ImGui::GetStyleColorVec4 (ImGuiCol_SKIF_Success));
+    if (ImGui::Button (ICON_FA_FLOPPY_DISK))
+      savePattern = true;
+    ImGui::PopStyleColor ();
+
+    if (savePattern)
+    {
+      savePattern = false;
+
+      if (pattern[0] == '\0')
+        strncpy (pattern, "<app>_<date>_<time>", maxChars);
+
+      StrTrimA (pattern, " \t\r\n");
+      _registry.wsScreenshotsPattern = SK_UTF8ToWideChar (pattern);
+      _registry.regKVScreenshotsPattern.putData (_registry.wsScreenshotsPattern);
+      
+      ImGui::InsertNotification ({ ImGuiToastType::Success, 1000, "Saved", ""});
+    }
+
+    if ((StrStrA (pattern, "<app>") == NULL && StrStrA (pattern, "<date>") == NULL && StrStrA (pattern, "<time>") == NULL))
+    {
+      ImGui::TextColored (ImGui::GetStyleColorVec4 (ImGuiCol_SKIF_Yellow), ICON_FA_TRIANGLE_EXCLAMATION);
+      ImGui::SameLine    ( );
+      ImGui::Text        ("Missing <app>, <date>, and <time>. Any captured shot will overwrite the existing file!");
+    }
+
+    ImGui::Spacing ();
+
     ImGui::TextColored (
       ImGui::GetStyleColorVec4(ImGuiCol_SKIF_TextCaption),
         "Screenshots Folder: "
     );
     ImGui::SameLine ( );
+    folderPosX = ImGui::GetCursorPosX();
     if (ImGui::Selectable(_path_cache.skiv_screenshotsA))
     {
       std::wstring newPath = SKIF_Util_FileExplorer_BrowseForFolder (_path_cache.skiv_screenshots);

src/utility/image.cpp

@@ -1086,43 +1086,45 @@ using namespace DirectX;
     return false;
 
   static SKIF_CommonPathsCache& _path_cache = SKIF_CommonPathsCache::GetInstance ( );
+  static SKIF_RegistrySettings& _registry   = SKIF_RegistrySettings::GetInstance ( );
 
   bool isPersistent = (capture_data._mode != CaptureMode_None);
   std::wstring wsPNGPath  = (isPersistent) ? _path_cache.skiv_screenshots : _path_cache.skiv_temp;
-  std::wstring wsFilename = capture_data._title;
-
-  wsFilename += L"_";
+  std::wstring wsFilename = _registry.wsScreenshotsPattern;
+  const std::wstring pApps = L"<app>",
+                     pDate = L"<date>",
+                     pTime = L"<time>";
 
   if (! isPersistent)
     SKIF_Util_Files_PruneToLatestN (_path_cache.skiv_temp, 10);
 
   // DateTime
   SYSTEMTIME st;
-  GetLocalTime(&st);
+  GetLocalTime (&st);
 
-  // Buffers for formatted output
-  wchar_t dateBuffer[100];
-  wchar_t timeBuffer[100];
+  if (wsFilename.find (pApps) != std::wstring::npos)
+    wsFilename.replace (wsFilename.find (pApps), pApps.length(), capture_data._title);
 
   // Get locale-aware date
-  if (GetDateFormatEx (LOCALE_NAME_USER_DEFAULT, DATE_SHORTDATE, &st, NULL, dateBuffer, 100, NULL))
-    wsFilename += std::wstring(dateBuffer);
-
-  wsFilename += L"_";
+  if (wsFilename.find (pDate) != std::wstring::npos)
+  {
+    wchar_t dateBuffer[100];
+    if (GetDateFormatEx (LOCALE_NAME_USER_DEFAULT, DATE_SHORTDATE, &st, NULL, dateBuffer, 100, NULL))
+      wsFilename.replace (wsFilename.find (pDate), pDate.length(), dateBuffer);
+  }
 
   // Get locale-aware time
-  if (GetTimeFormatEx (LOCALE_NAME_USER_DEFAULT, 0, &st, NULL, timeBuffer, 100))
-    wsFilename += std::wstring(timeBuffer);
+  if (wsFilename.find (pTime) != std::wstring::npos)
+  {
+    wchar_t timeBuffer[100];
+    if (GetTimeFormatEx (LOCALE_NAME_USER_DEFAULT, 0, &st, NULL, timeBuffer, 100))
+      wsFilename.replace (wsFilename.find (pTime), pTime.length(), timeBuffer);
+  }
 
   wsFilename = SKIF_Util_StripInvalidFilenameChars (wsFilename);
 
   wsPNGPath += wsFilename + L".png";
 
-  //PLOG_VERBOSE << wsPNGPath;
-
-  static SKIF_RegistrySettings& _registry =
-    SKIF_RegistrySettings::GetInstance ( );
-
   int snipping_tonemap_mode = _registry._SnippingTonemapsHDR;
 
   if (_registry._SnippingTonemapsHDR == 2)

src/utility/registry.cpp

@@ -387,6 +387,9 @@ SKIF_RegistrySettings::SKIF_RegistrySettings (void)
   if (regKVPathScreenshots.hasData(&hKey))
     wsPathScreenshots      =   regKVPathScreenshots        .getData (&hKey);
 
+  if (regKVScreenshotsPattern.hasData(&hKey))
+    wsScreenshotsPattern   =   regKVScreenshotsPattern     .getData (&hKey);
+
   if (regKVAutoUpdateVersion.hasData(&hKey))
     wsAutoUpdateVersion    =   regKVAutoUpdateVersion      .getData (&hKey);