# analyzeAudio
Measure one or more aspects of one or more audio files.
## Note well: FFmpeg & FFprobe binaries must be in PATH
Some options to [download FFmpeg and FFprobe](https://www.ffmpeg.org/download.html) at ffmpeg.org.
## Some ways to use this package
### Use `analyzeAudioFile` to measure one or more aspects of a single audio file
```python
from analyzeAudio import analyzeAudioFile
listAspectNames = ['LUFS integrated',
'RMS peak',
'SRMR mean',
'Spectral Flatness mean']
listMeasurements = analyzeAudioFile(pathFilename, listAspectNames)
```
### Use `getListAvailableAudioAspects` to get a crude list of aspects this package can measure
The aspect names are accurate, but the lack of additional documentation can make things challenging. 'Zero-crossing rate', 'Zero-crossing rate mean', and 'Zero-crossings rate', for example, are different from each other. ("... lack of additional documentation ...")
```python
import analyzeAudio
analyzeAudio.getListAvailableAudioAspects()
```
### Use `analyzeAudioListPathFilenames` to measure one or more aspects of individual file in a list of audio files
### Use `audioAspects` to call an analyzer function by using the name of the aspect you wish to measure
```python
from analyzeAudio import audioAspects
SI_SDR_channelsMean = audioAspects['SI-SDR mean']['analyzer'](pathFilenameAudioFile, pathFilenameDifferentAudioFile)
```
Retrieve the names of the parameters for an analyzer function with the `['analyzerParameters']` key-name.
```python
from analyzeAudio import audioAspects
print(audioAspects['Chromagram']['analyzerParameters'])
```
## Install this package
### From Github
```sh
pip install analyzeAudio@git+https://github.com/hunterhogan/analyzeAudio.git
```
### From a local directory
#### Windows
```powershell
git clone https://github.com/hunterhogan/analyzeAudio.git \path\to\analyzeAudio
pip install analyzeAudio@file:\path\to\analyzeAudio
```
#### POSIX
```bash
git clone https://github.com/hunterhogan/analyzeAudio.git /path/to/analyzeAudio
pip install analyzeAudio@file:/path/to/analyzeAudio
```
## Install updates
```sh
pip install --upgrade analyzeAudio@git+https://github.com/hunterhogan/analyzeAudio.git
```
Raw data
{
"_id": null,
"home_page": null,
"name": "analyzeAudio",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "audio, analysis, measurement, metrics, torch",
"author": null,
"author_email": "Hunter Hogan <HunterHogan@pm.me>",
"download_url": "https://files.pythonhosted.org/packages/bb/f5/c7e85baac0e9b535929ee39673b1628d38dff8ea9580102b2d60550e622f/analyzeaudio-0.0.11.tar.gz",
"platform": null,
"description": "# analyzeAudio\n\nMeasure one or more aspects of one or more audio files.\n\n## Note well: FFmpeg & FFprobe binaries must be in PATH\n\nSome options to [download FFmpeg and FFprobe](https://www.ffmpeg.org/download.html) at ffmpeg.org.\n\n## Some ways to use this package\n\n### Use `analyzeAudioFile` to measure one or more aspects of a single audio file\n\n```python\nfrom analyzeAudio import analyzeAudioFile\nlistAspectNames = ['LUFS integrated', \n 'RMS peak', \n 'SRMR mean', \n 'Spectral Flatness mean']\nlistMeasurements = analyzeAudioFile(pathFilename, listAspectNames)\n```\n\n### Use `getListAvailableAudioAspects` to get a crude list of aspects this package can measure\n\nThe aspect names are accurate, but the lack of additional documentation can make things challenging. 'Zero-crossing rate', 'Zero-crossing rate mean', and 'Zero-crossings rate', for example, are different from each other. (\"... lack of additional documentation ...\")\n\n```python\nimport analyzeAudio\nanalyzeAudio.getListAvailableAudioAspects()\n```\n\n### Use `analyzeAudioListPathFilenames` to measure one or more aspects of individual file in a list of audio files\n\n### Use `audioAspects` to call an analyzer function by using the name of the aspect you wish to measure\n\n```python\nfrom analyzeAudio import audioAspects\nSI_SDR_channelsMean = audioAspects['SI-SDR mean']['analyzer'](pathFilenameAudioFile, pathFilenameDifferentAudioFile)\n```\n\nRetrieve the names of the parameters for an analyzer function with the `['analyzerParameters']` key-name.\n\n```python\nfrom analyzeAudio import audioAspects\nprint(audioAspects['Chromagram']['analyzerParameters'])\n```\n\n## Install this package\n\n### From Github\n\n```sh\npip install analyzeAudio@git+https://github.com/hunterhogan/analyzeAudio.git\n```\n\n### From a local directory\n\n#### Windows\n\n```powershell\ngit clone https://github.com/hunterhogan/analyzeAudio.git \\path\\to\\analyzeAudio\npip install analyzeAudio@file:\\path\\to\\analyzeAudio\n```\n\n#### POSIX\n\n```bash\ngit clone https://github.com/hunterhogan/analyzeAudio.git /path/to/analyzeAudio\npip install analyzeAudio@file:/path/to/analyzeAudio\n```\n\n## Install updates\n\n```sh\npip install --upgrade analyzeAudio@git+https://github.com/hunterhogan/analyzeAudio.git\n```\n",
"bugtrack_url": null,
"license": "CC-BY-NC-4.0",
"summary": "Measure one or more aspects of one or more audio files.",
"version": "0.0.11",
"project_urls": {
"Donate": "https://www.patreon.com/integrated",
"Homepage": "https://github.com/hunterhogan/analyzeAudio"
},
"split_keywords": [
"audio",
" analysis",
" measurement",
" metrics",
" torch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df79ac5558271758c7e823fd45e8c88617af2d9aba44cdb46cf33e02c81b4315",
"md5": "6600d3c51fe0345d222e9e4119ee0103",
"sha256": "970d007de3950bde807cde3f1ef81b4eac87d84f5c38ea3ee52838555944f0dc"
},
"downloads": -1,
"filename": "analyzeAudio-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6600d3c51fe0345d222e9e4119ee0103",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 12001,
"upload_time": "2025-01-26T01:37:00",
"upload_time_iso_8601": "2025-01-26T01:37:00.508363Z",
"url": "https://files.pythonhosted.org/packages/df/79/ac5558271758c7e823fd45e8c88617af2d9aba44cdb46cf33e02c81b4315/analyzeAudio-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bbf5c7e85baac0e9b535929ee39673b1628d38dff8ea9580102b2d60550e622f",
"md5": "ac54b2268a7139f46cb497594ee970a9",
"sha256": "e96d61889b9da2f5b9715dcb76ba924b12038a35d43da2cc15e81e7972d8db98"
},
"downloads": -1,
"filename": "analyzeaudio-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "ac54b2268a7139f46cb497594ee970a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11046,
"upload_time": "2025-01-26T01:37:02",
"upload_time_iso_8601": "2025-01-26T01:37:02.620293Z",
"url": "https://files.pythonhosted.org/packages/bb/f5/c7e85baac0e9b535929ee39673b1628d38dff8ea9580102b2d60550e622f/analyzeaudio-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-26 01:37:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hunterhogan",
"github_project": "analyzeAudio",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "analyzeaudio"
}
JSON
