Use indicators library for ProgressBar (#278)

jeongseok-meta · facebook-github-bot · commit c8ff7d8a434e · 2025-04-16T18:50:26.000-07:00
Summary: Pull Request resolved: #278 - Replace the ProgressBar implementation with a 3rd-party library, indicators, to support various terminals - Remove the visible option. Downstream should handle enabling and disabling the progress bar programmatically if needed. Reviewed By: yutingye, juliencbmeta Differential Revision: D73077845 fbshipit-source-id: d8c0e07f3d9cc596dc6c7cea1a2fab81b925d568
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -100,6 +100,7 @@ find_package(ezc3d CONFIG REQUIRED)
 find_package(Microsoft.GSL CONFIG REQUIRED)
 find_package(fmt CONFIG REQUIRED)
 find_package(fx-gltf CONFIG REQUIRED)
+find_package(indicators 2.3 CONFIG REQUIRED)
 find_package(nlohmann_json CONFIG REQUIRED)
 find_package(openfbx CONFIG REQUIRED)
 find_package(re2 MODULE REQUIRED)
@@ -163,6 +164,7 @@ mt_library(
   SOURCES_VARS common_sources
   PUBLIC_LINK_LIBRARIES
     fmt::fmt
+    indicators::indicators
     spdlog::spdlog
   PUBLIC_COMPILE_DEFINITIONS
     MOMENTUM_WITH_SPDLOG=1
diff --git a/cmake/momentum-config.cmake.in b/cmake/momentum-config.cmake.in
@@ -21,6 +21,7 @@ find_dependency(ezc3d CONFIG)
 find_dependency(Microsoft.GSL CONFIG)
 find_dependency(fmt CONFIG)
 find_dependency(fx-gltf CONFIG)
+find_dependency(indicators 2.3 CONFIG)
 find_dependency(nlohmann_json CONFIG)
 find_dependency(openfbx CONFIG)
 find_dependency(re2 MODULE)
diff --git a/momentum/character_sequence_solver/sequence_solver.cpp b/momentum/character_sequence_solver/sequence_solver.cpp
@@ -207,7 +207,7 @@ template <typename T>
 double SequenceSolverT<T>::processPerFrameErrors_serial(
     SequenceSolverFunctionT<T>* fn,
     OnlineBandedHouseholderQR<T>& qrSolver,
-    ProgressBar& progress) {
+    ProgressBar* progress) {
   double errorSum = 0;
   for (size_t iFrame = 0; iFrame < fn->getNumFrames(); ++iFrame) {
     auto [jacobian, residual, errorCur, nFunctions] = computePerFrameJacobian(fn, iFrame);
@@ -221,7 +221,9 @@ double SequenceSolverT<T>::processPerFrameErrors_serial(
           residual);
     }
 
-    progress.increment(nFunctions);
+    if (progress) {
+      progress->increment(nFunctions);
+    }
   }
   return errorSum;
 }
@@ -259,7 +261,7 @@ double SequenceSolverT<T>::processErrorFunctions_parallel(
         OnlineBandedHouseholderQR<T>& qrSolver)>& processJac,
     SequenceSolverFunctionT<T>* fn,
     OnlineBandedHouseholderQR<T>& qrSolver,
-    ProgressBar& progress) {
+    ProgressBar* progress) {
   const size_t end = fn->getNumFrames();
 
   // We will buffer at the end of the pipeline to ensure the universal parts of the matrices are
@@ -323,7 +325,9 @@ double SequenceSolverT<T>::processErrorFunctions_parallel(
             } else {
               qrSolver.addMutating(toProcess.jacobian, toProcess.residual);
               errorSum += toProcess.error;
-              progress.increment(toProcess.nFunctions);
+              if (progress) {
+                progress->increment(toProcess.nFunctions);
+              }
             }
           }
         }
@@ -338,7 +342,9 @@ double SequenceSolverT<T>::processErrorFunctions_parallel(
       while (!readyJacobians.empty()) {
         qrSolver.addMutating(readyJacobians.front().jacobian, readyJacobians.front().residual);
         errorSum += readyJacobians.front().error;
-        progress.increment(readyJacobians.front().nFunctions);
+        if (progress) {
+          progress->increment(readyJacobians.front().nFunctions);
+        }
         readyJacobians.pop_front();
       }
     }
@@ -348,7 +354,9 @@ double SequenceSolverT<T>::processErrorFunctions_parallel(
       while (!reorderBuffer.empty()) {
         qrSolver.addMutating(reorderBuffer.top().jacobian, reorderBuffer.top().residual);
         errorSum += reorderBuffer.top().error;
-        progress.increment(reorderBuffer.top().nFunctions);
+        if (progress) {
+          progress->increment(reorderBuffer.top().nFunctions);
+        }
         reorderBuffer.pop();
       }
     }
@@ -362,7 +370,7 @@ template <typename T>
 double SequenceSolverT<T>::processPerFrameErrors_parallel(
     SequenceSolverFunctionT<T>* fn,
     OnlineBandedHouseholderQR<T>& qrSolver,
-    ProgressBar& progress) {
+    ProgressBar* progress) {
   return processErrorFunctions_parallel(
       [](size_t iFrame,
          SequenceSolverFunctionT<T>* fn,
@@ -403,7 +411,7 @@ template <typename T>
 double SequenceSolverT<T>::processSequenceErrors_serial(
     SequenceSolverFunctionT<T>* fn,
     OnlineBandedHouseholderQR<T>& qrSolver,
-    ProgressBar& progress) {
+    ProgressBar* progress) {
   if (fn->numTotalSequenceErrorFunctions_ == 0) {
     return 0;
   }
@@ -434,7 +442,9 @@ double SequenceSolverT<T>::processSequenceErrors_serial(
           residual);
     }
 
-    progress.increment(nFunctions);
+    if (progress) {
+      progress->increment(nFunctions);
+    }
   }
   return errorSum;
 }
@@ -454,20 +464,22 @@ void SequenceSolverT<T>::doIteration() {
 
   fn->setFrameParametersFromJoinedParameterVector(this->parameters_);
 
-  ProgressBar progress(
-      "Solving sequence",
-      fn->numTotalPerFrameErrorFunctions_ + fn->numTotalSequenceErrorFunctions_,
-      progressBar_);
+  std::unique_ptr<ProgressBar> progress;
+  if (progressBar_) {
+    progress = std::make_unique<ProgressBar>(
+        "Solving sequence",
+        fn->numTotalPerFrameErrorFunctions_ + fn->numTotalSequenceErrorFunctions_);
+  }
 
   this->error_ = 0;
   if (this->multithreaded_) {
-    this->error_ += processPerFrameErrors_parallel(fn, qrSolver, progress);
+    this->error_ += processPerFrameErrors_parallel(fn, qrSolver, progress.get());
 
     // Sequence errors still have to be be processed serially, at least for now.
-    this->error_ += processSequenceErrors_serial(fn, qrSolver, progress);
+    this->error_ += processSequenceErrors_serial(fn, qrSolver, progress.get());
   } else {
-    this->error_ += processPerFrameErrors_serial(fn, qrSolver, progress);
-    this->error_ += processSequenceErrors_serial(fn, qrSolver, progress);
+    this->error_ += processPerFrameErrors_serial(fn, qrSolver, progress.get());
+    this->error_ += processSequenceErrors_serial(fn, qrSolver, progress.get());
   }
 
   // Now, extract the delta:
diff --git a/momentum/character_sequence_solver/sequence_solver.h b/momentum/character_sequence_solver/sequence_solver.h
@@ -80,16 +80,16 @@ class SequenceSolverT : public SolverT<T> {
   static double processPerFrameErrors_parallel(
       SequenceSolverFunctionT<T>* fn,
       OnlineBandedHouseholderQR<T>& qrSolver,
-      ProgressBar& progress);
+      ProgressBar* progress);
   static double processPerFrameErrors_serial(
       SequenceSolverFunctionT<T>* fn,
       OnlineBandedHouseholderQR<T>& qrSolver,
-      ProgressBar& progress);
+      ProgressBar* progress);
 
   static double processSequenceErrors_serial(
       SequenceSolverFunctionT<T>* fn,
       OnlineBandedHouseholderQR<T>& qrSolver,
-      ProgressBar& progress);
+      ProgressBar* progress);
 
   struct UniversalJacobianResid {
     size_t frameIndex = SIZE_MAX;
@@ -116,7 +116,7 @@ class SequenceSolverT : public SolverT<T> {
           OnlineBandedHouseholderQR<T>&)>& processJac,
       SequenceSolverFunctionT<T>* fn,
       OnlineBandedHouseholderQR<T>& qrSolver,
-      ProgressBar& progress);
+      ProgressBar* progress);
 
   // Returns the [Jacobian, residual, error] for all the error functions applying to a single frame:
   static std::tuple<Eigen::MatrixX<T>, Eigen::VectorX<T>, double, size_t> computePerFrameJacobian(
diff --git a/momentum/common/progress_bar.cpp b/momentum/common/progress_bar.cpp
@@ -7,47 +7,29 @@
 
 #include "momentum/common/progress_bar.h"
 
-#include <iostream>
-
 namespace momentum {
 
-ProgressBar::ProgressBar(const std::string& name, const int64_t numOperations, bool visible)
-    : numHashes_(std::max(maxWidth - (int64_t)name.size() - 1, (int64_t)50)),
-      numOperations_(numOperations),
-      visible_(visible) {
-  if (visible_) {
-    std::cout << name << " " << std::flush;
-  }
+ProgressBar::ProgressBar(const std::string& name, const int64_t numOperations) {
+  using namespace indicators;
+
+  bar_.set_option(option::BarWidth(kMaxWidth - name.size() - 9));
+  bar_.set_option(option::MaxProgress(numOperations));
+  bar_.set_option(option::Start{"["});
+  bar_.set_option(option::Fill{"="});
+  bar_.set_option(option::Lead{">"});
+  bar_.set_option(option::Remainder{" "});
+  bar_.set_option(option::End{"]"});
+  bar_.set_option(option::PrefixText{name});
+  bar_.set_option(option::ShowPercentage{true});
+  bar_.set_option(option::FontStyles{std::vector<FontStyle>{FontStyle::bold}});
 }
 
 void ProgressBar::increment(int64_t count) {
-  set(curOp_ + count);
+  bar_.set_progress(bar_.current() + count);
 }
 
 void ProgressBar::set(int64_t count) {
-  curOp_ = count;
-  const int64_t expectedPrinted = (curOp_ * numHashes_) / numOperations_;
-
-  while (numHashesPrinted_ < expectedPrinted) {
-    if (visible_) {
-      std::cout.put('#');
-      std::cout.flush();
-    }
-    ++numHashesPrinted_;
-  }
-}
-
-ProgressBar::~ProgressBar() {
-  const size_t nBackspace = maxWidth - (numHashes_ - numHashesPrinted_);
-  if (visible_) {
-    for (size_t i = 0; i < nBackspace; ++i) {
-      std::cout << "\b";
-    }
-    for (size_t i = 0; i < nBackspace; ++i) {
-      std::cout << " ";
-    }
-    std::cout << "\r" << std::flush;
-  }
+  bar_.set_progress(count);
 }
 
 } // namespace momentum
diff --git a/momentum/common/progress_bar.h b/momentum/common/progress_bar.h
@@ -7,28 +7,28 @@
 
 #pragma once
 
+// clang-format off
+#include <cstdint>  // Must come first. See https://github.com/p-ranav/indicators/pull/124
+#include <indicators/progress_bar.hpp>
+// clang-format on
+
 #include <string>
 
 namespace momentum {
 
-// A simple progress bar that prints hash marks, e.g.
-//   Reticulating splines #####################################
+// A simple progress bar that prints hash marks (e.g., "Name [===>  ] 60%")
 class ProgressBar {
-  const int64_t maxWidth = 80;
+  static constexpr int64_t kMaxWidth = 80;
 
  public:
-  ProgressBar(const std::string& name, int64_t numOperations, bool visible = false);
+  /// @param name Displayed prefix (visible=true only)
+  /// @param numOperations Total operations (determines progress ratio)
+  ProgressBar(const std::string& name, int64_t numOperations);
   void increment(int64_t count = 1);
   void set(int64_t count);
-  ~ProgressBar();
 
  private:
-  const int64_t numHashes_;
-  const int64_t numOperations_;
-  const bool visible_;
-
-  int64_t numHashesPrinted_ = 0;
-  int64_t curOp_ = 0;
+  indicators::ProgressBar bar_;
 };
 
 } // namespace momentum
diff --git a/momentum/marker_tracking/marker_tracker.cpp b/momentum/marker_tracking/marker_tracker.cpp
@@ -281,7 +281,7 @@ Eigen::MatrixXf trackPosesPerframe(
   }
 
   { // scope the ProgressBar so it returns
-    ProgressBar progress("", numFrames, true);
+    ProgressBar progress("", numFrames);
     for (size_t iFrame = 0; iFrame < numFrames; iFrame += frameStride) {
       // reinitialize if not continuous
       if (!continuous) {
diff --git a/pixi.lock b/pixi.lock
diff --git a/pixi.toml b/pixi.toml

Original file line number	Diff line number	Diff line change
`@@ -281,7 +281,7 @@ Eigen::MatrixXf trackPosesPerframe(`
`281`	`281`	`}`
`282`	`282`
`283`	`283`	`{ // scope the ProgressBar so it returns`
`284`		`- ProgressBar progress("", numFrames, true);`
	`284`	`+ ProgressBar progress("", numFrames);`
`285`	`285`	`for (size_t iFrame = 0; iFrame < numFrames; iFrame += frameStride) {`
`286`	`286`	`// reinitialize if not continuous`
`287`	`287`	`if (!continuous) {`