whisper.rn 0.3.0-rc.6 → 0.3.0

package/README.md

@@ -13,7 +13,7 @@ React Native binding of [whisper.cpp](https://github.com/ggerganov/whisper.cpp).
 | <img src="https://github.com/mybigday/whisper.rn/assets/3001525/2fea7b2d-c911-44fb-9afc-8efc7b594446" width="300" /> | <img src="https://github.com/mybigday/whisper.rn/assets/3001525/a5005a6c-44f7-4db9-95e8-0fd951a2e147" width="300" /> |
 | :------------------------------------------: | :------------------------------------------: |
 | iOS: Tested on iPhone 13 Pro Max | Android: Tested on Pixel 6 |
-| (tiny.en, Core ML enabled) | (tiny.en, armv8.2-a+fp16) |
+| (tiny.en, Core ML enabled, release mode + archive) | (tiny.en, armv8.2-a+fp16, release mode) |
 
 ## Installation
 
@@ -21,7 +21,9 @@ React Native binding of [whisper.cpp](https://github.com/ggerganov/whisper.cpp).
 npm install whisper.rn
 ```
 
-Then re-run `npx pod-install` again for iOS.
+For iOS, please re-run `npx pod-install` again.
+
+For Android, it's recommended to use `ndkVersion = "24.0.8215888"` (or above) in your root project build configuration for Apple Silicon Macs. Otherwise please follow this trobleshooting [issue](./TROUBLESHOOTING.md#android-got-build-error-unknown-host-cpu-architecture-arm64-on-apple-silicon-macs).
 
 For Expo, you will need to prebuild the project before using it. See [Expo guide](https://docs.expo.io/guides/using-libraries/#using-a-library-in-a-expo-project) for more details.
 
@@ -129,9 +131,11 @@ To use Core ML on iOS, you will need to have the Core ML model files.
 
 The `.mlmodelc` model files is load depend on the ggml model file path. For example, if your ggml model path is `ggml-tiny.en.bin`, the Core ML model path will be `ggml-tiny.en-encoder.mlmodelc`. Please note that the ggml model is still needed as decoder or encoder fallback.
 
-Currently there is no official way to get the Core ML models by URL, you will need to convert Core ML models by yourself. Please see [Core ML Support](https://github.com/ggerganov/whisper.cpp#core-ml-support) of whisper.cpp for more details.
+The Core ML models are hosted here: https://huggingface.co/ggerganov/whisper.cpp/tree/main
+
+If you want to download model at runtime, during the host file is archive, you will need to unzip the file to get the `.mlmodelc` directory, you can use library like [react-native-zip-archive](https://github.com/mockingbot/react-native-zip-archive), or host those individual files to download yourself.
 
-During the `.mlmodelc` is a directory, you will need to download 5 files (3 required):
+The `.mlmodelc` is a directory, usually it includes 5 files (3 required):
 
 ```json5
 [
@@ -168,13 +172,9 @@ In real world, we recommended to split the asset imports into another platform s
 
 The example app provide a simple UI for testing the functions.
 
-Used Whisper model: `tiny.en` in https://huggingface.co/datasets/ggerganov/whisper.cpp  
+Used Whisper model: `tiny.en` in https://huggingface.co/ggerganov/whisper.cpp  
 Sample file: `jfk.wav` in https://github.com/ggerganov/whisper.cpp/tree/master/samples
 
-For test better performance on transcribe, you can run the app in Release mode.
-  - iOS: `yarn example ios --configuration Release`
-  - Android: `yarn example android --mode release`
-
 Please follow the [Development Workflow section of contributing guide](./CONTRIBUTING.md#development-workflow) to run the example app.
 
 ## Mock `whisper.rn`

package/android/src/main/jni/whisper/Whisper.mk

@@ -1,15 +1,18 @@
 WHISPER_LIB_DIR := $(LOCAL_PATH)/../../../../../cpp
 LOCAL_LDLIBS    := -landroid -llog
 
+# NOTE: If you want to debug the native code, you can uncomment ifneq and endif
+# ifneq ($(APP_OPTIM),debug)
+
 # Make the final output library smaller by only keeping the symbols referenced from the app.
-ifneq ($(APP_OPTIM),debug)
-    LOCAL_CFLAGS += -O3 -DNDEBUG
-    LOCAL_CFLAGS += -fvisibility=hidden -fvisibility-inlines-hidden
-    LOCAL_CFLAGS += -ffunction-sections -fdata-sections
-    LOCAL_LDFLAGS += -Wl,--gc-sections
-    LOCAL_LDFLAGS += -Wl,--exclude-libs,ALL
-    LOCAL_LDFLAGS += -flto
-endif
+LOCAL_CFLAGS += -O3 -DNDEBUG
+LOCAL_CFLAGS += -fvisibility=hidden -fvisibility-inlines-hidden
+LOCAL_CFLAGS += -ffunction-sections -fdata-sections
+LOCAL_LDFLAGS += -Wl,--gc-sections
+LOCAL_LDFLAGS += -Wl,--exclude-libs,ALL
+LOCAL_LDFLAGS += -flto
+
+# endif
 
 LOCAL_CFLAGS    += -DSTDC_HEADERS -std=c11 -I $(WHISPER_LIB_DIR)
 LOCAL_CPPFLAGS  += -std=c++11 -I $(WHISPER_LIB_DIR)