Oink
Concepts

Review and editorial

Oink Review: playback, review notes, the editorial timeline, conform and comp round trips.

raw .md

Oink Review is the companion app for the Hiero / Nuke Studio side of the work: playing and reviewing shots, and cutting, conforming and turning over an edit. It does not need Blender.

Starting it

  • ./launch_review.sh [image sequences or folders …] from the repository folder, or
  • Workspace › Timeline, Conforming or Reviewing in Oink's menu bar (Nuke Studio's workspaces) open it.

Review

  • Frame-accurate playback of image sequences: it slows down rather than dropping frames. Space, J / K / L, I / O as usual.
  • Versions of a shot side by side: compare, wipe, A / B.
  • Notes and annotations on frames, kept in files next to the media.

Editorial timeline

The timeline follows Hiero / Nuke Studio's, item by item: 115 behaviours from the Nuke 17.1 timeline help and hotkeys are on a checklist, and tests that use the real mouse and keys check them. Review has no Curve Editor, so non-linear transitions are a set of shapes instead (see Transitions).

  • Import an edit: EDL, OTIO, and AAF / XML (through OpenTimelineIO) with File › Import EDL/XML/AAF…, or drop the file on the viewer.
  • Tools (Q / W / E / T; press twice quickly to step through a group): Multi Tool (move, trim, roll, slide and slip depending on where you grab the shot), Select, Roll, Ripple, Slip, Slide, Retime, Razor, Join, Effects Selector. Nudge with , and . (Shift: 10 frames), Up / Down or PgUp / PgDn jump between edits, D enables or disables a shot.
  • Editing as in Nuke Studio: dragging overwrites; Alt at the drop ripples, Alt at the start duplicates; Shift+drag above the top track makes a new track. Trims stop at the end of the media unless you hold Ctrl. Lift, Extract, Ripple Delete, Copy Cuts, Make Freeze Frame, Link / Unlink Shots (a click selects the group), Insert (N) and Overwrite (M) from the project bins.
  • Trim previews: while you trim, roll or slip, the Viewer shows one, two or three frames (out / in, or in / current / out).
  • Transitions: fades and dissolves are drawn on the timeline, can be dragged and nudged, and play with real mixing on the GPU. Right-click a transition and pick Interpolation: Linear, Smooth, Ease In or Ease Out. The ramp is drawn on the timeline. Single curve keys cannot be dragged or added. Audio has fades, crossfades, track volume and output (stereo, left, right, mono).
  • Tracks: lock, hide, mute, solo, height, collapse; blend tracks (over, multiply, screen, plus, minus, difference, max, min) and alpha masks; waveforms (full or half) and a timecode / frames display; ten playheads with their own In / Out; Tags panel and project bins.
  • Versions: Alt+Up / Alt+Down steps a clip's version, V lists them, Project › Version Up All to Latest.
  • Soft effects: CDL values from the EDL, per-clip ColorCorrect (Alt+C), Saturation, Grade (Alt+G), Transform (Alt+T), Mirror, Crop, Premult / Unpremult, and LUT (OCIOFileTransform), Blur and Text (from the Clip › Effects menu and the clip properties). They show live, are never baked in, and are written into the per-shot comps on export. The pixels match Oink's own render of the exported comp to within the half-float write (about 0.05 %).
  • Compare: the Viewer's A and B buffers can take any track or the versions of the shot (Hiero's A / B track buttons; select a shot and press A or B). Modes: wipe, stack, horizontal, vertical, onion skin and difference.
  • Cut compare: a new cut against the current one, listing new, omitted, changed and reinstated shots, with a CSV report.
  • Projects save automatically, with an .otio copy of the timeline next to the project file.

One app with the compositor

Create Comp and Open Comp in Oink Review send the file to the Oink that is already running (it asks first if the open comp has unsaved changes, jumps to the playhead's frame and comes to the front). If none is running, it is started. Double-clicking a comp file in your file manager is different: it opens a new copy of Oink each time. Review session files have their own icon and open in Oink Review. In the other direction, Send to Review / flipbook in Oink goes to the running Oink Review first.

Conform

Conform finds the media for each shot of the edit by reel name, then clip name, then timecode (drop-frame aware), and shows each clip as matched, unmatched or ambiguous, with the reason. You can relink any clip by hand.

Export writes one folder per shot from name tokens ({sequence} {shot} {version} …), copies or links the plates with handles (renumbered to start at 1001), and writes a per-shot Nuke script and Oink .oink: Read → CDL → Retime → Grade → Transform → Write. The per-shot scripts also carry the LUT, Blur and Text soft effects (as OCIOFileTransform, Blur and Text2 in the .nk). A turnover package adds a reference movie, .cc CDL files, a shot list CSV and checksums.

Comp round trip

Right-click a shot and choose Create Comp: the shot's comp script is written, a comp placeholder appears on the track above, and Oink opens the comp. When renders appear in the comp's render folder they show up on the timeline as new versions of that shot.

The production tracker links the comp to its task. Oink itself also has a Conform panel (a tab beside Properties) that reads an EDL or OTIO, finds the media and exports shot folders and comps.

Not built yet

Burn-In, individual curve keys on transitions, blend tracks and audio fades in the exported comps, and exporting a Nuke Studio project.

On this page