Ykkrosh
1706363bab
Also delete some unused declarations, and rename is_playing to snd_is_playing. This was SVN commit r7813.
105 lines
3.1 KiB
C++
105 lines
3.1 KiB
C++
/* Copyright (c) 2010 Wildfire Games
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/*
|
|
* cache for aligned I/O blocks.
|
|
*/
|
|
|
|
#ifndef INCLUDED_BLOCK_CACHE
|
|
#define INCLUDED_BLOCK_CACHE
|
|
|
|
/**
|
|
* ID that uniquely identifies a block within a file
|
|
**/
|
|
class BlockId
|
|
{
|
|
public:
|
|
BlockId();
|
|
BlockId(const fs::wpath& pathname, off_t ofs);
|
|
bool operator==(const BlockId& rhs) const;
|
|
bool operator!=(const BlockId& rhs) const;
|
|
|
|
private:
|
|
u64 m_id;
|
|
};
|
|
|
|
|
|
/**
|
|
* cache of (aligned) file blocks with support for zero-copy IO.
|
|
* absorbs the overhead of rounding up archive IOs to the nearest block
|
|
* boundaries by keeping the last few blocks in memory.
|
|
*
|
|
* the interface is somewhat similar to FileCache; see the note there.
|
|
*
|
|
* not thread-safe (each thread is intended to have its own cache).
|
|
**/
|
|
class BlockCache
|
|
{
|
|
public:
|
|
/**
|
|
* @param numBlocks (the default value is enough to support temp buffers
|
|
* and absorb the cost of unaligned reads from archives.)
|
|
**/
|
|
BlockCache(size_t numBlocks = 16);
|
|
|
|
/**
|
|
* Add a block to the cache.
|
|
*
|
|
* @param id Key that will be used to Retrieve the block.
|
|
* @param buf
|
|
*
|
|
* Call this when the block's IO has completed; its data will
|
|
* satisfy subsequent Retrieve calls for the same id.
|
|
* If CONFIG2_CACHE_READ_ONLY, the memory is made read-only.
|
|
**/
|
|
void Add(BlockId id, const shared_ptr<u8>& buf);
|
|
|
|
/**
|
|
* Attempt to retrieve a block's contents.
|
|
*
|
|
* @return whether the block is in cache.
|
|
*
|
|
* if successful, a shared pointer to the contents is returned.
|
|
* they remain valid until all references are removed and the block
|
|
* is evicted.
|
|
**/
|
|
bool Retrieve(BlockId id, shared_ptr<u8>& buf);
|
|
|
|
/**
|
|
* Invalidate the contents of the cache.
|
|
*
|
|
* this effectively discards the contents of existing blocks
|
|
* (more specifically: prevents them from satisfying Retrieve calls
|
|
* until a subsequent Add with the same id).
|
|
*
|
|
* useful for self-tests: multiple independent IO tests run in the same
|
|
* process and must not influence each other via the cache.
|
|
**/
|
|
void InvalidateAll();
|
|
|
|
private:
|
|
class Impl;
|
|
shared_ptr<Impl> impl;
|
|
};
|
|
|
|
#endif // #ifndef INCLUDED_BLOCK_CACHE
|