Skip to content

Instantly share code, notes, and snippets.

@keijiro
Last active March 22, 2017 06:07
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save keijiro/bb38fe69ef3d0811f75eed03680982b8 to your computer and use it in GitHub Desktop.
Save keijiro/bb38fe69ef3d0811f75eed03680982b8 to your computer and use it in GitHub Desktop.

ProcAmp

ProcAmp is a utility shader for tweaking video frames. It's developed for providing optional functionalities of video playback with the VideoPlayer component that is newly introduced in Unity 5.6.

System Requirements

  • Unity 5.6

ProcAmp is supposed to be available in all the platforms. If you find any problem, plaese report it to Issues.

Available Functionalities

  • Basic color adjustment (brightness, contrast and saturation).
  • White balance (temperature and cyan-purple tint).
  • Chroma keying and spill removal.
  • Basic transform (trimming, scaling and position offset).

Implementation

There are two variants of implementation of ProcAmp.

  • The ProcAmp shader can be used with a material asset. It provides all the basic functionalities of ProcAmp.

  • The ProcAmp component can be used with a game object. It also provides optional functionalities that are useful in complex setups.

Examples of Use Cases

Apply ProcAmp and blit to the screen.

The ProcAmp component provides a simple rendering functionality that blits the resulting images to the screen with fit-to-screen scaling. This would be a handy option when trying to show the video in full-screen mode.

Typical steps to use

  • Create a VideoPlayer (drag & drop a video asset to the hierarchy).
  • Change Render Mode of the VideoPlayer to "API Only".
  • Add the ProcAmp component to the game object.
  • That's it!

Apply ProcAmp and show in a RawImage UI element.

When considering to support multiple resolution/aspect ratio, it's recommended using the RawImage component of the UI system to handle the situation properly. The TargetImage property of ProcAmp is used in such cases. It updates a given RawImage with resulting images.

Typical steps to use

  • Create a UI canvas and add a RawImage to it.
  • Create a VideoPlayer (drag & drop a video asset to the hierarchy).
  • Change Render Mode of the VideoPlayer to "API Only".
  • Add the ProcAmp component to the game object. - Set the RawImage in the canvas to Target Image of the ProcAmp.

Use ProcAmp as a shader

The ProcAmp shader (Klak/Video/ProcAmp) is an unlit shader combined with the functionalities of ProcAmp. It's useful when using a material/renderer pair to display a video.

Typical steps to use

  • Create a quad object ("Create" -> "3D Object" -> "Quad").
  • Create a material and change shader to Klak/Video/ProcAmp.
  • Set this material to the quad object.
  • Create a VideoPlayer (drag & drop a video asset to the hierarchy).
  • Change Render Mode of the VideoPlayer to "Material Override".
  • Set the quad object to the Renderer property.
  • Change Material Property to "_MainTex".

Apply ProcAmp and output to a RenderTexture

When a RenderTexture is given to the TargetTexture property, it updates the given RenderTexture with resulting images. This is useful when trying to use the video with other shaders or renderers.

Apply ProcAmp as an image effect

The ProcAmp component works as an image effect when it's attached to a camera object. It overlays the resulting images onto the screen with fit-to-screen scaling.

License

MIT

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment