# Falcon Binding for Python
## Falcon Speaker Diarization Engine
Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
Falcon is an on-device speaker diarization engine. Falcon is:
- Private; All voice processing runs locally.
- Cross-Platform:
- Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
- Raspberry Pi (3, 4, 5)
## Compatibility
- Python 3.8+
- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), and Raspberry Pi (3, 4, 5).
## Installation
```console
pip3 install pvfalcon
```
## AccessKey
Falcon requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Falcon 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 perform speaker diarization on an audio file:
```python
import pvfalcon
handle = pvfalcon.create(access_key='${ACCESS_KEY}')
segments = handle.process_file('${AUDIO_PATH}')
for segment in segments:
print("{speaker tag=%d - start_sec=%.2f end_sec=%.2f}"
% (segment.speaker_tag, segment.start_sec, segment.end_sec))
```
Replace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/) and
`${AUDIO_PATH}` to the path an audio file. Finally, when done be sure to explicitly release the resources using
`handle.delete()`.
## Demos
[pvfalcondemo](https://pypi.org/project/pvfalcondemo/) provides command-line utilities for processing audio using
Falcon.
Raw data
{
"_id": null,
"home_page": "https://github.com/Picovoice/falcon",
"name": "pvfalcon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Speaker Diarization, Speaker Identification, Voice Identification",
"author": "Picovoice",
"author_email": "hello@picovoice.ai",
"download_url": "https://files.pythonhosted.org/packages/e4/13/f81612b7caff42d9620eb85d1b8ed4c5c7dd9312e974fcc1d05a21842f71/pvfalcon-1.0.2.tar.gz",
"platform": null,
"description": "# Falcon Binding for Python\n\n## Falcon Speaker Diarization Engine\n\nMade in Vancouver, Canada by [Picovoice](https://picovoice.ai)\n\nFalcon is an on-device speaker diarization engine. Falcon is:\n\n- Private; All voice processing runs locally.\n- Cross-Platform:\n - Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)\n - Raspberry Pi (3, 4, 5)\n\n## Compatibility\n\n- Python 3.8+\n- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), and Raspberry Pi (3, 4, 5).\n\n## Installation\n\n```console\npip3 install pvfalcon\n```\n\n## AccessKey\n\nFalcon requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Falcon SDKs.\nYou can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.\nSignup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.\n\n### Usage\n\nCreate an instance of the engine and perform speaker diarization on an audio file:\n\n```python\nimport pvfalcon\n\nhandle = pvfalcon.create(access_key='${ACCESS_KEY}')\n\nsegments = handle.process_file('${AUDIO_PATH}')\nfor segment in segments:\n print(\"{speaker tag=%d - start_sec=%.2f end_sec=%.2f}\" \n % (segment.speaker_tag, segment.start_sec, segment.end_sec))\n```\n\nReplace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/) and\n`${AUDIO_PATH}` to the path an audio file. Finally, when done be sure to explicitly release the resources using\n`handle.delete()`.\n\n## Demos\n\n[pvfalcondemo](https://pypi.org/project/pvfalcondemo/) provides command-line utilities for processing audio using\nFalcon.\n",
"bugtrack_url": null,
"license": null,
"summary": "Falcon Speaker Diarization Engine",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/Picovoice/falcon"
},
"split_keywords": [
"speaker diarization",
" speaker identification",
" voice identification"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5213d2c7e0aa06a7ae31a562bb87b2947e490d347c1c04a6cf0ce926084bca98",
"md5": "8fca08c389a78050d25e39acd8350a1d",
"sha256": "6e0adfb475ffb9350ef3742e9cfbcd210fc354ba7789b70ed24829387185827b"
},
"downloads": -1,
"filename": "pvfalcon-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fca08c389a78050d25e39acd8350a1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13880689,
"upload_time": "2024-08-22T19:45:02",
"upload_time_iso_8601": "2024-08-22T19:45:02.683666Z",
"url": "https://files.pythonhosted.org/packages/52/13/d2c7e0aa06a7ae31a562bb87b2947e490d347c1c04a6cf0ce926084bca98/pvfalcon-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e413f81612b7caff42d9620eb85d1b8ed4c5c7dd9312e974fcc1d05a21842f71",
"md5": "79b21f7fce0e8caeda957f8e73de2029",
"sha256": "0b52c643e6353f6c493e8351b904851dfab9198c09bf4cabb88fa74dc2c95491"
},
"downloads": -1,
"filename": "pvfalcon-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "79b21f7fce0e8caeda957f8e73de2029",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13875590,
"upload_time": "2024-08-22T19:45:06",
"upload_time_iso_8601": "2024-08-22T19:45:06.463303Z",
"url": "https://files.pythonhosted.org/packages/e4/13/f81612b7caff42d9620eb85d1b8ed4c5c7dd9312e974fcc1d05a21842f71/pvfalcon-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 19:45:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Picovoice",
"github_project": "falcon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pvfalcon"
}
JSON
