Release Notes⚓

v0.2.6 (2022-07-05)⚓

New Features

Docs:
- Added new bonus example for RSTP/RTP Live-Streaming using WriteGear's Compression Mode.
- Added "How to resolve zmq.error.ZMQError" FAQ for NetGear API.(PR by @iandol)
- Added new ko-fi button to README.md
- Added new contributors block to changelog.md
Maintenance:
- Added new patterns to .gitignore to ignore pypi's build directory and egg-info files.
CI:
- Switched to new Issue GitHub's form schema using YAML
  - Added new bug_report.yaml.
  - Added new question.yaml.
  - Added new proposal.yaml.
  - Deleted depreciated markdown files.
  - Polished forms.

Updates/Improvements

Setup.py:
- Bumped version to 0.2.6.
- Updated logic operators and dependency.
  - Replaced >= comparsion operator with more flexible ~=.
  - Replaced distutils.version.LooseVersion with pkg_resources.parse_version.
Docs:
- Updated Site Navigation.
  - Added new notices to inform users more effectively about bonus examples.
  - Added new Bonus section to navigation and moved suitable pages under it.
  - Updated headings and URLs.
- Redesigned and Rewritten Donation and Contribution section to README.md
- Updated Zenodo badge and bibtex entry.
- Updated Admonition Icon, FAQs and site-links.
- Reformatted code and its comments.
- Updated changelog.md.
API:
- Updated depreciated tostring() to tobytes(). tostring was renamed to tobytes for the purposes for clarity in Python 3.2. https://docs.python.org/3/library/array.html#array.array.tobytes
CI:
- Added more paths and files to skip commits.

Breaking Updates/Changes

-input_framerate parameter now accepts any positive value for WriteGear and StreamGear APIs.

Bug-fixes

API:
- Fixed -input_framerate less than 5 does not get used in WriteGear and StreamGear APIs.(PR by @freol35241)
CamGear: Fixed Yt-dlp generated HTTP DASH Segments URLs not supported by OpenCV's VideoCapture(PR by @DynamiteC)
StreamGear:
- Fixed hls_segment_type not working bug. (PR by @enarche-ahn)
- Fixed critical logging parameter bug
  - Fixed debug logs even when logging=False in StreamGear's Real-time Mode. (patch suggested by @enarche-ahn)
  - Added length check to -video_source attribute to correctly infers it as empty(or invalid).
