diff --git a/README.md b/README.md new file mode 100644 index 00000000..7e571897 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# `ffmpegio-core`: Media I/O with FFmpeg in Python + +**This package has been deprecated as it is merged with the `ffmpegio` package.** + +If you are new to the package, please install `ffmpegio` instead: + +``` +pip install ffmpegio +``` + +and visit visit [https://github.com/python-ffmpegio/python-ffmpegio](https://github.com/python-ffmpegio/python-ffmpegio) for the details. + +If you are an active ffmpegio user, please read the following link for how to upgrade to v0.11 + +[https://github.com/python-ffmpegio/python-ffmpegio/wiki/Instructions-to-upgrade-to-v0.11.0](https://github.com/python-ffmpegio/python-ffmpegio/wiki/Instructions-to-upgrade-to-v0.11.0) diff --git a/README.rst b/README.rst deleted file mode 100644 index 30f0438f..00000000 --- a/README.rst +++ /dev/null @@ -1,373 +0,0 @@ -`ffmpegio-core`: Media I/O with FFmpeg in Python -=================================================== - -|pypi| |pypi-status| |pypi-pyvers| |github-license| |github-status| - -.. |pypi| image:: https://img.shields.io/pypi/v/ffmpegio - :alt: PyPI -.. |pypi-status| image:: https://img.shields.io/pypi/status/ffmpegio - :alt: PyPI - Status -.. |pypi-pyvers| image:: https://img.shields.io/pypi/pyversions/ffmpegio - :alt: PyPI - Python Version -.. |github-license| image:: https://img.shields.io/github/license/python-ffmpegio/python-ffmpegio - :alt: GitHub License -.. |github-status| image:: https://img.shields.io/github/actions/workflow/status/python-ffmpegio/python-ffmpegio/test_n_pub.yml?branch=main - :alt: GitHub Workflow Status - -Python `ffmpegio` package aims to bring the full capability of `FFmpeg `__ -to read, write, probe, and manipulate multimedia data to Python. FFmpeg is an open-source cross-platform -multimedia framework, which can handle most of the multimedia formats available today. - -Main Features -------------- - -* Pure-Python light-weight package interacting with FFmpeg executable found in - your system -* Read, write, filter, and create functions for audio, image, and video data -* Context-managing `ffmpegio.open` to perform stream read/write operations of video and audio -* Media readers can output the data in a Numpy array (if Numpy is installed) or a plain :code:`bytes` - objects in a :code:`dict`. The mode of operation can be switched with :code:`ffmpegio.use` function. -* Media writers can write a new media file from either data given in a Numpy array or :code:`bytes` - objects in a :code:`dict`. -* Write Matplotlib figures to images or to a video (a simpler interface than Matplotlib's Animation writers). -* Probe media file information -* Accepts all FFmpeg options including filter graphs -* Transcode a media file to another in Python -* Supports a user callback whenever FFmpeg updates its progress information file - (see `-progress` FFmpeg option) -* `ffconcat` scripter to make the use of `-f concat` demuxer easier -* I/O device enumeration to eliminate the need to look up device names. (currently supports only: Windows DirectShow) -* More features to follow - -Installation ------------- - -Install the full `ffmpegio` package via ``pip``: - -.. code-block:: bash - - pip install ffmpegio - -Following optional external packages are required to enable the :code:`ffmpegio` features that interact -with them. - -.. table:: - :class: tight-table - - ========================== ======================================================================== ===================================== - Distro package name :code:`ffmpegio` features Deprecated plugin names - ========================== ======================================================================== ===================================== - :code:`numpy` Support Numpy array inputs and outputs intead of bytes :code:`ffmpegio` - :code:`matplotlib` Support generation of images or videos from Matplotlib figure :code:`ffmpegio-plugin-mpl` - :code:`ffmepeg-downloader` Support the FFmpeg binaries installed by the :code:`ffdl` command :code:`ffmpegio-plugin-downloader` - :code:`static-ffmpeg` Support the FFmpeg binaries installed by :code:`static-ffmpeg` :code:`ffmpegio-plugin-static-ffmpeg` - ========================== ======================================================================== ===================================== - -These features are automatically enabled if the external packages are installed along along side with `ffmpegio`. -:code:`ffmpegio` is imported - -.. note:: - - Prior to v0.11.0, these features were only enabled via installing separate plugin packages (listed in the table above). - :code:`ffmpegio` v0.11 and :code:`ffmpegio-core` v0.11 are identical, and :code:`ffmpegio-core` will no longer receive - the updates. - -Documentation -------------- - -Visit our `GitHub page here `__ - -Examples --------- - -To import `ffmpegio` - -.. code-block:: python - - >>> import ffmpegio - -- `Transcoding `_ -- `Read Audio Files `_ -- `Read Image Files / Capture Video Frames `_ -- `Read Video Files `_ -- `Read Multiple Files or Streams `_ -- `Write Audio, Image, & Video Files `_ -- `Filter Audio, Image, & Video Data `_ -- `Stream I/O `_ -- `Video from Matplotlib Figure