mirror of
https://github.com/dsoprea/go-exif.git
synced 2025-05-31 11:41:57 +00:00
ifd_builder: renamed builderTag to BuilderTag.
- It's probably a generally good idea.
- These are usually created by other methods, but they're regularly
interacted with when you want to make tag changes and by making them
private we can't public official, testable examples.
- Corrected names for new examples.
This commit is contained in:
Dustin Oprea
parent
81b804b70d
commit
570c4d582c
1403
ifd_builder.go
1403
ifd_builder.go
File diff suppressed because it is too large
Load Diff
@ -1,199 +1,197 @@
|
|||||||
package exif
|
package exif
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"fmt"
|
"fmt"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"encoding/binary"
|
"encoding/binary"
|
||||||
|
|
||||||
"github.com/dsoprea/go-logging"
|
"github.com/dsoprea/go-logging"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// Tag-ID + Tag-Type + Unit-Count + Value/Offset.
|
// Tag-ID + Tag-Type + Unit-Count + Value/Offset.
|
||||||
IfdTagEntrySize = uint32(2 + 2 + 4 + 4)
|
IfdTagEntrySize = uint32(2 + 2 + 4 + 4)
|
||||||
)
|
)
|
||||||
|
|
||||||
type ByteWriter struct {
|
type ByteWriter struct {
|
||||||
b *bytes.Buffer
|
b *bytes.Buffer
|
||||||
byteOrder binary.ByteOrder
|
byteOrder binary.ByteOrder
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewByteWriter(b *bytes.Buffer, byteOrder binary.ByteOrder) (bw *ByteWriter) {
|
func NewByteWriter(b *bytes.Buffer, byteOrder binary.ByteOrder) (bw *ByteWriter) {
|
||||||
return &ByteWriter{
|
return &ByteWriter{
|
||||||
b: b,
|
b: b,
|
||||||
byteOrder: byteOrder,
|
byteOrder: byteOrder,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (bw ByteWriter) writeAsBytes(value interface{}) (err error) {
|
func (bw ByteWriter) writeAsBytes(value interface{}) (err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if state := recover(); state != nil {
|
if state := recover(); state != nil {
|
||||||
err = log.Wrap(state.(error))
|
err = log.Wrap(state.(error))
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
err = binary.Write(bw.b, bw.byteOrder, value)
|
err = binary.Write(bw.b, bw.byteOrder, value)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (bw ByteWriter) WriteUint32(value uint32) (err error) {
|
func (bw ByteWriter) WriteUint32(value uint32) (err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if state := recover(); state != nil {
|
if state := recover(); state != nil {
|
||||||
err = log.Wrap(state.(error))
|
err = log.Wrap(state.(error))
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
err = bw.writeAsBytes(value)
|
err = bw.writeAsBytes(value)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (bw ByteWriter) WriteUint16(value uint16) (err error) {
|
func (bw ByteWriter) WriteUint16(value uint16) (err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if state := recover(); state != nil {
|
if state := recover(); state != nil {
|
||||||
err = log.Wrap(state.(error))
|
err = log.Wrap(state.(error))
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
err = bw.writeAsBytes(value)
|
err = bw.writeAsBytes(value)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (bw ByteWriter) WriteFourBytes(value []byte) (err error) {
|
func (bw ByteWriter) WriteFourBytes(value []byte) (err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if state := recover(); state != nil {
|
if state := recover(); state != nil {
|
||||||
err = log.Wrap(state.(error))
|
err = log.Wrap(state.(error))
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
len_ := len(value)
|
len_ := len(value)
|
||||||
if len_ != 4 {
|
if len_ != 4 {
|
||||||
log.Panicf("value is not four-bytes: (%d)", len_)
|
log.Panicf("value is not four-bytes: (%d)", len_)
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err = bw.b.Write(value)
|
_, err = bw.b.Write(value)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
// ifdOffsetIterator keeps track of where the next IFD should be written by
|
// ifdOffsetIterator keeps track of where the next IFD should be written by
|
||||||
// keeping track of where the offsets start, the data that has been added, and
|
// keeping track of where the offsets start, the data that has been added, and
|
||||||
// bumping the offset *when* the data is added.
|
// bumping the offset *when* the data is added.
|
||||||
type ifdDataAllocator struct {
|
type ifdDataAllocator struct {
|
||||||
offset uint32
|
offset uint32
|
||||||
b bytes.Buffer
|
b bytes.Buffer
|
||||||
}
|
}
|
||||||
|
|
||||||
func newIfdDataAllocator(ifdDataAddressableOffset uint32) *ifdDataAllocator{
|
func newIfdDataAllocator(ifdDataAddressableOffset uint32) *ifdDataAllocator {
|
||||||
return &ifdDataAllocator{
|
return &ifdDataAllocator{
|
||||||
offset: ifdDataAddressableOffset,
|
offset: ifdDataAddressableOffset,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ida *ifdDataAllocator) Allocate(value []byte) (offset uint32, err error) {
|
func (ida *ifdDataAllocator) Allocate(value []byte) (offset uint32, err error) {
|
||||||
_, err = ida.b.Write(value)
|
_, err = ida.b.Write(value)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
offset = ida.offset
|
offset = ida.offset
|
||||||
ida.offset += uint32(len(value))
|
ida.offset += uint32(len(value))
|
||||||
|
|
||||||
return offset, nil
|
return offset, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ida *ifdDataAllocator) NextOffset() uint32 {
|
func (ida *ifdDataAllocator) NextOffset() uint32 {
|
||||||
return ida.offset
|
return ida.offset
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ida *ifdDataAllocator) Bytes() []byte {
|
func (ida *ifdDataAllocator) Bytes() []byte {
|
||||||
return ida.b.Bytes()
|
return ida.b.Bytes()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
// IfdByteEncoder converts an IB to raw bytes (for writing) while also figuring
|
// IfdByteEncoder converts an IB to raw bytes (for writing) while also figuring
|
||||||
// out all of the allocations and indirection that is required for extended
|
// out all of the allocations and indirection that is required for extended
|
||||||
// data.
|
// data.
|
||||||
type IfdByteEncoder struct {
|
type IfdByteEncoder struct {
|
||||||
// journal holds a list of actions taken while encoding.
|
// journal holds a list of actions taken while encoding.
|
||||||
journal [][3]string
|
journal [][3]string
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewIfdByteEncoder() (ibe *IfdByteEncoder) {
|
func NewIfdByteEncoder() (ibe *IfdByteEncoder) {
|
||||||
return &IfdByteEncoder{
|
return &IfdByteEncoder{
|
||||||
journal: make([][3]string, 0),
|
journal: make([][3]string, 0),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ibe *IfdByteEncoder) Journal() [][3]string {
|
func (ibe *IfdByteEncoder) Journal() [][3]string {
|
||||||
return ibe.journal
|
return ibe.journal
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ibe *IfdByteEncoder) TableSize(entryCount int) uint32 {
|
func (ibe *IfdByteEncoder) TableSize(entryCount int) uint32 {
|
||||||
// Tag-Count + (Entry-Size * Entry-Count) + Next-IFD-Offset.
|
// Tag-Count + (Entry-Size * Entry-Count) + Next-IFD-Offset.
|
||||||
return uint32(2) + (IfdTagEntrySize * uint32(entryCount)) + uint32(4)
|
return uint32(2) + (IfdTagEntrySize * uint32(entryCount)) + uint32(4)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ibe *IfdByteEncoder) pushToJournal(where, direction, format string, args ...interface{}) {
|
func (ibe *IfdByteEncoder) pushToJournal(where, direction, format string, args ...interface{}) {
|
||||||
event := [3]string {
|
event := [3]string{
|
||||||
direction,
|
direction,
|
||||||
where,
|
where,
|
||||||
fmt.Sprintf(format, args...),
|
fmt.Sprintf(format, args...),
|
||||||
}
|
}
|
||||||
|
|
||||||
ibe.journal = append(ibe.journal, event)
|
ibe.journal = append(ibe.journal, event)
|
||||||
}
|
}
|
||||||
|
|
||||||
// PrintJournal prints a hierarchical representation of the steps taken during
|
// PrintJournal prints a hierarchical representation of the steps taken during
|
||||||
// encoding.
|
// encoding.
|
||||||
func (ibe *IfdByteEncoder) PrintJournal() {
|
func (ibe *IfdByteEncoder) PrintJournal() {
|
||||||
maxWhereLength := 0
|
maxWhereLength := 0
|
||||||
for _, event := range ibe.journal {
|
for _, event := range ibe.journal {
|
||||||
where := event[1]
|
where := event[1]
|
||||||
|
|
||||||
len_ := len(where)
|
len_ := len(where)
|
||||||
if len_ > maxWhereLength {
|
if len_ > maxWhereLength {
|
||||||
maxWhereLength = len_
|
maxWhereLength = len_
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
level := 0
|
level := 0
|
||||||
for i, event := range ibe.journal {
|
for i, event := range ibe.journal {
|
||||||
direction := event[0]
|
direction := event[0]
|
||||||
where := event[1]
|
where := event[1]
|
||||||
message := event[2]
|
message := event[2]
|
||||||
|
|
||||||
if direction != ">" && direction != "<" && direction != "-" {
|
if direction != ">" && direction != "<" && direction != "-" {
|
||||||
log.Panicf("journal operation not valid: [%s]", direction)
|
log.Panicf("journal operation not valid: [%s]", direction)
|
||||||
}
|
}
|
||||||
|
|
||||||
if direction == "<" {
|
if direction == "<" {
|
||||||
if level <= 0 {
|
if level <= 0 {
|
||||||
log.Panicf("journal operations unbalanced (too many closes)")
|
log.Panicf("journal operations unbalanced (too many closes)")
|
||||||
}
|
}
|
||||||
|
|
||||||
level--
|
level--
|
||||||
}
|
}
|
||||||
|
|
||||||
indent := strings.Repeat(" ", level)
|
indent := strings.Repeat(" ", level)
|
||||||
|
|
||||||
fmt.Printf("%3d %s%s %s: %s\n", i, indent, direction, where, message)
|
fmt.Printf("%3d %s%s %s: %s\n", i, indent, direction, where, message)
|
||||||
|
|
||||||
if direction == ">" {
|
if direction == ">" {
|
||||||
level++
|
level++
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if level != 0 {
|
if level != 0 {
|
||||||
log.Panicf("journal operations unbalanced (too many opens)")
|
log.Panicf("journal operations unbalanced (too many opens)")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// encodeTagToBytes encodes the given tag to a byte stream. If
|
// encodeTagToBytes encodes the given tag to a byte stream. If
|
||||||
@ -201,103 +199,103 @@ func (ibe *IfdByteEncoder) PrintJournal() {
|
|||||||
// (`nextIfdOffsetToWrite` is required in order for them to know where the its
|
// (`nextIfdOffsetToWrite` is required in order for them to know where the its
|
||||||
// IFD data will be written, in order for them to know the offset of where
|
// IFD data will be written, in order for them to know the offset of where
|
||||||
// their allocated-data block will start, which follows right behind).
|
// their allocated-data block will start, which follows right behind).
|
||||||
func (ibe *IfdByteEncoder) encodeTagToBytes(ib *IfdBuilder, bt *builderTag, bw *ByteWriter, ida *ifdDataAllocator, nextIfdOffsetToWrite uint32) (childIfdBlock []byte, err error) {
|
func (ibe *IfdByteEncoder) encodeTagToBytes(ib *IfdBuilder, bt *BuilderTag, bw *ByteWriter, ida *ifdDataAllocator, nextIfdOffsetToWrite uint32) (childIfdBlock []byte, err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if state := recover(); state != nil {
|
if state := recover(); state != nil {
|
||||||
err = log.Wrap(state.(error))
|
err = log.Wrap(state.(error))
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
// Write tag-ID.
|
// Write tag-ID.
|
||||||
err = bw.WriteUint16(bt.tagId)
|
err = bw.WriteUint16(bt.tagId)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
// Works for both values and child IFDs (which have an official size of
|
// Works for both values and child IFDs (which have an official size of
|
||||||
// LONG).
|
// LONG).
|
||||||
err = bw.WriteUint16(bt.typeId)
|
err = bw.WriteUint16(bt.typeId)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
// Write unit-count.
|
// Write unit-count.
|
||||||
|
|
||||||
if bt.value.IsBytes() == true {
|
if bt.value.IsBytes() == true {
|
||||||
effectiveType := bt.typeId
|
effectiveType := bt.typeId
|
||||||
if bt.typeId == TypeUndefined {
|
if bt.typeId == TypeUndefined {
|
||||||
effectiveType = TypeByte
|
effectiveType = TypeByte
|
||||||
}
|
}
|
||||||
|
|
||||||
// It's a non-unknown value.Calculate the count of values of
|
// It's a non-unknown value.Calculate the count of values of
|
||||||
// the type that we're writing and the raw bytes for the whole list.
|
// the type that we're writing and the raw bytes for the whole list.
|
||||||
|
|
||||||
typeSize := uint32(TagTypeSize(effectiveType))
|
typeSize := uint32(TagTypeSize(effectiveType))
|
||||||
|
|
||||||
valueBytes := bt.value.Bytes()
|
valueBytes := bt.value.Bytes()
|
||||||
|
|
||||||
len_ := len(valueBytes)
|
len_ := len(valueBytes)
|
||||||
unitCount := uint32(len_) / typeSize
|
unitCount := uint32(len_) / typeSize
|
||||||
|
|
||||||
if _, found := tagsWithoutAlignment[bt.tagId]; found == false {
|
if _, found := tagsWithoutAlignment[bt.tagId]; found == false {
|
||||||
remainder := uint32(len_) % typeSize
|
remainder := uint32(len_) % typeSize
|
||||||
|
|
||||||
if remainder > 0 {
|
if remainder > 0 {
|
||||||
log.Panicf("tag (0x%04x) value of (%d) bytes not evenly divisible by type-size (%d)", bt.tagId, len_, typeSize)
|
log.Panicf("tag (0x%04x) value of (%d) bytes not evenly divisible by type-size (%d)", bt.tagId, len_, typeSize)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
err = bw.WriteUint32(unitCount)
|
err = bw.WriteUint32(unitCount)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
// Write four-byte value/offset.
|
// Write four-byte value/offset.
|
||||||
|
|
||||||
if len_ > 4 {
|
if len_ > 4 {
|
||||||
offset, err := ida.Allocate(valueBytes)
|
offset, err := ida.Allocate(valueBytes)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
err = bw.WriteUint32(offset)
|
err = bw.WriteUint32(offset)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
} else {
|
} else {
|
||||||
fourBytes := make([]byte, 4)
|
fourBytes := make([]byte, 4)
|
||||||
copy(fourBytes, valueBytes)
|
copy(fourBytes, valueBytes)
|
||||||
|
|
||||||
err = bw.WriteFourBytes(fourBytes)
|
err = bw.WriteFourBytes(fourBytes)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
if bt.value.IsIb() == false {
|
if bt.value.IsIb() == false {
|
||||||
log.Panicf("tag value is not a byte-slice but also not a child IB: %v", bt)
|
log.Panicf("tag value is not a byte-slice but also not a child IB: %v", bt)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Write unit-count (one LONG representing one offset).
|
// Write unit-count (one LONG representing one offset).
|
||||||
err = bw.WriteUint32(1)
|
err = bw.WriteUint32(1)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
if nextIfdOffsetToWrite > 0 {
|
if nextIfdOffsetToWrite > 0 {
|
||||||
var err error
|
var err error
|
||||||
|
|
||||||
ibe.pushToJournal("encodeTagToBytes", ">", "[%s]->[%s]", ib.ii.IfdName, bt.value.Ib().ii.IfdName)
|
ibe.pushToJournal("encodeTagToBytes", ">", "[%s]->[%s]", ib.ii.IfdName, bt.value.Ib().ii.IfdName)
|
||||||
|
|
||||||
// Create the block of IFD data and everything it requires.
|
// Create the block of IFD data and everything it requires.
|
||||||
childIfdBlock, err = ibe.encodeAndAttachIfd(bt.value.Ib(), nextIfdOffsetToWrite)
|
childIfdBlock, err = ibe.encodeAndAttachIfd(bt.value.Ib(), nextIfdOffsetToWrite)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
ibe.pushToJournal("encodeTagToBytes", "<", "[%s]->[%s]", bt.value.Ib().ii.IfdName, ib.ii.IfdName)
|
ibe.pushToJournal("encodeTagToBytes", "<", "[%s]->[%s]", bt.value.Ib().ii.IfdName, ib.ii.IfdName)
|
||||||
|
|
||||||
// Use the next-IFD offset for it. The IFD will actually get
|
// Use the next-IFD offset for it. The IFD will actually get
|
||||||
// attached after we return.
|
// attached after we return.
|
||||||
err = bw.WriteUint32(nextIfdOffsetToWrite)
|
err = bw.WriteUint32(nextIfdOffsetToWrite)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
} else {
|
} else {
|
||||||
// No child-IFDs are to be allocated. Finish the entry with a NULL
|
// No child-IFDs are to be allocated. Finish the entry with a NULL
|
||||||
// pointer.
|
// pointer.
|
||||||
|
|
||||||
ibe.pushToJournal("encodeTagToBytes", "-", "*Not* descending to child: [%s]", bt.value.Ib().ii.IfdName)
|
ibe.pushToJournal("encodeTagToBytes", "-", "*Not* descending to child: [%s]", bt.value.Ib().ii.IfdName)
|
||||||
|
|
||||||
err = bw.WriteUint32(0)
|
err = bw.WriteUint32(0)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return childIfdBlock, nil
|
return childIfdBlock, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// encodeIfdToBytes encodes the given IB to a byte-slice. We are given the
|
// encodeIfdToBytes encodes the given IB to a byte-slice. We are given the
|
||||||
@ -310,255 +308,254 @@ func (ibe *IfdByteEncoder) encodeTagToBytes(ib *IfdBuilder, bt *builderTag, bw *
|
|||||||
// IFDs, we will not be able to allocate them without first knowing how much
|
// IFDs, we will not be able to allocate them without first knowing how much
|
||||||
// data we need to allocate for the current IFD.
|
// data we need to allocate for the current IFD.
|
||||||
func (ibe *IfdByteEncoder) encodeIfdToBytes(ib *IfdBuilder, ifdAddressableOffset uint32, nextIfdOffsetToWrite uint32, setNextIb bool) (data []byte, tableSize uint32, dataSize uint32, childIfdSizes []uint32, err error) {
|
func (ibe *IfdByteEncoder) encodeIfdToBytes(ib *IfdBuilder, ifdAddressableOffset uint32, nextIfdOffsetToWrite uint32, setNextIb bool) (data []byte, tableSize uint32, dataSize uint32, childIfdSizes []uint32, err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if state := recover(); state != nil {
|
if state := recover(); state != nil {
|
||||||
err = log.Wrap(state.(error))
|
err = log.Wrap(state.(error))
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
ibe.pushToJournal("encodeIfdToBytes", ">", "%s", ib)
|
ibe.pushToJournal("encodeIfdToBytes", ">", "%s", ib)
|
||||||
|
|
||||||
tableSize = ibe.TableSize(len(ib.tags))
|
tableSize = ibe.TableSize(len(ib.tags))
|
||||||
|
|
||||||
b := new(bytes.Buffer)
|
b := new(bytes.Buffer)
|
||||||
bw := NewByteWriter(b, ib.byteOrder)
|
bw := NewByteWriter(b, ib.byteOrder)
|
||||||
|
|
||||||
// Write tag count.
|
// Write tag count.
|
||||||
err = bw.WriteUint16(uint16(len(ib.tags)))
|
err = bw.WriteUint16(uint16(len(ib.tags)))
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
ida := newIfdDataAllocator(ifdAddressableOffset)
|
ida := newIfdDataAllocator(ifdAddressableOffset)
|
||||||
|
|
||||||
childIfdBlocks := make([][]byte, 0)
|
childIfdBlocks := make([][]byte, 0)
|
||||||
|
|
||||||
// Write raw bytes for each tag entry. Allocate larger data to be referred
|
// Write raw bytes for each tag entry. Allocate larger data to be referred
|
||||||
// to in the follow-up data-block as required. Any "unknown"-byte tags that
|
// to in the follow-up data-block as required. Any "unknown"-byte tags that
|
||||||
// we can't parse will not be present here (using AddTagsFromExisting(), at
|
// we can't parse will not be present here (using AddTagsFromExisting(), at
|
||||||
// least).
|
// least).
|
||||||
for _, bt := range ib.tags {
|
for _, bt := range ib.tags {
|
||||||
childIfdBlock, err := ibe.encodeTagToBytes(ib, bt, bw, ida, nextIfdOffsetToWrite)
|
childIfdBlock, err := ibe.encodeTagToBytes(ib, bt, bw, ida, nextIfdOffsetToWrite)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
if childIfdBlock != nil {
|
if childIfdBlock != nil {
|
||||||
// We aren't allowed to have non-nil child IFDs if we're just
|
// We aren't allowed to have non-nil child IFDs if we're just
|
||||||
// sizing things up.
|
// sizing things up.
|
||||||
if nextIfdOffsetToWrite == 0 {
|
if nextIfdOffsetToWrite == 0 {
|
||||||
log.Panicf("no IFD offset provided for child-IFDs; no new child-IFDs permitted")
|
log.Panicf("no IFD offset provided for child-IFDs; no new child-IFDs permitted")
|
||||||
}
|
}
|
||||||
|
|
||||||
nextIfdOffsetToWrite += uint32(len(childIfdBlock))
|
nextIfdOffsetToWrite += uint32(len(childIfdBlock))
|
||||||
childIfdBlocks = append(childIfdBlocks, childIfdBlock)
|
childIfdBlocks = append(childIfdBlocks, childIfdBlock)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
dataBytes := ida.Bytes()
|
dataBytes := ida.Bytes()
|
||||||
dataSize = uint32(len(dataBytes))
|
dataSize = uint32(len(dataBytes))
|
||||||
|
|
||||||
childIfdSizes = make([]uint32, len(childIfdBlocks))
|
childIfdSizes = make([]uint32, len(childIfdBlocks))
|
||||||
childIfdsTotalSize := uint32(0)
|
childIfdsTotalSize := uint32(0)
|
||||||
for i, childIfdBlock := range childIfdBlocks {
|
for i, childIfdBlock := range childIfdBlocks {
|
||||||
len_ := uint32(len(childIfdBlock))
|
len_ := uint32(len(childIfdBlock))
|
||||||
childIfdSizes[i] = len_
|
childIfdSizes[i] = len_
|
||||||
childIfdsTotalSize += len_
|
childIfdsTotalSize += len_
|
||||||
}
|
}
|
||||||
|
|
||||||
// N the link from this IFD to the next IFD that will be written in the
|
// N the link from this IFD to the next IFD that will be written in the
|
||||||
// next cycle.
|
// next cycle.
|
||||||
if setNextIb == true {
|
if setNextIb == true {
|
||||||
// Write address of next IFD in chain. This will be the original
|
// Write address of next IFD in chain. This will be the original
|
||||||
// allocation offset plus the size of everything we have allocated for
|
// allocation offset plus the size of everything we have allocated for
|
||||||
// this IFD and its child-IFDs.
|
// this IFD and its child-IFDs.
|
||||||
//
|
//
|
||||||
// It is critical that this number is stepped properly. We experienced
|
// It is critical that this number is stepped properly. We experienced
|
||||||
// an issue whereby it first looked like we were duplicating the IFD and
|
// an issue whereby it first looked like we were duplicating the IFD and
|
||||||
// then that we were duplicating the tags in the wrong IFD, and then
|
// then that we were duplicating the tags in the wrong IFD, and then
|
||||||
// finally we determined that the next-IFD offset for the first IFD was
|
// finally we determined that the next-IFD offset for the first IFD was
|
||||||
// accidentally pointing back to the EXIF IFD, so we were visiting it
|
// accidentally pointing back to the EXIF IFD, so we were visiting it
|
||||||
// twice when visiting through the tags after decoding. It was an
|
// twice when visiting through the tags after decoding. It was an
|
||||||
// expensive bug to find.
|
// expensive bug to find.
|
||||||
|
|
||||||
ibe.pushToJournal("encodeIfdToBytes", "-", "Setting 'next' IFD to (0x%08x).", nextIfdOffsetToWrite)
|
ibe.pushToJournal("encodeIfdToBytes", "-", "Setting 'next' IFD to (0x%08x).", nextIfdOffsetToWrite)
|
||||||
|
|
||||||
err := bw.WriteUint32(nextIfdOffsetToWrite)
|
err := bw.WriteUint32(nextIfdOffsetToWrite)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
} else {
|
} else {
|
||||||
err := bw.WriteUint32(0)
|
err := bw.WriteUint32(0)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err = b.Write(dataBytes)
|
_, err = b.Write(dataBytes)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
// TODO(dustin): !! Debugging.
|
// TODO(dustin): !! Debugging.
|
||||||
// if thumbnailOffset != uint32(0) {
|
// if thumbnailOffset != uint32(0) {
|
||||||
// currentRelativeOffset := thumbnailOffset - ifdAddressableOffset
|
// currentRelativeOffset := thumbnailOffset - ifdAddressableOffset
|
||||||
// currentBuffer := b.Bytes()
|
// currentBuffer := b.Bytes()
|
||||||
|
|
||||||
// len_ := len(thumbnailData)
|
// len_ := len(thumbnailData)
|
||||||
// extractedThumbnailData := currentBuffer[int(currentRelativeOffset):int(currentRelativeOffset) + len_]
|
// extractedThumbnailData := currentBuffer[int(currentRelativeOffset):int(currentRelativeOffset) + len_]
|
||||||
|
|
||||||
// // We didn't have enough data available, which would be queer.
|
// // We didn't have enough data available, which would be queer.
|
||||||
// if len(extractedThumbnailData) != len_ {
|
// if len(extractedThumbnailData) != len_ {
|
||||||
// log.Panicf("extracted thumbnail data was truncated; not enough data")
|
// log.Panicf("extracted thumbnail data was truncated; not enough data")
|
||||||
// }
|
// }
|
||||||
|
|
||||||
// // fmt.Printf("Re-extracted (%d) bytes of thumbnail data.\n", len(extractedThumbnailData))
|
// // fmt.Printf("Re-extracted (%d) bytes of thumbnail data.\n", len(extractedThumbnailData))
|
||||||
// // DumpBytes(extractedThumbnailData[:50])
|
// // DumpBytes(extractedThumbnailData[:50])
|
||||||
// }
|
// }
|
||||||
|
|
||||||
// Append any child IFD blocks after our table and data blocks. These IFDs
|
// Append any child IFD blocks after our table and data blocks. These IFDs
|
||||||
// were equipped with the appropriate offset information so it's expected
|
// were equipped with the appropriate offset information so it's expected
|
||||||
// that all offsets referred to by these will be correct.
|
// that all offsets referred to by these will be correct.
|
||||||
//
|
//
|
||||||
// Note that child-IFDs are append after the current IFD and before the
|
// Note that child-IFDs are append after the current IFD and before the
|
||||||
// next IFD, as opposed to the root IFDs, which are chained together but
|
// next IFD, as opposed to the root IFDs, which are chained together but
|
||||||
// will be interrupted by these child-IFDs (which is expected, per the
|
// will be interrupted by these child-IFDs (which is expected, per the
|
||||||
// standard).
|
// standard).
|
||||||
|
|
||||||
for _, childIfdBlock := range childIfdBlocks {
|
for _, childIfdBlock := range childIfdBlocks {
|
||||||
_, err = b.Write(childIfdBlock)
|
_, err = b.Write(childIfdBlock)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
ibe.pushToJournal("encodeIfdToBytes", "<", "%s", ib)
|
ibe.pushToJournal("encodeIfdToBytes", "<", "%s", ib)
|
||||||
|
|
||||||
// if nextIfdOffsetToWrite > uint32(0) {
|
// if nextIfdOffsetToWrite > uint32(0) {
|
||||||
// fmt.Printf("Encoded IB: %s ADDRESSABLE-OFFSET=(0x%08x; %d):\n", ib.ii, ifdAddressableOffset, ifdAddressableOffset)
|
// fmt.Printf("Encoded IB: %s ADDRESSABLE-OFFSET=(0x%08x; %d):\n", ib.ii, ifdAddressableOffset, ifdAddressableOffset)
|
||||||
// fmt.Printf("\n")
|
// fmt.Printf("\n")
|
||||||
// DumpBytes(b.Bytes())
|
// DumpBytes(b.Bytes())
|
||||||
// fmt.Printf("\n")
|
// fmt.Printf("\n")
|
||||||
// }
|
// }
|
||||||
|
|
||||||
return b.Bytes(), tableSize, dataSize, childIfdSizes, nil
|
return b.Bytes(), tableSize, dataSize, childIfdSizes, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// encodeAndAttachIfd is a reentrant function that processes the IFD chain.
|
// encodeAndAttachIfd is a reentrant function that processes the IFD chain.
|
||||||
func (ibe *IfdByteEncoder) encodeAndAttachIfd(ib *IfdBuilder, ifdAddressableOffset uint32) (data []byte, err error) {
|
func (ibe *IfdByteEncoder) encodeAndAttachIfd(ib *IfdBuilder, ifdAddressableOffset uint32) (data []byte, err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if state := recover(); state != nil {
|
if state := recover(); state != nil {
|
||||||
err = log.Wrap(state.(error))
|
err = log.Wrap(state.(error))
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
ibe.pushToJournal("encodeAndAttachIfd", ">", "%s", ib)
|
ibe.pushToJournal("encodeAndAttachIfd", ">", "%s", ib)
|
||||||
|
|
||||||
if len(ib.tags) == 0 {
|
if len(ib.tags) == 0 {
|
||||||
log.Panicf("trying to encode an IfdBuilder that doesn't have any tags")
|
log.Panicf("trying to encode an IfdBuilder that doesn't have any tags")
|
||||||
}
|
}
|
||||||
|
|
||||||
b := new(bytes.Buffer)
|
b := new(bytes.Buffer)
|
||||||
|
|
||||||
i := 0
|
i := 0
|
||||||
|
|
||||||
// TODO(dustin): !! We suspect there's an issue with encoding sibling IFDs, here.
|
// TODO(dustin): !! We suspect there's an issue with encoding sibling IFDs, here.
|
||||||
|
|
||||||
for thisIb := ib; thisIb != nil; thisIb = thisIb.nextIb {
|
for thisIb := ib; thisIb != nil; thisIb = thisIb.nextIb {
|
||||||
|
|
||||||
|
// Do a dry-run in order to pre-determine its size requirement.
|
||||||
|
|
||||||
// Do a dry-run in order to pre-determine its size requirement.
|
ibe.pushToJournal("encodeAndAttachIfd", ">", "Beginning encoding process: (%d) [%s]", i, thisIb.ii.IfdName)
|
||||||
|
|
||||||
ibe.pushToJournal("encodeAndAttachIfd", ">", "Beginning encoding process: (%d) [%s]", i, thisIb.ii.IfdName)
|
ibe.pushToJournal("encodeAndAttachIfd", ">", "Calculating size: (%d) [%s]", i, thisIb.ii.IfdName)
|
||||||
|
|
||||||
ibe.pushToJournal("encodeAndAttachIfd", ">", "Calculating size: (%d) [%s]", i, thisIb.ii.IfdName)
|
_, tableSize, allocatedDataSize, _, err := ibe.encodeIfdToBytes(thisIb, ifdAddressableOffset, 0, false)
|
||||||
|
log.PanicIf(err)
|
||||||
|
|
||||||
_, tableSize, allocatedDataSize, _, err := ibe.encodeIfdToBytes(thisIb, ifdAddressableOffset, 0, false)
|
ibe.pushToJournal("encodeAndAttachIfd", "<", "Finished calculating size: (%d) [%s]", i, thisIb.ii.IfdName)
|
||||||
log.PanicIf(err)
|
|
||||||
|
|
||||||
ibe.pushToJournal("encodeAndAttachIfd", "<", "Finished calculating size: (%d) [%s]", i, thisIb.ii.IfdName)
|
ifdAddressableOffset += tableSize
|
||||||
|
nextIfdOffsetToWrite := ifdAddressableOffset + allocatedDataSize
|
||||||
|
|
||||||
ifdAddressableOffset += tableSize
|
ibe.pushToJournal("encodeAndAttachIfd", ">", "Next IFD will be written at offset (0x%08x)", nextIfdOffsetToWrite)
|
||||||
nextIfdOffsetToWrite := ifdAddressableOffset + allocatedDataSize
|
|
||||||
|
|
||||||
ibe.pushToJournal("encodeAndAttachIfd", ">", "Next IFD will be written at offset (0x%08x)", nextIfdOffsetToWrite)
|
// Write our IFD as well as any child-IFDs (now that we know the offset
|
||||||
|
// where new IFDs and their data will be allocated).
|
||||||
|
|
||||||
// Write our IFD as well as any child-IFDs (now that we know the offset
|
setNextIb := thisIb.nextIb != nil
|
||||||
// where new IFDs and their data will be allocated).
|
|
||||||
|
|
||||||
setNextIb := thisIb.nextIb != nil
|
ibe.pushToJournal("encodeAndAttachIfd", ">", "Encoding starting: (%d) [%s] NEXT-IFD-OFFSET-TO-WRITE=(0x%08x)", i, thisIb.ii.IfdName, nextIfdOffsetToWrite)
|
||||||
|
|
||||||
ibe.pushToJournal("encodeAndAttachIfd", ">", "Encoding starting: (%d) [%s] NEXT-IFD-OFFSET-TO-WRITE=(0x%08x)", i, thisIb.ii.IfdName, nextIfdOffsetToWrite)
|
tableAndAllocated, effectiveTableSize, effectiveAllocatedDataSize, childIfdSizes, err :=
|
||||||
|
ibe.encodeIfdToBytes(thisIb, ifdAddressableOffset, nextIfdOffsetToWrite, setNextIb)
|
||||||
|
|
||||||
tableAndAllocated, effectiveTableSize, effectiveAllocatedDataSize, childIfdSizes, err :=
|
log.PanicIf(err)
|
||||||
ibe.encodeIfdToBytes(thisIb, ifdAddressableOffset, nextIfdOffsetToWrite, setNextIb)
|
|
||||||
|
|
||||||
log.PanicIf(err)
|
if effectiveTableSize != tableSize {
|
||||||
|
log.Panicf("written table size does not match the pre-calculated table size: (%d) != (%d) %s", effectiveTableSize, tableSize, ib)
|
||||||
|
} else if effectiveAllocatedDataSize != allocatedDataSize {
|
||||||
|
log.Panicf("written allocated-data size does not match the pre-calculated allocated-data size: (%d) != (%d) %s", effectiveAllocatedDataSize, allocatedDataSize, ib)
|
||||||
|
}
|
||||||
|
|
||||||
if effectiveTableSize != tableSize {
|
ibe.pushToJournal("encodeAndAttachIfd", "<", "Encoding done: (%d) [%s]", i, thisIb.ii.IfdName)
|
||||||
log.Panicf("written table size does not match the pre-calculated table size: (%d) != (%d) %s", effectiveTableSize, tableSize, ib)
|
|
||||||
} else if effectiveAllocatedDataSize != allocatedDataSize {
|
|
||||||
log.Panicf("written allocated-data size does not match the pre-calculated allocated-data size: (%d) != (%d) %s", effectiveAllocatedDataSize, allocatedDataSize, ib)
|
|
||||||
}
|
|
||||||
|
|
||||||
ibe.pushToJournal("encodeAndAttachIfd", "<", "Encoding done: (%d) [%s]", i, thisIb.ii.IfdName)
|
totalChildIfdSize := uint32(0)
|
||||||
|
for _, childIfdSize := range childIfdSizes {
|
||||||
|
totalChildIfdSize += childIfdSize
|
||||||
|
}
|
||||||
|
|
||||||
totalChildIfdSize := uint32(0)
|
if len(tableAndAllocated) != int(tableSize+allocatedDataSize+totalChildIfdSize) {
|
||||||
for _, childIfdSize := range childIfdSizes {
|
log.Panicf("IFD table and data is not a consistent size: (%d) != (%d)", len(tableAndAllocated), tableSize+allocatedDataSize+totalChildIfdSize)
|
||||||
totalChildIfdSize += childIfdSize
|
}
|
||||||
}
|
|
||||||
|
|
||||||
if len(tableAndAllocated) != int(tableSize + allocatedDataSize + totalChildIfdSize) {
|
// TODO(dustin): !! We might want to verify the original tableAndAllocated length, too.
|
||||||
log.Panicf("IFD table and data is not a consistent size: (%d) != (%d)", len(tableAndAllocated), tableSize + allocatedDataSize + totalChildIfdSize)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO(dustin): !! We might want to verify the original tableAndAllocated length, too.
|
_, err = b.Write(tableAndAllocated)
|
||||||
|
log.PanicIf(err)
|
||||||
|
|
||||||
_, err = b.Write(tableAndAllocated)
|
// Advance past what we've allocated, thus far.
|
||||||
log.PanicIf(err)
|
|
||||||
|
|
||||||
// Advance past what we've allocated, thus far.
|
// TODO(dustin): !! If this doesn't work (or doesn't work easily), we may need to send a complex type for the addressable-offset instead of a simple integer.
|
||||||
|
ifdAddressableOffset += allocatedDataSize + totalChildIfdSize
|
||||||
|
|
||||||
// TODO(dustin): !! If this doesn't work (or doesn't work easily), we may need to send a complex type for the addressable-offset instead of a simple integer.
|
ibe.pushToJournal("encodeAndAttachIfd", "<", "Finishing encoding process: (%d) [%s] [FINAL:] NEXT-IFD-OFFSET-TO-WRITE=(0x%08x)", i, ib.ii.IfdName, nextIfdOffsetToWrite)
|
||||||
ifdAddressableOffset += allocatedDataSize + totalChildIfdSize
|
|
||||||
|
|
||||||
ibe.pushToJournal("encodeAndAttachIfd", "<", "Finishing encoding process: (%d) [%s] [FINAL:] NEXT-IFD-OFFSET-TO-WRITE=(0x%08x)", i, ib.ii.IfdName, nextIfdOffsetToWrite)
|
i++
|
||||||
|
}
|
||||||
|
|
||||||
i++
|
ibe.pushToJournal("encodeAndAttachIfd", "<", "%s", ib)
|
||||||
}
|
|
||||||
|
|
||||||
ibe.pushToJournal("encodeAndAttachIfd", "<", "%s", ib)
|
return b.Bytes(), nil
|
||||||
|
|
||||||
return b.Bytes(), nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// EncodeToExifPayload is the base encoding step that transcribes the entire IB
|
// EncodeToExifPayload is the base encoding step that transcribes the entire IB
|
||||||
// structure to its on-disk layout.
|
// structure to its on-disk layout.
|
||||||
func (ibe *IfdByteEncoder) EncodeToExifPayload(ib *IfdBuilder) (data []byte, err error) {
|
func (ibe *IfdByteEncoder) EncodeToExifPayload(ib *IfdBuilder) (data []byte, err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if state := recover(); state != nil {
|
if state := recover(); state != nil {
|
||||||
err = log.Wrap(state.(error))
|
err = log.Wrap(state.(error))
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
data, err = ibe.encodeAndAttachIfd(ib, ExifDefaultFirstIfdOffset)
|
data, err = ibe.encodeAndAttachIfd(ib, ExifDefaultFirstIfdOffset)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
return data, nil
|
return data, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// EncodeToExif calls EncodeToExifPayload and then packages the result into a
|
// EncodeToExif calls EncodeToExifPayload and then packages the result into a
|
||||||
// complete EXIF block.
|
// complete EXIF block.
|
||||||
func (ibe *IfdByteEncoder) EncodeToExif(ib *IfdBuilder) (data []byte, err error) {
|
func (ibe *IfdByteEncoder) EncodeToExif(ib *IfdBuilder) (data []byte, err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if state := recover(); state != nil {
|
if state := recover(); state != nil {
|
||||||
err = log.Wrap(state.(error))
|
err = log.Wrap(state.(error))
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
encodedIfds, err := ibe.EncodeToExifPayload(ib)
|
encodedIfds, err := ibe.EncodeToExifPayload(ib)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
// Wrap the IFD in a formal EXIF block.
|
// Wrap the IFD in a formal EXIF block.
|
||||||
|
|
||||||
b := new(bytes.Buffer)
|
b := new(bytes.Buffer)
|
||||||
|
|
||||||
headerBytes, err := BuildExifHeader(ib.byteOrder, ExifDefaultFirstIfdOffset)
|
headerBytes, err := BuildExifHeader(ib.byteOrder, ExifDefaultFirstIfdOffset)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
_, err = b.Write(headerBytes)
|
_, err = b.Write(headerBytes)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
_, err = b.Write(encodedIfds)
|
_, err = b.Write(encodedIfds)
|
||||||
log.PanicIf(err)
|
log.PanicIf(err)
|
||||||
|
|
||||||
return b.Bytes(), nil
|
return b.Bytes(), nil
|
||||||
}
|
}
|
||||||
|
|||||||
2562
ifd_builder_test.go
2562
ifd_builder_test.go
File diff suppressed because it is too large
Load Diff
Loading…
x
Reference in New Issue
Block a user