Skip to content

5.0.0: First official release in a decade or so
Compare
Choose a tag to compare
@dhdaines dhdaines released this 05 Oct 14:03
· 109 commits to master since this release
v5.0.0
7c3f085

Finally, now that it is thoroughly obsolete, it is time to get PocketSphinx out of its eternal "prealpha" status. The version number is strangely large because "5prealpha" existed for such a long time that it became treated as a real release, and for some reason it did not have a conventional version number like, say, 1.0.0-alpha5.

The purpose of this release is to fix and document the public API, as well as to debug, stabilize, test, and fully document the current state of PocketSphinx. I do expect that there will be bug fixes and possibly some new APIs, but all 5.x releases are guaranteed to be backwards source and binary compatible.

Notably this release is not source-compatible in C with the previous versions. Your code will fail to compile. By contrast, in Python, old code should not fail at runtime, and if this isn't the case, please report it as an issue. Such is the way of the world with dynamic languages.

API documentation can be found at https://cmusphinx.github.io/doc/pocketsphinx/ and https://pocketsphinx.readthedocs.io/

Among other notable changes:

  • pocketsphinx_continuous is gone, replaced by plain old pocketsphinx, which is documented in the README file.
  • The configuration interface is now quite different. It is not a "command-line parser" anymore and the configuration parameters have lost their leading dashes.
  • All of the SphinxBase "utility" headers have also been made internal and their symbols will no longer be exported on Windows. Conversely, the JSGF and N-Gram language model API has been included in <pocketsphinx/model.h>.
  • The sphinx_fe and sphinx_cepview utilities have been moved to SphinxTrain.
  • The audio interface (<sphinxbase/ad.h>) has been removed.
  • The -remove_noise option is now controlled by the acoustic model as it needs to match the training.
  • The -remove_silence option has been removed as it is a Bad Idea and Considered Harmful for batch mode recognition. Please use the endpointer API as detailed in <pocketsphinx/endpointer.h> and examples/live.c or examples/live.py.
  • The -cmninit option is not controlled by the default acoustic model anymore. This may cause some problems for live recognition as the defaults may not match the feature extraction parameters.
  • The SWIG wrappers have been removed. Only Python 3 is directly supported as a dynamic language binding. Node.js may be supported in the near future. The C API is specifically designed to be easily supported through FFI, so you can do that.
  • Python support is much improved, fully documented, and builds a proper module directly from the (top level of the) source tree with pip or build.
  • Android support is gone but may come back (contributions welcome, I don't have time to support anything other than Linux on x86_64 and s390x)

What's Changed

  • Change the <pocketsphinx/search.h> API to be slightly more intuitive by @dhdaines in #298
  • New force-alignment API and two-pass alignment to get phone/state durations by @dhdaines in #300
  • Uniformize API and test fixed-point mode properly by @dhdaines in #302
  • Fix float-to-int underflows (#199, #252) by @dhdaines in #303
  • Disallow multiple search types in config or command-line by @dhdaines in #304
  • Revert incorrect optimizations to JSGF compiler (fixes #53) by @dhdaines in #305
  • Make seg_iter and hyp behave as expected in kws search (fixes #122) by @dhdaines in #306
  • feat: add -config and config to parse and save JSON by @dhdaines in #307
  • Resurrect GStreamer support by @dhdaines in #308
  • Remove sphinxbase and modernize configuration API by @dhdaines in #295
  • Add support for input files to pocketsphinx command line by @dhdaines in #297
  • Add compatibility with pocketsphinx-python 0.1.5 by @dhdaines in #292
  • Rename pocketsphinx5 to pocketsphinx by @dhdaines in #293
  • Updated the en-us dict by @Coeur in #124
  • Fix memory leak in allphone_search.c by @chussong in #138
  • Forward declare allphone_clear_segments in allphone_search.c by @chussong in #140
  • Make force alignment accessible from pocketsphinx_batch and the ps_decoder API by @dhdaines in #144
  • Improve linking for internal headers by @chussong in #168
  • Fix memory leak in bin_mdef_read_text by @guidovranken in #198
  • Large build system and small API modernizations by @dhdaines in #250
  • Fix windows build by @dhdaines in #251
  • Fix endianness issues in binary trie LM code by @dhdaines in #253
  • Build a proper Python package by @dhdaines in #254
  • Update -cmninit parameter when CMN is updated by @dhdaines in #259
  • Switch back to Cython and use scikit-build for Python module by @dhdaines in #271
  • Document Python module better and build ReadTheDocs with (the other) Sphinx by @dhdaines in #273
  • Fix install command for Mac and iOS builds by @mattlarose in #280
  • Incoporate WebRTC VAD code by @dhdaines in #278
  • Reorganize header files by @dhdaines in #282
  • Remove thread library by @dhdaines in #283
  • Add a proper API for cepstral mean normalization by @dhdaines in #284
  • Make -samprate an int after all these years by @dhdaines in #285

New Contributors

Full Changelog: last-pre-1.0...v5.0.0

Contributors

Coeur, nxdefiant, and 12 other contributors
Assets 2
Loading