Introduce vpDisplayFactory usage, code indentation, harmonize command…

… line options
lagadic · May 19, 2024 · 41d8d3b · 41d8d3b
1 parent 1e4d079
commit 41d8d3b
Show file tree

Hide file tree

Showing 8 changed files with 130 additions and 115 deletions.
diff --git a/tutorial/grabber/tutorial-grabber-1394-writer.cpp b/tutorial/grabber/tutorial-grabber-1394-writer.cpp
@@ -50,14 +50,15 @@ int main(int argc, char **)
       vpDisplay::display(I);
       vpDisplay::flush(I);
 
-      if (vpDisplay::getClick(I, false))
+      if (vpDisplay::getClick(I, false)) {
         break;
+      }
 #endif
     }
 
-    if (save)
+    if (save) {
       writer.close();
-
+    }
   }
   catch (const vpException &e) {
     std::cout << "Catch an exception: " << e << std::endl;

diff --git a/tutorial/grabber/tutorial-video-reader.cpp b/tutorial/grabber/tutorial-video-reader.cpp
@@ -1,7 +1,5 @@
 //! \example tutorial-video-reader.cpp
-#include <visp3/gui/vpDisplayGDI.h>
-#include <visp3/gui/vpDisplayOpenCV.h>
-#include <visp3/gui/vpDisplayX.h>
+#include <visp3/gui/vpDisplayFactory.h>
 //! [Include]
 #include <visp3/core/vpTime.h>
 #include <visp3/io/vpVideoReader.h>
@@ -24,8 +22,8 @@ int main(int argc, char **argv)
         videoname = std::string(argv[i + 1]);
       else if (std::string(argv[i]) == "--help" || std::string(argv[i]) == "-h") {
         std::cout << "\nUsage: " << argv[0] << " [--name <video name> (default: " << videoname << ")]"
-                  << " [--help] [-h]\n"
-                  << std::endl;
+          << " [--help] [-h]\n"
+          << std::endl;
         return EXIT_SUCCESS;
       }
     }
@@ -44,20 +42,17 @@ int main(int argc, char **argv)
     std::cout << "Video framerate: " << g.getFramerate() << "Hz" << std::endl;
     std::cout << "Video dimension: " << I.getWidth() << " " << I.getHeight() << std::endl;
 
-#ifdef VISP_HAVE_X11
-    vpDisplayX d(I);
-#elif defined(VISP_HAVE_GDI)
-    vpDisplayGDI d(I);
-#elif defined(HAVE_OPENCV_HIGHGUI)
-    vpDisplayOpenCV d(I);
+#ifdef VISP_HAVE_DISPLAY
+    vpDisplay *d = vpDisplayFactory::displayFactory(I);
 #else
     std::cout << "No image viewer is available..." << std::endl;
 #endif
     vpDisplay::setTitle(I, "Video reader");
 
     unsigned cpt = 1;
+    bool quit = false;
     //! [vpVideoReader while loop]
-    while (!g.end()) {
+    while ((!g.end()) && (!quit)) {
       //! [vpVideoReader while loop]
       //! [vpVideoReader loop start time]
       double t = vpTime::measureTimeMs();
@@ -68,17 +63,25 @@ int main(int argc, char **argv)
       vpDisplay::display(I);
       vpDisplay::displayText(I, 20, 20, "Click to quit", vpColor::red);
       std::stringstream ss;
-      ss << "Frame: " << cpt++;
+      ss << "Frame: " << ++cpt;
+      std::cout << "Read " << ss.str() << std::endl;
       vpDisplay::displayText(I, 40, 20, ss.str(), vpColor::red);
       vpDisplay::flush(I);
-      if (vpDisplay::getClick(I, false))
-        break;
+      if (vpDisplay::getClick(I, false)) {
+        quit = true;
+      }
       //! [vpVideoReader loop rate]
       vpTime::wait(t, 1000. / g.getFramerate());
       //! [vpVideoReader loop rate]
     }
-    std::cout << "End of video was reached" << std::endl;
-  } catch (const vpException &e) {
+    if (!quit) {
+      std::cout << "End of video was reached" << std::endl;
+    }
+#ifdef VISP_HAVE_DISPLAY
+    delete d;
+#endif
+  }
+  catch (const vpException &e) {
     std::cout << e.getMessage() << std::endl;
   }
 #else

diff --git a/tutorial/grabber/tutorial-video-recorder.cpp b/tutorial/grabber/tutorial-video-recorder.cpp
@@ -1,8 +1,6 @@
 /*! \example tutorial-video-recorder.cpp */
 #include <visp3/core/vpTime.h>
