Merge branch 'release/2022.1.0'

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ develop ]
+  schedule:
+    - cron: '30 5 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

CHANGES.md

@@ -11,6 +11,16 @@
 
 ## develop
 
+## 2022.1.0
+
+- [CHANGE] `Rnnoise` クラスのインタフェース見直しと `DenoiseState` クラスの追加
+    - `Rnnoise` クラスの責務を wasm ファイル管理と RNNoise のステートレス関数の提供に限定し、それ以外は `DenoiseState` に分離
+    - https://github.com/shiguredo/rnnoise-wasm/pull/14
+    - @sile
+- [CHANGE] 内部 API を型定義ファイルに含めないように変更
+    - https://github.com/shiguredo/rnnoise-wasm/pull/15
+    - @sile
+
 ## 2021.1.0
 
 **初リリース**

README.md

@@ -1,6 +1,10 @@
 rnnoise-wasm
 ============
 
+[![GitHub tag](https://img.shields.io/github/tag/shiguredo/rnnoise-wasm.svg)](https://github.com/shiguredo/rnnoise-wasm)
+[![npm version](https://badge.fury.io/js/@shiguredo%2Frnnoise-wasm.svg)](https://badge.fury.io/js/@shiguredo%2Frnnoise-wasm)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
 [RNNoise](https://github.com/shiguredo/rnnoise) を WebAssembly (wasm) にビルドして
 JavaScript や TypeScript から利用するためのライブラリです。
 
@@ -22,18 +26,26 @@ Please read https://github.com/shiguredo/oss/blob/master/README.en.md before use
 ```console
 $ npm install --save @shiguredo/rnnoise-wasm
 $ npm ls
-└── @shiguredo/rnnoise-wasm@2021.1.0
+└── @shiguredo/rnnoise-wasm@2022.1.0
 ```
 
 TypeScript での使用方法は次のようになります:
 ```typescript
-import { Rnnoise } from "@shigredo/rnnoise-wasm/";
+import { Rnnoise } from "@shiguredo/rnnoise-wasm";
 
 // RNNoise の wasm ファイルをロード
 Rnnoise.load().then((rnnoise) => {
+    // ノイズ抑制用インスタンスを生成
+    const denoiseState = rnnoise.createDenoiseState();
+
     // 音声フレームにノイズ抑制処理を適用する
     const frame = new Float32Array(...);
     rnnoise.processFrame(frame);
+
+    ...
+
+    // インスタンスを破棄して wasm 用に割り当てたメモリを解放
+    denoiseState.destroy();
 });
 ```