feat(pipeline): automate picture-lock trimming in the preview build
Deploy / deploy (push) Successful in 10m37s
Deploy / deploy (push) Successful in 10m37s
Previews used to ship the full padded (handle-included) render to clients, with an artist manually pulling picture lock and hand-trimming the comp to match. The automated preview stage now trims the client comp to the picture-lock edit itself (a fixed handle count off each end, per the studio's existing convention) and separately builds an ungraded, full-duration picture-lock reference MP4 as a diagnostic sidecar to check back against. A new "No Picture Lock" panel checkbox is the single override for shots where picture lock is missing or wrong, falling back to today's untrimmed behavior. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
@@ -157,6 +157,19 @@ public sealed class PreviewManifest
|
||||
public string? SlateSubmissionProp { get; set; }
|
||||
public SlateInfo Slate { get; set; } = new();
|
||||
|
||||
/// <summary>Skip picture-lock trimming and the reference render entirely.</summary>
|
||||
public bool NoPictureLock { get; set; }
|
||||
/// <summary>"{footageRoot}/{showId}/_PICLOCKS" — empty when not configured.</summary>
|
||||
public string? PiclockDir { get; set; }
|
||||
/// <summary>e.g. "UNG_106" — the picture-lock file glob prefix.</summary>
|
||||
public string? PiclockGlobPrefix { get; set; }
|
||||
public string? SeqTimecodeStart { get; set; }
|
||||
public string? SeqTimecodeEnd { get; set; }
|
||||
/// <summary>Studio-standard head/tail handle count, applied symmetrically.</summary>
|
||||
public int HandleFrames { get; set; }
|
||||
/// <summary>Full-duration (handles included), ungraded picture-lock reference render.</summary>
|
||||
public string? PiclockRefOutput { get; set; }
|
||||
|
||||
public int TotalFrames => FrameEnd - FrameStart + 1;
|
||||
}
|
||||
|
||||
@@ -186,6 +199,10 @@ public sealed class PreviewBuildResult
|
||||
public int? FrameCount { get; set; }
|
||||
public int? Width { get; set; }
|
||||
public int? Height { get; set; }
|
||||
/// <summary>Whether the picture-lock reference comp was found, positioned and queued.</summary>
|
||||
public bool PiclockRefBuilt { get; set; }
|
||||
/// <summary>Why the picture-lock reference/trim was skipped, when it was (non-fatal).</summary>
|
||||
public string? PiclockSkippedReason { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>The Render Manifest (§6.2) — the fields the render and validation stages need; the rest is preserved raw.</summary>
|
||||
|
||||
@@ -438,6 +438,19 @@ public sealed class JobExecutor
|
||||
job.Id, machineId, "thumbnail", result.ThumbnailPath, "image/jpeg", shutdown);
|
||||
}
|
||||
|
||||
// Diagnostic sidecar, not a deliverable — an upload failure here must
|
||||
// never hold back the mov/mp4/thumbnail that already succeeded.
|
||||
string? piclockRefKey = null;
|
||||
if (result.PiclockRefPath is not null)
|
||||
{
|
||||
piclockRefKey = await _api.UploadArtifactAsync(
|
||||
job.Id, machineId, "piclockRef", result.PiclockRefPath, "video/mp4", shutdown);
|
||||
if (piclockRefKey is null)
|
||||
{
|
||||
_log.LogWarning("Picture-lock reference upload failed for job {JobId} (non-fatal)", job.Id);
|
||||
}
|
||||
}
|
||||
|
||||
_spooler.Enqueue("finalize", job.Id, new Dictionary<string, object?>
|
||||
{
|
||||
["machineId"] = machineId,
|
||||
@@ -446,6 +459,7 @@ public sealed class JobExecutor
|
||||
["deliveryMovPath"] = manifest.MovOutput,
|
||||
["previewMovKey"] = previewKey,
|
||||
["thumbnailKey"] = thumbKey,
|
||||
["piclockRefKey"] = piclockRefKey,
|
||||
},
|
||||
["renderStats"] = new Dictionary<string, object?>
|
||||
{
|
||||
|
||||
@@ -14,7 +14,8 @@ public sealed record PreviewStageResult(
|
||||
string? ThumbnailPath,
|
||||
string? TempAep,
|
||||
PreviewBuildResult? Build,
|
||||
double Seconds);
|
||||
double Seconds,
|
||||
string? PiclockRefPath = null);
|
||||
|
||||
/// <summary>
|
||||
/// Stage 3 — preview generation (RenderPipeline2 §9), the second half of a
|
||||
@@ -59,6 +60,8 @@ public sealed class PreviewStage
|
||||
|
||||
var movLocal = mapper.Map(manifest.MovOutput);
|
||||
var mp4Local = mapper.Map(manifest.Mp4Output);
|
||||
var piclockDirLocal = string.IsNullOrWhiteSpace(manifest.PiclockDir) ? null : mapper.Map(manifest.PiclockDir);
|
||||
var piclockRefLocal = string.IsNullOrWhiteSpace(manifest.PiclockRefOutput) ? null : mapper.Map(manifest.PiclockRefOutput);
|
||||
|
||||
// Everything the script needs, in machine-local paths.
|
||||
var context = new
|
||||
@@ -83,6 +86,13 @@ public sealed class PreviewStage
|
||||
slateScopeProp = manifest.SlateScopeProp,
|
||||
slateSubmissionProp = manifest.SlateSubmissionProp,
|
||||
slate = manifest.Slate,
|
||||
noPictureLock = manifest.NoPictureLock,
|
||||
piclockDir = piclockDirLocal,
|
||||
piclockGlobPrefix = manifest.PiclockGlobPrefix,
|
||||
seqTimecodeStart = manifest.SeqTimecodeStart,
|
||||
seqTimecodeEnd = manifest.SeqTimecodeEnd,
|
||||
handleFrames = manifest.HandleFrames,
|
||||
piclockRefOutput = piclockRefLocal,
|
||||
};
|
||||
|
||||
await File.WriteAllTextAsync(contextPath, JsonSerializer.Serialize(context, WorkerOptions.JsonOpts), shutdown);
|
||||
@@ -181,12 +191,29 @@ public sealed class PreviewStage
|
||||
|
||||
var thumbnail = await TryMakeThumbnailAsync(job.Id, mp4Local, shutdown);
|
||||
|
||||
// Non-fatal by design: the picture-lock reference is a diagnostic aid,
|
||||
// not part of the deliverable, so a missing file here must never hold
|
||||
// back the mov/mp4 that already rendered successfully.
|
||||
string? piclockRefResult = null;
|
||||
if (build.PiclockRefBuilt)
|
||||
{
|
||||
if (!string.IsNullOrWhiteSpace(piclockRefLocal) && File.Exists(piclockRefLocal))
|
||||
{
|
||||
piclockRefResult = piclockRefLocal;
|
||||
}
|
||||
else
|
||||
{
|
||||
_log.LogWarning("Picture-lock reference was queued but is missing after render: {Path}", piclockRefLocal);
|
||||
}
|
||||
}
|
||||
|
||||
sw.Stop();
|
||||
_log.LogInformation("Preview complete for job {JobId} in {Sec:F0}s (mov + mp4{Thumb})",
|
||||
job.Id, sw.Elapsed.TotalSeconds, thumbnail is null ? "" : " + thumbnail");
|
||||
_log.LogInformation("Preview complete for job {JobId} in {Sec:F0}s (mov + mp4{Thumb}{Piclock})",
|
||||
job.Id, sw.Elapsed.TotalSeconds, thumbnail is null ? "" : " + thumbnail",
|
||||
piclockRefResult is null ? "" : " + piclock ref");
|
||||
|
||||
return new PreviewStageResult(true, true, null, movLocal, mp4Local, thumbnail,
|
||||
build.TempAep, build, sw.Elapsed.TotalSeconds);
|
||||
build.TempAep, build, sw.Elapsed.TotalSeconds, piclockRefResult);
|
||||
}
|
||||
|
||||
private async Task<int> RunAfterFxAsync(
|
||||
|
||||
@@ -30,7 +30,9 @@
|
||||
queued: [],
|
||||
frameCount: null,
|
||||
width: null,
|
||||
height: null
|
||||
height: null,
|
||||
piclockRefBuilt: false,
|
||||
piclockSkippedReason: null
|
||||
};
|
||||
var resultPath = null;
|
||||
|
||||
@@ -156,6 +158,67 @@
|
||||
return null;
|
||||
}
|
||||
|
||||
// Mirrors the panel's parseTimecodeToSeconds exactly.
|
||||
function parseTimecodeToSeconds(tc, fps) {
|
||||
var parts = String(tc).split(/[:;]/);
|
||||
if (parts.length < 4) {
|
||||
return 0;
|
||||
}
|
||||
return parseInt(parts[0], 10) * 3600 + parseInt(parts[1], 10) * 60 +
|
||||
parseInt(parts[2], 10) + parseInt(parts[3], 10) / (fps || 24);
|
||||
}
|
||||
|
||||
// Locates the picture-lock reference footage the same way the panel's
|
||||
// pullPictureLock does: the _PICLOCKS project folder first, then a disk
|
||||
// glob under ctx.piclockDir. Returns the FootageItem, or null (with a
|
||||
// warn()) if it cannot be found — never fatal to the preview build.
|
||||
function findPiclockFootage(ctx) {
|
||||
var piclocksProjectFolder = findFolder("_PICLOCKS");
|
||||
var i;
|
||||
var item;
|
||||
var piclocksDir;
|
||||
var files;
|
||||
var importOptions;
|
||||
|
||||
if (piclocksProjectFolder) {
|
||||
for (i = 1; i <= app.project.numItems; i += 1) {
|
||||
item = app.project.item(i);
|
||||
if (item instanceof FootageItem &&
|
||||
item.parentFolder === piclocksProjectFolder &&
|
||||
item.name.indexOf(ctx.piclockGlobPrefix + "_") === 0) {
|
||||
return item;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!ctx.piclockDir) {
|
||||
warn("Picture lock: no footage root configured for this project — skipping reference render");
|
||||
return null;
|
||||
}
|
||||
piclocksDir = new Folder(ctx.piclockDir);
|
||||
if (!piclocksDir.exists) {
|
||||
warn("Picture lock: folder not found: " + piclocksDir.fsName);
|
||||
return null;
|
||||
}
|
||||
files = piclocksDir.getFiles(ctx.piclockGlobPrefix + "_*");
|
||||
if (!files || files.length < 1) {
|
||||
warn("Picture lock: no file matching " + ctx.piclockGlobPrefix + "_* found in " + piclocksDir.fsName);
|
||||
return null;
|
||||
}
|
||||
for (i = 0; i < files.length; i += 1) {
|
||||
if (files[i] instanceof File) {
|
||||
try {
|
||||
importOptions = new ImportOptions(files[i]);
|
||||
return app.project.importFile(importOptions);
|
||||
} catch (importError) {
|
||||
warn("Picture lock: import failed: " + importError.message);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
// Mirrors the panel's addOCIOToLayer: effect added but disabled, so the
|
||||
// artist/farm chain matches exactly.
|
||||
function addOCIOToLayer(layer) {
|
||||
@@ -510,8 +573,31 @@
|
||||
warn("NETFLIX_SLATE layer not found in template — slate fields not filled");
|
||||
}
|
||||
|
||||
// Trim the client-facing comp back to the picture-lock edit (§9,
|
||||
// picture lock): the render's frame range is editorial ± a fixed
|
||||
// symmetric handle count by studio convention (the same constant
|
||||
// pullPictureLock hardcodes), so no picture-lock file is needed for
|
||||
// this — only ctx.handleFrames. Both movOutput and mp4Output queue
|
||||
// against this same previewComp, so trimming it once fixes both.
|
||||
var shotLayer = previewComp.layer("SHOT");
|
||||
var targetOutPoint = shotLayer.inPoint + shotComp.duration;
|
||||
var handleSeconds = (ctx.handleFrames || 0) / fps;
|
||||
var visibleDuration = shotComp.duration;
|
||||
var trimmedToPictureLock = false;
|
||||
if (ctx.noPictureLock) {
|
||||
result.piclockSkippedReason = "No Picture Lock was set for this export";
|
||||
} else if (handleSeconds <= 0) {
|
||||
result.piclockSkippedReason = "No handle frame count configured";
|
||||
} else if (2 * handleSeconds >= shotComp.duration) {
|
||||
warn("Picture lock: handle count (" + ctx.handleFrames + "fr) covers the whole render (" +
|
||||
result.frameCount + "fr) — trim skipped");
|
||||
result.piclockSkippedReason = "handle count exceeds the render duration";
|
||||
} else {
|
||||
shotLayer.startTime -= handleSeconds;
|
||||
visibleDuration = shotComp.duration - (2 * handleSeconds);
|
||||
trimmedToPictureLock = true;
|
||||
}
|
||||
|
||||
var targetOutPoint = shotLayer.inPoint + visibleDuration;
|
||||
if (targetOutPoint > previewComp.duration) {
|
||||
previewComp.duration = targetOutPoint;
|
||||
}
|
||||
@@ -519,13 +605,85 @@
|
||||
previewComp.duration = targetOutPoint;
|
||||
|
||||
result.previewComp = previewComp.name;
|
||||
result.trimmedToPictureLock = trimmedToPictureLock;
|
||||
|
||||
// 6. Queue both outputs against the same preview comp. aerender will
|
||||
// render the whole queue in one launch.
|
||||
app.project.renderQueue.showWindow(false);
|
||||
while (app.project.renderQueue.numItems > 0) {
|
||||
app.project.renderQueue.item(1).remove();
|
||||
}
|
||||
|
||||
// 5b. Picture-lock reference comp: the raw plate only — no OCIO, no
|
||||
// show LUT, no overlay — spanning the FULL padded duration (handles
|
||||
// included), so a supervisor can check back against it if a delivered
|
||||
// edit is ever suspected to be off. Independent of the trim above:
|
||||
// this one needs the actual picture-lock file and sequence timecodes,
|
||||
// and is skipped gracefully (never fatal) if either is missing.
|
||||
if (ctx.noPictureLock) {
|
||||
if (!result.piclockSkippedReason) {
|
||||
result.piclockSkippedReason = "No Picture Lock was set for this export";
|
||||
}
|
||||
} else if (!ctx.seqTimecodeStart || !ctx.seqTimecodeEnd) {
|
||||
warn("Picture lock: no sequence timecodes for this shot — reference render skipped");
|
||||
result.piclockSkippedReason = "no sequence timecodes for this shot";
|
||||
} else {
|
||||
// A diagnostic aid, not a deliverable: any failure building or
|
||||
// queuing it must warn and move on, never take down the mov/mp4
|
||||
// that already succeeded (queueOutput() throws on template errors).
|
||||
try {
|
||||
var piclockFootage = findPiclockFootage(ctx);
|
||||
if (piclockFootage) {
|
||||
var piclockStartTC = 0;
|
||||
try {
|
||||
if (piclockFootage.mainSource && typeof piclockFootage.mainSource.startTimecode === "number") {
|
||||
piclockStartTC = piclockFootage.mainSource.startTimecode;
|
||||
}
|
||||
} catch (tcReadError) {
|
||||
}
|
||||
|
||||
var tcIn = parseTimecodeToSeconds(ctx.seqTimecodeStart, fps);
|
||||
var tcOut = parseTimecodeToSeconds(ctx.seqTimecodeEnd, fps);
|
||||
var refIn = tcIn - piclockStartTC - handleSeconds;
|
||||
var refOut = tcOut - piclockStartTC + handleSeconds;
|
||||
if (refIn < 0) {
|
||||
refIn = 0;
|
||||
}
|
||||
if (refOut > piclockFootage.duration) {
|
||||
refOut = piclockFootage.duration;
|
||||
}
|
||||
|
||||
var piclockRefComp = app.project.items.addComp(
|
||||
ctx.shotCode + "_PICLOCK_REF", width, height, 1, refOut - refIn, fps);
|
||||
if (previewsFolder) {
|
||||
piclockRefComp.parentFolder = previewsFolder;
|
||||
}
|
||||
var piclockLayer = piclockRefComp.layers.add(piclockFootage);
|
||||
var piclockScale = Math.max(
|
||||
piclockRefComp.width / piclockFootage.width,
|
||||
piclockRefComp.height / piclockFootage.height
|
||||
) * 100;
|
||||
piclockLayer.property("Scale").setValue([piclockScale, piclockScale]);
|
||||
piclockLayer.startTime = -refIn;
|
||||
piclockLayer.inPoint = 0;
|
||||
piclockLayer.outPoint = refOut - refIn;
|
||||
|
||||
if (queueOutput(piclockRefComp, ctx.mp4Template, ctx.piclockRefOutput, "piclockRef")) {
|
||||
result.piclockRefBuilt = true;
|
||||
} else {
|
||||
result.piclockSkippedReason = "no mp4 template or output path configured";
|
||||
}
|
||||
} else if (!result.piclockSkippedReason) {
|
||||
result.piclockSkippedReason = "picture-lock file not found";
|
||||
}
|
||||
} catch (piclockError) {
|
||||
warn("Picture lock: reference render skipped — " +
|
||||
(piclockError && piclockError.toString ? piclockError.toString() : String(piclockError)));
|
||||
result.piclockSkippedReason = "error building the reference render";
|
||||
result.piclockRefBuilt = false;
|
||||
}
|
||||
}
|
||||
|
||||
// 6. Queue both outputs against the same preview comp. aerender will
|
||||
// render the whole queue in one launch.
|
||||
queueOutput(previewComp, ctx.movTemplate, ctx.movOutput, "mov");
|
||||
queueOutput(previewComp, ctx.mp4Template, ctx.mp4Output, "mp4");
|
||||
|
||||
|
||||
Reference in New Issue
Block a user