Editorial_pkg: publishing sequence into OTIO timeline with rendered media #132

moonyuet · 2024-10-10T15:44:31Z

Changelog Description

Implement a sequence-based workflow for publishing an editorial package in Unreal. This workflow should publish the OTIO timeline and an intermediate render in MP4 format.

Resolve #131,
Resolve #125
Resolve #124

otio representation implementation
Has unreal_export.py edited for the otio implementation
Edit rendering.py which can be used for both rendering and editorial intermediate rendering

Additional info

-It may need multiple testing to get the correct frame ranges
@jakubjezek001 this is the zipped file with otio and the clip:
il_UE_editorial_pkgMain_v006.zip

Testing notes:

Select level sequence which includes MovieShotCutTrack/CameraCutTrack with multiple sections
Create Editorial Package Instance with it
Ayon -> Render
Wait to render out all the sequences until finished
Ayon -> Publish
It should publish successfully with mp4 and otio
Load otio in hiero/resolve

…ot render out the frame first, and make sure the product name unique

…implement the functions for storing the relevant editorial data

jakubjezek001

After a call with Kayla I am adding some notes for the workflow improvements

extract_intermediate_representation

add settings for the plugin containing:
- output extension - with validation for video type only restriction
- custom ffmpeg args list
- representation tag list
- representation custom tags list
gets rendered exrs sequence
converts exrs to settings defined output file
use the output file as representation for integration
this representation only is used in extract_editorial_package plugin for otio ExternalRepresentations

extract_editorial_package

make sure all clips are having ExternalRepresentations inherited from extract_intermediate_representation with correct trim framerange
all media source paths should be relative to published otio file representation
find a way to pass sequence item's unique identifyer to otio clip metadata (this will be later used for loading and edit synchronization)

LiborBatek

Sorry but still not working when trying to load the editorial pckg into Resolve...

I will provide both otio and publish report too for inspection.

And publish report:
UE-Editorial-publish-report-250922-15-33.json.txt

QD_unreal_editorial_pkgMain_v006.otio.txt

Note: It could be loaded manually via native File > Import Timeline as seen on the scrncap below, also note missing burnins on the source mp4 file (Ayon didnt incorporate any)

moonyuet · 2025-09-23T04:29:41Z

@jakubjezek001 can you review?
@LiborBatek can you test it again in regards to the updated commit?

LiborBatek · 2025-09-23T10:34:54Z

@moonyuet I did re-test it but still no luck.... no burnins and cant Ayon load the editorial into Resolve...

no good news, sry

…a to identify clips and tracks in unreal

moonyuet · 2025-09-23T11:00:47Z

The updated commit includes the clips and tracks with unreal-specific metadata to identify the clips and tracks(They get different names with some version numbers)
il_UE_editorial_pkgTest_v010_otio.txt

jakubjezek001 · 2025-09-25T09:22:48Z

client/ayon_unreal/plugins/publish/extract_intermediate_representation.py

+    def _extract_intermediate(
+            self, instance, input_frames, render_dir, extension, ffmpeg_args):
+        """Extract the intermediate representation for the instance.
+
+        Args:
+            instance (pyblish.api.Instance): The instance to extract.
+            input_frames (list): List of input frame file paths.
+            render_dir (str): The directory where the rendered files are located.
+            extension (str): The file extension for the intermediate representation.
+            ffpmeg_args (dict): Dictionary which stores the list of additional ffmpeg arguments.
+        """
+        collection = pipeline.get_sequence_by_collection(input_frames)[0]
+        in_frame_start = min(collection.indexes)
+        # converting image sequence to image sequence
+        input_file = collection.format("{head}{padding}{tail}")
+        input_path = os.path.join(render_dir, input_file)
+        output_path = os.path.join(render_dir, f"{instance.name}.{extension}")
+        sequence_fps = instance.data["fps"]
+        input_args = ffmpeg_args.get("input", [])
+        default_input_args = [
+            "-start_number", str(in_frame_start),
+            "-framerate", str(sequence_fps),
+        ]
+        if input_args:
+            default_input_args.extend(input_args)
+        default_input_args.extend(["-i", input_path])
+        all_intput_args = self._split_ffmpeg_args(default_input_args)
+        output_args = ffmpeg_args.get("output", [])
+        video_filters = ffmpeg_args.get("video_filters", [])
+        audio_filters = ffmpeg_args.get("audio_filters", [])
+
+        output_args = self._split_ffmpeg_args(output_args)
+        video_args_dentifiers = ["-vf", "-filter:v"]
+        audio_args_dentifiers = ["-af", "-filter:a"]
+        for arg in tuple(output_args):
+            for identifier in video_args_dentifiers:
+                if arg.startswith("{} ".format(identifier)):
+                    output_args.remove(arg)
+                    arg = arg.replace(identifier, "").strip()
+                    video_filters.append(arg)
+
+            for identifier in audio_args_dentifiers:
+                if arg.startswith("{} ".format(identifier)):
+                    output_args.remove(arg)
+                    arg = arg.replace(identifier, "").strip()
+                    audio_filters.append(arg)
+
+        all_args = [
+            subprocess.list2cmdline(get_ffmpeg_tool_args("ffmpeg"))
+        ]
+        all_args.extend(all_intput_args)
+        if video_filters:
+            all_args.append("-filter:v")
+            all_args.append("\"{}\"".format(",".join(video_filters)))


