Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dunyakirkali/format_parser.ex
The owls are not what they seem
https://github.com/dunyakirkali/format_parser.ex
elixir hex
Last synced: about 2 months ago
JSON representation
The owls are not what they seem
- Host: GitHub
- URL: https://github.com/dunyakirkali/format_parser.ex
- Owner: dunyakirkali
- License: apache-2.0
- Created: 2018-02-11T20:28:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-23T04:15:19.000Z (8 months ago)
- Last Synced: 2024-04-26T07:09:18.884Z (about 2 months ago)
- Topics: elixir, hex
- Language: Elixir
- Homepage:
- Size: 41.7 MB
- Stars: 22
- Watchers: 2
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-elixir - format_parser.ex - Elixir library to figure out the type and the format of a file. (Files and Directories)
README
# FormatParser
[](https://coveralls.io/r/ahtung/format_parser.ex?branch=master)
[](https://hex.pm/packages/format_parser)
[](https://hex.pm/packages/format_parser)
FormatParser can be used to figure out the type and the format of a file.
It also can extract some additional information.
Documentation can be found [here](https://hexdocs.pm/format_parser).
Inspired heavily by [format_parser](https://github.com/WeTransfer/format_parser/).
## Basic usage
```elixir
# Image
{:ok, file} = File.read("myimage.png")
match = FormatParser.parse(file)
match.nature #=> :image
match.format #=> :gif
match.width_px #=> 256
match.height_px #=> 256
match.intrinsics[:filter_method] #=> 0
# Video
{:ok, file} = File.read("myvideo.flv")
match = FormatParser.parse(file)
match.nature #=> :video
match.format #=> :flv
# Document
{:ok, file} = File.read("mydocument.rtf")
match = FormatParser.parse(file)
match.nature #=> :document
match.format #=> :rtf
# Audio
{:ok, file} = File.read("myaudio.wav")
match = FormatParser.parse(file)
match.nature #=> :audio
match.format #=> :wav
match.sample_rate_hz #=> 44100
match.num_audio_channels #=> 2
# Font
{:ok, file} = File.read("myfont.ttf")
match = FormatParser.parse(file)
match.nature #=> :font
match.format #=> :ttf
```
## Supported Formats
### Audio
| Type | Nature | Format | Sample Rate | # of Channels | Intrinsics |
| :---: | :----: | :----: | :---------: | :-----------: | :-------------------------------------- |
| aiff | x | x | | x | num_frames, bits_per_sample |
| wav | x | x | x | x | byte_rate, block_align, bits_per_sample |
| ogg | x | x | x | x | |
| flac | x | x | x | x | |
### Video
| Type | Nature | Format |
| :--: | :----: | :----: |
| flv | x | x |
### Document
| Type | Nature | Format | Intrinsics |
| :--: | :----: | :----: | :--------- |
| rtf | x | x | |
| pdf | x | x | page_count |
### Image
| Type | Nature | Format | Width | Height | Intrinsics |
| :--: | :----: | :----: | :---: | :----: | :------------------------------------------------------------------------------ |
| jpg | x | x | | | |
| gif | x | x | x | x | |
| ico | x | x | x | x | num_color_palette, color_planes, bits_per_pixel |
| cur | x | x | x | x | num_color_palette, hotspot_horizontal_coords, hotspot_vertical_coords |
| cr2 | x | x | x | x | date_time, model, preview_byte_count, preview_offset |
| nef | x | x | x | x | date_time, model, preview_byte_count, preview_offset |
| tif | x | x | x | x | |
| bmp | x | x | x | x | |
| png | x | x | x | x | bit_depth, color_type, compression_method, crc, filter_method, interlace_method |
| psd | x | x | x | x | |
| jb2 | x | x | | | |
| xcf | x | x | | | |
| exr | x | x | | | |
| webp | x | x | | | |
### Font
| Type | Nature | Format |
| :--: | :----: | :----: |
| ttf | x | x |
| otf | x | x |
| fon | x | x |
## Installation
Add the following to your `mix.exs` file
```elixir
def deps do
[
{:format_parser, "~> 1.4.0"}
]
end
```
And run `mix deps.get`
## Contribute
Please feel free to fork and send us a PR or open up an issue.