Skip to content

Commit 624f8ba

Browse files
committed
Encode API doc corrections
1 parent 37452e9 commit 624f8ba

File tree

2 files changed

+52
-33
lines changed

2 files changed

+52
-33
lines changed

amf/doc/AMF_Video_Encode_API.md

Lines changed: 52 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,8 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
6161
4. [Annex A: Encoding & frame parameters description](#4-annex-a-encoding--frame-parameters-description)
6262
- [Table A-1. Encoder configuration parameters](#table-a-1-encoder-configuration-parameters)
6363
- [Table A-2. Input frame and encoded data parameters](#table-a-2-input-frame-and-encoded-data-parameters)
64-
- [Table A-3. Default values of parameters](#table-a---3-default-values-of-parameters)
65-
- [Table A-4. Encoder statistics feedback](#table-a-4-encoder-statistics-feedback)
66-
- [Table A-5. Encoder PSNR/SSIM feedback](#table-a-5-encoder-psnrssim-feedback)
64+
- [Table A-3. Encoder statistics feedback](#table-a-3-encoder-statistics-feedback)
65+
- [Table A-4. Encoder PSNR/SSIM feedback](#table-a-4-encoder-psnrssim-feedback)
6766

6867

6968
## 1 Introduction
@@ -180,7 +179,7 @@ If an application enables `AMF_VIDEO_ENCODER_PICTURE_TRANSFER_MODE` for a specif
180179

181180
LTR (Long Term Reference) is to manually select a reference frame which can be far away to encode current frame. Normally, the encoder selects last frame as reference or a frame at lower layer in the SVC case.
182181

183-
In AV1, maximum of `16` reference frames are supported according to the spec. These `16` reference frames are shared by SVC and LTR.
182+
In AVC, maximum of `16` reference frames are supported according to the spec. These `16` reference frames are shared by SVC and LTR.
184183

185184
To use LTR, you need to set these properties as Static Properties:
186185

@@ -275,7 +274,7 @@ File name, relative or absolute path
275274
`NULL`
276275

277276
**Description:**
278-
Output HEVC file for encoded data.
277+
Output file for encoded data.
279278

280279
---
281280

@@ -289,7 +288,7 @@ File name, relative or absolute path
289288
`NULL`
290289

291290
**Description:**
292-
Input file with frames (AVC or HEVC).
291+
Input file with frames.
293292

294293
---
295294

@@ -424,7 +423,7 @@ Table 3. Miscellaneous parameters of VCEEncoderD3D application
424423
`AVC`
425424

426425
**Description:**
427-
Codec name
426+
Codec name.
428427

429428
---
430429

@@ -480,7 +479,7 @@ Frame height
480479
`720`
481480

482481
**Description:**
483-
Frame height
482+
Frame height.
484483

485484
---
486485

@@ -586,7 +585,7 @@ Render frame rate.
586585

587586
#### 3.2.1 Transcoding application (TranscodingHW.exe)
588587

589-
`TranscodeHW.exe -input input.h264 -output out.h265 –codec HEVC -width 1280 -height 720`
588+
`TranscodeHW.exe -input input.h264 -output out.h264 –codec AVC -width 1280 -height 720`
590589

591590
This command transcodes H264 elementary stream to H.264 video. Encoder is created with “Transcoding” usage.
592591

@@ -981,6 +980,7 @@ Color space primaries for the compressed output surface which are the maximum re
981980
| REF_B_PIC_DELTA_QP | amf_int64 |
982981
| PREENCODE_ENABLE | amf_int64 |
983982
| FILLER_DATA_ENABLE | amf_bool |
983+
| ENABLE_VBAQ | amf_bool |
984984

985985
<p align="center">
986986
Table 6. Encoder rate-control parameters
@@ -1213,10 +1213,29 @@ Sets the initial VBV buffer fullness.
12131213
- HQLL: `false`
12141214

12151215
**Description:**
1216-
- Disables/enables constraints on QP variation within a picture to meet HRD requirement(s)
1217-
- Enables/disables VBAQ
1216+
Disables/enables constraints on rate control to meet HRD model requirement(s) with peak_bitrate, VBV buffer size and VBV buffer fullness settings.
1217+
1218+
1219+
---
1220+
1221+
**Name:**
1222+
`AMF_VIDEO_ENCODER_ENABLE_VBAQ`
1223+
1224+
**Values:**
1225+
`true`, `false` (`On`, `Off`)
1226+
1227+
**Default Value associated with usages:**
1228+
- Transcoding: `false`
1229+
- Ultra low latency: `false`
1230+
- Low latency: `false`
1231+
- Webcam: `false`
1232+
- HQ: `true`
1233+
- HQLL: `true`
1234+
1235+
**Description:**
1236+
Note: Cannot use when `RATE_CONTROL_METHOD` is CQP.
12181237
- VBAQ stands for *Variance Based Adaptive Quantization*.
1219-
- The basic idea of VBAQ: Human visual system is typically less sensitive to artifacts in highly textured area. In VBAQ mode, we use pixel variance to indicate the complexity of spatial texture. This allows us to allocate more bits to smoother areas. Enabling such feature leads to improvements in subjective visual quality with some content.Note: Cannot use when RATE_CONTROL_METHOD is CQP.
1238+
- The basic idea of VBAQ: Human visual system is typically less sensitive to artifacts in highly textured area. In VBAQ mode, we use pixel variance to indicate the complexity of spatial texture. This allows us to allocate more bits to smoother areas. Enabling such feature leads to improvements in subjective visual quality with some content.Note: Cannot use when `RATE_CONTROL_METHOD` is CQP.
12201239

12211240
---
12221241

@@ -1555,7 +1574,7 @@ Selects progressive or interlaced scan.
15551574
- HQLL: `AMF_VIDEO_ENCODER_QUALITY_PRESET_QUALITY`
15561575

15571576
**Description:**
1558-
Selects the quality preset.
1577+
Selects the quality preset in HW to balance between encoding speed and video quality.
15591578

15601579
---
15611580

@@ -2094,7 +2113,7 @@ Reconstructed picture. Valid with `AMF_VIDEO_ENCODER_PICTURE_TRANSFER_MODE` turn
20942113

20952114
---
20962115

2097-
### Table A-4. Encoder statistics feedback
2116+
### Table A-3. Encoder statistics feedback
20982117

20992118
| Name (prefix "AMF_VIDEO_ENCODER_") | Type |
21002119
| :---------------------------------- | :-------- |
@@ -2145,147 +2164,147 @@ Average QP of all encoded macroblocks in a picture.
21452164
`AMF_VIDEO_ENCODER_STATISTIC_MAX_QP`
21462165

21472166
**Description:**
2148-
Max QP among all encoded macroblocks in a picture
2167+
Max QP among all encoded macroblocks in a picture.
21492168

21502169
---
21512170

21522171
**Name:**
21532172
`AMF_VIDEO_ENCODER_STATISTIC_MIN_QP`
21542173

21552174
**Description:**
2156-
Min QP among all encoded macroblocks in a picture
2175+
Min QP among all encoded macroblocks in a picture.
21572176

21582177
---
21592178

21602179
**Name:**
21612180
`AMF_VIDEO_ENCODER_STATISTIC_PIX_NUM_INTRA`
21622181

21632182
**Description:**
2164-
Number of intra-coded pixels
2183+
Number of intra-coded pixels.
21652184

21662185
---
21672186

21682187
**Name:**
21692188
`AMF_VIDEO_ENCODER_STATISTIC_PIX_NUM_INTER`
21702189

21712190
**Description:**
2172-
Number of inter-coded pixels
2191+
Number of inter-coded pixels.
21732192

21742193
---
21752194

21762195
**Name:**
21772196
`AMF_VIDEO_ENCODER_STATISTIC_PIX_NUM_SKIP`
21782197

21792198
**Description:**
2180-
Number of skip-coded pixels
2199+
Number of skip-coded pixels.
21812200

21822201
---
21832202

21842203
**Name:**
21852204
`AMF_VIDEO_ENCODER_STATISTIC_BITCOUNT_RESIDUAL`
21862205

21872206
**Description:**
2188-
Frame level bit count of residual data
2207+
Frame level bit count of residual data.
21892208

21902209
---
21912210

21922211
**Name:**
21932212
`AMF_VIDEO_ENCODER_STATISTIC_BITCOUNT_MOTION`
21942213

21952214
**Description:**
2196-
Frame level bit count of motion vectors
2215+
Frame level bit count of motion vectors.
21972216

21982217
---
21992218

22002219
**Name:**
22012220
`AMF_VIDEO_ENCODER_STATISTIC_BITCOUNT_INTER`
22022221

22032222
**Description:**
2204-
Frame level bit count of inter macroblocks
2223+
Frame level bit count of inter macroblocks.
22052224

22062225
---
22072226

22082227
**Name:**
22092228
`AMF_VIDEO_ENCODER_STATISTIC_BITCOUNT_INTRA`
22102229

22112230
**Description:**
2212-
Frame level bit count of intra macroblocks
2231+
Frame level bit count of intra macroblocks.
22132232

22142233
---
22152234

22162235
**Name:**
22172236
`AMF_VIDEO_ENCODER_STATISTIC_BITCOUNT_ALL_MINUS_HEADER`
22182237

22192238
**Description:**
2220-
Frame level bit count of the bitstream excluding header
2239+
Frame level bit count of the bitstream excluding header.
22212240

22222241
---
22232242

22242243
**Name:**
22252244
`AMF_VIDEO_ENCODER_STATISTIC_MV_X`
22262245

22272246
**Description:**
2228-
Accumulated absolute values of MVX
2247+
Accumulated absolute values of MVX.
22292248

22302249
---
22312250

22322251
**Name:**
22332252
`AMF_VIDEO_ENCODER_STATISTIC_MV_Y`
22342253

22352254
**Description:**
2236-
Accumulated absolute values of MVY
2255+
Accumulated absolute values of MVY.
22372256

22382257
---
22392258

22402259
**Name:**
22412260
`AMF_VIDEO_ENCODER_STATISTIC_RD_COST_FINAL`
22422261

22432262
**Description:**
2244-
Frame level final RD cost
2263+
Frame level final RD cost.
22452264

22462265
---
22472266

22482267
**Name:**
22492268
`AMF_VIDEO_ENCODER_STATISTIC_RD_COST_INTRA`
22502269

22512270
**Description:**
2252-
Frame level RD cost for intra mode
2271+
Frame level RD cost for intra mode.
22532272

22542273
---
22552274

22562275
**Name:**
22572276
`AMF_VIDEO_ENCODER_STATISTIC_RD_COST_INTER`
22582277

22592278
**Description:**
2260-
Frame level RD cost for inter mode
2279+
Frame level RD cost for inter mode.
22612280

22622281
---
22632282

22642283
**Name:**
22652284
`AMF_VIDEO_ENCODER_STATISTIC_SATD_FINAL`
22662285

22672286
**Description:**
2268-
Frame level final SATD
2287+
Frame level final SATD.
22692288

22702289
---
22712290

22722291
**Name:**
22732292
`AMF_VIDEO_ENCODER_STATISTIC_SATD_INTRA`
22742293

22752294
**Description:**
2276-
Frame level SATD for intra mode
2295+
Frame level SATD for intra mode.
22772296

22782297
---
22792298

22802299
**Name:**
22812300
`AMF_VIDEO_ENCODER_STATISTIC_SATD_INTER`
22822301

22832302
**Description:**
2284-
Frame level SATD for inter mode
2303+
Frame level SATD for inter mode.
22852304

22862305
---
22872306

2288-
### Table A-5. Encoder PSNR/SSIM feedback
2307+
### Table A-4. Encoder PSNR/SSIM feedback
22892308

22902309
| Name (prefix "AMF_VIDEO_ENCODER_") | Type |
22912310
| :--------------------------------- | :----- |

amf/doc/AMF_Video_Encode_API.pdf

11.6 KB
Binary file not shown.

0 commit comments

Comments
 (0)