Fangjun Kuang
Committed by GitHub

Add README for android libs. (#1693)

@@ -85,19 +85,19 @@ fi @@ -85,19 +85,19 @@ fi
85 85
86 echo "----------tts----------" 86 echo "----------tts----------"
87 87
88 -wget https://github.com/k2-fsa/sherpa-onnx/releases/download/tts-models/matcha-icefall-en_US-ljspeech.tar.bz2 88 +curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/tts-models/matcha-icefall-en_US-ljspeech.tar.bz2
89 tar xvf matcha-icefall-en_US-ljspeech.tar.bz2 89 tar xvf matcha-icefall-en_US-ljspeech.tar.bz2
90 rm matcha-icefall-en_US-ljspeech.tar.bz2 90 rm matcha-icefall-en_US-ljspeech.tar.bz2
91 -wget https://github.com/k2-fsa/sherpa-onnx/releases/download/vocoder-models/hifigan_v2.onnx 91 +curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/vocoder-models/hifigan_v2.onnx
92 92
93 node ./test_tts_non_streaming_matcha_icefall_en.js 93 node ./test_tts_non_streaming_matcha_icefall_en.js
94 rm hifigan_v2.onnx 94 rm hifigan_v2.onnx
95 rm -rf matcha-icefall-en_US-ljspeech 95 rm -rf matcha-icefall-en_US-ljspeech
96 96
97 -wget https://github.com/k2-fsa/sherpa-onnx/releases/download/tts-models/matcha-icefall-zh-baker.tar.bz2 97 +curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/tts-models/matcha-icefall-zh-baker.tar.bz2
98 tar xvf matcha-icefall-zh-baker.tar.bz2 98 tar xvf matcha-icefall-zh-baker.tar.bz2
99 rm matcha-icefall-zh-baker.tar.bz2 99 rm matcha-icefall-zh-baker.tar.bz2
100 -wget https://github.com/k2-fsa/sherpa-onnx/releases/download/vocoder-models/hifigan_v2.onnx 100 +curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/vocoder-models/hifigan_v2.onnx
101 101
102 node ./test_tts_non_streaming_matcha_icefall_zh.js 102 node ./test_tts_non_streaming_matcha_icefall_zh.js
103 rm hifigan_v2.onnx 103 rm hifigan_v2.onnx
@@ -64,6 +64,7 @@ jobs: @@ -64,6 +64,7 @@ jobs:
64 ./build-android-arm64-v8a.sh 64 ./build-android-arm64-v8a.sh
65 mkdir -p jniLibs/arm64-v8a/ 65 mkdir -p jniLibs/arm64-v8a/
66 cp -v ./build-android-arm64-v8a/install/lib/*.so ./jniLibs/arm64-v8a/ 66 cp -v ./build-android-arm64-v8a/install/lib/*.so ./jniLibs/arm64-v8a/
  67 + cp -v ./build-android-arm64-v8a/install/lib/README.md ./jniLibs/arm64-v8a/
67 rm -rf ./build-android-arm64-v8a/ 68 rm -rf ./build-android-arm64-v8a/
68 69
69 - name: build android armv7-eabi 70 - name: build android armv7-eabi
@@ -77,6 +78,7 @@ jobs: @@ -77,6 +78,7 @@ jobs:
77 ./build-android-armv7-eabi.sh 78 ./build-android-armv7-eabi.sh
78 mkdir -p ./jniLibs/armeabi-v7a/ 79 mkdir -p ./jniLibs/armeabi-v7a/
79 cp -v ./build-android-armv7-eabi/install/lib/*.so ./jniLibs/armeabi-v7a/ 80 cp -v ./build-android-armv7-eabi/install/lib/*.so ./jniLibs/armeabi-v7a/
  81 + cp -v ./build-android-armv7-eabi/install/lib/README.md ./jniLibs/armeabi-v7a/
80 rm -rf ./build-android-armv7-eabi 82 rm -rf ./build-android-armv7-eabi
81 83
82 - name: build android x86_64 84 - name: build android x86_64
@@ -90,6 +92,7 @@ jobs: @@ -90,6 +92,7 @@ jobs:
90 ./build-android-x86-64.sh 92 ./build-android-x86-64.sh
91 mkdir -p ./jniLibs/x86_64 93 mkdir -p ./jniLibs/x86_64
92 cp -v ./build-android-x86-64/install/lib/*.so ./jniLibs/x86_64 94 cp -v ./build-android-x86-64/install/lib/*.so ./jniLibs/x86_64
  95 + cp -v ./build-android-x86-64/install/lib/README.md ./jniLibs/x86_64
93 rm -rf ./build-android-x86-64 96 rm -rf ./build-android-x86-64
94 97
95 - name: build android x86 98 - name: build android x86
@@ -103,6 +106,7 @@ jobs: @@ -103,6 +106,7 @@ jobs:
103 ./build-android-x86.sh 106 ./build-android-x86.sh
104 mkdir -p ./jniLibs/x86 107 mkdir -p ./jniLibs/x86
105 cp -v ./build-android-x86/install/lib/*.so ./jniLibs/x86 108 cp -v ./build-android-x86/install/lib/*.so ./jniLibs/x86
  109 + cp -v ./build-android-x86/install/lib/README.md ./jniLibs/x86
106 rm -rf ./build-android-x86 110 rm -rf ./build-android-x86
107 111
108 - name: Copy files 112 - name: Copy files
@@ -355,6 +355,7 @@ jobs: @@ -355,6 +355,7 @@ jobs:
355 355
356 git clone https://csukuangfj:$HF_TOKEN@huggingface.co/csukuangfj/sherpa-onnx-bin huggingface 356 git clone https://csukuangfj:$HF_TOKEN@huggingface.co/csukuangfj/sherpa-onnx-bin huggingface
357 cd huggingface 357 cd huggingface
  358 + git remote set-url origin https://csukuangfj:$HF_TOKEN@huggingface.co/sherpa-onnx-bin
358 git fetch 359 git fetch
359 git pull 360 git pull
360 git merge -m "merge remote" --ff origin main 361 git merge -m "merge remote" --ff origin main
@@ -150,6 +150,22 @@ cp -fv $onnxruntime_version/jni/arm64-v8a/libonnxruntime.so install/lib 2>/dev/n @@ -150,6 +150,22 @@ cp -fv $onnxruntime_version/jni/arm64-v8a/libonnxruntime.so install/lib 2>/dev/n
150 rm -rf install/share 150 rm -rf install/share
151 rm -rf install/lib/pkgconfig 151 rm -rf install/lib/pkgconfig
152 rm -rf install/lib/lib*.a 152 rm -rf install/lib/lib*.a
  153 +if [ -f install/lib/libsherpa-onnx-c-api.so ]; then
  154 + cat >install/lib/README.md <<EOF
  155 +# Introduction
  156 +
  157 +Note that if you use Android Studio, then you only need to
  158 +copy libonnxruntime.so and libsherpa-onnx-jni.so
  159 +to your jniLibs, and you don't need libsherpa-onnx-c-api.so or
  160 +libsherpa-onnx-cxx-api.so.
  161 +
  162 +libsherpa-onnx-c-api.so and libsherpa-onnx-cxx-api.so are for users
  163 +who don't use JNI. In that case, libsherpa-onnx-jni.so is not needed.
  164 +
  165 +In any case, libonnxruntime.is is always needed.
  166 +EOF
  167 + ls -lh install/lib/README.md
  168 +fi
153 169
154 # To run the generated binaries on Android, please use the following steps. 170 # To run the generated binaries on Android, please use the following steps.
155 # 171 #
@@ -149,3 +149,20 @@ cp -fv $onnxruntime_version/jni/armeabi-v7a/libonnxruntime.so install/lib 2>/dev @@ -149,3 +149,20 @@ cp -fv $onnxruntime_version/jni/armeabi-v7a/libonnxruntime.so install/lib 2>/dev
149 rm -rf install/share 149 rm -rf install/share
150 rm -rf install/lib/pkgconfig 150 rm -rf install/lib/pkgconfig
151 rm -rf install/lib/lib*.a 151 rm -rf install/lib/lib*.a
  152 +
  153 +if [ -f install/lib/libsherpa-onnx-c-api.so ]; then
  154 + cat >install/lib/README.md <<EOF
  155 +# Introduction
  156 +
  157 +Note that if you use Android Studio, then you only need to
  158 +copy libonnxruntime.so and libsherpa-onnx-jni.so
  159 +to your jniLibs, and you don't need libsherpa-onnx-c-api.so or
  160 +libsherpa-onnx-cxx-api.so.
  161 +
  162 +libsherpa-onnx-c-api.so and libsherpa-onnx-cxx-api.so are for users
  163 +who don't use JNI. In that case, libsherpa-onnx-jni.so is not needed.
  164 +
  165 +In any case, libonnxruntime.is is always needed.
  166 +EOF
  167 + ls -lh install/lib/README.md
  168 +fi
@@ -151,3 +151,20 @@ cp -fv $onnxruntime_version/jni/x86_64/libonnxruntime.so install/lib 2>/dev/null @@ -151,3 +151,20 @@ cp -fv $onnxruntime_version/jni/x86_64/libonnxruntime.so install/lib 2>/dev/null
151 rm -rf install/share 151 rm -rf install/share
152 rm -rf install/lib/pkgconfig 152 rm -rf install/lib/pkgconfig
153 rm -rf install/lib/lib*.a 153 rm -rf install/lib/lib*.a
  154 +
  155 +if [ -f install/lib/libsherpa-onnx-c-api.so ]; then
  156 + cat >install/lib/README.md <<EOF
  157 +# Introduction
  158 +
  159 +Note that if you use Android Studio, then you only need to
  160 +copy libonnxruntime.so and libsherpa-onnx-jni.so
  161 +to your jniLibs, and you don't need libsherpa-onnx-c-api.so or
  162 +libsherpa-onnx-cxx-api.so.
  163 +
  164 +libsherpa-onnx-c-api.so and libsherpa-onnx-cxx-api.so are for users
  165 +who don't use JNI. In that case, libsherpa-onnx-jni.so is not needed.
  166 +
  167 +In any case, libonnxruntime.is is always needed.
  168 +EOF
  169 + ls -lh install/lib/README.md
  170 +fi
@@ -112,3 +112,20 @@ make -j4 @@ -112,3 +112,20 @@ make -j4
112 make install/strip 112 make install/strip
113 cp -fv $onnxruntime_version/jni/x86/libonnxruntime.so install/lib 113 cp -fv $onnxruntime_version/jni/x86/libonnxruntime.so install/lib
114 rm -rf install/lib/pkgconfig 114 rm -rf install/lib/pkgconfig
  115 +
  116 +if [ -f install/lib/libsherpa-onnx-c-api.so ]; then
  117 + cat >install/lib/README.md <<EOF
  118 +# Introduction
  119 +
  120 +Note that if you use Android Studio, then you only need to
  121 +copy libonnxruntime.so and libsherpa-onnx-jni.so
  122 +to your jniLibs, and you don't need libsherpa-onnx-c-api.so or
  123 +libsherpa-onnx-cxx-api.so.
  124 +
  125 +libsherpa-onnx-c-api.so and libsherpa-onnx-cxx-api.so are for users
  126 +who don't use JNI. In that case, libsherpa-onnx-jni.so is not needed.
  127 +
  128 +In any case, libonnxruntime.is is always needed.
  129 +EOF
  130 + ls -lh install/lib/README.md
  131 +fi