April 17th, 2004

Shake 3.50 Documentation

In addition to the printed Shake 3 Reference Guide and Shake 3 Tutorials books, there are also updated onscreen PDF versions of the documentation for Shake 3.50. The Shake 3.50 onscreen documentation is in Adobe® Portable Document Format. To use the available interactive links and cross-references in the PDF documentation, it is recommended to use Adobe® Acrobat® Reader®. For more information about new features in Shake 3, see chapter one in the Shake 3 Reference Guide.

For more information about changes and enhancements in Shake 3.50, see What's New in Shake 3.50 in the Shake 3.50 help menu.


Topics in this Document

Click a link to jump to the corresponding topic:

Input Device Controls on Different Platforms
Shake 3.50 Project Compatibility with Older Versions
Maximizing Performance on Macintosh G5 Computers
Known Issues Using Shake 3.50 with Mac OS X 10.3 (Panther)
Known Issues Using Shake 3.50 with Mac OS X
What's Fixed in Shake 3.50
Known Issues in Shake 3.50
Differences in Gamma Handling Between Shake and Final Cut Pro

Input Device Controls on Different Platforms

Depending on platform, panning, zooming, and contextual menu access vary in the Shake 3.50 interface when using a Wacom tablet and stylus, or a mouse. Use the following table as a guideline.

Mac OS X

Function Stylus and Tablet Mouse
Pan Opt-move pen Middle-mouse button, or Opt-left mouse button
Zoom Command+Opt-move pen Ctrl-middle-mouse button, or Ctrl+Opt-left mouse button
Contextual Menu Upper pen button Right-mouse button

Linux

Function Stylus and Tablet Mouse
Pan Lower pen button Middle-mouse button
Zoom Ctrl-lower pen button Ctrl-middle mouse button
Contextual Menu Upper pen button Right-mouse button

IRIX

Function Stylus and Tablet Mouse
Pan Upper pen button, or Alt-move pen Middle-mouse button
Zoom Ctrl-upper pen button, or Ctrl+Alt-move pen Ctrl-middle mouse button
Contextual Menu Lower pen button Right-mouse button

Note: Some 3-button mouse drivers may conflict with the middle mouse button functionality in Shake. To correct this, you can disable the 3-button mouse drivers in your System Preferences for use with Shake, or uninstall the mouse drivers.

Shake 3.50 Minimum system requirements

The minimum system requirements have changed:
• Mac OS X: Panther 10.3.2 and QuickTime 6.5
• Linux: RedHat 9
• Irix: Irix 6x

Shake 3.50 Compatibility with Older Project Files

Scripts created in Shake 3.0 should be compatible with Shake 3.50. However, forward compatibility is not guaranteed. For more information on new features in Shake 3.50, see “What's New...” in the Shake Help menu.

Maximizing Processor Performance on Macintosh G5 Computers

To obtain the highest performance when running Shake 3.50 on a Macintosh G5 computer, make sure that the Energy Saver setting in the System Preferences is set to “Highest Performance.” To change this setting, do the following:

  1. Open the System Preferences window.
  2. Click the Energy Saver icon.
  3. Click Options.
  4. Choose “Highest” from the Processor Performance pop-up menu.

Note: The Processor Performance option only appears on Macintosh G5 desktop computers using Mac OS X and on Macintosh PowerBook computers .

Known Issues Using Shake 3.50 with Mac OS X 10.3 (Panther)

Fast User Switching Cannot be Used with Shake 3.50

Running multiple instances of Shake simultaneously can result in corruption of the Shake disk cache as each separate instance of Shake attempts to write conflicting data to the same cache file. To prevent this from happening when multiple users on the same machine attempt to use Shake, the Enable Fast Switching option in the Accounts pane of the System Preferences is disabled whenever Shake is launched from the Finder.

Important — While you can still launch multiple instances of Shake from the command line, this should be avoided unless you specify separate disk cache files for each instance of Shake. For more information about customizing the Shake disk cache, see chapter 17 of the Shake User Manual, Customizing Shake, or choose Customizing Shake from Shake's Help menu.

Reading Files into a Script From /Network/Local Using the SFileIn Node

This is not supported in Shake 3.50.

Workaround — The preferred way to read files into a Shake script from a server on your network is to mount all server volumes with media you want to use by choosing Go > Connect to Server from the Finder (Command+K). Files that are read into Shake in this way will generate missing file errors during command-line renders if they become unavailable due to the server being disconnected.

Important — It's always a good idea to mount all server volumes with media you may need to use prior to rendering your project, in order to avoid unsuccessful renders due to unavailable media.

