Sapphire Plug-ins for OFX, General User Info



What's New in This Version

New in 1.03:

  1. Mac OS 10.6 Snow Leopard is supported.

New in 1.02:

  1. A problem with thresholds in Glow, Glint, Glare and Convolve is fixed. This gives improved but slightly different results from previous versions, and it makes the results compatible with Sapphire on other host products.
  2. A problem with Flicker Match and Flicker Remove on Windows is fixed.
  3. A problem with the Help dialog failing to open the documentation on Windows is fixed.

New in 1.01:

  1. Problems with downsampled rendering of warp effects are fixed.
  2. In Lensflare, a problem with the lens position shifting when downsampled is fixed.
  3. A problem with Z effects on Nuke is fixed.
  4. A problem with the Help Dialog hanging on Mac is fixed.
  5. Node-locked RLM licenses now work correctly.
  6. SGO Mistika (4.0 or later) is now supported.

Loading a Plug-in

When Sapphire Plug-ins have been installed and the host application has been restarted, the new plug-ins should appear in the host application's effects menus just like any other effects.

On Nuke: click on the GenArts Sapphire icon in the toolbar on the left-hand side of the screen. Select the desired Sapphire effects category, and click on an effect to add it to your project. Alternatively, you can right-click anywhere the Node Graph window and go to Sapphire -> Sapphire Category Name -> Effect Name in the context menu.

On Toxik: press the ~ key to open the Gate, and swipe right to Tools & Views. All the Sapphire effect categories such as "OFX S.Adjust", "OFX S.Blur+Sharpen", etc. should appear in the menu. Select the desired category and then drag an effect into your Composition window to add it.

On Fusion: in the Tools menu, select Sapphire and the desired Sapphire effects category, then click on an effect to add it to your Composition. Alternatively, you can right-click directly in the Comp Window and select Add Tool -> Sapphire -> Sapphire Category Name -> Effect Name.

On Baselight: using the Insert Menu, select the OFX Filter menu and select the desired Sapphire effects category. Then click on an effect to apply it to the currently selected clip. Instead of using the OFX Filter menu, you can alternatively use the OFX Transition menu to select amongst only transitions, or the OFX Source menu to select just generators.

On Film Master: select a clip in the timeline, and using the Effect menu on the right side of the timeline window, select the desired Sapphire effects category and effect plug-in. Then press the "Create new user effect" button (which looks like a square with a small 9-square grid overlaid) to apply the effect to the clip. The effects in the Sapphire Transition category can also be applied specially as usual transition effects in Film Master.

On Scratch: click on the "New.." button on the bottom left of the process screen, select the desired plug-in from the list, and then click on "Insert".


Resetting Parameters to Defaults

Host products should provide a way to reset all of a plug-in's parameters to their default values by clicking on a Reset button or selecting Reset from a context menu.

On Nuke: right-click on the properties panel and in the Context menu select Reset Knobs to Default. You can also choose Revert Knobs, which will undo all changes since you opened the properties panel.

On Toxik: press the Reset button on the right side of the parameters window.

On Fusion: right-click on the effect icon in the Comp, and choose Settings -> Load Default.

On Baselight: in the Edit menu, click on Reset Parameters.

On Film Master: press the Reset Effect button (which looks like a circle with a red dot in the center and a small white left-pointing triangle on the right).

On Scratch: press the Reset button located on the right side of the screen under the bin. To reset an individual parameter, click on that parameter's value/slider and in the resulting dialog, click on the "R" button.


Online Documentation

In OFX, all Sapphire Plug-ins include an Help button at the bottom of the plug-in parameters. Push this button to bring up a window showing the current version of Sapphire Plug-ins, your license status, some documentation about the current plug-in, and links to more detailed HTML documentation.

Online documentation is normally installed along with your software and can also be accessed directly.
On Windows: go to Start -> All Programs -> GenArts Sapphire OFX -> Online Help (HTML) or (PDF).
On Mac: go to the Applications/GenArtsSapphireOFX folder and double click on Online Help.html or .pdf.
On Linux: go to the RedHat Applications menu and select GenArts Sapphire OFX -> Sapphire Online Help (HTML) or (PDF).


About Mask Inputs

Many Sapphire Plug-ins accept an optional Mask input clip. Typically, this input can be used to provide more detailed control for where the effect should be applied and where it should not be applied.

Glint, Glow, Glare, and Rays, for example, take the main Source input and also an optional Mask input. For these, the source input is multiplied by the mask before generating the glints (or glows, glares), so where the mask is black no glints are generated, and where it is white they are generated as usual. This method prevents the glints or glows themselves from being partially cropped by the mask. In addition these effects use the RGB colors of the Mask input to selectively colorize the resulting glows, glints, or glares. The red areas of the mask will produce red glows, glints, or glares, and so on.

