Fix documentation for name changing

Author: Myzhar

CMakeLists.txt

@@ -25,9 +25,9 @@ endif()
 
 ############################################################################
 # Options
-option(BUILD_VIDEO      "Build the ZED Driver Video Modules (only for Linux)"   ON)
-option(BUILD_SENSORS    "Build the ZED Driver Sensors Modules"                  ON)
-option(BUILD_EXAMPLES   "Build the ZED Driver examples"                         ON)
+option(BUILD_VIDEO      "Build the ZED Open Capture Video Modules (only for Linux)"   ON)
+option(BUILD_SENSORS    "Build the ZED Open Capture Sensors Modules"                  ON)
+option(BUILD_EXAMPLES   "Build the ZED Open Capture examples"                         ON)
 
 ############################################################################
 # Sources
@@ -113,7 +113,7 @@ set_target_properties(${PROJECT_NAME} PROPERTIES
 )
 install(TARGETS ${PROJECT_NAME}
     LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
-    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_PREFIX}/include/zed-driver)
+    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_PREFIX}/include/zed-open-capture)
 
 
 ############################################################################

doc/api_doc/DoxygenLayout.xml

@@ -18,8 +18,8 @@
         <tab type="user" url="md_installation.html" visible="yes" title="Installation"/>         
 
         <tab type="usergroup" url="md_modules.html" visible="yes" title="Modules">
-            <tab type="user" url="classsl__drv_1_1VideoCapture.html" visible="yes" title="Video Capture and Control"/>
-            <tab type="user" url="classsl__drv_1_1SensorCapture.html" visible="yes" title="Sensors Data Capture"/>
+            <tab type="user" url="classsl__oc_1_1VideoCapture.html" visible="yes" title="Video Capture and Control"/>
+            <tab type="user" url="classsl__oc_1_1SensorCapture.html" visible="yes" title="Sensors Data Capture"/>
         </tab>
 
         <tab type="modules" visible="no" title="" intro=""/>
@@ -34,9 +34,10 @@
         <tab type="pages" visible="no" title="" intro=""/>
 
         <tab type="usergroup" url="md_examples.html" visible="yes" title="Examples">
-            <tab type="user" url="zed_drv_video_example_8cpp-example.html" visible="yes" title="Video Capture and Control" />
-            <tab type="user" url="zed_drv_sensors_example_8cpp-example.html" visible="yes" title="Sensors Data Capture" />
-            <tab type="user" url="zed_drv_sync_example_8cpp-example.html" visible="yes" title="Video/Sensors sync" />
+            <tab type="user" url="zed_oc_video_example_8cpp-example.html" visible="yes" title="Video Capture and Control" />
+            <tab type="user" url="zed_oc_rectify_example_8cpp-example.html" visible="yes" title="Video Rectification" />
+            <tab type="user" url="zed_oc_sensors_example_8cpp-example.html" visible="yes" title="Sensors Data Capture" />
+            <tab type="user" url="zed_oc_sync_example_8cpp-example.html" visible="yes" title="Video/Sensors sync" />
         </tab>        
 
         <tab type="user" url="md_release-notes.html" visible="yes" title="Release Notes"/>

doc/api_doc/add-on.txt

@@ -12,8 +12,8 @@ A synchronization mechanism is provided to get the correct sensor data associate
 <h2 style="text-align: left;">Modules</h2>
 The library is composed of two modules:
 
- - <a href="group__Video__group.html">Video Capture</a>: video frame grabbing and camera control
- - <a href="group__Depth__group.html">Sensor Capture</a>: camera sensors data grabbing
+ - <a href="classsl__oc_1_1VideoCapture.html">Video Capture</a>: video frame grabbing and camera control
+ - <a href="classsl__oc_1_1SensorCapture.html">Sensor Capture</a>: camera sensors data grabbing
 
 <br>
 

doc/api_doc/doxyfile

@@ -476,15 +476,15 @@ EXTRACT_ANON_NSPACES   = NO
 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
 # The default value is: NO.
 
-HIDE_UNDOC_MEMBERS     = YES
+HIDE_UNDOC_MEMBERS     = NO
 
 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
 # undocumented classes that are normally visible in the class hierarchy. If set
 # to NO, these classes will be included in the various overviews. This option
 # has no effect if EXTRACT_ALL is enabled.
 # The default value is: NO.
 
-HIDE_UNDOC_CLASSES     = YES
+HIDE_UNDOC_CLASSES     = NO
 
 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
 # (class|struct|union) declarations. If set to NO, these declarations will be
@@ -670,7 +670,7 @@ SHOW_FILES             = NO
 # Folder Tree View (if specified).
 # The default value is: YES.
 
-SHOW_NAMESPACES        = NO
+SHOW_NAMESPACES        = YES
 
 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
 # doxygen should invoke to get the current version for each file (typically from
@@ -782,11 +782,11 @@ WARN_LOGFILE           =
 
 INPUT                  = add-on.txt \
                          release-notes.md \
-                         ../../include \
-                         ../../src \
                          examples.md \
                          modules.md \
-                         installation.md
+                         installation.md \
+                         ../../src \
+                         ../../include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -2010,7 +2010,7 @@ PERLMOD_MAKEVAR_PREFIX =
 # C-preprocessor directives found in the sources and include files.
 # The default value is: YES.
 
-ENABLE_PREPROCESSING   = YES
+ENABLE_PREPROCESSING   = NO
 
 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
 # in the source code. If set to NO, only conditional compilation will be
@@ -2019,7 +2019,7 @@ ENABLE_PREPROCESSING   = YES
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-MACRO_EXPANSION        = YES
+MACRO_EXPANSION        = NO
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and

doc/api_doc/examples.md

@@ -1,8 +1,8 @@
 # Examples
 
-A set of examples is provided to exploit all the features of the ZED Driver:
+A set of examples is provided to exploit all the features of the ZED Open Capture library:
 
-- [Video Capture and Control](zed_open_capture_video_example_8cpp-example.html): demonstrates how to acquire video stream, convert it to RGB and control the video settings using the keyboard (Requires OpenCV)
-- [Sensor Capture](zed_open_capture_sensors_example_8cpp-example.html): demonstrates how to acquire all the sensors data at the maximum frequency available
-- [Video/Sensors synchronization](zed_open_capture_sync_example_8cpp-example.html): demonstrates how to synchronize video and sensors data using the timestamps
-- [Video Rectification](zed_open_capture_rectify_example_8cpp-example.html): demonstrates how to rectify the video frames getting the calibration parameters from the Stereolabs servers
+- [Video Capture and Control](zed_oc_video_example_8cpp-example.html): demonstrates how to acquire video stream, convert it to RGB and control the video settings using the keyboard (Requires OpenCV)
+- [Sensor Capture](zed_oc_sensors_example_8cpp-example.html): demonstrates how to acquire all the sensors data at the maximum frequency available
+- [Video/Sensors synchronization](zed_oc_sync_example_8cpp-example.html): demonstrates how to synchronize video and sensors data using the timestamps
+- [Video Rectification](zed_oc_rectify_example_8cpp-example.html): demonstrates how to rectify the video frames getting the calibration parameters from the Stereolabs servers

doc/api_doc/modules.md

@@ -2,5 +2,5 @@
 
 The ZED Open Capture library is composed of two main modules:
 
- - [Video Capture](classsl__drv_1_1VideoCapture.html): video frame grabbing and camera settings control
- - [Sensor Capture](classsl__drv_1_1SensorCapture.html): camera sensors data grabbing
+ - [Video Capture](classsl__oc_1_1VideoCapture.html): video frame grabbing and camera settings control
+ - [Sensor Capture](classsl__oc_1_1SensorCapture.html): camera sensors data grabbing

examples/include/calibration.hpp

@@ -4116,10 +4116,16 @@ bool downloadCalibrationFile(unsigned int serial_number, std::string &calibratio
         std::string cmd;
         cmd = "wget " + url + std::to_string(serial_number) + "' -O " + calibration_file;
         std::cout << cmd << std::endl;
-        system(cmd.c_str());
+        int res = system(cmd.c_str());
+
+        if( res == EXIT_FAILURE )
+        {
+            std::cerr << "Error downloading the calibration file" << std::endl;
+            return false;
+        }
 
         if (!checkFile(calibration_file)) {
-            std::cout << "Invalid calibration file" << std::endl;
+            std::cerr << "Invalid calibration file" << std::endl;
             return false;
         }
     }
@@ -4155,6 +4161,7 @@ bool downloadCalibrationFile(unsigned int serial_number, std::string &calibratio
         }
     }
 #endif
+
     return true;
 }
 
@@ -4175,7 +4182,6 @@ bool initCalibration(std::string calibration_file, cv::Size2i image_size, cv::Ma
         return 0;
 
     std::string resolution_str;
-    bool check_data = true;
     switch ((int) image_size.width) {
         case 2208:
             resolution_str = "2k";
@@ -4191,7 +4197,6 @@ bool initCalibration(std::string calibration_file, cv::Size2i image_size, cv::Ma
             break;
         default:
             resolution_str = "hd";
-            check_data = false;
             break;
     }
 

include/defines.hpp

@@ -30,24 +30,24 @@
 #include <chrono>
 
 #if defined _WIN32
-#if defined(SL_SDK_COMPIL)
-#define SL_SDK_EXPORT __declspec(dllexport)
+#if defined(SL_OC_COMPIL)
+#define SL_OC_EXPORT __declspec(dllexport)
 #else
-#define SL_SDK_EXPORT __declspec(dllimport)
+#define SL_OC_EXPORT __declspec(dllimport)
 #endif
 #elif __GNUC__
-#define SL_DRV_EXPORT __attribute__((visibility("default")))
+#define SL_OC_EXPORT __attribute__((visibility("default")))
 #if defined(__arm__) || defined(__aarch64__)
 #define _SL_JETSON_
 #endif
 #endif
 
 //// SDK VERSION NUMBER
-#define ZED_DRV_MAJOR_VERSION 0
-#define ZED_DRV_MINOR_VERSION 1
-#define ZED_DRV_PATCH_VERSION 0
+#define ZED_OC_MAJOR_VERSION 0
+#define ZED_OC_MINOR_VERSION 1
+#define ZED_OC_PATCH_VERSION 0
 
-#define ZED_DRV_VERSION_ATTRIBUTE private: uint32_t mDrvMajorVer = ZED_DRV_MAJOR_VERSION, mDrvMinorVer = ZED_DRV_MINOR_VERSION, mDrvPatchVer = ZED_DRV_PATCH_VERSION
+#define ZED_OC_VERSION_ATTRIBUTE private: uint32_t mMajorVer = ZED_OC_MAJOR_VERSION, mMinorVer = ZED_OC_MINOR_VERSION, mPatchVer = ZED_OC_PATCH_VERSION
 
 // Debug output
 #define INFO_OUT(lvl,msg) { int status_dem_0; if (lvl>=3) std::cout << "[" << abi::__cxa_demangle(typeid(*this).name(), 0, 0, &status_dem_0) << "] INFO: " << msg << std::endl; }

include/sensorcapture.hpp

@@ -41,7 +41,7 @@ class VideoCapture;
 /*!
  * \brief The struct containing the acquired IMU data
  */
-struct SL_DRV_EXPORT SensImuData
+struct SL_OC_EXPORT SensImuData
 {
     bool valid = false;     //!< Indicates if IMU data are valid
     uint64_t timestamp = 0; //!< Timestamp in nanoseconds
@@ -58,7 +58,7 @@ struct SL_DRV_EXPORT SensImuData
 /*!
  * \brief The struct containing the acquired Magnetometer data
  */
-struct SL_DRV_EXPORT SensMagData
+struct SL_OC_EXPORT SensMagData
 {
     // Validity of the magnetometer sensor data
     typedef enum _mag_status {
@@ -77,7 +77,7 @@ struct SL_DRV_EXPORT SensMagData
 /*!
  * \brief The struct containing the acquired Environmental data
  */
-struct SL_DRV_EXPORT SensEnvData
+struct SL_OC_EXPORT SensEnvData
 {
     // Validity of the environmental sensor data
     typedef enum _env_status {
@@ -96,7 +96,7 @@ struct SL_DRV_EXPORT SensEnvData
 /*!
  * \brief The struct containing the acquired Environmental data
  */
-struct SL_DRV_EXPORT SensCamTempData
+struct SL_OC_EXPORT SensCamTempData
 {
     bool valid = false;     //!< Indicates if camera temperature data are valid
     uint64_t timestamp = 0; //!< Timestamp in nanoseconds
@@ -107,9 +107,9 @@ struct SL_DRV_EXPORT SensCamTempData
 /*!
  * \brief The SensorCapture class provides sensor grabbing functions for the Stereolabs ZED Mini and ZED2 camera models
  */
-class SL_DRV_EXPORT SensorCapture
+class SL_OC_EXPORT SensorCapture
 {
-    ZED_DRV_VERSION_ATTRIBUTE;
+    ZED_OC_VERSION_ATTRIBUTE;
 
 public:
     /*!
@@ -262,16 +262,18 @@ class SL_DRV_EXPORT SensorCapture
 
 };
 
-/** \example zed_drv_sensors_example.cpp
+#endif
+
+/** \example zed_oc_sensors_example.cpp
  * This is an example of how to use the \ref SensorCapture class to get the raw sensors data at the maximum available
  * frequency.
  */
 
-/** \example zed_drv_sync_example.cpp
+/** \example zed_oc_sync_example.cpp
  * This is an example of how to get synchronized video and sensors data from
  * the \ref VideoCapture class and the \ref SensorCapture class.
  */
 }
-#endif
+
 
 #endif // SENSORCAPTURE_HPP

include/videocapture.hpp

@@ -37,7 +37,7 @@ class SensorCapture;
 /*!
  * \brief The Frame struct containing the acquired video frames
  */
-struct SL_DRV_EXPORT Frame
+struct SL_OC_EXPORT Frame
 {
     uint64_t frame_id = 0;          //!< Increasing index of frames
     uint64_t timestamp = 0;         //!< Timestamp in nanoseconds
@@ -50,9 +50,9 @@ struct SL_DRV_EXPORT Frame
 /*!
  * \brief The VideoCapture class provides image grabbing functions and settings control for all the Stereolabs camera models
  */
-class SL_DRV_EXPORT VideoCapture
+class SL_OC_EXPORT VideoCapture
 {
-    ZED_DRV_VERSION_ATTRIBUTE;
+    ZED_OC_VERSION_ATTRIBUTE;
 
 public:
     /*!
@@ -411,15 +411,20 @@ class SL_DRV_EXPORT VideoCapture
 #endif
 
 
-/** \example zed_drv_video_example.cpp
+/** \example zed_oc_video_example.cpp
  * This is an example of how to use the \ref VideoCapture class to get raw video frames and control the camera
  * parameters.
  */
 
-/** \example zed_drv_sync_example.cpp
+/** \example zed_oc_sync_example.cpp
  * This is an example of how to get synchronized video and sensors data from
  * the \ref VideoCapture class and the \ref SensorCapture class.
  */
 
+/** \example zed_oc_rectify_example.cpp
+ * This is an example of how to use the \ref VideoCapture class to get and rectify raw video frames downloading
+ * calibration parameters from Stereolabs servers
+ */
+
 #endif // VIDEOCAPTURE_HPP