exif.hpp

Go to the documentation of this file.

// ***************************************************************** -*- C++ -*-
/*
 * Copyright (C) 2004-2021 Exiv2 authors
 * 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.
 */
#ifndef EXIF_HPP_
#define EXIF_HPP_
 
// *****************************************************************************
#include "exiv2lib_export.h"
 
// included header files
#include "metadatum.hpp"
#include "tags.hpp"
 
// + standard includes
#include <list>
 
// *****************************************************************************
// namespace extensions
namespace Exiv2 {
 
// *****************************************************************************
// class declarations
    class ExifData;
 
// *****************************************************************************
// class definitions

    class EXIV2API Exifdatum : public Metadatum {
        template<typename T> friend Exifdatum& setValue(Exifdatum&, const T&);
    public:


        explicit Exifdatum(const ExifKey& key, const Value* pValue =0);
        Exifdatum(const Exifdatum& rhs);
        virtual ~Exifdatum();



        Exifdatum& operator=(const Exifdatum& rhs);
        Exifdatum& operator=(const uint16_t& value);
        Exifdatum& operator=(const uint32_t& value);
        Exifdatum& operator=(const URational& value);
        Exifdatum& operator=(const int16_t& value);
        Exifdatum& operator=(const int32_t& value);
        Exifdatum& operator=(const Rational& value);
        Exifdatum& operator=(const std::string& value);
        Exifdatum& operator=(const Value& value);
        void setValue(const Value* pValue);
        int setValue(const std::string& value);
        int setDataArea(const byte* buf, long len);



        std::string key() const;
        const char* familyName() const;
        std::string groupName() const;
        std::string tagName() const;
        std::string tagLabel() const;
        uint16_t tag() const;
        int ifdId() const;
        const char* ifdName() const;
        int idx() const;
        long copy(byte* buf, ByteOrder byteOrder) const;
        std::ostream& write(std::ostream& os, const ExifData* pMetadata =0) const;
        TypeId typeId() const;
        const char* typeName() const;
        long typeSize() const;
        long count() const;
        long size() const;
        std::string toString() const;
        std::string toString(long n) const;
        long toLong(long n =0) const;
        float toFloat(long n =0) const;
        Rational toRational(long n =0) const;
        Value::AutoPtr getValue() const;
        const Value& value() const;
        long sizeDataArea() const;
        DataBuf dataArea() const;
 
    private:
        // DATA
        ExifKey::AutoPtr key_;                  
        Value::AutoPtr   value_;                
 
    }; // class Exifdatum

    class EXIV2API ExifThumbC {
    public:


        explicit ExifThumbC(const ExifData& exifData);



        DataBuf copy() const;
        long writeFile(const std::string& path) const;
#ifdef EXV_UNICODE_PATH
        long writeFile(const std::wstring& wpath) const;
#endif
        const char* mimeType() const;
        const char* extension() const;
#ifdef EXV_UNICODE_PATH
        const wchar_t* wextension() const;
#endif
 
    private:
        // DATA
        const ExifData& exifData_; 
 
    }; // class ExifThumb

    class EXIV2API ExifThumb : public ExifThumbC {
    public:


        explicit ExifThumb(ExifData& exifData);



        void setJpegThumbnail(
            const std::string& path,
                  URational    xres,
                  URational    yres,
                  uint16_t     unit
        );
#ifdef EXV_UNICODE_PATH
        void setJpegThumbnail(
            const std::wstring& wpath,
                  URational     xres,
                  URational     yres,
                  uint16_t      unit
        );
#endif
        void setJpegThumbnail(
            const byte*     buf,
                  long      size,
                  URational xres,
                  URational yres,
                  uint16_t  unit
        );
        void setJpegThumbnail(const std::string& path);
#ifdef EXV_UNICODE_PATH
        void setJpegThumbnail(const std::wstring& wpath);
#endif
        void setJpegThumbnail(const byte* buf, long size);
        void erase();
 
    private:
        // DATA
        ExifData& exifData_;    
 
    }; // class ExifThumb

    typedef std::list<Exifdatum> ExifMetadata;

    class EXIV2API ExifData {
    public:
        typedef ExifMetadata::iterator iterator;
        typedef ExifMetadata::const_iterator const_iterator;



        Exifdatum& operator[](const std::string& key);
        void add(const ExifKey& key, const Value* pValue);
        void add(const Exifdatum& exifdatum);
        iterator erase(iterator pos);
        iterator erase(iterator beg, iterator end);
        void clear();
        void sortByKey();
        void sortByTag();
        iterator begin() { return exifMetadata_.begin(); }
        iterator end() { return exifMetadata_.end(); }
        iterator findKey(const ExifKey& key);



        const_iterator begin() const { return exifMetadata_.begin(); }
        const_iterator end() const { return exifMetadata_.end(); }
        const_iterator findKey(const ExifKey& key) const;
        bool empty() const { return count() == 0; }
        long count() const { return static_cast<long>(exifMetadata_.size()); }
 
    private:
        // DATA
        ExifMetadata exifMetadata_;
 
    }; // class ExifData

    class EXIV2API ExifParser {
    public:
        static ByteOrder decode(
                  ExifData& exifData,
            const byte*     pData,
                  uint32_t  size
        );
        static WriteMethod encode(
                  Blob&     blob,
            const byte*     pData,
                  uint32_t  size,
                  ByteOrder byteOrder,
            const ExifData& exifData
        );
        static void encode(
                  Blob&     blob,
                  ByteOrder byteOrder,
            const ExifData& exifData
        )
        {
            encode(blob, 0, 0, byteOrder, exifData);
        }
 
    }; // class ExifParser
 
}                                       // namespace Exiv2
 
#endif                                  // #ifndef EXIF_HPP_