Merge pull request #27 from ReadAlongs/merge_pocketsphinx5

Merge new features from PocketSphinx 5 (and simplify things)

Author: dhdaines

.github/workflows/tests.yml

@@ -8,15 +8,18 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+      - name: Install
+        run: |
+          sudo apt-get install sox ninja-build
       - name: Build
         run: |
           mkdir build
-          (cd build && cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=install ..)
-          (cd build && make)
+          cmake -S . -B build -GNinja -DCMAKE_BUILD_TYPE=Debug
+          cmake --build build
 
       - name: Run tests
         run: |
-          (cd build && make test)
+          CTEST_OUTPUT_ON_FAILURE=1 cmake --build build --target check
   pytest:
     runs-on: ubuntu-latest
     steps:
@@ -37,7 +40,10 @@ jobs:
         uses: actions/checkout@v3
       - name: Build
         run: |
-          (cd js && npm install && npm run build:prod)
+          emcmake cmake -S . -B jsbuild
+          cmake --build jsbuild
       - name: Run tests
         run: |
-          (cd js && npm test)
+          (cd jsbuild && npm install --also=dev)
+          (cd jsbuild && npm test)
+          (cd jsbuild && npm run tstest)

CMakeLists.txt

@@ -4,12 +4,12 @@ include(CheckSymbolExists)
 include(CheckLibraryExists)
 include(TestBigEndian)
 