CI:
- Xfailed RSTP CamGear CI test.
- Fixed pinned version syntax bug in docs_deployer workflow.
- Fixed typos in Github forms and its context.
- Added missing dependency.
Docs:
- Fixed jinja2 3.1.0 or above breaks mkdocs.
  - jinja2>=3.1.0 breaks mkdocs (mkdocs/mkdocs#2799), therefore pinned jinja2 version to <3.1.0.
- Fixed support for new mkdocstring versions
  - Replaced rendering sub-value with options.
  - Removed pinned mkdocstrings==0.17.0 version.
- Fixed Netgear+Webgear bonus example code bugs.(PR by @iandol)
  - Added a missing import.
  - Removed self. typo.
  - Replaced the return value with break in the async as it triggers an error.
- Fixed external bug that causing "Home" tab to irresponsive randomly when accessed from other tabs.
- Fixed indentation and spacing.
- Fixed typos and updated context.
- Removed dead code.

Pull Requests

PR #288
PR #290
PR #293
PR #295
PR #307
PR #313
PR #320

New Contributors

v0.2.5 (2021-02-11)⚓

New Features

WriteGear:
- Add support for GStreamer pipeline in WriteGear API's Non-Compression mode:
  - Implemented GStreamer Pipeline Mode to accept GStreamer pipeline as string to its output_filename parameter.
  - Added new special -gst_pipeline_mode attribute for its output_params parameter.
  - This feature provides flexible way to directly write video frames into GStreamer Pipeline with controlled bitrate.
  - Added new docs and updated existing docs with related changes.
- Added new -ffpreheaders special attribute to WriteGear's options parameter:
  - This attribute is specifically required to set special FFmpeg parameters in Compression Mode that are present at the starting of command(such as -re).
  - This attribute only accepts list datatype as value.
  - Added related docs.
NetGear:
- Added bidirectional data transfer support by extending Bidirectional mode support to exclusive Multi-Clients and Multi-Servers modes:
  - Users will now able to send data bidirectionally in both Multi-Clients and Multi-Servers exclusive modes.
  - Bidirectional mode will no longer disables automatically when Multi-Clients and Multi-Servers modes already enabled.
  - Added new docs and updated existing docs with related changes.
Maintenance:
- Added official support for Python-3.10 legacies.
- Added float value support to THREAD_TIMEOUT optional parameter.
- Added info about dropped support for Python-3.6 legacies through announcement bar.
- Added config.md file for Issue templates.
- Added title to Issue templates.
Docs:
- Added new Code Annotations
- Added new icons to headings.
- Added Advanced VideoGear usage example with CamGear backend.

Updates/Improvements

Setup.py:
- Dropped support for Python-3.6 and below legacies.
- Updated logging formatting.
- Updated python_requires to >=3.7.
- Bumped version to 0.2.5.
Helper:
- Vidgear will now report current version on every run.
Docs:
- Updated SSH tunneling docs context.
- Excluded docs directory from CI envs.
- Updated Zenodo badge and BibTeX entry.
- Updated dark theme hue to 260.
- Updated Admonitions.
- Additional warnings against pushing PR against VidGear's testing branch only.
- Updated code comments.
CI:
- Removed support for Python-3.6 legacies from all workflows.
- Updated NetGear's Exclusive Mode tests.
- Added GStreamer Pipeline Mode tests.
Maintenance:
- Updated Issue and PR templates.
- Updated metadata.

Breaking Updates/Changes

Dropped support for Python-3.6 legacies from vidgear.

Bug-fixes

NetGear: Fixed bidirectional mode overriding multi-clients mode's data.
WriteGear:
- Fixed wrongly defined ffmpeg_preheaders.
- Fixed condition logic bugs.
- Fixed UnboundLocalError bug.
Setup: Fixed uvicorn and aiortc dropped support for Python-3.6 legacies.
CI:
- Fixed GitHub Actions interprets 3.10 as 3.1 if used without strings.
- Fixed naming error in azure YAML.
Docs:
- Fixed codecov badge URL in README.md
- Fixed hyperlinks in README.
- Fixed indentation and spacing.
- Fixed typos and updated context.
- Removed dead code.
Maintenance:
- Removed depreciated condition checks.

Pull Requests

PR #283
PR #284

v0.2.4 (2021-12-05)⚓

New Features

CamGear:
- Added a new YT_backend Internal Class with YT-DLP backend:
  - Implemented YT_backend a new CamGear's Internal YT-DLP backend class for extracting metadata from Streaming URLs.
  - Added support for pipeling (live) video-frames from all yt-dlp supported streaming sites: https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md#supported-sites
  - Implemented algorithm from scratch for auto-extracting resolution specific streamable URLs for pipelineing.
  - Implemented logic for auto-calculating best and worst resolutions.
  - Added new ytv_metadata global parameter to CamGear for accessing video's metadata(such as duration, title, description) on-the-go.
  - ⚠️ Playlists are still unsupported.
WebGear_RTC:
- Implemented a new easy way of defining Custom Streaming Class with suitable source(such as OpenCV):
  - Added new custom_stream attribute with WebGear_RTC options parameter that allows you to easily define your own Custom Streaming Class with suitable source(such as OpenCV).
  - This implementation supports repeated Auto-Reconnection or Auto-Refresh out-of-the-box.
  - This implementation is more user-friendly and easy to integrate within complex APIs.
  - This implementation requires at-least read() and stop() methods implemented within Custom Streaming Class, otherwise WebGear_RTC will throw ValueError.
  - This implementation supports all vidgear's VideoCapture APIs readily as input.
Maintenance:
- Added new .gitignore for specifying intentionally untracked files to ignore
  - Added more files entries to .gitignore.
- Added new .gitattributes to manage how Git reads line endings.
  - Enabled auto default behavior, in case people don't have core.autocrlf set.
  - Enforced LF line-endings for selective files types.
  - Added Binary data files that specifies they are not text, and git should not try to change them.
  - Added Language aware diff headers.
  - Added Linguist language overrides.
Docs:
- Added bonus example to add real-time file audio encoding with VideoGear and Stabilizer class.
- Added complete usage docs with new CamGear's Internal Class with YT-DLP backend.
- Added instructions to extract video's metadata in CamGear.
- Added donation link in page footer with bouncing heart animation through pure CSS.
- Added info about critical changes in v0.2.4 and above installation through new announcement bar.
- Added related usage docs for new WebGear_RTC custom streaming class.
- Added changes for upgrading mkdocs-material from v7.x to newer v8.x.
- Added outdated version warning block.

Updates/Improvements

CamGear:
- Added is_livestream global YT_backend parameters.
- Added default options for yt-dlp for extracting info_dict(metadata) of the video as a single JSON line.
- Completely removed old logic for extracting streams using pafy.
- Removed all dead code related to streamlink backend.
Setup.py:
- Moved all API specific dependencies to extra_requires under the name "core". [PR #268 by @zpapakipos]
- Added rule to replace GitHub heading links in description.
- Updated extra_require dependencies.
- Removed streamlink dependency.
- Removed pafy dependency.
- Removed pyzmq from latest_version group.
- Updated SEO Keywords.
Docs:
- Re-written pip and source installation docs.
- Added warning for using -disable_force_termination flag for short duration videos.
- Added permalink_title entry to mkdocs.yml.
- Updated CamGear parameters.
- Updated Admonitions with related information.
- Updated Functional Block Diagram(gears_fbd.png) image.
- Updated installation instructions.
- Updated Advanced examples using WebGear_RTC's custom streaming class.
- Updated code highlighting.
- Updated zenodo badge.
- Updated BibTex for project citation.
- Replaced incorrect API parameter docs.
- Updated WebGear_RTC parameters.
CI:
- Updated CI tests for new WebGear_RTC custom streaming class.
- Restored test_stream_mode CamGear test.
- Updated Streaming Sites test links.
- Added more tests cases.
Maintenance:
- Updated spacing in logger formatting.
- Renamed Asyncio Helper logger name.
- Changed logging colors.
- Updated logging messages.

Breaking Updates/Changes

Installation command with pip has been changed in v0.2.4:
- The legacy pip install vidgear command now installs critical bare-minimum dependencies only. Therefore in order to automatically install all the API specific dependencies as previous versions, use pip install vidgear[core] command instead.
CamGear:
- Removed streamlink backend support from stream_mode in favor of more reliable CamGear's Internal YT-DLP backend class for extracting metadata from Streaming URLs.
  - CamGear will raise ValueError if streaming site URL is unsupported by yt-dlp backend.
  - CamGear will raise ValueError if yt-dlp isn't installed and stream_mode is enabled.
- Removed automatic enforcing of GStreamer backend for YouTube-livestreams and made it optional.
  - The CamGear will not raise ValueError if GStreamer support is missing in OpenCV backends.
WebGear_RTC:
- Removed support for assigning Custom Media Server Class(inherited from aiortc's VideoStreamTrack) in WebGear_RTC through its config global parameter.
- WebGear_RTC API will now throws ValueError if source parameter is NoneType as well as custom_stream attribute is undefined.
Helper:
- Removed restore_levelnames method.
- Removed youtube_url_validator helper method.

Bug-fixes

CamGear:
- Fixed KeyError Bug for missing attributed in meta_data json in some streaming sites.
Helper:
- Removed unused imports.
Docs:
- Removed slugify from mkdocs which was causing invalid hyperlinks in docs.
- Fixed GitHub hyperlinks in README.md.
- Fixed hyperlink in announcement bar.
- Fixed content tabs failing to work.
- Fixed line-endings and usage example code.
- Removed any pafy and streamlink references.
- Fixed context and typos.
CI:
- Fixed NameError bugs in WebGear_RTC CI test.
Maintenance:
- Removed dead logger code causing Python's Built-in logging module to hide logs.
- Removed unused logging import.
- Updated code comments.

Pull Requests

PR #268
PR #272
PR #274

New Contributors

@zpapakipos

v0.2.3 (2021-10-27)⚓

New Features

CamGear:
- Added support for 4K Streaming URLs.
Helper:
- Implemented logging ColorFormatter string alignment.
  - Center aligned logging Level-name and Class-name.
  - Changed % formatting style with modern {.
  - Re-added asctime value to Formatter string.
  - Re-arranged parameter positions in Formatter string.
Maintenance:
- Added new .gitignore for specifying intentionally untracked files to ignore
  - Added more files entries to .gitignore.
- Added new .gitattributes to manage how Git reads line endings.
  - Enabled auto default behavior, in case people don't have core.autocrlf set.
  - Enforced LF line-endings for selective files types.
  - Added Binary data files that specifies they are not text, and git should not try to change them.
  - Added Language aware diff headers.
  - Added Linguist language overrides.
Docs:
- Added new ScreenGear with WebGear_RTC API bonus example.
- Added support for hl_lines argument for highlighting specific code lines.
- Added drop-shadow effects for its slate theme to improve visibility.

Updates/Improvements

CamGear:
- Replaced youtube-dl with yt-dlp as pafy backend for YouTube videos pipelining.
  - Implemented hack to trick pafy into assuming yt-dlp as youtube-dl.
  - Using sys.modules to present yt-dlp as youtube-dl.
  - yt-dlp python API functions exactly similar to youtube-dl.
  - Replaced youtube-dl dependency with yt-dlp.
  - Replaced youtube-dl imports with yt-dlp.
StreamGear:
- Updated default stream_count internal dict key value to 1.
Maintenance:
- Introduced python short-circuiting for handling logging logic.
- Enabled logging for check_WriteAccess method in WriteGear, StreamGear and NetGear APIs.
Docs:
- Added warning for ScreenGear outputting RGBA frames instead of default BGR frames with mss backend.
- Added warnings for properly formatting output_params when assigning external audio-source in WriteGear.
- Added depreciation notice for Python 3.6 legacies.
- Restructured docs to make it more user-friendly.
- Updated, Extended and Improved context.
- Improved code comments.
- Updated docs admonitions.
- Updated Zenodo badge.
CI:
- Migrated to new Codecov Uploader in Azure Pipelines.
  - Support for the Bash Uploader will be deprecated on February 1^st, 2022. See: https://docs.codecov.com/docs/about-the-codecov-bash-uploader
  - Added commands for signature and SHASUM verification to ensure integrity of the Uploader before use.
  - Replaced related bash commands.
- Replaced env with export in ci_linux.yml.
- Replaced bubkoo/needs-more-info@v1 with wow-actions/needs-more-info@v1.
- Added codecov secret token through env variable.
- Added wildcard to skip CI tests for doc(.md) files.
- Added .md files to Codecov ignore list.
- Update vidgear's banner image.

Breaking Updates/Changes

check_WriteAccess will now return as invalid path if writing directory does not exists. This will effect output file handling in WriteGear and StreamGear APIs.

Bug-fixes

StreamGear:
- Fixed StreamGear Malformed URI Error with HLS Segments [PR #243 by @Vboivin]
  - Removed the extra '%' character from the naming convention for segment files.
  - Used stream_count internal dict variable to alter template for HLS segment filenames.
WriteGear:
- Fixed bug in disable_force_termination logic which accidentally disables force termination.
WebGear_RTC:
- Fixed name 'VideoStreamTrack' is not defined bug.
Setup.py:
- Fixed TypeError bug.
- Fixed invalid latest_version retrieval.
Helper:
- Fixed check_WriteAccess failing to recognize correct permission for writing the output file on windows platform.
  - Implemented separate logic for Windows and *nix platforms.
  - Added new stat import.
  - Improved warnings and error handling.
  - Added logging parameter to check_WriteAccess.
- Fixed bug in check_WriteAccess that throws OSError while handling URLs.
Docs:
- Fixed bugs in WriteGear's Compression Mode with Live Audio Input example.
- Fixed "drop-shadow" property via filter function conflicting with sidecard button.
  - Added new CSS classes for image, admonitions and code highlight in dark theme.
- Several internal and external webpage links typos fixed.
- Fixed several language typos.
CI:
- Fixed Azure Pipeline coverage upload bugs.
- Fixed random errors in CamGear stream_mode test.
Bash:
- Removed the Windows carriage returns from the shell scripts to be able to execute them on Linux.
Fixed logging comments.

Pull Requests

PR #249
PR #262

New Contributors

@Vboivin

v0.2.2 (2021-09-02)⚓

New Features

Updates/Improvements

Breaking Updates/Changes

Virtually isolated all API specific dependencies, Now ImportError for API-specific dependencies will be raised only when any of them is missing at API's initialization.
Renamed delete_safe to delete_ext_safe.
Dropped support for frame_jpeg_quality, frame_jpeg_optimize, frame_jpeg_progressive attributes from WebGear.

Bug-fixes

Pull Requests

PR #210
PR #215
PR #222
PR #223
PR #227
PR #231
PR #233
PR #237
PR #239
PR #243

New Contributors

@kpetrykin

v0.2.1 (2021-04-25)⚓

New Features

Updates/Improvements

Breaking Updates/Changes

WriteGear will automatically switch video encoder to default if specified encoder not found.
WriteGear will throw RuntimeError if no suitable default encoder found!
Removed format specific OpenCV decoding and encoding support for NetGear.
Dropped support for compression_format, compression_param attributes from NetGear.
Non-existent parent folder in output_filename value will no longer be considered as invalid in StreamGear and WriteGear APIs.
None-type source parameter value is allowed for WebGear and NetGear_Async for defining custom sources.

Bug-fixes

Pull Requests

PR #192
PR #196
PR #203
PR #206

New Contributors

@bml1g12

v0.2.0 (2021-01-01)⚓

New Features

CamGear API:
- Support for various Live-Video-Streaming services:
  - Added seamless support for live video streaming sites like Twitch, LiveStream, Dailymotion etc.
  - Implemented flexible framework around streamlink python library with easy control over parameters and quality.
  - Stream Mode can now automatically detects whether source belong to YouTube or elsewhere, and handles it with appropriate API.
- Re-implemented YouTube URLs Handler:
  - Re-implemented CamGear's YouTube URLs Handler completely from scratch.
  - New Robust Logic to flexibly handing video and video-audio streams.
  - Intelligent stream selector for selecting best possible stream compatible with OpenCV.
  - Added support for selecting stream qualities and parameters.
  - Implemented new get_supported_quality helper method for handling specified qualities
  - Fixed Live-Stream URLs not supported by OpenCV's Videocapture and its FFmpeg.
- Added additional STREAM_QUALITY and STREAM_PARAMS attributes.
ScreenGear API:
- Multiple Backends Support:
  - Added new multiple backend support with new pyscreenshot python library.
  - Made pyscreenshot the default API for ScreenGear, replaces mss.
  - Added new backend parameter for this feature while retaining previous behavior.
  - Added native automated RGB to BGR conversion for default PIL backend.
  - Kept support for old mss for old compatibility and multi-screen support.
  - Added native dimensional support for multi-screen.
  - Added support all input from all multiple screens.
  - Updated ScreenGear Docs.
  - Updated ScreenGear CI tests.
StreamGear API:
- Changed default behaviour to support complete video transcoding.
- Added -livestream attribute to support live-streaming.
- Added additional parameters for -livestream attribute functionality.
- Updated StreamGear Tests.
- Updated StreamGear docs.
Stabilizer Class:
- New Robust Error Handling with Blank Frames:
  - Elegantly handles all crashes due to Empty/Blank/Dark frames.
  - Stabilizer throws Warning with this new behavior instead of crashing.
  - Updated CI test for this feature.
Docs:
- Automated Docs Versioning:
  - Implemented Docs versioning through mike API.
  - Separate new workflow steps to handle different versions.
  - Updated docs deploy worflow to support release and dev builds.
  - Added automatic version extraction from github events.
  - Added version-select.js and version-select.css files.
- Toggleable Dark-White Docs Support:
  - Toggle-button to easily switch dark, white and preferred theme.
  - New Updated Assets for dark backgrounds
  - New css, js files/content to implement this behavior.
  - New material icons for button.
  - Updated scheme to slate in mkdocs.yml.
- New Theme and assets:
  - New purple theme with dark-purple accent color.
  - New images assets with updated transparent background.
  - Support for both dark and white theme.
  - Increased rebufferingGoal for dash videos.
  - New updated custom 404 page for docs.
- Issue and PR automated-bots changes
  - New need_info.yml YAML Workflow.
  - New needs-more-info.yml Request-Info template.
  - Replaced Request-Info templates.
  - Improved PR and Issue welcome formatting.
- Added custom HTML pages.
- Added show_root_heading flag to disable headings in References.
- Added new inserAfter function to version-select.js.
- Adjusted hue for dark-theme for better contrast.
- New usage examples and FAQs.
- Added gitmoji for commits.
Continuous Integration:
- Maintenance Updates:
  - Added support for new VIDGEAR_LOGFILE environment variable in Travis CI.
  - Added missing CI tests.
  - Added logging for helper functions.
- Azure-Pipeline workflow for MacOS envs
  - Added Azure-Pipeline Workflow for testing MacOS environment.
  - Added codecov support.
- GitHub Actions workflow for Linux envs
  - Added GitHub Action work-flow for testing Linux environment.
- New YAML to implement GitHub Action workflow for python 3.6, 3.7, 3,8 & 3.9 matrices.
- Added Upload coverage to Codecov GitHub Action workflow.
- New codecov-bash uploader for Azure Pipelines.
Logging:
- Added file support
  - Added VIDGEAR_LOGFILE environment variable to manually add file/dir path.
  - Reworked logger_handler() Helper methods (in asyncio too).
  - Added new formatter and Filehandler for handling logger files.
- Added restore_levelnames auxiliary method for restoring logging levelnames.
Added auto version extraction from package version.py in setup.py.

Updates/Improvements

Breaking Updates/Changes

y_tube parameter renamed as stream_mode in CamGear API!
Removed Travis support and travis.yml deleted.

Bug-fixes

Pull Requests

PR #164
PR #170
PR #173
PR #181
PR #183
PR #184

v0.1.9 (2020-08-31)⚓

New Features

Updates/Improvements

Breaking Updates/Changes

Changed Webgear API default address to localhost for cross-compatibility between different platforms.
In Netgear_Async API, source value can now be NoneType for a custom frame-generator at Server-end only.
Temp (such as /tmp in linux) is now not a valid directory for WriteGear & StreamGear API outputs.
Moved vidgear docs assets (i.e images, gifs, javascripts and stylescripts) to override directory.

Bug-fixes

Pull Requests

PR #129
PR #130
PR #155

v0.1.8 (2020-06-12)⚓

New Features

NetGear API:
- Multiple Clients support:
  - Implemented support for handling any number of Clients simultaneously with a single Server in this mode.
  - Added new multiclient_mode attribute for enabling this mode easily.
  - Built support for zmq.REQ/zmq.REP and zmq.PUB/zmq.SUB patterns in this mode.
  - Implemented ability to receive data from all Client(s) along with frames with zmq.REQ/zmq.REP pattern only.
  - Updated related CI tests
- Support for robust Lazy Pirate pattern(auto-reconnection) in NetGear API for both server and client ends:
  - Implemented a algorithm where NetGear rather than doing a blocking receive, will now:
    - Poll the socket and receive from it only when it's sure a reply has arrived.
    - Attempt to reconnect, if no reply has arrived within a timeout period.
    - Abandon the connection if there is still no reply after several requests.
  - Implemented its default support for REQ/REP and PAIR messaging patterns internally.
  - Added new max_retries and request_timeout(in seconds) for handling polling.
  - Added DONTWAIT flag for interruption-free data receiving.
  - Both Server and Client can now reconnect even after a premature termination.
- Performance Updates:
  - Added default Frame Compression support for Bidirectional frame transmission in Bidirectional mode.
  - Added support for Reducer() function in Helper.py to aid reducing frame-size on-the-go for more performance.
  - Added small delay in recv() function at client's end to reduce system load.
  - Reworked and Optimized NetGear termination, and also removed/changed redundant definitions and flags.
Docs: Migration to Mkdocs
- Implemented a beautiful, static documentation site based on MkDocs which will then be hosted on GitHub Pages.
- Crafted base mkdocs with third-party elegant & simplistic mkdocs-material theme.
- Implemented new mkdocs.yml for Mkdocs with relevant data.
- Added new docs folder to handle markdown pages and its assets.
- Added new Markdown pages(.md) to docs folder, which are carefully crafted documents - [x] based on previous Wiki's docs, and some completely new additions.
- Added navigation under tabs for easily accessing each document.
- New Assets:
  - Added new assets like gifs, images, custom scripts, favicons, site.webmanifest etc. for bringing standard and quality to docs visual design.
  - Designed brand new logo and banner for VidGear Documents.
  - Deployed all assets under separate Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License.
- Added Required Plugins and Extensions:
  - Added support for all pymarkdown-extensions.
  - Added support for some important admonition, attr_list, codehilite, def_list, footnotes, meta, and toc like Mkdocs extensions.
  - Enabled search, minify and git-revision-date-localized plugins support.
  - Added various VidGear's social links to yaml.
  - Added support for en (English) language.
- Auto-Build API Reference with mkdocstrings:
  - Added support for mkdocstrings plugin for auto-building each VidGear's API references.
  - Added python handler for parsing python source-code to mkdocstrings.
- Auto-Deploy Docs with GitHub Actions:
  - Implemented Automated Docs Deployment on gh-pages through GitHub Actions workflow.
  - Added new workflow yaml with minimal configuration for automated docs deployment.
  - Added all required python dependencies and environment for this workflow.
  - Added master branch on Ubuntu machine to build matrix.

Updates/Improvements

Breaking Updates/Changes

VidGear Docs moved to GitHub Pages, Now Available at https://abhitronix.github.io/vidgear.
Removed filter attribute from options parameter in NetGear API.
Removed force_terminate parameter support from NetGear API.
Disabled additional data of datatype numpy.ndarray for Server end in Bidirectional Mode.

Bug-fixes

Pull Requests

PR #129
PR #130

v0.1.7 (2020-04-29)⚓

New Features

WebGear API:
- Added a robust Live Video Server API that can transfer live video frames to any web browser on the network in real-time.
- Implemented a flexible asyncio wrapper around starlette ASGI Application Server.
- Added seamless access to various starlette's Response classes, Routing tables, Static Files, Template engine(with Jinja2), etc.
- Added a special internal access to VideoGear API and all its parameters.
- Implemented a new Auto-Generation Work-flow to generate/download & thereby validate WebGear API data files from its GitHub server automatically.
- Added on-the-go dictionary parameter in WebGear to tweak performance, Route Tables and other internal properties easily.
- Added new simple & elegant default Bootstrap Cover Template for WebGear Server.
- Added __main__.py to directly run WebGear Server through the terminal.
- Added new gif and related docs for WebGear API.
- Added and Updated various CI tests for this API.
NetGear_Async API:
- Designed NetGear_Async asynchronous network API built upon ZeroMQ's asyncio API.
- Implemented support for state-of-the-art asyncio event loop uvloop at its backend.
- Achieved Unmatchable high-speed and lag-free video streaming over the network with minimal resource constraint.
- Added exclusive internal wrapper around VideoGear API for this API.
- Implemented complete server-client handling and options to use variable protocols/patterns for this API.
- Implemented support for all four ZeroMQ messaging patterns: i.e zmq.PAIR, zmq.REQ/zmq.REP, zmq.PUB/zmq.SUB, and zmq.PUSH/zmq.PULL.
- Implemented initial support for tcp and ipc protocols.
- Added new Coverage CI tests for NetGear_Async Network Gear.
- Added new Benchmark tests for benchmarking NetGear_Async against NetGear.
Asynchronous Enhancements:
- Added asyncio package to for handling asynchronous APIs.
- Moved WebGear API(webgear.py) to asyncio and created separate asyncio helper.py for it.
- Various Performance tweaks for Asyncio APIs with concurrency within a single thread.
- Moved __main__.py to asyncio for easier access to WebGear API through the terminal.
- Updated setup.py with new dependencies and separated asyncio dependencies.
General Enhancements:
- Added new highly-precise Threaded FPS class for accurate benchmarking with time.perf_counter python module.
- Added a new Gitter community channel.
- Added a new Reducer function to reduce the frame size on-the-go.
- Add Flake8 tests to Travis CI to find undefined names. (PR by @cclauss)
- Added a new unified logging handler helper function for vidgear.

Updates/Improvements

Breaking Updates/Changes

Dropped support for Python 3.5 and below legacies. (See issue #99)
Dropped and replaced Python 3.5 matrices with new Python 3.8 matrices in all CI environments.
Implemented PEP-8 Styled Black formatting throughout the source-code.
Limited protocols support to tcp and ipc only, in NetGear API.

Bug-fixes

Pull Requests

PR #88
PR #91
PR #93
PR #95
PR #98
PR #101
PR #114
PR #118
PR #124

New Contributors

v0.1.6 (2020-01-01)⚓

New Features

NetGear API:
- Added powerful ZMQ Authentication & Data Encryption features for NetGear API:
  - Added exclusive secure_mode param for enabling it.
  - Added support for two most powerful Stonehouse & Ironhouse ZMQ security mechanisms.
  - Added smart auth-certificates/key generation and validation features.
- Implemented Robust Multi-Servers support for NetGear API:
  - Enables Multiple Servers messaging support with a single client.
  - Added exclusive multiserver_mode param for enabling it.
  - Added support for REQ/REP & PUB/SUB patterns for this mode.
  - Added ability to send additional data of any datatype along with the frame in realtime in this mode.
- Introducing exclusive Bidirectional Mode for bidirectional data transmission:
  - Added new return_data parameter to recv() function.
  - Added new bidirectional_mode attribute for enabling this mode.
  - Added support for PAIR & REQ/REP patterns for this mode
  - Added support for sending data of any python datatype.
  - Added support for message parameter for non-exclusive primary modes for this mode.
- Implemented compression support with on-the-fly flexible frame encoding for the Server-end:
  - Added initial support for JPEG, PNG & BMP encoding formats .
  - Added exclusive options attribute compression_format & compression_param to tweak this feature.
  - Client-end will now decode frame automatically based on the encoding as well as support decoding flags.
- Added force_terminate attribute flag for handling force socket termination at the Server-end if there's latency in the network.
- Implemented new Publish/Subscribe(zmq.PUB/zmq.SUB) pattern for seamless Live Streaming in NetGear API.
PiGear API:
- Added new threaded internal timing function for PiGear to handle any hardware failures/frozen threads.
- PiGear will not exit safely with SystemError if Picamera ribbon cable is pulled out to save resources.
- Added support for new user-defined HWFAILURE_TIMEOUT options attribute to alter timeout.
VideoGear API:
- Added framerate global variable and removed redundant function.
- Added CROP_N_ZOOM attribute in Videogear API for supporting Crop and Zoom stabilizer feature.
WriteGear API:
- Added new execute_ffmpeg_cmd function to pass a custom command to its FFmpeg pipeline.
Stabilizer class:
- Added new Crop and Zoom feature.
  - Added crop_n_zoom param for enabling this feature.
- Updated docs.
CI & Tests updates:
- Replaced python 3.5 matrices with latest python 3.8 matrices in Linux environment.
- Added full support for Codecov in all CI environments.
- Updated OpenCV to v4.2.0-pre(master branch).
- Added various Netgear API tests.
- Added initial Screengear API test.
- More test RTSP feeds added with better error handling in CamGear network test.
- Added tests for ZMQ authentication certificate generation.
- Added badge and Minor doc updates.
Added VidGear's official native support for MacOS environments.

Updates/Improvements

Breaking Updates/Changes

Python 2.7 legacy support dropped completely.
Source-code Relicensed to Apache 2.0 License.
Python 3+ are only supported legacies for installing v0.1.6 and above.
Python 2.7 and 3.4 legacies support dropped from CI tests.

Bug-fixes

Pull Requests

New Contributors

@BoboTiG

v0.1.5 (2019-07-24)⚓

New Features

Updates/Improvements

Updated New dependencies: mss, pyzmq and rejected redundant ones.
Revamped and refreshed look for readme.md and added new badges.
Updated Releases Documentation completely.
Updated CI tests for new changes
Updated Code Documentation.
Updated bash scripts and removed redundant information
Updated Youtube video URL in tests
Completely Reformatted and Updated Wiki Docs with new changes.

Breaking Updates/Changes

Implemented experimental Threaded Queue Mode(a.k.a Blocking Mode) for fast, synchronized, error-free multi-threading.
Renamed bash script pre-install.sh to prepare_dataset.sh - [x] downloads opensourced test datasets and static FFmpeg binaries for debugging.
Changed script folder location to bash/script.
Python 3.4 removed from Travis CI tests.

Bug-fixes

Pull Requests

v0.1.4 (2019-05-11)⚓

New Features

Updates/Improvements

Removed redundant dependencies
Updated youtube-dl as a dependency, as required by pafy's backend.
Updated common VideoGear API with new parameter.
Update robust algorithm to auto-detect FFmpeg executables and test them, if failed, auto fallback to OpenCV's VideoWriter API.
Improved system previously installed OpenCV detection in setup.py.
Updated setup.py with hack to remove bullets from pypi description.
Updated Code Documentation
Reformatted & Modernized readme.md with new badges.
Reformatted and Updated Wiki Docs.

Breaking Updates/Changes

Removed -height and -width parameter from CamGear API.
Replaced dependency opencv-python with opencv-contrib-python completely

Bug-fixes

Windows Cross-Platform fix: replaced dependency os with platform in setup.py.
Fixed Bug: Arises due to spaces in input **options/**output_param dictionary keys.
Fixed several wrong/missing variable & function definitions.
Fixed code uneven indentation.
Fixed several typos in docs.

Pull Requests

PR #7
PR #8
PR #10
PR #12

v0.1.3 (2019-04-07)⚓

Bug-fixes

Patched Major PiGear Bug: Incorrect import of PiRGBArray function in PiGear Class
Several Fixes for backend picamera API handling during frame capture(PiGear)
Fixed missing frame variable initialization.
Fixed minor typos

Pull Requests

PR #6
PR #5

v0.1.2 (2019-03-27)⚓

New Features

Added easy Source manipulation feature in CamGear API, to control features like resolution, brightness, framerate etc.
Added new **option parameter to CamGear API, provides the flexibility to manipulate input stream directly.
Added new parameters for Camgear API for time delay and logging.
Added new Logo to readme.md
Added new Wiki Documentation.

Updates/Improvements

Reformatted readme.md.
Updated Wiki Docs with new changes.

Bug-fixes

Improved Error Handling in CamGear & PiGear API.
Fixed minor typos in docs.

Pull Requests

PR #4

v0.1.1 (2019-03-24)⚓

New Features

Release ViGear binaries on the Python Package Index (PyPI)
Added new and configured setup.py & setup.cfg

Bug-fixes

Fixed PEP bugs: added and configured properly __init__.py in each folder
Fixed PEP bugs: improved code Indentation
Fixed wrong imports: replaced distutils.core with setuptools
Fixed readme.md

v0.1.0 (2019-03-17)⚓

New Features

Initial Release
Converted my imutils PR into Python Project.
Renamed conventions and reformatted complete source-code from scratch.
Added support for both python 2.7 and 3 legacies
Added new multi-threaded CamGear, PiGear, and VideoGear APIs
Added multi-platform compatibility
Added robust & flexible control over the source in PiGear API.

Last update: July 5, 2022