FrameNormalizer

#include <icy/vision/framenormalizer.h>

class FrameNormalizer

Defined in src/vision/include/icy/vision/framenormalizer.h:49

Inherits: PacketProcessor

Converts sampled decoded video into owned detector-ready frames.

List of all members

Name	Kind	Owner
`emitter`	`variable`	Declared here
`FrameNormalizer`	`function`	Declared here
`~FrameNormalizer`	`function`	Declared here
`setConfig`	`function`	Declared here
`config`	`function`	Declared here
`stats`	`function`	Declared here
`reset`	`function`	Declared here
`process`	`function`	Declared here
`accepts`	`function`	Declared here
`_config`	`variable`	Declared here
`_seen`	`variable`	Declared here
`_emitted`	`variable`	Declared here
`_dropped`	`variable`	Declared here
`_converted`	`variable`	Declared here
`_frameId`	`variable`	Declared here
`_state`	`variable`	Declared here
`normalize`	`function`	Declared here
`sanitize`	`function`	Declared here
`PacketProcessor`	`function`	Inherited from `PacketProcessor`
`process`	`function`	Inherited from `PacketProcessor`
`accepts`	`function`	Inherited from `PacketProcessor`
`operator<<`	`function`	Inherited from `PacketProcessor`
`PacketStreamAdapter`	`function`	Inherited from `PacketStreamAdapter`
`~PacketStreamAdapter`	`function`	Inherited from `PacketStreamAdapter`
`emit`	`function`	Inherited from `PacketStreamAdapter`
`emit`	`function`	Inherited from `PacketStreamAdapter`
`emit`	`function`	Inherited from `PacketStreamAdapter`
`emit`	`function`	Inherited from `PacketStreamAdapter`
`emit`	`function`	Inherited from `PacketStreamAdapter`
`getEmitter`	`function`	Inherited from `PacketStreamAdapter`
`retention`	`function`	Inherited from `PacketStreamAdapter`
`onStreamStateChange`	`function`	Inherited from `PacketStreamAdapter`
`_emitter`	`variable`	Inherited from `PacketStreamAdapter`
`PacketStreamAdapter`	`function`	Inherited from `PacketStreamAdapter`
`operator=`	`function`	Inherited from `PacketStreamAdapter`
`PacketStreamAdapter`	`function`	Inherited from `PacketStreamAdapter`
`operator=`	`function`	Inherited from `PacketStreamAdapter`

Inherited from `PacketProcessor`

Kind	Name	Description
`function`	`PacketProcessor` `inline`
`function`	`process` `virtual`	This method performs processing on the given packet and emits the result.
`function`	`accepts` `virtual` `inline`	This method ensures compatibility with the given packet type. Return false to reject the packet.
`function`	`operator<<` `virtual` `inline`	Stream operator alias for process()

Inherited from `PacketStreamAdapter`

Kind	Name	Description
`function`	`PacketStreamAdapter`	Construct the adapter, binding it to the given packet signal.
`function`	`~PacketStreamAdapter` `virtual` `inline`
`function`	`emit` `virtual`	Emit a mutable raw buffer as a packet.
`function`	`emit` `virtual`	Emit a read-only raw buffer as a packet (data is copied internally).
`function`	`emit` `virtual`	Emit a string as a packet (data is copied internally).
`function`	`emit` `virtual`	Emit a flag-only packet carrying no payload data.
`function`	`emit` `virtual`	Emit an existing packet directly onto the outgoing signal.
`function`	`getEmitter`	Returns a reference to the outgoing packet signal.
`function`	`retention` `virtual` `const`	Returns how this adapter treats incoming packet lifetime. Most adapters are synchronous and therefore only borrow the packet for the current call chain. Queue-style adapters override this to advertise that they clone before deferred use. Callers may treat the first adapter reporting Cloned or Retained as the explicit ownership boundary in the stream graph.
`function`	`onStreamStateChange` `virtual` `inline`	Called by the PacketStream to notify when the internal Stream state changes. On receiving the Stopped state, it is the responsibility of the adapter to have ceased all outgoing packet transmission, especially in multi-thread scenarios.
`variable`	`_emitter`
`function`	`PacketStreamAdapter`	NonCopyable and NonMovable.
`function`	`operator=`	Deleted assignment operator.
`function`	`PacketStreamAdapter`	Deleted constructor.
`function`	`operator=`	Deleted assignment operator.

