Zao SDK for Jetson / libzep API Reference
Loading...
Searching...
No Matches
Public Member Functions | List of all members
zep::video::VideoFormat Class Reference

Video format information. More...

#include <VideoFormat.hpp>

Public Member Functions

 VideoFormat () noexcept
 Construct a VideoFormat object by default.
 
 VideoFormat (int width, int height, bool interlaced, double fps, uint32_t pixelformat, v4l2_quantization quantization, v4l2_colorspace v4l2_colorspace colorspace) noexcept
 Construct a VideoFormat object with initial values.
 
void GetFramerate (int &numerator, int &denominator) const noexcept
 Get the numerator and denominator of the frame rate.
 
double GetFramerate () const noexcept
 Get the frame rate in floating point.
 
int GetWidth () const noexcept
 Get the picture width in pixels.
 
int GetHeight () const noexcept
 Get the height of the picture in pixels.
 
int GetFieldHeight () int GetFieldHeight() const noexcept
 Get the height of the field in pixels.
 
bool GetInterlaced () const noexcept
 Gets whether or not the interlace method is used.
 
uint32_t GetPixelFormat () const noexcept
 Get pixel format.
 
v4l2_quantization GetQuantization () const noexcept
 Get whether Limited range or Full range.
 
v4l2_colorspace GetColorSpace () const noexcept
 Get the color space.
 
bool operator== (const VideoFormat &other) const
 
 VideoFormat () noexcept
 VideoFormatオブジェクトをデフォルト構築する。
 
 VideoFormat (int width, int height, bool interlaced, double fps, uint32_t pixelformat, v4l2_quantization quantization, v4l2_colorspace colorspace) noexcept
 VideoFormatオブジェクトを初期値付きで構築する。
 
void GetFramerate (int &numerator, int &denominator) const noexcept
 フレームレートの分子と分母を取得する。
 
double GetFramerate () const noexcept
 フレームレートを浮動小数点で取得する。
 
int GetWidth () const noexcept
 ピクチャの横幅をピクセル数で取得する。
 
int GetHeight () const noexcept
 ピクチャの高さをピクセル数で取得する。
 
int GetFieldHeight () const noexcept
 フィールドの高さをピクセル数で取得する。
 
bool GetInterlaced () const noexcept
 インターレース方式か否かを取得する。
 
uint32_t GetPixelFormat () const noexcept
 ピクセルフォーマットを取得する。
 
v4l2_quantization GetQuantization () const noexcept
 Limited rangeかFull rangeかを取得する。
 
v4l2_colorspace GetColorSpace () const noexcept
 色空間を取得する。
 
bool operator== (const VideoFormat &other) const
 
bool operator!= (const VideoFormat &other) const
 

Detailed Description

Video format information.

映像のフォーマット情報

Constructor & Destructor Documentation

◆ VideoFormat() [1/4]

zep::video::VideoFormat::VideoFormat ( )
inlinenoexcept

Construct a VideoFormat object by default.

Note
Each field is initialized with an invalid value.

◆ VideoFormat() [2/4]

zep::video::VideoFormat::VideoFormat ( int  width,
int  height,
bool  interlaced,
double  fps,
uint32_t  pixelformat,
v4l2_quantization  quantization,
v4l2_colorspace v4l2_colorspace  colorspace 
)
inlinenoexcept

Construct a VideoFormat object with initial values.

Parameters
widthWidth of the picture
heightPicture height
interlacedinterlaced or not *
fpsframe rate
fpsframe rate
pixelformatV4L2 specific pixel format
quantizationLimited range or Full range
colorspacecolor space

◆ VideoFormat() [3/4]

zep::video::VideoFormat::VideoFormat ( )
inlinenoexcept

VideoFormatオブジェクトをデフォルト構築する。

Note
各フィールドは無効な値で初期化される。

◆ VideoFormat() [4/4]

zep::video::VideoFormat::VideoFormat ( int  width,
int  height,
bool  interlaced,
double  fps,
uint32_t  pixelformat,
v4l2_quantization  quantization,
v4l2_colorspace  colorspace 
)
inlinenoexcept

VideoFormatオブジェクトを初期値付きで構築する。

Parameters
widthピクチャの横幅
heightピクチャの高さ
interlacedインターレース方式か否か
fpsフレームレート
pixelformatV4L2固有ピクセルフォーマット
quantizationLimited rangeかFull rangeか
colorspace色空間

Member Function Documentation

◆ GetColorSpace() [1/2]

v4l2_colorspace zep::video::VideoFormat::GetColorSpace ( ) const
inlinenoexcept

Get the color space.

Note
V4L2 specific parameters.

◆ GetColorSpace() [2/2]

v4l2_colorspace zep::video::VideoFormat::GetColorSpace ( ) const
inlinenoexcept

色空間を取得する。

Note
V4L2固有パラメータ

◆ GetFieldHeight() [1/2]

int zep::video::VideoFormat::GetFieldHeight ( ) const
inlinenoexcept

フィールドの高さをピクセル数で取得する。

Note
インターレース方式の場合 GetHeight() の半分の値が返却される。
プログレッシブ方式の場合 GetHeight() と同じ値が返却される。
See also
GetHeight()

◆ GetFieldHeight() [2/2]

int zep::video::VideoFormat::GetFieldHeight ( ) const
inlinenoexcept

Get the height of the field in pixels.

Note
Half of GetHeight() is returned in case of interlaced system.
In case of progressive method, the same value as GetHeight() is returned.
See also
GetHeight()

◆ GetFramerate() [1/2]

void zep::video::VideoFormat::GetFramerate ( int &  numerator,
int &  denominator 
) const
inlinenoexcept

Get the numerator and denominator of the frame rate.

Parameters
numeratorwhere the numerator is stored.
denominatordenominator

noexcept

◆ GetFramerate() [2/2]

void zep::video::VideoFormat::GetFramerate ( int &  numerator,
int &  denominator 
) const
inlinenoexcept

フレームレートの分子と分母を取得する。

Parameters
numerator分子の格納先
denominator分子の格納先

手抜き

◆ GetHeight() [1/2]

int zep::video::VideoFormat::GetHeight ( ) const
inlinenoexcept

Get the height of the picture in pixels.

Note
In the case of interlaced system, this indicates the height of the original image (or the displayed image), The actual height of one field's worth of data is half of GetHeight().
See also
GetFieldHeight()

◆ GetHeight() [2/2]

int zep::video::VideoFormat::GetHeight ( ) const
inlinenoexcept

ピクチャの高さをピクセル数で取得する。

Note
インターレース方式の場合、元画像(または表示画像)の高さを示し、 実際の1フィールド分データの高さは GetHeight() の半分になる。
See also
GetFieldHeight()

◆ GetInterlaced() [1/2]

bool zep::video::VideoFormat::GetInterlaced ( ) const
inlinenoexcept

Gets whether or not the interlace method is used.

Return values
true
trueInterlaced
falseProgressive method is used.

◆ GetInterlaced() [2/2]

bool zep::video::VideoFormat::GetInterlaced ( ) const
inlinenoexcept

インターレース方式か否かを取得する。

Return values
trueインターレース方式である
falseプログレッシブ方式である

◆ GetPixelFormat() [1/2]

uint32_t zep::video::VideoFormat::GetPixelFormat ( ) const
inlinenoexcept

Get pixel format.

Note
V4L2 specific parameter

◆ GetPixelFormat() [2/2]

uint32_t zep::video::VideoFormat::GetPixelFormat ( ) const
inlinenoexcept

ピクセルフォーマットを取得する。

Note
V4L2固有パラメータ

◆ GetQuantization() [1/2]

v4l2_quantization zep::video::VideoFormat::GetQuantization ( ) const
inlinenoexcept

Get whether Limited range or Full range.

Note
V4L2 specific parameter

◆ GetQuantization() [2/2]

v4l2_quantization zep::video::VideoFormat::GetQuantization ( ) const
inlinenoexcept

Limited rangeかFull rangeかを取得する。

Note
V4L2固有パラメータ

◆ operator==() [1/2]

bool zep::video::VideoFormat::operator== ( const VideoFormat other) const
inline

4 significant digits

◆ operator==() [2/2]

bool zep::video::VideoFormat::operator== ( const VideoFormat other) const
inline

有効数字 4 桁


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