Welcome to v8.5.1 of the Mac, Windows & Linux R3D SDK!

For any feedback, bugs or questions please contact r3dsdk@red.com


Important 8.5 notes
-----------------------------------------------------------
NOTE: 12 GB minimum VRAM recommended for GPU
NOTE: Metal processing uses ARC (Automatic Reference Counting)


What's new for the 8.5.1 release
-----------------------------------------------------------
The 8.5.1 release contains these changes:
- Extended Highlight clips always decode in IPP2
- Improved IPP2 out of gamut color mapping
- Improved IPP2 high ISO black level consistency
- Improved CUDA kernel memory overlap

The 8.5.1 release contains bug fixes for:
- Fixed: OpenCL Extended Highlights
- Fixed: OpenCL Maskline Adjust
- Fixed: CPU multi-threaded Extended Highlights hang
- Fixed: GPU half-float output
- Fixed: GPU Monochrome decodes
- Fixed: GPU early KOMODO footage is green
- Fixed: CUDA Legacy DEB output
- Fixed: Metal Texture + Legacy decodes
- Fixed: Metal half-float + Legacy crash
- Fixed: OpenCL Image + Legacy decodes

The 8.5.0 release contains these changes:
- Added V-RAPTOR [X] support
- Added V-RAPTOR [X] Phantom Track metadata (RMD_PHANTOM_TRACK_INDEX, FRAME_GAP & TRACK_COUNT)
- Added RMD_USER_EXT_FILTER_[1-3], EXT_(T)LUT, EXT_PROXY, EXT_UPLOAD_SERVICE & EXT_GPS metadata
- Added V-RAPTOR [X] Extended Highlights - BETA support
- Removed PixelType_12Bit_BGR_Interleaved as it was never supported for GPU decodes

The 8.5.0 release contains bug fixes for:
- Fixed: RMD_SENSOR_ID metadata could be incorrect
- Fixed: RED ONE trim (bug was introduced in 8.4.0)
- Fixed: CPU IPP2 half resolution CNR
- Fixed: CPU IPP2 Maskline Adjust


Additional links
-----------------------------------------------------------
Sample R3D clips: http://www.red.com/sample-r3d-files

RED LUT KITS:
- https://www.red.com/download/3d-cude-luts-and-ipp2
- https://www.red.com/download/red-lut-kit

REDCINE-X PRO and REDline:
- https://www.red.com/download/redcine-x-pro-win
- https://www.red.com/download/redcine-x-pro-mac
- https://www.red.com/download/redline-linux-beta


Introduction
-----------------------------------------------------------
The R3D SDK contains the following functionality:

- Compatible with DSMC3 firmware up to build 1.7.X
- Compatible with all DSMC/DSMC2 firmware
- Compatible with all RED ONE firmware
- Opening of R3D clips (consisting of one or more R3D files)
- Extracting clip properties and associated metadata
- Decoding video frames at various resolutions, qualities & with different image & HDR processing settings
- Decoding of audio samples and audio blocks
- Assistance for getting the right options & ranges for the image processing into your User Interface
- Auto White Balance from a user selectable point
- RMD sidecar support to update a clips look and have it stay with the clip
- 3D LUT (CUBE) sidecar support
- Single or multi-GPU processing through CUDA, Metal or OpenCL


Hardware acceleration requirements
-----------------------------------------------------------
- CUDA: CUDA 6.5 runtime or higher, GPU compute capability 3.0 or higher
- OpenCL: 1.1 or higher. CPU OpenCL devices not supported
- Metal: macOS 10.11 minimum, 10.14 or higher recommended for concurrent dispatch support
- Minimum of 8 GB of graphics card memory, 12 GB or more recommended
- NOTE: GPU acceleration is not available for HDRx blending or ColorVersion1
- NOTE: GPUDecoder decompression support not available for RED ONE clips
- NOTE: GPU decompression and Metal image processing not yet supported with R3DDecoder class


What is included
-----------------------------------------------------------
- How to use the SDK.txt              : how to use the SDK, installation & building your application
- IPP2 How to use.txt                 : how to use the newer IPP2 image processing pipe
- IPP2 Image Pipeline Stages.pdf      : high level overview of the IPP2 image processing pipe, its goals and the parts that make up IPP2
- OpenCL kernel caching.txt           : tips on avoiding lengthy OpenCL startup delays due to kernel compilation
- R3D SDK readme.txt                  : this document
- Release history.txt                 : release notes for all versions released
- SDK License Agreement.pdf           : license agreement for the R3D SDK
- White Paper on RWG and Log3G10.pdf  : White paper on and definitions for REDWideGamutRGB and Log3G10
- Include\R3DSDK.h                    : include this first to get access to R3D loading and procesing
- Include\R3DSDKCuda.h                : include to use RED CUDA processing in your existing CUDA pipeline
- Include\R3DSDKCustomIO.has          : include to replace the SDK I/O back-end with a custom implementation
- Include\R3DSDKDecoder.h             : include to use RED managed GPU processing using either CUDA or OpenCL
- Include\R3DSDKDefinitions.h         : various definitions (no need to directly include this as R3DSDK.h does so)
- Include\R3DSDKMetadata.h            : metadata definitions (no need to directly include this as R3DSDK.h does so)
- Include\R3DSDKMetal.h               : include to use RED Metal processing in your existing Apple Metal pipeline
- Include\R3DSDKOpenCL.h              : include to use RED OpenCL processing in your existing OpenCL pipeline
- Include\R3DSDKRocket.h              : include to use RED Rocket processing
- Include\R3DSDKStream.h              : include to process incoming camera network stream and save to R3D clips
- Lib\linux32\libR3DSDK*.a            : Linux 32-bit Intel static libraries that must be linked to your project.
- Lib\linux64\libR3DSDK*.a            : Linux 64-bit Intel static libraries that must be linked to your project.
- Lib\mac64\libR3DSDK-libcpp.a        : Mac Universal 64-bit Intel/Apple Silicon static library that must be linked to your project.
- Lib\win32\R3DSDK-*.lib              : Windows 32-bit Intel static libraries that must be linked to your project.
- Lib\win64\R3DSDK-*.lib              : Windows 64-bit Intel static libraries that must be linked to your project.
- Redistributable\linux\              : Dynamic libraries (.so) you must distribute with your Linux application
- Redistributable\mac\                : Dynamic libraries (.dylib) you must distribute with your macOS application
- Redistributable\win\                : Dynamic libraries (.DLL) you must distribute with your Windows application
- Sample code\GetSdkVersionSample.cpp : simple example to initialize SDK & display version information (good to info to log!)
- Sample code\Audio decode\           : decode audio in two different ways
- Sample code\Clip info and metadata\ : get clip properties & metadata and check files for CRC errors
- Sample code\CPU decoding\           : basic CPU only decoding, image processing and HDRx blending
- Sample code\Creating clips\         : create new shorter R3D clips and stream compressed R3D data from a camera over the network
- Sample code\Custom IO\              : replace the SDK I/O back-end with a custom implementation
- Sample code\GPU decoding\           : CUDA, OpenCL and Metal GPU accelerated decoding


Copyright
-----------------------------------------------------------------
The R3D SDK and all included materials (including header files, libraries,
sample code & documentation) are Copyright (C) 2008-2024 RED Digital Cinema.
All rights reserved. All trademarks are the property of their respective owners.

This software was developed using KAKADU software.
