zprp-ffmpeg 1.1.0

ffmpeg filter graph bindings for python

Design proposal

Biblioteka ma za zadanie zastąpić i rozszerzyć istniejącą bibliotekę (https://github.com/kkroening/ffmpeg-python)

Minimalną funkcjonalność, którą chcemy zaimplementować, to ta oferowana przez powyższą bibliotekę, czyli korzystanie z grafów filtrów poprzez prosty interfejs. Poza tym, zależy nam na lepszej integracji z IDE (opisy filtrów w docstringach, typy argumentów), żeby ograniczyć potrzebę krążenia po dokumentacji FFmpeg.

Stack technologiczny

• szablon cookiecutter: https://github.com/ionelmc/cookiecutter-pylibrary

• dokumentacja mkdocs

• linter ruff

• Poetry do budowania paczki

• tox do automatycznych testów

• CI/CD przy użyciu github actions (uruchomienie testów, budowanie paczki, automatyczny release do PyPI)

Planowany rozkład jazdy

1. 18.03-24.03

   • Struktura projektu (cookiecutter)

   • Chcemy mieć możliwość uruchomienia testów, zbudowania dokumentacji (narazie pustej), zbudowania paczki.

2. 25.03-31.03

   • Podstawowa interakcja z procesem FFmpeg jako subproces

   • metody input, output

   • testy potwierdzające działanie

3. 01.04-07.04

   • metoda filter, run, compile

4. 08.04-14.04

   • implementacja części logiki grafu filtrów

   • jakiś podzbiór funkcjonalności np. concat tylko

5. 15.04-21.04

   • dalsza część logiki grafów

6. 22.04-28.04

   • poboczne metody: probe, view, run_async

7. 29.04-05.05

   • dodanie osobnych metod na popularne filtry np. hfilp.

   • ? automatyczna generacja metod z kodu źródłowego ffmpeg

Tygodnie 8-13 przewidziane na potencjalne przesunięcia w planie.

Dokumentacja będzie pisana regularnie wraz z kodem jako docstringi

Overview

docs
tests
package

Implementation of the successor to the ffmpeg-python library

• Free software: MIT license

Installation

pip install zprp-ffmpeg

You can also install the in-development version with:

pip install https://github.com/ffpmeg-zprp/zprp-ffmpeg/archive/main.zip

Documentation

https://zprp-ffmpeg.readthedocs.io/

Development

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox