fix PIC

Author: csukuangfj

.github/workflows/aarch64-linux-gnu-static.yaml

@@ -5,6 +5,7 @@ on:
   push:
     branches:
       - master
+      - rust-static
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]+*'
     paths:
@@ -141,7 +142,7 @@ jobs:
           path: sherpa-onnx-*.tar.bz2
 
       - name: Release pre-compiled binaries and libs for linux aarch64
-        if: github.repository_owner == 'csukuangfj' && github.event_name == 'push' && contains(github.ref, 'refs/tags/') && matrix.build_type == 'Release'
+        # if: github.repository_owner == 'csukuangfj' && github.event_name == 'push' && contains(github.ref, 'refs/tags/') && matrix.build_type == 'Release'
         uses: svenstaro/upload-release-action@v2
         with:
           file_glob: true

.github/workflows/linux.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - master
+      - rust-static
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]+*'
     paths:
@@ -65,8 +66,11 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        build_type: [Release, Debug]
-        shared_lib: [ON, OFF]
+        # build_type: [Release, Debug]
+        # shared_lib: [ON, OFF]
+        # with_tts: [ON, OFF]
+        build_type: [Release]
+        shared_lib: [OFF]
         with_tts: [ON, OFF]
 
     steps:
@@ -237,7 +241,7 @@ jobs:
           du -h -d1 .
 
       - name: Release pre-compiled binaries and libs for linux x64
-        if: github.repository_owner == 'csukuangfj' && github.event_name == 'push' && contains(github.ref, 'refs/tags/') && matrix.build_type == 'Release'
+        # if: github.repository_owner == 'csukuangfj' && github.event_name == 'push' && contains(github.ref, 'refs/tags/') && matrix.build_type == 'Release'
         uses: svenstaro/upload-release-action@v2
         with:
           file_glob: true

.github/workflows/test-rust-package-static.yaml

@@ -3,7 +3,7 @@ name: Test rust package static
 on:
   push:
     branches:
-      - rust-static
+      - rust-static-2
   workflow_dispatch:
 
 concurrency:

.github/workflows/test-rust-package.yaml

@@ -3,7 +3,7 @@ name: Test rust package
 on:
   push:
     branches:
-      - rust-static
+      - rust-static-2
   workflow_dispatch:
 
 concurrency:

CMakeLists.txt

@@ -237,6 +237,11 @@ endif()
 if(BUILD_SHARED_LIBS OR SHERPA_ONNX_ENABLE_JNI)
   set(CMAKE_CXX_VISIBILITY_PRESET hidden)
   set(CMAKE_VISIBILITY_INLINES_HIDDEN 1)
+endif()
+
+# Rust on Linux links static sherpa-onnx archives into PIE executables by
+# default, so static objects need PIC as well.
+if(NOT WIN32)
   set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 endif()
 

new-release.sh

@@ -35,10 +35,10 @@ sed -i.bak "$replace_str" ./jitpack.yml
 sed -i.bak "$replace_str" ./android/SherpaOnnxAar/README.md
 
 sed -i.bak "$replace_str" ./rust-api-examples/Cargo.toml
+sed -i.bak "$replace_str" ./rust-api-examples/for-advanced-users.md
 sed -i.bak "$replace_str" ./sherpa-onnx/rust/sherpa-onnx-sys/Cargo.toml
 sed -i.bak "$replace_str" ./sherpa-onnx/rust/sherpa-onnx/Cargo.toml
 sed -i.bak "$replace_str" ./sherpa-onnx/rust/sherpa-onnx/src/lib.rs
-sed -i.bak "$replace_str" ./rust-api-examples/README.md
 
 find android -name build.gradle -type f -exec sed -i.bak "s/sherpa-onnx:v$old_version/sherpa-onnx:v$new_version/g" {} \;
 find android -name build.gradle.kts -type f -exec sed -i.bak "s/sherpa-onnx:v$old_version/sherpa-onnx:v$new_version/g" {} \;

rust-api-examples/Cargo.toml

@@ -6,8 +6,8 @@ edition = "2021"
 [dependencies]
 anyhow = "1.0"
 clap = { version = "4.5", features = ["derive"] }
-sherpa-onnx = { version = "1.12.31", default-features = false }
-# sherpa-onnx = { path = "../sherpa-onnx/rust/sherpa-onnx" }
+# sherpa-onnx = { version = "1.12.31", default-features = false }
+sherpa-onnx = { path = "../sherpa-onnx/rust/sherpa-onnx" }
 serde_json = "1.0"
 
 cpal = { version = "0.16", optional = true } # cross-platform audio I/O

rust-api-examples/README.md

@@ -5,76 +5,31 @@ this repository.
 
 ## Setup
 
-`rust-api-examples` now uses the Rust crate's default configuration:
+For most users, you don't need to configure Rust linking details manually.
 
-- static linking is enabled by default
-- if `SHERPA_ONNX_LIB_DIR` is not set, the build script downloads a matching
-  prebuilt `-lib` archive automatically
-- if `SHERPA_ONNX_LIB_DIR` is set, that directory is used instead
+Just enter this directory and run one of the helper scripts below. Each script
+downloads the required model files automatically if needed.
 
-For most users, this means you can simply run:
+For example:
 
 ```bash
-cargo run --example version
-```
-
-The first build downloads the correct prebuilt libraries for your platform and
-prints the resolved library directory in the Cargo output.
-
-### Use shared libraries instead
-
-If you want to use the shared libraries, disable the default feature and enable
-`shared`:
-
-```bash
-cargo run --no-default-features --features shared --example version
-```
-
-For microphone examples, add `mic` as usual:
-
-```bash
-cargo run --no-default-features --features "shared,mic" \
-  --example streaming_zipformer_microphone -- --help
+./run-version.sh
 ```
 
-On Linux and macOS, the build script adds the runtime rpath automatically for
-downloaded or user-supplied shared libraries. On Windows, it copies the needed
-DLLs next to the generated binaries automatically.
-
-### Advanced: use your own sherpa-onnx libraries
-
-If you build sherpa-onnx yourself or download a release archive manually, set
-`SHERPA_ONNX_LIB_DIR` to the `lib` directory and rebuild:
+You can also run examples directly with Cargo:
 
 ```bash
-export SHERPA_ONNX_LIB_DIR=/path/to/sherpa-onnx/lib
+cargo run --example version
 ```
 
-That environment variable works for both static and shared builds.
-
-### Prebuilt `-lib` archives used by the build script
-
-Use the latest release in practice. We use `v1.12.31` below only as an example.
-
-#### Default static archives
-
-| OS | Archive example | Download link |
-|----|-----------------|---------------|
-| Linux x86_64 | `sherpa-onnx-v1.12.31-linux-x64-static-lib.tar.bz2` | [Download](https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.31/sherpa-onnx-v1.12.31-linux-x64-static-lib.tar.bz2) |
-| Linux aarch64 | `sherpa-onnx-v1.12.31-linux-aarch64-static-lib.tar.bz2` | [Download](https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.31/sherpa-onnx-v1.12.31-linux-aarch64-static-lib.tar.bz2) |
-| macOS x86_64 | `sherpa-onnx-v1.12.31-osx-x64-static-lib.tar.bz2` | [Download](https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.31/sherpa-onnx-v1.12.31-osx-x64-static-lib.tar.bz2) |
-| macOS arm64 | `sherpa-onnx-v1.12.31-osx-arm64-static-lib.tar.bz2` | [Download](https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.31/sherpa-onnx-v1.12.31-osx-arm64-static-lib.tar.bz2) |
-| Windows x64 | `sherpa-onnx-v1.12.31-win-x64-static-MT-Release-lib.tar.bz2` | [Download](https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.31/sherpa-onnx-v1.12.31-win-x64-static-MT-Release-lib.tar.bz2) |
-
-#### Optional shared archives
+The first build may download the matching sherpa-onnx native libraries for your
+platform automatically. This is usually invisible apart from a short Cargo
+message showing the resolved library directory.
 
-| OS | Archive example | Download link |
-|----|-----------------|---------------|
-| Linux x86_64 | `sherpa-onnx-v1.12.31-linux-x64-shared-lib.tar.bz2` | [Download](https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.31/sherpa-onnx-v1.12.31-linux-x64-shared-lib.tar.bz2) |
-| Linux aarch64 | `sherpa-onnx-v1.12.31-linux-aarch64-shared-cpu-lib.tar.bz2` | [Download](https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.31/sherpa-onnx-v1.12.31-linux-aarch64-shared-cpu-lib.tar.bz2) |
-| macOS x86_64 | `sherpa-onnx-v1.12.31-osx-x64-shared-lib.tar.bz2` | [Download](https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.31/sherpa-onnx-v1.12.31-osx-x64-shared-lib.tar.bz2) |
-| macOS arm64 | `sherpa-onnx-v1.12.31-osx-arm64-shared-lib.tar.bz2` | [Download](https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.31/sherpa-onnx-v1.12.31-osx-arm64-shared-lib.tar.bz2) |
-| Windows x64 | `sherpa-onnx-v1.12.31-win-x64-shared-MT-Release-lib.tar.bz2` | [Download](https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.31/sherpa-onnx-v1.12.31-win-x64-shared-MT-Release-lib.tar.bz2) |
+If you want to customize which libraries are used, set `SHERPA_ONNX_LIB_DIR`,
+choose shared instead of the default behavior, or configure the crate directly
+in your own Cargo project, see
+[for-advanced-users.md](./for-advanced-users.md).
 
 ## Examples
 

