Skip to content

Commit d6fb173

Browse files
dabrain34zlatinski
authored andcommitted
update doc to follow new build infra
1 parent 44fa4da commit d6fb173

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

BUILD.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ The Windows and Linux BETA drivers are available for download at https://develop
1818

1919
### Download the Repository
2020

21-
> Note: An alternative version of this repository is also available at the official Khronos Group repository:
22-
> https://github.com/KhronosGroup/Vulkan-Video-Samples
21+
> Note: An alternative version of this repository is also available:
22+
> https://github.com/nvpro-samples/vk_video_samples
2323
2424
```bash
25-
VULKAN_VIDEO_GIT_REPO="https://github.com/nvpro-samples/vk_video_samples.git"
25+
VULKAN_VIDEO_GIT_REPO="https://github.com/KhronosGroup/Vulkan-Video-Samples.git"
2626
git clone $VULKAN_VIDEO_GIT_REPO
2727
cd vk_video_samples
2828
```
@@ -107,7 +107,7 @@ sudo apt-get install git cmake build-essential libx11-xcb-dev libxkbcommon-dev \
107107

108108
1. Execute the dependency script:
109109
```bash
110-
./ubuntu-update-dependencies.sh
110+
./vk_video_decoder/ubuntu-update-dependencies.sh
111111
```
112112

113113
2. Configure and build:
@@ -127,12 +127,12 @@ vulkaninfo | grep VK_KHR_video
127127

128128
For decoder testing:
129129
```bash
130-
./demos/vk-video-dec-test -i '<Video content file with h.264 or h.265 format>' [--c N]
130+
./vk_video_decoder/demos/vk-video-dec-test -i '<Video content file with h.264 or h.265 format>' [--c N]
131131
```
132132

133133
For encoder testing:
134134
```bash
135-
./demos/vk-video-enc-test -i <yuv-video-input-file.yuv> --codec <"h264" | "h265" | "av1"> \
135+
./vk_video_encoder/demos/vk-video-enc-test -i <yuv-video-input-file.yuv> --codec <"h264" | "h265" | "av1"> \
136136
--inputNumPlanes <2 | 3> --inputWidth <input Y width> --inputHeight <input Y height> \
137137
--startFrame 0 --numFrames <max frame num>
138138
```

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# VK_VULKAN_VIDEO
22

3-
This project conatins two Vulkan Video sample applications which demonstrate video decoding and encoding, respectively. These samples can be independently compiled. Instructions on how to build either the encoder or decoder sample are present within each respective folder.
3+
This project contains two Vulkan Video sample applications which demonstrate video decoding and encoding, respectively. Instructions on how to build either the encoder or decoder sample are present within the root folder.
44

55
## VK_VIDEO_DECODE
66

77
![vk_video_decode](vk_video_decoder/doc/VideoDecode.png)
88

99

10-
This project is a Vulkan Video Sample Application demonstrating an end-to-end, all-Vulkan, processing of h.264/5 compressed video content. The application decodes the h.264/5 compressed content using an HW accelerated decoder, the decoded YCbCr frames are processed with Vulkan Graphics and then presented via the Vulkan WSI.
10+
This project is a Vulkan Video Sample Application demonstrating an end-to-end, all-Vulkan, processing of h.264/5, AV1 compressed video content. The application decodes the compressed content using an HW accelerated decoder, the decoded YCbCr frames are processed with Vulkan Graphics and then presented via the Vulkan WSI.
1111

1212
Currently, the sample application supports Linux and Windows10 operating systems.
1313

1414

1515
Features
1616
========
1717

18-
- [x] Extracts (DEMUX via FFMPEG) compressed video from .mp4, .mkv .mov and others video containers using h.264 (AVC), h.265 (HEVC) or AV1 compression formats.
19-
- [x] The HW video decoder processes textures to Vulkan Video Images that can be directly sampled from Vulkan Samplers (Textures).
18+
- [x] Extracts (DEMUX via FFMPEG) compressed video from .mp4, .mkv, .mov and others video containers using h.264 (AVC), h.265 (HEVC) or AV1 compression formats.
19+
- [x] The HW video decoder processes textures to Vulkan Video Images that can be directly sampled from Vulkan Samplers (Textures).
2020
- [x] Converts the YCbCr (YUV) Images to RGB while sampling the decoded images using the [VK_KHR_sampler_ycbcr_conversion](https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_KHR_sampler_ycbcr_conversion.html)
2121
- [x] Displays the post-processed video frames using Vulkan WSI.
2222
- [ ] Use Video display timing synchronization (such as VK_EXT_present_timing) at the WSI side - currently the video is played at the maximum frame rate that the display device can support. The video may be played at a faster rate than it is authored.
2323

2424

25-
For instructions on how to build the sample decode application, please see [the build instructions.](https://github.com/nvpro-samples/vk_video_samples/blob/main/vk_video_decoder/BUILD.md)
25+
For instructions on how to build the sample decode application, please see [the build instructions.](https://github.com/KhronosGroup/Vulkan-Video-Samples/blob/main/BUILD.md)
2626

2727
Please download and install [Beta NVIDIA Driver with Vulkan Video Enabled](https://developer.nvidia.com/vulkan-driver).
2828

@@ -32,7 +32,7 @@ For deep-dive information on Vulkan Video please refer to the [Deep Dive Slide D
3232

3333
## VK_VIDEO_ENCODE
3434

35-
This project is a Nvpro-based Vulkan Video sample application demonstrating video encoding. By using the Vulkan video encoding extensions to drive the HW-accelerated video encoder, this application encodes YCbCr content and writes the h.264 or h.265 compressed video to a file.
35+
This project is a Nvpro-based Vulkan Video sample application demonstrating video encoding. By using the Vulkan video encoding extensions to drive the HW-accelerated video encoder, this application encodes YCbCr content and writes the h.264, h.265 or AV1 compressed video to a file.
3636

3737
The sample is still in development and has issues such as missing POC numbers and corrupted frames.
3838

@@ -55,7 +55,7 @@ Features
5555
- [x] Support for multi-threaded encoding
5656
- [x] Tested 10-bit encoding
5757

58-
For instructions on how to build the sample decode application, please see [the build instructions.](https://github.com/nvpro-samples/vk_video_samples/blob/main/vk_video_encoder/BUILD.md)
58+
For instructions on how to build the sample decode application, please see [the build instructions.](https://github.com/KhronosGroup/Vulkan-Video-Samples/blob/main/BUILD.md)
5959

6060
Please download and install [Beta NVIDIA Driver with Vulkan Video Enabled](https://developer.nvidia.com/vulkan-driver).
6161

@@ -109,4 +109,4 @@ On Windows:
109109

110110
Do not use `~all~` or `~explicit~` options with `VK_LOADER_LAYERS_DISABLE` because these options disable the validation layers that other applications might attempt to enable programmaticaly.
111111

112-
For more information on Layers configuration please refer to the [LunarG, Layers Configuration](https://vulkan.lunarg.com/doc/sdk/1.3.290.0/windows/layer_configuration.html)
112+
For more information on Layers configuration please refer to the [LunarG, Layers Configuration](https://vulkan.lunarg.com/doc/sdk/latest/windows/layer_configuration.html)

0 commit comments

Comments
 (0)