ImageSDK : C++#

The following section describe how to setup a CMake project, that works for both Windows and Linux based operating systems. Further, the CMake project automatically downloads the newest SDK binaries.

Build & Runtime Prerequisites#

Depending on the target platform, our SDK’s depends on different system libraries.

Windows#

  • Windows 10 (x64)

  • CMake 3.13 or later

  • MSVC 2019 or later

On Windows CMake will output Visual Studio (*.vcxproj) project files. So, if you prefer to work in Visual Studio, you can do that.

Tip

Visual Studio 2019 actually include (optional) built-in support for working directly with CMake files. This means there is no need to output vcxproj files at all.

However, the way to configure projects and debug parameters are different from the approach used with normal Visual C++ projects.

You can add the optional CMake component from the Visual Studio Installer application.

Linux#

  • Ubuntu 20.04 (Focal) or later

  • CMake 3.13 or later

  • Either: GCC 7.5 or later or Clang 10 or later

  • libpthread

You can of course use older Ubuntu’s or other Linux distros. We use Ubuntu 20.04 here, because it has a later CMake than 3.13 built into its apt-get repositories.

Caution

Ubuntu 18.04 (Bionic Beaver) has a too old CMake (3.10) as part of its default apt-get repositories. If you wish to use Bionic, you must install CMake directly from its website.

We provide 3 different binary versions of our SDK libraries for Linux, compiled with these compilers:

AMD64

ARM64

GCC

7.5

8.2

Clang

10

N/A

You should use the same or a newer GCC or Clang version, to ensure the ABI’s are compatible.

Note

In contrast to our Windows releases, we provide only a Release build of our libraries on Linux. Since GCC / Clang allows linking between libraries built using Debug and Release configurations.

Get the ImageSDK#

Getting a copy of the ImageSDK library files is a straightforward process. Simply fill out the request form to get access to the download.

ImageSDK Download

We will return to you with a link where you can download the ImageSDK library version you need. This documentation pertains to the release: 4.1.57.

Set up Your Project#

Continue here once your download request has been processed and you have the ImageSDK in your possession.

Create a project directory and name it something like hello_world. This folder will serve as the home for your sample project, including the ImageSDK library you downloaded.

$ mkdir hello_world
$ cd hello_world

Unzip the ImageSDK archive into your hello_world project directory.

Source Code#

Now, let us add some example code that calls the ImageSDK. Create a new (empty) text file called main.cpp. Open the file in your favorite text editor and insert this content:

#include <iostream>
#include <P1Image.hpp>

int main(int argc, const char** argv)
{
   // Sensor data required by ImageSdk
   P1::ImageSdk::SetSensorProfilesLocation("./SensorProfiles");

   std::cout << "Open IIQ file" << std::endl;

   // Open an IIQ-file (edit the name and path to an IIQ-file)     
   P1::ImageSdk::RawImage iiq("input-file.iiq");

   // Setup a convert config with the description about how to convert image into Rgb domain
   P1::ImageSdk::ConvertConfig config;
   config.SetOutputScale(.25);

   std::cout << "Do the conversion..." << std::endl;
   P1::ImageSdk::BitmapImage bitmap = iiq.Convert(config);

   std::cout << "Write image to tiff file..." << std::endl;
   // The resulting bitmap can now be stored to a tiff file.   
   P1::ImageSdk::TiffConfig tiff;
   P1::ImageSdk::TiffWriter("output-file.tiff", bitmap, iiq, tiff);

   std::cout << "Done!" << std::endl;
   return 0;
}

CMake File#

Still inside the hello_world directory, create a new text file called CMakeLists.txt and insert this content:

 1cmake_minimum_required(VERSION 3.13)
 2
 3# Add FetchContent functionality
 4include(FetchContent)
 5
 6project(P1SdkProject)
 7
 8# SDK Major version
 9set(SDK_MAJOR_VERSION "4")
10
11# System name (lower case)
12string(TOLOWER ${CMAKE_SYSTEM_NAME} SYSTEM_NAME_LC)
13
14# File format extension
15if(WIN32)
16set(SDK_PACKAGE_EXT ".zip")
17else()
18set(SDK_PACKAGE_EXT ".tgz")
19endif()
20
21# Account for ARM based linux systems
22if(NOT APPLE AND UNIX AND CMAKE_SYSTEM_PROCESSOR STREQUAL "aarch64")
23set(LINUX_ARCH "-arm64")
24else()
25set(LINUX_ARCH "")
26endif()
27
28# Assume ImageSDK folder is in same directory as this CMakelists.txt file
29find_package(ImageSDK CONFIG REQUIRED HINTS ${CMAKE_CURRENT_LIST_DIR}/ImageSDK)
30
31## Add sample executable
32
33add_executable(hello_world main.cpp)
34
35## Link dynamic with ImageSDK
36
37target_link_libraries(hello_world PRIVATE
38    ImageSDK::ImageSdkCpp
39)
40
41if(WIN32)
42   #Copy ImageSDK DLL / SO file to build directory
43   add_custom_command(TARGET hello_world POST_BUILD
44      COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:ImageSDK::ImageSdkCpp> $<TARGET_FILE_DIR:hello_world>
45   )
46   #Copy Stitching & Stacking libraries deps - needed only if you call stitching or stacking APIs
47   add_custom_command(TARGET hello_world POST_BUILD
48      COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_LIST_DIR}/ImageSDK/lib/libifcoremd.dll $<TARGET_FILE_DIR:hello_world>
49      COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_LIST_DIR}/ImageSDK/lib/libifportmd.dll $<TARGET_FILE_DIR:hello_world>
50      COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_LIST_DIR}/ImageSDK/lib/libmmd.dll $<TARGET_FILE_DIR:hello_world>
51      COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_LIST_DIR}/ImageSDK/lib/P1CIRSTACK.dll $<TARGET_FILE_DIR:hello_world>
52      COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_LIST_DIR}/ImageSDK/lib/Qt5Core.dll $<TARGET_FILE_DIR:hello_world>
53   )
54endif()
55
56# Copy the directory where the sensor profiles are located
57# to where you program is executed (its current working dir.)
58add_custom_command(TARGET hello_world POST_BUILD
59   COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_LIST_DIR}/ImageSDK/SensorProfiles $<TARGET_FILE_DIR:hello_world>/SensorProfiles
60   COMMENT "Copy 'SensorProfiles' to build directory"
61)

The CMake project file assumes that ImageSDK is located in the same directory as the CMakeLists.txt file itself.

In short, everything above line 27 determines the correct library files to use for Windows, Linux, and Linux ARM64 systems.

Below line 27, we define our executable (called hello_world) and specify that it should link dynamically with ImageSDK. Below line 40, we instruct CMake to copy all the runtime dependencies to the target output directory.

Note

On Linux, CMake automatically builds our executable with an embedded RPATH that points to the SDK library files inside the project directory. The RPATH will ensure the executable works without requiring any file copying, as long as we run within the development setup.

Build & Run#

By CMake convention, we should create a new directory called build, inside our project folder. Therefore, cd into this new build directory, before running two cmake commands to configure CMake, and compile the project:

$ mkdir build
$ cd build
$ cmake ..
$ cmake --build .

The first cmake command tells CMake to generate a target build system project, from our CMakeLists.txt file. The second cmake command triggers CMake to build the project using that target build system.

Tip

On Windows the default target build system is Visual Studio projects. When you run cmake .. a .vcxproj is created for the executable in our project. Then the cmake --build command will trigger the MSBuild tool, to build the Visual Studio project.

On Linux the default target build system is Unix Makefiles. When cmake .. is run, Makefiles are created from your CMake project file. The second command cmake --build simply triggers the make command.

Lastly, let’s run the hello_world application. You should see something similar to this:

$ ./hello_world
Open IIQ file
Do the conversion...
Write image to tiff file...
Done!
$

PS> .\\Debug\\hello_world.exe
Open IIQ file
Do the conversion...
Write image to tiff file...
Done!
PS>

Notice, that the location of the executable file differs between the target build systems. Visual Studio likes to position the binary inside a directory named after the compile configuration.