Removing forced-loading of depthengine library. Just load k4a.dll and…

… let it load the depth engine.

Fixing markdown formatting.

src/python/k4a/build_wheel.csh

@@ -22,13 +22,13 @@ DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )"
 # to manually copy them into the _libs/ folder.
 if [ ! -f "$DIR/src/k4a/_libs/libk4a.so" ] && [ ! -h "$DIR/src/k4a/_libs/libk4a.so" ]; then
     echo "File not found: $DIR/src/k4a/_libs/libk4a.so"
-    echo "Please manually copy the library into that folder."
+    echo "Please manually copy the k4a library into that folder."
     return 1
 fi
 
-if [ ! -f "$DIR/src/k4a/_libs/libdepthengine.so" ] && [ ! -h "$DIR/src/k4a/_libs/libdepthengine.so" ]; then
-    echo "File not found: $DIR/src/k4a/_libs/libdepthengine.so"
-    echo "Please manually copy the library into that folder."
+if [ ! -f "$DIR/src/k4a/_libs/libdepthengine*" ] && [ ! -h "$DIR/src/k4a/_libs/libdepthengine*" ]; then
+    echo "File not found: $DIR/src/k4a/_libs/libdepthengine*"
+    echo "Please manually copy the depth engine library into that folder."
     return 1
 fi
 

src/python/k4a/build_wheel.ps1

@@ -5,13 +5,13 @@
 # to manually copy them into the _libs/ folder.
 If (-not (Test-Path -Path "$PSScriptRoot\src\k4a\_libs\k4a.dll")) {
     Write-Host "File not found: $PSScriptRoot\src\k4a\_libs\k4a.dll"
-    Write-Host "Please manually copy the dll into that folder."
+    Write-Host "Please manually copy the k4a library into that folder."
     exit 1
 }
 
-If (-not(Test-Path -Path "$PSScriptRoot\src\k4a\_libs\depthengine.dll")) {
-    Write-Host "File not found: $PSScriptRoot\src\k4a\_libs\depthengine.dll"
-    Write-Host "Please manually copy the dll into that folder."
+If (-not(Test-Path -Path "$PSScriptRoot\src\k4a\_libs\depthengine*.dll")) {
+    Write-Host "File not found: $PSScriptRoot\src\k4a\_libs\depthengine*.dll"
+    Write-Host "Please manually copy the depth engine library into that folder."
     exit 1
 }
 

src/python/k4a/docs/building.md

@@ -28,7 +28,7 @@ The following dependencies are for both Windows and Linux:
 
 * [k4a library](../../../../docs/building.md)
   The k4a library can be built from the repository or the SDK can be downloaded
-  for the binary. The Windows library is k4a.dll, and the Linux library is k4a.so.
+  for the binary. The Windows library is k4a.dll, and the Linux library is libk4a.so.
   The k4a binary needs to be copied to the host system and added 
   to the path src/python/k4a/src/k4a/_libs in this repository before building.
 
@@ -47,62 +47,49 @@ The following tools are optional:
 
 ### Building using a powershell script (Windows)
 
-1. Copy the k4a and DE binaries into the folder src/python/k4a/src/k4a/_libs.
-   The file names MUST be k4a.dll and depthengine.dll. 
+1. Copy the k4a and DE binaries into the folder src/python/k4a/src/k4a/_libs. 
+   The file name for the k4a library MUST be k4a.dll.
 
-   Note: To create a cross-platform wheel, the .dll for Windows and the .so for Linux need to
-         copied into the folder.
-   Note: If the dlls have different names, create a symlink with relative redirection. This may
-         require elevated permissions to create the symlink as well as run build_wheel.ps1.
-   Note: If the .so have different names, create a symlink with relative redirection. This may
-         require elevated permissions to create the symlink as well as run build_wheel.csh.
+    >**Note:** To create a cross-platform wheel, the .dll for Windows and the .so for Linux need to
+    >copied into the folder. Python will look for "k4a.dll" in Windows and "libk4a.so" in Linux.
 
 2. In a powershell terminal, run the script src/python/k4a/build_wheel.ps1.
    This will create the .whl file in a build/ folder.
 
 ### Building using a bash script (Linux)
 
 1. Copy the k4a and DE binaries into the folder src/python/k4a/src/k4a/_libs.
-   The file names MUST be libk4a.so and libdepthengine.so.
+   The file name for the k4a library MUST be libk4a.so.
 
-   Note: To create a cross-platform wheel, the .dll for Windows and the .so for Linux need to
-         copied into the folder.
-   Note: If the dlls have different names, create a symlink with relative redirection. This may
-         require elevated permissions to create the symlink as well as run build_wheel.ps1.
-   Note: If the .so have different names, create a symlink with relative redirection. This may
-         require elevated permissions to create the symlink as well as run build_wheel.csh.
+    >**Note:** To create a cross-platform wheel, the .dll for Windows and the .so for Linux need to
+    >copied into the folder. Python will look for "k4a.dll" in Windows and "libk4a.so" in Linux.
 
 2. In a terminal, source the script src/python/k4a/build_wheel.csh.
    This will create the .whl file in a build/ folder.
 
-   cd <repo_root>/src/python/k4a
-   source build_wheel.csh
+    `cd <repo_root>/src/python/k4a`  
+    `source build_wheel.csh`  
 
 ### Building using a command line terminal (cross platform)
 
 1. Copy the k4a and DE binaries into the folder src/python/k4a/src/k4a/_libs.
-   The file names MUST be k4a.dll and depthengine.dll in Windows, and
-   the file names MUST be libk4a.so and libdepthengine.so in Linux.
+   The file names for the k4a library MUST be k4a.dll (for Windows) and libk4a.so (for Linux).
 
-   Note: To create a cross-platform wheel, the .dll for Windows and the .so for Linux need to
-         copied into the folder.
-   Note: If the dlls have different names, create a symlink with relative redirection. This may
-         require elevated permissions to create the symlink as well as run build_wheel.ps1.
-   Note: If the .so have different names, create a symlink with relative redirection. This may
-         require elevated permissions to create the symlink as well as run build_wheel.csh.
+    >**Note:** To create a cross-platform wheel, the .dll for Windows and the .so for Linux need to
+    >copied into the folder. Python will look for "k4a.dll" in Windows and "libk4a.so" in Linux.
 
 2. In a command line terminal, create a Python virtual environment and activate it (do not include brackets):
-      cd <repo_root>/src/python/k4a
-      python -m venv <env_name>
-      ./<env_name>/Scripts/activate
+    `cd <repo_root>/src/python/k4a`  
+    `python -m venv <env_name>`  
+    `./<env_name>/Scripts/activate`  
 
 3. Build the .whl file and place it in a build/ folder.
-      pip install wheel
-      pip wheel . -w build
+    `pip install wheel`  
+    `pip wheel . -w build`  
 
-4. Deactivate the virtual environment and delete it.
-      ./<env_name>/Scripts/deactivate.bat
-      Delete the directory <env_name>
+4. Deactivate the virtual environment and delete it.  
+    `./<env_name>/Scripts/deactivate.bat`  
+    Delete the directory `<env_name>`.
 
 ### Building the HTML Documentation
 
@@ -118,6 +105,6 @@ The wheel file can be distributed and installed as follows.
 
 1. In a command line terminal, install the k4a python library via pip.
    Replace <k4a*.whl> with the name of the wheel file.
-      pip install <k4a*.whl>
+    `pip install <k4a*.whl>`
 
 Once installed, the user can "import k4a" in their python code.

src/python/k4a/docs/examples.md

@@ -28,20 +28,23 @@ A simple program to showcase the basic functions in the Azure Kinect API.
 
 Additional Prerequisites: None
 
-To run, open a command terminal and type: python the_basics.py
+To run, open a command terminal and type:  
+`python the_basics.py`  
+
 The expected output is a print out on the terminal of the device, capture, and image properties.
 
 ### image_transformations.py
 
 A simple program to showcase the image transformation functions in the Azure Kinect API.
 
 Additional Prerequisites: 
-    Matplotlib installed via pip:  pip install matplotlib
-    Numpy installed via pip:       pip install numpy==1.18.5
+    - Matplotlib installed via pip:  pip install matplotlib
+    - Numpy installed via pip:       pip install numpy==1.18.5
 
 Note that numpy version 1.19.5 currently has a bug for Windows, so do not use it as of 2020/12/28.
 
-To run, open a command terminal and type: python image_transformations.py
+To run, open a command terminal and type:  
+`python image_transformations.py`
 
 The program transforms a color image into the depth camera space and displays the images in a figure.
 Close the figure to proceed.
@@ -57,9 +60,10 @@ Close the figure to proceed and the program exits.
 A simple program to continuously capture images from an Azure Kinect device and display the images.
 
 Additional Prerequisites:
-    Matplotlib installed via pip:  pip install matplotlib
+    - Matplotlib installed via pip:  pip install matplotlib
 
-To run, open a command terminal and type: python simple_viewer.py
+To run, open a command terminal and type:  
+`python simple_viewer.py`  
 
 The program creates a figure and continuously displays the captured images on the figure.
 Close the figure to end the program.

src/python/k4a/docs/testing.md

@@ -22,38 +22,33 @@ The following are required in order to run the Python K4A tests.
 ### Setting up the test environment
 
 1. Copy the k4a and DE dynamic libraries (.dll or .so) into the folder src/python/k4a/src/k4a/_libs. 
-The file names MUST be k4a.dll and depthengine.dll in Windows, and
-the file names MUST be libk4a.so and libdepthengine.so in Linux.
-
-Note: If the libraries have different names, create a symlink with relative redirection. This may
-      require elevated permissions to create the symlinks.
+   The file names for the k4a library MUST be k4a.dll (for Windows) and libk4a.so (for Linux).
 
 2. In a command line terminal, create a Python virtual environment and activate it (do not include brackets):
-      cd <repo_root>/src/python/k4a
-      python -m venv <env_name>
+    `cd <repo_root>/src/python/k4a`  
+    `python -m venv <env_name>`  
 
-      Windows:
-      .\<env_name>\Scripts\activate
+    Windows:  
+    `.\<env_name>\Scripts\activate`  
 
-      Ubuntu:
-      source ./<env_name>/bin/activate
+    Ubuntu:  
+    `source ./<env_name>/bin/activate`  
 
 3. Install the k4a package in development mode. This is required in order to
    automatically install required Python packages for running the tests, as
    well as to install the code with the k4a package as the root of the 
    subpackages and modules. In the command below, make sure to include 
-   ".[test]" with dot and square brackets.
-      pip install -e .[test]
+   ".[test]" with dot and square brackets.  
+    `pip install -e .[test]`
 
 ### Running unit tests on the command line
 
 Unit tests execute small pieces of code that run very fast (less than a second).
 These tests do not require any hardware to be attached.
 These tests should be run on every pull request.
 
-To run the unit tests:
-
-      python -m pytest tests -k unit
+To run the unit tests:  
+    `python -m pytest tests -k _unit_`
 
 To capture the results, use an additional --junit-xml=./test_results.xml option.
 
@@ -64,13 +59,11 @@ There are 2 types of functional tests:
     1. functional_fast - fast functional tests that should be run on every pull request.
     2. functional - more comprehensive functional tests but these may take a long time.
 
-To run the functional_fast tests:
-
-      python -m pytest tests -k functional_fast
+To run the functional_fast tests:  
+    `python -m pytest tests -k functional_fast`
 
-To run all functional tests:
-
-      python -m pytest tests -k functional
+To run all functional tests:  
+    `python -m pytest tests -k functional`
 
 To capture the results, use an additional --junit-xml=./test_results.xml option.
 
@@ -80,9 +73,8 @@ Performance tests attempt to verify the performance of the device under stress,
 such as maintaining frame rates, etc. These tests require an attached device.
 These tests should be run on every pull request.
 
-To run the performance tests:
-
-      python -m pytest tests -k perf
+To run the performance tests:   
+    `python -m pytest tests -k perf`
 
 To capture the results, use an additional --junit-xml=./test_results.xml option.
 

src/python/k4a/src/k4a/_bindings/k4a.py

@@ -33,10 +33,8 @@
     _lib_dir = _os_path.join(_os_path.dirname(_os_path.dirname(__file__)), '_libs')
 
     if _IS_WINDOWS:
-        _depthengine_lib = _ctypes.CDLL(_os_path.join(_lib_dir, 'depthengine.dll'))
         _k4a_lib = _ctypes.CDLL(_os_path.join(_lib_dir, 'k4a.dll'))
     else:
-        _depthengine_lib = _ctypes.CDLL(_os_path.join(_lib_dir, 'libdepthengine.so'))
         _k4a_lib = _ctypes.CDLL(_os_path.join(_lib_dir, 'libk4a.so'))
 
 except Exception as ee:

src/python/k4a/src/k4a/_libs/README.md

@@ -1,8 +1,10 @@
-# Required libraries should be placed here before building wheel package.
+## Required libraries should be placed here before building wheel package.  
 
-# k4a
-# DepthEngine
+  - k4a
+  - DepthEngine
 
-# The actual names may differ depending on version and platform.
-# On Windows, the libraries should be named k4a.dll and depthengine.dll.
-# On Linux, the libraries should be named libk4a.so and libdepthengine.so.
+The actual names may differ depending on version and platform.  
+
+> On Windows, the libraries should be named k4a.dll and depthengine*.dll.  
+
+> On Linux, the libraries should be named libk4a.so and libdepthengine.*