Skip to content

Commit

Permalink
formats: Clenaup naming a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
wader committed May 1, 2023
1 parent f3fc85a commit a4a332b
Show file tree
Hide file tree
Showing 108 changed files with 501 additions and 503 deletions.
2 changes: 1 addition & 1 deletion format/apple/bookmark/apple_bookmark.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
var bookmarkFS embed.FS

func init() {
interp.RegisterFormat(format.AppleBookmark,
interp.RegisterFormat(format.Apple_Bookmark,
&decode.Format{
ProbeOrder: format.ProbeOrderBinUnique,
Description: "Apple BookmarkData",
Expand Down
2 changes: 1 addition & 1 deletion format/apple/macho/macho.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ var machoFS embed.FS

func init() {
interp.RegisterFormat(
format.Macho,
format.MachO,
&decode.Format{
Description: "Mach-O macOS executable",
Groups: []*decode.Group{format.Probe},
Expand Down
4 changes: 2 additions & 2 deletions format/apple/macho/macho_fat.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ var machoFormat decode.Group

func init() {
interp.RegisterFormat(
format.MachoFat,
format.MachO_Fat,
&decode.Format{
Description: "Fat Mach-O macOS executable (multi-architecture)",
Groups: []*decode.Group{format.Probe},
DecodeFn: machoFatDecode,
Dependencies: []decode.Dependency{
{Groups: []*decode.Group{format.Macho}, Out: &machoFormat},
{Groups: []*decode.Group{format.MachO}, Out: &machoFormat},
},
})
}
Expand Down
2 changes: 1 addition & 1 deletion format/ar/ar.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ var probeGroup decode.Group

func init() {
interp.RegisterFormat(
format.Ar,
format.AR,
&decode.Format{
Description: "Unix archive",
Groups: []*decode.Group{format.Probe},
Expand Down
2 changes: 1 addition & 1 deletion format/asn1/asn1_ber.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ var asn1FS embed.FS

func init() {
interp.RegisterFormat(
format.Asn1Ber,
format.ASN1_BER,
&decode.Format{
Description: "ASN1 BER (basic encoding rules, also CER and DER)",
DecodeFn: decodeASN1BER,
Expand Down
2 changes: 1 addition & 1 deletion format/av1/av1_ccr.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (

func init() {
interp.RegisterFormat(
format.Av1Ccr,
format.AV1_CCR,
&decode.Format{
Description: "AV1 Codec Configuration Record",
DecodeFn: ccrDecode,
Expand Down
4 changes: 2 additions & 2 deletions format/av1/av1_frame.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ var av1FrameObuGroup decode.Group

func init() {
interp.RegisterFormat(
format.Av1Frame,
format.AV1_Frame,
&decode.Format{
Description: "AV1 frame",
DecodeFn: frameDecode,
RootArray: true,
RootName: "frame",
Dependencies: []decode.Dependency{
{Groups: []*decode.Group{format.Av1Obu}, Out: &av1FrameObuGroup},
{Groups: []*decode.Group{format.AV1_OBU}, Out: &av1FrameObuGroup},
},
})
}
Expand Down
2 changes: 1 addition & 1 deletion format/av1/av1_obu.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (

func init() {
interp.RegisterFormat(
format.Av1Obu,
format.AV1_OBU,
&decode.Format{
Description: "AV1 Open Bitstream Unit",
DecodeFn: obuDecode,
Expand Down
2 changes: 1 addition & 1 deletion format/avro/avro_ocf.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ var avroOcfFS embed.FS

func init() {
interp.RegisterFormat(
format.AvroOcf,
format.Avro_Ocf,
&decode.Format{
Description: "Avro object container file",
Groups: []*decode.Group{format.Probe},
Expand Down
6 changes: 3 additions & 3 deletions format/bitcoin/bitcoin_blkdat.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ var bitcoinBlockGroup decode.Group

func init() {
interp.RegisterFormat(
format.BitcoinBlkdat,
format.Bitcoin_Blkdat,
&decode.Format{
Description: "Bitcoin blk.dat",
Groups: []*decode.Group{format.Probe},
Dependencies: []decode.Dependency{
{Groups: []*decode.Group{format.BitcoinBlock}, Out: &bitcoinBlockGroup},
{Groups: []*decode.Group{format.Bitcoin_Block}, Out: &bitcoinBlockGroup},
},
DecodeFn: decodeBlkDat,
RootArray: true,
Expand All @@ -26,7 +26,7 @@ func init() {
func decodeBlkDat(d *decode.D) any {
validBlocks := 0
for !d.End() {
d.FieldFormat("block", &bitcoinBlockGroup, format.BitCoinBlockIn{HasHeader: true})
d.FieldFormat("block", &bitcoinBlockGroup, format.Bitcoin_Block_In{HasHeader: true})
validBlocks++
}

Expand Down
8 changes: 4 additions & 4 deletions format/bitcoin/bitcoin_block.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ var bitcoinTranscationGroup decode.Group

func init() {
interp.RegisterFormat(
format.BitcoinBlock,
format.Bitcoin_Block,
&decode.Format{
Description: "Bitcoin block",
Dependencies: []decode.Dependency{
{Groups: []*decode.Group{format.BitcoinTransaction}, Out: &bitcoinTranscationGroup},
{Groups: []*decode.Group{format.Bitcoin_Transaction}, Out: &bitcoinTranscationGroup},
},
DecodeFn: decodeBitcoinBlock,
DefaultInArg: format.BitCoinBlockIn{
DefaultInArg: format.Bitcoin_Block_In{
HasHeader: false,
},
})
Expand All @@ -37,7 +37,7 @@ var rawHexReverse = scalar.BitBufFn(func(s scalar.BitBuf) (scalar.BitBuf, error)
})

func decodeBitcoinBlock(d *decode.D) any {
var bbi format.BitCoinBlockIn
var bbi format.Bitcoin_Block_In
d.ArgAs(&bbi)

size := d.BitsLeft()
Expand Down
2 changes: 1 addition & 1 deletion format/bitcoin/bitcoin_script.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ func (ops opcodeEntries) MapUint(s scalar.Uint) (scalar.Uint, error) {

func init() {
interp.RegisterFormat(
format.BitcoinScript,
format.Bitcoin_Script,
&decode.Format{
Description: "Bitcoin script",
DecodeFn: decodeBitcoinScript,
Expand Down
4 changes: 2 additions & 2 deletions format/bitcoin/bitcoin_transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ var bitcoinScriptGroup decode.Group

func init() {
interp.RegisterFormat(
format.BitcoinTransaction,
format.Bitcoin_Transaction,
&decode.Format{
Description: "Bitcoin transaction",
Dependencies: []decode.Dependency{
{Groups: []*decode.Group{format.BitcoinScript}, Out: &bitcoinScriptGroup},
{Groups: []*decode.Group{format.Bitcoin_Script}, Out: &bitcoinScriptGroup},
},
DecodeFn: decodeBitcoinTranscation,
})
Expand Down
2 changes: 1 addition & 1 deletion format/bson/bson.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ var bsonFS embed.FS

func init() {
interp.RegisterFormat(
format.Bson,
format.BSON,
&decode.Format{
Description: "Binary JSON",
DecodeFn: decodeBSON,
Expand Down
2 changes: 1 addition & 1 deletion format/cbor/cbor.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var cborFS embed.FS

func init() {
interp.RegisterFormat(
format.Cbor,
format.CBOR,
&decode.Format{
Description: "Concise Binary Object Representation",
DecodeFn: decodeCBOR,
Expand Down
6 changes: 3 additions & 3 deletions format/csv/csv.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ var csvFS embed.FS

func init() {
interp.RegisterFormat(
format.Csv,
format.CSV,
&decode.Format{
Description: "Comma separated values",
ProbeOrder: format.ProbeOrderTextFuzzy,
DecodeFn: decodeCSV,
DefaultInArg: format.CSVLIn{
DefaultInArg: format.CSV_In{
Comma: ",",
Comment: "#",
},
Expand All @@ -38,7 +38,7 @@ func init() {
}

func decodeCSV(d *decode.D) any {
var ci format.CSVLIn
var ci format.CSV_In
d.ArgAs(&ci)

var rvs []any
Expand Down
6 changes: 3 additions & 3 deletions format/dns/dns.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ import (

func init() {
interp.RegisterFormat(
format.Dns,
format.DNS,
&decode.Format{
Description: "DNS packet",
Groups: []*decode.Group{format.UdpPayload},
Groups: []*decode.Group{format.UDP_Payload},
DecodeFn: dnsUDPDecode,
})
}
Expand Down Expand Up @@ -263,7 +263,7 @@ func dnsDecode(d *decode.D, hasLengthHeader bool) any {
}

func dnsUDPDecode(d *decode.D) any {
var upi format.UDPPayloadIn
var upi format.UDP_Payload_In
if d.ArgAs(&upi) {
upi.MustIsPort(d.Fatalf, format.UDPPortDomain, format.UDPPortMDNS)
}
Expand Down
6 changes: 3 additions & 3 deletions format/dns/dns_tcp.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ import (

func init() {
interp.RegisterFormat(
format.DnsTcp,
format.DNS_TCP,
&decode.Format{
Description: "DNS packet (TCP)",
Groups: []*decode.Group{format.TcpStream},
Groups: []*decode.Group{format.TCP_Stream},
DecodeFn: dnsTCPDecode,
})
}

func dnsTCPDecode(d *decode.D) any {
var tsi format.TCPStreamIn
var tsi format.TCP_Stream_In
if d.ArgAs(&tsi) {
tsi.MustIsPort(d.Fatalf, format.TCPPortDomain)
}
Expand Down
2 changes: 1 addition & 1 deletion format/elf/elf.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (

func init() {
interp.RegisterFormat(
format.Elf,
format.ELF,
&decode.Format{
Description: "Executable and Linkable Format",
Groups: []*decode.Group{format.Probe},
Expand Down
2 changes: 1 addition & 1 deletion format/fairplay/fairplay.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (

func init() {
interp.RegisterFormat(
format.FairplaySpc,
format.Fairplay_SPC,
&decode.Format{
Description: "FairPlay Server Playback Context",
DecodeFn: fairPlaySPCDecode,
Expand Down
16 changes: 8 additions & 8 deletions format/flac/flac.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,44 +21,44 @@ var flacFrameGroup decode.Group

func init() {
interp.RegisterFormat(
format.Flac,
format.FLAC,
&decode.Format{
Description: "Free Lossless Audio Codec file",
Groups: []*decode.Group{format.Probe},
DecodeFn: flacDecode,
Dependencies: []decode.Dependency{
{Groups: []*decode.Group{format.FlacMetadatablocks}, Out: &flacMetadatablocksGroup},
{Groups: []*decode.Group{format.FlacFrame}, Out: &flacFrameGroup},
{Groups: []*decode.Group{format.FLAC_Metadatablocks}, Out: &flacMetadatablocksGroup},
{Groups: []*decode.Group{format.FLAC_Frame}, Out: &flacFrameGroup},
},
})
}

func flacDecode(d *decode.D) any {
d.FieldUTF8("magic", 4, d.StrAssert("fLaC"))

var streamInfo format.FlacStreamInfo
var flacFrameIn format.FlacFrameIn
var streamInfo format.FLAC_Stream_Info
var flacFrameIn format.FLAC_Frame_In
var framesNDecodedSamples uint64
var streamTotalSamples uint64
var streamDecodedSamples uint64

_, v := d.FieldFormat("metadatablocks", &flacMetadatablocksGroup, nil)
flacMetadatablockOut, ok := v.(format.FlacMetadatablocksOut)
flacMetadatablockOut, ok := v.(format.FLAC_Metadatablocks_Out)
if !ok {
panic(fmt.Sprintf("expected FlacMetadatablockOut got %#+v", v))
}
if flacMetadatablockOut.HasStreamInfo {
streamInfo = flacMetadatablockOut.StreamInfo
streamTotalSamples = streamInfo.TotalSamplesInStream
flacFrameIn = format.FlacFrameIn{BitsPerSample: int(streamInfo.BitsPerSample)}
flacFrameIn = format.FLAC_Frame_In{BitsPerSample: int(streamInfo.BitsPerSample)}
}

md5Samples := md5.New()
d.FieldArray("frames", func(d *decode.D) {
for d.NotEnd() {
// flac frame might need some fields from stream info to decode
_, v := d.FieldFormat("frame", &flacFrameGroup, flacFrameIn)
ffo, ok := v.(format.FlacFrameOut)
ffo, ok := v.(format.FLAC_Frame_Out)
if !ok {
panic(fmt.Sprintf("expected FlacFrameOut got %#+v", v))
}
Expand Down
8 changes: 4 additions & 4 deletions format/flac/flac_frame.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ import (

func init() {
interp.RegisterFormat(
format.FlacFrame,
format.FLAC_Frame,
&decode.Format{
Description: "FLAC frame",
DecodeFn: frameDecode,
DefaultInArg: format.FlacFrameIn{
DefaultInArg: format.FLAC_Frame_In{
BitsPerSample: 16, // TODO: maybe should not have a default value?
},
})
Expand Down Expand Up @@ -109,7 +109,7 @@ func frameDecode(d *decode.D) any {
sampleSize := 0
sideChannelIndex := -1

var ffi format.FlacFrameIn
var ffi format.FLAC_Frame_In
if d.ArgAs(&ffi) {
sampleSize = ffi.BitsPerSample
}
Expand Down Expand Up @@ -642,7 +642,7 @@ func frameDecode(d *decode.D) any {
}
}

return format.FlacFrameOut{
return format.FLAC_Frame_Out{
SamplesBuf: interleavedSamplesBuf,
Samples: uint64(streamSamples),
Channels: channels,
Expand Down

0 comments on commit a4a332b

Please sign in to comment.