Public Attributes

Return	Name	Description
`PacketSignal`	`emitter`

emitter

PacketSignal emitter

Defined in src/vision/include/icy/vision/framenormalizer.h:52

Public Methods

Return	Name	Description
	`FrameNormalizer` `explicit`
`void`	`setConfig`
`FrameNormalizerConfig`	`config` `const`
`FrameNormalizerStats`	`stats` `const`
`void`	`reset`
`void`	`process` `virtual` `override`	This method performs processing on the given packet and emits the result.
`bool`	`accepts` `virtual` `inline` `override`	This method ensures compatibility with the given packet type. Return false to reject the packet.

FrameNormalizer

explicit

explicit FrameNormalizer(FrameNormalizerConfig config = {})

Defined in src/vision/include/icy/vision/framenormalizer.h:54

setConfig

void setConfig(FrameNormalizerConfig config)

Defined in src/vision/include/icy/vision/framenormalizer.h:57

config

const

FrameNormalizerConfig config() const

Defined in src/vision/include/icy/vision/framenormalizer.h:58

stats

const

FrameNormalizerStats stats() const

Defined in src/vision/include/icy/vision/framenormalizer.h:59

reset

void reset()

Defined in src/vision/include/icy/vision/framenormalizer.h:60

process

virtual override

virtual void process(IPacket & packet) override

Defined in src/vision/include/icy/vision/framenormalizer.h:62

This method performs processing on the given packet and emits the result.

Processors that defer work asynchronously must either clone the packet or retain an owned equivalent. See retention().

Reimplements

process

accepts

virtual inline override

virtual inline bool accepts(IPacket *) override

Defined in src/vision/include/icy/vision/framenormalizer.h:63

This method ensures compatibility with the given packet type. Return false to reject the packet.

Reimplements

accepts

Private Attributes

Return	Name	Description
`FrameNormalizerConfig`	`_config`
`std::atomic< uint64_t >`	`_seen`
`std::atomic< uint64_t >`	`_emitted`
`std::atomic< uint64_t >`	`_dropped`
`std::atomic< uint64_t >`	`_converted`
`std::atomic< uint64_t >`	`_frameId`
`std::unique_ptr< State >`	`_state`

_config

FrameNormalizerConfig _config

Defined in src/vision/include/icy/vision/framenormalizer.h:76

_seen

std::atomic< uint64_t > _seen {0}

Defined in src/vision/include/icy/vision/framenormalizer.h:77

_emitted

std::atomic< uint64_t > _emitted {0}

Defined in src/vision/include/icy/vision/framenormalizer.h:78

_dropped

std::atomic< uint64_t > _dropped {0}

Defined in src/vision/include/icy/vision/framenormalizer.h:79

_converted

std::atomic< uint64_t > _converted {0}

Defined in src/vision/include/icy/vision/framenormalizer.h:80

_frameId

std::atomic< uint64_t > _frameId {0}

Defined in src/vision/include/icy/vision/framenormalizer.h:81

_state

std::unique_ptr< State > _state

Defined in src/vision/include/icy/vision/framenormalizer.h:82

Private Methods

Return	Name	Description
`VisionFramePacket`	`normalize`

normalize

VisionFramePacket normalize(const av::PlanarVideoPacket & packet)

Defined in src/vision/include/icy/vision/framenormalizer.h:74

Private Static Methods

Return	Name	Description
`FrameNormalizerConfig`	`sanitize` `static`

sanitize

static

static FrameNormalizerConfig sanitize(FrameNormalizerConfig config)

Defined in src/vision/include/icy/vision/framenormalizer.h:72

FrameNormalizer

List of all members

Inherited from PacketProcessor

Inherited from PacketStreamAdapter

Public Attributes

emitter

Public Methods

FrameNormalizer

setConfig

config

stats

reset

process

Reimplements

accepts

Reimplements

Private Attributes

_config

_seen

_emitted

_dropped

_converted

_frameId

_state

Private Methods

normalize

Private Static Methods

sanitize

Inherited from `PacketProcessor`

Inherited from `PacketStreamAdapter`