C++ API & examples improved

CMakeLists.txt

@@ -26,10 +26,28 @@ if (NOT WIN32 AND NOT UNIX AND NOT APPLE)
 endif (NOT WIN32 AND NOT UNIX AND NOT APPLE)
 
 
-### BUILD_TYPE
+### CMAKE_BUILD_TYPE
 # Default: Release
-set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
-set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
+# Bug fixed: By default, it uses something different to Release, that provokes OpenPose to be about 15% slower than
+# it should be.
+# Is CMAKE_BUILD_TYPE "Debug" or "MinSizeRel" or "RelWithDebInfo"?
+set(CMAKE_BUILD_TYPE_KNOWN FALSE)
+if (${CMAKE_BUILD_TYPE} MATCHES "Debug")
+  set(CMAKE_BUILD_TYPE_KNOWN TRUE)
+endif (${CMAKE_BUILD_TYPE} MATCHES "Debug")
+if (${CMAKE_BUILD_TYPE} MATCHES "MinSizeRel")
+  set(CMAKE_BUILD_TYPE_KNOWN TRUE)
+endif (${CMAKE_BUILD_TYPE} MATCHES "MinSizeRel")
+if (${CMAKE_BUILD_TYPE} MATCHES "RelWithDebInfo")
+  set(CMAKE_BUILD_TYPE_KNOWN TRUE)
+endif (${CMAKE_BUILD_TYPE} MATCHES "RelWithDebInfo")
+# Assign proper CMAKE_BUILD_TYPE
+if (${CMAKE_BUILD_TYPE_KNOWN})
+  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build.")
+else (${CMAKE_BUILD_TYPE_KNOWN})
+  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
+endif (${CMAKE_BUILD_TYPE_KNOWN})
+set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Release" "Debug" "MinSizeRel" "RelWithDebInfo")
 
 
 ### FLAGS

README.md

@@ -8,7 +8,7 @@
 |-------------|
 |[![Build Status](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose.svg?branch=master)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose)|
 
-[OpenPose](https://github.com/CMU-Perceptual-Computing-Lab/openpose) represents the **first real-time multi-person system to jointly detect human body, hand, and facial keypoints (in total 135 keypoints) on single images**.
+[OpenPose](https://github.com/CMU-Perceptual-Computing-Lab/openpose) represents the **first real-time multi-person system to jointly detect human body, hand, facial, and foot keypoints (in total 135 keypoints) on single images**.
 
 <p align="center">
     <img src="doc/media/pose_face_hands.gif", width="480">
@@ -113,9 +113,9 @@ bin\OpenPoseDemo.exe --video examples\media\video.avi
 
 - **Calibration toolbox**: To easily calibrate your cameras for 3-D OpenPose or any other stereo vision task. See [doc/modules/calibration_module.md](doc/modules/calibration_module.md).
 
-- **OpenPose Wrapper**: If you want to read a specific input, and/or add your custom post-processing function, and/or implement your own display/saving, check the `Wrapper` tutorial on [examples/tutorial_wrapper/](examples/tutorial_wrapper/). You can create your custom code on [examples/user_code/](examples/user_code/) and quickly compile it with CMake when compiling the whole OpenPose project. Quickly **add your custom code**: See [examples/user_code/README.md](examples/user_code/README.md) for further details.
+- **OpenPose C++ API**: If you want to read a specific input, and/or add your custom post-processing function, and/or implement your own display/saving, check the C++ API tutorial on [examples/tutorial_api_cpp/](examples/tutorial_api_cpp/) and [doc/library_introduction.md](doc/library_introduction.md). You can create your custom code on [examples/user_code/](examples/user_code/) and quickly compile it with CMake when compiling the whole OpenPose project. Quickly **add your custom code**: See [examples/user_code/README.md](examples/user_code/README.md) for further details.
 
-- **OpenPose C++ API**: See [doc/library_introduction.md](doc/library_introduction.md).
+- **OpenPose Python API**: Analogously to the C++ API, find the tutorial for the Python API on [examples/tutorial_api_python/](examples/tutorial_api_python/).
 
 - **Adding an extra module**: Check [doc/library_add_new_module.md](./doc/library_add_new_module.md).
 

doc/installation.md

@@ -112,14 +112,20 @@ Any problem installing OpenPose? Check [doc/faq.md](./faq.md) and/or post a GitH
     - Windows: download and install the latest CMake win64-x64 msi installer from the [CMake website](https://cmake.org/download/), called `cmake-X.X.X-win64-x64.msi`.
     - Mac: `brew cask install cmake`.
 3. Windows - **Microsoft Visual Studio (VS) 2015 Enterprise Update 3**:
-    - If **Visual Studio 2017 Community** is desired, we do not officially support it, but it might be compiled by firstly [enabling CUDA 8.0 in VS2017](https://stackoverflow.com/questions/43745099/using-cuda-with-visual-studio-2017?answertab=active#tab-top) or use **VS2017 with CUDA 9** by checking the `.vcxproj` file and changing the necessary paths from CUDA 8 to 9.
-    - VS 2015 Enterprise Update 1 will give some compiler errors and VS 2015 Community has not been tested.
+    - **IMPORTANT**: Enable all C++-related flags when selecting the components to install.
+    - Different VS versions:
+        - If **Visual Studio 2017 Community** is desired, we do not officially support it, but it might be compiled by firstly [enabling CUDA 8.0 in VS2017](https://stackoverflow.com/questions/43745099/using-cuda-with-visual-studio-2017?answertab=active#tab-top) or use **VS2017 with CUDA 9** by checking the `.vcxproj` file and changing the necessary paths from CUDA 8 to 9.
+        - VS 2015 Enterprise Update 1 will give some compiler errors.
+        - VS 2015 Community has not been tested.
 4. Nvidia GPU version prerequisites:
     1. [**CUDA 8**](https://developer.nvidia.com/cuda-80-ga2-download-archive):
         - Ubuntu: Run `sudo ubuntu/install_cuda.sh` or alternatively download and install it from their website.
-        - Windows: Install CUDA 8.0 after Visual Studio 2015 is installed to assure that the CUDA installation will generate all necessary files for VS. If CUDA was already installed, re-install - **IMPORTANT 1/2**: Nvidia V, any Nvidia with Volta architecture, and newer Nvidia model GPUs require at least CUDA 9.
-        - **IMPORTANT 2/2**: As of a recent Windows update, you might want to download the Nvidia [drivers](http://www.nvidia.com/Download/index.aspx) first, and then install CUDA without the Graphics Driver flag or else your system might hang.
-    2. [**cuDNN 5.1**](https://developer.nvidia.com/cudnn):
+        - Windows: Install CUDA 8.0 after Visual Studio 2015 is installed to assure that the CUDA installation will generate all necessary files for VS. If CUDA was already installed, re-install it.
+        - **Important installation tips**:
+            - New Nvidia model GPUs (e.g., Nvidia V, GTX 2080, any Nvidia with Volta or Turing architecture, etc.) require at least CUDA 9.
+            - (Windows issue, reported Sep 2018): If your computer hangs when installing CUDA drivers, try installing first the [Nvidia drivers](http://www.nvidia.com/Download/index.aspx), and then installing CUDA without the Graphics Driver flag.
+            - (Windows): If CMake returns and error message similar to `CUDA_TOOLKIT_ROOT_DIR not found or specified` or any other CUDA component missing, then: 1) Re-install Visual Studio 2015; 2) Reboot your PC; 3) Re-install CUDA.
+    2. [**cuDNN 5.1**](https://developer.nvidia.com/rdp/cudnn-archive):
         - Ubuntu: Run `sudo ubuntu/install_cudnn.sh` or alternatively download and install it from their website.
         - Windows (and Ubuntu if manual installation): In order to manually install it, just unzip it and copy (merge) the contents on the CUDA folder, usually `/usr/local/cuda/` in Ubuntu and `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0` in Windows.
 5. AMD GPU version prerequisites:

doc/library_add_new_module.md

@@ -8,7 +8,7 @@ In order to add a new module, these are the recommended steps in order to develo
 2. Implement all the functionality in one `Worker` (i.e. inherit from `Worker` and implement all the functionality on that class).
     1. The first letter of the class name should be `W` (e.g. `WHairExtractor`).
     2. To initially simplify development:
-        1. Initialize the Worker class with the specific std::shared_ptr<std::vector<op::Datum>> instead of directly using a template class (following the `examples/tutorial_wrapper` synchronous examples).
+        1. Initialize the Worker class with the specific std::shared_ptr<std::vector<op::Datum>> instead of directly using a template class (following the `examples/tutorial_api_cpp` synchronous examples).
         2. Use the whole op::Datum as unique argument of your auxiliary functions.
         3. Use the OpenPose Wrapper in ThreadManagerMode::SingleThread mode (e.g. it allows you to directly use cv::imshow).
         4. If you are using your own custom Caffe -> initially change the Caffe for your version. It should directly work.
@@ -20,6 +20,8 @@ In order to add a new module, these are the recommended steps in order to develo
 5. If the Workers need extra data from `Datum`, simply add into `Datum` the new variables required (without removing/modifying any previous variables!).
 6. Read also the release steps before starting this developping phase.
 
+
+
 ## Release Steps
 In order to release the new module:
 

doc/library_extend_functionality.md

@@ -7,14 +7,14 @@ If you intend to extend the functionality of our library:
 
 2. Check the basic library overview doc on [library_overview.md](library_overview.md).
 
-3. Read, understand and play with the basic real time pose demo source code [examples/openpose/openpose.cpp](../examples/openpose/openpose.cpp) and [examples/tutorial_wrapper](../examples/tutorial_wrapper). It includes all the functionality of our library, and it has been properly commented.
+3. Read, understand and play with the basic real time pose demo source code [examples/openpose/openpose.cpp](../examples/openpose/openpose.cpp) and [examples/tutorial_api_cpp](../examples/tutorial_api_cpp). It includes all the functionality of our library, and it has been properly commented.
 
 4. Read, understand and play with the other tutorials in [examples/](../examples/). It includes more specific examples.
 
 5. Check the basic UML diagram on the [UML folder](UML/) to get an idea of each module relations.
 
 6. Take a look to the stucuture of the already existing modules.
 
-7. The C++ headers files add documentation in [Doxygen](http://www.doxygen.org/) format. Create this documentation by compiling the [include](../include/) folder with Doxygen. This documentation will be completed during the next few weeks/months.
+7. The C++ headers files add documentation in [Doxygen](http://www.doxygen.org/) format. Create this documentation by compiling the [include](../include/) folder with Doxygen. This documentation is slowly but continuously improved.
 
 8. You can also take a look to the source code or ask us on GitHub.

doc/modules/3d_reconstruction_module.md

@@ -109,7 +109,7 @@ It should be similar to the following image.
 You can copy and modify the OpenPose 3-D demo to use any camera brand by:
 
 1. You can optionally turn off the `WITH_FLIR_CAMERA` while compiling CMake.
-2. Copy any of the `examples/tutorial_wrapper/*.cpp` examples (we recommend `2_user_synchronous.cpp`).
+2. Copy `examples/tutorial_api_cpp/7_synchronous_custom_input.cpp` (or 9_synchronous_custom_all.cpp).
 3. Modify `WUserInput` and add your custom code there. Your code should fill `Datum::name`, `Datum::cameraMatrix`, `Datum::cvInputData`, and `Datum::cvOutputData` (fill cvOutputData = cvInputData).
 4. Remove `WUserPostProcessing` and `WUserOutput` (unless you want to have your custom post-processing and/or output).
 

doc/modules/python_module.md

@@ -35,21 +35,21 @@ pip install opencv-python
 
 
 ## Testing
-Two examples can be found in `build/examples/tutorial_python` in your build folder. Navigate directly to this path to run examples.
+Two examples can be found in `build/examples/tutorial_api_python` in your build folder. Navigate directly to this path to run examples.
 
 - `1_extract_pose` demonstrates a simple use of the API.
-- `2_pose_from_heatmaps` demonstrates constructing pose from heatmaps from the caffe network. (Requires Python Caffe to be installed seperately)
+- `2_pose_from_heatmaps` demonstrates constructing pose from heatmaps from the caffe network (Requires Python Caffe to be installed seperately, only tested on Ubuntu).
 
 ```
 # From command line
-cd build/examples/tutorial_python
+cd build/examples/tutorial_api_python
 python 1_extract_pose.py
 ```
 
 
 
 ## Exporting Python OpenPose
-Note: This step is only required if you are moving the `*.py` files outside their original location, or writting new `*.py` scripts outside `build/examples/tutorial_python`.
+Note: This step is only required if you are moving the `*.py` files outside their original location, or writting new `*.py` scripts outside `build/examples/tutorial_api_python`.
 
 - Option a, installing OpenPose: On an Ubuntu or OSX based system, you could install OpenPose by running `sudo make install`, you could then set the OpenPose path in your python scripts to the OpenPose installation path (default: `/usr/local/python`) and start using OpenPose at any location. Take a look at `build/examples/tutorial_pose/1_extract_pose.py` for an example.
-- Option b, not Installing OpenPose: To move the OpenPose Python API demos to a different folder, ensure that the line `sys.path.append('{OpenPose_path}/python')` is properly set in your `*.py` files, where `{OpenPose_path}` points to your build folder of OpenPose. Take a look at `build/examples/tutorial_pose/1_extract_pose.py` for an example.
+- Option b, not installing OpenPose: To move the OpenPose Python API demos to a different folder, ensure that the line `sys.path.append('{OpenPose_path}/python')` is properly set in your `*.py` files, where `{OpenPose_path}` points to your build folder of OpenPose. Take a look at `build/examples/tutorial_pose/1_extract_pose.py` for an example.

doc/release_notes.md

@@ -57,7 +57,7 @@ OpenPose Library - Release Notes
     9. WCocoJsonSaver finished and removed its 3599-image limit.
     10. Added `--camera_fps` so generated video will use that frame rate.
     11. Reduced the number of printed information messages. Default logging priority threshold increased to Priority::Max.
-    12. Google flags to OpenPose configuration parameters reader moved from each demo to utilities/flagsToOpenPose.
+    12. GFlags to OpenPose configuration parameters reader moved from each demo to utilities/flagsToOpenPose.
     13. Nms classes do not use `numberParts` for `Reshape`, they deduce the value.
     14. Improved documentation.
 2. Functions or parameters renamed:
@@ -259,15 +259,23 @@ OpenPose Library - Release Notes
 
 
 
-## Current version - future OpenPose 1.4.1
+## Current version - future OpenPose 1.5.0
 1. Main improvements:
     1. Added initial single-person tracker for further speed up or visual smoothing (`--tracking` flag).
     2. Greedy body part connector implemented in CUDA: +~30% speed up in Nvidia (CUDA) version with default flags and +~10% in maximum accuracy configuration. In addition, it provides a small 0.5% boost in accuracy (default flags).
     3. OpenPose can be built as Unity plugin: Added flag `BUILD_UNITY_SUPPORT` and special Unity code.
     4. If camera is unplugged, OpenPose GUI and command line will display a warning and try to reconnect it.
+    5. Wrapper classes simplified and renamed.
+    6. API and examples improved:
+        1. New header file `flags.hpp` that includes all OpenPose flags, removing the need to copy them repeatedly on each OpenPose example file.
+        2. `tutorial_wrapper` renamed as `tutorial_api_cpp` as well as new examples were added.
+        2. `tutorial_python` renamed as `tutorial_api_python` as well as new examples were added.
+        3. `tutorial_pose` and `tutorial_thread` renamed as `tutorial_developer`, not meant to be used by users, but rather for OpenPose developers.
 2. Functions or parameters renamed:
-    1. By default, python example `2_pose_from_heatmaps.py` was using 2 scales starting at -1x736, changed to 1 scale at -1x368.
+    1. By default, python example `tutorial_developer/python_2_pose_from_heatmaps.py` was using 2 scales starting at -1x736, changed to 1 scale at -1x368.
+    2. WrapperStructPose default parameters changed to match those of the OpenPose demo binary.
 3. Main bugs fixed:
+    1. CMake-GUI was forcing to Release mode, allowed Debug modes too.
 
 
 

examples/CMakeLists.txt

@@ -1,10 +1,9 @@
 add_subdirectory(calibration)
 add_subdirectory(openpose)
 add_subdirectory(tutorial_add_module)
-add_subdirectory(tutorial_pose)
-add_subdirectory(tutorial_python)
-add_subdirectory(tutorial_thread)
-add_subdirectory(tutorial_wrapper)
+add_subdirectory(tutorial_api_python)
+add_subdirectory(tutorial_api_cpp)
+add_subdirectory(tutorial_developer)
 add_subdirectory(user_code)
 if (UNIX OR APPLE)
   add_subdirectory(tests)

examples/calibration/CMakeLists.txt

@@ -1,4 +1,4 @@
-set(EXAMPLE_FILES 
+set(EXAMPLE_FILES
     calibration.cpp)
 
 foreach(EXAMPLE_FILE ${EXAMPLE_FILES})

examples/calibration/calibration.cpp

@@ -3,26 +3,12 @@
 // Implemented on top of OpenCV.
 // It computes and saves the intrinsics parameters of the input images.
 
-// C++ std library dependencies
-#include <chrono> // `std::chrono::` functions and classes, e.g. std::chrono::milliseconds
-#include <thread> // std::this_thread
-// Other 3rdparty dependencies
-// GFlags: DEFINE_bool, _int32, _int64, _uint64, _double, _string
-#include <gflags/gflags.h>
-// Allow Google Flags in Ubuntu 14
-#ifndef GFLAGS_GFLAGS_H_
-    namespace gflags = google;
-#endif
+// Command-line user intraface
+#define OPENPOSE_FLAGS_DISABLE_POSE
+#include <openpose/flags.hpp>
 // OpenPose dependencies
 #include <openpose/headers.hpp>
 
-// See all the available parameter options withe the `--help` flag. E.g. `build/examples/openpose/openpose.bin --help`
-// Note: This command will show you flags for other unnecessary 3rdparty files. Check only the flags for the OpenPose
-// executable. E.g. for `openpose.bin`, look for `Flags from examples/openpose/openpose.cpp:`.
-// Debugging/Other
-DEFINE_int32(logging_level,             3,              "The logging level. Integer in the range [0, 255]. 0 will output any log() message, while"
-                                                        " 255 will not output any. Current OpenPose library messages are in the range 0-4: 1 for"
-                                                        " low priority messages and 4 for important ones.");
 // Calibration
 DEFINE_int32(mode,                      1,              "Select 1 for intrinsic camera parameter calibration, 2 for extrinsic calibration.");
 DEFINE_string(calibration_image_dir,    "images/intrinsics/", "Directory where the images for camera parameter calibration are placed.");

examples/openpose/CMakeLists.txt

@@ -1,4 +1,4 @@
-set(EXAMPLE_FILES 
+set(EXAMPLE_FILES
     openpose.cpp)
 
 foreach(EXAMPLE_FILE ${EXAMPLE_FILES})