Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
WyattBlue committed Oct 8, 2023
1 parent 854af36 commit 7d7065d
Showing 1 changed file with 18 additions and 28 deletions.
46 changes: 18 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,43 @@
# PyAV

PyAV is a Pythonic binding for the [FFmpeg](https://ffmpeg.org) libraries. We aim to provide all of the power and control of the underlying library, but manage the gritty details as much as possible.
# pyav
pyav implements bindings for the [ffmpeg](https://ffmpeg.org) libraries. We aim to provide all of the power and control of the underlying library, but manage the gritty details as much as possible.

---
[![Actions Status](https://github.com/WyattBlue/PyAV/workflows/tests/badge.svg)](https://github.com/wyattblue/PyAV/actions?workflow=tests)
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>

PyAV is for direct and precise access to your media via containers, streams, packets, codecs, and frames. It exposes a few transformations of that data, and helps you get your data to/from other packages (e.g. Numpy and Pillow).

This power does come with some responsibility as working with media is horrendously complicated and PyAV can't abstract it away or make all the best decisions for you. If the `ffmpeg` command does the job without you bending over backwards, PyAV is likely going to be more of a hindrance than a help.

But where you can't work without it, PyAV is a critical tool.
pyav is for direct and precise access to your media via containers, streams, packets, codecs, and frames. It exposes a few transformations of that data, and helps you get your data to/from other packages (e.g. Numpy and Pillow).

This power does come with some responsibility as working with media is horrendously complicated and pyav can't make all the best decisions for you. If the `ffmpeg` cli does the job without you bending over backwards, use it. pyav is much more complicated than the standalone `ffmpeg` program.

## Installing
Due to the complexity of the dependencies, PyAV is not always the easiest Python package to install from source. Binary wheels are provided on [PyPI](https://pypi.org/project/pyav) for MacOS, Windows, and Linux linked against a modern FFmpeg. You can install these wheels by running:

```bash
Just run:
```
pip install pyav
```

If you want to use your existing FFmpeg, the source version is available too:
Running the command should install the binary wheel provided. Due to the complexity of the dependencies, pyav is not easy to install from source. If you want to try your luck anyway, you can run:

```bash
```
pip install pyav --no-binary pyav
```

## Alternative installation methods

Another way of installing PyAV is via [conda-forge](https://conda-forge.github.io/):
And if you want to build the absolute latest (POSIX only):

```bash
conda install av -c conda-forge
```
git clone https://github.com/WyattBlue/pyav.git
cd pyav

And if you want to build from the absolute source (for development or testing):

```bash
git clone https://github.com/WyattBlue/PyAV.git
cd PyAV
source scripts/activate.sh

pip install -U -r tests/requirements.txt
./scripts/build-deps

make
# optional: make test
```

---

Have fun, and good luck!
## Motivations For a Fork
Unlike [PyAV](https://github.com/PyAV-Org/PyAV) (The original repo), this fork offers the following benefits:
* Wheels for Python 3.12
* Support for Cython 3
* Support for FFmpeg 6, and beyond
* Expanded support for different pixel formats
* Being maintained

0 comments on commit 7d7065d

Please sign in to comment.