@iLLiCiTiT could you have a look please?

Sorry for late response, not sure what should I be looking at?

…real-to-Ayon

client/ayon_unreal/hooks/pre_otio_install.py

iLLiCiTiT · 2025-11-25T16:17:02Z

client/ayon_unreal/plugins/publish/collect_editorial_package.py

+        try:
+            project = get_current_project_name()
+            anatomy = Anatomy(project)
+            root = anatomy.roots['renders']
+        except Exception as e:
+            raise Exception((
+                "Could not find render root "
+                "in anatomy settings.")) from e
+        render_dir = f"{root}/{project}/editorial_pkg/{instance.data.get('output')}"


Suggested change

try:

project = get_current_project_name()

anatomy = Anatomy(project)

root = anatomy.roots['renders']

except Exception as e:

raise Exception((

"Could not find render root "

"in anatomy settings.")) from e

render_dir = f"{root}/{project}/editorial_pkg/{instance.data.get('output')}"

anatomy = instance.context.data["anatomy"]

try:

root = anatomy.roots['renders']

except Exception as e:

raise Exception((

"Could not find render root "

"in anatomy settings.")) from e

render_dir = f"{root}/{anatomy.project_name}/editorial_pkg/{instance.data.get('output')}"

This is forcing studio to have "renders" root. That probably should be settings related?

Unfortunately this is the current state where the renders root is really enforced. We need to change it to "normal" anatomy templates for Unreal with some sane defaults, but not in this PR. So there should be setting to select proper anatomy template.

The issue is that in Unreal, you don't want to have renders in Unreal project, you need them somewhere else.

client/ayon_unreal/plugins/publish/extract_intermediate_representation.py

iLLiCiTiT · 2025-11-25T16:19:10Z

client/ayon_unreal/plugins/publish/extract_intermediate_representation.py

+        try:
+            project = get_current_project_name()
+            anatomy = Anatomy(project)
+            root = anatomy.roots['renders']
+        except Exception as e:
+            raise Exception((
+                "Could not find render root "
+                "in anatomy settings.")) from e
+
+        render_dir = f"{root}/{project}/editorial_pkg/{data.get('output')}"


Suggested change

try:

project = get_current_project_name()

anatomy = Anatomy(project)

root = anatomy.roots['renders']

except Exception as e:

raise Exception((

"Could not find render root "

"in anatomy settings.")) from e

render_dir = f"{root}/{project}/editorial_pkg/{data.get('output')}"

anatomy = instance.context.data["anatomy"]

try:

root = anatomy.roots['renders']

except Exception as e:

raise Exception((

"Could not find render root "

"in anatomy settings.")) from e

render_dir = f"{root}/{anatomy.project_name}/editorial_pkg/{data.get('output')}"

Same question as above, the root should be in settings.

If the path is "hardcoded" (which seems as it is), it probably should be passed along instead of calculating it again at all the places?

Co-authored-by: Jakub Trllo <[email protected]>

moonyuet added 3 commits October 10, 2024 23:35

wip for creator, collector and extractor for editorial product type

72c2f1e

remove collect editorial as it is not gonna use for this workflow

ef4e87d

remove otio-related workflow as it is not related to this PR

9f24405

moonyuet changed the title ~~Implementation of Editorial Publish(EDL only)~~ Implementation of Editorial Publish Oct 11, 2024

moonyuet added 7 commits October 11, 2024 17:58

wip the creator and render for clip function

f96b691

wip the creator

bbfafef

wip on the creator and collector

58e46bf

wip on the creator

b6082c4

use editorial pkg product type

