Frames Struct Reference

#include "lib/time/formats.hpp"

Description

Frame count as timecode format.

An integral number used to count frames can be used as a simple from of time code. Indeed the Lumiera vault layer mostly relies on these frame counts. As with any timecode, the underlying framerate/quantisation remains implicit.

Definition at line 75 of file formats.hpp.

Static Public Member Functions
static TimeValue	parse (string const &, QuantR)
	try to parse a frame number specification
static void	rebuild (FrameNr &, QuantR, TimeValue const &)
	build up a frame count by quantising the given time value
static TimeValue	evaluate (FrameNr const &, QuantR)
	calculate the time point denoted by this frame count

Additional Inherited Members
Public Member Functions inherited from NoInstance< X >
	NoInstance ()
	NoInstance (NoInstance const &)

Member Function Documentation

parse()

TimeValue parse ( string const &  frameNumber, QuantR  frameGrid  )

static

try to parse a frame number specification

Parameters

frameNumber	string containing an integral number with trailing '#'
frameGrid	coordinate system (and thus framerate) to use for the conversion

Returns

(opaque internal) lumiera time value of the given frame's start position

Exceptions

error::Invalid

in case of parsing failure

Note

the string may contain any additional content, as long as a regular-expression search is able to pick out a suitable value

Definition at line 64 of file timecode.cpp.

References LERR_.

Referenced by TimeFormats_test::checkTimecodeUsageCycle().

Here is the caller graph for this function:

rebuild()

void rebuild ( FrameNr &  frameNr, QuantR  quantiser, TimeValue const &  rawTime  )

static

build up a frame count by quantising the given time value

Definition at line 150 of file timecode.cpp.

References Digxel< NUM, FMT >::setValueRaw().

Here is the call graph for this function:

evaluate()

TimeValue evaluate ( FrameNr const &  frameNr, QuantR  quantiser  )

static

calculate the time point denoted by this frame count

Definition at line 157 of file timecode.cpp.

Referenced by FrameNr::value().

Here is the caller graph for this function:

Inheritance diagram for Frames:

Collaboration diagram for Frames:

---

The documentation for this struct was generated from the following files:

• formats.hpp
• timecode.cpp