AV module

PlanarVideoPacket

Video packet for planar formats.

PlanarVideoPacket

#include <icy/av/packet.h>

struct PlanarVideoPacket

Defined in src/av/include/icy/av/packet.h:121

Inherits: VideoPacket Subclassed by: VisionFramePacket

Video packet for planar formats.

Parameters

data Array of per-plane data pointers (up to 4 planes).
linesize Array of per-plane byte strides.
pixelFmt The pixel format name (e.g. "yuv420p").
width The frame width in pixels.
height The frame height in pixels.
time The timestamp in microseconds.

List of all members

Name	Kind	Owner
`buffer`	`variable`	Declared here
`linesize`	`variable`	Declared here
`pixelFmt`	`variable`	Declared here
`owns_buffer`	`variable`	Declared here
`avframe`	`variable`	Declared here
`PlanarVideoPacket`	`function`	Declared here
`PlanarVideoPacket`	`function`	Declared here
`~PlanarVideoPacket`	`function`	Declared here
`clone`	`function`	Declared here
`className`	`function`	Declared here
`width`	`variable`	Inherited from `VideoPacket`
`height`	`variable`	Inherited from `VideoPacket`
`iframe`	`variable`	Inherited from `VideoPacket`
`avpacket`	`variable`	Inherited from `VideoPacket`
`VideoPacket`	`function`	Inherited from `VideoPacket`
`VideoPacket`	`function`	Inherited from `VideoPacket`
`~VideoPacket`	`function`	Inherited from `VideoPacket`
`clone`	`function`	Inherited from `VideoPacket`
`className`	`function`	Inherited from `VideoPacket`
`time`	`variable`	Inherited from `MediaPacket`
`MediaPacket`	`function`	Inherited from `MediaPacket`
`MediaPacket`	`function`	Inherited from `MediaPacket`
`MediaPacket`	`function`	Inherited from `MediaPacket`
`~MediaPacket`	`function`	Inherited from `MediaPacket`
`clone`	`function`	Inherited from `MediaPacket`
`className`	`function`	Inherited from `MediaPacket`
`RawPacket`	`function`	Inherited from `RawPacket`
`RawPacket`	`function`	Inherited from `RawPacket`
`RawPacket`	`function`	Inherited from `RawPacket`
`~RawPacket`	`function`	Inherited from `RawPacket`
`clone`	`function`	Inherited from `RawPacket`
`copyData`	`function`	Inherited from `RawPacket`
`read`	`function`	Inherited from `RawPacket`
`write`	`function`	Inherited from `RawPacket`
`data`	`function`	Inherited from `RawPacket`
`size`	`function`	Inherited from `RawPacket`
`className`	`function`	Inherited from `RawPacket`
`ownsBuffer`	`function`	Inherited from `RawPacket`
`_data`	`variable`	Inherited from `RawPacket`
`_size`	`variable`	Inherited from `RawPacket`
`_owned`	`variable`	Inherited from `RawPacket`
`operator<<`	`friend`	Inherited from `IPacket`
`opaque`	`variable`	Inherited from `IPacket`
`info`	`variable`	Inherited from `IPacket`
`flags`	`variable`	Inherited from `IPacket`
`IPacket`	`function`	Inherited from `IPacket`
`IPacket`	`function`	Inherited from `IPacket`
`operator=`	`function`	Inherited from `IPacket`
`clone`	`function`	Inherited from `IPacket`
`~IPacket`	`function`	Inherited from `IPacket`
`read`	`function`	Inherited from `IPacket`
`write`	`function`	Inherited from `IPacket`
`size`	`function`	Inherited from `IPacket`
`hasData`	`function`	Inherited from `IPacket`
`data`	`function`	Inherited from `IPacket`
`constData`	`function`	Inherited from `IPacket`
`className`	`function`	Inherited from `IPacket`
`print`	`function`	Inherited from `IPacket`

Inherited from `VideoPacket`

Kind	Name	Description
`variable`	`width`	Frame width in pixels.
`variable`	`height`	Frame height in pixels.
`variable`	`iframe`	True if this is an intra (keyframe) frame.
`variable`	`avpacket`	Non-owning pointer to the encoded AVPacket from FFmpeg. Set by VideoEncoder, read by MultiplexEncoder.
`function`	`VideoPacket` `inline`	Construct a video packet with an interleaved buffer.
`function`	`VideoPacket` `inline`	Copy constructor. The avpacket pointer is shallow-copied (non-owning).
`function`	`~VideoPacket` `virtual`	Defaulted destructor.
`function`	`clone` `virtual` `const` `inline` `override`
`function`	`className` `virtual` `const` `inline` `override`	Returns the class name of this packet type for logging and diagnostics.

Inherited from `MediaPacket`

Kind	Name	Description
`variable`	`time`	Presentation timestamp in microseconds.
`function`	`MediaPacket` `inline`	Construct with a non-owning or owning mutable buffer.
`function`	`MediaPacket` `inline`	Construct with const data (copied, owning).
`function`	`MediaPacket` `inline`	Copy constructor.
`function`	`~MediaPacket` `virtual`	Defaulted destructor.
`function`	`clone` `virtual` `const` `inline` `override`
`function`	`className` `virtual` `const` `inline` `override`	Returns the class name of this packet type for logging and diagnostics.

Inherited from `RawPacket`

