exiv2/src/exif.cpp

// ***************************************************************** -*- C++ -*-
/*
 * Copyright (c) 2004 Andreas Huggel
 *
 * Todo: Insert license blabla here
 *
 */
/*
  Author(s): Andreas Huggel (ahu)
  History:
   13-Jan-04, ahu: created

  RCS information
   $Name:  $
   $Revision: 1.3 $
 */
// *****************************************************************************
// included header files
#include "exif.hpp"
#include "tags.hpp"

// + standard includes
#include <iostream>
#include <iomanip>
#include <sstream>
#include <fstream>

#include <cstring>

// *****************************************************************************
// local declarations
namespace {

    // Compare two IFD entries by offset, taking care of special cases
    // where one or both of the entries don't have an offset.
    bool cmpOffset(const Exif::Metadatum& lhs, const Exif::Metadatum& rhs);

}

// *****************************************************************************
// class member definitions
namespace Exif {

    JpegImage::JpegImage()
        : sizeExifData_(0), offsetExifData_(0), exifData_(0)
    {
    }

    JpegImage::~JpegImage()
    {
        delete exifData_;
    }

    const uint16 JpegImage::soi_    = 0xffd8;
    const uint16 JpegImage::app1_   = 0xffe1;
    const char JpegImage::exifId_[] = "Exif\0\0";

    bool JpegImage::isJpeg(std::istream& is)
    {
        char c;
        is.get(c);
        if (!is.good()) return false;
        if (static_cast<char>((soi_ & 0xff00) >> 8) != c) {
            is.unget();
            return false;
        }
        is.get(c);
        if (!is.good()) return false;
        if (static_cast<char>(soi_ & 0x00ff) != c) {
            is.unget();
            return false;
        }
        return true;
    }

    int JpegImage::readExifData(const std::string& path)
    {
        std::ifstream file(path.c_str());
        if (!file) return -1;
        return readExifData(file);
    }

    int JpegImage::readExifData(std::istream& is)
    {
        // Check if this is a JPEG image in the first place
        if (!isJpeg(is)) {
            if (!is.good()) return 1;
            return 2;
        }

        // Todo: implement this properly: the APP1 segment may not follow
        //       immediately after SOI.
        char marker[2];
        marker[0] = '\0'; 
        marker[1] = '\0';
        long offsetApp1 = 2;
        // Read the APP1 marker
        is.read(marker, 2);
        if (!is.good()) return 1;
        // Check the APP1 marker
        if (getUShort(marker, bigEndian) != app1_) return 3;

        // Read the length of the APP1 field and the Exif identifier
        char buf[8];
        ::memset(buf, 0x0, 8);
        is.read(buf, 8);
        if (!is.good()) return 1;
        // Get the length of the APP1 field and do a plausibility check
        long app1Length = getUShort(buf, bigEndian);
        if (app1Length < 8) return 4;
        // Check the Exif identifier
        if (::memcmp(buf+2, exifId_, 6) != 0) return 4;
 
        // Read the rest of the APP1 field (Exif data)
        long sizeExifData = app1Length - 8;
        exifData_ = new char[sizeExifData];
        ::memset(exifData_, 0x0, sizeExifData);
        is.read(exifData_, sizeExifData);
        if (!is.good()) {
            delete[] exifData_;
            exifData_ = 0;
            return 1;
        }
        // Finally, set the size and offset of the Exif data buffer
        sizeExifData_ = sizeExifData;
        offsetExifData_ = offsetApp1 + 10;

        return 0;
    } // JpegImage::readExifData

    TiffHeader::TiffHeader() 
        : byteOrder_(littleEndian), tag_(0x002a), offset_(0x00000008)
    {
    }

    int TiffHeader::read(const char* buf)
    {
        if (buf[0] == 0x49 && buf[1] == 0x49) {
            byteOrder_ = littleEndian;
        }
        else if (buf[0] == 0x4d && buf[1] == 0x4d) {
            byteOrder_ = bigEndian;
        }
        else {
            return 1;
        }
        tag_ = getUShort(buf+2, byteOrder_);
        offset_ = getULong(buf+4, byteOrder_);
        return 0;
    }

    long TiffHeader::copy(char* buf) const
    {
        switch (byteOrder_) {
        case littleEndian:
            buf[0] = 0x49;
            buf[1] = 0x49;
            break;
        case bigEndian:
            buf[0] = 0x4d;
            buf[1] = 0x4d;
            break;
        }
        us2Data(buf+2, tag_, byteOrder_);
        ul2Data(buf+4, offset_, byteOrder_);
        return size();
    }

    Value* Value::create(TypeId typeId, ByteOrder byteOrder)
    {
        Value* value = 0;
        switch (typeId) {
        case invalid:
            break;
        case unsignedByte:
            value = new AsciiValue;
            break;
        case asciiString:
            value =  new AsciiValue;
            break;
        case unsignedShort:
            value = new UShortValue(byteOrder);
            break;
        case unsignedLong:
        case unsignedRational:
        case signedByte:
        case undefined:
        case signedShort:
        case signedLong:
        case signedRational:
        case singleFloat:
        case doubleFloat:
            value = new AsciiValue;
            break;
        }
        return value;
    } // Value::create

    void AsciiValue::read(const char* buf, long len)
    {
        value_ = std::string(buf, len);
    }

    void AsciiValue::read(const std::string& buf)
    {
        value_ = buf;
    }

    long AsciiValue::copy(char* buf) const
    {
        return value_.copy(buf, value_.size());
    }

    long AsciiValue::size() const
    {
        return value_.size();
    }

    Value* AsciiValue::clone() const
    {
        return new AsciiValue(*this);
    }

    std::ostream& AsciiValue::write(std::ostream& os) const
    {
        return os << value_;
    }

    void UShortValue::read(const char* buf, long len)
    {
        // Todo: Should we check to make sure that len is 2
        value_ = getUShort(buf, byteOrder_);
    }

    void UShortValue::read(const std::string& buf)
    {
        std::istringstream is(buf);
        is >> value_;
    }

    long UShortValue::copy(char* buf) const
    {
        us2Data(buf, value_, byteOrder_);
        return size();
    }

    long UShortValue::size() const
    {
        return 2;
    }

    Value* UShortValue::clone() const
    {
        return new UShortValue(*this);
    }

    std::ostream& UShortValue::write(std::ostream& os) const
    {
        return os << value_;
    }

    Metadatum::Metadatum()
        : tag_(0), type_(0), count_(0), offset_(0), size_(0), 
          ifdId_(IfdIdNotSet), ifdIdx_(-1), value_(0)
    {
    }

    Metadatum::~Metadatum()
    {
        delete value_;
    }

    Metadatum::Metadatum(const Metadatum& rhs)
    {
        tag_ = rhs.tag_;
        type_ = rhs.type_;
        count_ = rhs.count_;
        offset_ = rhs.offset_;   
        size_ = rhs.size_;

        ifdId_ = rhs.ifdId_;
        ifdIdx_ = rhs.ifdIdx_;

        value_ = 0;
        if (rhs.value_ != 0) value_ = rhs.value_->clone(); // deep copy
    }

    Metadatum& Metadatum::operator=(const Metadatum& rhs)
    {
        tag_ = rhs.tag_;
        type_ = rhs.type_;
        count_ = rhs.count_;
        offset_ = rhs.offset_;   
        size_ = rhs.size_;

        ifdId_ = rhs.ifdId_;
        ifdIdx_ = rhs.ifdIdx_;

        delete value_;
        value_ = 0;
        if (rhs.value_ != 0) value_ = rhs.value_->clone(); // deep copy

        return *this;
    } // Metadatum::operator=

    std::string Metadatum::key() const
    {
        std::string key = std::string(ifdItem()) 
                  + "." + std::string(sectionName()) 
                  + "." + std::string(tagName());
        return key;
    }

    Ifd::Ifd(IfdId ifdId)
        : ifdId_(ifdId), offset_(0), next_(0), size_(0)
    {
    }

    int Ifd::read(const char* buf, ByteOrder byteOrder, long offset)
    {
        offset_ = offset;
        int n = getUShort(buf, byteOrder);
        long o = 2;

        entries_.clear();
        for (int i=0; i<n; ++i) {
            Metadatum e;
            e.ifdId_ = ifdId_;
            e.ifdIdx_ = i;
            e.tag_ = getUShort(buf+o, byteOrder);
            e.type_ = getUShort(buf+o+2, byteOrder);
            e.count_ = getULong(buf+o+4, byteOrder);
            // offset will be converted to a relative offset below
            e.offset_ = getULong(buf+o+8, byteOrder); 
            e.size_ = e.count_ * e.typeSize();
            // value_ is set later, see below
            entries_.push_back(e);
            o += 12;
        }
        next_ = getULong(buf+o, byteOrder);
        size_ = 2 + 12 * entries_.size() + 4;

        // Guess the offset if it was not given. The guess is based 
        // on the assumption that the smallest offset points to a data 
        // buffer directly following the IFD.
        // Subsequently all offsets of IFD entries need to be recalculated.
        const Metadata::iterator eb = entries_.begin();
        const Metadata::iterator ee = entries_.end();
        Metadata::iterator i = eb;
        if (offset_ == 0 && i != ee) {
            // Find the entry with the smallest offset
            i = std::min_element(eb, ee, cmpOffset);
            // Set the guessed IFD offset
            if (i->size_ > 4) {
                offset_ = i->offset_ - size_;
            }
        }

        // Assign the values to each IFD entry and 
        // calculate offsets relative to the start of the IFD
        for (i = eb; i != ee; ++i) {
            delete i->value_;
            //! Todo: Create the correct type here, once we have them
            i->value_ = Value::create(TypeId(i->type_), byteOrder);
            if (i->size_ > 4) {
                i->offset_ = i->offset_ - offset_;
                i->value_->read(buf + i->offset_, i->size_);
            }
            else {
                char value[4];
                ul2Data(value, i->offset_, byteOrder);
                i->value_->read(value, 4);
            }
        }
        return 0;
    } // Ifd::read

    int Ifd::readSubIfd(
        Ifd& dest, const char* buf, ByteOrder byteOrder, uint16 tag
    ) const
    {
        int rc = 0;
        Metadata::const_iterator pos;
        Metadata::const_iterator end = entries_.end();
        pos = std::find_if(entries_.begin(), end, FindMetadatumByTag(tag));
        if (pos != end) {
            rc = dest.read(buf + pos->offset_, byteOrder, pos->offset_);
        }
        return rc;
    } // Ifd::readSubIfd

    long Ifd::copy(char* buf, ByteOrder byteOrder, long offset) const
    {
        if (offset == 0) offset = offset_;

        // Add the number of entries to the data buffer
        us2Data(buf, entries_.size(), byteOrder);
        long o = 2;

        // Add all directory entries to the data buffer
        long dataSize = 0;
        const Metadata::const_iterator b = entries_.begin();
        const Metadata::const_iterator e = entries_.end();
        Metadata::const_iterator i = b;
        for (; i != e; ++i) {
            us2Data(buf+o, i->tag_, byteOrder);
            us2Data(buf+o+2, i->type_, byteOrder);
            ul2Data(buf+o+4, i->count_, byteOrder);
            if (i->size_ > 4) {
                ul2Data(buf+o+8, offset + size_ + dataSize, byteOrder);
                dataSize += i->size_;
            }
            else {
                ul2Data(buf+o+8, i->offset_, byteOrder);
            }
            o += 12;
        }

        // Add the offset to the next IFD to the data buffer pointing
        // directly behind this IFD and its data
        if (next_ != 0) {
            ul2Data(buf+o, offset + size_ + dataSize, byteOrder);
        }
        else {
            ul2Data(buf+o, 0, byteOrder);
        }
        o += 4;

        // Add the data of all IFD entries to the data buffer
        for (i = b; i != e; ++i) {
            if (i->size_ > 4) {
                // Todo: Check this! There seems to be an inconsistency
                // in the use of size_ and the return value of copy() here
                // Todo: And can value_ be 0?
                o += i->value_->copy(buf+o);
            }
        }

        return o;
    } // Ifd::data

