aep-parser 0.3.0

A .aep (After Effects Project) parser

aep_parser

An After Effects file parser in Python!
Explore the docs »

About The Project

This as a .aep (After Effects Project) parser in Python. After Effects files (.aep) are mostly binary files, encoded in RIFX format. This parser uses Kaitai Struct to parse .aep files and return a Project object containing items, layers, effects and properties. The API is as close as possible to the ExtendScript API, with a few nice additions like iterators instead of collection items.

(back to top)

Installation

pip install aep-parser

(back to top)

Usage

import aep_parser

# Parse an After Effects project
app = aep_parser.parse("path/to/project.aep")
project = app.project

# Access application-level info
print(f"AE Version: {app.version}")

# Access every item
for item in project:
    print(f"{item.name} ({type(item).__name__})")

# Get a composition by name and its layers
comp = next(c for c in project.compositions if c.name == "Comp 1")
for layer in comp.layers:
    print(f"  Layer: {layer.name}, in={layer.in_point}s, out={layer.out_point}s")

    # Access layer's source (for AVLayer)
    if hasattr(layer, "source") and layer.source:
        print(f"    Source: {layer.source.name}")
        # Get file path if source is footage with a file
        if hasattr(layer.source, "file"):
            print(f"    File: {layer.source.file}")

# Access render queue
for rq_item in project.render_queue.items:
    print(f"Render: {rq_item.comp_name}")
    for om in rq_item.output_modules:
        # Settings are a dict with ExtendScript keys
        video_on = om.settings.get("Video Output", False)
        print(f"  Output: {om.name}, video={video_on}")

(back to top)

Roadmap

See the open issues for a full 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.

(back to top)

Contributing

See the full Contributing Guide on GitHub.

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Aurore Delaunay - [e-mail]

(back to top)

Acknowledgments

• aftereffects-aep-parser in Go
• Kaitai Struct
• The invaluable Lottie Docs
• After Effects Scripting Guide
• AE version parsing

(back to top)