Kind	Name	Description
`function`	`RawPacket` `inline`	Construct with borrowed (non-owning) buffer.
`function`	`RawPacket` `inline`	Construct with const data (copied, owning).
`function`	`RawPacket` `inline`	Copy constructor (always copies data).
`function`	`~RawPacket` `virtual`	Defaulted destructor.
`function`	`clone` `virtual` `const` `inline` `override`
`function`	`copyData` `virtual` `inline`	Copies data into an internally owned buffer, replacing any prior content.
`function`	`read` `virtual` `inline` `override`	Reads from the buffer by copying its contents into an owned buffer.
`function`	`write` `virtual` `const` `inline` `override`	Appends the packet data to the given output buffer.
`function`	`data` `virtual` `const` `inline` `override`
`function`	`size` `virtual` `const` `inline` `override`
`function`	`className` `virtual` `const` `inline` `override`	Returns the class name of this packet type for logging and diagnostics.
`function`	`ownsBuffer` `const` `inline`
`variable`	`_data`
`variable`	`_size`
`variable`	`_owned`

Inherited from `IPacket`

Kind	Name	Description
`friend`	`operator<<` `inline`	Stream insertion operator; delegates to print().
`variable`	`opaque`	Optional type-safe context data. Use std::any_cast to retrieve. Lifetime of the stored value is tied to the packet's lifetime.
`variable`	`info`	Optional extra information about the packet.
`variable`	`flags`	Provides basic information about the packet.
`function`	`IPacket` `inline`
`function`	`IPacket` `inline`	Copy constructor; clones the info object if present.
`function`	`operator=` `inline`	Copy assignment; clones the info object if present.
`function`	`clone` `virtual` `const`	Returns a heap-allocated deep copy of this packet.
`function`	`~IPacket` `virtual`	Defaulted destructor.
`function`	`read` `virtual`	Read/parse to the packet from the given input buffer. The number of bytes read is returned.
`function`	`write` `virtual` `const`	Copy/generate to the packet given output buffer. The number of bytes written can be obtained from the buffer.
`function`	`size` `virtual` `const` `inline`	The size of the packet in bytes.
`function`	`hasData` `virtual` `const` `inline`	Returns true if the packet has a non-null data pointer.
`function`	`data` `virtual` `const` `inline`	The packet data pointer for buffered packets.
`function`	`constData` `virtual` `const` `inline`	The const packet data pointer for buffered packets.
`function`	`className` `virtual` `const`	Returns the class name of this packet type for logging and diagnostics.
`function`	`print` `virtual` `const` `inline`	Prints a human-readable representation to the given stream.

Public Attributes

Return	Name	Description
`uint8_t *`	`buffer`
`int`	`linesize`
`std::string`	`pixelFmt`
`bool`	`owns_buffer`
`AVFrame *`	`avframe`	Non-owning pointer to the decoded AVFrame from FFmpeg. Set by VideoDecoder.

buffer

uint8_t * buffer = {nullptr}

Defined in src/av/include/icy/av/packet.h:123

linesize

int linesize = {0}

Defined in src/av/include/icy/av/packet.h:124

pixelFmt

std::string pixelFmt

Defined in src/av/include/icy/av/packet.h:125

owns_buffer

bool owns_buffer = false

Defined in src/av/include/icy/av/packet.h:126

avframe

AVFrame * avframe = nullptr

Defined in src/av/include/icy/av/packet.h:130

Non-owning pointer to the decoded AVFrame from FFmpeg. Set by VideoDecoder.

Public Methods

Return	Name	Description
	`PlanarVideoPacket`	Construct a planar video packet, copying the plane pointers (not the pixel data).
	`PlanarVideoPacket`	Copy constructor. Performs a deep copy of the owned buffer if owns_buffer is set.
`std::unique_ptr< IPacket >`	`clone` `virtual` `const` `inline` `override`
`const char *`	`className` `virtual` `const` `inline` `override`	Returns the class name of this packet type for logging and diagnostics.

PlanarVideoPacket

PlanarVideoPacket(uint8_t * data, const int linesize, const std::string & pixelFmt = "", int width = 0, int height = 0, int64_t time = 0)

Defined in src/av/include/icy/av/packet.h:139

Construct a planar video packet, copying the plane pointers (not the pixel data).

Parameters

data Array of up to 4 per-plane data pointers.
linesize Array of per-plane byte strides.
pixelFmt The pixel format string (e.g. "yuv420p").
width Frame width in pixels.
height Frame height in pixels.
time Presentation timestamp in microseconds.

PlanarVideoPacket

PlanarVideoPacket(const PlanarVideoPacket & r)

Defined in src/av/include/icy/av/packet.h:143

Copy constructor. Performs a deep copy of the owned buffer if owns_buffer is set.

clone

virtual const inline override

virtual inline std::unique_ptr< IPacket > clone() const override

Defined in src/av/include/icy/av/packet.h:147

Returns

A heap-allocated deep copy of this packet.

Reimplements

clone

Reimplemented by

clone

className

virtual const inline override

virtual inline const char * className() const override

Defined in src/av/include/icy/av/packet.h:149

Returns the class name of this packet type for logging and diagnostics.

Reimplements

className

Reimplemented by

className

Built with

PlanarVideoPacket

Parameters

List of all members

Inherited from VideoPacket

Inherited from MediaPacket

Inherited from RawPacket

Inherited from IPacket

Public Attributes

buffer

linesize

pixelFmt

owns_buffer

avframe

Public Methods

PlanarVideoPacket

Parameters

PlanarVideoPacket

clone

Returns

Reimplements

Reimplemented by

className

Reimplements

Reimplemented by

Inherited from `VideoPacket`

Inherited from `MediaPacket`

Inherited from `RawPacket`

Inherited from `IPacket`