Utility: Add ImageStream and GIF support
This commit is contained in:
SirLynix
Jérôme Leclercq
parent
3d15f3578b
commit
2a091d25b7
|
|
@ -0,0 +1,58 @@
|
||||||
|
// Copyright (C) 2022 Jérôme "Lynix" Leclercq (lynix680@gmail.com)
|
||||||
|
// This file is part of the "Nazara Engine - Utility module"
|
||||||
|
// For conditions of distribution and use, see copyright notice in Config.hpp
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#ifndef NAZARA_UTILITY_IMAGESTREAM_HPP
|
||||||
|
#define NAZARA_UTILITY_IMAGESTREAM_HPP
|
||||||
|
|
||||||
|
#include <Nazara/Prerequisites.hpp>
|
||||||
|
#include <Nazara/Core/Resource.hpp>
|
||||||
|
#include <Nazara/Core/ResourceLoader.hpp>
|
||||||
|
#include <Nazara/Core/ResourceParameters.hpp>
|
||||||
|
#include <Nazara/Math/Vector2.hpp>
|
||||||
|
#include <Nazara/Utility/Config.hpp>
|
||||||
|
#include <Nazara/Utility/Enums.hpp>
|
||||||
|
#include <mutex>
|
||||||
|
|
||||||
|
namespace Nz
|
||||||
|
{
|
||||||
|
struct ImageStreamParams : public ResourceParameters
|
||||||
|
{
|
||||||
|
bool IsValid() const;
|
||||||
|
};
|
||||||
|
|
||||||
|
class Mutex;
|
||||||
|
class ImageStream;
|
||||||
|
|
||||||
|
using ImageStreamLoader = ResourceLoader<ImageStream, ImageStreamParams>;
|
||||||
|
|
||||||
|
class NAZARA_UTILITY_API ImageStream : public Resource
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
ImageStream() = default;
|
||||||
|
virtual ~ImageStream();
|
||||||
|
|
||||||
|
virtual bool DecodeNextFrame(void* buffer) = 0;
|
||||||
|
|
||||||
|
virtual UInt64 GetFrameCount() const = 0;
|
||||||
|
virtual UInt64 GetFrameDelay(std::size_t frameIndex) const = 0;
|
||||||
|
virtual PixelFormat GetPixelFormat() const = 0;
|
||||||
|
virtual Vector2ui GetSize() const = 0;
|
||||||
|
|
||||||
|
virtual bool HasConstantRate() const = 0;
|
||||||
|
|
||||||
|
virtual void Seek(UInt64 frameIndex) = 0;
|
||||||
|
|
||||||
|
virtual UInt64 Tell() = 0;
|
||||||
|
|
||||||
|
static std::shared_ptr<ImageStream> OpenFromFile(const std::filesystem::path& filePath, const ImageStreamParams& params = ImageStreamParams());
|
||||||
|
static std::shared_ptr<ImageStream> OpenFromMemory(const void* data, std::size_t size, const ImageStreamParams& params = ImageStreamParams());
|
||||||
|
static std::shared_ptr<ImageStream> OpenFromStream(Stream& stream, const ImageStreamParams& params = ImageStreamParams());
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
#include <Nazara/Utility/ImageStream.inl>
|
||||||
|
|
||||||
|
#endif // NAZARA_UTILITY_IMAGESTREAM_HPP
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
// Copyright (C) 2022 Jérôme "Lynix" Leclercq (lynix680@gmail.com)
|
||||||
|
// This file is part of the "Nazara Engine - Utility module"
|
||||||
|
// For conditions of distribution and use, see copyright notice in Config.hpp
|
||||||
|
|
||||||
|
#include <Nazara/Utility/ImageStream.hpp>
|
||||||
|
#include <Nazara/Utility/Debug.hpp>
|
||||||
|
|
||||||
|
namespace Nz
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
#include <Nazara/Utility/DebugOff.hpp>
|
||||||
|
|
@ -13,6 +13,7 @@
|
||||||
#include <Nazara/Utility/Config.hpp>
|
#include <Nazara/Utility/Config.hpp>
|
||||||
#include <Nazara/Utility/Font.hpp>
|
#include <Nazara/Utility/Font.hpp>
|
||||||
#include <Nazara/Utility/Image.hpp>
|
#include <Nazara/Utility/Image.hpp>
|
||||||
|
#include <Nazara/Utility/ImageStream.hpp>
|
||||||
#include <Nazara/Utility/Mesh.hpp>
|
#include <Nazara/Utility/Mesh.hpp>
|
||||||
|
|
||||||
namespace Nz
|
namespace Nz
|
||||||
|
|
@ -39,6 +40,8 @@ namespace Nz
|
||||||
const ImageLoader& GetImageLoader() const;
|
const ImageLoader& GetImageLoader() const;
|
||||||
ImageSaver& GetImageSaver();
|
ImageSaver& GetImageSaver();
|
||||||
const ImageSaver& GetImageSaver() const;
|
const ImageSaver& GetImageSaver() const;
|
||||||
|
ImageStreamLoader& GetImageStreamLoader();
|
||||||
|
const ImageStreamLoader& GetImageStreamLoader() const;
|
||||||
MeshLoader& GetMeshLoader();
|
MeshLoader& GetMeshLoader();
|
||||||
const MeshLoader& GetMeshLoader() const;
|
const MeshLoader& GetMeshLoader() const;
|
||||||
MeshSaver& GetMeshSaver();
|
MeshSaver& GetMeshSaver();
|
||||||
|
|
@ -52,6 +55,7 @@ namespace Nz
|
||||||
FontLoader m_fontLoader;
|
FontLoader m_fontLoader;
|
||||||
ImageLoader m_imageLoader;
|
ImageLoader m_imageLoader;
|
||||||
ImageSaver m_imageSaver;
|
ImageSaver m_imageSaver;
|
||||||
|
ImageStreamLoader m_imageStreamLoader;
|
||||||
MeshLoader m_meshLoader;
|
MeshLoader m_meshLoader;
|
||||||
MeshSaver m_meshSaver;
|
MeshSaver m_meshSaver;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,653 @@
|
||||||
|
// Copyright (C) 2022 Jérôme "Lynix" Leclercq (lynix680@gmail.com)
|
||||||
|
// This file is part of the "Nazara Engine - Utility module"
|
||||||
|
// For conditions of distribution and use, see copyright notice in Config.hpp
|
||||||
|
|
||||||
|
#include <Nazara/Utility/Formats/GIFLoader.hpp>
|
||||||
|
#include <Nazara/Core/Bitset.hpp>
|
||||||
|
#include <Nazara/Core/ByteStream.hpp>
|
||||||
|
#include <Nazara/Core/CallOnExit.hpp>
|
||||||
|
#include <Nazara/Core/Endianness.hpp>
|
||||||
|
#include <Nazara/Core/Error.hpp>
|
||||||
|
#include <Nazara/Core/Stream.hpp>
|
||||||
|
#include <Nazara/Utility/Image.hpp>
|
||||||
|
#include <Nazara/Utility/Formats/STBLoader.hpp>
|
||||||
|
#include <Nazara/Utility/Debug.hpp>
|
||||||
|
|
||||||
|
// based on https://www.w3.org/Graphics/GIF/spec-gif89a.txt, with help from the following public domain libraries source code:
|
||||||
|
// - https://github.com/lecram/gifdec
|
||||||
|
// - https://github.com/nothings/stb/blob/master/stb_image.h
|
||||||
|
|
||||||
|
namespace Nz
|
||||||
|
{
|
||||||
|
namespace
|
||||||
|
{
|
||||||
|
class GIFImageStream : public ImageStream
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
GIFImageStream()
|
||||||
|
{
|
||||||
|
m_byteStream.SetDataEndianness(Endianness::LittleEndian);
|
||||||
|
}
|
||||||
|
|
||||||
|
~GIFImageStream()
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
bool Check()
|
||||||
|
{
|
||||||
|
std::array<UInt8, 6> header; //< 3 bytes for signature + 3 bytes for version (87a and 89a supported)
|
||||||
|
if (m_byteStream.Read(header.data(), header.size()) != header.size())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (std::memcmp(&header[0], "GIF", 3) != 0)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (std::memcmp(&header[3], "87a", 3) != 0 && std::memcmp(&header[3], "89a", 3) != 0)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool DecodeNextFrame(void* buffer) override
|
||||||
|
{
|
||||||
|
UInt8* outputImage = static_cast<UInt8*>(buffer);
|
||||||
|
auto& frameData = m_frames[m_currentFrame];
|
||||||
|
|
||||||
|
UInt16 left;
|
||||||
|
UInt16 top;
|
||||||
|
UInt16 width;
|
||||||
|
UInt16 height;
|
||||||
|
UInt8 flag;
|
||||||
|
|
||||||
|
m_byteStream >> left >> top >> width >> height >> flag;
|
||||||
|
|
||||||
|
ImageDecodingData decodingData;
|
||||||
|
decodingData.lineSize = m_header.width * 4;
|
||||||
|
decodingData.startX = left * 4;
|
||||||
|
decodingData.startY = top * decodingData.lineSize;
|
||||||
|
decodingData.maxX = decodingData.startX + width * 4;
|
||||||
|
decodingData.maxY = decodingData.startY + decodingData.lineSize * height;
|
||||||
|
decodingData.currentX = decodingData.startX;
|
||||||
|
decodingData.currentY = decodingData.startY;
|
||||||
|
decodingData.outputImage = outputImage;
|
||||||
|
|
||||||
|
//if (m_currentFrame == 0)
|
||||||
|
std::memset(decodingData.outputImage, 0, m_header.width * m_header.height * 4);
|
||||||
|
|
||||||
|
// if the width of the specified rectangle is 0, that means
|
||||||
|
// we may not see *any* pixels or the image is malformed;
|
||||||
|
// to make sure this is caught, move the current y down to
|
||||||
|
// max_y (which is what out_gif_code checks).
|
||||||
|
if (width == 0)
|
||||||
|
decodingData.currentY = decodingData.maxY;
|
||||||
|
|
||||||
|
bool interlace = (flag & 0b0100'0000);
|
||||||
|
if (interlace)
|
||||||
|
{
|
||||||
|
decodingData.step = 8 * decodingData.lineSize;
|
||||||
|
decodingData.parseMode = 3;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
decodingData.step = decodingData.lineSize;
|
||||||
|
decodingData.parseMode = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool hasLocalColorTable = (flag & 0b1000'0000);
|
||||||
|
if (hasLocalColorTable)
|
||||||
|
{
|
||||||
|
UInt16 numEntries = 2ULL << (flag & 0b0000'0111);
|
||||||
|
m_localColorTable.resize(numEntries);
|
||||||
|
for (std::size_t i = 0; i < numEntries; ++i)
|
||||||
|
{
|
||||||
|
m_byteStream >> m_localColorTable[i].r >> m_localColorTable[i].g >> m_localColorTable[i].b;
|
||||||
|
m_localColorTable[i].a = (i == frameData.transparentIndex) ? 0 : 0xFF;
|
||||||
|
}
|
||||||
|
|
||||||
|
decodingData.colorTable = &m_localColorTable[0];
|
||||||
|
}
|
||||||
|
else if (!m_globalColorTable.empty())
|
||||||
|
decodingData.colorTable = &m_globalColorTable[0];
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// this error should have been caught already when loading
|
||||||
|
NazaraInternalError("expected color table");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
UInt8 minimumCodeSize;
|
||||||
|
m_byteStream >> minimumCodeSize;
|
||||||
|
if (minimumCodeSize > 12)
|
||||||
|
{
|
||||||
|
NazaraInternalError("unexpected LZW Minimum Code Size (" + std::to_string(minimumCodeSize) + ")");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
Int32 clear = 1 << minimumCodeSize;
|
||||||
|
UInt32 first = 1;
|
||||||
|
Int32 codeSize = minimumCodeSize + 1;
|
||||||
|
Int32 codeMask = (1 << codeSize) - 1;
|
||||||
|
Int32 bits = 0;
|
||||||
|
Int32 validBits = 0;
|
||||||
|
m_lzwEntries.clear();
|
||||||
|
m_lzwEntries.resize(8192); //< ??
|
||||||
|
for (Int32 i = 0; i < clear; ++i)
|
||||||
|
{
|
||||||
|
auto& entry = m_lzwEntries[i];
|
||||||
|
entry.prefix = -1;
|
||||||
|
entry.first = UInt8(i);
|
||||||
|
entry.suffix = UInt8(i);
|
||||||
|
}
|
||||||
|
|
||||||
|
// support no starting clear code
|
||||||
|
Int32 avail = clear + 2;
|
||||||
|
|
||||||
|
Int32 oldcode = -1;
|
||||||
|
UInt8 len = 0;
|
||||||
|
|
||||||
|
m_affectedPixels.Reset();
|
||||||
|
|
||||||
|
for (;;)
|
||||||
|
{
|
||||||
|
if (validBits < codeSize)
|
||||||
|
{
|
||||||
|
if (len == 0)
|
||||||
|
{
|
||||||
|
m_byteStream >> len; // start new block
|
||||||
|
if (len == 0)
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
UInt8 data;
|
||||||
|
m_byteStream >> data;
|
||||||
|
|
||||||
|
--len;
|
||||||
|
bits |= data << validBits;
|
||||||
|
validBits += 8;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
Int32 code = bits & codeMask;
|
||||||
|
bits >>= codeSize;
|
||||||
|
validBits -= codeSize;
|
||||||
|
// @OPTIMIZE: is there some way we can accelerate the non-clear path?
|
||||||
|
if (code == clear)
|
||||||
|
{ // clear code
|
||||||
|
codeSize = minimumCodeSize + 1;
|
||||||
|
codeMask = (1 << codeSize) - 1;
|
||||||
|
avail = clear + 2;
|
||||||
|
oldcode = -1;
|
||||||
|
first = 0;
|
||||||
|
}
|
||||||
|
else if (code == clear + 1)
|
||||||
|
{
|
||||||
|
// end of stream code
|
||||||
|
SkipUntilTerminationBlock();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
else if (code <= avail)
|
||||||
|
{
|
||||||
|
if (first)
|
||||||
|
{
|
||||||
|
NazaraError("corrupt gif (no clear code)");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (oldcode >= 0)
|
||||||
|
{
|
||||||
|
auto& p = m_lzwEntries[avail++];
|
||||||
|
if (avail > 8192)
|
||||||
|
{
|
||||||
|
NazaraError("corrupt gif (too many codes)");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.prefix = SafeCast<Int16>(oldcode);
|
||||||
|
p.first = m_lzwEntries[oldcode].first;
|
||||||
|
p.suffix = (code == avail) ? p.first : m_lzwEntries[code].first;
|
||||||
|
}
|
||||||
|
else if (code == avail)
|
||||||
|
{
|
||||||
|
NazaraError("corrupt gif (illegal code in raster)");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
DecodeGIF(SafeCast<UInt16>(code), decodingData);
|
||||||
|
|
||||||
|
if ((avail & codeMask) == 0 && avail <= 0x0FFF)
|
||||||
|
{
|
||||||
|
codeSize++;
|
||||||
|
codeMask = (1 << codeSize) - 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
oldcode = code;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
NazaraError("corrupt gif (illegal code in raster)");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// if this was the first frame
|
||||||
|
if (m_currentFrame == 0 && m_header.backgroundPaletteIndex > 0)
|
||||||
|
{
|
||||||
|
std::size_t pixelCount = m_header.width * m_header.height;
|
||||||
|
// if first frame, any pixel not drawn to gets the background color
|
||||||
|
for (std::size_t i = 0; i < pixelCount; ++i)
|
||||||
|
{
|
||||||
|
if (!m_affectedPixels[i])
|
||||||
|
{
|
||||||
|
UInt8* outputPixel = &outputImage[i * 4];
|
||||||
|
outputPixel[0] = m_globalColorTable[m_header.backgroundPaletteIndex].r;
|
||||||
|
outputPixel[1] = m_globalColorTable[m_header.backgroundPaletteIndex].g;
|
||||||
|
outputPixel[2] = m_globalColorTable[m_header.backgroundPaletteIndex].b;
|
||||||
|
outputPixel[3] = m_globalColorTable[m_header.backgroundPaletteIndex].a;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (m_currentFrame + 1 < m_frames.size())
|
||||||
|
Seek(m_currentFrame + 1);
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
UInt64 GetFrameCount() const override
|
||||||
|
{
|
||||||
|
return m_frames.size();
|
||||||
|
}
|
||||||
|
|
||||||
|
UInt64 GetFrameDelay(std::size_t frameIndex) const override
|
||||||
|
{
|
||||||
|
assert(frameIndex < m_frames.size());
|
||||||
|
return m_frames[frameIndex].delay;
|
||||||
|
}
|
||||||
|
|
||||||
|
PixelFormat GetPixelFormat() const override
|
||||||
|
{
|
||||||
|
return PixelFormat::RGBA8; //< TODO: Set SRGB
|
||||||
|
}
|
||||||
|
|
||||||
|
Vector2ui GetSize() const override
|
||||||
|
{
|
||||||
|
return Vector2ui(m_header.width, m_header.height);
|
||||||
|
}
|
||||||
|
|
||||||
|
bool HasConstantRate() const override
|
||||||
|
{
|
||||||
|
return m_hasConstantRate;
|
||||||
|
}
|
||||||
|
|
||||||
|
void Seek(UInt64 frameIndex) override
|
||||||
|
{
|
||||||
|
assert(frameIndex < m_frames.size());
|
||||||
|
|
||||||
|
m_currentFrame = frameIndex;
|
||||||
|
m_byteStream.GetStream()->SetCursorPos(m_frames[m_currentFrame].streamOffset);
|
||||||
|
}
|
||||||
|
|
||||||
|
UInt64 Tell() override
|
||||||
|
{
|
||||||
|
return m_currentFrame;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool Open()
|
||||||
|
{
|
||||||
|
if (!Check())
|
||||||
|
{
|
||||||
|
NazaraError("stream has invalid GIF header");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
m_byteStream >> m_header.width >> m_header.height;
|
||||||
|
m_byteStream >> m_header.flags >> m_header.backgroundPaletteIndex >> m_header.ratio;
|
||||||
|
|
||||||
|
bool hasGlobalColorTable = (m_header.flags & 0b1000'0000);
|
||||||
|
if (hasGlobalColorTable)
|
||||||
|
{
|
||||||
|
std::size_t numEntries = 2ULL << (m_header.flags & 0b0000'0111);
|
||||||
|
m_globalColorTable.resize(numEntries);
|
||||||
|
for (std::size_t i = 0; i < numEntries; ++i)
|
||||||
|
{
|
||||||
|
m_byteStream >> m_globalColorTable[i].r >> m_globalColorTable[i].g >> m_globalColorTable[i].b;
|
||||||
|
m_globalColorTable[i].a = 0xFF;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
m_frames.clear();
|
||||||
|
bool terminated = false;
|
||||||
|
UInt16 nextFrameDelay = 0;
|
||||||
|
UInt8 nextFrameTransparentIndex = 0xFF;
|
||||||
|
while (!terminated)
|
||||||
|
{
|
||||||
|
UInt8 tag;
|
||||||
|
m_byteStream >> tag;
|
||||||
|
|
||||||
|
switch (tag)
|
||||||
|
{
|
||||||
|
case 0x2C: //< image descriptor tag
|
||||||
|
{
|
||||||
|
auto& frame = m_frames.emplace_back();
|
||||||
|
frame.delay = nextFrameDelay;
|
||||||
|
frame.streamOffset = m_byteStream.GetStream()->GetCursorPos();
|
||||||
|
frame.transparentIndex = nextFrameTransparentIndex;
|
||||||
|
|
||||||
|
UInt16 left;
|
||||||
|
UInt16 top;
|
||||||
|
UInt16 width;
|
||||||
|
UInt16 height;
|
||||||
|
UInt8 flag;
|
||||||
|
|
||||||
|
m_byteStream >> left >> top >> width >> height >> flag;
|
||||||
|
|
||||||
|
if (left + width > m_header.width)
|
||||||
|
{
|
||||||
|
NazaraError("corrupt gif (out of range)");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (top + height > m_header.height)
|
||||||
|
{
|
||||||
|
NazaraError("corrupt gif (out of range)");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (flag & 0b1000'0000)
|
||||||
|
{
|
||||||
|
// has local color table
|
||||||
|
UInt16 colorTableSize = 2ULL << (flag & 0b0000'0111);
|
||||||
|
m_byteStream.Read(nullptr, colorTableSize * 3);
|
||||||
|
}
|
||||||
|
else if (!hasGlobalColorTable)
|
||||||
|
{
|
||||||
|
NazaraError("corrupt gif (no color table for image #" + std::to_string(m_frames.size() - 1) + ")");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
UInt8 minimumCodeSize;
|
||||||
|
m_byteStream >> minimumCodeSize;
|
||||||
|
if (minimumCodeSize > 12)
|
||||||
|
{
|
||||||
|
NazaraError("unexpected LZW Minimum Code Size (" + std::to_string(minimumCodeSize) + ")");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
SkipUntilTerminationBlock();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
case 0x3B: //< end of file
|
||||||
|
terminated = true;
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 0x21: //< extension tag
|
||||||
|
{
|
||||||
|
UInt8 label;
|
||||||
|
m_byteStream >> label;
|
||||||
|
switch (label)
|
||||||
|
{
|
||||||
|
case 0xF9: //< graphic control extension
|
||||||
|
{
|
||||||
|
UInt8 blockSize;
|
||||||
|
UInt8 flags;
|
||||||
|
UInt16 delay;
|
||||||
|
|
||||||
|
m_byteStream >> blockSize >> flags >> delay;
|
||||||
|
|
||||||
|
if (blockSize != 4)
|
||||||
|
{
|
||||||
|
NazaraError("corrupt gif (invalid block size for graphic control extension)");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
UInt8 disposalMethod = (flags & 0b0001'1100) >> 2;
|
||||||
|
nextFrameDelay = delay * 10;
|
||||||
|
|
||||||
|
if (flags & 0b0000'0001)
|
||||||
|
m_byteStream >> nextFrameTransparentIndex;
|
||||||
|
else
|
||||||
|
nextFrameTransparentIndex = 0xFFFF;
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
case 0xFE: //< comment extension
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 0x01: //< plain text extension
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 0xFF: //< application extension
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
NazaraWarning("unrecognized extension label (unknown tag 0x" + NumberToString(label, 16) + ")");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
SkipUntilTerminationBlock();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
default:
|
||||||
|
NazaraError("corrupt gif (unknown tag 0x" + NumberToString(tag, 16) + ")");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
m_affectedPixels.Resize(m_header.width* m_header.height);
|
||||||
|
|
||||||
|
Seek(0);
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool SetFile(const std::filesystem::path& filePath)
|
||||||
|
{
|
||||||
|
std::unique_ptr<File> file = std::make_unique<File>();
|
||||||
|
if (!file->Open(filePath, OpenMode::ReadOnly))
|
||||||
|
{
|
||||||
|
NazaraError("Failed to open stream from file: " + Error::GetLastError());
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
m_ownedStream = std::move(file);
|
||||||
|
|
||||||
|
SetStream(*m_ownedStream);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
void SetMemory(const void* data, std::size_t size)
|
||||||
|
{
|
||||||
|
m_ownedStream = std::make_unique<MemoryView>(data, size);
|
||||||
|
SetStream(*m_ownedStream);
|
||||||
|
}
|
||||||
|
|
||||||
|
void SetStream(Stream& stream)
|
||||||
|
{
|
||||||
|
m_byteStream.SetStream(&stream);
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
struct ImageDecodingData;
|
||||||
|
|
||||||
|
void DecodeGIF(UInt16 code, ImageDecodingData& decodingData)
|
||||||
|
{
|
||||||
|
// recurse to decode the prefixes, since the linked-list is backwards,
|
||||||
|
// and working backwards through an interleaved image would be nasty
|
||||||
|
if (m_lzwEntries[code].prefix >= 0)
|
||||||
|
DecodeGIF(m_lzwEntries[code].prefix, decodingData);
|
||||||
|
|
||||||
|
if (decodingData.currentY >= decodingData.maxY)
|
||||||
|
return;
|
||||||
|
|
||||||
|
std::size_t idx = decodingData.currentX + decodingData.currentY;
|
||||||
|
UInt8* p = &decodingData.outputImage[idx];
|
||||||
|
m_affectedPixels[idx / 4] = true;
|
||||||
|
|
||||||
|
const Color* c = &decodingData.colorTable[m_lzwEntries[code].suffix];
|
||||||
|
if (c->a > 128)
|
||||||
|
{
|
||||||
|
// don't render transparent pixels;
|
||||||
|
p[0] = c->r;
|
||||||
|
p[1] = c->g;
|
||||||
|
p[2] = c->b;
|
||||||
|
p[3] = c->a;
|
||||||
|
}
|
||||||
|
|
||||||
|
decodingData.currentX += 4;
|
||||||
|
|
||||||
|
if (decodingData.currentX >= decodingData.maxX)
|
||||||
|
{
|
||||||
|
decodingData.currentX = decodingData.startX;
|
||||||
|
decodingData.currentY += decodingData.step;
|
||||||
|
|
||||||
|
while (decodingData.currentY >= decodingData.maxY && decodingData.parseMode > 0)
|
||||||
|
{
|
||||||
|
decodingData.step = (1ULL << decodingData.parseMode) * decodingData.lineSize;
|
||||||
|
decodingData.currentY = decodingData.startY + (decodingData.step >> 1);
|
||||||
|
--decodingData.parseMode;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void SkipUntilTerminationBlock()
|
||||||
|
{
|
||||||
|
for (;;)
|
||||||
|
{
|
||||||
|
UInt8 blockSize;
|
||||||
|
m_byteStream >> blockSize;
|
||||||
|
|
||||||
|
if (blockSize == 0)
|
||||||
|
return;
|
||||||
|
|
||||||
|
m_byteStream.Read(nullptr, blockSize);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
struct Color
|
||||||
|
{
|
||||||
|
UInt8 r, g, b, a;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct FrameData
|
||||||
|
{
|
||||||
|
UInt64 delay;
|
||||||
|
UInt64 streamOffset;
|
||||||
|
UInt8 transparentIndex;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct ImageDecodingData
|
||||||
|
{
|
||||||
|
std::size_t currentX;
|
||||||
|
std::size_t currentY;
|
||||||
|
std::size_t lineSize;
|
||||||
|
std::size_t maxX;
|
||||||
|
std::size_t maxY;
|
||||||
|
std::size_t parseMode;
|
||||||
|
std::size_t startX;
|
||||||
|
std::size_t startY;
|
||||||
|
std::size_t step;
|
||||||
|
Color* colorTable;
|
||||||
|
UInt8* outputImage;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct LogicalScreenDescriptor
|
||||||
|
{
|
||||||
|
UInt16 height;
|
||||||
|
UInt16 width;
|
||||||
|
UInt8 backgroundPaletteIndex;
|
||||||
|
UInt8 flags;
|
||||||
|
UInt8 packedFields;
|
||||||
|
UInt8 ratio;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct LZWEntry
|
||||||
|
{
|
||||||
|
Int16 prefix = 0;
|
||||||
|
UInt8 first = 0;
|
||||||
|
UInt8 suffix = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
std::size_t m_currentFrame;
|
||||||
|
std::vector<Color> m_globalColorTable;
|
||||||
|
std::vector<Color> m_localColorTable;
|
||||||
|
std::vector<FrameData> m_frames;
|
||||||
|
std::vector<LZWEntry> m_lzwEntries;
|
||||||
|
std::unique_ptr<Stream> m_ownedStream;
|
||||||
|
Bitset<UInt64> m_affectedPixels;
|
||||||
|
ByteStream m_byteStream;
|
||||||
|
LogicalScreenDescriptor m_header;
|
||||||
|
bool m_hasConstantRate;
|
||||||
|
};
|
||||||
|
|
||||||
|
bool CheckGIFExtension(const std::string_view& extension)
|
||||||
|
{
|
||||||
|
return extension == "gif";
|
||||||
|
}
|
||||||
|
|
||||||
|
Ternary CheckGIF(Stream& stream, const ImageStreamParams& parameters)
|
||||||
|
{
|
||||||
|
bool skip;
|
||||||
|
if (parameters.custom.GetBooleanParameter("SkipBuiltinGIFLoader", &skip) && skip)
|
||||||
|
return Ternary::False;
|
||||||
|
|
||||||
|
GIFImageStream gif;
|
||||||
|
gif.SetStream(stream);
|
||||||
|
|
||||||
|
if (gif.Check())
|
||||||
|
return Ternary::True;
|
||||||
|
else
|
||||||
|
return Ternary::False;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::shared_ptr<ImageStream> LoadGIFFile(const std::filesystem::path& filePath, const ImageStreamParams& /*parameters*/)
|
||||||
|
{
|
||||||
|
std::shared_ptr<GIFImageStream> gifStream = std::make_shared<GIFImageStream>();
|
||||||
|
gifStream->SetFile(filePath);
|
||||||
|
|
||||||
|
if (!gifStream->Open())
|
||||||
|
return {};
|
||||||
|
|
||||||
|
return gifStream;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::shared_ptr<ImageStream> LoadGIFMemory(const void* ptr, std::size_t size, const ImageStreamParams& /*parameters*/)
|
||||||
|
{
|
||||||
|
std::shared_ptr<GIFImageStream> gifStream = std::make_shared<GIFImageStream>();
|
||||||
|
gifStream->SetMemory(ptr, size);
|
||||||
|
|
||||||
|
if (!gifStream->Open())
|
||||||
|
return {};
|
||||||
|
|
||||||
|
return gifStream;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::shared_ptr<ImageStream> LoadGIFStream(Stream& stream, const ImageStreamParams& /*parameters*/)
|
||||||
|
{
|
||||||
|
std::shared_ptr<GIFImageStream> gifStream = std::make_shared<GIFImageStream>();
|
||||||
|
gifStream->SetStream(stream);
|
||||||
|
|
||||||
|
if (!gifStream->Open())
|
||||||
|
return {};
|
||||||
|
|
||||||
|
return gifStream;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
namespace Loaders
|
||||||
|
{
|
||||||
|
ImageStreamLoader::Entry GetImageStreamLoader_GIF()
|
||||||
|
{
|
||||||
|
ImageStreamLoader::Entry loaderEntry;
|
||||||
|
loaderEntry.extensionSupport = CheckGIFExtension;
|
||||||
|
loaderEntry.streamChecker = CheckGIF;
|
||||||
|
loaderEntry.fileLoader = LoadGIFFile;
|
||||||
|
loaderEntry.memoryLoader = LoadGIFMemory;
|
||||||
|
loaderEntry.streamLoader = LoadGIFStream;
|
||||||
|
|
||||||
|
return loaderEntry;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
// Copyright (C) 2022 Jérôme "Lynix" Leclercq (lynix680@gmail.com)
|
||||||
|
// This file is part of the "Nazara Engine - Utility module"
|
||||||
|
// For conditions of distribution and use, see copyright notice in Config.hpp
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#ifndef NAZARA_UTILITY_FORMATS_GIFLOADER_HPP
|
||||||
|
#define NAZARA_UTILITY_FORMATS_GIFLOADER_HPP
|
||||||
|
|
||||||
|
#include <Nazara/Prerequisites.hpp>
|
||||||
|
#include <Nazara/Utility/Image.hpp>
|
||||||
|
#include <Nazara/Utility/ImageStream.hpp>
|
||||||
|
|
||||||
|
namespace Nz::Loaders
|
||||||
|
{
|
||||||
|
ImageStreamLoader::Entry GetImageStreamLoader_GIF();
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif // NAZARA_UTILITY_FORMATS_GIFLOADER_HPP
|
||||||
|
|
@ -0,0 +1,69 @@
|
||||||
|
// Copyright (C) 2022 Jérôme "Lynix" Leclercq (lynix680@gmail.com)
|
||||||
|
// This file is part of the "Nazara Engine - Utility module"
|
||||||
|
// For conditions of distribution and use, see copyright notice in Config.hpp
|
||||||
|
|
||||||
|
#include <Nazara/Utility/ImageStream.hpp>
|
||||||
|
#include <Nazara/Utility/Utility.hpp>
|
||||||
|
#include <Nazara/Utility/Debug.hpp>
|
||||||
|
|
||||||
|
namespace Nz
|
||||||
|
{
|
||||||
|
bool ImageStreamParams::IsValid() const
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
ImageStream::~ImageStream() = default;
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* \brief Opens the sound stream from file
|
||||||
|
* \return true if loading is successful
|
||||||
|
*
|
||||||
|
* \param filePath Path to the file
|
||||||
|
* \param params Parameters for the sound stream
|
||||||
|
*
|
||||||
|
* \remark The file must stay valid until the sound stream is destroyed
|
||||||
|
*/
|
||||||
|
std::shared_ptr<ImageStream> ImageStream::OpenFromFile(const std::filesystem::path& filePath, const ImageStreamParams& params)
|
||||||
|
{
|
||||||
|
Utility* utility = Utility::Instance();
|
||||||
|
NazaraAssert(utility, "Utility module has not been initialized");
|
||||||
|
|
||||||
|
return utility->GetImageStreamLoader().LoadFromFile(filePath, params);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* \brief Opens the sound stream from memory
|
||||||
|
* \return true if loading is successful
|
||||||
|
*
|
||||||
|
* \param data Raw memory
|
||||||
|
* \param size Size of the memory
|
||||||
|
* \param params Parameters for the sound stream
|
||||||
|
*
|
||||||
|
* \remark The memory block must stay valid until the sound stream is destroyed
|
||||||
|
*/
|
||||||
|
std::shared_ptr<ImageStream> ImageStream::OpenFromMemory(const void* data, std::size_t size, const ImageStreamParams& params)
|
||||||
|
{
|
||||||
|
Utility* utility = Utility::Instance();
|
||||||
|
NazaraAssert(utility, "Utility module has not been initialized");
|
||||||
|
|
||||||
|
return utility->GetImageStreamLoader().LoadFromMemory(data, size, params);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* \brief Opens the sound stream from stream
|
||||||
|
* \return true if loading is successful
|
||||||
|
*
|
||||||
|
* \param stream Stream to the sound stream
|
||||||
|
* \param params Parameters for the sound stream
|
||||||
|
*
|
||||||
|
* \remark The stream must stay valid until the sound stream is destroyed
|
||||||
|
*/
|
||||||
|
std::shared_ptr<ImageStream> ImageStream::OpenFromStream(Stream& stream, const ImageStreamParams& params)
|
||||||
|
{
|
||||||
|
Utility* utility = Utility::Instance();
|
||||||
|
NazaraAssert(utility, "Utility module has not been initialized");
|
||||||
|
|
||||||
|
return utility->GetImageStreamLoader().LoadFromStream(stream, params);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -17,6 +17,7 @@
|
||||||
#include <Nazara/Utility/VertexDeclaration.hpp>
|
#include <Nazara/Utility/VertexDeclaration.hpp>
|
||||||
#include <Nazara/Utility/Formats/DDSLoader.hpp>
|
#include <Nazara/Utility/Formats/DDSLoader.hpp>
|
||||||
#include <Nazara/Utility/Formats/FreeTypeLoader.hpp>
|
#include <Nazara/Utility/Formats/FreeTypeLoader.hpp>
|
||||||
|
#include <Nazara/Utility/Formats/GIFLoader.hpp>
|
||||||
#include <Nazara/Utility/Formats/MD2Loader.hpp>
|
#include <Nazara/Utility/Formats/MD2Loader.hpp>
|
||||||
#include <Nazara/Utility/Formats/MD5AnimLoader.hpp>
|
#include <Nazara/Utility/Formats/MD5AnimLoader.hpp>
|
||||||
#include <Nazara/Utility/Formats/MD5MeshLoader.hpp>
|
#include <Nazara/Utility/Formats/MD5MeshLoader.hpp>
|
||||||
|
|
@ -60,6 +61,9 @@ namespace Nz
|
||||||
m_imageLoader.RegisterLoader(Loaders::GetImageLoader_STB()); // Generic loader (STB)
|
m_imageLoader.RegisterLoader(Loaders::GetImageLoader_STB()); // Generic loader (STB)
|
||||||
m_imageSaver.RegisterSaver(Loaders::GetImageSaver_STB()); // Generic saver (STB)
|
m_imageSaver.RegisterSaver(Loaders::GetImageSaver_STB()); // Generic saver (STB)
|
||||||
|
|
||||||
|
// ImageStream
|
||||||
|
m_imageStreamLoader.RegisterLoader(Loaders::GetImageStreamLoader_GIF()); // GIF loader
|
||||||
|
|
||||||
/// Loaders spécialisés
|
/// Loaders spécialisés
|
||||||
// Animation
|
// Animation
|
||||||
m_animationLoader.RegisterLoader(Loaders::GetAnimationLoader_MD5Anim()); // Loader de fichiers .md5anim (v10)
|
m_animationLoader.RegisterLoader(Loaders::GetAnimationLoader_MD5Anim()); // Loader de fichiers .md5anim (v10)
|
||||||
|
|
@ -117,6 +121,16 @@ namespace Nz
|
||||||
return m_imageLoader;
|
return m_imageLoader;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
ImageStreamLoader& Utility::GetImageStreamLoader()
|
||||||
|
{
|
||||||
|
return m_imageStreamLoader;
|
||||||
|
}
|
||||||
|
|
||||||
|
const ImageStreamLoader& Utility::GetImageStreamLoader() const
|
||||||
|
{
|
||||||
|
return m_imageStreamLoader;
|
||||||
|
}
|
||||||
|
|
||||||
ImageSaver& Utility::GetImageSaver()
|
ImageSaver& Utility::GetImageSaver()
|
||||||
{
|
{
|
||||||
return m_imageSaver;
|
return m_imageSaver;
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue