Merge pull request #9008 from The-OpenROAD-Project-staging/gui-multi-gif

gui: allow more than one animated gif to be generated at a time

Author: maliberty

src/gpl/src/graphicsImpl.cpp

@@ -856,15 +856,16 @@ void GraphicsImpl::saveLabeledImageImpl(std::string_view path,
 
 void GraphicsImpl::gifStart(std::string_view path)
 {
-  gui::Gui::get()->gifStart(std::string(path));
+  gif_key_ = gui::Gui::get()->gifStart(std::string(path));
 }
 
 void GraphicsImpl::gifAddFrameImpl(const odb::Rect& region,
                                    int width_px,
                                    double dbu_per_pixel,
                                    std::optional<int> delay)
 {
-  gui::Gui::get()->gifAddFrame(region, width_px, dbu_per_pixel, delay);
+  gui::Gui::get()->gifAddFrame(
+      gif_key_, region, width_px, dbu_per_pixel, delay);
 }
 
 void GraphicsImpl::deleteLabel(std::string_view label_name)
@@ -874,7 +875,7 @@ void GraphicsImpl::deleteLabel(std::string_view label_name)
 
 void GraphicsImpl::gifEnd()
 {
-  gui::Gui::get()->gifEnd();
+  gui::Gui::get()->gifEnd(gif_key_);
 }
 
 }  // namespace gpl

src/gpl/src/graphicsImpl.h

@@ -173,7 +173,8 @@ class GraphicsImpl : public gpl::AbstractGraphics,
   gui::Chart* density_chart_{nullptr};
   gui::Chart* phi_chart_{nullptr};
   gui::Chart* stepLength_chart_{nullptr};
-  bool debug_on_ = false;
+  bool debug_on_{false};
+  int gif_key_{0};
 
   void initHeatmap();
   void drawNesterov(gui::Painter& painter);

src/gui/README.md

@@ -165,13 +165,19 @@ save_histogram_image
 
 This command can be used to generate an animated gif.
 
+When used with -start this command returns an integer key that can be
+used to distinguish files if multiple are generated.  That key can be
+provided when using -add or -end.  If only a single file is being used
+the key can be ignored.
+
 ```tcl
 save_animated_gif
     -start|-add|-end
     [-resolution microns_per_pixel]
     [-area {x0 y0 x1 y1}]
     [-width width]
     [-delay delay]
+    [-key key]
     [filename]
 ```
 
@@ -187,6 +193,7 @@ save_animated_gif
 | `-resolution`| resolution in microns per pixel to use when saving the image, default will match what the GUI has selected.|
 | `-width`| width of the output image in pixels, default will be computed from the resolution. Cannot be used with ``-resolution``.|
 | `-delay`| delay between frames in the GIF.|
+| `-key`| used to distinguish multiple GIF files (returned by -add).|
 
 ### Select Objects
 

src/gui/include/gui/gui.h

@@ -824,12 +824,15 @@ class Gui
   const Selected& getInspectorSelection();
 
   // GIF API
