pveagle 0.1.0__tar.gz

pveagle-0.1.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include pveagle/LICENSE
+include pveagle/__init__.py
+include pveagle/_factory.py
+include pveagle/_eagle.py
+include pveagle/_util.py
+recursive-include pveagle/lib *

pveagle-0.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.1
+Name: pveagle
+Version: 0.1.0
+Summary: Eagle Speaker Recognition Engine
+Home-page: https://github.com/Picovoice/eagle
+Author: Picovoice
+Author-email: hello@picovoice.ai
+Keywords: Speaker Recognition,Speaker Identification,Voice Recognition,Voice Identification
+Classifier: Development Status :: 4 - Beta
+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
+
+# Eagle Speaker Recognition Engine
+
+Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
+
+Eagle is an on-device speaker recognition engine. Eagle 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 pveagle
+```
+
+## AccessKey
+
+Eagle requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Eagle
+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
+
+Eagle has two distinct steps: Enrollment and Recognition. In the enrollment step, Eagle analyzes a series of
+utterances from a particular speaker to learn their unique voiceprint. This step produces an `EagleProfile` object,
+which can be stored and utilized during inference. During the Recognition step, Eagle compares the incoming frames of
+audio to the voiceprints of all enrolled speakers in real-time to determine the similarity between them.
+
+### Speaker Enrollment
+
+Create an instance of the profiler:
+
+```python
+import pveagle
+
+# AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
+access_key = "${ACCESS_KEY}"
+eagle_profiler = pveagle.create_profiler(access_key)
+```
+
+`EagleProfiler` is responsible for processing and enrolling PCM audio data, with the valid audio sample rate determined
+by `eagle_profiler.sample_rate`. The audio data must be 16-bit linearly-encoded and single-channel.
+
+When passing samples to `eagle_profiler.enroll`, the number of samples must be at
+least `eagle_profiler.min_enroll_samples` to ensure sufficient data for enrollment. The percentage value
+obtained from this process indicates the progress of enrollment, while the feedback value can be utilized to determine
+the status of the enrollment process.
+
+```python
+def get_next_enroll_audio_data(num_samples):
+    pass
+
+
+percentage = 0.0
+while percentage < 100.0:
+    percentage, feedback = eagle_profiler.enroll(get_next_enroll_audio_data(eagle_profiler.min_enroll_samples))
+    print(feedback.name)
+```
+
+After the percentage reaches 100%, the enrollment process is considered complete. While it is possible to continue
+providing additional audio data to the profiler to improve the accuracy of the voiceprint, it is not necessary to do so.
+Moreover, if the audio data submitted is unsuitable for enrollment, the feedback value will indicate the reason, and the
+enrollment progress will remain unchanged.
+
+```python
+speaker_profile = eagle_profiler.export()
+```
+
+The `eagle_profiler.export()` function produces an `EagleProfile` object, which can be converted into a binary form
+using the `EagleProfile.to_bytes()` method. This binary representation can be saved and subsequently retrieved using
+the `EagleProfile.from_bytes()` method.
+
+To reset the profiler and enroll a new speaker, the `eagle_profiler.reset()` method can be used. This method clears all
+previously stored data, making it possible to start a new enrollment session with a different speaker.
+
+Finally, when done be sure to explicitly release the resources:
+
+```python
+eagle_profiler.delete()
+```
+
+### Speaker Recognition
+
+Create an instance of the engine with one or more speaker profiles from the `EagleProfiler`:
+
+```python
+eagle = pveagle.create_recognizer(access_key, speaker_profile)
+```
+
+When initialized, `eagle.sample_rate` specifies the valid sample rate for Eagle. The expected length of a frame, or the
+number of audio samples in an input array, is defined by `eagle.frame_length`.
+
+Like the profiler, Eagle is designed to work with single-channel audio that is encoded using 16-bit linear PCM.
+
+```python
+def get_next_audio_frame():
+    pass
+
+
+while True:
+    scores = eagle.process(get_next_audio_frame())
+```
+
+The `scores` array contains floating-point numbers that indicate the similarity between the input audio frame and the
+enrolled speakers. Each value in the array corresponds to a specific enrolled speaker, maintaining the same order as the
+speaker profiles provided during initialization. The values in the array range from 0.0 to 1.0, where higher values
+indicate a stronger degree of similarity.
+
+Finally, when done be sure to explicitly release the resources:
+
+```python
+eagle.delete()
+```
+
+## Demos
+<!-- markdown-link-check-disable -->
+[pveagledemo](https://pypi.org/project/pveagledemo/) provides command-line utilities for processing real-time
+audio (i.e. microphone) and files using Eagle.
+<!-- markdown-link-check-enable -->

pveagle-0.1.0/README.md

@@ -0,0 +1,128 @@
+# Eagle Speaker Recognition Engine
+
+Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
+
+Eagle is an on-device speaker recognition engine. Eagle 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 pveagle
+```
+
+## AccessKey
+
+Eagle requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Eagle
+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
+
+Eagle has two distinct steps: Enrollment and Recognition. In the enrollment step, Eagle analyzes a series of
+utterances from a particular speaker to learn their unique voiceprint. This step produces an `EagleProfile` object,
+which can be stored and utilized during inference. During the Recognition step, Eagle compares the incoming frames of
+audio to the voiceprints of all enrolled speakers in real-time to determine the similarity between them.
+
+### Speaker Enrollment
+
+Create an instance of the profiler:
+
+```python
+import pveagle
+
+# AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
+access_key = "${ACCESS_KEY}"
+eagle_profiler = pveagle.create_profiler(access_key)
+```
+
+`EagleProfiler` is responsible for processing and enrolling PCM audio data, with the valid audio sample rate determined
+by `eagle_profiler.sample_rate`. The audio data must be 16-bit linearly-encoded and single-channel.
+
+When passing samples to `eagle_profiler.enroll`, the number of samples must be at
+least `eagle_profiler.min_enroll_samples` to ensure sufficient data for enrollment. The percentage value
+obtained from this process indicates the progress of enrollment, while the feedback value can be utilized to determine
+the status of the enrollment process.
+
+```python
+def get_next_enroll_audio_data(num_samples):
+    pass
+
+
+percentage = 0.0
+while percentage < 100.0:
+    percentage, feedback = eagle_profiler.enroll(get_next_enroll_audio_data(eagle_profiler.min_enroll_samples))
+    print(feedback.name)
+```
+
+After the percentage reaches 100%, the enrollment process is considered complete. While it is possible to continue
+providing additional audio data to the profiler to improve the accuracy of the voiceprint, it is not necessary to do so.
+Moreover, if the audio data submitted is unsuitable for enrollment, the feedback value will indicate the reason, and the
+enrollment progress will remain unchanged.
+
+```python
+speaker_profile = eagle_profiler.export()
+```
+
+The `eagle_profiler.export()` function produces an `EagleProfile` object, which can be converted into a binary form
+using the `EagleProfile.to_bytes()` method. This binary representation can be saved and subsequently retrieved using
+the `EagleProfile.from_bytes()` method.
+
+To reset the profiler and enroll a new speaker, the `eagle_profiler.reset()` method can be used. This method clears all
+previously stored data, making it possible to start a new enrollment session with a different speaker.
+
+Finally, when done be sure to explicitly release the resources:
+
+```python
+eagle_profiler.delete()
+```
+
+### Speaker Recognition
+
+Create an instance of the engine with one or more speaker profiles from the `EagleProfiler`:
+
+```python
+eagle = pveagle.create_recognizer(access_key, speaker_profile)
+```
+
+When initialized, `eagle.sample_rate` specifies the valid sample rate for Eagle. The expected length of a frame, or the
+number of audio samples in an input array, is defined by `eagle.frame_length`.
+
+Like the profiler, Eagle is designed to work with single-channel audio that is encoded using 16-bit linear PCM.
+
+```python
+def get_next_audio_frame():
+    pass
+
+
+while True:
+    scores = eagle.process(get_next_audio_frame())
+```
+
+The `scores` array contains floating-point numbers that indicate the similarity between the input audio frame and the
+enrolled speakers. Each value in the array corresponds to a specific enrolled speaker, maintaining the same order as the
+speaker profiles provided during initialization. The values in the array range from 0.0 to 1.0, where higher values
+indicate a stronger degree of similarity.
+
+Finally, when done be sure to explicitly release the resources:
+
+```python
+eagle.delete()
+```
+
+## Demos
+<!-- markdown-link-check-disable -->
+[pveagledemo](https://pypi.org/project/pveagledemo/) provides command-line utilities for processing real-time
+audio (i.e. microphone) and files using Eagle.
+<!-- markdown-link-check-enable -->

pveagle-0.1.0/pveagle/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pveagle-0.1.0/pveagle/__init__.py

@@ -0,0 +1,14 @@
+#
+# Copyright 2023 Picovoice Inc.
+#
+# You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
+# file accompanying this source.
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+#
+
+from ._eagle import *
+from ._factory import *
+from ._util import *