Lua api for Snapshot and demo script

4 files changed, 65 insertions, 19 deletions

diff --git a/indra/newview/llviewerwindow.cpp b/indra/newview/llviewerwindow.cpp
index b637bcbdac..9f60f71d28 100644
--- a/indra/newview/llviewerwindow.cpp
+++ b/indra/newview/llviewerwindow.cpp
@@ -4840,7 +4840,7 @@ BOOL LLViewerWindow::saveSnapshot(const std::string& filepath, S32 image_width,
     LL_INFOS() << "Saving snapshot to: " << filepath << LL_ENDL;
 
     LLPointer<LLImageRaw> raw = new LLImageRaw;
-    BOOL success = rawSnapshot(raw, image_width, image_height, TRUE, FALSE, show_ui, show_hud, do_rebuild);
+    BOOL success = rawSnapshot(raw, image_width, image_height, TRUE, FALSE, show_ui, show_hud, do_rebuild, 0, type);
 
     if (success)
     {
diff --git a/indra/newview/llviewerwindowlistener.cpp b/indra/newview/llviewerwindowlistener.cpp
index da7e18af5c..cba4fbc391 100644
--- a/indra/newview/llviewerwindowlistener.cpp
+++ b/indra/newview/llviewerwindowlistener.cpp
@@ -43,22 +43,13 @@ LLViewerWindowListener::LLViewerWindowListener(LLViewerWindow* llviewerwindow):
     mViewerWindow(llviewerwindow)
 {
     // add() every method we want to be able to invoke via this event API.
-    LLSD saveSnapshotArgs;
-    saveSnapshotArgs["filename"] = LLSD::String();
-    saveSnapshotArgs["reply"] = LLSD::String();
-    // The following are optional, so don't build them into required prototype.
-//  saveSnapshotArgs["width"] = LLSD::Integer();
-//  saveSnapshotArgs["height"] = LLSD::Integer();
-//  saveSnapshotArgs["showui"] = LLSD::Boolean();
-//  saveSnapshotArgs["showhud"] = LLSD::Boolean();
-//  saveSnapshotArgs["rebuild"] = LLSD::Boolean();
-//  saveSnapshotArgs["type"] = LLSD::String();
     add("saveSnapshot",
-        "Save screenshot: [\"filename\"], [\"width\"], [\"height\"], [\"showui\"], [\"showhud\"], [\"rebuild\"], [\"type\"]\n"
+        "Save screenshot: [\"filename\"] (extension may be specified: bmp, jpeg, png)\n"
+        "[\"width\"], [\"height\"], [\"showui\"], [\"showhud\"], [\"rebuild\"], [\"type\"]\n"
         "type: \"COLOR\", \"DEPTH\"\n"
         "Post on [\"reply\"] an event containing [\"ok\"]",
         &LLViewerWindowListener::saveSnapshot,
-        saveSnapshotArgs);
+        llsd::map("filename", LLSD(), "reply", LLSD()));
     add("requestReshape",
         "Resize the window: [\"w\"], [\"h\"]",
         &LLViewerWindowListener::requestReshape);
@@ -66,12 +57,15 @@ LLViewerWindowListener::LLViewerWindowListener(LLViewerWindow* llviewerwindow):
 
 void LLViewerWindowListener::saveSnapshot(const LLSD& event) const
 {
+    Response response(LLSD(), event);
+
     typedef std::map<LLSD::String, LLSnapshotModel::ESnapshotLayerType> TypeMap;
     TypeMap types;
 #define tp(name) types[#name] = LLSnapshotModel::SNAPSHOT_TYPE_##name
     tp(COLOR);
     tp(DEPTH);
-#undef  tp
+#undef tp
+
     // Our add() call should ensure that the incoming LLSD does in fact
     // contain our required arguments. Deal with the optional ones.
     S32 width (mViewerWindow->getWindowWidthRaw());
@@ -94,14 +88,36 @@ void LLViewerWindowListener::saveSnapshot(const LLSD& event) const
         TypeMap::const_iterator found = types.find(event["type"]);
         if (found == types.end())
         {
-            LL_ERRS("LLViewerWindowListener") << "LLViewerWindowListener::saveSnapshot(): "
-                                              << "unrecognized type " << event["type"] << LL_ENDL;
-        return;
+            return response.error(stringize("Unrecognized type ", std::quoted(event["type"].asString()), " [\"COLOR\"] or [\"DEPTH\"] is expected."));
         }
         type = found->second;
     }
-    bool ok = mViewerWindow->saveSnapshot(event["filename"], width, height, showui, showhud, rebuild, type);
-    sendReply(LLSDMap("ok", ok), event);
+
+    std::string filename(event["filename"]);
+    if (filename.empty())
+    {
+        return response.error(stringize("File path is empty."));
+    }
+
+    LLSnapshotModel::ESnapshotFormat format(LLSnapshotModel::SNAPSHOT_FORMAT_BMP);
+    std::string ext = gDirUtilp->getExtension(filename);
+    if (ext.empty())
+    {
+        filename.append(".bmp");
+    }
+    else if (ext == "png")
+    {
+        format = LLSnapshotModel::SNAPSHOT_FORMAT_PNG;
+    }
+    else if (ext == "jpeg" || ext == "jpg")
+    {
+        format = LLSnapshotModel::SNAPSHOT_FORMAT_JPEG;
+    }
+    else if (ext != "bmp")
+    {
+        return response.error(stringize("Unrecognized format. [\"png\"], [\"jpeg\"] or [\"bmp\"] is expected."));
+    }
+    response["result"] = mViewerWindow->saveSnapshot(filename, width, height, showui, showhud, rebuild, type, format);
 }
 
 void LLViewerWindowListener::requestReshape(LLSD const & event_data) const
diff --git a/indra/newview/scripts/lua/require/UI.lua b/indra/newview/scripts/lua/require/UI.lua
index eb1a4017c7..8fcc446e09 100644
--- a/indra/newview/scripts/lua/require/UI.lua
+++ b/indra/newview/scripts/lua/require/UI.lua
@@ -122,4 +122,19 @@ function UI.type(...)
     end
 end
 
+-- ***************************************************************************
+--  Snapshot
+-- ***************************************************************************
+-- UI.snapshot{filename=filename            -- extension may be specified: bmp, jpeg, png
+--          [, type='COLOR' | 'DEPTH']
+--          [, width=width][, height=height]  -- uses current window size if not specified
+--          [, showui=true][, showhud=true]
+--          [, rebuild=false]}
+function UI.snapshot(...)
+    local args = mapargs('filename,width,height,showui,showhud,rebuild,type', ...)
+    leap.request('LLViewerWindow', {op='saveSnapshot', filename = args.filename,
+                                    width=args.width, height=args.height,
+                                    showui=args.showui, showhud=args.showhud,
+                                    rebuild=args.rebuild, type=args.type})
+end
 return UI
diff --git a/indra/newview/scripts/lua/test_snapshot.lua b/indra/newview/scripts/lua/test_snapshot.lua
new file mode 100644
index 0000000000..d7c878833b
--- /dev/null
+++ b/indra/newview/scripts/lua/test_snapshot.lua
@@ -0,0 +1,15 @@
+local UI = require 'UI'
+
+PATH = 'E:\\'
+-- 'png', 'jpeg' or 'bmp'
+EXT = '.png'
+
+NAME_SIMPLE = 'Snapshot_simple' .. '_' .. os.date("%Y-%m-%d_%H-%M-%S")
+UI.snapshot(PATH .. NAME_SIMPLE .. EXT)
+
+NAME_ARGS = 'Snapshot_args' .. '_' .. os.date("%Y-%m-%d_%H-%M-%S")
+
+-- 'COLOR' or 'DEPTH'
+TYPE = 'COLOR'
+UI.snapshot{PATH .. NAME_ARGS .. EXT, width = 700, height = 400,
+            type = TYPE, showui = false, showhud = false}