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.
88 lines
2.8 KiB
C++
88 lines
2.8 KiB
C++
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
#ifndef XMPSIDECAR_HPP_
|
|
#define XMPSIDECAR_HPP_
|
|
|
|
// *****************************************************************************
|
|
#include "exiv2lib_export.h"
|
|
|
|
// included header files
|
|
#include "image.hpp"
|
|
|
|
// *****************************************************************************
|
|
// namespace extensions
|
|
namespace Exiv2 {
|
|
// *****************************************************************************
|
|
// class definitions
|
|
|
|
/*!
|
|
@brief Class to access XMP sidecar files. They contain only XMP metadata.
|
|
*/
|
|
class EXIV2API XmpSidecar : public Image {
|
|
public:
|
|
//! @name Creators
|
|
//@{
|
|
/*!
|
|
@brief Constructor for an XMP sidecar file. Since the constructor
|
|
can not return a result, callers should check the good() method
|
|
after object construction to determine success or failure.
|
|
@param io An auto-pointer that owns a BasicIo instance used for
|
|
reading and writing image metadata. \b Important: The constructor
|
|
takes ownership of the passed in BasicIo instance through the
|
|
auto-pointer. Callers should not continue to use the BasicIo
|
|
instance after it is passed to this method. Use the Image::io()
|
|
method to get a temporary reference.
|
|
@param create Specifies if an existing image should be read (false)
|
|
or if a new image should be created (true).
|
|
*/
|
|
XmpSidecar(BasicIo::UniquePtr io, bool create);
|
|
//@}
|
|
|
|
//! @name Manipulators
|
|
//@{
|
|
void readMetadata() override;
|
|
void writeMetadata() override;
|
|
/*!
|
|
@brief Not supported. XMP sidecar files do not contain a comment.
|
|
Calling this function will throw an instance of Error(ErrorCode::kerInvalidSettingForImage).
|
|
*/
|
|
void setComment(std::string_view comment) override;
|
|
//@}
|
|
|
|
//! @name Accessors
|
|
//@{
|
|
[[nodiscard]] std::string mimeType() const override;
|
|
//@}
|
|
|
|
//! @name NOT Implemented
|
|
//@{
|
|
~XmpSidecar() override = default;
|
|
//! Copy constructor
|
|
XmpSidecar(const XmpSidecar&) = delete;
|
|
//! Assignment operator
|
|
XmpSidecar& operator=(const XmpSidecar&) = delete;
|
|
//@}
|
|
|
|
Exiv2::Dictionary dates_;
|
|
|
|
}; // class XmpSidecar
|
|
|
|
// *****************************************************************************
|
|
// template, inline and free functions
|
|
|
|
// These could be static private functions on Image subclasses but then
|
|
// ImageFactory needs to be made a friend.
|
|
/*!
|
|
@brief 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.
|
|
*/
|
|
EXIV2API Image::UniquePtr newXmpInstance(BasicIo::UniquePtr io, bool create);
|
|
|
|
//! Check if the file iIo is an XMP sidecar file.
|
|
EXIV2API bool isXmpType(BasicIo& iIo, bool advance);
|
|
|
|
} // namespace Exiv2
|
|
|
|
#endif // #ifndef XMPSIDECAR_HPP_
|