-  void gifStart(const std::string& filename);
-  void gifAddFrame(const odb::Rect& region = odb::Rect(),
+  // Start returns the key for use by add and end.  This allows multiple
+  // gifs to be open at once.
+  int gifStart(const std::string& filename);
+  void gifAddFrame(int key,
+                   const odb::Rect& region = odb::Rect(),
                    int width_px = 0,
                    double dbu_per_pixel = 0,
                    std::optional<int> delay = {});
-  void gifEnd();
+  void gifEnd(int key);
 
   void setHeatMapSetting(const std::string& name,
                          const std::string& option,
@@ -947,7 +950,7 @@ class Gui
   std::unique_ptr<PlacementDensityDataSource> placement_density_heat_map_;
   std::unique_ptr<PowerDensityDataSource> power_density_heat_map_;
 
-  std::unique_ptr<GIF> gif_;
+  std::vector<std::unique_ptr<GIF>> gifs_;
   static constexpr int kDefaultGifDelay = 250;
 
   std::string main_window_title_ = "OpenROAD";

src/gui/src/gui.cpp

@@ -1445,7 +1445,7 @@ bool Gui::TypeInfoComparator::operator()(const std::type_index& a,
 #endif
 }
 
-void Gui::gifStart(const std::string& filename)
+int Gui::gifStart(const std::string& filename)
 {
   if (!enabled()) {
     logger_->error(utl::GUI, 49, "Cannot generate GIF without GUI enabled");
@@ -1455,24 +1455,29 @@ void Gui::gifStart(const std::string& filename)
     logger_->error(utl::GUI, 81, "Filename is required to save a GIF.");
   }
 
-  gif_ = std::make_unique<GIF>();
-  gif_->filename = filename;
-  gif_->writer = nullptr;
+  auto gif = std::make_unique<GIF>();
+  gif->filename = filename;
+  gifs_.emplace_back(std::move(gif));
+  return gifs_.size() - 1;
 }
 
-void Gui::gifAddFrame(const odb::Rect& region,
+void Gui::gifAddFrame(const int key,
+                      const odb::Rect& region,
                       int width_px,
                       double dbu_per_pixel,
                       std::optional<int> delay)
 {
-  if (gif_ == nullptr) {
+  if (key >= gifs_.size() || gifs_[key] == nullptr) {
     logger_->warn(utl::GUI, 51, "GIF not active");
     return;
   }
 
   if (db_ == nullptr) {
     logger_->error(utl::GUI, 50, "No design loaded.");
   }
+
+  auto& gif = gifs_[key];
+
   odb::Rect save_region = region;
   const bool use_die_area = region.dx() == 0 || region.dy() == 0;
   const bool is_offscreen
@@ -1504,64 +1509,65 @@ void Gui::gifAddFrame(const odb::Rect& region,
   QImage img = main_window->getLayoutViewer()->createImage(
       save_region, width_px, dbu_per_pixel);
 
-  if (gif_->writer == nullptr) {
-    gif_->writer = std::make_unique<GifWriter>();
-    gif_->width = img.width();
-    gif_->height = img.height();
-    GifBegin(gif_->writer.get(),
-             gif_->filename.c_str(),
-             gif_->width,
-             gif_->height,
+  if (gif->writer == nullptr) {
+    gif->writer = std::make_unique<GifWriter>();
+    gif->width = img.width();
+    gif->height = img.height();
+    GifBegin(gif->writer.get(),
+             gif->filename.c_str(),
+             gif->width,
+             gif->height,
              delay.value_or(kDefaultGifDelay));
   } else {
     // scale IMG if not matched
-    img = img.scaled(gif_->width, gif_->height, Qt::KeepAspectRatio);
+    img = img.scaled(gif->width, gif->height, Qt::KeepAspectRatio);
   }
 
-  std::vector<uint8_t> frame(gif_->width * gif_->height * 4, 0);
+  std::vector<uint8_t> frame(gif->width * gif->height * 4, 0);
   for (int x = 0; x < img.width(); x++) {
-    if (x >= gif_->width) {
+    if (x >= gif->width) {
       continue;
     }
     for (int y = 0; y < img.height(); y++) {
-      if (y >= gif_->height) {
+      if (y >= gif->height) {
         continue;
       }
 
       const QRgb pixel = img.pixel(x, y);
-      const int frame_offset = (y * gif_->width + x) * 4;
+      const int frame_offset = (y * gif->width + x) * 4;
       frame[frame_offset + 0] = qRed(pixel);
       frame[frame_offset + 1] = qGreen(pixel);
       frame[frame_offset + 2] = qBlue(pixel);
       frame[frame_offset + 3] = qAlpha(pixel);
     }
   }
 
-  GifWriteFrame(gif_->writer.get(),
+  GifWriteFrame(gif->writer.get(),
                 frame.data(),
-                gif_->width,
-                gif_->height,
+                gif->width,
+                gif->height,
                 delay.value_or(kDefaultGifDelay));
 }
 
-void Gui::gifEnd()
+void Gui::gifEnd(const int key)
 {
-  if (gif_ == nullptr) {
+  if (key >= gifs_.size() || gifs_[key] == nullptr) {
     logger_->warn(utl::GUI, 58, "GIF not active");
     return;
   }
 
-  if (gif_->writer == nullptr) {
+  auto& gif = gifs_[key];
+  if (gif->writer == nullptr) {
     logger_->warn(utl::GUI,
                   107,
                   "Nothing to save to {}. No frames added to gif.",
-                  gif_->filename);
-    gif_ = nullptr;
+                  gif->filename);
+    gif = nullptr;
     return;
   }
 
-  GifEnd(gif_->writer.get());
-  gif_ = nullptr;
+  GifEnd(gif->writer.get());
+  gifs_[key] = nullptr;
 }
 
 class SafeApplication : public QApplication

src/gui/src/gui.i

@@ -817,16 +817,16 @@ void set_title(std::string title)
   gui->setMainWindowTitle(title);
 }
 
-void gif_start(const char* filename)
+int gif_start(const char* filename)
 {
   if (!check_gui("gif_start")) {
-    return;
+    return 0;
   }
   auto gui = gui::Gui::get();
-  gui->gifStart(filename);
+  return gui->gifStart(filename);
 }
 
-void gif_add(double xlo, double ylo, double xhi, double yhi, int width_px = 0, double dbu_per_pixel = 0, int delay = 0)
+void gif_add(int key, double xlo, double ylo, double xhi, double yhi, int width_px = 0, double dbu_per_pixel = 0, int delay = 0)
 {
   if (!check_gui("gif_add")) {
     return;
@@ -836,16 +836,16 @@ void gif_add(double xlo, double ylo, double xhi, double yhi, int width_px = 0, d
   if (delay > 0) {
     delay_pass = delay;
   }
-  gui->gifAddFrame(make_rect(xlo, ylo, xhi, yhi), width_px, dbu_per_pixel, delay_pass);
+  gui->gifAddFrame(key, make_rect(xlo, ylo, xhi, yhi), width_px, dbu_per_pixel, delay_pass);
 }
 
-void gif_end()
+void gif_end(int key)
 {
   if (!check_gui("gif_end")) {
     return;
   }
   auto gui = gui::Gui::get();
-  gui->gifEnd();
+  gui->gifEnd(key);
 }
 
 %} // inline

src/gui/src/gui.tcl

@@ -142,12 +142,13 @@ sta::define_cmd_args "save_animated_gif" {-start|-add|-end \
                                           [-width width] \
                                           [-resolution microns_per_pixel] \
                                           [-delay delay] \
+                                          [-key key] \
                                           [path]
 }
 
 proc save_animated_gif { args } {
   sta::parse_key_args "save_animated_gif" args \
-    keys {-area -width -resolution -delay} flags {-start -end -add}
+    keys {-area -width -resolution -delay -key} flags {-start -end -add}
 
   set resolution 0
   if { [info exists keys(-resolution)] } {
@@ -189,19 +190,24 @@ proc save_animated_gif { args } {
     set delay $keys(-delay)
   }
 
+  set key 0
+  if { [info exists keys(-key)] } {
+    set key $keys(-key)
+  }
+
   if { [info exists flags(-start)] } {
     sta::check_argc_eq1 "save_animated_gif" $args
     set path [lindex $args 0]
 
-    gui::gif_start $path
+    return [gui::gif_start $path]
   } elseif { [info exists flags(-add)] } {
     sta::check_argc_eq0 "save_animated_gif" $args
 
-    gui::gif_add {*}$area $width $resolution $delay
+    gui::gif_add $key {*}$area $width $resolution $delay
   } elseif { [info exists flags(-end)] } {
     sta::check_argc_eq0 "save_animated_gif" $args
 
-    gui::gif_end
+    gui::gif_end $key
   } else {
     utl::error GUI 106 "-start, -end, or -add is required"
   }

src/gui/src/stub.cpp

@@ -204,15 +204,17 @@ void initGui(Tcl_Interp* interp,
   Tcl_Eval(interp, enabled_supported.c_str());
 }
 
-void Gui::gifStart(const std::string& filename)
+int Gui::gifStart(const std::string& filename)
 {
+  return 0;
 }
 
-void Gui::gifEnd()
+void Gui::gifEnd(const int key)
 {
 }
 
-void Gui::gifAddFrame(const odb::Rect& region,
+void Gui::gifAddFrame(const int key,
+                      const odb::Rect& region,
                       int width_px,
                       double dbu_per_pixel,
                       std::optional<int> delay)