Composite Blur (original) (raw)

Composite Blur Logo ​

A feature rich and efficient blur plugin for OBS​

Latest release supports obs versions 28, 29, and 30
​

Introduction​

Composite Blur Plugin is a comprehensive blur plugin that provides blur algorithms and types for all levels of quality and computational need.

For a fantastic overview of the plugin, check out AndiLippi's awesome Composite Blur video:

IMPORTANT RECENT RELEASE NOTES​

Note​

While we only release new versions of Composite Blur after testing it extensively on local hardware, there are bugs and issues that will slip through. If you happen to run into any issues, please post a message here, or open an issue on the GitHub repository and we will work to resolve it.​

Installation​

Windows​

The easiest way to install on windows is to download the windows installer zip from the Downloads link above, and run the installer. If instead you wish to manually install:

  1. Download the non installer version from the Download link above.
  2. Unzip the download in the OBS folder for example:
    C:\Program Files\obs-studio\
    or
    C:\Program Files (x86)\obs-studio
  3. Install latest visual c++ redistributable for visual studio 2019
  4. Start OBS Studio
  5. Add the Composite Blur filter to the sources you want to blur.
  6. Have fun blurring all the things!

MacOS​

MacOS requires non-signed installers (such as the installer for this plugin) to be approved by the user at install time, requiring some extra steps. To install for MacOS:

  1. Download the MacOS zip file from the Download link above.
  2. When the download is complete, open the composite-blur-macos folder that was downloaded.
  3. Double click the package you want to use. In most cases the Universal installer is what you want to use.
  4. A warning will appear that the package can not be opened because it is coming from an unidentified developer. Click "OK".
  5. Open the System Settings app.
  6. Click Privacy & Security
  7. Scroll down to the Security section. You should see a notice that "obs-compos...pkg" was blocked from use because it is not from an identified developer. Click "Open Anyway"
  8. Enter your password to continue.
  9. Click Open on the message that appears confirming you want to install the plugin.
  10. Work your way through the installer.
  11. IMPORTANT- If you are on an Apple Silicon Mac (M1, M2, etc) make sure to "Install for Me Only" rather than install for all users.
  12. Start OBS Studio
  13. Add the Composite Blur filter to the sources you want to blur.
  14. Have fun blurring all the things!

Linux​

  1. Download the Linux zip file from the Download link above.
  2. Unzip the downloaded archive.
  3. Copy to $HOME/.config/obs-studio/plugins
  4. Start OBS Studio
  5. Add the Composite Blur filter to the sources you want to blur.
  6. Have fun blurring all the things!

Blur Algorithms​

Composite Blur provides several different algorithms to blur your sources. The blur algorithms are written with performance in mind using techniques like linear sampling and GPU texture interpolation to stretch what your GPU can do. Additionally, the algorithms have been written with finely adjustable blur amounts, that allow for smooth transitions and animations when using other plugins like Move Transition.

blur-algorithms.jpg

Example showing area blur for different algorithms.

Gaussian​

A high quality blur algorithm that uses a gaussian kernel to sample/blur. Gaussian sampling results in an aesthetically pleasing blur, but becomes computationally intensive at higher blur radius. This plugin supports fractional pixels for Gaussian blur, which allows for smooth animation when using plugins like Move Transition. The Gaussian Blur Algorithm supports Area, Directional, Zoom, and Motion blur effects.

Box​

Box blur works similar to Gaussian, but uses an equally weighted sample of surrounding pixels. The upside is a more efficient blurring algorithm, at the expense of some quality. With one pass, box blur can cause some blocky artifacts in some cases. This can be mitigated by increasing the number of passes- a 2 pass box blur has nearly the same quality as Gaussian blur. This plugin allows the user to specify up to 5 passes. Similar to Gaussian, this implementation of box blur allows for fractional pixels for smooth animation. The Box Blur Algorithm supports Area, Directional, Zoom, and Tilt-Shift blur effects.

Dual Kawase (Dual Filter)​

Dual Kawase is a blurring algorithm that uses down and up-sampling in order to blur the image. It has a high quality blur with little artifacting and is computationally efficient especially at larger blur values. The naïve implementation of Dual Kawase however has very large jumps in blur- essentially doubling the blur at each step. This implementation sacrifices a small amount of efficiency, but allows intermediate blur values by using linear interpolation during the final down-samping step. This gives a continuous change in blur values. The most common use for Dual Kawase is when you need a very high blur radius, but with the linear interpolation step this implementation has, it can also be used as a general blur. Due to how the algorithm works, only Area blur is available.

