ONNX open source and update license terms (#32)

ONNX open source and update license terms

Author: Ziyi6

LICENSE

@@ -0,0 +1,47 @@
+Open Source License
+
+The ten-vad is licensed pursuant to the Apache License v2.0, with the
+following additional conditions. You may reproduce, prepare Derivative Works
+of, publicly display, publicly perform, sublicense, distribute, or otherwise
+make available (together, "Deploy") the ten-vad, for commercial or
+non-commercial purposes, provided that you agree to abide by the terms below:
+
+    1. You may not Deploy the ten-vad in a way that competes with Agora's
+       offerings and/or that allows others to compete with Agora's offerings,
+       including without limitation enabling any third party to develop or
+       deploy Applications.
+    
+    2. You may Deploy the ten-vad solely to create and enable deployment
+       of your Application(s) solely for your benefit and the benefit of your
+       direct End Users. If you prefer, you may include the following notice in
+       the documentation of your Application(s): "Powered by ten-vad".
+
+    3. Derivative Works of the ten-vad remain subject to this Open Source
+       License.
+
+    4. "End Users" shall mean the end-users of your Application(s) who access
+       the ten-vad solely to the extent necessary to access and use the
+       Application(s) you create or deploy using ten-vad.
+
+    5. "Application(s)" shall mean your software programs designed or developed
+       by using the ten-vad or where deployment is enabled by the ten-vad.
+
+  Copyright © 2025 Agora
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+=======================================================================================
+
+  Note that the project contains derived code from other open source project
+  with BSD-3-Clause and BSD-2-Clause license, refer to the "NOTICES" 
+  file in the root directory for detailed information.

NOTICES

@@ -0,0 +1,68 @@
+This project includes modified code from the following third-party component:
+
+1. File: lpcnet_enc.c
+   - Source: LPCNet (https:github.com/xiph/LPCNet)
+   - License: BSD-2-Clause
+   - Copyright: 2017-2019, Mozilla
+   - Original License Text:
+        Copyright (c) 2017-2019 Mozilla
+
+        Redistribution and use in source and binary forms, with or without modification,
+        are permitted provided that the following conditions are met:
+
+        - Redistributions of source code must retain the above copyright notice, 
+          this list of conditions and the following disclaimer.
+
+        - Redistributions in binary form must reproduce the above copyright notice,
+          this list of conditions and the following disclaimer in the documentation
+          and/or other materials provided with the distribution.
+
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+        ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+        LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+        A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
+        CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+        EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+        PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+        PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+        LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+        NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+2. Project: LPCNet
+    - Source: LPCNet (https:github.com/xiph/LPCNet)
+    - License: BSD-3-Clause
+    - Copyright: 2017-2018, Mozilla, 2007-2017, Jean-Marc Valin, 2005-2017, Xiph.Org Foundation, 2003-2004, Mark Borgerding
+    - Original License Text of LPCNet open source project:
+        Copyright (c) 2017-2018, Mozilla
+        Copyright (c) 2007-2017, Jean-Marc Valin
+        Copyright (c) 2005-2017, Xiph.Org Foundation
+        Copyright (c) 2003-2004, Mark Borgerding
+
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions
+        are met:
+
+        - Redistributions of source code must retain the above copyright
+        notice, this list of conditions and the following disclaimer.
+
+        - Redistributions in binary form must reproduce the above copyright
+        notice, this list of conditions and the following disclaimer in the
+        documentation and/or other materials provided with the distribution.
+
+        - Neither the name of the Xiph.Org Foundation nor the names of its
+        contributors may be used to endorse or promote products derived from
+        this software without specific prior written permission.
+
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+        ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+        LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+        A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION
+        OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+        SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+        LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+        DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+        THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        

README.md

@@ -14,6 +14,7 @@
 <br>
 
 *Latest News* 🔥
+- [2025/06] We **finally** released and **open-sourced** the **ONNX** model and the corresponding **preprocessing code**! Now you can deploy **TEN VAD** on **any platform** and **any hardware architecture**!
 - [2025/06] We are excited to announce the release of **WASM+JS** for Web WASM Support. 
 <br>
 
@@ -43,14 +44,13 @@
 - [TEN Ecosystem](#ten-ecosystem)
 - [Ask Questions](#ask-questions)
 - [Citations](#citations)
-- [Usage Guidance](#usage-guidance)
-- [Future Open Source Plan](#future-open-source-plan)
+- [License](#license)
 
 <br>
 
 ## Welcome to TEN 
 
-TEN is a collection of open-source projects for building real-time, multimodal conversational voice agents. It includes [ TEN Framework ](https://github.com/ten-framework/ten-framework), [ TEN Turn Detection ](https://github.com/ten-framework/ten-turn-detection), TEN Agent, TMAN Designer, and [ TEN Portal ](https://github.com/ten-framework/portal), all fully open-source. [ TEN VAD ](https://github.com/ten-framework/ten-vad) is not fully open-source yet, but it is open for public use.
+TEN is a collection of open-source projects for building real-time, multimodal conversational voice agents. It includes [ TEN Framework ](https://github.com/ten-framework/ten-framework), [ TEN VAD ](https://github.com/ten-framework/ten-vad), [ TEN Turn Detection ](https://github.com/ten-framework/ten-turn-detection), TEN Agent, TMAN Designer, and [ TEN Portal ](https://github.com/ten-framework/portal), all fully open-source.
 
 <br>
 
@@ -354,7 +354,7 @@ from ten_vad import TenVad
 
 ### **C Usage**
 #### **Build Scripts**
-Located in examples/ directory:
+Located in examples/ directory and examples_onnx (for **ONNX** usage on Linux):
 
 - Linux: build-and-deploy-linux.sh
 - Windows: build-and-deploy-windows.bat
@@ -374,7 +374,7 @@ Runtime library path configuration:
 - Configure toolchain and architecture settings
 
 #### **Overview of Usage**
-- Navigate to examples/
+- Navigate to examples/ or examples_onx/ (for **ONNX** usage on Linux)
 - Execute platform-specific build script
 - Configure dynamic library path
 - Run demo with sample audio s0724-s0730.wav
@@ -396,11 +396,20 @@ sudo apt update
 sudo apt install libc++1
 ```
 
-##### **Usage**
+##### **Usage (prebuilt-lib)**
 ```
 1) cd ./examples
 2) ./build-and-deploy-linux.sh
 ```
+
+##### **Usage (ONNX)**
+You have to download the **onnxruntime** packages from the [official website](https://github.com/microsoft/onnxruntime). Note that the version of onnxruntime must be higher than or equal to 1.17.1 (e.g. onnxruntime-linux-x64-1.17.1.tgz).
+```
+1) cd examples_onnx/
+2) ./build-and-deploy-linux.sh --ort-root /absolute/path/to/your/onnxruntime/root/dir
+```
+Note: If executing the onnx demo from a different directory than the one used when running build-and-deploy-linux.sh, ensure to create a symbolic link to src/onnx_model/ to prevent ONNX model file loading failures.
+
 <br>
 
 ####  **2. Windows**
@@ -538,32 +547,13 @@ Most questions can be answered by using DeepWiki, it is fast, intutive to use an
 ```
 <br>
 
-## Usage Guidance
+## License
 
-1. You may not Deploy the TEN VAD in a way that competes with Agora's
-   offerings and/or that allows others to compete with Agora's offerings,
-   including without limitation enabling any third party to develop or
-   deploy Applications.
-
-2. You may Deploy the TEN VAD solely to create and enable deployment
-   of your Application(s) solely for your benefit and the benefit of your
-   direct End Users. If you prefer, you may include the following notice in
-   the documentation of your Application(s): "Powered by TEN VAD".
-
-3. "End Users" shall mean the end-users of your Application(s) who access
-   the TEN VAD solely to the extent necessary to access and use the
-   Application(s) you create or deploy using TEN VAD.
-
-4. "Application(s)" shall mean your software programs designed or developed
-   by using the TEN VAD or where deployment is enabled by the TEN
-   VAD.
+This project is Apache 2.0 with additional conditions licensed. Refer to the "LICENSE" file in the root directory for detailed information. Note that `pitch_est.cc` contains modified code derived from [LPCNet](https://github.com/xiph/LPCNet), which is [BSD-2-Clause](https://spdx.org/licenses/BSD-2-Clause.html) and [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) licensed, refer to the NOTICES file in the root directory for detailed information.
 
 
 <br>
 
-## Future Open Source Plan
-
-TEN-VAD is currently released as a binary. Based on community feedback and interest, we plan to progressively open source the internal components of the binary.
 
 [back-to-top]: https://img.shields.io/badge/-Back_to_top-gray?style=flat-square
 

examples/CMakeLists.txt

@@ -1,3 +1,9 @@
+#
+#  Copyright © 2025 Agora
+#  This file is part of TEN Framework, an open source project.
+#  Licensed under the Apache License, Version 2.0, with certain conditions.
+#  Refer to the "LICENSE" file in the root directory for more information.
+#
 cmake_minimum_required(VERSION 3.10)
 get_filename_component(ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../ ABSOLUTE)
 

examples/build-and-deploy-android.sh

@@ -1,4 +1,10 @@
 #!/bin/bash
+#
+#  Copyright © 2025 Agora
+#  This file is part of TEN Framework, an open source project.
+#  Licensed under the Apache License, Version 2.0, with certain conditions.
+#  Refer to the "LICENSE" file in the root directory for more information.
+#
 set -eo pipefail
 
 # Customize the arch and toolchain

examples/build-and-deploy-ios.sh

@@ -1,4 +1,10 @@
 #!/usr/bin/env bash
+#
+#  Copyright © 2025 Agora
+#  This file is part of TEN Framework, an open source project.
+#  Licensed under the Apache License, Version 2.0, with certain conditions.
+#  Refer to the "LICENSE" file in the root directory for more information.
+#
 set -euo pipefail
 
 work_dir=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)

examples/build-and-deploy-linux.sh

@@ -1,4 +1,10 @@
 #!/bin/bash
+#
+#  Copyright © 2025 Agora
+#  This file is part of TEN Framework, an open source project.
+#  Licensed under the Apache License, Version 2.0, with certain conditions.
+#  Refer to the "LICENSE" file in the root directory for more information.
+#
 set -euo pipefail
 
 arch=x64

examples/build-and-deploy-mac.sh

@@ -1,4 +1,10 @@
 #!/bin/bash
+#
+#  Copyright © 2025 Agora
+#  This file is part of TEN Framework, an open source project.
+#  Licensed under the Apache License, Version 2.0, with certain conditions.
+#  Refer to the "LICENSE" file in the root directory for more information.
+#
 set -euo pipefail
 
 # Customize the arch

examples/build-and-deploy-windows.bat

@@ -1,6 +1,13 @@
 @echo off
 setlocal
 
+@REM
+@REM  Copyright © 2025 Agora
+@REM  This file is part of TEN Framework, an open source project.
+@REM  Licensed under the Apache License, Version 2.0, with certain conditions.
+@REM  Refer to the "LICENSE" file in the root directory for more information.
+@REM
+
 @REM Customize the arch
 set arch=x64
 @REM set arch=x86

examples/main.c

@@ -1,3 +1,9 @@
+//
+// Copyright © 2025 Agora
+// This file is part of TEN Framework, an open source project.
+// Licensed under the Apache License, Version 2.0, with certain conditions.
+// Refer to the "LICENSE" file in the root directory for more information.
+//
 #include <stdio.h>
 #include <stdint.h>
 #include <stdlib.h>