Skip to content

Commit 5b32766

Browse files
committed
Update VQ Enhancer API doc
1 parent 85eea8d commit 5b32766

2 files changed

Lines changed: 42 additions & 10 deletions

File tree

amf/doc/AMF_VQ_Enhancer_API.md

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Windows™, Visual Studio and DirectX are trademark of Microsoft Corp.
1818

1919
### Copyright Notice
2020

21-
© 2022-2023 Advanced Micro Devices, Inc. All rights reserved
21+
© 2022-2024 Advanced Micro Devices, Inc. All rights reserved
2222

2323
Notice Regarding Standards. AMD does not provide a license or sublicense to any Intellectual Property Rights relating to any standards, including but not limited to any audio and/or video codec technologies such as MPEG-2, MPEG-4; AVC/H.264; HEVC/H.265; AAC decode/FFMPEG; AAC encode/FFMPEG; VC-1; and MP3 (collectively, the "Media Technologies"). For clarity, you will pay any royalties due for such third party technologies, which may include the Media Technologies that are owed as a result of AMD providing the Software to you.
2424

2525
### MIT license
2626

27-
Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
27+
Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved.
2828

2929
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
3030

@@ -81,21 +81,25 @@ VQ enhancer supports the following input and output formats:
8181

8282
The output format must be same as the input and the format conversion is not supported. The parameters of the output stream are set using the following properties:
8383

84-
| Name (prefix "AMF_VQ_ENHANCER_") | Type |
85-
| :---------------------------------- | :---- |
86-
|ENGINE_TYPE |AMF_MEMORY_TYPE|
87-
|OUTPUT_SIZE |AMFSize |
88-
|ATTENUATION |Float |
84+
| Name (prefix "AMF_VIDEO_ENHANCER" / "AMF_VE_FCR_") | Type |
85+
| :------------------------------- | :-------------- |
86+
| ENGINE_TYPE | AMF_MEMORY_TYPE |
87+
| OUTPUT_SIZE | AMFSize |
88+
| ATTENUATION | Float |
89+
| RADIUS [^1] | amf_int64 |
90+
| SPLIT_VIEW | amf_int64 |
8991

9092
<p align="center">
9193
Table 1. AMF VQ Enhancer properties of the output stream
9294
</p>
9395

96+
[^1]: Deprecated.
97+
9498
---
9599

96100
**Name:**
97101

98-
`AMF_VQ_ENHANCER_ENGINE_TYPE`
102+
`AMF_VIDEO_ENHANCER_ENGINE_TYPE`
99103

100104
**Values:**
101105
`AMF_MEMORY_DX11`, `AMF_MEMORY_DX12`, `AMF_MEMORY_VULKAN`,`AMF_MEMORY_OPENCL`
@@ -109,7 +113,7 @@ Specifies the memory type of output surfaces (surfaces are allocated internally
109113
---
110114

111115
**Name:**
112-
`AMF_VQ_ENHANCER_OUTPUT_SIZE`
116+
`AMF_VIDEO_ENHANCER_OUTPUT_SIZE`
113117

114118
**Values:**
115119
A valid size
@@ -123,7 +127,7 @@ Output image resolution. VQ enhancer will be performed when this property is se
123127
---
124128

125129
**Name:**
126-
`AMF_VQ_ENHANCER_ATTENUATION`
130+
`AMF_VE_FCR_ATTENUATION`
127131

128132
**Values:**
129133
Float in the range of `[0.02, 0.4]`
@@ -136,6 +140,34 @@ Control VQEnhancer strength.
136140

137141
---
138142

143+
**Name:**
144+
`AMF_VE_FCR_RADIUS`
145+
146+
**Values:**
147+
Int in the range of `[1, 4]`
148+
149+
**Default Value:**
150+
`4`
151+
152+
**Description:**
153+
Deprecated. Setting this property has no effect.
154+
155+
---
156+
157+
**Name:**
158+
`AMF_VE_FCR_SPLIT_VIEW`
159+
160+
**Values:**
161+
`0` / `1` (OFF / ON)
162+
163+
**Default Value:**
164+
`0`
165+
166+
**Description:**
167+
Experimental. When set, enables a side by side view with processing enabled on one side and disabled on the other side.
168+
169+
---
170+
139171
### 2.3 Submitting Input and Retrieving Output
140172

141173
Once the VQ enhancer component is successfully initialized, you may start submitting input samples to it. Input samples must be submitted as `AMFSurface` objects.

amf/doc/AMF_VQ_Enhancer_API.pdf

24.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)