AV module
VideoCodec
Video codec parameters including resolution, frame rate, and pixel format.
#include <icy/av/codec.h>
struct VideoCodecDefined in src/av/include/icy/av/codec.h:169
- Inherits
Codec
List of all members
| Name | Kind | Owner |
|---|---|---|
width | variable | Declared here |
height | variable | Declared here |
fps | variable | Declared here |
pixelFmt | variable | Declared here |
VideoCodec | function | Declared here |
VideoCodec | function | Declared here |
VideoCodec | function | Declared here |
VideoCodec | function | Declared here |
VideoCodec | function | Declared here |
operator= | function | Declared here |
~VideoCodec | function | Declared here |
toString | function | Declared here |
print | function | Declared here |
name | variable | Inherited from Codec |
encoder | variable | Inherited from Codec |
sampleRate | variable | Inherited from Codec |
bitRate | variable | Inherited from Codec |
quality | variable | Inherited from Codec |
compliance | variable | Inherited from Codec |
enabled | variable | Inherited from Codec |
options | variable | Inherited from Codec |
Codec | function | Inherited from Codec |
Codec | function | Inherited from Codec |
Codec | function | Inherited from Codec |
~Codec | function | Inherited from Codec |
toString | function | Inherited from Codec |
specified | function | Inherited from Codec |
print | function | Inherited from Codec |
Inherited from Codec
| Kind | Name | Description |
|---|---|---|
variable | name | The display name for this codec. |
variable | encoder | The encoder name for FFmpeg. |
variable | sampleRate | The sampling rate or RTP clock rate. |
variable | bitRate | The bit rate to encode at. |
variable | quality | Optional quality value, variable range depending on codec. |
variable | compliance | FFmpeg strict_std_compliance level (default: FF_COMPLIANCE_EXPERIMENTAL). |
variable | enabled | Weather or not the codec is available for use. |
variable | options | Arbitrary encoder options passed to FFmpeg via av_opt_set(). Keys are FFmpeg option names (e.g. "preset", "tune", "profile"). Applied after codec-specific defaults, so they override everything. |
function | Codec | Construct a disabled codec with zeroed parameters. |
function | Codec | Construct a codec with a display name, sample rate, bit rate, and enabled flag. |
function | Codec | Construct a codec with an explicit FFmpeg encoder name. |
function | ~Codec virtual noexcept | Codec(const Codec& r);. |
function | toString virtual const | Return a compact string representation of this codec. |
function | specified const | Returns true when this codec explicitly names either an RTP/media codec or an FFmpeg encoder and is enabled for use. |
function | print virtual | Print a multi-line human-readable description to the given stream. |
Public Attributes
width
int widthDefined in src/av/include/icy/av/codec.h:171
height
int heightDefined in src/av/include/icy/av/codec.h:172
fps
double fpsDefined in src/av/include/icy/av/codec.h:173
pixelFmt
std::string pixelFmtDefined in src/av/include/icy/av/codec.h:174
Public Methods
| Return | Name | Description |
|---|---|---|
VideoCodec | Construct a disabled video codec with zeroed parameters. | |
VideoCodec | Construct an anonymous video codec from raw parameters. | |
VideoCodec | Construct a named video codec. | |
VideoCodec | Construct a named video codec with an explicit FFmpeg encoder name. | |
VideoCodec | ||
VideoCodec & | operator= | Defaulted assignment operator. |
~VideoCodec virtual noexcept | ||
std::string | toString virtual const override | |
void | print virtual override | Print a multi-line human-readable description to the given stream. |
VideoCodec
VideoCodec()Defined in src/av/include/icy/av/codec.h:177
Construct a disabled video codec with zeroed parameters.
VideoCodec
VideoCodec(int width, int height, double fps = 0.0, const std::string & pixelFmt = DEFAULT_VIDEO_PIXEL_FMT, int bitRate = 0, int sampleRate = 0)Defined in src/av/include/icy/av/codec.h:186
Construct an anonymous video codec from raw parameters.
Parameters
| Parameter | Type | Description |
|---|---|---|
width | int | The frame width in pixels. |
height | int | The frame height in pixels. |
fps | double | The target frame rate in frames per second. |
pixelFmt | const std::string & | The pixel format string (e.g. "yuv420p"). |
bitRate | int | The target bit rate in bits per second. |
sampleRate | int | The RTP clock rate in Hz. |
VideoCodec
VideoCodec(const std::string & name, int width = 0, int height = 0, double fps = 0.0, int bitRate = 0, int sampleRate = 0, const std::string & pixelFmt = DEFAULT_VIDEO_PIXEL_FMT)Defined in src/av/include/icy/av/codec.h:199
Construct a named video codec.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | const std::string & | The codec display name. |
width | int | The frame width in pixels. |
height | int | The frame height in pixels. |
fps | double | The target frame rate in frames per second. |
bitRate | int | The target bit rate in bits per second. |
sampleRate | int | The RTP clock rate in Hz. |
pixelFmt | const std::string & | The pixel format string. |
VideoCodec
VideoCodec(const std::string & name, const std::string & encoder, int width = 0, int height = 0, double fps = 0.0, int bitRate = 0, int sampleRate = 0, const std::string & pixelFmt = DEFAULT_VIDEO_PIXEL_FMT)Defined in src/av/include/icy/av/codec.h:213
Construct a named video codec with an explicit FFmpeg encoder name.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | const std::string & | The codec display name. |
encoder | const std::string & | The FFmpeg encoder name (e.g. "libx264"). |
width | int | The frame width in pixels. |
height | int | The frame height in pixels. |
fps | double | The target frame rate in frames per second. |
bitRate | int | The target bit rate in bits per second. |
sampleRate | int | The RTP clock rate in Hz. |
pixelFmt | const std::string & | The pixel format string. |
VideoCodec
VideoCodec(const VideoCodec & r)Defined in src/av/include/icy/av/codec.h:218
operator=
VideoCodec & operator=(const VideoCodec &) = defaultDefined in src/av/include/icy/av/codec.h:219
Defaulted assignment operator.
~VideoCodec
virtual noexcept
virtual ~VideoCodec() noexceptDefined in src/av/include/icy/av/codec.h:220
toString
virtual const override
virtual std::string toString() const overrideDefined in src/av/include/icy/av/codec.h:223
Returns
A string in the form "VideoCodec[name:encoder:width:height:fps:pixelFmt:enabled]".
Reimplements
virtual override
virtual void print(std::ostream & ost) overrideDefined in src/av/include/icy/av/codec.h:227
Print a multi-line human-readable description to the given stream.
Reimplements
Parameters
| Parameter | Type | Description |
|---|---|---|
ost | std::ostream & | The output stream to write to. |