VidGear Stable v0.3.0

📓 Complete Release Notes can be found here ↗️

---

New Features ✨

• WriteGear:
  • Added support for higher than 8-bit depth frames with datatypes of unsigned integer(uint) kind and element size 2.
  • Added new -input_pixfmt attribute to output_params dictionary parameter for easily specifying custom input pixel-format.
  • Added support for Context Managers __enter__() and __exit__() methods for proper handling of resources via with statement for allocating and releasing resources precisely. (Suggested by @sueskind)
• StreamGear:
  • Added support for Context Managers __enter__() and __exit__() methods for proper handling of resources via with statement for allocating and releasing resources precisely. (Suggested by @sueskind)
• WebGear:
  • Added new skip_generate_webdata boolean optional attribute(False by default) to completely disable Data-Files Auto-Generation WorkFlow.
    • This flag enables only /video route for disabled Data-Files Auto-Generation WorkFlow.
• Helper:
  • Added more robust implementation of validate_audio method with more robust regex pattern for extracting audio-samplerate.
  • Added support for Linux video device path (such as /dev/video0).
• Maintenance:
  • Logging current vidgear version when vidgear APIs are called, not at import.
    • Current version can only be logged by VidGear APIs with the logging turned on (i.e. logging=True).

Updates/Improvements ⚡️

• WriteGear:
  • Updated comments, description, and logging messages to more sensible and developer friendly.
    • Renamed startFFmpeg_Process internal class method to start_FFProcess.
    • Renamed Preprocess internal class method to PreprocessFFParams.
    • Renamed startCV_Process internal class method to start_CVProcess.
    • Renamed initiate internal class parameter to initiate_process.
    • Renamed force_termination internal class parameter to forced_termination.
• Helper:
  • Updated validate_audio method with improved and more robust regex patterns for identifying audio bitrate in ay audio file.
• Setup.py:
  • Replaced distutils.version.LooseVersion with pkg_resources.parse_version.
• Maintenance:
  • Replaced depreciated LooseVersion with parse_version.
  • Updated Retry package to be imported from requests.adapters.
• Bash Scripts:
  • Updated FFmpeg Static Binaries links to latest date/version tag to 12-07-2022.

Breaking Updates/Changes 💥

• WriteGear:
  • 💣 Renamed output_filename string parameter to output.
  • 💣 Renamed cmd parameter in execute_ffmpeg_cmd() class method to more sensible command.
  • 💣 ValueError will be raised if datatype of input frames mismatches.

Bug-fixes 🐛

• Camgear:
  • Fixed CamGear.read() blocked unnecessarily.
  • Fixed deadlock on termination.
• ScreenGear:
  • Fixed ScreenGear.read() blocked during startup.
    • 💬 During startup, ScreenGear.read() doesn't checks if queue is empty before continuing.
• WriteGear:
  • Fixed gstpipeline_mode not activating when wrongly assuming output value as valid path.
  • Fixed name 'compression' is not defined bug.
• Helper:
  • Fixed fltp keyword in regex pattern causing non-ftlp streams to be not recognized.
  • Fixed response.headers returning content-length as Nonetype since it may not necessarily have the Content-Length header set.
• Setup:
  • Pinned pyzmq==24.0.1 working version.