Magic_Game/src/kiwano/render/GifImage.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#pragma once
#include <kiwano/core/Time.h>
#include <kiwano/render/Texture.h>

namespace kiwano
{
class Renderer;

KGE_DECLARE_SMART_PTR(GifImage);

/**
 * \addtogroup Render
 * @{
 */

/**
 * \~chinese
 * @brief GIFͼ<EFBFBD><EFBFBD>
 */
class KGE_API GifImage : public virtual ObjectBase
{
    friend class Renderer;

public:
    GifImage();

    /// \~chinese
    /// @brief <20><><EFBFBD>ر<EFBFBD><D8B1><EFBFBD>GIFͼƬ
    bool Load(String const& file_path);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>GIF<49><46>Դ
    bool Load(Resource const& res);

    /// \~chinese
    /// @brief <20>Ƿ<EFBFBD><C7B7><EFBFBD>Ч
    bool IsValid() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD>ؿ<EFBFBD><D8BF><EFBFBD>
    uint32_t GetWidthInPixels() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD>ظ߶<D8B8>
    uint32_t GetHeightInPixels() const;

    /// \~chinese
    /// @brief <20><>ȡ֡<C8A1><D6A1><EFBFBD><EFBFBD>
    uint32_t GetFramesCount() const;

public:
    /// \~chinese
    /// @brief GIF֡<46>Ĵ<EFBFBD><C4B4>÷<EFBFBD>ʽ
    enum class DisposalType
    {
        Unknown,     ///< δ֪
        None,        ///< <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
        Background,  ///< <20><><EFBFBD><EFBFBD>
        Previous     ///< <20>ָ<EFBFBD>ǰһ֡
    };

    /// \~chinese
    /// @brief GIF֡
    struct Frame
    {
        Duration     delay;          ///< ֡<>ӳ<EFBFBD>
        TexturePtr   texture;        ///< ֡ͼ<D6A1><CDBC>
        Rect         rect;           ///< <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
        DisposalType disposal_type;  ///< <20><><EFBFBD>÷<EFBFBD>ʽ

        Frame();
    };

    /// \~chinese
    /// @brief <20><>ȡGIF֡
    /// @param index ֡<>±<EFBFBD>
    Frame GetFrame(uint32_t index);

private:
    ComPtr<IWICBitmapDecoder> GetDecoder() const;

    void SetDecoder(ComPtr<IWICBitmapDecoder> decoder);

    HRESULT GetGlobalMetadata();

private:
    uint32_t frames_count_;
    uint32_t width_in_pixels_;
    uint32_t height_in_pixels_;

    ComPtr<IWICBitmapDecoder> decoder_;
};

/** @} */

inline GifImage::Frame::Frame()
    : disposal_type(DisposalType::Unknown)
{
}

inline uint32_t GifImage::GetWidthInPixels() const
{
    return width_in_pixels_;
}

inline uint32_t GifImage::GetHeightInPixels() const
{
    return height_in_pixels_;
}

inline uint32_t GifImage::GetFramesCount() const
{
    return frames_count_;
}

inline ComPtr<IWICBitmapDecoder> GifImage::GetDecoder() const
{
    return decoder_;
}

inline void GifImage::SetDecoder(ComPtr<IWICBitmapDecoder> decoder)
{
    decoder_ = decoder;
}
}  // namespace kiwano