arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
VideoInfo Struct Reference

Basic video information (width/height/codec/frame size), analogous to AudioInfo - common to both DemuxerAVI and DemuxerMP4, accessible via their getVideoInfo() getter. More...

#include <Video.h>

Public Member Functions

void logInfo (const char *source="")
 
 operator bool () const
 True if width/height are both defined.
 
bool operator!= (const VideoInfo &alt) const
 
bool operator== (const VideoInfo &alt) const
 

Public Attributes

VideoFormat format = VideoFormat::UNKNOWN
 Video codec - VideoFormat::UNKNOWN if not (yet) determined.
 
float fps = 0
 
uint32_t frame_size = 0
 
uint16_t height = 0
 Frame height in pixels.
 
uint32_t total_file_size = 0
 
uint16_t width = 0
 Frame width in pixels.
 

Detailed Description

Basic video information (width/height/codec/frame size), analogous to AudioInfo - common to both DemuxerAVI and DemuxerMP4, accessible via their getVideoInfo() getter.

Member Function Documentation

◆ logInfo()

void logInfo ( const char *  source = "")
inline

◆ operator bool()

operator bool ( ) const
inline

True if width/height are both defined.

◆ operator!=()

bool operator!= ( const VideoInfo alt) const
inline

◆ operator==()

bool operator== ( const VideoInfo alt) const
inline

Member Data Documentation

◆ format

Video codec - VideoFormat::UNKNOWN if not (yet) determined.

◆ fps

float fps = 0

Frames/sec, if known - 0 if not (e.g. not yet determined, or a VideoFrameSource that doesn't have a fixed rate).

◆ frame_size

uint32_t frame_size = 0

Fixed size of a single frame in bytes - only meaningful for uncompressed formats (RAW/YUV422/RGB565/I420); 0 for compressed formats (H264/MJPEG/MPEG4), whose frame size varies per frame.

◆ height

uint16_t height = 0

Frame height in pixels.

◆ total_file_size

uint32_t total_file_size = 0

Total size of the container file/stream in bytes, if known. For DemuxerAVI this comes from the RIFF header's declared size (0 if the stream is unbounded/streamed). MP4 has no equivalent declared field, so DemuxerMP4 reports the number of bytes received so far instead (only equal to the true total once the whole stream has been fed in).

◆ width

uint16_t width = 0

Frame width in pixels.


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