version bump -> v0.5.0

Author: tikuma-lsuhsc

CHANGELOG.md

@@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [0.5.0] - 2022-04-03
+
+### Changed
+
+- Matching the `ffmpegio` version bump 
+
 ## [0.4.1] - 2022-02-22
 
 ### Changed
@@ -36,6 +42,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - First release.
 - A plugin to convert raw media I/O data of `ffmpegio` to use `numpy.ndarray` objects.
 
-[Unreleased]: https://github.com/python-ffmpegio/python-ffmpegio/compare/v0.4.1...HEAD
+[Unreleased]: https://github.com/python-ffmpegio/python-ffmpegio/compare/v0.5.0...HEAD
+[v0.5.0]: https://github.com/python-ffmpegio/python-ffmpegio/compare/v0.4.1...v0.5.0
 [v0.3.3]: https://github.com/python-ffmpegio/python-ffmpegio/compare/v0.3.1...v0.4.1
 [v0.3.1]: https://github.com/python-ffmpegio/python-ffmpegio/compare/v0.3.0...v0.3.1

README.rst

@@ -15,11 +15,13 @@
   :alt: GitHub Workflow Status
 
 Python `ffmpegio` package aims to bring the full capability of `FFmpeg <https://ffmpeg.org>`__
-to read, write, and manipulate multimedia data to Python. FFmpeg is an open-source cross-platform 
+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.
 
-Since v0.3.0, `ffmpegio` Python distribution package has been split into `ffmpegio-core` and `ffmpegio` to allow
-Numpy-independent installation.
+.. note::
+  
+  Since v0.3.0, `ffmpegio` Python distribution package has been split into `ffmpegio-core` and `ffmpegio` to allow
+  Numpy-independent installation.
 
 Install the full `ffmpegio` package via ``pip``:
 
@@ -46,7 +48,8 @@ Main Features
 * Accepts all FFmpeg options including filter graphs
 * Supports a user callback whenever FFmpeg updates its progress information file 
   (see `-progress` FFmpeg option)
-* Advanced users can gain finer controls of FFmpeg I/O with `ffmpegio.ffmpegprocess` submodule
+* `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
 
 Documentation
@@ -63,6 +66,20 @@ To import `ffmpegio`
 
   >>> import ffmpegio
 
+- `Transcoding <ex_trancode>`__
+- `Read Audio Files <ex_read_audio>`__
+- `Read Image Files / Capture Video Frames <ex_read_image>`__
+- `Read Video Files <ex_read_video>`__
+- `Read Multiple Files or Streams <ex_read_media>`__
+- `Write Audio, Image, & Video Files <ex_write>`__
+- `Filter Audio, Image, & Video Data <ex_filter>`__
+- `Stream I/O <ex_stream>`__
+- `Device I/O Enumeration <ex_devices>`__
+- `Progress Callback <ex_progress>`__
+- `Run FFmpeg and FFprobe Directly <ex_direct>`__
+
+.. _ex_trancode:
+
 Transcoding
 ^^^^^^^^^^^
 
@@ -79,6 +96,15 @@ Transcoding
   >>> ffmpegio.transcode('input.avi', 'output.mkv', two_pass=True, show_log=True,
   >>>                    **{'c:v':'libx264', 'b:v':'2600k', 'c:a':'aac', 'b:a':'128k'}) 
 
+  >>> # concatenate videos using concat demuxer
+  >>> files = ['/video/video1.mkv','/video/video2.mkv']
+  >>> ffconcat = ffmpegio.FFConcat()
+  >>> ffconcat.add_files(files)
+  >>> with ffconcat: # generates temporary ffconcat file
+  >>>     ffmpegio.transcode(ffconcat, 'output.mkv', f_in='concat', codec='copy', safe_in=0)
+
+.. _ex_read_audio:
+
 Read Audio Files
 ^^^^^^^^^^^^^^^^
 
@@ -95,6 +121,8 @@ Read Audio Files
   >>> #   filter: equalizer which attenuate 10 dB at 1 kHz with a bandwidth of 200 Hz 
   >>> fs, x = ffmpegio.audio.read('myaudio.mp3', t=10.0, af='equalizer=f=1000:t=h:width=200:g=-10')
 
+.. _ex_read_image:
+
 Read Image Files / Capture Video Frames
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -125,6 +153,8 @@ Read Image Files / Capture Video Frames
   >>> I = ffmpegio.image.read('myaudio.mp3', filter_complex='showspectrumpic=s=960x540', pix_fmt='rgb24')
 
 
+.. _ex_read_video:
+
 Read Video Files
 ^^^^^^^^^^^^^^^^
 
@@ -136,7 +166,9 @@ Read Video Files
 
   >>> # get running spectrogram of audio input (must specify pix_fmt if input is audio)
   >>> fs, F = ffmpegio.video.read('myvideo.mp4', pix_fmt='rgb24', filter_complex='showspectrum=s=1280x480')
+  
 
+.. _ex_read_media:
 
 Read Multiple Files or Streams
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -157,6 +189,8 @@ Read Multiple Files or Streams
   >>> #  rates: dict of frame rates: keys="v:0" and "v:1"
   >>> #  data: dict of video frame arrays: keys="v:0" and "v:1"
 
+.. _ex_write:
+
 Write Audio, Image, & Video Files
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -171,7 +205,9 @@ Write Audio, Image, & Video Files
   >>> # create an audio file from a numpy array
   >>> ffmpegio.audio.write('myaudio.mp3', rate, x)
 
-Filter Audio, Image, & Video data
+.. _ex_filter:
+
+Filter Audio, Image, & Video Data
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: python
@@ -186,6 +222,8 @@ Filter Audio, Image, & Video data
   >>> filter = "drawtext=fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h)/2"
   >>> fs_out, F_out = ffmpegio.video.filter(filter, fs_in, F_in)
 
+.. _ex_stream:
+
 Stream I/O
 ^^^^^^^^^^
 
@@ -198,10 +236,28 @@ Stream I/O
   >>>     for frames in fin:
   >>>         fout.write(myprocess(frames))
 
+.. _ex_devices:
+
+Device I/O Enumeration
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+  >>> # record 5 minutes of audio from Windows microphone
+  >>> fs, x = ffmpegio.audio.read('a:0', f_in='dshow', sample_fmt='dbl', t=300)
 
-Progress callback
+  >>> # capture Windows' webcam frame
+  >>> with ffmpegio.open('v:0', 'rv', f_in='dshow') as webcam,
+  >>>     for frame in webcam:
+  >>>         process_frame(frame)
+
+.. _ex_progress:
+
+Progress Callback
 ^^^^^^^^^^^^^^^^^
 
+.. code-block:: python
+
   >>> import pprint
 
   >>> # progress callback
@@ -219,3 +275,34 @@ Progress callback
   >>> with ffmpegio.open('myvideo.mp4', 'rv', blocksize=100, progress=progress) as fin:
   >>>     for frames in fin:
   >>>         myprocess(frames)
+
+.. _ex_direct:
+
+Run FFmpeg and FFprobe Directly
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+  >>> from ffmpegio import ffmpeg, FFprobe, ffmpegprocess
+  >>> from subprocess import PIPE
+
+  >>> # call with options as a long string
+  >>> ffmpeg('-i input.avi -b:v 64k -bufsize 64k output.avi')
+
+  >>> # or call with list of options
+  >>> ffmpeg(['-i', 'input.avi' ,'-r', '24', 'output.avi'])
+
+  >>> # the same for ffprobe
+  >>> ffprobe('ffprobe -show_streams -select_streams a INPUT')
+
+  >>> # specify subprocess arguments to capture stdout
+  >>> out = ffprobe('ffprobe -of json -show_frames INPUT', 
+                    stdout=PIPE, universal_newlines=True).stdout
+
+  >>> # use ffmpegprocess to take advantage of ffmpegio's default behaviors
+  >>> out = ffmpegprocess.run({"inputs": [("input.avi", None)],
+                               "outputs": [("out1.mp4", None),
+                                           ("-", {"f": "rawvideo", "vframes": 1, "pix_fmt": "gray", "an": None})
+                              }, capture_log=True)
+  >>> print(out.stderr) # print the captured FFmpeg logs (banner text omitted)
+   >>> b = out.stdout # width*height bytes of the first frame

ffmpegio

@@ -1,33 +1,53 @@
 import ffmpegio
 from matplotlib import pyplot as plt
 
-vf = ffmpegio.FilterGraph(
-    [
-        [
-            (
-                "drawtext",
-                {
-                    "fontfile": "C:\\WINDOWS\\FONTS\\BKANT.TTF",
-                    "text": "Test Text",
-                    "x": "(w-text_w)/2",
-                    "y": "(h-text_h)/2",
-                    "fontsize": 24,
-                    "fontcolor": "black@0.8",
-                    "box": 1,
-                    "boxcolor": "white@0.5",
-                    "boxborderw": 6,
-                },
-            )
-        ]
-    ]
-)
-
-I = ffmpegio.image.create("smptebars", d=1, vf=vf)
-
-plt.imshow(I)
-plt.show()
+# vf = ffmpegio.FilterGraph(
+#     [
+#         [
+#             (
+#                 "drawtext",
+#                 {
+#                     "fontfile": "C:\\WINDOWS\\FONTS\\BKANT.TTF",
+#                     "text": "Test Text",
+#                     "x": "(w-text_w)/2",
+#                     "y": "(h-text_h)/2",
+#                     "fontsize": 24,
+#                     "fontcolor": "black@0.8",
+#                     "box": 1,
+#                     "boxcolor": "white@0.5",
+#                     "boxborderw": 6,
+#                 },
+#             )
+#         ]
+#     ]
+# )
+
+# I = ffmpegio.image.create("smptebars", d=1, vf=vf)
+
+# plt.imshow(I)
+# plt.show()
 
 # T = 10
 # ffmpegio.video.write(
 #     r"sandbox\test.mp4", 1 / T, I, r=25, t=10, show_log=True, overwrite=True
 # )
+
+i = 0
+
+url = r'sandbox\test.mp4'
+
+info = ffmpegio.probe.video_streams_basic(url)[0]
+w = info['width']
+h = info['height']
+
+with ffmpegio.open(url, f_in='lavfi',pix_fmt='rgb24', 
+                   hwaccel_in='auto',bufsize=w*h*3*2) as f:
+    for image in f:
+        i += 1
+        print(image.shape,image.dtype)
+
+        # throw away the data in the pipe's buffer.
+        f.read(2) # flush the buffer (of size 2)
+
+        if i>2:
+            break

sandbox/test_image_video.py

@@ -30,7 +30,7 @@ classifiers =
 package_dir=
     =src
 install_requires =
-    ffmpegio-core >= 0.3.1
+    ffmpegio-core >= 0.5.0
     numpy >= 1.20
 python_requires = >=3.7,
 packages=ffmpegio_plugin_numpy

setup.cfg

@@ -8,7 +8,7 @@
 
 hookimpl = HookimplMarker("ffmpegio")
 
-__version__ = "0.4.3"
+__version__ = "0.5.0"
 
 __all__ = [
     "video_info",