Merge pull request #123 from xmos/release/v0.20.0

Release/v0.20.0

.github/workflows/ci.yml

@@ -28,66 +28,72 @@ env:
   SDK_BUILDER_IMAGE: 'ghcr.io/xmos/sdk_app_builder:develop'
 
 jobs:
-  build_examples:
-    name: Build example applications
+  build_host_apps:
+    name: Build host applications
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout SDK
-        uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
           submodules: recursive
 
-      - name: Pull SDK builder image
+      - name: Pull SDK builder
         run: |
           docker pull ${SDK_BUILDER_IMAGE}
 
       - name: Build
         run: |
-          docker run --user $(id -u) --rm -w /sln_voice -v ${{github.workspace}}:/sln_voice ${SDK_BUILDER_IMAGE} bash -l tools/ci/build_examples.sh
-
-      - name: Save metadata
-        run: |
-          bash tools/ci/log_metadata.sh ./dist/examples_metadata.json
+          docker run --rm -w /xcore_sdk -v ${{github.workspace}}:/xcore_sdk ${SDK_BUILDER_IMAGE} bash -l tools/ci/build_host_apps.sh
 
-      - name: Save example app firmware artifacts
+      - name: Upload artifacts
         uses: actions/upload-artifact@v3
         with:
-          name: sln_voice_example_apps
-          path: ./dist/*
+          name: host_apps
+          path: ./dist_host
 
-  build_applications:
-    name: Build reference applications
+  build_examples:
+    name: Build example applications
     runs-on: ubuntu-latest
+    needs: build_host_apps
     steps:
       - name: Checkout SDK
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: recursive
 
       - name: Pull SDK builder image
         run: |
           docker pull ${SDK_BUILDER_IMAGE}
 
+      - name: Download host build artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: host_apps
+          path: ./dist_host
+
       - name: Build
         run: |
-          docker run --user $(id -u) --rm -w /sln_voice -v ${{github.workspace}}:/sln_voice ${SDK_BUILDER_IMAGE} bash -l tools/ci/build_applications.sh
+          docker run --user $(id -u) --rm -w /sln_voice -v ${{github.workspace}}:/sln_voice ${SDK_BUILDER_IMAGE} bash -l tools/ci/build_examples.sh
 
       - name: Save metadata
         run: |
-          bash tools/ci/log_metadata.sh ./dist/applications_metadata.json
+          bash tools/ci/log_metadata.sh ./dist/examples_metadata.json
 
-      - name: Save reference app firmware artifacts
+      - name: Save example app firmware artifacts
         uses: actions/upload-artifact@v3
         with:
-          name: sln_voice_reference_apps
-          path: ./dist/*
+          name: sln_voice_example_apps
+          path: |
+            ./dist/*.xe
+            ./dist/*.fs
+            ./dist/*.json
 
   build_tests:
     name: Build tests and test applications
     runs-on: ubuntu-latest
     steps:
       - name: Checkout SDK
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: recursive
 
@@ -103,8 +109,10 @@ jobs:
         run: |
           bash tools/ci/log_metadata.sh ./dist/tests_metadata.json
 
-      - name: Save reference app firmware artifacts
+      - name: Save example application firmware artifacts
         uses: actions/upload-artifact@v3
         with:
           name: sln_voice_test_apps
-          path: ./dist/*
+          path: |
+            ./dist/*.xe
+            ./dist/*.json

.github/workflows/docs.yml

@@ -25,15 +25,15 @@ on:
   workflow_dispatch: {}
 
 env:
-  DOC_BUILDER_IMAGE: 'ghcr.io/xmos/doc_builder:main'
+  DOC_BUILDER_IMAGE: 'ghcr.io/xmos/doc_builder:latest'
 
 jobs:
   build_documentation:
     name: Build and package documentation
     runs-on: ubuntu-latest
     steps:
       - name: Checkout SDK
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: recursive
 

.gitignore

@@ -22,6 +22,8 @@
 *.xmt
 **/_build/
 **/build_*/
+**/dist*/
+**/dist_host*/
 !doc/tutorials/build_system/
 **/run_*.log
 **/_doxygen/*

CHANGELOG.rst

@@ -1,12 +1,22 @@
 XCORE-VOICE change log
 ======================
 
+0.20.0
+------
+
+  * ADDED: Audio response playback
+  * ADDED: Wanson 20220923 model update
+  * ADDED: Documentation updates
+  * FIXED: USB audio device is now recognized on Windows
+  * FIXED: Applications moved to examples folder
+  * FIXED: Sample rate conversion from 48k fixed
+
 0.12.0
 ------
 
   * ADDED: Audio playback to FFD application
   * ADDED: First draft of documentation
-  * KNOWN ISSUE: USB audio device is not recognized on Windows.  This Does not effect FFD.
+  * KNOWN ISSUE: USB audio device is not recognized on Windows  (This does not effect FFD)
 
 0.10.0
 ------

CMakeLists.txt

@@ -19,7 +19,6 @@ add_subdirectory(xcore_sdk)
 
 ## Add top level project targets
 if(PROJECT_IS_TOP_LEVEL)
-    include(applications/applications.cmake)
     include(examples/examples.cmake)
 endif()
 

README.md

@@ -17,11 +17,11 @@ Some dependent components are included as git submodules. These can be obtained
 
 ## Documentation
 
-See the READMEs for the early applications:
+See the READMEs for the early example applications:
 
-[FFD](https://github.com/xmos/sln_voice/blob/develop/applications/ffd/README.rst)
+[FFD](https://github.com/xmos/sln_voice/blob/develop/examples/ffd/README.md)
 
-[STLP](https://github.com/xmos/sln_voice/blob/develop/applications/stlp/README.rst)
+[STLP](https://github.com/xmos/sln_voice/blob/develop/examples/stlp/README.md)
 
 # Getting Help
 
@@ -33,5 +33,5 @@ This Software is subject to the terms of the [XMOS Public Licence: Version 1](ht
 
 Additional third party copyrighted code is included under the following licenses:
 
-The Wanson speech recognition library is `Copyright 2022. Shanghai Wanson Electronic Technology Co.Ltd ("WANSON")` and is subject to the [Wanson Restrictive License](https://github.com/xmos/sln_voice/tree/develop/applications/ffd/inference/wanson/lib/LICENSE.md).
+The Wanson speech recognition library is `Copyright 2022. Shanghai Wanson Electronic Technology Co.Ltd ("WANSON")` and is subject to the [Wanson Restrictive License](https://github.com/xmos/sln_voice/tree/develop/examples/ffd/inference/wanson/lib/LICENSE.md).