| Name | libCAF JSON |
| Version |
0.1.0b0
JSON |
| download |
| home_page | |
| Summary | Parser and Builder classes related to Apple's Core Audio Format (.caf). |
| upload_time | 2023-08-14 20:24:32 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
construct
construct-dataclasses
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Core Audio Format Parser
[][pypi status]
[][pypi status]
[][pypi status]
[][license]
[][black]
[](https://justhexdata.github.io/CAF)
[pypi status]: https://pypi.org/project/libCAF/
[black]: https://github.com/psf/black
Parser and Builder classes related to Apple's Core Audio Format (.caf).
_**NOTE: This is a work in progress**_
## Core Audio Format
> _"Apple’s Core Audio Format (CAF) is a file format for storing and transporting digital audio data. It simplifies the management and manipulation of many types of audio data without the file-size limitations of other audio file formats."_
* [MusicAudio/Reference/CAFSpec](https://developer.apple.com/library/archive/documentation/MusicAudio/Reference/CAFSpec/CAF_intro/CAF_intro.html)
## Installation
You can install _libCAF_ via [pip] from [PyPI]:
```console
$ pip install libcaf
```
and to build the docs you need `make` to be installed:
```console
$ pip install -r docs/requirements.txt
$ cd docs && make html
```
## Usage
The python package provided within this repository supports parsing ``caf`` archives into an object model. More detailed information about the implementation and fields of each class, please refer to the documentation available on [Github-Pages].
### Parsing CAF Files
```python
>>> from libcaf import *
>>> data = caf.parse_file("file.caf")
>>> data
caf_t(m_header=caf__header_t(m_file_type=b'caff', m_file_version=1, m_file_flags=0), ...
```
## Contributing
Contributions are very welcome.
To learn more, see the [Contributor Guide].
## License
Distributed under the terms of the [MIT license][license],
_Core Audio Format Parser_ is free and open source software.
## Issues
If you encounter any problems,
please [file an issue] along with a detailed description.
[pypi]: https://pypi.org/
[file an issue]: https://github.com/JustHexData/CAF/issues
[pip]: https://pip.pypa.io/
<!-- github-only -->
[Github-Pages]: https://justhexdata.github.io/CAF
[license]: https://github.com/JustHexData/CAF/blob/main/LICENSE
[contributor guide]: https://github.com/JustHexData/blob/main/CONTRIBUTING.md
Raw data
{
"_id": null,
"home_page": "",
"name": "libCAF",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "MatrixEditor <not@supported.com>",
"download_url": "https://files.pythonhosted.org/packages/1c/0e/df38947cc427848ae97e7d2ea58a27b4dfdf798693d49cd2ea42051c6bb9/libCAF-0.1.0b0.tar.gz",
"platform": null,
"description": "# Core Audio Format Parser\r\n\r\n[][pypi status]\r\n[][pypi status]\r\n[][pypi status]\r\n[][license]\r\n\r\n[][black]\r\n[](https://justhexdata.github.io/CAF)\r\n\r\n\r\n[pypi status]: https://pypi.org/project/libCAF/\r\n[black]: https://github.com/psf/black\r\n\r\nParser and Builder classes related to Apple's Core Audio Format (.caf).\r\n\r\n_**NOTE: This is a work in progress**_\r\n\r\n## Core Audio Format\r\n\r\n> _\"Apple\u2019s Core Audio Format (CAF) is a file format for storing and transporting digital audio data. It simplifies the management and manipulation of many types of audio data without the file-size limitations of other audio file formats.\"_\r\n\r\n* [MusicAudio/Reference/CAFSpec](https://developer.apple.com/library/archive/documentation/MusicAudio/Reference/CAFSpec/CAF_intro/CAF_intro.html)\r\n\r\n## Installation\r\n\r\nYou can install _libCAF_ via [pip] from [PyPI]:\r\n\r\n```console\r\n$ pip install libcaf\r\n```\r\n\r\nand to build the docs you need `make` to be installed:\r\n```console\r\n$ pip install -r docs/requirements.txt\r\n$ cd docs && make html\r\n```\r\n\r\n## Usage\r\n\r\nThe python package provided within this repository supports parsing ``caf`` archives into an object model. More detailed information about the implementation and fields of each class, please refer to the documentation available on [Github-Pages].\r\n\r\n### Parsing CAF Files\r\n\r\n```python\r\n>>> from libcaf import *\r\n>>> data = caf.parse_file(\"file.caf\")\r\n>>> data\r\ncaf_t(m_header=caf__header_t(m_file_type=b'caff', m_file_version=1, m_file_flags=0), ...\r\n```\r\n\r\n## Contributing\r\n\r\nContributions are very welcome.\r\nTo learn more, see the [Contributor Guide].\r\n\r\n## License\r\n\r\nDistributed under the terms of the [MIT license][license],\r\n_Core Audio Format Parser_ is free and open source software.\r\n\r\n## Issues\r\n\r\nIf you encounter any problems,\r\nplease [file an issue] along with a detailed description.\r\n\r\n[pypi]: https://pypi.org/\r\n[file an issue]: https://github.com/JustHexData/CAF/issues\r\n[pip]: https://pip.pypa.io/\r\n\r\n\r\n<!-- github-only -->\r\n\r\n[Github-Pages]: https://justhexdata.github.io/CAF\r\n[license]: https://github.com/JustHexData/CAF/blob/main/LICENSE\r\n[contributor guide]: https://github.com/JustHexData/blob/main/CONTRIBUTING.md\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Parser and Builder classes related to Apple's Core Audio Format (.caf).",
"version": "0.1.0b0",
"project_urls": {
"documentation": "https://justhexdata.github.io/CAF",
"homepage": "https://github.com/JustHexData/CAF",
"repository": "https://github.com/JustHexData/CAF"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08ab01f8943c580f2a446a92297785f8a252a746bd30324dce6f3216a01e5199",
"md5": "36301e2f07791c34b4b6cbdd3c675fc2",
"sha256": "f1eba3f34f4a907757cc083d880b849eafbe4377015bc459adbbba70813999bc"
},
"downloads": -1,
"filename": "libCAF-0.1.0b0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36301e2f07791c34b4b6cbdd3c675fc2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6295,
"upload_time": "2023-08-14T20:24:30",
"upload_time_iso_8601": "2023-08-14T20:24:30.476475Z",
"url": "https://files.pythonhosted.org/packages/08/ab/01f8943c580f2a446a92297785f8a252a746bd30324dce6f3216a01e5199/libCAF-0.1.0b0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c0edf38947cc427848ae97e7d2ea58a27b4dfdf798693d49cd2ea42051c6bb9",
"md5": "e1096e168ffd5336bf787d3c6deced1e",
"sha256": "8aa941b69e8a4c2d37e5837ccaa279ea63a6467549e4581be9101382192b5f67"
},
"downloads": -1,
"filename": "libCAF-0.1.0b0.tar.gz",
"has_sig": false,
"md5_digest": "e1096e168ffd5336bf787d3c6deced1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4721,
"upload_time": "2023-08-14T20:24:32",
"upload_time_iso_8601": "2023-08-14T20:24:32.254739Z",
"url": "https://files.pythonhosted.org/packages/1c/0e/df38947cc427848ae97e7d2ea58a27b4dfdf798693d49cd2ea42051c6bb9/libCAF-0.1.0b0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-14 20:24:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JustHexData",
"github_project": "CAF",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "construct",
"specs": []
},
{
"name": "construct-dataclasses",
"specs": [
[
">=",
"1.1.7"
]
]
}
],
"lcname": "libcaf"
}
