Exiv2
|
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of the objects of this namespace. More...
Namespaces | |
ImageType | |
Supported image formats. | |
Internal | |
Contains internal objects which are not published and are not part of the libexiv2 API. | |
Classes | |
class | AnyError |
Error class interface. Allows the definition and use of a hierarchy of error classes which can all be handled in one catch block. Inherits from the standard exception base-class, to make life easier for library users (they have the option of catching most things via std::exception). More... | |
class | AsciiValue |
Value for an Ascii string type. More... | |
class | AsfVideo |
Class to access ASF video files. More... | |
class | BasicError |
Simple error class used for exceptions. An output operator is provided to print errors to a stream. More... | |
class | BasicIo |
An interface for simple binary IO. More... | |
class | BmpImage |
Class to access Windows bitmaps. This is just a stub - we only read width and height. More... | |
class | CommentValue |
Value for an Exif comment. More... | |
class | Converter |
Metadata conversions. More... | |
class | Cr2Image |
Class to access raw Canon CR2 images. Exif metadata is supported directly, IPTC is read from the Exif data, if present. More... | |
class | Cr2Parser |
Stateless parser class for data in CR2 format. Images use this class to decode and encode CR2 data. See class TiffParser for details. More... | |
class | CrwImage |
Class to access raw Canon CRW images. Only Exif metadata and a comment are supported. CRW format does not contain IPTC metadata. More... | |
class | CrwParser |
class | DataBuf |
Utility class containing a character array. All it does is to take care of memory allocation and deletion. Its primary use is meant to be as a stack variable in functions that need a temporary data buffer. More... | |
struct | DataBufRef |
Auxiliary type to enable copies and assignments, similar to std::auto_ptr_ref. See http://www.josuttis.com/libbook/auto_ptr.html for a discussion. More... | |
struct | DataSet |
Details of an IPTC dataset. More... | |
class | DataValue |
Value for an undefined data type. More... | |
class | DateValue |
Value for simple ISO 8601 dates More... | |
class | EpsImage |
Class to access EPS images. More... | |
class | ExifData |
A container for Exif data. This is a top-level class of the Exiv2 library. The container holds Exifdatum objects. More... | |
class | Exifdatum |
An Exif metadatum, consisting of an ExifKey and a Value and methods to manipulate these. More... | |
class | ExifKey |
Concrete keys for Exif metadata and access to Exif tag reference data. More... | |
class | ExifParser |
Stateless parser class for Exif data. Images use this class to decode and encode binary Exif data. More... | |
class | ExifTags |
Access to Exif group and tag lists and misc. tag reference methods, implemented as a static class. More... | |
class | ExifThumb |
Access and modify an Exif thumbnail image. This class implements manipulators to set and erase the thumbnail image that is optionally embedded in IFD1 of the Exif data. Accessors are provided by the base class, ExifThumbC. More... | |
class | ExifThumbC |
Access to a Exif thumbnail image. This class provides higher level accessors to the thumbnail image that is optionally embedded in IFD1 of the Exif data. These methods do not write to the Exif metadata. Manipulators are provided in subclass ExifThumb. More... | |
class | ExvImage |
Helper class to access Exiv2 files. More... | |
class | FileIo |
Provides binary file IO by implementing the BasicIo interface. More... | |
class | GifImage |
Class to access raw GIF images. Exif/IPTC metadata are supported directly. More... | |
struct | GroupInfo |
The details of an Exif group. Groups include IFDs and binary arrays. More... | |
class | Image |
Abstract base class defining the interface for an image. This is the top-level interface to the Exiv2 library. More... | |
class | ImageFactory |
Returns an Image instance of the specified type. More... | |
class | IoCloser |
Utility class that closes a BasicIo instance upon destruction. Meant to be used as a stack variable in functions that need to ensure BasicIo instances get closed. Useful when functions return errors from many locations. More... | |
class | IptcData |
A container for IPTC data. This is a top-level class of the Exiv2 library. More... | |
class | IptcDataSets |
IPTC dataset reference, implemented as a static class. More... | |
class | Iptcdatum |
An IPTC metadatum ("dataset"), consisting of an IptcKey and a Value and methods to manipulate these. More... | |
class | IptcKey |
Concrete keys for IPTC metadata. More... | |
class | IptcParser |
Stateless parser class for IPTC data. Images use this class to decode and encode binary IPTC data. More... | |
class | Jp2Image |
Class to access JPEG-2000 images. More... | |
class | JpegBase |
Abstract helper base class to access JPEG images. More... | |
class | JpegImage |
Class to access JPEG images. More... | |
class | Key |
Abstract base class defining the Key of a metadatum. Keys are used to identify and group metadata. More... | |
class | LangAltValue |
Value type for XMP language alternative properties. More... | |
class | LogMsg |
Class for a log message, used by the library. Applications can set the log level and provide a customer log message handler (callback function). More... | |
struct | MatroskaTags |
Helper structure for the Matroska tags lookup table. More... | |
class | MatroskaVideo |
Class to access Matroska video files. More... | |
class | MemIo |
Provides binary IO on blocks of memory by implementing the BasicIo interface. A copy-on-write implementation ensures that the data passed in is only copied when necessary, i.e., as soon as data is written to the MemIo. The original data is only used for reading. If writes are performed, the changed data can be retrieved using the read methods (since the data used in construction is never modified). More... | |
class | Metadatum |
Abstract base class defining the interface to access information related to one metadata tag. More... | |
struct | MimeTypeList |
Structure for TIFF compression to MIME type mappings. More... | |
class | MrwImage |
Class to access raw Minolta MRW images. Exif metadata is supported directly, IPTC is read from the Exif data, if present. More... | |
struct | NativePreview |
Native preview information. This is meant to be used only by the PreviewManager. More... | |
class | OrfImage |
Class to access raw Olympus ORF images. Exif metadata is supported directly, IPTC is read from the Exif data, if present. More... | |
class | OrfParser |
Stateless parser class for data in ORF format. Images use this class to decode and encode ORF data. See class TiffParser for details. More... | |
class | PgfImage |
Class to access PGF images. Exif and IPTC metadata are supported directly. More... | |
struct | Photoshop |
Helper class, has methods to deal with Photoshop "Information
Resource Blocks" (IRBs). More... | |
class | PngImage |
Class to access PNG images. Exif and IPTC metadata are supported directly. More... | |
class | PreviewImage |
Class that holds preview image properties and data buffer. More... | |
class | PreviewManager |
Class for extracting preview images from image metadata. More... | |
struct | PreviewProperties |
Preview image properties. More... | |
class | PsdImage |
Class to access raw Photoshop images. More... | |
class | QuickTimeVideo |
Class to access QuickTime video files. More... | |
class | RafImage |
Class to access raw Fujifilm RAF images. Exif metadata is supported directly, IPTC is read from the Exif data, if present. More... | |
struct | RecordInfo |
Details of an IPTC record. More... | |
class | RiffVideo |
Class to access RIFF video files. More... | |
class | Rw2Image |
Class to access raw Panasonic RW2 images. Exif metadata is supported directly, IPTC and XMP are read from the Exif data, if present. More... | |
class | Rw2Parser |
Stateless parser class for data in RW2 format. Images use this class to decode and encode RW2 data. Only decoding is currently implemented. See class TiffParser for details. More... | |
class | StringValue |
Value for string type. More... | |
class | StringValueBase |
Abstract base class for a string based Value type. More... | |
struct | TagInfo |
Tag information. More... | |
class | TgaImage |
Class to access raw TARGA images. This is just a stub - we only read width and height. More... | |
class | TiffImage |
Class to access TIFF images. Exif metadata is supported directly, IPTC is read from the Exif data, if present. More... | |
class | TiffParser |
Stateless parser class for data in TIFF format. Images use this class to decode and encode TIFF data. It is a wrapper of the internal class Internal::TiffParserWorker. More... | |
class | TimeValue |
Value for simple ISO 8601 times. More... | |
class | TypeInfo |
Type information lookup functions. Implemented as a static class. More... | |
class | Value |
Common interface for all types of values used with metadata. More... | |
class | ValueType |
Template for a Value of a basic type. This is used for unsigned and signed short, long and rationals. More... | |
class | XmpArrayValue |
Value type for simple arrays. Each item in the array is a simple value, without qualifiers. The array may be an ordered (seq), unordered (bag) or alternative array (alt). The array items must not contain qualifiers. For language alternatives use LangAltValue. More... | |
class | XmpData |
A container for XMP data. This is a top-level class of the Exiv2 library. More... | |
class | Xmpdatum |
Information related to an XMP property. An XMP metadatum consists of an XmpKey and a Value and provides methods to manipulate these. More... | |
class | XmpKey |
Concrete keys for XMP metadata. More... | |
struct | XmpNsInfo |
Structure mapping XMP namespaces and (preferred) prefixes. More... | |
class | XmpParser |
Stateless parser class for XMP packets. Images use this class to parse and serialize XMP packets. The parser uses the XMP toolkit to do the job. More... | |
class | XmpProperties |
XMP property reference, implemented as a static class. More... | |
struct | XmpPropertyInfo |
Information about one XMP property. More... | |
class | XmpSidecar |
Class to access XMP sidecar files. They contain only XMP metadata. More... | |
class | XmpTextValue |
Value type suitable for simple XMP properties and XMP nodes of complex types which are not parsed into specific values. More... | |
class | XmpValue |
Base class for all Exiv2 values used to store XMP property values. More... | |
Typedefs | |
typedef BasicError< char > | Error |
Error class used for exceptions (std::string based) | |
typedef std::list< Exifdatum > | ExifMetadata |
Container type to hold all metadata. | |
typedef std::vector < NativePreview > | NativePreviewList |
List of native previews. This is meant to be used only by the PreviewManager. | |
typedef Image::AutoPtr(* | NewInstanceFct )(BasicIo::AutoPtr io, bool create) |
Type for function pointer that creates new Image instances. | |
typedef bool(* | IsThisTypeFct )(BasicIo &iIo, bool advance) |
Type for function pointer that checks image types. | |
typedef std::vector< Iptcdatum > | IptcMetadata |
Container type to hold all metadata. | |
typedef int | PreviewId |
Type of preview image. | |
typedef std::vector < PreviewProperties > | PreviewPropertiesList |
Container type to hold all preview images metadata. | |
typedef std::ostream &(* | PrintFct )(std::ostream &, const Value &, const ExifData *pExifData) |
Type for a function pointer for functions interpreting the tag value. | |
typedef const TagInfo *(* | TagListFct )() |
A function returning a tag list. | |
typedef uint8_t | byte |
1 byte unsigned integer type. | |
typedef std::pair< uint32_t, uint32_t > | URational |
8 byte unsigned rational type. | |
typedef std::pair< int32_t, int32_t > | Rational |
8 byte signed rational type. | |
typedef std::vector< byte > | Blob |
Container for binary data. | |
typedef ValueType< uint16_t > | UShortValue |
Unsigned short value type. | |
typedef ValueType< uint32_t > | ULongValue |
Unsigned long value type. | |
typedef ValueType< URational > | URationalValue |
Unsigned rational value type. | |
typedef ValueType< int16_t > | ShortValue |
Signed short value type. | |
typedef ValueType< int32_t > | LongValue |
Signed long value type. | |
typedef ValueType< Rational > | RationalValue |
Signed rational value type. | |
typedef ValueType< float > | FloatValue |
Float value type. | |
typedef ValueType< double > | DoubleValue |
Double value type. | |
typedef std::vector< Xmpdatum > | XmpMetadata |
Container type to hold all metadata. | |
Enumerations | |
enum | XmpCategory { xmpInternal, xmpExternal } |
Category of an XMP property. | |
enum | ByteOrder { invalidByteOrder, littleEndian, bigEndian } |
Type to express the byte order (little or big endian) | |
enum | WriteMethod { wmIntrusive, wmNonIntrusive } |
Type to indicate write method used by TIFF parsers. | |
enum | MetadataId { mdNone =0, mdExif =1, mdIptc =2, mdComment =4, mdXmp =8 } |
An identifier for each type of metadata. | |
enum | AccessMode { amNone =0, amRead =1, amWrite =2, amReadWrite =3 } |
An identifier for each mode of metadata support. | |
enum | TypeId { unsignedByte = 1, asciiString = 2, unsignedShort = 3, unsignedLong = 4, unsignedRational = 5, signedByte = 6, undefined = 7, signedShort = 8, signedLong = 9, signedRational =10, tiffFloat =11, tiffDouble =12, tiffIfd =13, string =0x10000, date =0x10001, time =0x10002, comment =0x10003, directory =0x10004, xmpText =0x10005, xmpAlt =0x10006, xmpBag =0x10007, xmpSeq =0x10008, langAlt =0x10009, invalidTypeId =0x1fffe, lastTypeId =0x1ffff } |
Exiv2 value type identifiers. More... | |
Functions | |
Image::AutoPtr | newAsfInstance (BasicIo::AutoPtr io, bool create) |
Create a new AsfVideo instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isAsfType (BasicIo &iIo, bool advance) |
Check if the file iIo is a Windows Asf Video. | |
DataBuf | readFile (const std::string &path) |
Read file path into a DataBuf, which is returned. More... | |
long | writeFile (const DataBuf &buf, const std::string &path) |
Write DataBuf buf to file path. More... | |
Image::AutoPtr | newBmpInstance (BasicIo::AutoPtr io, bool create) |
Create a new BmpImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isBmpType (BasicIo &iIo, bool advance) |
Check if the file iIo is a Windows Bitmap image. | |
void | copyExifToXmp (const ExifData &exifData, XmpData &xmpData) |
Convert (copy) Exif tags to XMP properties. | |
void | moveExifToXmp (ExifData &exifData, XmpData &xmpData) |
Convert (move) Exif tags to XMP properties, remove converted Exif tags. | |
void | copyXmpToExif (const XmpData &xmpData, ExifData &exifData) |
Convert (copy) XMP properties to Exif tags. | |
void | moveXmpToExif (XmpData &xmpData, ExifData &exifData) |
Convert (move) XMP properties to Exif tags, remove converted XMP properties. | |
void | syncExifWithXmp (ExifData &exifData, XmpData &xmpData) |
Detect which metadata are newer and perform a copy in appropriate direction. | |
void | copyIptcToXmp (const IptcData &iptcData, XmpData &xmpData, const char *iptcCharset=0) |
Convert (copy) IPTC datasets to XMP properties. | |
void | moveIptcToXmp (IptcData &iptcData, XmpData &xmpData, const char *iptcCharset=0) |
Convert (move) IPTC datasets to XMP properties, remove converted IPTC datasets. | |
void | copyXmpToIptc (const XmpData &xmpData, IptcData &iptcData) |
Convert (copy) XMP properties to IPTC datasets. | |
void | moveXmpToIptc (XmpData &xmpData, IptcData &iptcData) |
Convert (move) XMP properties to IPTC tags, remove converted XMP properties. | |
bool | convertStringCharset (std::string &str, const char *from, const char *to) |
Convert character encoding of str from from to to. If the function succeeds, str contains the result string. More... | |
Image::AutoPtr | newCr2Instance (BasicIo::AutoPtr io, bool create) |
Create a new Cr2Image instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isCr2Type (BasicIo &iIo, bool advance) |
Check if the file iIo is a CR2 image. | |
Image::AutoPtr | newCrwInstance (BasicIo::AutoPtr io, bool create) |
Create a new CrwImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isCrwType (BasicIo &iIo, bool advance) |
Check if the file iIo is a CRW image. | |
std::ostream & | operator<< (std::ostream &os, const DataSet &dataSet) |
Output operator for dataSet. | |
ExifData::const_iterator | orientation (const ExifData &ed) |
Return the orientation of the image. | |
ExifData::const_iterator | isoSpeed (const ExifData &ed) |
Return the ISO speed used to shoot the image. | |
ExifData::const_iterator | flashBias (const ExifData &ed) |
Return the flash bias value. | |
ExifData::const_iterator | exposureMode (const ExifData &ed) |
Return the exposure mode setting. | |
ExifData::const_iterator | sceneMode (const ExifData &ed) |
Return the scene mode setting. | |
ExifData::const_iterator | macroMode (const ExifData &ed) |
Return the macro mode setting. | |
ExifData::const_iterator | imageQuality (const ExifData &ed) |
Return the image quality setting. | |
ExifData::const_iterator | whiteBalance (const ExifData &ed) |
Return the white balance setting. | |
ExifData::const_iterator | lensName (const ExifData &ed) |
Return the name of the lens used. | |
ExifData::const_iterator | saturation (const ExifData &ed) |
Return the saturation level. | |
ExifData::const_iterator | sharpness (const ExifData &ed) |
Return the sharpness level. | |
ExifData::const_iterator | contrast (const ExifData &ed) |
Return the contrast level. | |
ExifData::const_iterator | sceneCaptureType (const ExifData &ed) |
Return the scene capture type. | |
ExifData::const_iterator | meteringMode (const ExifData &ed) |
Return the metering mode setting. | |
ExifData::const_iterator | make (const ExifData &ed) |
Return the camera make. | |
ExifData::const_iterator | model (const ExifData &ed) |
Return the camera model. | |
ExifData::const_iterator | exposureTime (const ExifData &ed) |
Return the exposure time. | |
ExifData::const_iterator | fNumber (const ExifData &ed) |
Return the F number. | |
ExifData::const_iterator | subjectDistance (const ExifData &ed) |
Return the subject distance. | |
ExifData::const_iterator | serialNumber (const ExifData &ed) |
Return the camera serial number. | |
ExifData::const_iterator | focalLength (const ExifData &ed) |
Return the focal length setting. | |
ExifData::const_iterator | afPoint (const ExifData &ed) |
Return the AF point. | |
Image::AutoPtr | newEpsInstance (BasicIo::AutoPtr io, bool create) |
Create a new EpsImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isEpsType (BasicIo &iIo, bool advance) |
Check if the file iIo is a EPS image. | |
const char * | errMsg (int code) |
Return the error message for the error with code code. | |
template<typename charT , typename T > | |
std::basic_string< charT > | toBasicString (const T &arg) |
Generalised toString function. | |
std::ostream & | operator<< (std::ostream &os, const AnyError &error) |
AnyError output operator | |
template<typename T > | |
Exiv2::Exifdatum & | setValue (Exiv2::Exifdatum &exifDatum, const T &value) |
Set the value of exifDatum to value. If the object already has a value, it is replaced. Otherwise a new ValueType<T> value is created and set to value. More... | |
bool | fileExists (const std::string &path, bool ct=false) |
Test if a file exists. More... | |
std::string | strError () |
Return a system error message and the error code (errno). See strerror(3). | |
Image::AutoPtr | newGifInstance (BasicIo::AutoPtr io, bool create) |
Create a new GifImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isGifType (BasicIo &iIo, bool advance) |
Check if the file iIo is a GIF image. | |
void | append (Exiv2::Blob &blob, const byte *buf, uint32_t len) |
Append len bytes pointed to by buf to blob. | |
bool | cmpIptcdataByRecord (const Iptcdatum &lhs, const Iptcdatum &rhs) |
Compare two iptc items by record. Return true if the record of lhs is less than that of rhs. More... | |
Image::AutoPtr | newJp2Instance (BasicIo::AutoPtr io, bool create) |
Create a new Jp2Image instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isJp2Type (BasicIo &iIo, bool advance) |
Check if the file iIo is a JPEG-2000 image. | |
Image::AutoPtr | newJpegInstance (BasicIo::AutoPtr io, bool create) |
Create a new JpegImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isJpegType (BasicIo &iIo, bool advance) |
Check if the file iIo is a JPEG image. | |
Image::AutoPtr | newExvInstance (BasicIo::AutoPtr io, bool create) |
Create a new ExvImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isExvType (BasicIo &iIo, bool advance) |
Check if the file iIo is an EXV file. | |
Image::AutoPtr | newMkvInstance (BasicIo::AutoPtr io, bool create) |
Create a new MatroskaVideo instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isMkvType (BasicIo &iIo, bool advance) |
Check if the file iIo is a Matroska Video. | |
bool | cmpMetadataByTag (const Metadatum &lhs, const Metadatum &rhs) |
Compare two metadata by tag. Return true if the tag of metadatum lhs is less than that of rhs. | |
bool | cmpMetadataByKey (const Metadatum &lhs, const Metadatum &rhs) |
Compare two metadata by key. Return true if the key of metadatum lhs is less than that of rhs. | |
std::ostream & | operator<< (std::ostream &os, const Key &key) |
Output operator for Key types. | |
std::ostream & | operator<< (std::ostream &os, const Metadatum &md) |
Output operator for Metadatum types, writing the interpreted tag value. | |
Image::AutoPtr | newMrwInstance (BasicIo::AutoPtr io, bool create) |
Create a new MrwImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isMrwType (BasicIo &iIo, bool advance) |
Check if the file iIo is a MRW image. | |
Image::AutoPtr | newOrfInstance (BasicIo::AutoPtr io, bool create) |
Create a new OrfImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isOrfType (BasicIo &iIo, bool advance) |
Check if the file iIo is an ORF image. | |
Image::AutoPtr | newPgfInstance (BasicIo::AutoPtr io, bool create) |
Create a new PgfImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isPgfType (BasicIo &iIo, bool advance) |
Check if the file iIo is a PGF image. | |
Image::AutoPtr | newPngInstance (BasicIo::AutoPtr io, bool create) |
Create a new PngImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isPngType (BasicIo &iIo, bool advance) |
Check if the file iIo is a PNG image. | |
std::ostream & | operator<< (std::ostream &os, const XmpPropertyInfo &propertyInfo) |
Output operator for property info. | |
Image::AutoPtr | newPsdInstance (BasicIo::AutoPtr io, bool create) |
Create a new PsdImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isPsdType (BasicIo &iIo, bool advance) |
Check if the file iIo is a Photoshop image. | |
Image::AutoPtr | newQTimeInstance (BasicIo::AutoPtr io, bool create) |
Create a new QuicktimeVideo instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isQTimeType (BasicIo &iIo, bool advance) |
Check if the file iIo is a Quick Time Video. | |
Image::AutoPtr | newRafInstance (BasicIo::AutoPtr io, bool create) |
Create a new RafImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isRafType (BasicIo &iIo, bool advance) |
Check if the file iIo is a RAF image. | |
Image::AutoPtr | newRiffInstance (BasicIo::AutoPtr io, bool create) |
Create a new RiffVideo instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isRiffType (BasicIo &iIo, bool advance) |
Check if the file iIo is a Riff Video. | |
Image::AutoPtr | newRw2Instance (BasicIo::AutoPtr io, bool create) |
Create a new Rw2Image instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isRw2Type (BasicIo &iIo, bool advance) |
Check if the file iIo is a RW2 image. | |
std::ostream & | operator<< (std::ostream &os, const TagInfo &ti) |
Output operator for TagInfo. | |
Image::AutoPtr | newTgaInstance (BasicIo::AutoPtr io, bool create) |
Create a new TgaImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isTgaType (BasicIo &iIo, bool advance) |
Check if the file iIo is a Targa v2 image. | |
Image::AutoPtr | newTiffInstance (BasicIo::AutoPtr io, bool create) |
Create a new TiffImage instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isTiffType (BasicIo &iIo, bool advance) |
Check if the file iIo is a TIFF image. | |
std::ostream & | operator<< (std::ostream &os, const Rational &r) |
Output operator for our fake rational. | |
std::istream & | operator>> (std::istream &is, Rational &r) |
Input operator for our fake rational. | |
std::ostream & | operator<< (std::ostream &os, const URational &r) |
Output operator for our fake unsigned rational. | |
std::istream & | operator>> (std::istream &is, URational &r) |
Input operator for our fake unsigned rational. | |
uint16_t | getUShort (const byte *buf, ByteOrder byteOrder) |
Read a 2 byte unsigned short value from the data buffer. | |
uint32_t | getULong (const byte *buf, ByteOrder byteOrder) |
Read a 4 byte unsigned long value from the data buffer. | |
URational | getURational (const byte *buf, ByteOrder byteOrder) |
Read an 8 byte unsigned rational value from the data buffer. | |
int16_t | getShort (const byte *buf, ByteOrder byteOrder) |
Read a 2 byte signed short value from the data buffer. | |
int32_t | getLong (const byte *buf, ByteOrder byteOrder) |
Read a 4 byte signed long value from the data buffer. | |
Rational | getRational (const byte *buf, ByteOrder byteOrder) |
Read an 8 byte signed rational value from the data buffer. | |
float | getFloat (const byte *buf, ByteOrder byteOrder) |
Read a 4 byte single precision floating point value (IEEE 754 binary32) from the data buffer. | |
double | getDouble (const byte *buf, ByteOrder byteOrder) |
Read an 8 byte double precision floating point value (IEEE 754 binary64) from the data buffer. | |
long | us2Data (byte *buf, uint16_t s, ByteOrder byteOrder) |
Convert an unsigned short to data, write the data to the buffer, return number of bytes written. | |
long | ul2Data (byte *buf, uint32_t l, ByteOrder byteOrder) |
Convert an unsigned long to data, write the data to the buffer, return number of bytes written. | |
long | ur2Data (byte *buf, URational l, ByteOrder byteOrder) |
Convert an unsigned rational to data, write the data to the buffer, return number of bytes written. | |
long | s2Data (byte *buf, int16_t s, ByteOrder byteOrder) |
Convert a signed short to data, write the data to the buffer, return number of bytes written. | |
long | l2Data (byte *buf, int32_t l, ByteOrder byteOrder) |
Convert a signed long to data, write the data to the buffer, return number of bytes written. | |
long | r2Data (byte *buf, Rational l, ByteOrder byteOrder) |
Convert a signed rational to data, write the data to the buffer, return number of bytes written. | |
long | f2Data (byte *buf, float f, ByteOrder byteOrder) |
Convert a single precision floating point (IEEE 754 binary32) float to data, write the data to the buffer, return number of bytes written. | |
long | d2Data (byte *buf, double d, ByteOrder byteOrder) |
Convert a double precision floating point (IEEE 754 binary64) double to data, write the data to the buffer, return number of bytes written. | |
void | hexdump (std::ostream &os, const byte *buf, long len, long offset=0) |
Print len bytes from buf in hex and ASCII format to the given stream, prefixed with the position in the buffer adjusted by offset. | |
bool | isHex (const std::string &str, size_t size=0, const std::string &prefix="") |
Return true if str is a hex number starting with prefix followed by size hex digits, false otherwise. If size is 0, any number of digits is allowed and all are checked. | |
int | exifTime (const char *buf, struct tm *tm) |
Converts a string in the form "%Y:%m:%d %H:%M:%S", e.g., "2007:05:24 12:31:55" to broken down time format, returns 0 if successful, else 1. | |
const char * | exvGettext (const char *str) |
Translate a string using the gettext framework. This wrapper hides all the implementation details from the interface. | |
template<> | |
bool | stringTo< bool > (const std::string &s, bool &ok) |
Specialization of stringTo(const std::string& s, bool& ok) for bool. More... | |
long | parseLong (const std::string &s, bool &ok) |
Return a long set to the value represented by s. More... | |
float | parseFloat (const std::string &s, bool &ok) |
Return a float set to the value represented by s. More... | |
Rational | parseRational (const std::string &s, bool &ok) |
Return a Rational set to the value represented by s. More... | |
Rational | floatToRationalCast (float f) |
Very simple conversion of a float to a Rational. More... | |
template<typename T , typename K , int N> | |
const T * | find (T(&src)[N], const K &key) |
Find an element that matches key in the array src. More... | |
template<typename T , int N> | |
char(& | sizer (T(&)[N]))[N] |
Template used in the COUNTOF macro to determine the size of an array. | |
template<typename T > | |
std::string | toString (const T &arg) |
Utility function to convert the argument of any type to a string. | |
template<typename T > | |
T | stringTo (const std::string &s, bool &ok) |
Utility function to convert a string to a value of type T . More... | |
template<typename IntType > | |
IntType | gcd (IntType n, IntType m) |
Return the greatest common denominator of n and m. (Implementation from Boost rational.hpp) More... | |
std::ostream & | operator<< (std::ostream &os, const Value &value) |
Output operator for Value types. | |
template<typename T > | |
TypeId | getType () |
Template to determine the TypeId for a type T. | |
template<> | |
TypeId | getType< uint16_t > () |
Specialization for an unsigned short. | |
template<> | |
TypeId | getType< uint32_t > () |
Specialization for an unsigned long. | |
template<> | |
TypeId | getType< URational > () |
Specialization for an unsigned rational. | |
template<> | |
TypeId | getType< int16_t > () |
Specialization for a signed short. | |
template<> | |
TypeId | getType< int32_t > () |
Specialization for a signed long. | |
template<> | |
TypeId | getType< Rational > () |
Specialization for a signed rational. | |
template<> | |
TypeId | getType< float > () |
Specialization for a float. | |
template<> | |
TypeId | getType< double > () |
Specialization for a double. | |
template<typename T > | |
T | getValue (const byte *buf, ByteOrder byteOrder) |
Read a value of type T from the data buffer. More... | |
template<> | |
uint16_t | getValue (const byte *buf, ByteOrder byteOrder) |
Read a value of type T from the data buffer. More... | |
template<> | |
uint32_t | getValue (const byte *buf, ByteOrder byteOrder) |
Read a value of type T from the data buffer. More... | |
template<> | |
URational | getValue (const byte *buf, ByteOrder byteOrder) |
Read a value of type T from the data buffer. More... | |
template<> | |
int16_t | getValue (const byte *buf, ByteOrder byteOrder) |
Read a value of type T from the data buffer. More... | |
template<> | |
int32_t | getValue (const byte *buf, ByteOrder byteOrder) |
Read a value of type T from the data buffer. More... | |
template<> | |
Rational | getValue (const byte *buf, ByteOrder byteOrder) |
Read a value of type T from the data buffer. More... | |
template<> | |
float | getValue (const byte *buf, ByteOrder byteOrder) |
Read a value of type T from the data buffer. More... | |
template<> | |
double | getValue (const byte *buf, ByteOrder byteOrder) |
Read a value of type T from the data buffer. More... | |
template<typename T > | |
long | toData (byte *buf, T t, ByteOrder byteOrder) |
Convert a value of type T to data, write the data to the data buffer. More... | |
template<> | |
long | toData (byte *buf, uint16_t t, ByteOrder byteOrder) |
Specialization to write an unsigned short to the data buffer. Return the number of bytes written. | |
template<> | |
long | toData (byte *buf, uint32_t t, ByteOrder byteOrder) |
Specialization to write an unsigned long to the data buffer. Return the number of bytes written. | |
template<> | |
long | toData (byte *buf, URational t, ByteOrder byteOrder) |
Specialization to write an unsigned rational to the data buffer. Return the number of bytes written. | |
template<> | |
long | toData (byte *buf, int16_t t, ByteOrder byteOrder) |
Specialization to write a signed short to the data buffer. Return the number of bytes written. | |
template<> | |
long | toData (byte *buf, int32_t t, ByteOrder byteOrder) |
Specialization to write a signed long to the data buffer. Return the number of bytes written. | |
template<> | |
long | toData (byte *buf, Rational t, ByteOrder byteOrder) |
Specialization to write a signed rational to the data buffer. Return the number of bytes written. | |
template<> | |
long | toData (byte *buf, float t, ByteOrder byteOrder) |
Specialization to write a float to the data buffer. Return the number of bytes written. | |
template<> | |
long | toData (byte *buf, double t, ByteOrder byteOrder) |
Specialization to write a double to the data buffer. Return the number of bytes written. | |
int | versionNumber () |
Return the version of Exiv2 available at runtime as an integer. | |
std::string | versionString () |
Return the version string Example: "0.24.0" (major.minor.patch) | |
std::string | versionNumberHexString () |
Return the version of Exiv2 as hex string of fixed length 6. | |
const char * | version () |
Return the version of Exiv2 available at runtime as a string. | |
bool | testVersion (int major, int minor, int patch) |
Test the version of the available Exiv2 library at runtime. Return true if it is the same as or newer than the passed-in version. More... | |
Image::AutoPtr | newXmpInstance (BasicIo::AutoPtr io, bool create) |
Create a new XmpSidecar instance and return an auto-pointer to it. Caller owns the returned object and the auto-pointer ensures that it will be deleted. | |
bool | isXmpType (BasicIo &iIo, bool advance) |
Check if the file iIo is an XMP sidecar file. | |
Variables | |
const GroupInfo | groupInfo [] |
List of all known Exif groups. Important: Group name (3rd column) must be unique! | |
const SectionInfo | sectionInfo [] |
List of all defined Exif sections. More... | |
MimeTypeList | mimeTypeList [] |
List of TIFF compression to MIME type mappings. More... | |
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of the objects of this namespace.
enum Exiv2::TypeId |
Exiv2 value type identifiers.
Used primarily as identifiers when creating Exiv2 Value instances. See Value::create. 0x0000 to 0xffff are reserved for TIFF (Exif) types.
bool Exiv2::cmpIptcdataByRecord | ( | const Iptcdatum & | lhs, |
const Iptcdatum & | rhs | ||
) |
Compare two iptc items by record. Return true if the record of lhs is less than that of rhs.
This is a helper function for IptcParser::encode().
References Exiv2::Iptcdatum::record().
Referenced by Exiv2::IptcParser::encode().
EXIV2API bool Exiv2::convertStringCharset | ( | std::string & | str, |
const char * | from, | ||
const char * | to | ||
) |
Convert character encoding of str from from to to. If the function succeeds, str contains the result string.
This function uses the iconv library, if the Exiv2 library was compiled with iconv support. Otherwise, on Windows, it uses Windows functions to support a limited number of conversions and fails with a warning if an unsupported conversion is attempted. If the function is called but Exiv2 was not compiled with iconv support and can't use Windows functions, it fails with a warning.
The conversions supported on Windows without iconv are:
from | to |
UTF-8 | UCS-2BE |
UTF-8 | UCS-2LE |
UCS-2BE | UTF-8 |
UCS-2BE | UCS-2LE |
UCS-2LE | UTF-8 |
UCS-2LE | UCS-2BE |
ISO-8859-1 | UTF-8 |
ASCII | UTF-8 |
str | The string to convert. It is updated to the converted string, which may have a different size. If the function call fails, the string is not modified. |
from | Charset in which the input string is encoded as a name understood by iconv_open(3) . |
to | Charset to convert the string to as a name understood by iconv_open(3) . |
true
if the conversion was successful, else false
. References EXV_WARNING.
Referenced by Exiv2::Converter::cnvIptcValue(), Exiv2::CommentValue::comment(), Exiv2::AsfVideo::contentDescription(), Exiv2::CommentValue::copy(), Exiv2::Internal::printUcs2(), and Exiv2::CommentValue::read().
EXIV2API bool Exiv2::fileExists | ( | const std::string & | path, |
bool | ct = false |
||
) |
Test if a file exists.
path | Name of file to verify. |
ct | Flag to check if path is a regular file. |
Referenced by Action::Insert::insertThumbnail(), Action::Insert::insertXmpPacket(), Action::Print::printComment(), Action::Print::printList(), Action::Print::printPreviewList(), Action::Print::printSummary(), Action::Rename::run(), Action::Adjust::run(), Action::Erase::run(), Action::Insert::run(), Action::Modify::run(), Action::FixIso::run(), Action::FixCom::run(), Exiv2::FileIo::transfer(), Action::Extract::writePreviews(), and Action::Extract::writeThumbnail().
const T* Exiv2::find | ( | T(&) | src[N], |
const K & | key | ||
) |
Find an element that matches key in the array src.
Designed to be used with lookup tables as shown in the example below. Requires a Key structure (ideally in the array) and a comparison operator to compare a key with an array element. The size of the array is determined automagically. Thanks to Stephan Broennimann for this nifty implementation.
Referenced by Exiv2::ImageFactory::checkMode(), Exiv2::ImageFactory::checkType(), Exiv2::AsfVideo::contentDescription(), Exiv2::MatroskaVideo::contentManagement(), Exiv2::Internal::TiffMnCreator::create(), Exiv2::Internal::TiffCreator::create(), Exiv2::ImageFactory::create(), Exiv2::AsfVideo::decodeBlock(), Exiv2::MatroskaVideo::decodeBlock(), errMsg(), Exiv2::AsfVideo::fileProperties(), Exiv2::Internal::TiffMapping::findDecoder(), Exiv2::Internal::TiffMapping::findEncoder(), Exiv2::Internal::TiffCreator::getPath(), Exiv2::Internal::groupId(), Exiv2::Internal::groupName(), Exiv2::Internal::ifdName(), Exiv2::RiffVideo::infoTagsHandler(), Exiv2::Internal::TiffHeader::isImageTag(), Exiv2::Internal::isMakerIfd(), Exiv2::Internal::isTiffImageTag(), Exiv2::TiffImage::mimeType(), Exiv2::Internal::nikonCrypt(), Exiv2::Internal::nikonSelector(), Exiv2::RiffVideo::nikonTagsHandler(), Exiv2::Internal::Nikon3MakerNote::print0x009e(), Exiv2::Internal::printCombiTag(), Exiv2::Internal::printCsLensByFocalLengthAndMaxAperture(), Exiv2::Internal::CanonMakerNote::printCsLensType(), Exiv2::Internal::printTag(), Exiv2::Internal::printTagVocabulary(), Exiv2::RiffVideo::streamFormatHandler(), Exiv2::AsfVideo::streamProperties(), Exiv2::ExifTags::tagList(), Exiv2::Internal::tagList(), Exiv2::TypeInfo::typeId(), Exiv2::TypeInfo::typeName(), Exiv2::TypeInfo::typeSize(), and Exiv2::Internal::TiffReader::visitBinaryArray().
EXIV2API Rational Exiv2::floatToRationalCast | ( | float | f | ) |
Very simple conversion of a float to a Rational.
Test it with the values that you expect and check the implementation to see if this is really what you want!
References gcd().
Referenced by Exiv2::Converter::cnvXmpGPSCoord(), parseRational(), and Exiv2::ValueType< T >::toRational().
IntType Exiv2::gcd | ( | IntType | n, |
IntType | m | ||
) |
Return the greatest common denominator of n and m. (Implementation from Boost rational.hpp)
Referenced by floatToRationalCast(), and Exiv2::Internal::print0x9204().
|
inline |
Read a value of type T from the data buffer.
We need this template function for the ValueType template classes. There are only specializations of this function available; no default implementation is provided.
buf | Pointer to the data buffer to read from. |
byteOrder | Applicable byte order (little or big endian). |
References getDouble(), getFloat(), getLong(), getRational(), getShort(), getULong(), getURational(), and getUShort().
|
inline |
Read a value of type T from the data buffer.
We need this template function for the ValueType template classes. There are only specializations of this function available; no default implementation is provided.
buf | Pointer to the data buffer to read from. |
byteOrder | Applicable byte order (little or big endian). |
References getUShort().
|
inline |
Read a value of type T from the data buffer.
We need this template function for the ValueType template classes. There are only specializations of this function available; no default implementation is provided.
buf | Pointer to the data buffer to read from. |
byteOrder | Applicable byte order (little or big endian). |
References getULong().
|
inline |
Read a value of type T from the data buffer.
We need this template function for the ValueType template classes. There are only specializations of this function available; no default implementation is provided.
buf | Pointer to the data buffer to read from. |
byteOrder | Applicable byte order (little or big endian). |
References getURational().
|
inline |
Read a value of type T from the data buffer.
We need this template function for the ValueType template classes. There are only specializations of this function available; no default implementation is provided.
buf | Pointer to the data buffer to read from. |
byteOrder | Applicable byte order (little or big endian). |
References getShort().
|
inline |
Read a value of type T from the data buffer.
We need this template function for the ValueType template classes. There are only specializations of this function available; no default implementation is provided.
buf | Pointer to the data buffer to read from. |
byteOrder | Applicable byte order (little or big endian). |
References getLong().
|
inline |
Read a value of type T from the data buffer.
We need this template function for the ValueType template classes. There are only specializations of this function available; no default implementation is provided.
buf | Pointer to the data buffer to read from. |
byteOrder | Applicable byte order (little or big endian). |
References getRational().
|
inline |
Read a value of type T from the data buffer.
We need this template function for the ValueType template classes. There are only specializations of this function available; no default implementation is provided.
buf | Pointer to the data buffer to read from. |
byteOrder | Applicable byte order (little or big endian). |
References getFloat().
|
inline |
Read a value of type T from the data buffer.
We need this template function for the ValueType template classes. There are only specializations of this function available; no default implementation is provided.
buf | Pointer to the data buffer to read from. |
byteOrder | Applicable byte order (little or big endian). |
References getDouble().
EXIV2API float Exiv2::parseFloat | ( | const std::string & | s, |
bool & | ok | ||
) |
Return a float set to the value represented by s.
Besides strings that represent float values, the function also handles long, Rational and boolean (see also: stringTo(const std::string& s, bool& ok)).
s | String to parse |
ok | Output variable indicating the success of the operation. |
true
if the conversion was successful or false
if not. References stringTo< bool >().
Referenced by Exiv2::XmpTextValue::toFloat(), and Exiv2::XmpArrayValue::toFloat().
EXIV2API long Exiv2::parseLong | ( | const std::string & | s, |
bool & | ok | ||
) |
Return a long set to the value represented by s.
Besides strings that represent long values, the function also handles float, Rational and boolean (see also: stringTo(const std::string& s, bool& ok)).
s | String to parse |
ok | Output variable indicating the success of the operation. |
true
if the conversion was successful or false
if not. References stringTo< bool >().
Referenced by isoSpeed(), Exiv2::XmpTextValue::toLong(), and Exiv2::XmpArrayValue::toLong().
EXIV2API Rational Exiv2::parseRational | ( | const std::string & | s, |
bool & | ok | ||
) |
Return a Rational set to the value represented by s.
Besides strings that represent Rational values, the function also handles long, float and boolean (see also: stringTo(const std::string& s, bool& ok)). Uses floatToRationalCast(float f) if the string can be parsed into a float.
s | String to parse |
ok | Output variable indicating the success of the operation. |
true
if the conversion was successful or false
if not. References floatToRationalCast(), and stringTo< bool >().
Referenced by Exiv2::XmpTextValue::toRational(), and Exiv2::XmpArrayValue::toRational().
EXIV2API DataBuf Exiv2::readFile | ( | const std::string & | path | ) |
Read file path into a DataBuf, which is returned.
Error | In case of failure. |
References Exiv2::FileIo::open(), Exiv2::DataBuf::pData_, Exiv2::FileIo::read(), Exiv2::DataBuf::size_, and strError().
Referenced by Action::Insert::insertXmpPacket(), and Exiv2::ExifThumb::setJpegThumbnail().
Exiv2::Exifdatum& Exiv2::setValue | ( | Exiv2::Exifdatum & | exifDatum, |
const T & | value | ||
) |
Set the value of exifDatum to value. If the object already has a value, it is replaced. Otherwise a new ValueType<T> value is created and set to value.
This is a helper function, called from Exifdatum members. It is meant to be used with T = (u)int16_t, (u)int32_t or (U)Rational. Do not use directly.
Referenced by Exiv2::Exifdatum::operator=().
T Exiv2::stringTo | ( | const std::string & | s, |
bool & | ok | ||
) |
Utility function to convert a string to a value of type T
.
The string representation of the value must match that recognized by the input operator for T
for this function to succeed.
s | String to convert |
ok | Output variable indicating the success of the operation. |
true
if the conversion was successful or false
if not. References string.
bool Exiv2::stringTo< bool > | ( | const std::string & | s, |
bool & | ok | ||
) |
Specialization of stringTo(const std::string& s, bool& ok) for bool.
Handles the same string values as the XMP SDK. Converts the string to lowercase and returns true
if it is "true", "t" or "1", and false
if it is "false", "f" or "0".
References string.
Referenced by parseFloat(), parseLong(), and parseRational().
EXIV2API bool Exiv2::testVersion | ( | int | major, |
int | minor, | ||
int | patch | ||
) |
Test the version of the available Exiv2 library at runtime. Return true if it is the same as or newer than the passed-in version.
Versions are denoted using a triplet of integers: major.minor.patch .
References EXIV2_MAKE_VERSION, and versionNumber().
long Exiv2::toData | ( | byte * | buf, |
T | t, | ||
ByteOrder | byteOrder | ||
) |
Convert a value of type T to data, write the data to the data buffer.
We need this template function for the ValueType template classes. There are only specializations of this function available; no default implementation is provided.
buf | Pointer to the data buffer to write to. |
t | Value to be converted. |
byteOrder | Applicable byte order (little or big endian). |
Referenced by Exiv2::ValueType< T >::copy().
EXIV2API long Exiv2::writeFile | ( | const DataBuf & | buf, |
const std::string & | path | ||
) |
Write DataBuf buf to file path.
Error | In case of failure. |
References Exiv2::FileIo::open(), Exiv2::DataBuf::pData_, Exiv2::DataBuf::size_, strError(), and Exiv2::FileIo::write().
Referenced by Exiv2::PreviewImage::writeFile(), and Exiv2::ExifThumbC::writeFile().
MimeTypeList Exiv2::mimeTypeList[] |
List of TIFF compression to MIME type mappings.
Referenced by Exiv2::TiffImage::mimeType().
const SectionInfo Exiv2::sectionInfo[] |
List of all defined Exif sections.
Referenced by Exiv2::ExifTags::sectionName().