loader.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
#ifdef NOT_USERSPACE
#   error This is a userspace-only header, not allowed by the current build.
#endif

#include <sifteo/asset/group.h>
#include <sifteo/math.h>
#include <sifteo/array.h>
#include <sifteo/abi.h>

namespace Sifteo {

class Volume;

struct AssetConfigurationNode {
    _SYSAssetConfiguration sys;

    /*
     * @brief Initialize this node with an AssetSlot and AssetGroup
     *
     * This initializes the AssetConfigurationNode with instructions for
     * the AssetLoader to make sure the AssetGroup 'group' is available in the AssetSlot
     * 'slot' by the time the load finishes.
     *
     * If the AssetGroup is part of a different Volume, you must provide that volume
     * handle as the 'volume' parameter, and the 'group' must be mapped via MappedVolume.
     * If you are loading assets packaged with your own game, you do not need to provide
     * a volume.
     */
    void init(_SYSAssetSlot slot, AssetGroup &group, _SYSVolumeHandle volume = 0)
    {
        sys.pGroup = reinterpret_cast<uintptr_t>(&group);
        sys.volume = volume;
        sys.dataSize = group.compressedSize();
        sys.numTiles = group.numTiles();
        sys.ordinal = group.sysHeader()->ordinal;
        sys.slot = slot;
    }

    AssetSlot slot() const {
        return AssetSlot(sys.slot);
    }

    AssetGroup *group() const {
        return reinterpret_cast<AssetGroup*>(sys.pGroup);
    }

    _SYSVolumeHandle volume() const {
        return sys.volume;
    }

    unsigned numTiles() const {
        return sys.numTiles;
    }

    unsigned tileAllocation() const {
        return roundup<unsigned>(numTiles(), _SYS_ASSET_GROUP_SIZE_UNIT);
    }

    unsigned compressedSize() const {
        return sys.dataSize;
    }
};


template <unsigned tCapacity>
class AssetConfiguration : public Array<AssetConfigurationNode, tCapacity, uint8_t> {
    typedef Array<AssetConfigurationNode, tCapacity, uint8_t> super;
public:

    void append(_SYSAssetSlot slot, AssetGroup &group, _SYSVolumeHandle volume = 0)
    {
        super::append().init(slot, group, volume);
    }
};


struct AssetLoader {
    _SYSAssetLoader sys;
    _SYSAssetLoaderCube cubes[CUBE_ALLOCATION];

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

    void init() {
        bzero(*this);
    }

    void finish() {
        _SYS_asset_loadFinish(*this);
    }

    void cancel(_SYSCubeIDVector cubes = -1) {
        _SYS_asset_loadCancel(*this, cubes);
    }

    template < typename T >
    void start(T& configuration, _SYSCubeIDVector cubes = -1)
    {
        // Limit to cubes that we've allocated _SYSAssetLoaderCubes for
        STATIC_ASSERT(CUBE_ALLOCATION <= _SYS_NUM_CUBE_SLOTS);
        cubes &= 0xFFFFFFFF << (32 - CUBE_ALLOCATION);
        _SYS_asset_loadStart(*this, &configuration.begin()->sys, configuration.count(), cubes);
    }

    unsigned cubeProgress(_SYSCubeID cubeID, unsigned max) const
    {
        ASSERT(cubeID < CUBE_ALLOCATION);
        // NB: Division by zero on ARM (udiv) yields zero.
        return cubes[cubeID].progress * max / cubes[cubeID].total;
    }

    float cubeProgress(_SYSCubeID cubeID) const
    {
        ASSERT(cubeID < CUBE_ALLOCATION);
        unsigned progress = cubes[cubeID].progress;
        unsigned total = cubes[cubeID].total;
        return total ? (progress / float(total)) : 0.0f;
    }

    unsigned averageProgress(unsigned max) const
    {
        unsigned progress = 0, total = 0;
        for (unsigned i = 0; i < CUBE_ALLOCATION; ++i) {
            progress += cubes[i].progress;
            total += cubes[i].total;
        }
        return progress * max / total;
    }

    float averageProgress() const
    {
        unsigned progress = 0, total = 0;
        for (unsigned i = 0; i < CUBE_ALLOCATION; ++i) {
            progress += cubes[i].progress;
            total += cubes[i].total;
        }
        return total ? (progress / float(total)) : 0.0f;
    }

    _SYSCubeIDVector busyCubes() const {
        return sys.busyCubes;
    }

    bool isComplete(_SYSCubeIDVector vec) const {
        return (sys.busyCubes & vec) == 0;
    }
    
    bool isComplete(_SYSCubeID cubeID) const {
        return isComplete(_SYSCubeIDVector(0x80000000 >> cubeID));
    }

    bool isComplete() const {
        return sys.busyCubes == 0;
    }
};


class ScopedAssetLoader : public AssetLoader {
public:
    ScopedAssetLoader() { init(); }
    ~ScopedAssetLoader() { finish(); }
};

};  // namespace Sifteo