Known Issues Using Shake 3.50 with Mac OS X

The following issues apply to Shake 3.50 running Mac OS X 10.3.

Files in the /include/startup Directory

Shake reads any files located in the /include/startup directory. In Mac OS X, the file extensions must be modified in Terminal or else the old file extension is still appended. For example, if you modify mysetting.h to mysettings.old using the Finder, the system still reads mysettings.old.h.

Workaround 1 — In the Finder, choose Finder > Preferences, click Advanced, and turn on Show all file extensions. You can then modify the entire file name as needed.

Workaround 2 — Rename the file via Terminal using the “move” command, for example:

     mv mysettings.h mysettings.old

Using Shake with Two Monitors

Using Shake with a dual-monitor setup may be problematic. The current UI design for Shake does not support changes in the monitor resolution and/or the stretching of the applications between two monitors. Consequently, if the Flipbook is stretched between two monitors, drawing corruption may occur.

Visible Cursor While Drawing Strokes

While drawing strokes, the cursor remains visible in the Viewer.

Rendering

You cannot render to the root directory.

Incorrect Display of the Landcscape Interface

Depending on the graphic settings, the landscape interface may not be correctly displayed on the Mac. The landscape interface is not officially supported by Shake. Currently, there is no workaround.

Using the Delete Key

On the Macintosh keyboard, the delete key (next to the + and keys) does not delete in Shake. For example, selecting a node in the Node View and pressing delete has no result. In Shake, the delete key is mapped to the “tab” behavior used on other keyboards and cannot be modified without affecting several behaviors (for example, “tab” in tracking removes a track point and goes back one frame in time).

Workaround — Use the del key on the numeric keypad (also known as the Forward Delete Key), or press Opt+delete (next to the + and keys) to delete.

Using Shake with the Dock

There may be a performance drop if the OS X Dock is over the Shake interface, especially during playback. To ensure that Shake is not above or below the Dock, set the System Preferences to automatically hide and show the Dock:

  • Go to System Preferences > Personal.

  • Enable Automatically hide and show the Dock.
  • Close (Command+W) or quit (Command+Q) the System Preferences.

What's Been Fixed in Shake 3.50

Disk-Based Flipbook

General

IRIX/Linux

Note: It was brought to our attention that Shake may crash when opening scripts on Linux systems running ATI cards. Upgrading the ATI drivers to the newest version may resolve this problem.

Mac OS X

Rotoshape

QuickTime

Note: The Apple Uncompressed 10-bit 4:2:2 codec is highly recommended when rendering greater than 8-bit Quicktime files.

DPX

SDK

Known Issues in Shake 3.50

Broadcast Monitor

Crashing Issues

Curve Editor

Disk-Based Flipbook

General

IMPORTANT  We have received different reports of problems related to cache size that is bigger than cache settings. We have identified that the source of this problem is different versions of Shake running on the same system. We are looking into improving cache management, but please be aware that this situation may occur if you use different versions of Shake on the same system. For more information, see the Caching chapter of the “New Features Guide” in the on-screen help menu.
Node View/Node View Groups

MultiLayer and Photoshop File Support

IMPORTANT  Photoshop compositing modes must be used on files containing an alpha channel. If these modes are not used, erratic results may occur in the composite. For example, if the background plate does not contain an alpha, the layer may disappear after selecting the Photoshop mode.

Workaround — If your image does not contain an alpha, enable “Auto Alpha” in your SFileIn parameter.

QuickPaint Node

Note: We have received some reports from customers complaining about the rendering time of Shake scripts when QuickPaint nodes are used. This may be related to the numbers of QuickPaint nodes contained in a script. With each added paint node, Shake creates at least one full size image buffer equal to the resolution of your image; two are created if reveal is used. This memory comes from the processing cache. When shake hits the upper limit of the processing cache, it begins to swap used memory blocks to disk, starting with the oldest ones. If the shake processing cache parameter is too low for a particular computer's RAM configuration, and the script requires a lot of processing cache, shake may start swapping memory. On the other hand, if shake's processing cache is too high, you may also encounter memory swapping. For these reasons, it is highly recommended to tweak the cache parameters to have more processing cache. For more information, see the Caching chapter of the “New Features Guide” in the on-screen help menu.

A rough estimation of the processing cache that a paint node uses can be calculated with the following formula:

${width} * ${height} * 4 channels/pixel * ${byte_depth} * 2 (if reveal is used).

For a 2k 10-bit image using reveal, a paint node will require the following ram:

2048 * 2048 * 4 channels/pixel * 2 bytes/channel * 2= 64 MB

The above is only for one QuickPaint node. Warping nodes also use more memory for the processing cache. Additional RAM is necessary for the image cache.

If you find one script takes too much RAM, the workaround if to break it down into smaller scripts with smaller memory requirements.

QuickTime Codec

RotoShape Node

SFileIn/SfileOut/Proxy/Thumbnails

Tracker/Stabilize/Matchmove

Viewer

Differences in Gamma Handling Between Shake and Final Cut Pro

Shake and Final Cut Pro display and process the gamma of QuickTime movies and RGB image files differently.

Shake makes no automatic changes to the gamma of QuickTime or RGB Image files and sequences. It is up to users to make sure that their monitor is properly calibrated for their production environment, and that the ViewerLookup parameters are set to the values required for images to display properly in the Shake Viewer. In particular, the default viewerGamma value is 1, which leaves the gamma of images displayed in the Viewer unchanged.

Final Cut Pro, on the other hand, makes some assumptions about the gamma of QuickTime and RGB image files that are imported into a project. The gamma of imported QuickTime and RGB image files is treated differently in sequences set to render in 8- or 10-bit YUV.

Note: While it is possible to recalibrate Apple displays via the Display Calibrator Assistant in the Displays control panel of the System Preferences, users are recommended to leave the gamma of their monitors to the 1.8 Standard Gamma setting when working in Final Cut Pro. ColorSync settings are not used by either Shake or Final Cut Pro for automatic color calibration or compensation of any kind.

QuickTime Movies

Issue: When importing a QuickTime movie created with Shake into Final Cut Pro, users may notice a difference in the displayed gamma of the image. This is because Final Cut Pro automatically lowers the gamma of sequences playing in the Canvas on your computer's display. The gamma of QuickTime images remain untouched when the sequence is output to video or rendered as a QuickTime movie.

Solution: You can load Shake's Viewer Lookup controls into the Parameter tab, and change the viewerGamma parameter to .818 to preview how your composition will look in Final Cut Pro's Canvas window. This only changes how your image is displayed in the Shake Viewer, and does nothing to change the Gamma of the script's final rendered image.

Reason: Final Cut Pro assumes that QuickTime movies for codecs that support the YUV color space (including DV, DVCPRO 50, and the 8- and 10-bit Uncompressed 4:2:2 codecs) are created with a gamma of 2.2. This is generally true of movies captured from both NTSC and PAL sources. When you eventually output the sequence to video, or render it as a QuickTime movie, the gamma of the output is identical to that of the original, unless you've added color correction filters of your own.

However, during playback on your computer's monitor, Final Cut Pro automatically lowers the gamma of a sequence playing in the Canvas to 1.8 for display purposes. This is to approximate the way it will look when displayed on a broadcast monitor. This on-screen compensation does not change the actual gamma of the clips in your sequence.

RGB Image Files and Sequences

Issue: When importing a still image file or sequence from Shake into Final Cut Pro, the gamma may be incorrectly boosted when the sequence is output to video or rendered as a QuickTime movie.

Solution: You should convert image sequences to QuickTime movies using a FileOut node in Shake for Mac OS X, prior to importing them into Final Cut Pro. This makes them easier to import, and also ensures that their gamma won't be changed. For the highest quality, use either the Uncompressed 8- or 10-bit 4:2:2 codec when performing this conversion, depending on the bit depth of the source image files. The QuickTime player is not recommended for this operation, as it may perform an unwanted bit-depth conversion with greater than 8-bit images.

Reason: Final Cut Pro assumes that all RGB image files are created with a gamma of 1.8. When RGB image files are imported into Final Cut Pro and edited into a sequence set to 8- or 10-bit YUV rendering, the gamma is automatically boosted to 2.2 in an attempt to match the other video files in your project. This boosted gamma is then used when the sequence is output to video or rendered as a QuickTime movie.

During playback on your computer's monitor, Final Cut Pro lowers the gamma of the sequence playing in the Canvas to 1.8 for display purposes. This is to approximate the way it will look when displayed on a broadcast monitor. The still image clips in your sequence are still boosted when the sequence is output to video or rendered as a QuickTime movie.

Important: QuickTime movies compressed using the Animation codec (which only supports the RGB color space) are also assumed to have been created with a gamma of 1.8. As a result, these clips are also boosted to 2.2 when edited into a sequence set to 8- or 10-bit YUV rendering.

Note: For more information on setting the rendering options of a sequence in the Video Processing tab of the Sequence Settings, see the Final Cut Pro User's Manual.