kdu_perf

Overview

kdu_perf tests the in-memory performance of the kdu_supp::kdu_stripe_decompressor class exposed by the Kakadu SDK.

NOTE: The #define _DECODER_WANTS_STREAMING_STORES macro found in the coresys/coding/avx2_coder_local.cpp source file of the Kakadu SDK may need to be commented out to achieve best performance on low latency HTJ2K codestreams.

IMPORTANT: While kdu_perf is published under an open-source license, the Kakadu SDK is a commercial library licensed under a restrictive license. The kdu_perf license does not extend to the Kakadu SDK and a separate license for Kakadu SDK must be obained.

Prerequisites

• Kakadu SDK library files (version 8.4.1+)
• C++11 toolchains
• CMake

Quick start

git clone --recurse-submodules https://github.com/sandflow/kdu-perf.git
cd kdu-perf
mkdir build
cd build
cmake -DKDU_LIBRARY=<path to libkdu_v84R.so> \
      -DKDU_AUX_LIBRARY=<path to libkdu_a84R.so> \
      -DKDU_INCLUDE_DIR=<path to Kakadu SDK include headers> \
      ..
ctest
./kdu_perf ../src/test/resources/codestreams/ht.j2c

Usage

kdu_perf [OPTION...] <path to j2c codestream>

-r, --repetitions arg  Number of repetitions per thread (default: 100)
-t, --threads arg      Number of threads (default: 1)

CMake Examples

Linux

cmake \
-DKDU_LIBRARY=~/software/kdu-sdk/v8_4_1-01908E/lib/Linux-x86-64-gcc/libkdu_v84R.so \
-DKDU_AUX_LIBRARY=~/software/kdu-sdk/v8_4_1-01908E/lib/Linux-x86-64-gcc/libkdu_a84R.so \
-DKDU_INCLUDE_DIR=~/software/kdu-sdk/v8_4_1-01908E/managed/all_includes \
..

Windows

cmake -DKDU_LIBRARY=../../kdu-sdk/lib_x64/kdu_v84R.lib -DKDU_AUX_LIBRARY=../../kdu-sdk/lib_x64/kdu_a84R.lib -DKDU_INCLUDE_DIR=../../kdu-sdk/v8_4_1-01908E/managed/all_includes ..

Mac

cmake \
-DKDU_LIBRARY=~/software/kdu-sdk/v8_4_1-01908E/lib/Mac-arm-64-gcc/libkdu_v84R.so \
-DKDU_AUX_LIBRARY=~/software/kdu-sdk/v8_4_1-01908E/lib/Mac-arm-64-gcc/libkdu_a84R.so \
-DKDU_INCLUDE_DIR=~/software/kdu-sdk/v8_4_1-01908E/managed/all_includes \
..

Mac (Xcode)

cmake \
-G Xcode \
-DKDU_LIBRARY=~/software/kdu-sdk/v8_4_1-01908E/lib/Mac-arm-64-gcc/libkdu_v84R.so \
-DKDU_AUX_LIBRARY=~/software/kdu-sdk/v8_4_1-01908E/lib/Mac-arm-64-gcc/libkdu_a84R.so \
-DKDU_INCLUDE_DIR=~/software/kdu-sdk/v8_4_1-01908E/managed/all_includes \
..