Merge pull request #271 from cmusphinx/cython_module

Switch back to Cython and use scikit-build for Python module

Author: dhdaines

.github/workflows/tests.yml

@@ -20,12 +20,11 @@ jobs:
   pytest:
     runs-on: ubuntu-latest
     steps:
-      - name: Install Build Dependencies
-        run: sudo apt-get -y install doxygen swig
       - name: Checkout
         uses: actions/checkout@v3
       - name: Install
         run: |
+          python -m pip install --upgrade pip
           pip install -r requirements.dev.txt
           pip install .
       - name: Run tests

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.14) # I like pie
 
-project(PocketSphinx VERSION 4.9.999.0
+project(PocketSphinx VERSION 5.0.0
   DESCRIPTION "A small speech recognizer"
   HOMEPAGE_URL "https://github.com/cmusphinx/pocketsphinx")
 include(CMakePrintHelpers)
@@ -60,10 +60,6 @@ else()
   add_compile_options(-Wall -Wextra)
 endif()
 
-option(BUILD_SHARED_LIBS "Build using shared libraries" ON)
-if(BUILD_SHARED_LIBS)
-  add_definitions(-DSPHINX_DLL)
-endif()
 option(FIXED_POINT "Build using fixed-point math" OFF)
 if(NOT DEFAULT_RADIX)
   set(DEFAULT_RADIX 12)
@@ -79,18 +75,24 @@ configure_file(config.h.in config.h)
 configure_file(sphinx_config.h.in include/sphinxbase/sphinx_config.h)
 add_definitions(-DHAVE_CONFIG_H)
 
-add_subdirectory(src)
-# Only build SWIG and Python if we are building the package
-if(CALL_FROM_SETUP_PY)
-  add_subdirectory(swig)
+# Python build
+if(SKBUILD)
+  add_subdirectory(src)
+  add_subdirectory(cython)
 else()
-  # Don't build or install these in Python
+  # C shared library build
+  option(BUILD_SHARED_LIBS "Build using shared libraries" ON)
+  if(BUILD_SHARED_LIBS)
+    add_definitions(-DSPHINX_DLL)
+  endif()
+  add_subdirectory(src)
   add_subdirectory(model)
   add_subdirectory(doc)
   add_subdirectory(include)
   add_subdirectory(programs)
   add_subdirectory(test)
   configure_file(pocketsphinx.pc.in pocketsphinx.pc @ONLY)
+  install(TARGETS pocketsphinx LIBRARY)
   install(FILES ${CMAKE_BINARY_DIR}/pocketsphinx.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
 endif()
 

NEWS

@@ -1,3 +1,8 @@
+PocketSphinx 5.0.0
+^^^^^^^^^^^^^^^^^^
+
+Not released yet!
+
 Pocketsphinx 0.8
 ^^^^^^^^^^^^^^^^
 

README.md

@@ -1,5 +1,5 @@
-PocketSphinx 5.0.0 prerelease
-=============================
+PocketSphinx 5.0.0 release candidate 1
+======================================
 
 This is PocketSphinx, one of Carnegie Mellon University's open source large
 vocabulary, speaker-independent continuous speech recognition engines.

cython/.gitignore

@@ -0,0 +1,2 @@
+*.so
+model

cython/CMakeLists.txt

@@ -0,0 +1,17 @@
+find_package(PythonExtensions REQUIRED)
+find_package(Python COMPONENTS Interpreter Development)
+find_package(Cython)
+
+set_property(TARGET pocketsphinx PROPERTY POSITION_INDEPENDENT_CODE on)
+
+add_cython_target(_pocketsphinx _pocketsphinx.pyx)
+add_library(_pocketsphinx MODULE ${_pocketsphinx})
+target_link_libraries(_pocketsphinx pocketsphinx)
+target_include_directories(
+  _pocketsphinx PRIVATE ${PYTHON_INCLUDE_DIR}
+  _pocketsphinx PRIVATE ${PROJECT_SOURCE_DIR}/src
+  _pocketsphinx PRIVATE ${PROJECT_SOURCE_DIR}/include
+  _pocketsphinx PRIVATE ${CMAKE_BINARY_DIR} # for config.h
+  )
+python_extension_module(_pocketsphinx)
+install(TARGETS _pocketsphinx LIBRARY DESTINATION cython/pocketsphinx5)