KisLegacyTileCompressor Class Reference

#include <kis_legacy_tile_compressor.h>

Inheritance diagram for KisLegacyTileCompressor:

Public Member Functions
void	compressTileData (KisTileData *tileData, quint8 *buffer, qint32 bufferSize, qint32 &bytesWritten) override
bool	decompressTileData (quint8 *buffer, qint32 bufferSize, KisTileData *tileData) override
	KisLegacyTileCompressor ()
bool	readTile (QIODevice *stream, KisTiledDataManager *dm) override
qint32	tileDataBufferSize (KisTileData *tileData) override
bool	writeTile (KisTileSP tile, KisPaintDeviceWriter &store) override
	~KisLegacyTileCompressor () override
Public Member Functions inherited from KisAbstractTileCompressor
	KisAbstractTileCompressor ()
virtual	~KisAbstractTileCompressor ()
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Private Member Functions
qint32	maxHeaderLength ()
bool	writeHeader (KisTileSP tile, quint8 *buffer)

Additional Inherited Members
Protected Member Functions inherited from KisAbstractTileCompressor
qint32	pixelSize (KisTiledDataManager *dm)
qint32	xToCol (KisTiledDataManager *dm, qint32 x)
qint32	yToRow (KisTiledDataManager *dm, qint32 y)
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Detailed Description

Definition at line 13 of file kis_legacy_tile_compressor.h.

Constructor & Destructor Documentation

KisLegacyTileCompressor()

KisLegacyTileCompressor::KisLegacyTileCompressor

(

)

Definition at line 13 of file kis_legacy_tile_compressor.cpp.

{
}

~KisLegacyTileCompressor()

KisLegacyTileCompressor::~KisLegacyTileCompressor ( )

override

Definition at line 17 of file kis_legacy_tile_compressor.cpp.

{
}

Member Function Documentation

compressTileData()

void KisLegacyTileCompressor::compressTileData ( KisTileData * tileData, quint8 * buffer, qint32 bufferSize, qint32 & bytesWritten )

overridevirtual

Compresses a tileData and writes it into the buffer. The buffer must be at least tileDataBufferSize() bytes long. Actual number of bytes written is returned using out-parameter bytesWritten

Parameters

tileData	an existing tile data. It should be created and acquired by the caller.
buffer	the buffer
bufferSize	the size of the buffer
bytesWritten	the number of written bytes

See also

tileDataBufferSize()

Implements KisAbstractTileCompressor.

Definition at line 68 of file kis_legacy_tile_compressor.cpp.

{
    bytesWritten = 0;
    const qint32 tileDataSize = TILE_DATA_SIZE(tileData->pixelSize());
    Q_UNUSED(bufferSize);
    Q_ASSERT(bufferSize >= tileDataSize);
    memcpy(buffer, tileData->data(), tileDataSize);
    bytesWritten += tileDataSize;
}

References KisTileData::data(), KisTileData::pixelSize(), and TILE_DATA_SIZE.

decompressTileData()

bool KisLegacyTileCompressor::decompressTileData ( quint8 * buffer, qint32 bufferSize, KisTileData * tileData )

overridevirtual

Decompresses a tileData from a given buffer.

Parameters

buffer	the buffer
bufferSize	the size of the buffer
tileData	an existing tile data where the result will be written to. It should be created and acquired by the caller.

Implements KisAbstractTileCompressor.

Definition at line 81 of file kis_legacy_tile_compressor.cpp.

{
    const qint32 tileDataSize = TILE_DATA_SIZE(tileData->pixelSize());
    if (bufferSize >= tileDataSize) {
        memcpy(tileData->data(), buffer, tileDataSize);
        return true;
    }
    return false;
}

References KisTileData::data(), KisTileData::pixelSize(), and TILE_DATA_SIZE.

maxHeaderLength()

qint32 KisLegacyTileCompressor::maxHeaderLength ( )

inlineprivate

Quite self describing

Definition at line 98 of file kis_legacy_tile_compressor.cpp.

{
    static const qint32 LEGACY_MAGIC_NUMBER = 79;
    return LEGACY_MAGIC_NUMBER;
}

readTile()

bool KisLegacyTileCompressor::readTile ( QIODevice * stream, KisTiledDataManager * dm )

overridevirtual

Decompresses the tile from the stream. Used by datamanager in load/save routines

See also

decompressTile()

Implements KisAbstractTileCompressor.

Definition at line 43 of file kis_legacy_tile_compressor.cpp.

{
    const qint32 tileDataSize = TILE_DATA_SIZE(pixelSize(dm));
 
    const qint32 bufferSize = maxHeaderLength() + 1;
    quint8 *headerBuffer = new quint8[bufferSize];
 
    qint32 x, y;
    qint32 width, height;
 
    stream->readLine((char *)headerBuffer, bufferSize);
    sscanf((char *) headerBuffer, "%d,%d,%d,%d", &x, &y, &width, &height);
 
    qint32 row = yToRow(dm, y);
    qint32 col = xToCol(dm, x);
 
    KisTileSP tile = dm->getTile(col, row, true);
 
    tile->lockForWrite();
    stream->read((char *)tile->data(), tileDataSize);
    tile->unlockForWrite();
 
    return true;
}

References KisTile::data(), KisTiledDataManager::getTile(), KisTile::lockForWrite(), maxHeaderLength(), KisAbstractTileCompressor::pixelSize(), TILE_DATA_SIZE, KisTile::unlockForWrite(), KisAbstractTileCompressor::xToCol(), and KisAbstractTileCompressor::yToRow().

tileDataBufferSize()

qint32 KisLegacyTileCompressor::tileDataBufferSize ( KisTileData * tileData )

overridevirtual

Return the number of bytes needed for compressing one tile

Implements KisAbstractTileCompressor.

Definition at line 93 of file kis_legacy_tile_compressor.cpp.

{
    return TILE_DATA_SIZE(tileData->pixelSize());
}

References KisTileData::pixelSize(), and TILE_DATA_SIZE.

writeHeader()

bool KisLegacyTileCompressor::writeHeader ( KisTileSP tile, quint8 * buffer )

inlineprivate

Writes header into the buffer. Buffer size should be maxHeaderLength() + 1 bytes at least (to fit terminating '\0')

Definition at line 104 of file kis_legacy_tile_compressor.cpp.

{
    qint32 x, y;
    qint32 width, height;
 
    tile->extent().getRect(&x, &y, &width, &height);
    sprintf((char *)buffer, "%d,%d,%d,%d\n", x, y, width, height);
 
    return true;
}

References KisTile::extent().

writeTile()

bool KisLegacyTileCompressor::writeTile ( KisTileSP tile, KisPaintDeviceWriter & store )

overridevirtual

Compresses the tile and writes it into the stream. Used by datamanager in load/save routines

See also

compressTile()

Implements KisAbstractTileCompressor.

Definition at line 21 of file kis_legacy_tile_compressor.cpp.

{
    const qint32 tileDataSize = TILE_DATA_SIZE(tile->pixelSize());
 
    const qint32 bufferSize = maxHeaderLength() + 1;
    QScopedArrayPointer<quint8> headerBuffer(new quint8[bufferSize]);
 
    bool retval = writeHeader(tile, headerBuffer.data());
    Q_ASSERT(retval);  // currently the code returns true unconditionally
    if (!retval) {
        return false;
    }
 
    store.write((char *)headerBuffer.data(), strlen((char *)headerBuffer.data()));
 
    tile->lockForRead();
    retval = store.write((char *)tile->data(), tileDataSize);
    tile->unlockForRead();
 
    return retval;
}

References KisSharedPtr< T >::data(), KisTile::data(), KisTile::lockForRead(), maxHeaderLength(), KisTile::pixelSize(), TILE_DATA_SIZE, KisTile::unlockForRead(), KisPaintDeviceWriter::write(), and writeHeader().

---

The documentation for this class was generated from the following files:

• libs/image/tiles3/swap/kis_legacy_tile_compressor.h
• libs/image/tiles3/swap/kis_legacy_tile_compressor.cpp