Pixelate​

Pixelate divides the source into larger pixels, effectively down-sampling the image, and giving it a bitmap like appearance. This plugin allows the user to specify the pixel size and shape. Supported shapes are Square, Hexagon, Triangle, and Circle. As with the other algorithms, fractional pixel sizes (blur radius) are supported. The Pixelate Algorithm only supports the Area blur effect.

Blur Effects​

Composite Blur provides several different blur effects or types, all giving a different feel to the resulting image.

Area​

Area blur is the typical 2D blur where pixels are blurred equally in all directions. The only adjustable input for area blur is the blur radius (or pixel size for pixelate).

area-blur.jpg

Directional​

Directional blur is a blur applied along a single axis, but is blurred in both the positive and negative direction. Adjustable inputs for directional blur are the blur radius and direction angle.

directional-blur.jpg

Motion​

Motion blur is similar to Directional Blur, however it is applied in only the positive direction along the blur axis. This yields an image that simulates a camera capturing blur due to motion in a particular direction. Adjustable inputs are blur radius and direction angle.

motion-blur.jpg

Zoom​

Zoom blur is applied away from a center zoom point, and increases the further from the center point the pixel being blurred is. This yields an image that looks like the viewer is zooming into the center zoom point. Adjustable inputs are blur radius, and center zoom point location.

zoom-blur.jpg

Tilt-Shift​

Tilt-Shift blur defines an in-focus plane, specified by a location in the frame, and a thickness. All pixels outside of the in-focus plane have their blur value increased the further away from the plane they are. The resulting image gives a distorted sense of scale, making large objects look like mineature models. When applied to video scenes like a city street, the effect can be significant. Adjustable inputs are blur radius, focus plane angle, focus plane location, and focus plane thickness.

tilt-shift-blur.jpg

Composite Background​

Blurring sources that have different dimensions than the canvas can be difficult to do in OBS, as filters do not have access to what is being blurred behind the filtered source. Composite Blur gives users the option to add a second OBS source as the Background Source for Compositing input, allowing the blur algorithms to mix in the proper color. This prevents the dark halos that are seen around such masked sources after blurring. This does, however, require that both the masked/blurred source, and the background source, have the same aspect ratio, and 1:1 overlay/coverage.

background-composite.jpg

An example with and without background source compositing. Notice the dark halo around the non-composited facecam, versus the smooth and more natural blurring into the background when a background source is provided.

Warning​

There is currently a bug that requires composite background enabled sources to set their blending method to SRGB Off if the source is cropped in OBS. To do this, right click the source, and select 'SRGB Off' under Blending Method​

Effect Masking​

Composite Blur offers a variety of ways to mask where and how blur is applied to your source. For all mask options, the mask can also be inverted by checking the "Invert Mask" box. The following options are available.

mask-examples.jpg

Examples of the different types of masks.

Crop​

Specify the percentage distance in from the top, bottom, left, and right edges of your source that you want masked. Additionally, the crop mask allows you to specify a corner radius for those smooth rounded corners.

Rectangle​

Is the same as the Crop option, but instead of specifying the edges, you specify the center of the rectangle, the rectangle width, and rectangle height. This is easier to use with plugins like Move Transition if you want to animate the movement or size of the rectangular masked blur.

Circle​

Similar to the Rectangle option, but lets you specify the center of a circle and its radius. Some nice sweep effects can be made by using a very large circle, and moving it from off the source (less than 0 or greater than 100 for the center coordinates) over the source.

Source​

Use another OBS source or scene as a mask for your blur. Simply select the source or scene you want to use, and then specify if you want to use the source's alpha channel, grayscale value, luminosity, or a custom combination of the red, green, blue, and alpha channels to mask the blur effect. You can also multiply the resulting mask by a value. The multiply value comes in handy if you have a translucent source, but want everything behind the translucent source to be fully blurred.

Image​

All of the same options as Source, but allows you to select an image file rather than a source.

For 1:1 pixel images of the example images posted, please Visit the GitHub Repository.