    void Ifd::print(std::ostream& os, const std::string& prefix) const
    {
        if (entries_.size() == 0) return;

        os << prefix << "IFD Offset: 0x"
           << std::setw(8) << std::setfill('0') << std::hex << std::right 
           << offset_ 
           << ",   IFD Entries: " 
           << std::setfill(' ') << std::dec << std::right
           << entries_.size() << "\n"
           << prefix << "Entry     Tag  Format   (Bytes each)  Number  Offset/Data\n"
           << prefix << "-----  ------  ---------------------  ------  -----------\n";

        const Metadata::const_iterator b = entries_.begin();
        const Metadata::const_iterator e = entries_.end();
        Metadata::const_iterator i = b;
        for (; i != e; ++i) {
            std::ostringstream offset;
            if (i->typeSize() * i->count_ <= 4) {
                // Minor cheat here: we use value_ instead of offset_ to avoid
                // having to invoke ul2Data() which would require byte order.
                // Todo: can value_ be 0 here?
                char tmpbuf[4];
                i->value_->copy(tmpbuf);
                offset << std::setw(2) << std::setfill('0') << std::hex
                       << (int)*(unsigned char*)tmpbuf << " "
                       << std::setw(2) << std::setfill('0') << std::hex
                       << (int)*(unsigned char*)(tmpbuf+1) << " "
                       << std::setw(2) << std::setfill('0') << std::hex 
                       << (int)*(unsigned char*)(tmpbuf+2) << " "
                       << std::setw(2) << std::setfill('0') << std::hex
                       << (int)*(unsigned char*)(tmpbuf+3) << " ";
            }
            else {
                offset << " 0x" << std::setw(8) << std::setfill('0') << std::hex
                       << std::right << i->offset_;
            }

            os << prefix << std::setw(5) << std::setfill(' ') << std::dec
               << std::right << i - b
               << "  0x" << std::setw(4) << std::setfill('0') << std::hex 
               << std::right << i->tag_ 
               << "  " << std::setw(17) << std::setfill(' ') 
               << std::left << i->typeName() 
               << " (" << std::dec << i->typeSize() << ")"
               << "  " << std::setw(6) << std::setfill(' ') << std::dec
               << std::right << i->count_
               << "  " << offset.str()
               << "\n";
        }
        os << prefix << "Next IFD: 0x" 
           << std::setw(8) << std::setfill('0') << std::hex
           << std::right << next_ << "\n";

// Todo: Fix me! This does not work with Value anymore 
//        for (i = b; i != e; ++i) {
//            if (i->size_ > 4) {
//                os << "Data of entry " << i-b << ":\n";
//                hexdump(os, i->data_, i->size_);
//            }
//        }

    } // Ifd::print

    int ExifData::read(const std::string& path)
    {
        JpegImage img;
        int rc = img.readExifData(path);
        if (rc) return rc;
        offset_ = img.offsetExifData();
        return read(img.exifData(), img.sizeExifData());
    }

    int ExifData::read(const char* buf, long len)
    {
        int rc = tiffHeader_.read(buf);
        if (rc) return rc;

        // Read IFD0
        Ifd ifd0(ifd0);
        rc = ifd0.read(buf + tiffHeader_.offset(), 
                       byteOrder(), 
                       tiffHeader_.offset());
        if (rc) return rc;

        // Find and read ExifIFD sub-IFD of IFD0
        Ifd exifIfd(exifIfd);
        rc = ifd0.readSubIfd(exifIfd, buf, byteOrder(), 0x8769);
        if (rc) return rc;

        // Find and read Interoperability IFD in ExifIFD
        Ifd iopIfd(iopIfd);
        rc = exifIfd.readSubIfd(iopIfd, buf, byteOrder(), 0xa005);
        if (rc) return rc;

        // Find and read GPSInfo sub-IFD in IFD0
        Ifd gpsIfd(gpsIfd);
        rc = ifd0.readSubIfd(gpsIfd, buf, byteOrder(), 0x8825);
        if (rc) return rc;

        // Read IFD1
        Ifd ifd1(ifd1);
        if (ifd0.next()) {
            rc = ifd1.read(buf + ifd0.next(), byteOrder(), ifd0.next());
            if (rc) return rc;
        }

        // Find and read ExifIFD sub-IFD of IFD1
        Ifd ifd1ExifIfd(ifd1ExifIfd);
        rc = ifd1.readSubIfd(ifd1ExifIfd, buf, byteOrder(), 0x8769);
        if (rc) return rc;

        // Find and read Interoperability IFD in ExifIFD of IFD1
        Ifd ifd1IopIfd(ifd1IopIfd);
        rc = ifd1ExifIfd.readSubIfd(ifd1IopIfd, buf, byteOrder(), 0xa005);
        if (rc) return rc;

        // Find and read GPSInfo sub-IFD in IFD1
        Ifd ifd1GpsIfd(ifd1GpsIfd);
        rc = ifd1.readSubIfd(ifd1GpsIfd, buf, byteOrder(), 0x8825);
        if (rc) return rc;

        // Finally, copy all metadata from the IFDs to the internal metadata
        metadata_.clear();
        add(ifd0.entries());
        add(exifIfd.entries());
        add(iopIfd.entries()); 
        add(gpsIfd.entries());
        add(ifd1.entries());
        add(ifd1ExifIfd.entries());
        add(ifd1IopIfd.entries());
        add(ifd1GpsIfd.entries());

        return 0;
    } // ExifData::read

    long ExifData::copy(char* buf) const
    {
        // Todo: implement me!
        return 0;
    }

    long ExifData::size() const
    {
        // Todo: implement me!
        return 0;
    }

    void ExifData::add(const Metadata& src)
    {
        metadata_.insert(metadata_.end(), src.begin(), src.end());
    }

    void ExifData::add(const Metadatum& src)
    {
        metadata_.push_back(src);
    }

    // *************************************************************************
    // free functions

    uint16 getUShort(const char* buf, ByteOrder byteOrder)
    {
        if (byteOrder == littleEndian) {
            return (unsigned char)buf[1] << 8 | (unsigned char)buf[0];
        }
        else {
            return (unsigned char)buf[0] << 8 | (unsigned char)buf[1];
        }
    }

    uint32 getULong(const char* buf, ByteOrder byteOrder)
    {
        if (byteOrder == littleEndian) {
            return   (unsigned char)buf[3] << 24 | (unsigned char)buf[2] << 16 
                   | (unsigned char)buf[1] <<  8 | (unsigned char)buf[0];
        }
        else {
            return   (unsigned char)buf[0] << 24 | (unsigned char)buf[1] << 16 
                   | (unsigned char)buf[2] <<  8 | (unsigned char)buf[3];
        }
    }

    std::string getString(const char* buf, long len)
    {
        std::string txt(buf, len);
        return txt;
    }

    char* us2Data(char* buf, uint16 s, ByteOrder byteOrder)
    {
        if (byteOrder == littleEndian) {
            buf[0] =  s & 0x00ff;
            buf[1] = (s & 0xff00) >> 8;
        }
        else {
            buf[0] = (s & 0xff00) >> 8;
            buf[1] =  s & 0x00ff;
        }
        return buf;
    }

    char* ul2Data(char* buf, uint32 l, ByteOrder byteOrder)
    {
        if (byteOrder == littleEndian) {
            buf[0] =  l & 0x000000ff;
            buf[1] = (l & 0x0000ff00) >> 8;
            buf[2] = (l & 0x00ff0000) >> 16;
            buf[3] = (l & 0xff000000) >> 24;
        }
        else {
            buf[0] = (l & 0xff000000) >> 24;
            buf[1] = (l & 0x00ff0000) >> 16;
            buf[2] = (l & 0x0000ff00) >> 8;
            buf[3] =  l & 0x000000ff;
        }
        return buf;
    }

    void hexdump(std::ostream& os, const char* buf, long len)
    {
        const std::string::size_type pos = 9 + 16 * 3; 
        const std::string align(pos, ' '); 

        long i = 0;
        while (i < len) {
            os << "   " 
               << std::setw(4) << std::setfill('0') << std::hex 
               << i << "  ";
            std::ostringstream ss;
            do {
                unsigned char c = buf[i];
                os << std::setw(2) << std::setfill('0') 
                   << std::hex << (int)c << " ";
                ss << ((int)c >= 31 && (int)c < 127 ? buf[i] : '.');
            } while (++i < len && i%16 != 0);
            std::string::size_type width = 9 + ((i-1)%16 + 1) * 3;
            os << (width > pos ? "" : align.substr(width)) << ss.str() << "\n";
        }
        os << std::dec << std::setfill(' ');
    }

}                                       // namespace Exif

// *****************************************************************************
// local definitions
namespace {

    bool cmpOffset(const Exif::Metadatum& lhs, const Exif::Metadatum& rhs)
    {
        // We need to ignore entries with size <= 4, so by definition,
        // entries with size <= 4 are greater than those with size > 4
        // when compared by their offset.
        if (lhs.size_ <= 4) {
            return false; // lhs is greater by definition, or they are equal
        }
        if (rhs.size_ <= 4) {
            return true; // rhs is greater by definition (they cannot be equal)
        }
        return lhs.offset_ < rhs.offset_;
    }

}