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

#ifndef _SIFTEO_ABI_ASSET_H
#define _SIFTEO_ABI_ASSET_H

#include <sifteo/abi/types.h>

#ifdef __cplusplus
extern "C" {
#endif


#define _SYS_ASSETLOAD_BUF_SIZE     48      // Makes _SYSAssetLoaderCube come to 64 bytes
#define _SYS_MAX_ASSET_SLOTS        4       // Number of AssetSlots maximum per-program
#define _SYS_TILES_PER_ASSETSLOT    4096    // Number of tiles per AssetSlot
#define _SYS_ASSET_GROUPS_PER_SLOT  24      // Number of AssetGroups we can track per-slot
#define _SYS_ASSET_SLOTS_PER_BANK   4       // Number of AssetSlots maximum per-program
#define _SYS_ASSET_GROUP_SIZE_UNIT  16      // Basic unit of AssetGroup allocation, in tiles
#define _SYS_ASSET_GROUP_CRC_SIZE   16      // Number of bytes of AssetGroup CRC


struct _SYSAssetGroupHeader {
    uint8_t reserved;                       
    uint8_t ordinal;                        
    uint16_t numTiles;                      
    uint32_t dataSize;                      
    uint8_t crc[_SYS_ASSET_GROUP_CRC_SIZE]; 
    // Followed by compressed data
};

struct _SYSAssetGroupCube {
    uint16_t baseAddr;          
};

struct _SYSAssetGroup {
    uint32_t pHdr;              
    // Followed by a _SYSAssetGroupCube array
};

struct _SYSAssetLoaderCube {
    uint32_t progress;      
    uint32_t total;         
    uint16_t reserved;      
    uint8_t head;           
    uint8_t tail;           
    uint8_t buf[_SYS_ASSETLOAD_BUF_SIZE];
};

struct _SYSAssetLoader {
    _SYSCubeIDVector busyCubes; 
    // Followed by a _SYSAssetLoaderCube array
};

struct _SYSAssetConfiguration {
    uint32_t pGroup;            
    _SYSVolumeHandle volume;    
    uint32_t dataSize;          
    uint16_t numTiles;          
    uint8_t ordinal;            
    _SYSAssetSlot slot;         
};

enum _SYSAssetImageFormat {
    _SYS_AIF_PINNED = 0,        
    _SYS_AIF_FLAT,              
    _SYS_AIF_DUB_I8,            
    _SYS_AIF_DUB_I16,           
};

struct _SYSAssetImage {
    uint32_t pAssetGroup;       
    uint16_t width;             
    uint16_t height;            
    uint16_t frames;            
    uint8_t  format;            
    uint8_t  reserved;          
    uint32_t pData;             
};


#ifdef __cplusplus
}  // extern "C"
#endif

#endif