You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
492 lines
17 KiB
C++
492 lines
17 KiB
C++
20 years ago
|
// ***************************************************************** -*- C++ -*-
|
||
|
|
/*
|
||
|
|
* Copyright (C) 2006 Andreas Huggel <ahuggel@gmx.net>
|
||
|
|
*
|
||
|
|
* This program is part of the Exiv2 distribution.
|
||
|
|
*
|
||
|
|
* This program is free software; you can redistribute it and/or
|
||
|
|
* modify it under the terms of the GNU General Public License
|
||
|
|
* as published by the Free Software Foundation; either version 2
|
||
|
|
* of the License, or (at your option) any later version.
|
||
|
|
*
|
||
|
|
* This program is distributed in the hope that it will be useful,
|
||
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
* GNU General Public License for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU General Public License
|
||
|
|
* along with this program; if not, write to the Free Software
|
||
|
|
* Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
|
||
|
|
*/
|
||
|
|
/*!
|
||
|
|
@file tiffparser.hpp
|
||
|
|
@brief Class TiffParser to parse TIFF data.
|
||
|
|
@version $Rev$
|
||
|
|
@author Andreas Huggel (ahu)
|
||
|
|
<a href="mailto:ahuggel@gmx.net">ahuggel@gmx.net</a>
|
||
|
|
@date 15-Mar-06, ahu: created
|
||
|
|
*/
|
||
|
|
#ifndef TIFFPARSER_HPP_
|
||
|
|
#define TIFFPARSER_HPP_
|
||
|
|
|
||
|
|
// *****************************************************************************
|
||
|
|
// included header files
|
||
|
|
#include "exif.hpp"
|
||
|
|
#include "iptc.hpp"
|
||
|
|
#include "image.hpp"
|
||
|
|
#include "types.hpp"
|
||
|
|
|
||
|
|
// + standard includes
|
||
|
|
#include <iostream>
|
||
|
|
#include <iosfwd>
|
||
|
|
#include <string>
|
||
|
|
#include <vector>
|
||
|
|
|
||
|
|
// *****************************************************************************
|
||
|
|
// namespace extensions
|
||
|
|
namespace Exiv2 {
|
||
|
|
|
||
|
|
// *****************************************************************************
|
||
|
|
// class declarations
|
||
|
|
|
||
|
|
struct TiffStructure;
|
||
|
|
|
||
|
|
// *****************************************************************************
|
||
|
|
// type definitions
|
||
|
|
|
||
|
|
// *****************************************************************************
|
||
|
|
// class definitions
|
||
|
|
|
||
|
|
/*!
|
||
|
|
Known TIFF groups
|
||
|
|
|
||
|
|
Todo: what exactly are these and where should they go?
|
||
|
|
Are they going to be mapped to the second part of an Exif key or are they
|
||
|
|
the second part of the key?
|
||
|
|
*/
|
||
|
|
namespace Group {
|
||
|
|
const uint16_t none = 0; //!< Dummy group
|
||
|
|
const uint16_t ifd0 = 1; //!< Exif IFD0
|
||
|
|
const uint16_t ifd1 = 2; //!< Thumbnail IFD
|
||
|
|
const uint16_t exif = 3; //!< Exif IFD
|
||
|
|
const uint16_t gps = 4; //!< GPS IFD
|
||
|
|
const uint16_t iop = 5; //!< Interoperability IFD
|
||
|
|
const uint16_t makernote = 256; //!< Makernote
|
||
|
|
const uint16_t canonmn = 257; //!< Canon makernote
|
||
|
|
}
|
||
|
|
|
||
|
|
/*!
|
||
|
|
Known TIFF tags
|
||
|
|
|
||
|
|
Todo: Same Q as above...
|
||
|
|
*/
|
||
|
|
namespace Tag {
|
||
|
|
const int32_t none = -1; //!< Dummy tag
|
||
|
|
const int32_t root = -2; //!< Special tag: root IFD
|
||
|
|
const int32_t next = -3; //!< Special tag: next IFD
|
||
|
|
}
|
||
|
|
|
||
|
|
/*!
|
||
|
|
@brief Interface class for components of a TIFF directory hierarchy. Both
|
||
|
|
TIFF directories as well as entries implement this interface. This
|
||
|
|
class is implemented as NVI (non-virtual interface).
|
||
|
|
*/
|
||
|
|
class TiffComponent {
|
||
|
|
public:
|
||
|
|
//! TiffComponent auto_ptr type
|
||
|
|
typedef std::auto_ptr<TiffComponent> AutoPtr;
|
||
|
|
//! Container type to hold all metadata
|
||
|
|
typedef std::vector<TiffComponent*> Components;
|
||
|
|
|
||
|
|
//! @name Creators
|
||
|
|
//@{
|
||
|
|
//! Constructor
|
||
|
|
TiffComponent(uint16_t group, const TiffStructure* pTiffStructure)
|
||
|
|
: group_(group), pTiffStructure_(pTiffStructure) {}
|
||
|
|
|
||
|
|
//! Virtual destructor.
|
||
|
|
virtual ~TiffComponent() {}
|
||
|
|
//@}
|
||
|
|
|
||
|
|
//! @name Manipulators
|
||
|
|
//@{
|
||
|
|
/*!
|
||
|
|
@brief Read a component from a data buffer
|
||
|
|
|
||
|
|
@param pData Pointer to the data buffer, starting with a TIFF header.
|
||
|
|
@param size Number of bytes in the data buffer.
|
||
|
|
@param start Component starts at \em pData + \em start.
|
||
|
|
@param byteOrder Applicable byte order (little or big endian).
|
||
|
|
|
||
|
|
@throw Error If the component cannot be parsed.
|
||
|
|
*/
|
||
|
|
void read(const byte* pData,
|
||
|
|
uint32_t size,
|
||
|
|
uint32_t start,
|
||
|
|
ByteOrder byteOrder);
|
||
|
|
//@}
|
||
|
|
|
||
|
|
//! @name Accessors
|
||
|
|
//@{
|
||
|
|
//*! Return the group id of this component
|
||
|
|
uint16_t group() const { return group_; }
|
||
|
|
//*! Return the TIFF structure
|
||
|
|
const TiffStructure* pTiffStructure() const { return pTiffStructure_; }
|
||
|
|
/*!
|
||
|
|
@brief Decode metadata from the component and add it to
|
||
|
|
\em image.
|
||
|
|
|
||
|
|
@param image Image to add the metadata to
|
||
|
|
@param byteOrder Byte order
|
||
|
|
*/
|
||
|
|
void decode(Image& image, ByteOrder byteOrder) const;
|
||
|
|
/*!
|
||
|
|
@brief Print debug info about a component to \em os.
|
||
|
|
|
||
|
|
@param os Output stream to write to
|
||
|
|
@param byteOrder Byte order
|
||
|
|
@param prefix Prefix to be written before each line of output
|
||
|
|
*/
|
||
|
|
void print(std::ostream& os,
|
||
|
|
ByteOrder byteOrder,
|
||
|
|
const std::string& prefix ="") const;
|
||
|
|
//@}
|
||
|
|
|
||
|
|
protected:
|
||
|
|
//! @name Manipulators
|
||
|
|
//@{
|
||
|
|
//! Implements read().
|
||
|
|
virtual void doRead(const byte* pData,
|
||
|
|
uint32_t size,
|
||
|
|
uint32_t start,
|
||
|
|
ByteOrder byteOrder) =0;
|
||
|
|
//@}
|
||
|
|
|
||
|
|
//! @name Accessors
|
||
|
|
//@{
|
||
|
|
//! Implements decode()
|
||
|
|
virtual void doDecode(Image& image,
|
||
|
|
ByteOrder byteOrder) const =0;
|
||
|
|
//! Implements print()
|
||
|
|
virtual void doPrint(std::ostream& os,
|
||
|
|
ByteOrder byteOrder,
|
||
|
|
const std::string& prefix) const =0;
|
||
|
|
//@}
|
||
|
|
|
||
|
|
private:
|
||
|
|
// DATA
|
||
|
|
uint16_t group_; //!< Group id for this component
|
||
|
|
const TiffStructure* pTiffStructure_; //!< TIFF structure for this component
|
||
|
|
|
||
|
|
}; // class TiffComponent
|
||
|
|
|
||
|
|
/*!
|
||
|
|
@brief This baseclass provides the common functionality of an IFD directory entry
|
||
|
|
and defines the interface for derived concrete entries.
|
||
|
|
|
||
|
|
todo: make sure this class is an ABC
|
||
|
|
*/
|
||
|
|
class TiffEntryBase : public TiffComponent {
|
||
|
|
public:
|
||
|
|
//! @name Creators
|
||
|
|
//@{
|
||
|
|
//! Default constructor
|
||
|
|
TiffEntryBase()
|
||
|
|
: TiffComponent(Group::none, 0),
|
||
|
|
tag_(0), type_(0), count_(0), offset_(0),
|
||
|
|
size_(0), pData_(0), isAllocated_(false) {}
|
||
|
|
//! Virtual destructor.
|
||
|
|
virtual ~TiffEntryBase();
|
||
|
|
//@}
|
||
|
|
|
||
|
|
//! @name Accessors
|
||
|
|
//@{
|
||
|
|
//! Return the tag of this entry.
|
||
|
|
uint16_t tag() const { return tag_; }
|
||
|
|
//! Return the Exiv2 type which corresponds to the field type.
|
||
|
|
TypeId typeId() const { return TypeId(type_); }
|
||
|
|
//! Return the number of components in this entry.
|
||
|
|
uint32_t count() const { return count_; }
|
||
|
|
//! Return the offset relative to the start of the TIFF header.
|
||
|
|
uint32_t offset() const { return offset_; }
|
||
|
|
//! Return the size of this component in bytes
|
||
|
|
uint32_t size() const { return size_; }
|
||
|
|
//! Return a pointer to the data area of this component
|
||
|
|
const byte* pData() const { return pData_; }
|
||
|
|
//@}
|
||
|
|
|
||
|
|
protected:
|
||
|
|
//! @name Manipulators
|
||
|
|
//@{
|
||
|
|
//! Implements read().
|
||
|
|
virtual void doRead(const byte* pData,
|
||
|
|
uint32_t size,
|
||
|
|
uint32_t start,
|
||
|
|
ByteOrder byteOrder);
|
||
|
|
//@}
|
||
|
|
|
||
|
|
//! @name Accessors
|
||
|
|
//@{
|
||
|
|
//! Implements decode() for a TIFF IFD entry
|
||
|
|
virtual void doDecode(Image& image, ByteOrder byteOrder) const;
|
||
|
|
//! Implements print() for a TIFF IFD entry
|
||
|
|
virtual void doPrint(std::ostream& os,
|
||
|
|
ByteOrder byteOrder,
|
||
|
|
const std::string& prefix) const;
|
||
|
|
//@}
|
||
|
|
|
||
|
|
private:
|
||
|
|
// DATA
|
||
|
|
uint16_t tag_; //!< Tag that identifies the field
|
||
|
|
uint16_t type_; //!< Field Type
|
||
|
|
uint32_t count_; //!< The number of values of the indicated Type
|
||
|
|
uint32_t offset_; //!< Offset to the data area from start of the TIFF header
|
||
|
|
/*!
|
||
|
|
Size of the data buffer holding the value in bytes, there is no
|
||
|
|
minimum size.
|
||
|
|
*/
|
||
|
|
uint32_t size_;
|
||
|
|
const byte* pData_; //!< Pointer to the data area
|
||
|
|
bool isAllocated_; //!< True if this entry owns the value data
|
||
|
|
|
||
|
|
}; // class TiffEntryBase
|
||
|
|
|
||
|
|
/*!
|
||
|
|
@brief A standard TIFF IFD entry. The value is kept in a data buffer.
|
||
|
|
*/
|
||
|
|
class TiffEntry : public TiffEntryBase {
|
||
|
|
public:
|
||
|
|
//! @name Creators
|
||
|
|
//@{
|
||
|
|
//! Virtual destructor.
|
||
|
|
virtual ~TiffEntry() {}
|
||
|
|
//@}
|
||
|
|
|
||
|
|
private:
|
||
|
|
//! @name Manipulators
|
||
|
|
//@{
|
||
|
|
//! Implements read().
|
||
|
|
virtual void doRead(const byte* pData,
|
||
|
|
uint32_t size,
|
||
|
|
uint32_t start,
|
||
|
|
ByteOrder byteOrder);
|
||
|
|
//@}
|
||
|
|
|
||
|
|
//! @name Accessors
|
||
|
|
//@{
|
||
|
|
virtual void doDecode(Image& image, ByteOrder byteOrder) const;
|
||
|
|
//! Implements print() for a TIFF IFD entry
|
||
|
|
virtual void doPrint(std::ostream& os,
|
||
|
|
ByteOrder byteOrder,
|
||
|
|
const std::string& prefix) const;
|
||
|
|
//@}
|
||
|
|
|
||
|
|
}; // class TiffEntry
|
||
|
|
|
||
|
|
//! This class models a TIFF directory (%Ifd).
|
||
|
|
class TiffDirectory : public TiffComponent {
|
||
|
|
public:
|
||
|
|
//! @name Creators
|
||
|
|
//@{
|
||
|
|
//! Default constructor
|
||
|
|
TiffDirectory(uint16_t group, const TiffStructure* pTiffStructure)
|
||
|
|
: TiffComponent(group, pTiffStructure), pNext_(0) {}
|
||
|
|
//! Virtual destructor
|
||
|
|
virtual ~TiffDirectory();
|
||
|
|
//@}
|
||
|
|
|
||
|
|
private:
|
||
|
|
//! @name Manipulators
|
||
|
|
//@{
|
||
|
|
virtual void doRead(const byte* pData,
|
||
|
|
uint32_t size,
|
||
|
|
uint32_t start,
|
||
|
|
ByteOrder byteOrder);
|
||
|
|
//@}
|
||
|
|
|
||
|
|
//! @name Accessors
|
||
|
|
//@{
|
||
|
|
virtual void doDecode(Image& image,
|
||
|
|
ByteOrder byteOrder) const;
|
||
|
|
|
||
|
|
virtual void doPrint(std::ostream& os,
|
||
|
|
ByteOrder byteOrder,
|
||
|
|
const std::string& prefix) const;
|
||
|
|
//@}
|
||
|
|
|
||
|
|
private:
|
||
|
|
// DATA
|
||
|
|
Components components_; //!< List of components in this directory
|
||
|
|
TiffComponent* pNext_; //!< Pointer to the next IFD
|
||
|
|
|
||
|
|
}; // class TiffDirectory
|
||
|
|
|
||
|
|
//! This class models a TIFF sub-directory (%SubIfd).
|
||
|
|
class TiffSubIfd : public TiffEntryBase {
|
||
|
|
public:
|
||
|
|
//! @name Creators
|
||
|
|
//@{
|
||
|
|
//! Default constructor
|
||
|
|
TiffSubIfd(uint16_t group, const TiffStructure* pTiffStructure)
|
||
|
|
: ifd_(group, pTiffStructure) {}
|
||
|
|
//! Virtual destructor
|
||
|
|
virtual ~TiffSubIfd() {}
|
||
|
|
//@}
|
||
|
|
|
||
|
|
private:
|
||
|
|
//! @name Manipulators
|
||
|
|
//@{
|
||
|
|
virtual void doRead(const byte* pData,
|
||
|
|
uint32_t size,
|
||
|
|
uint32_t start,
|
||
|
|
ByteOrder byteOrder);
|
||
|
|
//@}
|
||
|
|
|
||
|
|
//! @name Accessors
|
||
|
|
//@{
|
||
|
|
virtual void doDecode(Image& image,
|
||
|
|
ByteOrder byteOrder) const;
|
||
|
|
|
||
|
|
virtual void doPrint(std::ostream& os,
|
||
|
|
ByteOrder byteOrder,
|
||
|
|
const std::string& prefix) const;
|
||
|
|
//@}
|
||
|
|
|
||
|
|
private:
|
||
|
|
// DATA
|
||
|
|
TiffDirectory ifd_; //!< The subdirectory
|
||
|
|
|
||
|
|
}; // class TiffDirectory
|
||
|
|
|
||
|
|
/*!
|
||
|
|
@brief This class models a TIFF header structure.
|
||
|
|
*/
|
||
|
|
class TiffHeade2 {
|
||
|
|
public:
|
||
|
|
//! @name Creators
|
||
|
|
//@{
|
||
|
|
//! Default constructor
|
||
|
|
TiffHeade2()
|
||
|
|
: byteOrder_ (littleEndian),
|
||
|
|
offset_ (0x00000008)
|
||
|
|
{}
|
||
|
|
//@}
|
||
|
|
|
||
|
|
//! @name Manipulators
|
||
|
|
//@{
|
||
|
|
/*!
|
||
|
|
@brief Read the TIFF header from a data buffer. Return false if the
|
||
|
|
data buffer does not contain a TIFF header, else true.
|
||
|
|
|
||
|
|
@param pData Pointer to the data buffer.
|
||
|
|
@param size Number of bytes in the data buffer.
|
||
|
|
*/
|
||
|
|
bool read(const byte* pData, uint32_t size);
|
||
|
|
//@}
|
||
|
|
|
||
|
|
//! @name Accessors
|
||
|
|
//@{
|
||
|
|
/*!
|
||
|
|
@brief Write the TIFF header to the binary image \em blob.
|
||
|
|
This method appends to the blob.
|
||
|
|
|
||
|
|
@param blob Binary image to add to.
|
||
|
|
|
||
|
|
@throw Error If the header cannot be written.
|
||
|
|
*/
|
||
|
|
void write(Blob& blob) const;
|
||
|
|
/*!
|
||
|
|
@brief Print debug info for the TIFF header to \em os.
|
||
|
|
|
||
|
|
@param os Output stream to write to.
|
||
|
|
@param prefix Prefix to be written before each line of output.
|
||
|
|
*/
|
||
|
|
void print(std::ostream& os, const std::string& prefix ="") const;
|
||
|
|
//! Return the byte order (little or big endian).
|
||
|
|
ByteOrder byteOrder() const { return byteOrder_; }
|
||
|
|
//! Return the offset to the start of the root directory
|
||
|
|
uint32_t offset() const { return offset_; }
|
||
|
|
//@}
|
||
|
|
|
||
|
|
private:
|
||
|
|
// DATA
|
||
|
|
ByteOrder byteOrder_; //!< Applicable byte order
|
||
|
|
uint32_t offset_; //!< Offset to the start of the root dir
|
||
|
|
|
||
|
|
static const uint16_t tag_; //!< 42, identifies the buffer as TIFF data
|
||
|
|
|
||
|
|
}; // class TiffHeade2
|
||
|
|
|
||
|
|
/*!
|
||
|
|
Type for a function pointer for functions to create TIFF components.
|
||
|
|
Todo: This may eventually need to also have access to the image or parse tree
|
||
|
|
in order to make decisions based on the value of other tags.
|
||
|
|
*/
|
||
|
|
typedef TiffComponent::AutoPtr (*NewTiffCompFct)(uint16_t group,
|
||
|
|
const TiffStructure* tiffStructure);
|
||
|
|
|
||
|
|
/*!
|
||
|
|
Table describing the TIFF structure of an image format for reading and writing.
|
||
|
|
Different tables can be used to support different TIFF based image formats.
|
||
|
|
*/
|
||
|
|
struct TiffStructure {
|
||
|
|
int32_t tag_; //!< Tag
|
||
|
|
uint16_t group_; //!< Group that contains the tag
|
||
|
|
NewTiffCompFct newTiffCompFct_; //!< Function to create the correct TIFF component
|
||
|
|
uint16_t newGroup_; //!< Group of the newly created component
|
||
|
|
};
|
||
|
|
|
||
|
|
/*!
|
||
|
|
Stateless parser class for data in TIFF format.
|
||
|
|
*/
|
||
|
|
class TiffParser {
|
||
|
|
public:
|
||
|
|
/*!
|
||
|
|
@brief Decode TIFF metadata from a data buffer \em pData of length
|
||
|
|
\em size into \em image.
|
||
|
|
|
||
|
|
This is the entry point to access image data in TIFF format. The
|
||
|
|
parser uses classes TiffHeade2, TiffEntry, TiffDirectory.
|
||
|
|
|
||
|
|
@param pImage Pointer to the %Exiv2 TIFF image to hold the
|
||
|
|
metadata read from the buffer.
|
||
|
|
@param pTiffStructure Pointer to a table describing the TIFF structure
|
||
|
|
used to decode the data.
|
||
|
|
@param pData Pointer to the data buffer. Must point to data
|
||
|
|
in TIFF format; no checks are performed.
|
||
|
|
@param size Length of the data buffer.
|
||
|
|
|
||
|
|
@throw Error If the data buffer cannot be parsed.
|
||
|
|
*/
|
||
|
|
static void decode( Image* pImage,
|
||
|
|
const TiffStructure* pTiffStructure,
|
||
|
|
const byte* pData,
|
||
|
|
uint32_t size);
|
||
|
|
/*!
|
||
|
|
@brief Create the appropriate TiffComponent to handle the \em tag in
|
||
|
|
\em group.
|
||
|
|
|
||
|
|
Uses table \em pTiffStructure to derive the correct component. If a
|
||
|
|
tag, group tupel is not found in the table, a TiffEntry is created. If
|
||
|
|
the pointer that is returned is 0, then the tag should be ignored.
|
||
|
|
*/
|
||
|
|
static TiffComponent::AutoPtr create( int32_t tag,
|
||
|
|
uint16_t group,
|
||
|
|
const TiffStructure* pTiffStructure);
|
||
|
|
}; // class TiffParser
|
||
|
|
|
||
|
|
// *****************************************************************************
|
||
|
|
// template, inline and free functions
|
||
|
|
|
||
|
|
//!< Function to create and initialize a new TIFF directory
|
||
|
|
TiffComponent::AutoPtr newTiffDirectory(uint16_t group,
|
||
|
|
const TiffStructure* pTiffStructure);
|
||
|
|
|
||
|
|
//!< Function to create and initialize a new TIFF sub-directory
|
||
|
|
TiffComponent::AutoPtr newTiffSubIfd(uint16_t group,
|
||
|
|
const TiffStructure* pTiffStructure);
|
||
|
|
|
||
|
|
} // namespace Exiv2
|
||
|
|
|
||
|
|
#endif // #ifndef TIFFPARSER_HPP_
|