pvkoala 1.0.1__tar.gz → 2.0.0__tar.gz

{pvkoala-1.0.1 → pvkoala-2.0.0}/MANIFEST.in

@@ -3,4 +3,4 @@ include pvkoala/__init__.py
 include pvkoala/_factory.py
 include pvkoala/_koala.py
 include pvkoala/_util.py
-recursive-include pvkoala/lib/ *
+recursive-include pvkoala/lib *

pvkoala-2.0.0/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: pvkoala
+Version: 2.0.0
+Summary: Koala Noise Suppression Engine.
+Home-page: https://github.com/Picovoice/koala
+Author: Picovoice
+Author-email: hello@picovoice.ai
+License: UNKNOWN
+Description: # Koala Noise Suppression Engine
+        
+        Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
+        
+        Koala is an on-device noise suppression engine. Koala is:
+        
+        - Private; All voice processing runs locally.
+        - Cross-Platform:
+          - Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
+          - Android and iOS
+          - Chrome, Safari, Firefox, and Edge
+          - Raspberry Pi (4, 3) and NVIDIA Jetson Nano
+        
+        ## Compatibility
+        
+        - Python 3.5 or higher
+        - Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (4, 3), and NVIDIA Jetson Nano.
+        
+        ## Installation
+        
+        ```console
+        pip3 install pvkoala
+        ```
+        
+        ## AccessKey
+        
+        Koala requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Koala 
+        SDKs. You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
+        Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
+        
+        ### Usage
+        
+        Create an instance of the engine and enhance audio:
+        
+        ```python
+        import pvkoala
+        
+        koala = pvkoala.create(access_key='${ACCESS_KEY}')
+        
+        def get_next_audio_frame():
+            pass
+        
+        while True:
+            enhanced_audio = koala.process(get_next_audio_frame())
+        ```
+        
+        Replace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/). 
+        The input audio must come from a single-channel stream with integer 16-bit encoding. The sample rate must be identical
+        to `koala.sample_rate`. The stream must be split into *frames* with a fixed length in samples that can be obtained 
+        from `koala.frame_length`.
+        
+        The output of `koala.process()` is a frame of enhanced audio with the same 16-bit integer encoding. The delay in 
+        samples between the start time of the input frame and the start time of the output frame can be attained from 
+        `koala.delay_sample`.
+        
+        In case the next audio frame does not directly follow the previous one, call `koala.reset()`.
+        When done be sure to explicitly release the resources using `koala.delete()`.
+        
+        ## Demos
+        
+        [pvkoalademo](https://pypi.org/project/pvkoalademo/) provides command-line utilities for processing audio using Koala.
+        
+Keywords: Noise Cancellation,Noise Suppression,Noise Removal,Speech Enhancement,Speech Denoising
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Requires-Python: >=3.5
+Description-Content-Type: text/markdown

{pvkoala-1.0.1 → pvkoala-2.0.0}/pvkoala/_koala.py

@@ -16,7 +16,27 @@ from typing import Sequence
 
 
 class KoalaError(Exception):
-    pass
+    def __init__(self, message: str = '', message_stack: Sequence[str] = None):
+        super().__init__(message)
+
+        self._message = message
+        self._message_stack = list() if message_stack is None else message_stack
+
+    def __str__(self):
+        message = self._message
+        if len(self._message_stack) > 0:
+            message += ':'
+            for i in range(len(self._message_stack)):
+                message += '\n  [%d] %s' % (i, self._message_stack[i])
+        return message
+
+    @property
+    def message(self) -> str:
+        return self._message
+
+    @property
+    def message_stack(self) -> Sequence[str]:
+        return self._message_stack
 
 
 class KoalaMemoryError(KoalaError):
@@ -123,15 +143,34 @@ class Koala(object):
 
         library = cdll.LoadLibrary(library_path)
 
+        set_sdk_func = library.pv_set_sdk
+        set_sdk_func.argtypes = [c_char_p]
+        set_sdk_func.restype = None
+
+        set_sdk_func('python'.encode('utf-8'))
+
+        self._get_error_stack_func = library.pv_get_error_stack
+        self._get_error_stack_func.argtypes = [POINTER(POINTER(c_char_p)), POINTER(c_int)]
+        self._get_error_stack_func.restype = self.PicovoiceStatuses
+
+        self._free_error_stack_func = library.pv_free_error_stack
+        self._free_error_stack_func.argtypes = [POINTER(c_char_p)]
+        self._free_error_stack_func.restype = None
+
         init_func = library.pv_koala_init
         init_func.argtypes = [c_char_p, c_char_p, POINTER(POINTER(self.CKoala))]
         init_func.restype = self.PicovoiceStatuses
 
         self._handle = POINTER(self.CKoala)()
 
-        status = init_func(access_key.encode(), model_path.encode(), byref(self._handle))
+        status = init_func(
+            access_key.encode(),
+            model_path.encode(),
+            byref(self._handle))
         if status is not self.PicovoiceStatuses.SUCCESS:
-            raise self._PICOVOICE_STATUS_TO_EXCEPTION[status]()
+            raise self._PICOVOICE_STATUS_TO_EXCEPTION[status](
+                message='Initialization failed',
+                message_stack=self._get_error_stack())
 
         self._delete_func = library.pv_koala_delete
         self._delete_func.argtypes = [POINTER(self.CKoala)]
@@ -144,7 +183,10 @@ class Koala(object):
         status = delay_sample_func(self._handle, delay_sample)
         if status is not self.PicovoiceStatuses.SUCCESS:
             self.delete()
-            raise self._PICOVOICE_STATUS_TO_EXCEPTION[status]()
+            raise self._PICOVOICE_STATUS_TO_EXCEPTION[status](
+                message='Failed to get delay samples',
+                message_stack=self._get_error_stack())
+
         self._delay_sample = delay_sample.value
 
         self._process_func = library.pv_koala_process
@@ -193,7 +235,9 @@ class Koala(object):
 
         status = self._process_func(self._handle, pcm, enhanced_pcm)
         if status is not self.PicovoiceStatuses.SUCCESS:
-            raise self._PICOVOICE_STATUS_TO_EXCEPTION[status]()
+            raise self._PICOVOICE_STATUS_TO_EXCEPTION[status](
+                message='Processing failed',
+                message_stack=self._get_error_stack())
 
         # noinspection PyTypeChecker
         return list(enhanced_pcm)
@@ -206,7 +250,9 @@ class Koala(object):
 
         status = self._reset_func(self._handle)
         if status is not self.PicovoiceStatuses.SUCCESS:
-            raise self._PICOVOICE_STATUS_TO_EXCEPTION[status]()
+            raise self._PICOVOICE_STATUS_TO_EXCEPTION[status](
+                message='Reset failed',
+                message_stack=self._get_error_stack())
 
     def delete(self) -> None:
         """Releases resources acquired by Koala."""
@@ -239,6 +285,21 @@ class Koala(object):
 
         return self._version
 
+    def _get_error_stack(self) -> Sequence[str]:
+        message_stack_ref = POINTER(c_char_p)()
+        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 Koala error state')
+
+        message_stack = list()
+        for i in range(message_stack_depth.value):
+            message_stack.append(message_stack_ref[i].decode('utf-8'))
+
+        self._free_error_stack_func(message_stack_ref)
+
+        return message_stack
+
 
 __all__ = [
     'Koala',

pvkoala-2.0.0/pvkoala.egg-info/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: pvkoala
+Version: 2.0.0
+Summary: Koala Noise Suppression Engine.
+Home-page: https://github.com/Picovoice/koala
+Author: Picovoice
+Author-email: hello@picovoice.ai
+License: UNKNOWN
+Description: # Koala Noise Suppression Engine
+        
+        Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
+        
+        Koala is an on-device noise suppression engine. Koala is:
+        
+        - Private; All voice processing runs locally.
+        - Cross-Platform:
+          - Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
+          - Android and iOS
+          - Chrome, Safari, Firefox, and Edge
+          - Raspberry Pi (4, 3) and NVIDIA Jetson Nano
+        
+        ## Compatibility
+        
+        - Python 3.5 or higher
+        - Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (4, 3), and NVIDIA Jetson Nano.
+        
+        ## Installation
+        
+        ```console
+        pip3 install pvkoala
+        ```
+        
+        ## AccessKey
+        
+        Koala requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Koala 
+        SDKs. You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
+        Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
+        
+        ### Usage
+        
+        Create an instance of the engine and enhance audio:
+        
+        ```python
+        import pvkoala
+        
+        koala = pvkoala.create(access_key='${ACCESS_KEY}')
+        
+        def get_next_audio_frame():
+            pass
+        
+        while True:
+            enhanced_audio = koala.process(get_next_audio_frame())
+        ```
+        
+        Replace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/). 
+        The input audio must come from a single-channel stream with integer 16-bit encoding. The sample rate must be identical
+        to `koala.sample_rate`. The stream must be split into *frames* with a fixed length in samples that can be obtained 
+        from `koala.frame_length`.
+        
+        The output of `koala.process()` is a frame of enhanced audio with the same 16-bit integer encoding. The delay in 
+        samples between the start time of the input frame and the start time of the output frame can be attained from 
+        `koala.delay_sample`.
+        
+        In case the next audio frame does not directly follow the previous one, call `koala.reset()`.
+        When done be sure to explicitly release the resources using `koala.delete()`.
+        
+        ## Demos
+        
+        [pvkoalademo](https://pypi.org/project/pvkoalademo/) provides command-line utilities for processing audio using Koala.
+        
+Keywords: Noise Cancellation,Noise Suppression,Noise Removal,Speech Enhancement,Speech Denoising
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Requires-Python: >=3.5
+Description-Content-Type: text/markdown

{pvkoala-1.0.1 → pvkoala-2.0.0}/setup.py

@@ -32,7 +32,7 @@ for platform in INCLUDE_LIBS:
     shutil.copytree(
         os.path.join(os.path.dirname(__file__), '../../lib', platform),
         os.path.join(package_folder, 'lib', platform))
-manifest_in += "recursive-include pvkoala/lib/ *\n"
+manifest_in += "recursive-include pvkoala/lib *\n"
 
 with open(os.path.join(os.path.dirname(__file__), 'MANIFEST.in'), 'w') as f:
     f.write(manifest_in)
@@ -42,7 +42,7 @@ with open(os.path.join(os.path.dirname(__file__), 'README.md'), 'r') as f:
 
 setuptools.setup(
     name="pvkoala",
-    version="1.0.1",
+    version="2.0.0",
     author="Picovoice",
     author_email="hello@picovoice.ai",
     description="Koala Noise Suppression Engine.",

pvkoala-1.0.1/PKG-INFO

@@ -1,82 +0,0 @@
-Metadata-Version: 2.1
-Name: pvkoala
-Version: 1.0.1
-Summary: Koala Noise Suppression Engine.
-Home-page: https://github.com/Picovoice/koala
-Author: Picovoice
-Author-email: hello@picovoice.ai
-License: UNKNOWN
-Keywords: Noise Cancellation,Noise Suppression,Noise Removal,Speech Enhancement,Speech Denoising
-Platform: UNKNOWN
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
-Requires-Python: >=3.5
-Description-Content-Type: text/markdown
-
-# Koala Noise Suppression Engine
-
-Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
-
-Koala is an on-device noise suppression engine. Koala is:
-
-- Private; All voice processing runs locally.
-- Cross-Platform:
-  - Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
-  - Android and iOS
-  - Chrome, Safari, Firefox, and Edge
-  - Raspberry Pi (4, 3) and NVIDIA Jetson Nano
-
-## Compatibility
-
-- Python 3.5 or higher
-- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (4, 3), and NVIDIA Jetson Nano.
-
-## Installation
-
-```console
-pip3 install pvkoala
-```
-
-## AccessKey
-
-Koala requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Koala 
-SDKs. You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
-Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
-
-### Usage
-
-Create an instance of the engine and enhance audio:
-
-```python
-import pvkoala
-
-koala = pvkoala.create(access_key='${ACCESS_KEY}')
-
-def get_next_audio_frame():
-    pass
-
-while True:
-    enhanced_audio = koala.process(get_next_audio_frame())
-```
-
-Replace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/). 
-The input audio must come from a single-channel stream with integer 16-bit encoding. The sample rate must be identical
-to `koala.sample_rate`. The stream must be split into *frames* with a fixed length in samples that can be obtained 
-from `koala.frame_length`.
-
-The output of `koala.process()` is a frame of enhanced audio with the same 16-bit integer encoding. The delay in 
-samples between the start time of the input frame and the start time of the output frame can be attained from 
-`koala.delay_sample`.
-
-In case the next audio frame does not directly follow the previous one, call `koala.reset()`.
-When done be sure to explicitly release the resources using `koala.delete()`.
-
-## Demos
-
-[pvkoalademo](https://pypi.org/project/pvkoalademo/) provides command-line utilities for processing audio using Koala.
-
-

pvkoala-1.0.1/pvkoala.egg-info/PKG-INFO

@@ -1,82 +0,0 @@
-Metadata-Version: 2.1
-Name: pvkoala
-Version: 1.0.1
-Summary: Koala Noise Suppression Engine.
-Home-page: https://github.com/Picovoice/koala
-Author: Picovoice
-Author-email: hello@picovoice.ai
-License: UNKNOWN
-Keywords: Noise Cancellation,Noise Suppression,Noise Removal,Speech Enhancement,Speech Denoising
-Platform: UNKNOWN
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
-Requires-Python: >=3.5
-Description-Content-Type: text/markdown
-
-# Koala Noise Suppression Engine
-
-Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
-
-Koala is an on-device noise suppression engine. Koala is:
-
-- Private; All voice processing runs locally.
-- Cross-Platform:
-  - Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
-  - Android and iOS
-  - Chrome, Safari, Firefox, and Edge
-  - Raspberry Pi (4, 3) and NVIDIA Jetson Nano
-
-## Compatibility
-
-- Python 3.5 or higher
-- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (4, 3), and NVIDIA Jetson Nano.
-
-## Installation
-
-```console
-pip3 install pvkoala
-```
-
-## AccessKey
-
-Koala requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Koala 
-SDKs. You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
-Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
-
-### Usage
-
-Create an instance of the engine and enhance audio:
-
-```python
-import pvkoala
-
-koala = pvkoala.create(access_key='${ACCESS_KEY}')
-
-def get_next_audio_frame():
-    pass
-
-while True:
-    enhanced_audio = koala.process(get_next_audio_frame())
-```
-
-Replace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/). 
-The input audio must come from a single-channel stream with integer 16-bit encoding. The sample rate must be identical
-to `koala.sample_rate`. The stream must be split into *frames* with a fixed length in samples that can be obtained 
-from `koala.frame_length`.
-
-The output of `koala.process()` is a frame of enhanced audio with the same 16-bit integer encoding. The delay in 
-samples between the start time of the input frame and the start time of the output frame can be attained from 
-`koala.delay_sample`.
-
-In case the next audio frame does not directly follow the previous one, call `koala.reset()`.
-When done be sure to explicitly release the resources using `koala.delete()`.
-
-## Demos
-
-[pvkoalademo](https://pypi.org/project/pvkoalademo/) provides command-line utilities for processing audio using Koala.
-
-