Exiv2
tags.hpp
1 // ***************************************************************** -*- C++ -*-
2 /*
3  * Copyright (C) 2004-2021 Exiv2 authors
4  * This program is part of the Exiv2 distribution.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
19  */
20 #ifndef TAGS_HPP_
21 #define TAGS_HPP_
22 
23 // *****************************************************************************
24 #include "exiv2lib_export.h"
25 
26 // included header files
27 #include "metadatum.hpp"
28 
29 // + standard includes
30 #include <string>
31 #include <iosfwd>
32 #include <memory>
33 
34 // *****************************************************************************
35 // namespace extensions
36 namespace Exiv2 {
37 
38 // *****************************************************************************
39 // class declarations
40  class ExifData;
41  class ExifKey;
42  class Value;
43  struct TagInfo;
44 
45 // *****************************************************************************
46 // type definitions
47 
49  typedef std::ostream& (*PrintFct)(std::ostream&, const Value&, const ExifData* pExifData);
51  typedef const TagInfo* (*TagListFct)();
52 
53 // *****************************************************************************
54 // class definitions
55 
57  struct EXIV2API GroupInfo {
58  struct GroupName;
59  bool operator==(int ifdId) const;
60  bool operator==(const GroupName& groupName) const;
61  int ifdId_;
62  const char* ifdName_;
63  const char* groupName_;
65  };
66 
68  struct EXIV2API GroupInfo::GroupName {
69  explicit GroupName(const std::string& groupName);
70  std::string g_;
71  };
72 
74  struct EXIV2API TagInfo {
76  TagInfo(
77  uint16_t tag,
78  const char* name,
79  const char* title,
80  const char* desc,
81  int ifdId,
82  int sectionId,
83  TypeId typeId,
84  int16_t count,
85  PrintFct printFct
86  );
87  uint16_t tag_;
88  const char* name_;
89  const char* title_;
90  const char* desc_;
91  int ifdId_;
92  int sectionId_;
94  int16_t count_;
96  }; // struct TagInfo
97 
99  class EXIV2API ExifTags {
101  ExifTags();
103  ExifTags(const ExifTags& rhs);
105  ExifTags& operator=(const ExifTags& rhs);
106 
107  public:
109  static const GroupInfo* groupList();
111  static const TagInfo* tagList(const std::string& groupName);
113  static void taglist(std::ostream& os);
115  static void taglist(std::ostream& os, const std::string& groupName);
116 
118  static const char* sectionName(const ExifKey& key);
120  static uint16_t defaultCount(const ExifKey& key);
122  static const char* ifdName(const std::string& groupName);
123 
127  static bool isMakerGroup(const std::string& groupName);
133  static bool isExifGroup(const std::string& groupName);
134 
135  }; // class ExifTags
136 
140  class EXIV2API ExifKey : public Key {
141  public:
143  typedef std::auto_ptr<ExifKey> AutoPtr;
144 
146 
147 
155  explicit ExifKey(const std::string& key);
165  ExifKey(uint16_t tag, const std::string& groupName);
172  explicit ExifKey(const TagInfo& ti);
173 
175  ExifKey(const ExifKey& rhs);
177  virtual ~ExifKey();
179 
181 
182 
185  ExifKey& operator=(const ExifKey& rhs);
187  void setIdx(int idx);
189 
191 
192  virtual std::string key() const;
193  virtual const char* familyName() const;
194  virtual std::string groupName() const;
196  int ifdId() const;
197  virtual std::string tagName() const;
198  virtual uint16_t tag() const;
199  virtual std::string tagLabel() const;
201  std::string tagDesc() const; // Todo: should be in the base class
203  TypeId defaultTypeId() const; // Todo: should be in the base class
204 
205  AutoPtr clone() const;
207  int idx() const;
209 
210  private:
212  virtual ExifKey* clone_() const;
213 
214  private:
215  // Pimpl idiom
216  struct Impl;
217  std::auto_ptr<Impl> p_;
218 
219  }; // class ExifKey
220 
221 // *****************************************************************************
222 // free functions
223 
225  EXIV2API std::ostream& operator<<(std::ostream& os, const TagInfo& ti);
226 
227 } // namespace Exiv2
228 
229 #endif // #ifndef TAGS_HPP_
Exiv2::ExifTags::defaultCount
static uint16_t defaultCount(const ExifKey &key)
Return the default number of components (not bytes!) key has. (0=any, -1=count not known)
Definition: tags.cpp:147
Exiv2::Internal::SectionInfo::name_
const char * name_
Section name (one word)
Definition: tags_int.hpp:217
Exiv2::ExifKey::Impl::tagInfo_
const TagInfo * tagInfo_
Tag info.
Definition: tags.cpp:242
Exiv2::Key::operator=
Key & operator=(const Key &rhs)
Assignment operator. Protected so that it can only be used by subclasses but not directly.
Definition: metadatum.cpp:42
olympusmn_int.hpp
Olympus makernote tags. References: [1] Exif file format, Appendix 1: MakerNote of Olympus Digicams ...
nikonmn_int.hpp
Nikon makernote tags. References: [1] MakerNote EXIF Tag of the Nikon 990 by Max Lyons [2] Exif fil...
Exiv2::ExifKey::ExifKey
ExifKey(const std::string &key)
Constructor to create an Exif key from a key string.
Definition: tags.cpp:341
Exiv2::Internal::taglist
void taglist(std::ostream &os, IfdId ifdId)
Print the list of tags for ifdId to the output stream os.
Definition: tags_int.cpp:2483
Exiv2::GroupInfo::tagList_
TagListFct tagList_
Tag list.
Definition: tags.hpp:64
Exiv2::ExifKey::Impl::Impl
Impl()
Default constructor.
Definition: tags.cpp:252
Exiv2::ExifKey::tagLabel
virtual std::string tagLabel() const
Return a label for the tag.
Definition: tags.cpp:387
Exiv2::Value
Common interface for all types of values used with metadata.
Definition: value.hpp:51
Exiv2::GroupInfo::ifdId_
int ifdId_
IFD id.
Definition: tags.hpp:61
Exiv2::TagListFct
const typedef TagInfo *(* TagListFct)()
A function returning a tag list.
Definition: tags.hpp:51
Exiv2::ExifKey::Impl::decomposeKey
void decomposeKey(const std::string &key)
Parse and convert the key string into tag and IFD Id. Updates data members if the string can be decom...
Definition: tags.cpp:268
Exiv2::GroupInfo::ifdName_
const char * ifdName_
IFD name.
Definition: tags.hpp:62
Exiv2::Key::AutoPtr
std::auto_ptr< Key > AutoPtr
Shortcut for a Key auto pointer.
Definition: metadatum.hpp:47
Exiv2::Internal::IfdId
IfdId
Type to specify the IFD to which a metadata belongs.
Definition: tags_int.hpp:46
Exiv2::GroupInfo
The details of an Exif group. Groups include IFDs and binary arrays.
Definition: tags.hpp:57
Exiv2::ExifKey::tagName
virtual std::string tagName() const
Return the name of the tag (which is also the third part of the key)
Definition: tags.cpp:382
Exiv2::TagInfo::name_
const char * name_
One word tag label.
Definition: tags.hpp:88
Exiv2::Internal::tagList
const TagInfo * tagList(IfdId ifdId)
Return the tag list for ifdId.
Definition: tags_int.cpp:2493
Exiv2::ExifKey::Impl::tag_
uint16_t tag_
Tag value.
Definition: tags.cpp:243
Exiv2::asciiString
@ asciiString
Exif ASCII type, 8-bit byte.
Definition: types.hpp:121
Exiv2::GroupInfo::groupName_
const char * groupName_
Group name, unique for each group.
Definition: tags.hpp:63
Exiv2::Internal::iopTagList
const TagInfo * iopTagList()
Return read-only list of built-in IOP tags.
Definition: tags_int.cpp:2419
Exiv2::ExifKey::Impl::groupName_
std::string groupName_
The group name.
Definition: tags.cpp:246
Exiv2::TagInfo::ifdId_
int ifdId_
Link to the (preferred) IFD.
Definition: tags.hpp:91
Exiv2::ExifKey::operator=
ExifKey & operator=(const ExifKey &rhs)
Assignment operator.
Definition: tags.cpp:354
Exiv2::ExifTags::groupList
static const GroupInfo * groupList()
Return read-only list of built-in groups.
Definition: tags.cpp:172
Exiv2::ExifKey::Impl::makeKey
void makeKey(uint16_t tag, IfdId ifdId, const TagInfo *tagInfo)
Set the key corresponding to the tag, ifdId and tagInfo. The key is of the form 'Exif....
Definition: tags.cpp:304
Exiv2::Internal::groupName
const char * groupName(IfdId ifdId)
Return the group name for a group id.
Definition: tags_int.cpp:2540
canonmn_int.hpp
Canon makernote tags. References: [1] EXIF MakerNote of Canon by David Burren [2] Canon makernote t...
Exiv2::ExifKey::idx
int idx() const
Return the index (unique id of this key within the original Exif data, 0 if not set)
Definition: tags.cpp:425
Exiv2::PrintFct
std::ostream &(* PrintFct)(std::ostream &, const Value &, const ExifData *pExifData)
Type for a function pointer for functions interpreting the tag value.
Definition: tags.hpp:49
Exiv2::ExifKey::Impl::idx_
int idx_
Unique id of the Exif key in the image.
Definition: tags.cpp:245
Exiv2::Internal::TagVocabulary::operator==
bool operator==(const std::string &key) const
Comparison operator for use with the find template.
Definition: tags.cpp:90
Exiv2::Key
Abstract base class defining the Key of a metadatum. Keys are used to identify and group metadata.
Definition: metadatum.hpp:44
Exiv2::TagInfo::typeId_
TypeId typeId_
Type id.
Definition: tags.hpp:93
Exiv2::ExifTags::isMakerGroup
static bool isMakerGroup(const std::string &groupName)
Return true if groupName is a makernote group.
Definition: tags.cpp:160
Exiv2::ExifKey::tagDesc
std::string tagDesc() const
Return the tag description.
Definition: tags.cpp:393
Exiv2::ExifTags::isExifGroup
static bool isExifGroup(const std::string &groupName)
Return true if groupName is a TIFF or Exif IFD, else false. This is used to differentiate between sta...
Definition: tags.cpp:166
Exiv2::TagInfo::count_
int16_t count_
The number of values (not bytes!), 0=any, -1=count not known.
Definition: tags.hpp:94
Exiv2::ExifKey::groupName
virtual std::string groupName() const
Return the name of the group (the second part of the key)
Definition: tags.cpp:377
Exiv2::ExifKey::defaultTypeId
TypeId defaultTypeId() const
Return the default type id for this tag.
Definition: tags.cpp:399
Exiv2::Internal::printValue
std::ostream & printValue(std::ostream &os, const Value &value, const ExifData *)
Default print function, using the Value output operator.
Definition: tags_int.cpp:2547
Exiv2::GroupInfo::operator==
bool operator==(int ifdId) const
Comparison operator for IFD id.
Definition: tags.cpp:114
Exiv2::ExifKey
Concrete keys for Exif metadata and access to Exif tag reference data.
Definition: tags.hpp:140
Exiv2::Internal::ifdName
const char * ifdName(IfdId ifdId)
Return the name of the IFD.
Definition: tags_int.cpp:2533
Exiv2::ExifKey::AutoPtr
std::auto_ptr< ExifKey > AutoPtr
Shortcut for an ExifKey auto pointer.
Definition: tags.hpp:143
Exiv2::ExifTags::tagList
static const TagInfo * tagList(const std::string &groupName)
Return read-only list of built-in groupName tags.
Definition: tags.cpp:177
Exiv2::operator<<
EXIV2API std::ostream & operator<<(std::ostream &os, const DataSet &dataSet)
Output operator for dataSet.
Definition: datasets.cpp:709
Exiv2::Internal::isMakerIfd
bool isMakerIfd(IfdId ifdId)
Return true if ifdId is a makernote IFD id. (Note: returns false for makerIfd)
Definition: tags_int.cpp:2445
Exiv2::Internal::tagNumber
uint16_t tagNumber(const std::string &tagName, IfdId ifdId)
Return the tag number for one combination of IFD id and tagName. If the tagName is not known,...
Definition: tags_int.cpp:2608
Exiv2::ExifKey::familyName
virtual const char * familyName() const
Return an identifier for the type of metadata (the first part of the key)
Definition: tags.cpp:372
Exiv2
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
Exiv2::ExifKey::key
virtual std::string key() const
Return the key of the metadatum as a string. The key is of the form 'familyName.groupName....
Definition: tags.cpp:367
Exiv2::Internal::TagVocabulary::voc_
const char * voc_
Vocabulary string.
Definition: tags_int.hpp:247
convert.hpp
Exif and IPTC conversions to and from XMP.
Exiv2::TypeId
TypeId
Exiv2 value type identifiers.
Definition: types.hpp:119
Exiv2::TypeInfo::typeName
static const char * typeName(TypeId typeId)
Return the name of the type, 0 if unknown.
Definition: types.cpp:102
Exiv2::ExifTags::ifdName
static const char * ifdName(const std::string &groupName)
Return the name of the IFD for the group.
Definition: tags.cpp:154
Exiv2::TagInfo
Tag information.
Definition: tags.hpp:74
Exiv2::Internal::exifTagList
const TagInfo * exifTagList()
Return read-only list of built-in Exif IFD tags.
Definition: tags_int.cpp:2096
Exiv2::ExifKey::Impl::key_
std::string key_
Key
Definition: tags.cpp:247
Exiv2::Internal::operator==
bool operator==(const TagDetails &td, const LensTypeAndFocalLengthAndMaxAperture &ltfl)
Compare tag details with a lens entry.
Definition: canonmn_int.cpp:2820
Exiv2::ExifKey::Impl::tagName
std::string tagName() const
Return the name of the tag.
Definition: tags.cpp:257
Exiv2::Internal::gpsTagList
const TagInfo * gpsTagList()
Return read-only list of built-in GPS tags.
Definition: tags_int.cpp:2316
Exiv2::ExifKey::Impl::ifdId_
IfdId ifdId_
The IFD associated with this tag.
Definition: tags.cpp:244
Exiv2::Internal::ifdTagList
const TagInfo * ifdTagList()
Return read-only list of built-in IFD0/1 tags.
Definition: tags_int.cpp:1709
Exiv2::ExifKey::ifdId
int ifdId() const
Return the IFD id as an integer. (Do not use, this is meant for library internal use....
Definition: tags.cpp:420
Exiv2::ExifKey::~ExifKey
virtual ~ExifKey()
Destructor.
Definition: tags.cpp:352
Exiv2::TagInfo::TagInfo
TagInfo(uint16_t tag, const char *name, const char *title, const char *desc, int ifdId, int sectionId, TypeId typeId, int16_t count, PrintFct printFct)
Constructor.
Definition: tags.cpp:124
Exiv2::ExifTags::taglist
static void taglist(std::ostream &os)
Print a list of all standard Exif tags to output stream.
Definition: tags.cpp:182
Exiv2::TagInfo::printFct_
PrintFct printFct_
Pointer to tag print function.
Definition: tags.hpp:95
Exiv2::TagInfo::desc_
const char * desc_
Short tag description.
Definition: tags.hpp:90
Exiv2::ExifKey::setIdx
void setIdx(int idx)
Set the index.
Definition: tags.cpp:362
Exiv2::Internal::tagInfo
const TagInfo * tagInfo(uint16_t tag, IfdId ifdId)
Return the tag info for tag and ifdId.
Definition: tags_int.cpp:2500
Exiv2::ExifKey::tag
virtual uint16_t tag() const
Return the tag number.
Definition: tags.cpp:405
Exiv2::Error
BasicError< char > Error
Error class used for exceptions (std::string based)
Definition: error.hpp:324
Exiv2::sectionInfo
const SectionInfo sectionInfo[]
List of all defined Exif sections.
Exiv2::TagInfo::tag_
uint16_t tag_
Tag.
Definition: tags.hpp:87
Exiv2::ExifTags::sectionName
static const char * sectionName(const ExifKey &key)
Return the name of the section for an Exif key.
Definition: tags.cpp:140
Exiv2::TagInfo::sectionId_
int sectionId_
Section id.
Definition: tags.hpp:92
Exiv2::ExifKey::Impl
Internal Pimpl structure with private members and data of class ExifKey.
Definition: tags.cpp:210
Exiv2::GroupInfo::g_
std::string g_
Group name.
Definition: tags.hpp:70
casiomn_int.hpp
Casio MakerNote implemented using the following references: Casio MakerNote Information by GVsoft,...
Exiv2::TagInfo::title_
const char * title_
Tag title.
Definition: tags.hpp:89
Exiv2::ExifTags
Access to Exif group and tag lists and misc. tag reference methods, implemented as a static class.
Definition: tags.hpp:99
Exiv2::Internal::groupId
IfdId groupId(const std::string &groupName)
Return the group id for a group name.
Definition: tags_int.cpp:2525
Exiv2::ExifKey::Impl::familyName_
static const char * familyName_
"Exif"
Definition: tags.cpp:240
Exiv2::Internal::isExifIfd
bool isExifIfd(IfdId ifdId)
Return true if ifdId is an Exif IFD id.
Definition: tags_int.cpp:2455
error.hpp
Error class for exceptions, log message class.
Exiv2::ExifData
A container for Exif data. This is a top-level class of the Exiv2 library. The container holds Exifda...
Definition: exif.hpp:434