thorvg/src/loaders/tvg/tvgTvgLoadParser.cpp

/*
 * Copyright (c) 2021 Samsung Electronics Co., Ltd. All rights reserved.

 * 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.
 */

#include <memory.h>
#include "tvgTvgLoadParser.h"


/************************************************************************/
/* Internal Class Implementation                                        */
/************************************************************************/

struct TvgBinBlock
{
    TvgIndicator type;
    ByteCounter length;
    const char* data;
    const char* end;
};

#define _read_tvg_ui32(dst, src) memcpy(dst, (src), sizeof(uint32_t))
#define _read_tvg_float(dst, src) memcpy(dst, (src), sizeof(float))

enum class LoaderResult { Success = 0, InvalidType, SizeCorruption, MemoryCorruption, LogicalCorruption };

static Paint* _parsePaint(TvgBinBlock block);


static bool _paintProperty(TvgBinBlock block)
{
    switch (block.type) {
        case TVG_PAINT_OPACITY_INDICATOR:
        case TVG_PAINT_TRANSFORM_MATRIX_INDICATOR:
        case TVG_PAINT_CMP_TARGET_INDICATOR:
        return true;
    }
    return false;
}


static TvgBinBlock _readBlock(const char *ptr)
{
    TvgBinBlock block;
    block.type = *ptr;
    _read_tvg_ui32(&block.length, ptr + TVG_INDICATOR_SIZE);
    block.data = ptr + TVG_INDICATOR_SIZE + BYTE_COUNTER_SIZE;
    block.end = block.data + block.length;
    return block;
}

static bool _readTvgHeader(const char **ptr)
{
    if (!*ptr) return false;

    //Sign phase, always TVG_BIN_HEADER_SIGNATURE is declared
    if (memcmp(*ptr, TVG_BIN_HEADER_SIGNATURE, TVG_BIN_HEADER_SIGNATURE_LENGTH)) return false;
    *ptr += TVG_BIN_HEADER_SIGNATURE_LENGTH;

    //Version number, declared in TVG_BIN_HEADER_VERSION
    if (memcmp(*ptr, TVG_BIN_HEADER_VERSION, TVG_BIN_HEADER_VERSION_LENGTH)) return false;
    *ptr += TVG_BIN_HEADER_VERSION_LENGTH;

    return true;
}


static LoaderResult _parseCmpTarget(const char *ptr, const char *end, Paint *paint)
{
    auto block = _readBlock(ptr);
    if (block.end > end) return LoaderResult::SizeCorruption;

    if (block.type != TVG_PAINT_CMP_METHOD_INDICATOR) return LoaderResult::LogicalCorruption;
    if (block.length != sizeof(TvgFlag)) return LoaderResult::SizeCorruption;

    CompositeMethod cmpMethod;

    switch (*block.data) {
        case TVG_PAINT_CMP_METHOD_CLIPPATH_FLAG: {
            cmpMethod = CompositeMethod::ClipPath;
            break;
        }
        case TVG_PAINT_CMP_METHOD_ALPHAMASK_FLAG: {
            cmpMethod = CompositeMethod::AlphaMask;
            break;
        }
        case TVG_PAINT_CMP_METHOD_INV_ALPHAMASK_FLAG: {
            cmpMethod = CompositeMethod::InvAlphaMask;
            break;
        }
        default: return LoaderResult::LogicalCorruption;
    }

    ptr = block.end;

    auto cmpBlock = _readBlock(ptr);
    if (cmpBlock.end > end) return LoaderResult::SizeCorruption;

    paint->composite(unique_ptr<Paint>(_parsePaint(cmpBlock)), cmpMethod);

    return LoaderResult::Success;
}


static LoaderResult _parsePaintProperty(TvgBinBlock block, Paint *paint)
{
    switch (block.type) {
        case TVG_PAINT_OPACITY_INDICATOR: {
            if (block.length != sizeof(uint8_t)) return LoaderResult::SizeCorruption;
            paint->opacity(*block.data);
            return LoaderResult::Success;
        }
        case TVG_PAINT_TRANSFORM_MATRIX_INDICATOR: {
            if (block.length != sizeof(Matrix)) return LoaderResult::SizeCorruption;
            Matrix matrix;
            memcpy(&matrix, block.data, sizeof(Matrix));
            if (paint->transform(matrix) != Result::Success) return LoaderResult::MemoryCorruption;
            return LoaderResult::Success;
        }
        case TVG_PAINT_CMP_TARGET_INDICATOR: {
            if (block.length < TVG_INDICATOR_SIZE + BYTE_COUNTER_SIZE) return LoaderResult::SizeCorruption;
            return _parseCmpTarget(block.data, block.end, paint);
        }
    }
    return LoaderResult::InvalidType;
}


static LoaderResult _parseScene(TvgBinBlock block, Paint *paint)
{
    auto scene = static_cast<Scene*>(paint);

    switch (block.type) {
        case TVG_SCENE_FLAG_RESERVEDCNT: {
            if (block.length != sizeof(uint32_t)) return LoaderResult::SizeCorruption;
            uint32_t reservedCnt;
            _read_tvg_ui32(&reservedCnt, block.data);
            scene->reserve(reservedCnt);
            return LoaderResult::Success;
        }
    }

    if (_paintProperty(block)) return _parsePaintProperty(block, scene);

    if (auto paint = _parsePaint(block)) {
        scene->push(unique_ptr<Paint>(paint));
        return LoaderResult::Success;
    }

    return LoaderResult::InvalidType;
}


static LoaderResult _parseShapePath(const char *ptr, const char *end, Shape *shape)
{
    //Shape Path
    uint32_t cmdCnt, ptsCnt;
    _read_tvg_ui32(&cmdCnt, ptr);
    ptr += sizeof(uint32_t);
    _read_tvg_ui32(&ptsCnt, ptr);
    ptr += sizeof(uint32_t);

    const PathCommand* cmds = (PathCommand*) ptr;
    ptr += sizeof(PathCommand) * cmdCnt;
    const Point* pts = (Point*) ptr;
    ptr += sizeof(Point) * ptsCnt;

    if (ptr > end) return LoaderResult::SizeCorruption;

    shape->appendPath(cmds, cmdCnt, pts, ptsCnt);
    return LoaderResult::Success;
}


static LoaderResult _parseShapeFill(const char *ptr, const char *end, Fill **fillOutside)
{
    unique_ptr<Fill> fillGrad;

    while (ptr < end) {
        auto block = _readBlock(ptr);
        if (block.end > end) return LoaderResult::SizeCorruption;

        switch (block.type) {
            case TVG_FILL_RADIAL_GRADIENT_INDICATOR: {
                if (block.length != 3 * sizeof(float)) return LoaderResult::SizeCorruption;

                auto ptr = block.data;
                float x, y, radius;

                _read_tvg_float(&x, ptr);
                ptr += sizeof(float);
                _read_tvg_float(&y, ptr);
                ptr += sizeof(float);
                _read_tvg_float(&radius, ptr);

                auto fillGradRadial = RadialGradient::gen();
                fillGradRadial->radial(x, y, radius);
                fillGrad = move(fillGradRadial);
                break;
            }
            case TVG_FILL_LINEAR_GRADIENT_INDICATOR: {
                if (block.length != 4 * sizeof(float)) return LoaderResult::SizeCorruption;

                auto ptr = block.data;
                float x1, y1, x2, y2;

                _read_tvg_float(&x1, ptr);
                ptr += sizeof(float);
                _read_tvg_float(&y1, ptr);
                ptr += sizeof(float);
                _read_tvg_float(&x2, ptr);
                ptr += sizeof(float);
                _read_tvg_float(&y2, ptr);

                auto fillGradLinear = LinearGradient::gen();
                fillGradLinear->linear(x1, y1, x2, y2);
                fillGrad = move(fillGradLinear);
                break;
            }
            case TVG_FILL_FILLSPREAD_INDICATOR: {
                if (!fillGrad) return LoaderResult::LogicalCorruption;
                if (block.length != sizeof(TvgFlag)) return LoaderResult::SizeCorruption;
                switch (*block.data) {
                    case TVG_FILL_FILLSPREAD_PAD_FLAG: {
                        fillGrad->spread(FillSpread::Pad);
                        break;
                    }
                    case TVG_FILL_FILLSPREAD_REFLECT_FLAG: {
                        fillGrad->spread(FillSpread::Reflect);
                        break;
                    }
                    case TVG_FILL_FILLSPREAD_REPEAT_FLAG: {
                        fillGrad->spread(FillSpread::Repeat);
                        break;
                    }
                }
                break;
            }
            case TVG_FILL_COLORSTOPS_INDICATOR: {
                if (!fillGrad) return LoaderResult::LogicalCorruption;
                if (block.length == 0 || block.length & 0x07) return LoaderResult::SizeCorruption;
                uint32_t stopsCnt = block.length >> 3; // 8 bytes per ColorStop
                if (stopsCnt > 1023) return LoaderResult::SizeCorruption;
                Fill::ColorStop stops[stopsCnt];
                auto p = block.data;
                for (uint32_t i = 0; i < stopsCnt; i++, p += 8) {
                    _read_tvg_float(&stops[i].offset, p);
                    stops[i].r = p[4];
                    stops[i].g = p[5];
                    stops[i].b = p[6];
                    stops[i].a = p[7];
                }
                fillGrad->colorStops(stops, stopsCnt);
                break;
            }
        }
        ptr = block.end;
    }
    *fillOutside = fillGrad.release();
    return LoaderResult::Success;
}


static LoaderResult _parseShapeStrokeDashPattern(const char *ptr, const char *end, Shape *shape)
{
    uint32_t dashPatternCnt;
    _read_tvg_ui32(&dashPatternCnt, ptr);
    ptr += sizeof(uint32_t);
    const float* dashPattern = (float*) ptr;
    ptr += sizeof(float) * dashPatternCnt;

    if (ptr > end) return LoaderResult::SizeCorruption;

    shape->stroke(dashPattern, dashPatternCnt);
    return LoaderResult::Success;
}


static LoaderResult _parseShapeStroke(const char *ptr, const char *end, Shape *shape)
{
    while (ptr < end) {
        auto block = _readBlock(ptr);
        if (block.end > end) return LoaderResult::SizeCorruption;

        switch (block.type) {
            case TVG_SHAPE_STROKE_CAP_INDICATOR: {
                if (block.length != sizeof(TvgFlag)) return LoaderResult::SizeCorruption;
                switch (*block.data) {
                    case TVG_SHAPE_STROKE_CAP_SQUARE_FLAG:
                        shape->stroke(StrokeCap::Square);
                        break;
                    case TVG_SHAPE_STROKE_CAP_ROUND_FLAG:
                        shape->stroke(StrokeCap::Round);
                        break;
                    case TVG_SHAPE_STROKE_CAP_BUTT_FLAG:
                        shape->stroke(StrokeCap::Butt);
                        break;
                }
                break;
            }
            case TVG_SHAPE_STROKE_JOIN_INDICATOR: {
                if (block.length != sizeof(TvgFlag)) return LoaderResult::SizeCorruption;
                switch (*block.data) {
                    case TVG_SHAPE_STROKE_JOIN_BEVEL_FLAG:
                        shape->stroke(StrokeJoin::Bevel);
                        break;
                    case TVG_SHAPE_STROKE_JOIN_ROUND_FLAG:
                        shape->stroke(StrokeJoin::Round);
                        break;
                    case TVG_SHAPE_STROKE_JOIN_MITER_FLAG:
                        shape->stroke(StrokeJoin::Miter);
                        break;
                }
                break;
            }
            case TVG_SHAPE_STROKE_WIDTH_INDICATOR: {
                if (block.length != sizeof(float)) return LoaderResult::SizeCorruption;
                float width;
                _read_tvg_float(&width, block.data);
                shape->stroke(width);
                break;
            }
            case TVG_SHAPE_STROKE_COLOR_INDICATOR: {
                if (block.length != 4) return LoaderResult::SizeCorruption;
                shape->stroke(block.data[0], block.data[1], block.data[2], block.data[3]);
                break;
            }
            case TVG_SHAPE_STROKE_FILL_INDICATOR: {
                Fill* fill;
                auto result = _parseShapeFill(block.data, block.end, &fill);
                if (result != LoaderResult::Success) return result;
                shape->stroke(unique_ptr < Fill > (fill));
                break;
            }
            case TVG_SHAPE_STROKE_DASHPTRN_INDICATOR: {
                auto result = _parseShapeStrokeDashPattern(block.data, block.end, shape);
                if (result != LoaderResult::Success) return result;
                break;
            }
        }
        ptr = block.end;
    }
    return LoaderResult::Success;
}


