metadata.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/abi.h>

namespace Sifteo {

class Metadata {
public:
    Metadata()
    {
        // Metadata that's automatically inserted only once
        if (_SYS_lti_counter("Sifteo.Metadata", 0) == 0) {

            // Count the total number of AssetGroupSlots in use
            unsigned numAGSlots = _SYS_lti_counter("Sifteo.AssetGroupSlot", -1);
            _SYS_lti_metadata(_SYS_METADATA_NUM_ASLOTS, "b", numAGSlots);

            // UUID for this particular build.
            _SYS_lti_metadata(_SYS_METADATA_UUID, "IIII",
                _SYS_lti_uuid(0, 0), _SYS_lti_uuid(0, 1),
                _SYS_lti_uuid(0, 2), _SYS_lti_uuid(0, 3));
        }
    }

    Metadata &title(const char *str)
    {
        _SYS_lti_abort(_SYS_lti_counter("Sifteo.Metadata.Title", 0) != 0,
            "Duplicate Metadata::title() instance.");

        _SYS_lti_metadata(_SYS_METADATA_TITLE_STR, "sB", str, 0);

        return *this;
    }

    Metadata &package(const char *pkg, const char *version)
    {
        _SYS_lti_abort(_SYS_lti_counter("Sifteo.Metadata.Package", 0) != 0,
            "Duplicate Metadata::package() instance.");

        _SYS_lti_metadata(_SYS_METADATA_PACKAGE_STR, "sB", pkg, 0);
        _SYS_lti_metadata(_SYS_METADATA_VERSION_STR, "sB", version, 0);

        return *this;
    }

    Metadata &isDemoOf(const char *fullAppPkgID)
    {
        _SYS_lti_abort(_SYS_lti_counter("Sifteo.Metadata.IsDemoOf", 0) != 0,
            "Duplicate Metadata::isDemoOf() instance.");

        _SYS_lti_metadata(_SYS_METADATA_IS_DEMO_OF_STR, "sB", fullAppPkgID, 0);

        return *this;
    }

    Metadata &icon(const _SYSAssetImage &i)
    {
        _SYS_lti_abort(_SYS_lti_counter("Sifteo.Metadata.Icon", 0) != 0,
            "Duplicate Metadata::icon() instance.");
        _SYS_lti_abort(i.width != 96/8 || i.height != 96/8,
            "Metadata::icon() image must be 96x96 pixels in size.");

        return image(_SYS_METADATA_ICON_96x96, i);
    }

    Metadata &image(uint16_t key, const _SYSAssetImage &i)
    {
        // AssetGroup is in RAM, but we want the static initializer data
        _SYSAssetGroup *G = (_SYSAssetGroup*) _SYS_lti_initializer(
            reinterpret_cast<const void*>(i.pAssetGroup), true);

        // Build a _SYSMetadataImage struct
        _SYS_lti_metadata(key, "BBBBII",
            i.width, i.height, i.frames, i.format, G->pHdr, i.pData);

        return *this;
    }

    Metadata &cubeRange(unsigned minCubes, unsigned maxCubes)
    {
        _SYS_lti_abort(_SYS_lti_counter("Sifteo.Metadata.CubeRange", 0) != 0,
            "Duplicate Metadata::cubeRange() instance.");
        _SYS_lti_abort(minCubes > _SYS_NUM_CUBE_SLOTS,
            "Minimum number of cubes is too high.");
        _SYS_lti_abort(maxCubes > _SYS_NUM_CUBE_SLOTS,
            "Maximum number of cubes is too high.");
        _SYS_lti_abort(minCubes > maxCubes,
            "Minimum number of cubes must be <= maximum number");

        _SYS_lti_metadata(_SYS_METADATA_CUBE_RANGE, "BB", minCubes, maxCubes);

        return *this;
    }

    Metadata &cubeRange(unsigned count)
    {
        return cubeRange(count, count);
    }

    Metadata &minimumOSVersion(uint32_t version)
    {
        _SYS_lti_abort((version & 0xff000000) != 0,
            "Metadata::minimumOSVersion(): invalid version. Must be of the form "
            "0xMMNNPP (MM = major, NN = minor, PP = patch).");

        _SYS_lti_metadata(_SYS_METADATA_MIN_OS_VERSION, "I", version);
        return *this;
    }
};

}   // namespace Sifteo