rev 2

Picovoice · Nov 28, 2023 · e036f79 · e036f79
1 parent 7f81950
commit e036f79
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 17 deletions.
diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -28,6 +28,7 @@ on:
       - 'lib/raspberry-pi/**'
       - 'lib/windows/**'
       - 'resources/audio_samples/*.wav'
+      - 'resources/.test/**'
 
 defaults:
   run:

diff --git a/README.md b/README.md
@@ -24,20 +24,26 @@ Falcon is an on-device speaker diarization engine. Falcon is:
     - Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
     - Raspberry Pi (4, 3) and NVIDIA Jetson Nano
 
-
 ## Table of Contents
 
 - [Falcon](#falcon)
-  - [Table of Contents](#table-of-contents)
-  - [AccessKey](#accesskey)
-  - [Demos](#demos)
-    - [Python Demos](#python-demos)
-    - [C Demos](#c-demos)
-  - [SDKs](#sdks)
-    - [Python](#python)
-    - [C](#c)
-  - [Releases](#releases)
-  - [FAQ](#faq)
+    - [Table of Contents](#table-of-contents)
+    - [What is Speaker Diarization?](#what-is-speaker-diarization)
+    - [AccessKey](#accesskey)
+    - [Demos](#demos)
+        - [Python Demos](#python-demos)
+        - [C Demos](#c-demos)
+    - [SDKs](#sdks)
+        - [Python](#python)
+        - [C](#c)
+    - [Releases](#releases)
+    - [FAQ](#faq)
+
+## What is Speaker Diarization?
+
+Speaker diarization, a fundamental step in automatic speech recognition and audio processing, focuses on identifying and
+separating distinct speakers within an audio recording. Its objective is to divide the audio into segments while
+precisely identifying the speakers and their respective speaking intervals.
 
 ## AccessKey
 
@@ -105,9 +111,10 @@ print(falcon.process_file('${AUDIO_PATH}'))
 ```
 
 Replace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/) and
-`${AUDIO_PATH}` to path an audio file. 
+`${AUDIO_PATH}` to path an audio file.
 
 Finally, when done be sure to explicitly release the resources:
+
 ```python
 falcon.delete()
 ```
@@ -153,6 +160,7 @@ Replace `${ACCESS_KEY}` with yours obtained from Picovoice Console, `${MODEL_PAT
 [default model file](./lib/common/falcon_params.pv) (or your custom one), and `${AUDIO_PATH}` to path an audio file.
 
 Finally, when done be sure to release resources acquired:
+
 ```c
 pv_falcon_delete(falcon);
 ```

diff --git a/binding/python/README.md b/binding/python/README.md
@@ -1,4 +1,6 @@
-# Falcon Speaker Diarization Engine
+# Falcon Binding for Python
+
+## Falcon Speaker Diarization Engine
 
 Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
 
@@ -28,7 +30,7 @@ Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get you
 
 ### Usage
 
-Create an instance of the engine and diarize an audio file:
+Create an instance of the engine and perform speaker diarization on an audio file:
 
 ```python
 import pvfalcon

diff --git a/binding/python/_falcon.py b/binding/python/_falcon.py
@@ -307,7 +307,7 @@ def _get_error_stack(self) -> Sequence[str]:
         message_stack_depth = c_int()
         status = self._get_error_stack_func(byref(message_stack_ref), byref(message_stack_depth))
         if status is not self.PicovoiceStatuses.SUCCESS:
-            raise self._PICOVOICE_STATUS_TO_EXCEPTION[status](message="Unable to get Porcupine error state")
+            raise self._PICOVOICE_STATUS_TO_EXCEPTION[status](message="Unable to get Falcon error state")
 
         message_stack = list()
         for i in range(message_stack_depth.value):

diff --git a/include/pv_falcon.h b/include/pv_falcon.h
@@ -125,10 +125,10 @@ PV_API pv_status_t pv_falcon_process_file(
         pv_segment_t **segments);
 
 /**
- * Deletes segments allocated by `pv_falcon_process()`.
+ * Deletes segments allocated by `pv_falcon_process()` and `pv_falcon_process_file()`.
  *
  * Use this function to properly release memory allocated for segments returned by the
- * `pv_falcon_process()` functions.
+ * `pv_falcon_process()` and `pv_falcon_process_file()` functions.
  *
  * @param segments Pointer to the array of segments to be deleted.
  */