diff --git a/README.MD b/README.MD index 02aacd0..b5ad007 100644 --- a/README.MD +++ b/README.MD @@ -1,4 +1,5 @@ -**Nvidia VideoEffects SDK: API Source Code and Sample Applications** +# README +## Nvidia VideoEffects SDK: API Source Code and Sample Applications NVIDIA VideoEffects SDK is an SDK for enhancing and applying filters to videos at real-time. The SDK is powered by NVIDIA graphics processing units (GPUs) with Tensor Cores, and as a result, the algorithm throughput is greatly accelerated, and latency is reduced. @@ -25,3 +26,37 @@ NVIDIA VideoEffects SDK is distributed in the following parts: - An installer hosted on [RTX broadcast engine developer page](https://developer.nvidia.com/rtx-broadcast-engine) that installs the SDK DLLs, the models, and the SDK dependency libraries. Please refer to [SDK programming guide](https://github.com/NVIDIA/BROADCAST-VFX-SDK/blob/master/docs/NVIDIA%20Video%20Effects%20SDK%20Programming%20Guide.pdf) for configuring and integrating the SDK, compiling and running the sample applications. + +## System requirements +The SDK is supported on NVIDIA GPUs that are based on the NVIDIA® Turing™ architecture. Although the SDK can run on Turing™ GPUs without Tensor Cores, it is optimized for much higher performance on GPUs with Tensor Cores. + +* Windows OS supported: 64-bit Windows 10 +* Microsoft Visual Studio: 2017 (MSVC15.0) or later +* CMake: v3.12 or later +* NVIDIA Graphics Driver for Windows: 455.57 or later + +## NVIDIA Branding Guidelines +If you integrate an NVIDIA Broadcast Engine SDK within your product, please follow the required branding guidelines that are available [here]( +https://nvidia.frontify.com/d/uAobRitG8H8B) + +## Compiling the sample apps + +### Steps + +The open source repository includes the source code to build the sample applications, and a proxy file NVVideoEffectsProxy.cpp to enable compilation without explicitly linking against the SDK DLL. + +**Note: To download the models and runtime dependencies required by the features, you need to run the [SDK Installer](https://developer.nvidia.com/rtx-broadcast-engine).** + +1. In the root folder of the downloaded source code, start the CMake GUI and specify the source folder and a build folder for the binary files. +* For the source folder, ensure that the path ends in OSS. +* For the build folder, ensure that the path ends in OSS/build. +2. Use CMake to configure and generate the Visual Studio solution file. +* Click Configure. +* When prompted to confirm that CMake can create the build folder, click OK. +* Select Visual Studio for the generator and x64 for the platform. +* To complete configuring the Visual Studio solution file, click Finish. +* To generate the Visual Studio Solution file, click Generate. +* Verify that the build folder contains the NvVideoEffects_SDK.sln file. +3. Use Visual Studio to generate the application binary .exe file from the NvVideoEffects_SDK.sln file. +* In CMake, to open Visual Studio, click Open Project. +* In Visual Studio, select Build > Build Solution.