cvf_runtime

Console Video File runtime — play .cvf files in the terminal.

cvf_runtime reads a .cvf file and plays it frame-by-frame in the terminal. No keybinds, no editing, no interface. Just playback.

Install

pip install cvf_runtime

Installs cuifw automatically (required for rendering).

Usage

Python

import cvf_runtime

cvf_runtime.execute("movie.cvf")

With parameters

cvf_runtime.execute("movie.cvf", loop=True)
cvf_runtime.execute("movie.cvf", speed=2.0)
cvf_runtime.execute("movie.cvf", fps=30)
cvf_runtime.execute("movie.cvf", start=100, end=200)

In the background

import cvf_runtime
import time

handle = cvf_runtime.execute_async("movie.cvf", loop=True)
time.sleep(5)
handle.stop()

API

cvf_runtime.execute(path, loop=False, speed=1.0, fps=None, start=0, end=None)

Play a .cvf file in the terminal. Blocks until finished.

Returns the number of frames shown.

cvf_runtime.execute_async(path, loop=False, speed=1.0, fps=None, start=0, end=None)

Start a .cvf player in a background Python process.

Returns a handle with:

• handle.is_playing() — True if still running
• handle.stop() — graceful stop
• handle.kill() — force kill
• handle.wait() — block until done

cvf_runtime.Runtime(path, loop=False, speed=1.0, fps_override=None, start=0, end=None)

Low-level player class.

Methods:

• run() — play, returns frames shown
• info() — dict with metadata

Info about a file

import cvf_runtime

r = cvf_runtime.Runtime("movie.cvf")
info = r.info()

print(info["width"], "x", info["height"])
print(info["fps"])
print(info["frames"])
print(info["duration"])
print(info["color_mode"])

Requirements

• Python 3.7+
• cuifw (installed automatically)
• Terminal with UTF-8 support

Supported platforms

Difference from cvf

cvf — full library for creating and editing .cvf files. cvf_runtime — minimal runtime for playing .cvf files.

License

MIT — see LICENSE.

Author

Suleiman

Changelog

1.0.3

• Initial release
• execute() — synchronous playback
• execute_async() — background playback
• Runtime — low-level player
• info() — file metadata
• Grayscale and TrueColor support