py_aep
py_aep is a Python package for working with After Effects AEP files.
About
After Effects files (.aep) are mostly binary files, encoded in RIFX format. This package uses struct to parse .aep files and return an Application object containing a project, items, layers, effects and properties. The API is very close to the ExtendScript API, with a few nice additions like iterators.
Features
Supported
- Reading .aep files
- Creating a new empty project from scratch (
py_aep.new), replicating File > New > New Project
- Saving to a new .aep file
- Modifying most properties, including some that are not accessible through ExtendScript such as gradients, render settings, 3D renderer options, output module settings, etc. (Differences from ExtendScript for more details)
- Adding and removing keyframes on any property - including mask paths, source text, markers, orientation and gradients - with static/animated transitions matching After Effects' own output
- Adding new compositions and folders, moving items between folders
- Creating layers: solids, nulls, shapes, cameras, lights, text (point, box and vertical text), and parametric 3D mesh layers (cube, sphere, plane, torus, cone, cylinder)
- Removing items and layers; moving and duplicating layers; replacing a layer's source item
- Importing footage files and image sequences, setting proxies, and selecting a single layer from layered
.psd/.psb/.ai/.pdf files
- Replacing a footage item's source, including rebinding to a specific layer of a layered file
- Variable font axes on text layers, and editing dropdown menu items (property parameters)
- Render queue management: adding compositions, removing and duplicating items, adding output modules, applying render/output templates from the AE preferences
- Essential Graphics, Essential Properties and alternate sources
- Preferences parsing for Render Queue Item / Output Module templates, New Composition / Project presets, ...
- Interpolation between numeric keyframe values
- Color Management: working and display space, footage interpretation and output module
Limited support
- Properties that are synthesized by After Effects at runtime and not stored in the binary are supported but some might be missing or inaccurate
- When adding effect properties to a layer or PropertyGroup, only effects that are already present in a .aep can be added
- Some Text layers attributes are missing
Not supported
- Expression evaluation
- Image sampling and rendering
- Layers, properties and keyframes selection
- Runtime things such as System information, UI state, etc.
Installation
uv (recommended)
uv add py-aep
pip
pip install py-aep
Getting started
import py_aep
app = py_aep.parse("myproject.aep")
project = app.project
comp = project.compositions[0]
# Modify composition settings
comp.frame_rate = 24
# Modify a layer property
comp.layers[0].transform.opacity.value = 50
# Save to a new file
project.save("modified.aep")
For more examples, see the Quick Start guide.
Roadmap
See the open issues for a list of proposed features and known issues.
If you encounter a bug, please submit an issue and attach a basic scene to reproduce your issue.
Contributing
See the full Contributing Guide on GitHub.
Contact
Aurore Delaunay - [email protected]
Acknowledgments
