opencv/modules/imgcodecs/src/grfmt_base.cpp

/*M///////////////////////////////////////////////////////////////////////////////////////
//
//  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
//
//  By downloading, copying, installing or using the software you agree to this license.
//  If you do not agree to this license, do not download, install,
//  copy or use the software.
//
//
//                        Intel License Agreement
//                For Open Source Computer Vision Library
//
// Copyright (C) 2000, Intel Corporation, all rights reserved.
// Third party copyrights are property of their respective owners.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
//   * Redistribution's of source code must retain the above copyright notice,
//     this list of conditions and the following disclaimer.
//
//   * Redistribution's in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//
//   * The name of Intel Corporation may not be used to endorse or promote products
//     derived from this software without specific prior written permission.
//
// This software is provided by the copyright holders and contributors "as is" and
// any express or implied warranties, including, but not limited to, the implied
// warranties of merchantability and fitness for a particular purpose are disclaimed.
// In no event shall the Intel Corporation or contributors be liable for any direct,
// indirect, incidental, special, exemplary, or consequential damages
// (including, but not limited to, procurement of substitute goods or services;
// loss of use, data, or profits; or business interruption) however caused
// and on any theory of liability, whether in contract, strict liability,
// or tort (including negligence or otherwise) arising in any way out of
// the use of this software, even if advised of the possibility of such damage.
//
//M*/

#include "precomp.hpp"

#include "grfmt_base.hpp"
#include "bitstrm.hpp"
#include <opencv2/core/utils/logger.hpp>

namespace cv
{

BaseImageDecoder::BaseImageDecoder()
{
    m_width = m_height = 0;
    m_type = -1;
    m_buf_supported = false;
    m_scale_denom = 1;
    m_use_rgb = false;
    m_frame_count = 1;
    m_read_options = 0;
    m_metadata.resize(IMAGE_METADATA_MAX + 1);
}

bool BaseImageDecoder::haveMetadata(ImageMetadataType type) const
{
    if (type == IMAGE_METADATA_EXIF)
        return !m_exif.getData().empty();
    return false;
}

Mat BaseImageDecoder::getMetadata(ImageMetadataType type) const
{
    auto makeMat = [](const std::vector<unsigned char>& data) -> Mat {
        return data.empty() ? Mat() : Mat(1, (int)data.size(), CV_8U, (void*)data.data());
        };

    switch (type) {
    case IMAGE_METADATA_EXIF:
        return makeMat(m_exif.getData());

    case IMAGE_METADATA_XMP:
    case IMAGE_METADATA_ICCP:
    case IMAGE_METADATA_CICP:
        return makeMat(m_metadata[type]);

    default:
        CV_LOG_WARNING(NULL, "Unknown metadata type requested: " << static_cast<int>(type));
        break;
    }
    return Mat();
}

ExifEntry_t BaseImageDecoder::getExifTag(const ExifTagName tag) const
{
    return m_exif.getTag(tag);
}

bool BaseImageDecoder::setSource( const String& filename )
{
    m_filename = filename;
    m_buf.release();
    return true;
}

bool BaseImageDecoder::setSource( const Mat& buf )
{
    if( !m_buf_supported )
        return false;
    m_filename = String();
    m_buf = buf;
    return true;
}

size_t BaseImageDecoder::signatureLength() const
{
    return m_signature.size();
}

bool BaseImageDecoder::checkSignature( const String& signature ) const
{
    size_t len = signatureLength();
    return signature.size() >= len && memcmp( signature.c_str(), m_signature.c_str(), len ) == 0;
}

int BaseImageDecoder::setScale( const int& scale_denom )
{
    int temp = m_scale_denom;
    m_scale_denom = scale_denom;
    return temp;
}

int BaseImageDecoder::setReadOptions(int read_options)
{
    int temp = m_read_options;
    m_read_options = read_options;
    return temp;
}

void BaseImageDecoder::setRGB(bool useRGB)
{
    m_use_rgb = useRGB;
}

ImageDecoder BaseImageDecoder::newDecoder() const
{
    return ImageDecoder();
}

BaseImageEncoder::BaseImageEncoder()
{
    m_buf = 0;
    m_buf_supported = false;
}

bool  BaseImageEncoder::isFormatSupported( int depth ) const
{
    return depth == CV_8U;
}

bool BaseImageEncoder::isValidEncodeKey(const int key) const
{
    auto first = m_supported_encode_key.begin();
    auto last = m_supported_encode_key.end();

    return (std::find(first, last, key) != last);
}

String BaseImageEncoder::getDescription() const
{
    return m_description;
}

bool BaseImageEncoder::setDestination( const String& filename )
{
    m_filename = filename;
    m_buf = 0;
    return true;
}

bool BaseImageEncoder::setDestination( std::vector<uchar>& buf )
{
    if( !m_buf_supported )
        return false;
    m_buf = &buf;
    m_buf->clear();
    m_filename = String();
    return true;
}

bool BaseImageEncoder::addMetadata(ImageMetadataType type, const Mat& metadata)
{
    CV_Assert_N(type >= IMAGE_METADATA_EXIF, type <= IMAGE_METADATA_MAX);
    if (metadata.empty())
        return true;
    size_t itype = (size_t)type;
    if (itype >= m_support_metadata.size() || !m_support_metadata[itype])
        return false;
    if (m_metadata.empty())
        m_metadata.resize((size_t)IMAGE_METADATA_MAX+1);
    CV_Assert(metadata.elemSize() == 1);
    CV_Assert(metadata.isContinuous());
    const unsigned char* data = metadata.ptr<unsigned char>();
    m_metadata[itype].assign(data, data + metadata.total());
    return true;
}

bool BaseImageEncoder::write(const Mat &img, const std::vector<int> &params) {
    std::vector<Mat> img_vec(1, img);
    return writemulti(img_vec, params);
}

bool BaseImageEncoder::writemulti(const std::vector<Mat>& img_vec, const std::vector<int>& params)
{
    if(img_vec.size() > 1)
        CV_LOG_INFO(NULL, "Multi page image will be written as animation with 1 second frame duration.");

    Animation animation;
    animation.frames = img_vec;

    for (size_t i = 0; i < animation.frames.size(); i++)
    {
        animation.durations.push_back(1000);
    }
    return writeanimation(animation, params);
}

bool BaseImageEncoder::writeanimation(const Animation&, const std::vector<int>& )
{
    CV_LOG_WARNING(NULL, "No Animation encoder for specified file extension");
    return false;
}

ImageEncoder BaseImageEncoder::newEncoder() const
{
    return ImageEncoder();
}

void BaseImageEncoder::throwOnError() const
{
    if(!m_last_error.empty())
    {
        String msg = "Raw image encoder error: " + m_last_error;
        CV_Error( Error::BadImageSize, msg.c_str() );
    }
}

}

/* End of file. */