feat(connector): resolve footage per project type, anchor parsing on showId
Build Shot only ever worked on UNG. Two assumptions were baked in: that a shot's
plates sit flat in a folder named after the episode, and that a shot code is
three letters followed by three 3-digit tokens. DH2_VFX breaks both -- it groups
a shot's plates under a {shotCode}/ folder, has no episode level, and its showId
contains a digit and an underscore.
- findSequenceFolders prefers {group}/{shotCode}/ and falls back to UNG's flat
{group}/{shotCode}_* scan, so both layouts work with no migration -- moving
delivered footage would break the links in every AE project pointing at it. An
existing-but-empty shot folder returns nothing rather than falling through, so
stray plate folders sitting beside a shot cannot be read as its footage.
Underscore-prefixed folders are never shots or plates.
- getFootageGroupFolder replaces getEpisodeRootFolder: the {showId}_{episode}
folder for episodic shows, the show root otherwise. A scene filters the shot
list, it is not a directory -- which is why Build Shot on DH2 was looking in
V:/_FOOTAGE/DH2/027.
- Shot codes are now parsed by stripping the known showId prefix
({showId}_{episode}_{scene}_{shot} for episodic, {showId}_{scene}_{shot} for
standard) rather than matching /[A-Z]{3}_.../ or counting underscores.
extractShotCode keeps the old pattern as a fallback so a comp from a different
show than the selected one still reads. Same anchoring in deriveEpisodeCode
(no more hardcoded "UNG_"), deriveEpisodeAPIValue, isEpisodeCode and the
getShotExportDir episode fallback.
- Two positional cuts of the same class, found on the way: the DELIVERY path and
Pull Picture Lock's episode-prefix match both used shotCode.substring(0, 7).
Both now go through getEpisodePrefix(). Output is identical for UNG and DH2
(DH2_VFX happens to be 7 characters); the one behaviour change is that
standard shows no longer get a constant group level under DELIVERY/, and DH2
has no delivery history to move.
Verified against the live V:/_FOOTAGE tree by running the real functions under a
Folder stub: UNG_102_019_010 resolves its BG01/FG01 plates via the flat scan, and
DH2_VFX_027_010 and DH2_VFX_066_380 resolve theirs via the grouped layout. Not
yet exercised in After Effects.
Initialise Workspace is untouched and still hardcoded to UNG -- next.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
+31
-19
@@ -56,20 +56,28 @@ Source EXR plates are read from **`<Footage Root>/{SHOW_ID}/`**. Configure `foot
|
||||
|
||||
```
|
||||
<Footage Root>/
|
||||
└── {SHOW_ID}/ # e.g. UNG/
|
||||
├── {EPISODE_CODE}/ # episodic: e.g. UNG_108/
|
||||
│ └── {SHOT_CODE}_{CLIP}/ # e.g. UNG_108_001_010_A315C001/
|
||||
│ └── *.exr # EXR sequence
|
||||
│
|
||||
├── {SCENE}/ # standard: e.g. 001/
|
||||
│ └── {SHOT_CODE}_{CLIP}/
|
||||
│ └── *.exr
|
||||
└── {SHOW_ID}/ # e.g. UNG/ or DH2_VFX/
|
||||
├── {EPISODE_CODE}/ # episodic only: e.g. UNG_108/
|
||||
│ └── {SHOT_CODE}/ # standard layout: plates grouped per shot
|
||||
│ └── {SHOT_CODE}_{ELEM}_{VER}/
|
||||
│ └── *.exr
|
||||
│
|
||||
└── _PICLOCKS/
|
||||
└── {EPISODE_CODE}_*.mov # matched by episode prefix
|
||||
```
|
||||
|
||||
Sequence folders must start with the shot code followed by an underscore (`{SHOT_CODE}_*`). The connector imports all matching folders as separate footage layers.
|
||||
**Scenes are not folders.** Standard projects have no level between the show
|
||||
folder and the shot folder — the scene picker filters the shot list only.
|
||||
|
||||
**Two layouts are supported, and neither is migrated.** The connector prefers the
|
||||
grouped layout above; where a `{SHOT_CODE}/` folder does not exist it falls back
|
||||
to scanning the parent for folders named `{SHOT_CODE}_*` (the original UNG
|
||||
layout, where plates sit directly in the episode folder). All matching folders
|
||||
are imported as separate footage layers. If a `{SHOT_CODE}/` folder exists but
|
||||
holds no plate subfolders, that is reported as no footage — the fallback scan is
|
||||
not attempted, so stray plate folders sitting beside the shot cannot be picked up
|
||||
as its footage. Underscore-prefixed folders (`_ARCHIVE`, `_GFX`, `_PULLS`, …) are
|
||||
never treated as shots or plates.
|
||||
|
||||
---
|
||||
|
||||
@@ -95,7 +103,7 @@ Same applies to `footageRoot`: change `V:/_FOOTAGE/UNG` → `V:/_FOOTAGE`.
|
||||
|
||||
## New production checklist
|
||||
|
||||
1. Create `<Footage Root>/{SHOW_ID}/{EPISODE or SCENE}/` and place EXR sequences inside, named `{SHOT_CODE}_{clip}`.
|
||||
1. Create `<Footage Root>/{SHOW_ID}/[{EPISODE_CODE}/]{SHOT_CODE}/` — episode level for episodic shows only, never a scene level — and place each plate in its own `{SHOT_CODE}_{ELEM}_{VER}/` folder inside it.
|
||||
2. `<Export Root>/{SHOW_ID}/` is created automatically on first render.
|
||||
3. Add the project to the VFXReview server with the correct **Show ID** set.
|
||||
4. Open the panel in After Effects, click **⚙**, enter the Server URL, API Token, bare `exportRoot`, and bare `footageRoot`, then click **Save**.
|
||||
@@ -158,7 +166,7 @@ Updates the **Status** panel to show the current count of selected `CompItem`s.
|
||||
### Fix Comp Names
|
||||
Renames selected comps so their names match the shot code extracted from their current name.
|
||||
|
||||
- Shot codes follow the pattern `XXX_000_000_000` (e.g. `UNG_106_010_020`).
|
||||
- Shot codes are read by anchoring on the selected project's showId — see [Shot Code Convention](#shot-code-convention).
|
||||
- If a comp name contains a valid shot code but has extra text, it is trimmed to the code only.
|
||||
- Wrapped in an undo group.
|
||||
|
||||
@@ -254,7 +262,7 @@ Imports a picture-lock (offline cut) video file and trims it to the correct sequ
|
||||
|
||||
**Process:**
|
||||
1. Calls the API to retrieve `seqTimecodeStart` and `seqTimecodeEnd` for the shot.
|
||||
2. Searches the `_PICLOCKS` project folder for already-imported footage matching the episode prefix (first 7 characters of the shot code, e.g. `UNG_106`).
|
||||
2. Searches the `_PICLOCKS` project folder for already-imported footage matching the episode prefix — `{showId}_{episode}` on episodic shows (e.g. `UNG_106`), plain `{showId}` on standard ones.
|
||||
3. If not found, scans `FOOTAGE_ROOT/_PICLOCKS/` for a file matching `{episodePrefix}_*` and imports it.
|
||||
4. Calculates the in/out offsets from the sequence timecodes relative to the piclock's start (assumed `01:00:00:00` / 3590 s unless embedded timecode is available), with **±8 frame handles**.
|
||||
5. Adds the piclock footage as a layer at the top of the comp, scales it to fill the frame, and sets `startTime`, `inPoint`, and `outPoint` to isolate the correct range.
|
||||
@@ -340,15 +348,19 @@ Accept: application/json
|
||||
|
||||
## Shot Code Convention
|
||||
|
||||
Shot codes follow the pattern `AAA_NNN_NNN_NNN` where:
|
||||
- `AAA` = three-letter show prefix (e.g. `UNG`)
|
||||
- First `NNN` = episode number (e.g. `106`)
|
||||
- Second `NNN` = sequence number (e.g. `010`)
|
||||
- Third `NNN` = shot number (e.g. `020`)
|
||||
Shot codes are the project's **showId** followed by three-digit tokens:
|
||||
|
||||
Example: `UNG_106_010_020`
|
||||
| Project type | Pattern | Example |
|
||||
|---|---|---|
|
||||
| Episodic | `{showId}_{episode}_{scene}_{shot}` | `UNG_106_010_020` (showId `UNG`) |
|
||||
| Standard | `{showId}_{scene}_{shot}` | `DH2_VFX_027_010` (showId `DH2_VFX`) |
|
||||
|
||||
Episode codes follow the pattern `AAA_NNN` (e.g. `UNG_106`).
|
||||
The showId is **not** always three letters and may itself contain underscores, so
|
||||
codes are parsed by stripping the known showId prefix — never by counting
|
||||
underscores or matching a fixed `AAA_` pattern. Everything after the showId is
|
||||
three digits per token.
|
||||
|
||||
Episode codes follow `{showId}_{episode}` (e.g. `UNG_106`).
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user