-#include <visp3/gui/vpDisplayGDI.h>
-#include <visp3/gui/vpDisplayGTK.h>
-#include <visp3/gui/vpDisplayOpenCV.h>
+#include <visp3/gui/vpDisplayFactory.h>
 #include <visp3/gui/vpDisplayX.h>
 #include <visp3/io/vpVideoWriter.h>
 #include <visp3/sensor/vpV4l2Grabber.h>
@@ -12,36 +10,36 @@
 #endif
 
 /*!
- This example allows to record a video from a camera.
- It only requires that ViSP is build with OpenCV.
+  This example allows to record a video from a camera.
+  It only requires that ViSP is build with OpenCV.
 
- Example to save an mpeg video:
+  Example to save an mpeg video:
 
     ./tutorial-video-recorder --device 0 --name myvideo.mp4
 
- Example to save a sequence of png images:
+  Example to save a sequence of png images:
 
     ./tutorial-video-recorder --device 0 --name image%04d.png
 
- Example to save one imags:
+  Example to save one image:
 
     ./tutorial-video-recorder --device 0 --name image.jpeg
 
  */
-int main(int argc, const char *argv [])
+int main(int argc, const char *argv[])
 {
-#if ((defined(VISP_HAVE_V4L2) || defined(HAVE_OPENCV_VIDEOIO)) &&                                            \
-     (defined(VISP_HAVE_X11) || defined(VISP_HAVE_GDI) || defined(HAVE_OPENCV_HIGHGUI) || defined(VISP_HAVE_GTK)))
+#if (defined(VISP_HAVE_V4L2) || defined(HAVE_OPENCV_VIDEOIO)) && defined(VISP_HAVE_DISPLAY)
   std::string opt_videoname = "video-recorded.mpg";
   int opt_device = 0;
 
   for (int i = 0; i < argc; i++) {
     if (std::string(argv[i]) == "--device")
       opt_device = atoi(argv[i + 1]);
-    else if (std::string(argv[i]) == "--name")
+    else if (std::string(argv[i]) == "--recorded-name")
       opt_videoname = std::string(argv[i + 1]);
     else if (std::string(argv[i]) == "--help" || std::string(argv[i]) == "-h") {
-      std::cout << "\nUsage: " << argv[0] << " [--device <device number>] [--name <video name>] [--help][-h]\n"
+      std::cout << "\nUsage: " << argv[0]
+        << " [--device <device number>] [--recorded-name <video name>] [--help][-h]\n"
         << std::endl;
       return EXIT_SUCCESS;
     }
@@ -55,6 +53,7 @@ int main(int argc, const char *argv [])
     vpImage<unsigned char> I; // for gray images
 
 #if defined(VISP_HAVE_V4L2)
+    std::cout << "Use v4l2 grabber..." << std::endl;
     vpV4l2Grabber g;
     std::ostringstream device;
     device << "/dev/video" << opt_device;
@@ -63,6 +62,7 @@ int main(int argc, const char *argv [])
     g.open(I);
     g.acquire(I);
 #elif defined(HAVE_OPENCV_VIDEOIO)
+    std::cout << "Use OpenCV grabber..." << std::endl;
     cv::VideoCapture g(opt_device);
     if (!g.isOpened()) { // check if we succeeded
       std::cout << "Failed to open the camera" << std::endl;
@@ -75,16 +75,10 @@ int main(int argc, const char *argv [])
 
     std::cout << "Image size: " << I.getWidth() << " " << I.getHeight() << std::endl;
 
-#if defined(VISP_HAVE_X11)
-    vpDisplayX d;
-#elif defined(VISP_HAVE_GDI)
-    vpDisplayGDI d;
-#elif defined(HAVE_OPENCV_HIGHGUI)
-    vpDisplayOpenCV d;
-#elif defined(VISP_HAVE_GTK)
-    vpDisplayGTK d;
+#if defined(VISP_HAVE_DISPLAY)
+    vpDisplay *d = vpDisplayFactory::displayFactory();
+    d->init(I, 0, 0, "Camera view");
 #endif
-    d.init(I, 0, 0, "Camera view");
     vpVideoWriter writer;
 
 #if defined(HAVE_OPENCV_VIDEOIO)
@@ -121,6 +115,9 @@ int main(int argc, const char *argv [])
       vpDisplay::flush(I);
     }
     std::cout << "The video was recorded in \"" << opt_videoname << "\"" << std::endl;
+#ifdef VISP_HAVE_DISPLAY
+    delete d;
+#endif
   }
   catch (const vpException &e) {
     std::cout << "Catch an exception: " << e << std::endl;

diff --git a/tutorial/image/tutorial-draw-circle.cpp b/tutorial/image/tutorial-draw-circle.cpp
@@ -1,6 +1,5 @@
 //! \example tutorial-draw-circle.cpp
-#include <visp3/gui/vpDisplayGDI.h>
-#include <visp3/gui/vpDisplayX.h>
+#include <visp3/gui/vpDisplayFactory.h>
 #include <visp3/core/vpImageCircle.h>
 #include <visp3/core/vpImageDraw.h>
 
@@ -11,10 +10,10 @@ int main()
 
   try {
     {
-#if defined(VISP_HAVE_X11)
-      vpDisplayX d(I, vpDisplay::SCALE_AUTO);
-#elif defined(VISP_HAVE_GDI)
-      vpDisplayGDI d(I, vpDisplay::SCALE_AUTO);
+#if defined(VISP_HAVE_DISPLAY)
+      vpDisplay *d = vpDisplayFactory::displayFactory(I, vpDisplay::SCALE_AUTO);
+#else
+      std::cout << "No gui available to display gray level image..." << std::endl;
 #endif
 
       vpDisplay::setTitle(I, "Gray image");
@@ -25,9 +24,9 @@ int main()
       // i.e. does not modify I
       vpDisplay::displayCircle(I, circle, vpColor::red, false, 2);
       //! [Circle display]
+      vpDisplay::setTitle(I, "Display a red circle on gray level image overlay");
       vpDisplay::flush(I);
-      vpDisplay::setTitle(I, "Overlay");
-      std::cout << "Result of displaying a red circle on overlay on the display..." << std::endl;
+      std::cout << "Result of displaying a red circle on a gray level image overlay..." << std::endl;
       std::cout << "A click to continue..." << std::endl;
       vpDisplay::getClick(I);
 
@@ -38,11 +37,17 @@ int main()
       vpImageDraw::drawCircle(I, circle2, 255, 2);
       //! [Circle draw uchar]
       vpDisplay::display(I);
-      vpDisplay::flush(I);
-      vpDisplay::setTitle(I, "Modification of a uchar image");
-      std::cout << "Result of the modification of a uchar image..." << std::endl;
+      vpDisplay::setTitle(I, "Display circle by modifying a gray level image");
+      std::cout << "Result of displaying a circle by modifying a gray level image..." << std::endl;
       std::cout << "A click to continue..." << std::endl;
+      vpDisplay::flush(I);
       vpDisplay::getClick(I);
+
+#if defined(VISP_HAVE_DISPLAY)
+      if (d) {
+        delete d;
+      }
+#endif
     }
 
     {
@@ -53,19 +58,23 @@ int main()
       vpImageDraw::drawCircle(I_rgb, circle3, vpColor::blue, 2);
       //! [Circle draw color]
 
-#if defined(VISP_HAVE_X11)
-      vpDisplayX d_rgb(I_rgb, vpDisplay::SCALE_AUTO);
-#elif defined(VISP_HAVE_GDI)
-      vpDisplayGDI d_rgb(I_rgb, vpDisplay::SCALE_AUTO);
+#if defined(VISP_HAVE_DISPLAY)
+      vpDisplay *d = vpDisplayFactory::displayFactory(I_rgb, vpDisplay::SCALE_AUTO);
+#else
+      std::cout << "No gui available to display color image..." << std::endl;
 #endif
 
-      vpDisplay::setTitle(I_rgb, "Color image");
       vpDisplay::display(I_rgb);
+      vpDisplay::setTitle(I_rgb, "Display blue circle on a modified color image");
       vpDisplay::flush(I_rgb);
-      vpDisplay::setTitle(I, "Modification of a vpRGBa image");
-      std::cout << "Result of the modification of a vpRGBa image..." << std::endl;
+      std::cout << "Result of displaying a blue circle on a modified color image..." << std::endl;
       std::cout << "A click to continue..." << std::endl;
       vpDisplay::getClick(I_rgb);
+#if defined(VISP_HAVE_DISPLAY)
+      if (d) {
+        delete d;
+      }
+#endif
     }
   }
   catch (const vpException &e) {

diff --git a/tutorial/image/tutorial-draw-cross.cpp b/tutorial/image/tutorial-draw-cross.cpp
@@ -1,13 +1,11 @@
 //! \example tutorial-draw-cross.cpp
-#include <visp3/gui/vpDisplayGDI.h>
-#include <visp3/gui/vpDisplayX.h>
+#include <visp3/gui/vpDisplayFactory.h>
 
 int main()
 {
   vpImage<unsigned char> I(2160, 3840, 128);
 
   try {
-
 #if defined(VISP_HAVE_X11)
     vpDisplayX d(I, vpDisplay::SCALE_AUTO);
 #elif defined(VISP_HAVE_GDI)
@@ -22,7 +20,8 @@ int main()
     vpDisplay::flush(I);
     std::cout << "A click to quit..." << std::endl;
     vpDisplay::getClick(I);
-  } catch (const vpException &e) {
+  }
+  catch (const vpException &e) {
     std::cout << "Catch an exception: " << e.getMessage() << std::endl;
   }
   std::cout << std::endl;