C++ Quick start
===============

Installation
------------

To integrate **iris-sdk** with C++:

* Extract the SDK zip file to somewhere in your existing source tree, for example **src/vendor/iris/iris-sdk/**
* Add the **src/vendor/iris/iris-sdk/include** directory to your header search paths
* Add the **src/vendor/iris/iris-sdk/lib** directory to your library search paths
* In your linker settings, link against all the libs in **src/vendor/iris/iris-sdk/lib**
* include the main header file

.. code-block:: cpp

  #include <Iris/Iris.h>


Building the sample code
------------------------

To build the sample application enter the following commands in the sdk sample root directory

.. code-block:: console

  cmake -B build -DCMAKE_BUILD_TYPE=Release
  cmake --build build --config=Release

Running the sample code
-----------------------

To run the sample application:

.. code-block:: console

  ./build/iris-sdk-sample


View the sample code results
----------------------------
The example application reads in the file **res/breaking_point_f32_48k.raw**, processes it and writes the result to **res/breaking_point_f32_48k_processed.raw**.

These raw files can be opened in audacity or any application that supports header-less raw audio files.

Open audacity and import raw data -> encoding 32 bit float / sample rate 48000

.. note::
  To generate a Visual Studio project from the sample code through cmake run:

  **cmake -B build -G "Visual Studio 17 2022"** or just open the project root folder.

  To generate an Xcode project from the above code through cmake run:

  **cmake -B build -G "Xcode"**