rust-api-examples/for-advanced-users.md

@@ -0,0 +1,118 @@
+# Rust examples: advanced users
+
+This note is for users who want to control how the `sherpa-onnx` Rust crate
+finds and links its native libraries.
+
+Most users do **not** need anything here. The default behavior is:
+
+1. build normally
+2. let the build script download the matching native libraries automatically
+3. run the examples or your own Rust program
+
+## Use your own sherpa-onnx libraries
+
+If you already have sherpa-onnx libraries on disk, set
+`SHERPA_ONNX_LIB_DIR` to the `lib` directory before building:
+
+```bash
+export SHERPA_ONNX_LIB_DIR=/path/to/sherpa-onnx/lib
+```
+
+Examples:
+
+- source build output: `/path/to/sherpa-onnx/build/install/lib`
+- manually extracted release archive:
+  `/path/to/sherpa-onnx-v1.12.31-linux-x64-static-lib/lib`
+
+If `SHERPA_ONNX_LIB_DIR` is set, the build script uses that directory and does
+not auto-download another archive.
+
+## Automatic download behavior
+
+If `SHERPA_ONNX_LIB_DIR` is not set, `sherpa-onnx-sys/build.rs` downloads a
+matching prebuilt `-lib` archive from GitHub releases and uses its `lib`
+directory automatically.
+
+The build script currently selects archives like this:
+
+### Default mode
+
+Default mode uses the default crate feature set. Most users just get this
+behavior automatically.
+
+| OS | Architecture | Archive example |
+|----|--------------|-----------------|
+| Linux | x86_64 | `sherpa-onnx-v1.12.31-linux-x64-static-lib.tar.bz2` |
+| Linux | aarch64 | `sherpa-onnx-v1.12.31-linux-aarch64-static-lib.tar.bz2` |
+| macOS | x86_64 | `sherpa-onnx-v1.12.31-osx-x64-static-lib.tar.bz2` |
+| macOS | arm64 | `sherpa-onnx-v1.12.31-osx-arm64-static-lib.tar.bz2` |
+| Windows | x86_64 | `sherpa-onnx-v1.12.31-win-x64-static-MT-Release-lib.tar.bz2` |
+
+### Shared mode
+
+If you enable the `shared` feature, the build script downloads these shared
+archives instead:
+
+| OS | Architecture | Archive example |
+|----|--------------|-----------------|
+| Linux | x86_64 | `sherpa-onnx-v1.12.31-linux-x64-shared-lib.tar.bz2` |
+| Linux | aarch64 | `sherpa-onnx-v1.12.31-linux-aarch64-shared-cpu-lib.tar.bz2` |
+| macOS | x86_64 | `sherpa-onnx-v1.12.31-osx-x64-shared-lib.tar.bz2` |
+| macOS | arm64 | `sherpa-onnx-v1.12.31-osx-arm64-shared-lib.tar.bz2` |
+| Windows | x86_64 | `sherpa-onnx-v1.12.31-win-x64-shared-MT-Release-lib.tar.bz2` |
+
+In practice, use the latest release tag instead of the example version above.
+
+## Configure the `sherpa-onnx` crate in Cargo.toml
+
+### Default configuration
+
+This is enough for most users:
+
+```toml
+[dependencies]
+sherpa-onnx = "1.12.31"
+```
+
+That uses the crate's default feature set.
+
+### Use shared libraries
+
+To use shared libraries instead, disable default features and enable `shared`:
+
+```toml
+[dependencies]
+sherpa-onnx = { version = "1.12.31", default-features = false, features = ["shared"] }
+```
+
+From the command line, the equivalent example command is:
+
+```bash
+cargo run --no-default-features --features shared --example version
+```
+
+### Enable microphone examples
+
+In `rust-api-examples`, microphone support is controlled by the `mic` feature:
+
+```bash
+cargo run --features mic --example streaming_zipformer_microphone -- --help
+```
+
+If you want both microphone support and shared libraries:
+
+```bash
+cargo run --no-default-features --features "shared,mic" \
+  --example streaming_zipformer_microphone -- --help
+```
+
+## Notes about runtime behavior
+
+When shared libraries are used:
+
+- Linux and macOS: the build script adds the runtime rpath automatically
+- Windows: the build script copies the required DLLs next to the generated
+  binaries automatically
+
+When `SHERPA_ONNX_LIB_DIR` is set, the same behavior applies, but the files come
+from your directory instead of an auto-downloaded archive.