https://github.com/claucambra/flacmetadatakit
A package to parse FLAC files' metadata, locally or remotely
https://github.com/claucambra/flacmetadatakit
flac music streaming swift swift-package-manager
Last synced: 4 months ago
JSON representation
A package to parse FLAC files' metadata, locally or remotely
- Host: GitHub
- URL: https://github.com/claucambra/flacmetadatakit
- Owner: claucambra
- License: lgpl-3.0
- Created: 2024-04-09T17:17:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-12T10:20:17.000Z (12 months ago)
- Last Synced: 2024-12-24T02:52:54.352Z (4 months ago)
- Topics: flac, music, streaming, swift, swift-package-manager
- Language: Swift
- Homepage:
- Size: 1.9 MB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
FLACMetadataKit
===============
`FLACMetadataKit` is a Swift library designed to parse metadata from FLAC audio files either locally or streamed from the internet. It is able to extract information such as stream info, Vorbis comments, picture data, and other relevant metadata in a progressive and efficient manner.
Features
--------
* **Local Parsing:** Parse FLAC metadata directly from local files.
* **Streaming Parsing:** Fetch and parse metadata progressively from remote FLAC files without needing to download the entire file.
* **Support for Multiple Metadata Types:** Handles various types of metadata including StreamInfo, Vorbis Comments, Cue Sheets, Pictures, and more.
* **Error Handling:** Handles parsing issues like incomplete data or non-FLAC content.
Installation
------------
### Swift Package Manager
You can add `FLACMetadataKit` to your project via Swift Package Manager.
Usage
-----
### Parsing Local FLAC Files
```swift
import FLACMetadataKit
let flacData = Data(contentsOf: URL(fileURLWithPath: "path/to/your/file.flac"))
let parser = FLACParser(data: flacData)
do {
let metadata = try parser.parse()
print("Parsed metadata successfully: \(metadata)")
} catch {
print("Error parsing FLAC metadata: \(error)")
}
```
### Streaming FLAC Metadata from the Internet
```swift
import FLACMetadataKit
import Alamofire
let url = URL(string: "http://example.com/file.flac")!
let session = Alamofire.Session.default
let fetcher = FLACRemoteMetadataFetcher(url: url, session: session, headers: nil)
Task {
if let metadata = await fetcher.fetch() {
print("Successfully fetched and parsed metadata: \(metadata)")
} else {
print("Failed to fetch metadata.")
}
}
```
Contributing
------------
Contributions to `FLACMetadataKit` are welcome! Here's how you can contribute:
* **Issues:** Submit issues for bugs, enhancements, or features via GitHub Issues.
* **Pull Requests:** We welcome pull requests. Please fork the repository and submit a PR for review.
License
-------
`FLACMetadataKit` is released under the LGPL V3 License. See the `LICENSE` file for more information.