asset_manager.h revision 90887627f185ea795fd8620bb916bd14a9f51041
1e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/* 2e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Copyright (C) 2010 The Android Open Source Project 3e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 4e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Licensed under the Apache License, Version 2.0 (the "License"); 5e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * you may not use this file except in compliance with the License. 6e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * You may obtain a copy of the License at 7e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 8e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * http://www.apache.org/licenses/LICENSE-2.0 9e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 10e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Unless required by applicable law or agreed to in writing, software 11e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * distributed under the License is distributed on an "AS IS" BASIS, 12e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * See the License for the specific language governing permissions and 14e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * limitations under the License. 15e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 16e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 17e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 18e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn#ifndef ANDROID_ASSET_MANAGER_H 19e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn#define ANDROID_ASSET_MANAGER_H 20e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 2190887627f185ea795fd8620bb916bd14a9f51041David 'Digit' Turner#ifdef __cplusplus 2290887627f185ea795fd8620bb916bd14a9f51041David 'Digit' Turnerextern "C" { 2390887627f185ea795fd8620bb916bd14a9f51041David 'Digit' Turner#endif 24e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 25e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornstruct AAssetManager; 26e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborntypedef struct AAssetManager AAssetManager; 27e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 28e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornstruct AAssetDir; 29e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborntypedef struct AAssetDir AAssetDir; 30e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 31e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornstruct AAsset; 32e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborntypedef struct AAsset AAsset; 33e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 34e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/* Available modes for opening assets */ 35e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornenum { 36e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn AASSET_MODE_UNKNOWN = 0, 37e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn AASSET_MODE_RANDOM = 1, 38e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn AASSET_MODE_STREAMING = 2, 39e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn AASSET_MODE_BUFFER = 3 40e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn}; 41e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 42e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 43e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 44e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Open the named directory within the asset hierarchy. The directory can then 45e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * be inspected with the AAssetDir functions. To open the top-level directory, 46e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * pass in "" as the dirName. 47e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 48e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * The object returned here should be freed by calling AAssetDir_close(). 49e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 50e551875b2d82ed2709a28e046759523cb87ba2e2Dianne HackbornAAssetDir* AAssetManager_openDir(AAssetManager* mgr, const char* dirName); 51e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 52e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 53e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Open an asset. 54e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 55e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * The object returned here should be freed by calling AAsset_close(). 56e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 57e551875b2d82ed2709a28e046759523cb87ba2e2Dianne HackbornAAsset* AAssetManager_open(AAssetManager* mgr, const char* filename, int mode); 58e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 59e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 60e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Iterate over the files in an asset directory. A NULL string is returned 61e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * when all the file names have been returned. 62e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 63e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * The returned file name is suitable for passing to AAssetManager_open(). 64e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 65e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * The string returned here is owned by the AssetDir implementation and is not 66e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * guaranteed to remain valid if any other calls are made on this AAssetDir 67e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * instance. 68e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 69e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornconst char* AAssetDir_getNextFileName(AAssetDir* assetDir); 70e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 71e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 72e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Reset the iteration state of AAssetDir_getNextFileName() to the beginning. 73e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 74e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornvoid AAssetDir_rewind(AAssetDir* assetDir); 75e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 76e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 77e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Close an opened AAssetDir, freeing any related resources. 78e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 79e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornvoid AAssetDir_close(AAssetDir* assetDir); 80e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 81e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 82e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Attempt to read 'count' bytes of data from the current offset. 83e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 84e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Returns the number of bytes read, zero on EOF, or < 0 on error. 85e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 86e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornint AAsset_read(AAsset* asset, void* buf, size_t count); 87e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 88e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 89e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Seek to the specified offset within the asset data. 'whence' uses the 90e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * same constants as lseek()/fseek(). 91e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 92e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Returns the new position on success, or (off_t) -1 on error. 93e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 94e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornoff_t AAsset_seek(AAsset* asset, off_t offset, int whence); 95e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 96e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 97e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Close the asset, freeing all associated resources. 98e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 99e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornvoid AAsset_close(AAsset* asset); 100e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 101e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 102e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Get a pointer to a buffer holding the entire contents of the assset. 103e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 104e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Returns NULL on failure. 105e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 106e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornconst void* AAsset_getBuffer(AAsset* asset); 107e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 108e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 109e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Report the total size of the asset data. 110e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 111e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornoff_t AAsset_getLength(AAsset* asset); 112e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 113e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 114e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Report the total amount of asset data that can be read from the current position. 115e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 116e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornoff_t AAsset_getRemainingLength(AAsset* asset); 117e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 118e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 119e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Open a new file descriptor that can be used to read the asset data. 120e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * 121e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Returns < 0 if direct fd access is not possible (for example, if the asset is 122e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * compressed). 123e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 124e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornint AAsset_openFileDescriptor(AAsset* asset, off_t* outStart, off_t* outLength); 125e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 126e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn/** 127e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * Returns whether this asset's internal buffer is allocated in ordinary RAM (i.e. not 128e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn * mmapped). 129e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn */ 130e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackbornint AAsset_isAllocated(AAsset* asset); 131e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 132e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 133e551875b2d82ed2709a28e046759523cb87ba2e2Dianne Hackborn 13490887627f185ea795fd8620bb916bd14a9f51041David 'Digit' Turner#ifdef __cplusplus 13590887627f185ea795fd8620bb916bd14a9f51041David 'Digit' Turner}; 13690887627f185ea795fd8620bb916bd14a9f51041David 'Digit' Turner#endif 13790887627f185ea795fd8620bb916bd14a9f51041David 'Digit' Turner 13890887627f185ea795fd8620bb916bd14a9f51041David 'Digit' Turner#endif // ANDROID_ASSET_MANAGER_H 139