In Blur effects, the areas which are masked out are never blurred, so they do not blur into the masked-in regions. If a mask were instead applied afterward, the pixels behind the mask would be blurred over the edge of the mask and into the final image. As an example, say you have a clip with white text over a black background. If you put that clip into both the Source and Mask inputs of Blur, the black background will not be blurred into the text, since the black pixels are all masked out.

Some OFX host products, such as Toxik and Fusion, have their own native masking inputs on every effect. These inputs simply composite the original source over the normal result where the mask is black. The plug-in doesn't use that input in its processing.

In Fusion, the native masking input is called Effect Mask and it's blue to distinguish it from the Sapphire Mask input, which is white. In Toxik, the native Masking input is always last and is colored black, whereas the Sapphire Mask input is gray like other inputs.


About Alpha Channel Processing

All Sapphire Plug-ins can handle RGBA inputs, and the Alpha of RGBA inputs is handled in one of three ways, depending on the effect:

  1. Alpha is processed as just another input channel like R, G, and B. Effects in this category include: AutoPaint, Mosaic, Blur, BlurMotion, RackDefocus, all Wipes, all Dissolves, Distort, DistortBlur, DistortChroma, all Kaleidoscopes, all Warps, Shake, and MathOps.

  2. Alpha is copied from the first input to the output. In this case the effect doesn't use the Alpha channel, but it is passed through unchanged from the first input to the output. Effects in this category include: BandPass, BlurChroma, ClampChroma, DuoTone, EdgeDetect, Embosses, Etching, HalfTones, Hotspots, DistortRGB, Monochrome, Pseudo_Color, Psykos, Sharpen, Sketch, Sparkles, Streaks, Threshold, and Zebrafy.

  3. Some other effects pass the input Alpha channel through, and also add some opacity where the effects are applied. An Affect Alpha parameter is included in these effects which allows adjusting the amount that the alpha channel is affected. The effects in this category are: LensFlare, all Glows, all Glints, Glare, EdgeRays, Rays, and all Zaps.

Some OFX host products, such as Nuke and Fusion, represent RGBA images in pre-multiplied format, where the RGB are assumed to be scaled by the opacity. Other hosts such as Toxik, Baselight, and Film Master represent RGBA in non-premultiplied or straight format. Sapphire effects use pre-multiplied format internally, and will automatically convert as needed depending on the host product's format. The Affect Alpha parameter which is available in most lighting effects tends to be less necessary in hosts that use pre-multiplied RGBA format, and it defaults to 0.0 for these hosts, but defaults to 1.0 for hosts that use straight RGBA format.


About Pixel Aspect Ratios

For some image formats, the digital form of the image is scaled non-uniformly to produce the final viewed picture. For example NTSC resolution is normally 720x486 with an aspect ratio of 1.481. However, the final NTSC picture has an aspect ratio of 4/3 or 1.333. Thus the original digital image is scaled in the horizontal direction by a factor of 0.9 and shapes rendered as circles can end up squashed slightly into ovals. The original pixels are effectively rectangular shaped instead of squares, and have an aspect ratio of 1.481/1.333 = 1.111. (Or 1.333/1.481 = 0.9 if the inverse ratio is used.)

OFX allows you to adjust the pixel aspect ratio in the Composition Settings menu, and Sapphire Plug-ins read this value to give the appropriately scaled results.

If necessary, you can override the pixel aspect ratio for all Sapphire Plug-ins by changing the value of force_pixel_aspect_ratio in the s_config.text file.

The pixel aspect ratio makes no difference for basic pixel processing effects such as color processing or compositing.


Customizing Plug-ins

A number of parameters are available that can be adjusted to customize the behavior of all Sapphire plug-ins. You can disable multi-processing, force the pixel aspect ratio, or specify lookup tables for more accurate processing of log format images. A facility is also included with Sapphire Plug-ins that allows users with some programming experience to define and customize new plug-ins. For additional information on these, or to modify a parameter, see the s_config.text file.

On Mac the config file is: /Applications/GenArtsSapphireOFX/config/s_config.text
On Windows the config file is: C:\Program Files\GenArts\SapphireOFX\s_config.text.
On Linux the config file is: /usr/genarts/SapphireOFX/s_config.text.

Custom Lens Flare types can also be made by editing the s_lensflares.text file, in the same directory as the config file above. New flare types will automatically appear in the menu of the S_LensFlare plug-in.


To Sapphire Plug-ins Introduction


© 2009, GenArts, Inc. All rights reserved.