427828e

remove to return unnecessary function

f4a6956

wip on implementation

4962722

moonyuet added the type: feature Adding something new and exciting to the product label Oct 15, 2024

moonyuet added 8 commits October 31, 2024 21:01

draft the otio_unreal_export script

ea40c2d

draft the otio_unreal_export script

9377c8d

resolve conflict

47dd36a

wip creator

3001478

wip creator

521d94b

add intermediate renders and supports rendering for editorial package

1e60e01

add the check on the publish error in the collector if the users do n…

4864345

…ot render out the frame first, and make sure the product name unique

make sure the frame range is correct

306cd6e

moonyuet requested a review from antirotor November 4, 2024 10:57

moonyuet self-assigned this Nov 4, 2024

moonyuet added 8 commits November 4, 2024 21:49

edit rendering py for rendering out the image in different directory

6f93a9c

fix the enumerate value

c6afe1e

update the intermediate render product type as editorial publish and …

be237a5

…implement the functions for storing the relevant editorial data

edit the unreal_export.py

2cbab6e

coverting otio logic to accompany wioth unreal in unreal_export.py

b146626

coverting otio logic to accompany wioth unreal in unreal_export.py

9291eaa

implement unreal logic into unreal_export.py

78d794e

impelement the extractor for intermediate render

beb46a3

Use Pathlib to make sure the path compatible to all dccs

dd2377b

moonyuet requested a review from jakubjezek001 September 16, 2025 14:06

jakubjezek001 requested changes Sep 17, 2025

View reviewed changes

moonyuet added 3 commits September 22, 2025 16:26

add ffmpeg argument supports for extract intermediate representation

f75b082

remove unused import

00bab4d

use the correct unreal setting and fix the input arguments for ffmpeg

e98445f

LiborBatek requested changes Sep 22, 2025

View reviewed changes

use different output arguments

97f750b

moonyuet requested review from LiborBatek and jakubjezek001 and removed request for jakubjezek001 September 23, 2025 04:28

resolve conflict

50f6f74

update the intermediate representation arguments and specific metadat…

1b84edc

…a to identify clips and tracks in unreal

moonyuet added 2 commits September 23, 2025 20:44

adding burnin as families so that to use extract burnin

dd7e189

add burnin tags

a354798

jakubjezek001 reviewed Sep 25, 2025

View reviewed changes

jakubjezek001 requested a review from iLLiCiTiT September 25, 2025 09:25

Merge branch 'develop' into feature/AY-6916_Editorial-publish-from-Un…

ac02bba

…real-to-Ayon

jakubjezek001 added the sponsored This is directly sponsored by a client or community member label Nov 7, 2025

iLLiCiTiT reviewed Nov 25, 2025

View reviewed changes

client/ayon_unreal/hooks/pre_otio_install.py Outdated Show resolved Hide resolved

iLLiCiTiT reviewed Nov 25, 2025

View reviewed changes

client/ayon_unreal/plugins/publish/extract_intermediate_representation.py Outdated Show resolved Hide resolved

iLLiCiTiT reviewed Nov 25, 2025

View reviewed changes

moonyuet and others added 4 commits November 26, 2025 00:58

Update extract_intermediate_representation.py

50399d4

Co-authored-by: Jakub Trllo <[email protected]>

Update pre_otio_install.py

4a52064

Co-authored-by: Jakub Trllo <[email protected]>

kuba's comment - code clean up

f160e89

ruff fix

0bf8c68

Editorial_pkg: publishing sequence into OTIO timeline with rendered media #132

Are you sure you want to change the base?

Editorial_pkg: publishing sequence into OTIO timeline with rendered media #132

Conversation

moonyuet commented Oct 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog Description

Additional info

Testing notes:

Uh oh!

jakubjezek001 left a comment • edited by moonyuet Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

extract_intermediate_representation

extract_editorial_package

Uh oh!

LiborBatek left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

moonyuet commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LiborBatek commented Sep 23, 2025

Uh oh!

moonyuet commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jakubjezek001 Sep 25, 2025

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iLLiCiTiT Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

antirotor Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iLLiCiTiT Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

moonyuet commented Oct 10, 2024 •

edited

Loading

jakubjezek001 left a comment •

edited by moonyuet

Loading

LiborBatek left a comment •

edited

Loading

moonyuet commented Sep 23, 2025 •

edited

Loading

moonyuet commented Sep 23, 2025 •

edited

Loading

iLLiCiTiT Nov 25, 2025 •

edited

Loading