preview.hpp

Go to the documentation of this file.

// ***************************************************************** -*- C++ -*-
/*
 * Copyright (C) 2004-2018 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 PREVIEW_HPP_
#define PREVIEW_HPP_

// *****************************************************************************
#include "exiv2lib_export.h"

#include "image.hpp"

// *****************************************************************************
// namespace extensions
namespace Exiv2 {

// *****************************************************************************
// class definitions

    typedef int PreviewId;

    struct EXIV2API PreviewProperties {
        std::string mimeType_;
        std::string extension_;
#ifdef EXV_UNICODE_PATH
        std::wstring wextension_;
#endif
        uint32_t size_;
        uint32_t width_;
        uint32_t height_;
        PreviewId id_;
    };

    typedef std::vector<PreviewProperties> PreviewPropertiesList;

    class EXIV2API PreviewImage {
        friend class PreviewManager;
    public:

        PreviewImage(const PreviewImage& rhs);
        ~PreviewImage();


        PreviewImage& operator=(const PreviewImage& rhs);



        DataBuf copy() const;
        const byte* pData() const;
        uint32_t size() const;
        long writeFile(const std::string& path) const;
#ifdef EXV_UNICODE_PATH

        long writeFile(const std::wstring& wpath) const;
#endif

        std::string mimeType() const;
        std::string extension() const;
#ifdef EXV_UNICODE_PATH

        std::wstring wextension() const;
#endif

        uint32_t width() const;
        uint32_t height() const;
        PreviewId id() const;

    private:
        PreviewImage(const PreviewProperties& properties, DataBuf data);

        PreviewProperties properties_;          
        byte* pData_;                           
        uint32_t size_;                         

    }; // class PreviewImage

    class EXIV2API PreviewManager {
    public:

        explicit PreviewManager(const Image& image);



        PreviewPropertiesList getPreviewProperties() const;
        PreviewImage getPreviewImage(const PreviewProperties& properties) const;

    private:
    const Image& image_;

    }; // class PreviewManager
}                                       // namespace Exiv2

#endif                                  // #ifndef PREVIEW_HPP_