boredstiff / protio

Premiere Pro Open Timeline IO App
31 stars 4 forks source link

Protio

Premiere OpenTimelineIO extension. Pronounced "Pro-T-Oh".

Allows you to import and export OpenTimelineIO sequences, and launch the otioview application.

Wide View

Collapsed View

Contribution

Michael Nowakowski - Helped a lot on the UI design

Bruce Bullis - Insurmountable Premiere Wisdom

Installation

Building requirements:
Runtime requirements:

Building For Dev:

If you're not familiar with make, you should get familiar with it first.

To build a local dev copy in order to do work, you have to build a folder path first. That folder path is:

"%APPDATA%\\Adobe\\CEP\\extensions\\protio"

or

/Library/Application Support/Adobe/CEP/extensions/protio
cd /c/dev/protio
yarn global add gulp (This is only required the very first time)
yarn global add jspm (This is only required the very first time)
make deps
make build-dev
gulp watch (Doesn't seem to be picking up on Windows inside build-dev, need to look into this).

If you notice inside of the protio source folder, there is a .debug file. This file states what port the extension is debugged on, which is 6145. Go to localhost:6145 in a Chrome browser and you can do debugging.

However, you can't do that just yet if this is your first time developing an Adobe CEP extension. You can't even open the extension inside of Premiere yet, even though it shows up under Window > Extensions > Protio

If you are in the midst of development, you can bypass the check for extension signature by editing the CSXS preference properties file, located at:

Win: regedit >
     HKEY_CURRENT_USER/Software/Adobe/CSXS.8
     Add a new entry PlayerDebugMode of type "string" with the value of "1".
Mac: In the terminal, type: 
     defaults write com.adobe.CSXS.8 PlayerDebugMode 1
     (The plist is also located at /Users/USERNAME/Library/Preferences/com.adobe.CSXS.8.plist)

This puts your Adobe apps into debug mode, and now you can open the application.

While Gulp is running, you can update files and close and reopen the extension to test changes. At a studio that I used to work at, we had a Ctrl + R refresh working at some point, but an update eventually ruined what allowed that to work. It currently works intermittently and eventually stops working altogether.

Additionally, you can now go to localhost:6145 and run the debugger.

Building for Release:

Usage

After installing, go to Window > Extensions > Protio

Then, click either the import otio as sequence button or the export sequence as otio button.

Deployment

If you work in a studio environment... have fun. Adobe deployment for their packages is atrocious and is not built for a scalable, distributed solution like one that is needed at visual effects studios. Ironic, right? They have this desire to want to put everything in their store, but stuff like that does not work when you're off network, or need to push out constant updates.

At the studio that I used to work at, we had a deployment manager called Ansible (but you can do the same thing with a Docker container) that moved packages around on disk and we would put a variation of the development workflow on disk locally for the editors.

To build everything out into a deployable package, run

make build

This will make a folder called dist/ and a folder called output, and you want to take the built extension from the output folder and distribute that.

As a note, the Makefile contains default fake data in the build step for the ZXPSignCmd. Fill this with information for you or your organization.

Finally, you can run the

make deploy

step which will place the built .zxp in the output/ folder in the correct location for Premiere to find it.