markdown 使用Visual Studio构建RealSense SDK 2（librealsense2）

Posted 2021-05-06

Building RealSense SDK v2.10.2 (librealsense v2.10.2) with Visual Studio
========================================================================

Download
--------
1. RealSense SDK v2.10.2 (librealsense-2.10.2.zip)をダウンロードしてファイルを解凍する。(C:\librealsense-2.10.2)  
   <https://github.com/IntelRealSense/librealsense/releases/tag/v2.10.2>  


CMake  
-----
1. ソースコードの入力先とソリューションファイルの出力先を指定する。  
    * **Where is the source code:**         C:\librealsense-2.10.2  
    * **Where is build the binaries:**      C:\librealsense-2.10.2\build  

2. [Configure]を押してターゲットとなるVisual Studioを選択する。  

3. 各種設定を行う。  
    **BUILD**  
    * **BUILD_EXAMPLES**                    ☑ (check)  
    * **BUILD_GRAPHICAL_EXAMPLES**          ☑ (check)  
    * **BUILD_WITH_STATIC_CRT**             ☐ (uncheck)  
    * **BUILD_SHARED_LIBS**                 ☐ (uncheck)  
    * **BUILD_UNIT_TESTS**                  ☐ (uncheck)  
    * **BUILD_WITH_OPENMP**                 ☑ (check)  
    
    **CMAKE**
    * **CMAKE_CONFIGURATION_TYPES**         Debug;Release  
    * **CMAKE_INSTALL_PREFIX**              C:/Program Files/librealsense2 (or C:/Program Files (x86)/librealsense2)  

<sup>* BUILD_WITH_OPENMPをONにするとYUYVからRGBへの色空間の変換やRGB-Dの位置合わせを高速に処理できるが、CPU使用率が非常に高くなる。YUYVからRGBへの色空間の変換に関しては、librealsense2ではなくOpenCVで変換することで回避できることが知られている。詳細は[こちら](https://gist.github.com/UnaNancyOwen/d7df70bddf4ae8fa4f812c64e743b7e6)を参照してください。</sup>  

<sup>* RealSense Viewerなどのツール類が不要な場合、BUILD_EXAMPLESとBUILD_GRAPHICAL_EXAMPLESをOFFにする。</sup>  


4. [Add Entry]を押して以下の設定を追加する。  
    <table>
      <tr>
        <td>Name:</td>
        <td>CMAKE_DEBUG_POSTFIX</td>
      </tr>
      <tr>
        <td>Type:</td>
        <td>STRING</td>
      </tr>
      <tr>
        <td>Value:</td>
        <td>_d</td>
      </tr>
      <tr>
        <td>Description:</td>
        <td></td>
      </tr>
    </table>  

<sup>* Debugビルドの生成ファイルのファイル名(最後尾)に付加する文字列。</sup>  


5. [Generate]を押してソリューションファイルを出力する。  


Build
-----
1. Visual Studioを管理者権限で起動してRealSense SDK2 (librealsense2)のソリューションファイル(C:\librealsense-2.10.2\build\librealsense2.sln)を開く。  
   (Visual Studioを管理者権限で起動しないとINSTALLが失敗する。)  

2. RealSense SDK2 (librealsense2)をビルドする。(ALL_BUILD)  
    1. ソリューションの構成(Debug, Release)を設定する。  
    2. ソリューションエクスプローラーからALL_BUILDプロジェクトを選択する。  
    3. [ビルド]>[ソリューションのビルド]を押してRealSense SDK2 (librealsense2)をビルドする。  

3. RealSense SDK2 (librealsense2)をインストールする。(INSTALL)
    1. ソリューションエクスプローラーからINSTALLプロジェクトを選択する。  
    2. [ビルド]>[プロジェクトのみ]>[INSTALLのみをビルド]を押してRealSense SDK2 (librealsense2)をインストールする。  
       **CMAKE_INSTALL_PREFIX**で指定した出力先へ必要なファイルがコピーされる。  


Environment Variable
--------------------
1. 環境変数**realsense2_DIR**を作成してRealSense SDK2 (librealsense2)のパス(C:\Program Files\librealsense2)を設定する。  

2. 環境変数**Path**に;%realsense2_DIR%\binを追加する。  

Building RealSense SDK v2.10.1 (librealsense v2.10.1) with Visual Studio
========================================================================

Download
--------
1. RealSense SDK 2.10.1 (librealsense-2.10.1.zip)をダウンロードしてファイルを解凍する。(C:\librealsense-2.10.1)  
   <https://github.com/IntelRealSense/librealsense/releases/tag/v2.10.1>  

2. 以下の変更を適用する。(Pull Request #1262)  
  [Add BUILD_WITH_STATIC_CRT option #1262 | librealsense](https://github.com/IntelRealSense/librealsense/pull/1262)  


CMake  
-----
1. ソースコードの入力先とソリューションファイルの出力先を指定する。  
    * **Where is the source code:**         C:\librealsense-2.10.1  
    * **Where is build the binaries:**      C:\librealsense-2.10.1\build  

2. [Configure]を押してターゲットとなるVisual Studioを選択する。  

3. 各種設定を行う。  
    **Ungrouped Entries**  
    * **RGB_USING_AVX2**                    ☑ (check)  
    
    **BUILD**  
    * **BUILD_EXAMPLES**                    ☑ (check)  
    * **BUILD_GRAPHICAL_EXAMPLES**          ☑ (check)  
    * **BUILD_WITH_STATIC_CRT**             ☐ (uncheck)  
    * **BUILD_SHARED_LIBS**                 ☐ (uncheck)  
    * **BUILD_UNIT_TESTS**                  ☐ (uncheck)  
    * **BUILD_WITH_OPENMP**                 ☑ (check)  
    
    **CMAKE**
    * **CMAKE_CONFIGURATION_TYPES**         Debug;Release  
    * **CMAKE_INSTALL_PREFIX**              C:/Program Files/librealsense2 (or C:/Program Files (x86)/librealsense2)  

<sup>* BUILD_WITH_OPENMPをONにするとYUYVからRGBへの色空間の変換やRGB-Dの位置合わせを高速に処理できるが、CPU使用率が非常に高くなる。YUYVからRGBへの色空間の変換に関しては、librealsense2ではなくOpenCVで変換することで回避できることが知られている。詳細は[こちら](https://gist.github.com/UnaNancyOwen/d7df70bddf4ae8fa4f812c64e743b7e6)を参照してください。</sup>  

<sup>* RealSense Viewerなどのツール類が不要な場合、BUILD_EXAMPLESとBUILD_GRAPHICAL_EXAMPLESをOFFにする。</sup>  


4. [Add Entry]を押して以下の設定を追加する。  
    <table>
      <tr>
        <td>Name:</td>
        <td>CMAKE_DEBUG_POSTFIX</td>
      </tr>
      <tr>
        <td>Type:</td>
        <td>STRING</td>
      </tr>
      <tr>
        <td>Value:</td>
        <td>_d</td>
      </tr>
      <tr>
        <td>Description:</td>
        <td></td>
      </tr>
    </table>  

<sup>* Debugビルドの生成ファイルのファイル名(最後尾)に付加する文字列。</sup>  


5. [Generate]を押してソリューションファイルを出力する。  


Build
-----
1. Visual Studioを管理者権限で起動してRealSense SDK2 (librealsense2)のソリューションファイル(C:\librealsense-2.10.1\build\librealsense2.sln)を開く。  
   (Visual Studioを管理者権限で起動しないとINSTALLが失敗する。)  

2. RealSense SDK2 (librealsense2)をビルドする。(ALL_BUILD)  
    1. ソリューションの構成(Debug, Release)を設定する。  
    2. ソリューションエクスプローラーからALL_BUILDプロジェクトを選択する。  
    3. [ビルド]>[ソリューションのビルド]を押してRealSense SDK2 (librealsense2)をビルドする。  

3. RealSense SDK2 (librealsense2)をインストールする。(INSTALL)
    1. ソリューションエクスプローラーからINSTALLプロジェクトを選択する。  
    2. [ビルド]>[プロジェクトのみ]>[INSTALLのみをビルド]を押してRealSense SDK2 (librealsense2)をインストールする。  
       **CMAKE_INSTALL_PREFIX**で指定した出力先へ必要なファイルがコピーされる。  


Environment Variable
--------------------
1. 環境変数**realsense2_DIR**を作成してRealSense SDK2 (librealsense2)のパス(C:\Program Files\librealsense2)を設定する。  

2. 環境変数**Path**に;%realsense2_DIR%\binを追加する。