Description

The asset subsystem of the Steam-Layer.

Namespaces

Typedefs
typedef const ID< Asset > &	IDA

typedef std::unordered_map< size_t, PAsset, IdentityHash >	IdHashtable

typedef boost::variant< DoAttach, DoRecurse, DoConditional >	InstructEntry

typedef vector< BuildInstruct >	InstructionSequence

typedef lib::P< Asset >	PAsset

typedef lib::P< const Asset >	PcAsset

typedef lib::P< const asset::Clip >	PClipAsset

typedef lib::P< Inventory >	PInv

typedef lib::P< Meta >	PMeta

using	PPipe = lib::P< Pipe >

using	PProc = lib::P< const asset::Proc >

using	PProcPatt = lib::P< const asset::ProcPatt >

typedef lib::P< Sequence >	PSequence

typedef lib::P< Timeline >	PTimeline

typedef lib::P< Viewer >	PViewer

Enumerations
enum	Kind { AUDIO, VIDEO, EFFECT, CODEC, STRUCT, META }
	top-level distinction of different Kinds of Assets. More...

Classes
class	Asset
	Superinterface describing especially bookkeeping properties. More...

class	AssetManager
	Facade for the Asset subsystem. More...

struct	BuildInstruct
	(Interface) building instructions to be executed by the Builder on the render node network under construction. More...

class	Category
	Tree like classification of Assets. More...

class	Clip
	bookkeeping (Asset) view of a media clip. More...

class	Codec
	description of some media data decoder or encoder facility More...

class	CompoundMedia
	compound of several elementary media tracks, e.g. More...

class	Dataset
	meta asset describing a collection of control data More...

class	DB
	Implementation of the registry holding all Asset instances known to the Asset Manager subsystem. More...

struct	DoAttach

class	DoConditional

struct	DoRecurse

class	Effect
	Effect or media processing component. More...

class	ID
	thin wrapper around a size_t hash ID used as primary key for all Asset objects. More...

class	ID< Media >

class	ID< Meta >

class	ID< Pipe >

class	ID< Proc >

class	ID< Struct >

struct	IdentityHash
	trivial hash functor returns any hash value unmodified. More...

struct	IDErr
	AssetManager error responses, caused by querying invalid Asset IDs from the internal DB. More...

class	Inventory
	TypedID registration group exposed as meta asset. More...

struct	is_pAsset
	type trait for detecting a shared-ptr-to-asset More...

struct	is_pAsset< shared_ptr< A > >

class	Media
	key abstraction: media-like assets More...

class	MediaFactory
	Factory specialised for creating Media Asset objects. More...

class	Meta
	key abstraction: metadata, parametrisation, customisation and similar organisational traits. More...

class	MetaFactory
	Factory specialised for creating Metadata Asset objects. More...

class	Pipe
	structural asset corresponding to the part of the model forming a processing pipe for generating media output More...

class	Preview
	special placeholder denoting an alternative version of the media data, typically with lower resolution ("proxy media") More...

class	Proc
	key abstraction: data processing asset More...

class	ProcFactory
	Factory specialised for creating Processor Asset objects. More...

class	ProcPatt
	"Processing Pattern" is a structural Asset representing information how to build some part of the render engine's processing nodes network. More...

class	Sequence
	TODO type comment. More...

class	Struct
	key abstraction: structural asset Created automatically as a sideeffect of building the structure of the high-level-model (session contents), thus providing IDs for later referral, search and attachment of metadata. More...

class	StructFactory
	Factory specialised for creating Structural Asset objects. More...

class	StructFactoryImpl
	Implementation details, especially concerning how configuration queries are resolved and when to create new objects automatically. More...

class	TestClipAsset
	An asset::Media instance Test Clip for checking various Asset operations and for creating dependent Clip-MObjects. More...

class	Timeline

class	TypedID

class	Unknown
	Placeholder Asset for unknown or unavailable media source. More...

struct	UnknownID

class	Viewer
	TODO type comment. More...

struct	WrongKind

Functions
bool	all_parents_enabled (const vector< PAsset > &parents)

template<class CHI , class PAR >
bool	dependencyCheck (lib::P< CHI > child, lib::P< PAR > parent)

void	dump (PcAsset const &aa)

void	dumpAssetManager ()

size_t	hash_value (Asset::Ident const &idi)

size_t	hash_value (Asset const &asset)

size_t	hash_value (Category const &cat)

	LUMIERA_ERROR_DECLARE (ORIG_NOT_FOUND)

	LUMIERA_ERROR_DECLARE (MISSING_INSTANCE)
	Existing ID registration without associated instance.

	LUMIERA_ERROR_DECLARE (PART_OF_COMPOUND)

	LUMIERA_ERROR_DEFINE (ORIG_NOT_FOUND, "Media referred by placeholder not found")

	LUMIERA_ERROR_DEFINE (MISSING_INSTANCE, "Existing ID registration without associated instance")

	LUMIERA_ERROR_DEFINE (PART_OF_COMPOUND, "part of compound used as toplevel element")

template<class A >
const PcAsset	pAsset (shared_ptr< A > const &subPtr)
	promote subtype-ptr to PAsset, e.g. More...

void	propagate_down (PAsset child, bool on)

Variables
function< bool(const PAsset &)>	check_isActive

const string	CLIP_SUBFOLDER = "clips"

static Symbol	CURRENT = "current"

const Duration	DUMMY_TIME (FSecs(5))

Enumeration Type Documentation

◆ Kind

enum Kind

top-level distinction of different Kinds of Assets.

For convenience, this classification is slightly denormalised, as AUDIO, and VIDEO are both asset::Media objects, EFFECT and CODEC are asset::Proc objects, while STRUCT and META refer directly to the corresponding Interfaces asset::Struct and asset::Meta.

Definition at line 55 of file category.hpp.

Class Documentation

◆ steam::asset::DoConditional

class steam::asset::DoConditional

Collaboration diagram for DoConditional:

◆ steam::asset::TestClipAsset

class steam::asset::TestClipAsset

Collaboration diagram for TestClipAsset:

◆ steam::asset::TypedID

class steam::asset::TypedID

Collaboration diagram for TypedID:

Function Documentation

◆ pAsset()

const PcAsset steam::asset::pAsset ( shared_ptr< A > const & subPtr )

inline

promote subtype-ptr to PAsset, e.g.

for comparing

Definition at line 333 of file asset.hpp.

Variable Documentation

◆ DUMMY_TIME

const Duration DUMMY_TIME(FSecs(5))

Todo:: solve config management

◆ check_isActive

function<bool(const PAsset&)> check_isActive

Initial value:

= bind ( &Asset::isActive
           , bind (&PAsset::get, _1 )
           )

Definition at line 112 of file asset.cpp.