Skip to content

Commit fc76462

Browse files
committed
Update table in HW-ACCEL.md for Doxygen
By using actual Unicode characters for the various ✔️ and ❌ marks in the table, Doxygen will format it properly. Also: - Changed to superscripted numerals, for the various callouts - Reformatted notes into a corresponding ordered list - Added invisible spaces after the marks without a callout, to balance centering - Added center-alignment markers to appropriate table columns
1 parent 90a5610 commit fc76462

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

doc/HW-ACCEL.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,22 @@ our support for this in the future!
77

88
The following table summarizes our current level of support:
99

10-
| | Linux Decode | Linux Encode | Mac Decode | Mac Encode |Windows Decode| Windows Encode | Notes |
11-
|--------------------|------------------------|----------------------|------------------|----------------|--------------|------------------|------------------|
12-
| VA-API | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | *Linux Only* |
13-
| VDPAU | :heavy_check_mark:(+) |:white_check_mark:(++)| - | - | - | - | *Linux Only* |
14-
| CUDA (NVDEC/NVENC) | :x:(+++) | :heavy_check_mark: | - | - | - |:heavy_check_mark:| *Cross Platform* |
15-
| VideoToolBox | - | - |:heavy_check_mark:| :x:(++++) | - | - | *Mac Only* |
16-
| DXVA2 | - | - | - | - | :x:(+++) | - | *Windows Only* |
17-
| D3D11VA | - | - | - | - | :x:(+++) | - | *Windows Only* |
18-
| QSV | :x:(+++) | :x: | :x: | :x: | :x: | :x: | *Cross Platform* |
19-
20-
* *(+) VDPAU for some reason needs a card number one higher than it really is*
21-
* *(++) VDPAU is a decoder only.*
22-
* *(+++) Green frames (pixel data not correctly tranferred back to system memory)*
23-
* *(++++) Crashes and burns*
10+
| | Linux Decode | Linux Encode | Mac Decode | Mac Encode | Windows Decode | Windows Encode | Notes |
11+
|--------------------|:---------------:|:--------------:|:----------:|:--------------:|:--------------:|:--------------:|------------------|
12+
| VA-API | ✔️   | ✔️   | - | - | - | - | *Linux Only* |
13+
| VDPAU | ✔️ <sup>1</sup> | ✅ <sup>2</sup> | - | - | - | - | *Linux Only* |
14+
| CUDA (NVDEC/NVENC) | ❌ <sup>3</sup> | ✔️ &nbsp; | - | - | - | ✔️ &nbsp; | *Cross Platform* |
15+
| VideoToolBox | - | - | ✔️ &nbsp; | ❌ <sup>4</sup> | - | - | *Mac Only* |
16+
| DXVA2 | - | - | - | - | ❌ <sup>3</sup> | - | *Windows Only* |
17+
| D3D11VA | - | - | - | - | ❌ <sup>3</sup> | - | *Windows Only* |
18+
| QSV | ❌ <sup>3</sup> |&nbsp; |&nbsp; |&nbsp; |&nbsp; |&nbsp; | *Cross Platform* |
19+
20+
#### Notes
21+
22+
1. VDPAU for some reason needs a card number one higher than it really is
23+
2. VDPAU is a decoder only
24+
3. Green frames (pixel data not correctly tranferred back to system memory)
25+
4. Crashes and burns
2426

2527
## Supported FFmpeg Versions
2628

@@ -37,7 +39,7 @@ included.
3739
The following settings are use by libopenshot to enable, disable, and control
3840
the various hardware acceleration features.
3941

40-
```
42+
```{cpp}
4143
/// Use video codec for faster video decoding (if supported)
4244
int HARDWARE_DECODER = 0;
4345
@@ -76,9 +78,9 @@ in Ubuntu 18.04) for the AppImage to work with hardware acceleration.
7678
An AppImage that works on both systems (supporting libva and libva2),
7779
might be possible when no libva is included in the AppImage.
7880

79-
* vaapi is working for intel and AMD
80-
* vaapi is working for decode only for nouveau
81-
* nVidia driver is working for export only
81+
* vaapi is working for intel and AMD
82+
* vaapi is working for decode only for nouveau
83+
* nVidia driver is working for export only
8284

8385
## AMD Graphics Cards (RadeonOpenCompute/ROCm)
8486

0 commit comments

Comments
 (0)