Asset.h revision d1ecd7af687bcad0f87c37fe33515ff6c5ea0f1d
1e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman/* 2e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Copyright (C) 2006 The Android Open Source Project 3e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 4e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Licensed under the Apache License, Version 2.0 (the "License"); 5e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * you may not use this file except in compliance with the License. 6e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * You may obtain a copy of the License at 7e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 8e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * http://www.apache.org/licenses/LICENSE-2.0 9e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 10e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Unless required by applicable law or agreed to in writing, software 11e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * distributed under the License is distributed on an "AS IS" BASIS, 12e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * See the License for the specific language governing permissions and 14e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * limitations under the License. 15e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 16e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 17e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman// 18e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman// Class providing access to a read-only asset. Asset objects are NOT 19e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman// thread-safe, and should not be shared across threads. 20e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman// 21e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#ifndef __LIBS_ASSET_H 22e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#define __LIBS_ASSET_H 23e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 24e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#include <stdio.h> 25e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#include <sys/types.h> 26e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 27e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#include <memory> 28e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 29e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#include <utils/Compat.h> 30e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#include <utils/Errors.h> 31e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#include <utils/String8.h> 32e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 33e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramannamespace android { 34e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 35e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanclass FileMap; 36e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 37e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman/* 38e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Instances of this class provide read-only operations on a byte stream. 39e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 40e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Access may be optimized for streaming, random, or whole buffer modes. All 41e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * operations are supported regardless of how the file was opened, but some 42e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * things will be less efficient. [pass that in??] 43e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 44e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * "Asset" is the base class for all types of assets. The classes below 45e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * provide most of the implementation. The AssetManager uses one of the 46e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * static "create" functions defined here to create a new instance. 47e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 48e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanclass Asset { 49e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanpublic: 50e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual ~Asset(void) = default; 51e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 52e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static int32_t getGlobalCount(); 53e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static String8 getAssetAllocations(); 54e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 55e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* used when opening an asset */ 56e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman typedef enum AccessMode { 57e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman ACCESS_UNKNOWN = 0, 58e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 59e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* read chunks, and seek forward and backward */ 60e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman ACCESS_RANDOM, 61e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 62e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* read sequentially, with an occasional forward seek */ 63e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman ACCESS_STREAMING, 64e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 65e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* caller plans to ask for a read-only buffer with all data */ 66e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman ACCESS_BUFFER, 67e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman } AccessMode; 68e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 69e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 70e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Read data from the current offset. Returns the actual number of 71e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * bytes read, 0 on EOF, or -1 on error. 72e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 73e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual ssize_t read(void* buf, size_t count) = 0; 74e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 75e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 76e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Seek to the specified offset. "whence" uses the same values as 77e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * lseek/fseek. Returns the new position on success, or (off64_t) -1 78e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * on failure. 79e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 80e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual off64_t seek(off64_t offset, int whence) = 0; 81e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 82e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 83e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Close the asset, freeing all associated resources. 84e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 85e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual void close(void) = 0; 86e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 87e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 88e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Get a pointer to a buffer with the entire contents of the file. 89e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 90e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual const void* getBuffer(bool wordAligned) = 0; 91e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 92e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 93e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Get the total amount of data that can be read. 94e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 95e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual off64_t getLength(void) const = 0; 96e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 97e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 98e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Get the total amount of data that can be read from the current position. 99e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 100e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual off64_t getRemainingLength(void) const = 0; 101e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 102e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 103e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Open a new file descriptor that can be used to read this asset. 104e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Returns -1 if you can not use the file descriptor (for example if the 105e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * asset is compressed). 106e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 107e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual int openFileDescriptor(off64_t* outStart, off64_t* outLength) const = 0; 108e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 109e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 110e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Return whether this asset's buffer is allocated in RAM (not mmapped). 111e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Note: not virtual so it is safe to call even when being destroyed. 112e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 113e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual bool isAllocated(void) const { return false; } 114e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 115e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 116e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Get a string identifying the asset's source. This might be a full 117e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * path, it might be a colon-separated list of identifiers. 118e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 119e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * This is NOT intended to be used for anything except debug output. 120e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * DO NOT try to parse this or use it to open a file. 121e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 122e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman const char* getAssetSource(void) const { return mAssetSource.string(); } 123e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 124e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanprotected: 125e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 126e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Adds this Asset to the global Asset list for debugging and 127e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * accounting. 128e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Concrete subclasses must call this in their constructor. 129e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 130e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static void registerAsset(Asset* asset); 131e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 132e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 133e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Removes this Asset from the global Asset list. 134e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Concrete subclasses must call this in their destructor. 135e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 136e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static void unregisterAsset(Asset* asset); 137e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 138e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman Asset(void); // constructor; only invoked indirectly 139e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 140e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* handle common seek() housekeeping */ 141e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman off64_t handleSeek(off64_t offset, int whence, off64_t curPosn, off64_t maxPosn); 142e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 143e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* set the asset source string */ 144e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman void setAssetSource(const String8& path) { mAssetSource = path; } 145e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 146e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman AccessMode getAccessMode(void) const { return mAccessMode; } 147e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 148e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanprivate: 149e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* these operations are not implemented */ 150e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman Asset(const Asset& src); 151e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman Asset& operator=(const Asset& src); 152e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 153e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* AssetManager needs access to our "create" functions */ 154e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman friend class AssetManager; 155e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman friend class ApkAssets; 156e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 157e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 158e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Create the asset from a named file on disk. 159e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 160e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static Asset* createFromFile(const char* fileName, AccessMode mode); 161e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 162e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 163e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Create the asset from a named, compressed file on disk (e.g. ".gz"). 164e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 165e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static Asset* createFromCompressedFile(const char* fileName, 166e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman AccessMode mode); 167e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 168e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#if 0 169e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 170e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Create the asset from a segment of an open file. This will fail 171e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * if "offset" and "length" don't fit within the bounds of the file. 172e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 173e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * The asset takes ownership of the file descriptor. 174e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 175e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static Asset* createFromFileSegment(int fd, off64_t offset, size_t length, 176e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman AccessMode mode); 177e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 178e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 179e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Create from compressed data. "fd" should be seeked to the start of 180e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * the compressed data. This could be inside a gzip file or part of a 181e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Zip archive. 182e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 183e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * The asset takes ownership of the file descriptor. 184e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 185e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * This may not verify the validity of the compressed data until first 186e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * use. 187e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 188e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static Asset* createFromCompressedData(int fd, off64_t offset, 189e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman int compressionMethod, size_t compressedLength, 190e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman size_t uncompressedLength, AccessMode mode); 191e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#endif 192e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 193e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 194e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Create the asset from a memory-mapped file segment. 195e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 196e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * The asset takes ownership of the FileMap. 197e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 198e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static Asset* createFromUncompressedMap(FileMap* dataMap, AccessMode mode); 199e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 200e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static std::unique_ptr<Asset> createFromUncompressedMap(std::unique_ptr<FileMap> dataMap, 201e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman AccessMode mode); 202e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 203e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 204e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Create the asset from a memory-mapped file segment with compressed 205e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * data. 206e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 207e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * The asset takes ownership of the FileMap. 208e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 209e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static Asset* createFromCompressedMap(FileMap* dataMap, 210e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman size_t uncompressedLen, AccessMode mode); 211e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 212e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman static std::unique_ptr<Asset> createFromCompressedMap(std::unique_ptr<FileMap> dataMap, 213e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman size_t uncompressedLen, AccessMode mode); 214e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 215e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 216e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 217e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Create from a reference-counted chunk of shared memory. 218e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 219e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // TODO 220e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 221e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman AccessMode mAccessMode; // how the asset was opened 222e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman String8 mAssetSource; // debug string 223e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 224e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman Asset* mNext; // linked list. 225e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman Asset* mPrev; 226e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman}; 227e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 228e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 229e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman/* 230e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * =========================================================================== 231e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 232e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Innards follow. Do not use these classes directly. 233e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 234e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 235e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman/* 236e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * An asset based on an uncompressed file on disk. It may encompass the 237e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * entire file or just a piece of it. Access is through fread/fseek. 238e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 239e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanclass _FileAsset : public Asset { 240e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanpublic: 241e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman _FileAsset(void); 242e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual ~_FileAsset(void); 243e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 244e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 245e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Use a piece of an already-open file. 246e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 247e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * On success, the object takes ownership of "fd". 248e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 249e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman status_t openChunk(const char* fileName, int fd, off64_t offset, size_t length); 250e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 251e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 252e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Use a memory-mapped region. 253e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 254e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * On success, the object takes ownership of "dataMap". 255e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 256e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman status_t openChunk(FileMap* dataMap); 257e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 258e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 259e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Standard Asset interfaces. 260e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 261e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual ssize_t read(void* buf, size_t count); 262e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual off64_t seek(off64_t offset, int whence); 263e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual void close(void); 264e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual const void* getBuffer(bool wordAligned); 265e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual off64_t getLength(void) const { return mLength; } 266e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual off64_t getRemainingLength(void) const { return mLength-mOffset; } 267e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual int openFileDescriptor(off64_t* outStart, off64_t* outLength) const; 268e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual bool isAllocated(void) const { return mBuf != NULL; } 269e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 270e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanprivate: 271e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman off64_t mStart; // absolute file offset of start of chunk 272e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman off64_t mLength; // length of the chunk 273e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman off64_t mOffset; // current local offset, 0 == mStart 274e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman FILE* mFp; // for read/seek 275e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman char* mFileName; // for opening 276e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 277e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 278e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * To support getBuffer() we either need to read the entire thing into 279e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * a buffer or memory-map it. For small files it's probably best to 280e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * just read them in. 281e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 282e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman enum { kReadVsMapThreshold = 4096 }; 283e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 284e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman FileMap* mMap; // for memory map 285e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman unsigned char* mBuf; // for read 286e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 287e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman const void* ensureAlignment(FileMap* map); 288e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman}; 289e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 290e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 291e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman/* 292e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * An asset based on compressed data in a file. 293e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 294e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanclass _CompressedAsset : public Asset { 295e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanpublic: 296e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman _CompressedAsset(void); 297e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual ~_CompressedAsset(void); 298e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 299e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 300e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Use a piece of an already-open file. 301e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 302e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * On success, the object takes ownership of "fd". 303e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 304e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman status_t openChunk(int fd, off64_t offset, int compressionMethod, 305e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman size_t uncompressedLen, size_t compressedLen); 306e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 307e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 308e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Use a memory-mapped region. 309e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 310e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * On success, the object takes ownership of "fd". 311e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 312e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman status_t openChunk(FileMap* dataMap, size_t uncompressedLen); 313e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 314e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman /* 315e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Standard Asset interfaces. 316e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 317e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual ssize_t read(void* buf, size_t count); 318e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual off64_t seek(off64_t offset, int whence); 319e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual void close(void); 320e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual const void* getBuffer(bool wordAligned); 321e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual off64_t getLength(void) const { return mUncompressedLen; } 322e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual off64_t getRemainingLength(void) const { return mUncompressedLen-mOffset; } 323e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual int openFileDescriptor(off64_t* /* outStart */, off64_t* /* outLength */) const { return -1; } 324e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual bool isAllocated(void) const { return mBuf != NULL; } 325e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 326e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanprivate: 327e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman off64_t mStart; // offset to start of compressed data 328e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman off64_t mCompressedLen; // length of the compressed data 329e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman off64_t mUncompressedLen; // length of the uncompressed data 330e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman off64_t mOffset; // current offset, 0 == start of uncomp data 331e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 332e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman FileMap* mMap; // for memory-mapped input 333e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman int mFd; // for file input 334e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 335e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman class StreamingZipInflater* mZipInflater; // for streaming large compressed assets 336e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 337e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman unsigned char* mBuf; // for getBuffer() 338e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman}; 339e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 340e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman// need: shared mmap version? 341e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 342e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman}; // namespace android 343e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 344e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#endif // __LIBS_ASSET_H 345e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman