wader/fq

mirror of https://github.com/wader/fq.git synced 2024-09-11 12:05:39 +03:00

jq for binary formats

binary cli decode go hexdump jq json query repl starred-repo starred-wader-repo

Go to file

Mattias Wadman 970465996c Init		2021-09-12 13:08:42 +02:00
.github/workflows	Init	2021-09-12 13:08:42 +02:00
.vscode	Init	2021-09-12 13:08:42 +02:00
dev	Init	2021-09-12 13:08:42 +02:00
doc	Init	2021-09-12 13:08:42 +02:00
format	Init	2021-09-12 13:08:42 +02:00
internal	Init	2021-09-12 13:08:42 +02:00
pkg	Init	2021-09-12 13:08:42 +02:00
.golangci.yml	Init	2021-09-12 13:08:42 +02:00
.goreleaser.yml	Init	2021-09-12 13:08:42 +02:00
Bumpfile	Init	2021-09-12 13:08:42 +02:00
Dockerfile	Init	2021-09-12 13:08:42 +02:00
go.mod	Init	2021-09-12 13:08:42 +02:00
go.sum	Init	2021-09-12 13:08:42 +02:00
LICENSE	Init	2021-09-12 13:08:42 +02:00
main.go	Init	2021-09-12 13:08:42 +02:00
Makefile	Init	2021-09-12 13:08:42 +02:00
README.md	Init	2021-09-12 13:08:42 +02:00

README.md

fq

Tool, language and decoders for querying and exploring binary data.

_{# Overview of mp3 file
$ fq . file.mp3
|00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f| |.: {} file.mp3 (mp3)
0x000|49 44 33 04 00 00 00 00 15 39 54 53 53 45 00 00|ID3......9TSSE..| headers: [1]
* |until 0xac2.7 (2755) | |
0xac0| ff fb 40 c0 00 00 00 00 00 00 00 00 00| ..@..........| frames: [3]
0xad0|00 00 00 00 00 00 00 00 49 6e 66 6f 00 00 00 0f|........Info....|
* |until 0xd19.7 (end) (599) | |
| | | footers: [0]

# Show ID3v2 APIC frame
$ fq '.headers[].frames[] | select(.id == "APIC")' file.mp3
|00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f| |.headers[0].frames[1]: {}
0x020| 41 50 49 43 | APIC | id: "APIC" (Attached picture)
0x020| 00 00 15 0c | .... | size: 2700
0x020| 00 00 | .. | flags: {}
0x020| 03 | . | text_encoding: UTF-8 (3)
0x020| 69 6d| im| mime_type: "image/png"
0x030|61 67 65 2f 70 6e 67 00 |age/png. |
0x030| 00 | . | picture_type: 0
0x030| 00 | . | description: ""
0x030| 89 50 4e 47 0d 0a| .PNG..| picture: {} (png)
0x040|1a 0a 00 00 00 0d 49 48 44 52 00 00 01 40 00 00|......IHDR...@..|
* |until 0xab8.7 (2687) | |

# Resolution of embedded PNG file
$ fq '.headers[].frames[] | select(.id == "APIC").picture.chunks[] | select(.type == "IHDR") | {width, height}' file.mp3
{
"height": 240,
"width": 320
}

# Extract PNG file
$ fq '.headers[].frames[] | select(.id == "APIC")?.picture._bits' file.mp3 > file.png
$ file file.png
file.png: PNG image data, 320 x 240, 8-bit/color RGB, non-interlaced

# Codecs in a mp4 file
$ fq '[.. | select(.type == "stsd")?.boxes[].type]' file.mp4
[
"avc1",
"mp4a"
]}

Install

Download archive from releases page for your platform, unarchive and move the executable to PATH.

Homebrew

# install latest release
brew install wader/tap/fq

Build from source

Make sure you have go 1.16 or later then do:

# build latest master
go install github.com/wader/fq@latest

and the binary should end up at $GOPATH/bin/fq.

Usage

Basic usage is:

Usage: fq [OPTIONS] [EXPR] [FILE...]

For more usage details see usage.md.

Supported formats

aac_frame, adts, adts_frame, apev2, av1_ccr, av1_frame, av1_obu, avc_au, avc_dcr, avc_nalu, avc_pps, avc_sei, avc_sps, bzip2, dns, elf, exif, flac, flac_frame, flac_metadatablock, flac_picture, gif, gzip, hevc_au, hevc_dcr, hevc_nalu, icc_profile, id3v1, id3v11, id3v2, jpeg, json, matroska, mp3, mp3_frame, mp4, mpeg_asc, mpeg_es, mpeg_pes, mpeg_pes_packet, mpeg_spu, mpeg_ts, ogg, ogg_page, opus_packet, png, protobuf, protobuf_widevine, raw, tar, tiff, vorbis_comment, vorbis_packet, vp8_frame, vp9_cfm, vp9_frame, vpx_ccr, wav, webp, xing

For more format details see usage.md.

TODO and ideas

See TODO.md

Development

See dev.md

This project would not be possible without itchyny's jq implementation gojq. Also want to thank HexFiend for inspiration and ideas and stedolan for inventing the jq language.

Similar projects: