Attention
This version of the SDK has been superseded by the latest release of the SDK.
Software Migration Considerations¶
This section of documentation covers the notable API differences between the current release of SDK, 1.2, and previous versions.
API Changes from Alveo U30¶
This sub-section describes differences between U30 and MA35D
FFmpeg API Changes¶
Options General |
MA35D |
U30 |
---|---|---|
-c:v: Used for codec selection. Aside from naming convention changes, new AV1 codec and VP9 decoder are now available. |
||
-filter_complex: Used for frame filtering operation. Aside from naming convention changes, new 2D composition and ML operations are now available. |
||
-hwaccel: Used to select hardware accelerator engine. This option was previously referred to as |
||
-vf: Used to select the DMA transfer direction between host and accelerator. |
Options Encoder |
Version 1.2 |
U30 |
---|---|---|
-level: Used to specify encoder's level. It now supports AV1's levels. |
||
-profile: Used to set encoder's profile. It now supports AV1's main. |
||
-control_rate: Used to set rate control mode. Options to this setting have changed. |
||
-tune_metrics: Used to tune VQ metrics. Options to this setting have changed. |
||
-cores: Used to explicitly specify the number of processing cores. |
Deprecated |
|
-periodicity-idr: Used to determine IDR frame frequency. |
Deprecated |
|
-disable-pipeline: Used to enable/disable pipelining. |
Deprecated |
|
-aspect-ratio: Used to set video's aspect ratio. |
Deprecated |
|
-expert-options: Used to set encoder's expert option. |
Deprecated |
|
-avc-lowlat: Used to enable/disable ULL for AVC. |
Deprecated |
Options Decoder |
Version 1.2 |
U30 |
---|---|---|
-splitbuff_mode: Used to configure decoder's buffer mode. |
Deprecated |
|
-entropy_buffers_count: Used to set number of decoder's entropy buffers. |
Deprecated |
Options Scaler |
Version 1.2 |
U30 |
---|---|---|
-out_{N}_width: Used to configure width of an output rung. |
Deprecated |
|
-out_{N}_height: Used to configure height of an output rung. |
Deprecated |
|
-out_{N}_rate: Used to configure frame rate of an output rung. |
Deprecated |
Gstreamer API Changes¶
Options Encoder |
Version 1.2 |
U30 |
---|---|---|
tune_metrics: Used to tune VQ metrics. Options to this setting have changed. |
||
ultra-low-latency: Used to set ULL mode. |
Set |
|
target-bitrate: Used to set target bit rate. |
||
control_rate: Used to set rate control mode. Options to this setting have changed. |
||
dev-idx: Used to specify the index of the device on which the encoder should be executed. |
||
aspect-ratio: Used to set video’s aspect ratio. |
Deprecated |
|
avc-lowlat: Used to enable/disable ULL for AVC. |
Deprecated |
|
dependent-slice: Used to specify slice dependency. |
Deprecated |
|
enable-pipeline: Used to enable/disable pipelining. |
Deprecated |
|
ip-delta: Used to set IP delta. |
Deprecated |
|
loop-filter-beta-offset: Used to set loop filter beta offset. |
Deprecated |
|
loop-filter-tc-offset: Used to set loop filter tc offset.. |
Deprecated |
|
slice-qp: Used to set slice QP mode. |
Deprecated |
|
scaling-list: Used to set lscaling list mode. |
Deprecated |
|
reservation-id: Used to set resource pool reservation id. |
Deprecated |
|
rc-mode: Used to enable custom rate control mode. |
Deprecated |
|
qp-mode: Used to set QP control mode used by the encoder. |
Deprecated |
|
pb-delta: Used to set PB delta. |
Deprecated |
|
periodicity-idr: Used to set periodicity of IDR frames. |
Deprecated |
|
num-cores: Used to set the number of encoder cores to be used for current stream. |
Deprecated |
|
num-slices: Used to set the number of slices produced for each frame. |
Deprecated |
Options Decoder |
Version 1.2 |
U30 |
---|---|---|
dev-idx: Used to specify the index of the device on which the decoder should be executed. |
||
avoid-dynamic-alloc: Used to set a flag to avoid dynamic allocation of output buffers. |
Deprecated |
|
avoid-output-copy: Used to set a flag to avoid output frames copy. |
Deprecated |
|
disable-hdr10-sei: Used to configure whether to passthrough HDR10/10+ SEI messages or not. |
Deprecated |
|
interpolate-timestamps: Used to configure interpolation of output buffers PTS. |
Deprecated |
|
num-entropy-buf: Used to specifie the number of decoder internal entropy buffers. |
Deprecated |
|
reservation-id: Used to set resource Pool Reservation id. |
Deprecated |
|
splitbuff-mode: Used to configure decoder in split/unsplit input buffer mode. |
Deprecated |
Options Scaler |
Version 1.2 |
U30 |
---|---|---|
dev-idx: Used to specify the index of the device on which the scaler should be executed. |
||
avoid-output-copy: Used to set a flag to avoid output frames copy on all source pads. |
Deprecated |
|
coef-load-type: Used to configure coefficients loading type for scaling. |
Deprecated |
|
enable-pipeline: Used to enable buffer pipelining to improve performance in non zero-copy use cases. |
Deprecated |
|
reservation-id: Used to configure resource pool reservation id. |
Deprecated |
CLI Changes from 1.1.2 to 1.2¶
This sub-section describes differences between 1.1.2 and current version.
PCIe Addressing¶
Unlike the previous version, where PCIe devices were addressed as DBDF, this release uses BDF scheme. See Card Management.
FFmpeg CLI Changes¶
Options General |
1.2 |
1.1.2 |
---|---|---|
-c:v: New still image codecs are now available. See |
Options Encoder |
1.2 |
1.1.2 |
---|---|---|
-control_rate: cabr has been removed as a rate control mode, and can now be applied as a modifier to all encoding modes. |
|
|
-crf: Changes have been made in the call parameters. |
|
-crf 1 -qp <value> |
Options Decoder |
1.2 |
1.1.2 |
---|---|---|
-resize: Option to perform downscaling through decoders has been added. |
Options 2D Engine |
1.2 |
1.1.2 |
---|---|---|
crop, pad, drawbox, and other 2D operations: 2D operations that were previously sub-commands of 2d_ama are now invoked with a simpler syntax. |
-scaler_ama and -2d_ama |
Card Management¶
Options |
1.2 |
1.1.2 |
---|---|---|
|
See mamgmt. |
|
Syntax for creation of VF has been updated. |
See mamgmt. |
C APIs¶
See relevant sub-sections in C API Programming Guide.