# owl
`owl` is a python project aimed at developing and evaluating the effectiveness of conversion methods from video to audio. The resulting audio could be used to learn certain method and "see" with just sound.
## Requirements
- [`poetry`](https://python-poetry.org/docs/#installation)
- `portaudio-devel` - required by `pyaudio`
## Installation
```
poetry install
```
## Converter hierarchy
The main aim of this project is to be extensible so that new converters can be easily built and integrated into the existing converter hierarchy.
Some converters are already implemented. The most simple ones are the `CurveConverter` family of converters. These converters map a space-filling curve over each frame of the input. Then the curve is walked and mapped with a frequency range. Each pixel's brightness contributes to a single sine-wave's amplitude. All sine waves (one for each pixel) are then combined into the final sound. This conversion technique is simple, but does not convey much information. It is only effective at low resolutions since higher resolutions always turn to white noise.
Another family of converters are the `ScanConverter` family of converters. These converters are dynamic, i.e. a single frame generates a sound which (unlike static converters) cannot be represented as a set of frequencies and their amplitudes. Converters of the `ScanConverter` family split the image into strips (either horizontal, vertical or circular). Then each strip is mapped with a frequency range, same as in the `CurveConverter` family. Each strip's sound is then sequentially played for each frame. A sound cue may be inserted at the start of each frame to signify a frame start to the user.
## Examples
```shell
# each frame walked by hilbert curve of order 1 (2x2)
poetry run owl curve hilbert
# each frame walked by peano curve of order 1 (3x3)
poetry run owl curve peano
# every frame (each 500ms) gets scanned with 4 circles all having 4 samples on each circle
poetry run owl scan circular -c4 -n4 --ms-per-frame 500
# every frame (each 100ms) gets scanned column-wise left to right, 4 columns each having 4 samples
poetry run owl scan horizontal -c4 -n4 --ms-per-frame 100
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Kuba314/owl",
"name": "owl-framework",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "conversion, blindness, visual-aid, video-to-audio",
"author": "Jakub Rozek",
"author_email": "jakub.rozek314@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/74/87/e74ae982e088c2510c44f64d020751afb2b19ef188525ee619e3d34119d6/owl_framework-0.1.1.tar.gz",
"platform": null,
"description": "# owl\n`owl` is a python project aimed at developing and evaluating the effectiveness of conversion methods from video to audio. The resulting audio could be used to learn certain method and \"see\" with just sound.\n\n## Requirements\n- [`poetry`](https://python-poetry.org/docs/#installation)\n- `portaudio-devel` - required by `pyaudio`\n\n## Installation\n```\npoetry install\n```\n\n## Converter hierarchy\nThe main aim of this project is to be extensible so that new converters can be easily built and integrated into the existing converter hierarchy.\n\nSome converters are already implemented. The most simple ones are the `CurveConverter` family of converters. These converters map a space-filling curve over each frame of the input. Then the curve is walked and mapped with a frequency range. Each pixel's brightness contributes to a single sine-wave's amplitude. All sine waves (one for each pixel) are then combined into the final sound. This conversion technique is simple, but does not convey much information. It is only effective at low resolutions since higher resolutions always turn to white noise.\n\nAnother family of converters are the `ScanConverter` family of converters. These converters are dynamic, i.e. a single frame generates a sound which (unlike static converters) cannot be represented as a set of frequencies and their amplitudes. Converters of the `ScanConverter` family split the image into strips (either horizontal, vertical or circular). Then each strip is mapped with a frequency range, same as in the `CurveConverter` family. Each strip's sound is then sequentially played for each frame. A sound cue may be inserted at the start of each frame to signify a frame start to the user.\n\n## Examples\n```shell\n# each frame walked by hilbert curve of order 1 (2x2)\npoetry run owl curve hilbert\n\n# each frame walked by peano curve of order 1 (3x3)\npoetry run owl curve peano\n\n# every frame (each 500ms) gets scanned with 4 circles all having 4 samples on each circle\npoetry run owl scan circular -c4 -n4 --ms-per-frame 500\n\n# every frame (each 100ms) gets scanned column-wise left to right, 4 columns each having 4 samples\npoetry run owl scan horizontal -c4 -n4 --ms-per-frame 100\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Extensible framework for comparing methods of converting video to audio",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/Kuba314/owl",
"Repository": "https://github.com/Kuba314/owl"
},
"split_keywords": [
"conversion",
" blindness",
" visual-aid",
" video-to-audio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d6e1ac5cbe24dffa2e9e09c0e6cbc13ff65e1914808768fb749d90e00c6af4b7",
"md5": "04689066001697bb2b3e4f0a10037140",
"sha256": "48aa2a4d39545a044701896c8003a8e6a7372cd628fbf3fa3336baad90de3cec"
},
"downloads": -1,
"filename": "owl_framework-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "04689066001697bb2b3e4f0a10037140",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 16537,
"upload_time": "2024-04-29T19:56:49",
"upload_time_iso_8601": "2024-04-29T19:56:49.585192Z",
"url": "https://files.pythonhosted.org/packages/d6/e1/ac5cbe24dffa2e9e09c0e6cbc13ff65e1914808768fb749d90e00c6af4b7/owl_framework-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7487e74ae982e088c2510c44f64d020751afb2b19ef188525ee619e3d34119d6",
"md5": "5cb797ab11028f714b74a6d9849be797",
"sha256": "b48eeea882f1517032d9673774c2b3c86682eaa68d3793911a6a5f82d0282698"
},
"downloads": -1,
"filename": "owl_framework-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "5cb797ab11028f714b74a6d9849be797",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 11348,
"upload_time": "2024-04-29T19:56:51",
"upload_time_iso_8601": "2024-04-29T19:56:51.309953Z",
"url": "https://files.pythonhosted.org/packages/74/87/e74ae982e088c2510c44f64d020751afb2b19ef188525ee619e3d34119d6/owl_framework-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 19:56:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Kuba314",
"github_project": "owl",
"github_not_found": true,
"lcname": "owl-framework"
}
JSON