static LoaderResult _parseShape(TvgBinBlock block, Paint* paint)
{
    auto shape = static_cast<Shape*>(paint);

    switch (block.type) {
        case TVG_SHAPE_PATH_INDICATOR: {
            auto result = _parseShapePath(block.data, block.end, shape);
            if (result != LoaderResult::Success) return result;
            break;
        }
        case TVG_SHAPE_STROKE_INDICATOR: {
            auto result = _parseShapeStroke(block.data, block.end, shape);
            if (result != LoaderResult::Success) return result;
            break;
        }
        case TVG_SHAPE_FILL_INDICATOR: {
            Fill* fill;
            auto result = _parseShapeFill(block.data, block.end, &fill);
            if (result != LoaderResult::Success) return result;
            shape->fill(unique_ptr < Fill > (fill));
            break;
        }
        case TVG_SHAPE_COLOR_INDICATOR: {
            if (block.length != 4) return LoaderResult::SizeCorruption;
            shape->fill(block.data[0], block.data[1], block.data[2], block.data[3]);
            break;
        }
        case TVG_SHAPE_FILLRULE_INDICATOR: {
            if (block.length != sizeof(TvgFlag)) return LoaderResult::SizeCorruption;
            switch (*block.data) {
                case TVG_SHAPE_FILLRULE_WINDING_FLAG:
                    shape->fill(FillRule::Winding);
                    break;
                case TVG_SHAPE_FILLRULE_EVENODD_FLAG:
                    shape->fill(FillRule::EvenOdd);
                    break;
            }
            break;
        }
        default: return _parsePaintProperty(block, shape);
    }
    return LoaderResult::Success;
}


static LoaderResult _parsePicture(TvgBinBlock block, Paint* paint)
{
    auto picture = static_cast<Picture*>(paint);

    switch (block.type) {
        case TVG_RAW_IMAGE_BEGIN_INDICATOR: {
            if (block.length < 2 * sizeof(uint32_t)) return LoaderResult::SizeCorruption;

            auto ptr = block.data;
            uint32_t w, h;

            _read_tvg_ui32(&w, ptr);
            ptr += sizeof(uint32_t);
            _read_tvg_ui32(&h, ptr);
            ptr += sizeof(uint32_t);

            auto size = w * h * sizeof(uint32_t);
            if (block.length != 2 * sizeof(uint32_t) + size) return LoaderResult::SizeCorruption;

            auto pixels = (uint32_t*) ptr;
            picture->load(pixels, w, h, true);
            return LoaderResult::Success;
        }
    }

    if (_paintProperty(block)) return _parsePaintProperty(block, picture);

    if (auto paint = _parsePaint(block)) {
        picture->paint(unique_ptr<Paint>(paint));
        return LoaderResult::Success;
    }

    return LoaderResult::InvalidType;
}


static Paint* _parsePaint(TvgBinBlock baseBlock)
{
    LoaderResult (*parser)(TvgBinBlock, Paint*);
    Paint *paint = nullptr;

    switch (baseBlock.type) {
        case TVG_SCENE_BEGIN_INDICATOR: {
            paint = Scene::gen().release();
            parser = _parseScene;
            break;
        }
        case TVG_SHAPE_BEGIN_INDICATOR: {
            paint = Shape::gen().release();
            parser = _parseShape;
            break;
        }
        case TVG_PICTURE_BEGIN_INDICATOR: {
            paint = Picture::gen().release();
            parser = _parsePicture;
            break;
        }
        default: return nullptr;
    }

    auto ptr = baseBlock.data;

    while (ptr < baseBlock.end) {
        auto block = _readBlock(ptr);
        if (block.end > baseBlock.end) return paint;
        auto result = parser(block, paint);
        if (result != LoaderResult::Success && result != LoaderResult::InvalidType) return paint;
        ptr = block.end;
    }
    return paint;
}


/************************************************************************/
/* External Class Implementation                                        */
/************************************************************************/

bool tvgValidateData(const char *ptr, uint32_t size)
{
    auto end = ptr + size;
    if (!_readTvgHeader(&ptr) || ptr >= end) return false;
    return true;
}

unique_ptr<Scene> tvgLoadData(const char *ptr, uint32_t size)
{
    auto end = ptr + size;

    if (!_readTvgHeader(&ptr) || ptr >= end) {
#ifdef THORVG_LOG_ENABLED
        printf("TVG_LOADER: Invalid TVG Data!\n");
#endif
        return nullptr;
    }

    auto scene = Scene::gen();
    if (!scene) return nullptr;

    while (ptr < end) {
        auto block = _readBlock(ptr);
        if (block.end > end) return nullptr;
        scene->push(unique_ptr<Paint>(_parsePaint(block)));
        ptr = block.end;
    }

    return move(scene);
}