Add progress indicator

Based on pull request johmathe#3 by
Olivier Aubert (https://github.com/oaubert).

Add library {fmt} http://fmtlib.net/ for sane string handling. Will be
used in upcoming commits, too.

Author: mostlyuseful

src/commandline.cc

@@ -23,7 +23,7 @@ class film;
 
 // Example
 // Put the file you want to analyse in the same directory of shotdetect (it not
-// mandatory but itÕs easier with the command line)
+// mandatory but it's easier with the command line)
 
 // shotdetect -i myvideo.avi -o output_dir -s 75 -w -v -f -l -m -r
 
@@ -51,6 +51,7 @@ void show_help(char **argv) {
       "-n           : commandline mode (disable GUI)\n"
       "-s threshold : threshold (Default=%d)\n"
       "-i file      : input file path\n"
+      "-p           : output progress report information\n"
       "-o path      : output path\n"
       "-y year      : set the year\n"
       "-a id        : id of the movie\n"
@@ -86,7 +87,7 @@ int main(int argc, char **argv) {
   f.set_draw_yuv_graph(false);  // YUV graph is still disabled, until it works.
 
   for (;;) {
-    int c = getopt(argc, argv, "?ht:y:i:o:a:x:s:flwvmrc");
+    int c = getopt(argc, argv, "?ht:y:i:o:a:x:s:flpwvmrc");
 
     if (c < 0) {
       break;
@@ -117,6 +118,10 @@ int main(int argc, char **argv) {
       /* Generate thumbnails? */
       case 'm':
         f.set_thumb(true);
+      break;
+
+    case 'p':
+      f.set_progress(true);
         break;
 
       /* Generate XML with video metadata? */

src/film.cc

@@ -32,11 +32,21 @@ extern "C" {
 #include "src/film.h"
 #include "src/graph.h"
 
+#include "src/format.h"
+
 #define DEBUG
 
 int film::idfilm = 0;
 
-void film::do_stats(int frame_number) {
+void film::log_progress(string type, int position, int total)
+{
+  if (this->get_progress()) {
+    cerr << type << " " << position << " " << total << endl;
+  }
+}
+
+void film::do_stats(int frame_number)
+{
   double perctmp = percent;
   struct timeval time_now;
   struct timezone timezone;
@@ -180,9 +190,7 @@ void film::CompareFrame(AVFrame *pFrame, AVFrame *pFramePrev) {
     s.msbegin = int((frame_number * 1000) / fps);
     s.myid = shots.back().myid + 1;
 
-#ifdef DEBUG
-    cerr << "Shot log :: " << s.msbegin << endl;
-#endif
+    this->log_progress("shot", s.msbegin, duration.mstotal);
 
     /*
      * Convert to ms
@@ -414,6 +422,10 @@ int film::process() {
 
   checknumber = (samplerate * samplearg) / 1000;
 
+  const int progress_frame_interval = 100;
+  timespec last_progress_log_cputime;
+  clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &last_progress_log_cputime);
+
   /*
    * Main loop to control the movie processing flow
    */
@@ -424,6 +436,26 @@ int film::process() {
       if (frameFinished) {
         frame_number = pCodecCtx->frame_number;  // Current frame number
 
+        // Report progress information every N frames
+        if (frame_number % progress_frame_interval == 0) {
+
+          timespec current_progress_log_cputime;
+          clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &current_progress_log_cputime);
+          const double delta_s = [](auto start, auto end){
+              return    (double)(end.tv_sec - start.tv_sec) +
+                        1.0e-9*(double)(end.tv_nsec - start.tv_nsec);
+          }(last_progress_log_cputime, current_progress_log_cputime);
+          last_progress_log_cputime = current_progress_log_cputime;
+          const double computation_fps = 1/(delta_s / progress_frame_interval);
+
+          // this->log_progress("progress", int((frame_number * 1000) / fps), duration.mstotal);
+          const double current_secs = frame_number / fps;
+          const double duration_secs = duration.mstotal / 1000.0;
+          const double percent = current_secs / duration_secs * 100;
+          this->shotlog(fmt::format("Progress: frame={:6}, time={:.1f}s, duration={:.1f}s, percent={:.3f}%%, fps={:.1f}",
+                                               frame_number, current_secs, duration_secs, percent, computation_fps));
+        }
+
         // Convert the image into YUV444
         if (!img_ctx) {
           img_ctx =

src/film.h

@@ -186,6 +186,8 @@ class film {
   double percent;
   /* Showing state started */
   bool show_started;
+  /* Output progress information */
+  bool progress;
   /* Draw graphs: */
   bool draw_rgb_graph;
   bool draw_hsv_graph;
@@ -198,6 +200,7 @@ class film {
   void process_audio();
   void shotlog(string message);
   void create_main_dir(void);
+  void log_progress(string message, int position, int total);
 
   /* Constructor */
   film();
@@ -222,6 +225,12 @@ class film {
   inline void set_year(int year) { this->year = year; };
   inline void set_alphaid(string alphaid) { this->alphaid = alphaid; };
   inline void set_title(string title) { this->title = title; };
+  inline void set_progress(bool progress) {
+    this->progress = progress;
+  };
+  inline bool get_progress(void)  {
+    return this->progress;
+  };
 
   inline void set_draw_rgb_graph(bool val) { this->draw_rgb_graph = val; };
   inline void set_draw_hsv_graph(bool val) { this->draw_hsv_graph = val; };