-project(soundswallower VERSION 0.3.2
+project(soundswallower VERSION 0.4.0
   DESCRIPTION "An even smaller speech recognizer")
 
 if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
   include(CTest)
-  enable_testing()
+  add_custom_target(check COMMAND ${CMAKE_CTEST_COMMAND})
 endif()
 
 CHECK_INCLUDE_FILE(unistd.h HAVE_UNISTD_H)
@@ -57,7 +57,7 @@ elseif(SKBUILD)
   add_subdirectory(py)
 else()
   # C shared library build
-  option(BUILD_SHARED_LIBS "Build using shared libraries" ON)
+  option(BUILD_SHARED_LIBS "Build using shared libraries" OFF)
   # Build the core library source (needs to go after BUILD_SHARED_LIBS
   # option because CMake is magically stupid)
   add_subdirectory(src)

LICENSE

@@ -29,24 +29,108 @@ 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.
 
-The JavaScript audio and web worker code is from pocketsphinx.js and is:
-Copyright © 2013-2017 Sylvain Chevalier
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WebRTC VAD code (in src/vad):
+
+Copyright (c) 2011, The WebRTC project authors. All rights reserved.
+
+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 Google 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 COPYRIGHT
+HOLDER 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.
+
+Python WebRTC VAD code and test files (in py and test/data/vad):
+
+The MIT License (MIT)
+
+Copyright (c) 2016 John Wiseman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+JSON parser (in src/jsmn.h):
+
+Copyright (c) 2010 Serge A. Zaitsev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Escaping code in JSON serialization (src/config.c):
+
+Copyright (C) 2014 James McLaughlin.  All rights reserved.
+https://github.com/udp/json-builder
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+2. 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 AUTHOR 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 AUTHOR 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.manylinux.md

@@ -2,8 +2,9 @@ Building binary distributions for Linux
 ---------------------------------------
 
 To build distributions that are compatible with all the various Linux
-distributions, and can therefore be uploaded to PyPI, you can use the
-Docker images provided by the [manylinux
+distributions, and can therefore be uploaded to PyPI, we now use
+[cibuildwheel](https://pypi.org/project/cibuildwheel/).  But also, you
+can use the Docker images provided by the [manylinux
 project](https://github.com/pypa/manylinux).
 
 The full sequence of commands to create Linux wheels for Python 3.7

README.md

@@ -13,7 +13,7 @@ useful speech technologies.
 
 With that in mind the current version is limited to finite-state
 grammar recognition.  In addition, the eternally problematic and
-badly-designed audio library as well as all other external
+badly-designed audio library as well as (almost) all other external
 dependencies have been removed.
 
 Compiling SoundSwallower
@@ -22,12 +22,10 @@ Compiling SoundSwallower
 Currently SoundSwallower can be built in several different ways. To
 build the C shared library, run CMake in the standard way:
 
-    mkdir build
-    cd build
-    cmake ..
-    make
-    make test
-    make install
+    cmake -S . -B build
+    cmake --build build
+    cmake --build build --target check
+    sudo cmake --build --target install
 
 Note that this isn't terribly useful as there is no command-line
 frontend.  You probably want to target JavaScript or Python.
@@ -62,27 +60,54 @@ alignment for one or more input files, for example:
 Note that multiple input files are not particularly useful for
 `--align` or `--align-text` as they will simply (try to) align the
 same text to each file.  The output results (a list of time-aligned
-words) can be written to a JSON file with `--output`.
+words) can be written to a JSON file with `--output`.  To obtain
+phoneme-level alignments, add the `--phone-align` flag.  The JSON
+format (which has recently changed) is the same as used in
+[PocketSphinx 5.0](https://github.com/cmusphinx/pocketsphinx) and is
+more compact than it is readable, but briefly, it consists of one
+dictionary (or "object" in JavaScript-ese) per line, where the `t`
+attribute is the recognized text and the `w` attribute contains a list
+of word segmentations, with start time in `b` and duration in `d` and,
+optionally, a list of phone segmentations in the `w` attribute with
+the same format.
 
 See also the [full documentation of the Python
 API](https://soundswallower.readthedocs.io/en/latest/soundswallower.html).
 
 Compiling to JavaScript/WebAssembly
 -----------------------------------
 
+To use the JavaScript library in your projects:
+
+    npm install soundswallower
+
 To build the JavaScript library, use CMake with
 [Emscripten](https://emscripten.org/):
 
-    cd js
-    emcmake cmake ..
-    emmake make
+    emcmake cmake -S . -B jsbuild
+    cmake --build jsbuild
 
-This will create `js/soundswallower.js` and `js/soundswallower.wasm`
-in the `jsbuild` directory, which you can then include in your
-projects.  Demo applications can be seen at
+This will create `soundswallower.js` and `soundswallower.wasm` in the
+`jsbuild` directory, which you can then include in your projects.  You
+can also use `npm link` to link it to your `node_modules` folder for
+development Demo applications can be seen at
 https://github.com/dhdaines/alignment-demo and
 https://github.com/dhdaines/soundswallower-demo.
 
+To run the JavaScript tests:
+
+    cd jsbuild
+    npm install
+    npm test
+    npx tsc
+    node test_typescript.js
+    
+And in the browser:
+
+    cd jsbuild
+    python server.py
+    # Navigate to http://localhost:8000/test_web.html
+
 For more details on the JavaScript implementation and API, see
 [js/README.js](https://github.com/ReadAlongs/SoundSwallower/blob/master/js/README.md).
 

TODO.md

@@ -1,28 +1,23 @@
 Roadmap:
 
-- 0.4.0: Merge PocketSphinx 5.0.0
-  - VAD/Endpointer
-  - Two-pass alignment (but easier)
-  - Config updates, but smaller (no s3kr3t command-line, etc),
-    actually we were mostly there already
-  - JSGF correctness
-  - JSON decoding/alignment output
+- 1.0: Finalize API
+  - ES6 module (possibly separate for Node vs. Web)
+  - Optimize JSGF compiler
   - Support IPA dictionaries
-  - ES6 module
-
-- 1.0.0: Update API
-  - Clearly define use cases
+  - Improve Endpointer/VAD
+  - Clearly define use cases and restructure API for them
     - Live: feed data asynchronously, check results synchronously or emit events
       - *recording* is real-time in a separate thread
+        - VAD/Endpointing should be done in the recording thread
+        - Feature extraction could be done there but this is not necessary
       - *decoding* is not real-time, can be decomposed to microtasks
-    - Single: pass data with promise of result, emit progress events
-  - Remove remaining PocketSphinx API junk if any
+    - Single/Batch: pass data with promise of result, emit progress events
+      - Good fit for async
   - Easier support for observable/event type uses
     - async/await/promise is actually not a great fit
   - Support web audio formats directly
-  - Change ownership semantics to fit use cases
   - Better solution for float vs. int in front-end
 
-- 2.0.0: Improved modeling
-  - DNN acoustic models?
-  - WFST search?
+- 2.0: Improved modeling
+  - WFST search
+  - DNN acoustic models

build_wheels.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 set -e
-VERSION=0.3.2
+VERSION=0.4.0
 U=$(id -u)
 G=$(id -g)
 

config.h.in

@@ -1,4 +1,5 @@
 #cmakedefine HAVE_UNISTD_H
+#cmakedefine HAVE_STDINT_H
 #cmakedefine HAVE_SYS_TYPES_H
 #cmakedefine HAVE_SYS_STAT_H
 #cmakedefine HAVE_SNPRINTF

include/soundswallower.h

@@ -0,0 +1,50 @@
+/* -*- c-basic-offset:4; indent-tabs-mode: nil -*- */
+/* ====================================================================
+ * Copyright (c) 2022 David Huggins-Daines.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer. 
+ *
+ * 2. 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 AUTHOR ``AS IS'' AND ANY EXPRESSED
+ * 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 AUTHOR NOR ITS EMPLOYEES 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.
+ *
+ * ====================================================================
+ */
+#ifndef __SOUNDSWALLOWER_H__
+#define __SOUNDSWALLOWER_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+#if 0
+}
+#endif
+
+/* Not much here for the moment! */
+#include <soundswallower/decoder.h>
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif /* __SOUNDSWALLOWER_H__ */