image.h

/* -*- mode: C; c-basic-offset: 4; intent-tabs-mode: nil -*-
 *
 * Sifteo SDK
 *
 * Copyright <c> 2012 Sifteo, Inc.
 *
 * 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

/*
 * This header needs to work in both userspace and non-userspace
 * builds, though the latter have a greatly reduced feature set.
 */

#ifndef NOT_USERSPACE
#   include <sifteo/math.h>
#   include <sifteo/macros.h>
#   include <sifteo/asset/group.h>
#endif

#include <sifteo/abi.h>

namespace Sifteo {

struct AssetImage {
    _SYSAssetImage sys;

#ifndef NOT_USERSPACE   // Begin userspace-only members

    AssetGroup &assetGroup() const { return *reinterpret_cast<AssetGroup*>(sys.pAssetGroup); }

    Int2 tileSize() const { return vec<int>(sys.width, sys.height); }

    Int2 tileExtent() const { return tileSize() / 2; }

    Int2 pixelSize() const { return vec<int>(sys.width << 3, sys.height << 3); }

    Int2 pixelExtent() const { return pixelSize() / 2; }

#endif   // End userspace-only members

    int tileWidth() const { return sys.width; }

    int tileHeight() const { return sys.height; }

    int pixelWidth() const { return sys.width << 3; }

    int pixelHeight() const { return sys.height << 3; }

    int numFrames() const { return sys.frames; }

    int numTilesPerFrame() const { return tileWidth() * tileHeight(); }

    int numTiles() const { return numFrames() * numTilesPerFrame(); }
    
    operator const _SYSAssetImage& () const { return sys; }
    operator _SYSAssetImage& () { return sys; }
    operator const _SYSAssetImage* () const { return &sys; }
    operator _SYSAssetImage* () { return &sys; }
};


struct PinnedAssetImage {
    _SYSAssetImage sys;

#ifndef NOT_USERSPACE   // Begin userspace-only members

    AssetGroup &assetGroup() const { return *reinterpret_cast<AssetGroup*>(sys.pAssetGroup); }

    Int2 tileSize() const { return vec<int>(sys.width, sys.height); }

    Int2 tileExtent() const { return tileSize() / 2; }

    Int2 pixelSize() const { return vec<int>(sys.width << 3, sys.height << 3); }

    Int2 pixelExtent() const { return pixelSize() / 2; }

    uint16_t tile(unsigned i) const {
        ASSERT(i < numTiles());
        return sys.pData + i;
    }

    uint16_t tile(Int2 pos, unsigned frame = 0) const {
        ASSERT(pos.x < tileWidth() && pos.y < tileHeight() && frame < numFrames());
        return sys.pData + pos.x + pos.y * tileHeight() + frame * numTilesPerFrame();
    }

    uint16_t tile(_SYSCubeID cube, unsigned i) const {
        ASSERT(i < numTiles());
        return assetGroup().baseAddress(cube) + sys.pData + i;
    }

    uint16_t tile(_SYSCubeID cube, Int2 pos, unsigned frame = 0) const {
        ASSERT(pos.x < tileWidth() && pos.y < tileHeight() && frame < numFrames());
        return assetGroup().baseAddress(cube) + sys.pData
            + pos.x + pos.y * tileHeight() + frame * numTilesPerFrame();
    }

#endif   // End userspace-only members

    int tileWidth() const { return sys.width; }

    int tileHeight() const { return sys.height; }

    int pixelWidth() const { return sys.width << 3; }

    int pixelHeight() const { return sys.height << 3; }

    int numFrames() const { return sys.frames; }

    int numTilesPerFrame() const { return tileWidth() * tileHeight(); }

    int numTiles() const { return numFrames() * numTilesPerFrame(); }

    operator const AssetImage& () const { return *reinterpret_cast<const AssetImage*>(this); }
    operator AssetImage& () { return *reinterpret_cast<AssetImage*>(this); }
    operator const AssetImage* () const { return reinterpret_cast<const AssetImage*>(this); }
    operator AssetImage* () { return reinterpret_cast<AssetImage*>(this); }

    operator const _SYSAssetImage& () const { return sys; }
    operator _SYSAssetImage& () { return sys; }
    operator const _SYSAssetImage* () const { return &sys; }
    operator _SYSAssetImage* () { return &sys; }
};


struct FlatAssetImage {
    _SYSAssetImage sys;

#ifndef NOT_USERSPACE   // Begin userspace-only members

    AssetGroup &assetGroup() const { return *reinterpret_cast<AssetGroup*>(sys.pAssetGroup); }

    Int2 tileSize() const { return vec<int>(sys.width, sys.height); }

    Int2 tileExtent() const { return tileSize() / 2; }

    Int2 pixelSize() const { return vec<int>(sys.width << 3, sys.height << 3); }

    Int2 pixelExtent() const { return pixelSize() / 2; }

    const uint16_t *tileArray() const {
        return reinterpret_cast<const uint16_t *>(sys.pData);
    }

    uint16_t tile(unsigned i) const {
        ASSERT(i < numTiles());
        return tileArray()[i];
    }

    uint16_t tile(Int2 pos, unsigned frame = 0) const {
        ASSERT(pos.x < tileWidth() && pos.y < tileHeight() && frame < numFrames());
        return tileArray()[pos.x + pos.y * tileHeight() + frame * numTilesPerFrame()];
    }

    uint16_t tile(_SYSCubeID cube, unsigned i) const {
        ASSERT(i < numTiles());
        return assetGroup().baseAddress(cube) + tileArray()[i];
    }

    uint16_t tile(_SYSCubeID cube, Int2 pos, unsigned frame = 0) const {
        ASSERT(pos.x < tileWidth() && pos.y < tileHeight() && frame < numFrames());
        return assetGroup().baseAddress(cube) + tileArray()[
            pos.x + pos.y * tileHeight() + frame * numTilesPerFrame()];
    }

#endif   // End userspace-only members

    int tileWidth() const { return sys.width; }

    int tileHeight() const { return sys.height; }

    int pixelWidth() const { return sys.width << 3; }

    int pixelHeight() const { return sys.height << 3; }

    int numFrames() const { return sys.frames; }

    int numTilesPerFrame() const { return tileWidth() * tileHeight(); }

    int numTiles() const { return numFrames() * numTilesPerFrame(); }

    operator const AssetImage& () const { return *reinterpret_cast<const AssetImage*>(this); }
    operator AssetImage& () { return *reinterpret_cast<AssetImage*>(this); }
    operator const AssetImage* () const { return reinterpret_cast<const AssetImage*>(this); }
    operator AssetImage* () { return reinterpret_cast<AssetImage*>(this); }

    operator const _SYSAssetImage& () const { return sys; }
    operator _SYSAssetImage& () { return sys; }
    operator const _SYSAssetImage* () const { return &sys; }
    operator _SYSAssetImage* () { return &sys; }
};

};  // namespace Sifteo