19 Commits
Author SHA1 Message Date
abhiTronix 7ab185acc8 📝 Docs: Fixed hyperlinks to new GitHub's form schemas.
- 🚧 Added `404.html` static template to `mkdocs.yml`.
2022-08-12 07:16:07 +05:30
abhiTronix d3d4db3baa 📝 Docs: several usability enhancements
- ✨ Added new Code Annotations.
- 💄 Added icons to headings.
- 🚸 Added additional warnings to push PR against VidGear's `testing` branch only.
- 💄 Updated dark theme hue to `260`.
- 📝 Updated Admonitions.
- 📝 Updated context and fixed typos.
2022-02-11 14:53:35 +05:30
abhiTronix 065e7356d8 🎨 Docs: Updates images and fixed context & typos. 2021-08-12 09:45:44 +05:30
abhiTronix a091d004f7 📄 License: Dropped publication year range to avoid confusion. (Signed and Approved by @abhiTronix)
- 📄 Updated Vidgear license's year of first publication of the work in accordance with US copyright notices defined by Title 17, Chapter 4(Visually perceptible copies): https://www.copyright.gov/title17/92chap4.html (Fixes #238)
- 💥 Reflected changes in all copyright notices.
2021-08-11 17:17:34 +05:30
abhiTronix d30c9ab7cd 📝 Docs: Updated examples.
- 📝 Added example for audio input support from external device in StreamGear.
- 📝 Added steps for using `-audio` attribute on different OS platforms in StreamGear.
- 📝 Added steps for identifying and specifying sound card on different OS platforms in WriteGear.
- ✏️ Updated context and fixed typos.
2021-08-11 16:20:15 +05:30
abhiTronix 2aec45b702 👷 CI: Updated CI tests for new HLS support
- 👷 Updated CI tests from scratch for new native HLS support in StreamGear.
- ✅ Added support for `hls` format in existing CI tests.
- ✅ Added new functions `check_valid_m3u8` and `extract_meta_video` for validating HLS files.
- ➕ Added new `m3u8` dependency to CI workflows.
- 💚 Fixed several bugs related to CI tests.

- 🐛 StreamGear: Fixed bugs related to external audio not mapped correctly in HLS format.
- 🔨 BASH: Added new `temp_m3u8` folder for generating M3U8 assets in CI tests.
- Docs:
  - 💡 Updated code comments.
  - 📝 Updated docs.
2021-08-06 07:26:05 +05:30
abhiTronix 18bd74315f 📝 Docs: Updated contexts 2021-08-02 21:29:16 +05:30
abhiTronix 545db174cf ✨ StreamGear: Native Support for Apple HLS (Fixes #106)
- ✨ Added support for new [Apple HLS](https://developer.apple.com/documentation/http_live_streaming) _(HTTP Live Streaming)_ HTTP streaming format in StreamGear.
- ⚡️ Implemented default workflow for auto-generating primary HLS stream of same resolution and framerate as source.
- ✨ Added HLS support in *Single-Source* and *Real-time Frames* Modes.
- ⚡️ Implemented inherit support for `fmp4` and `mpegts` HLS segment types.
- ✨ Added adequate default parameters required for transcoding HLS streams.
- ✨ Added native support for HLS live-streaming.
- 🚩 Added "hls" value to `format` parameter for easily selecting HLS format.
- ✨ Added HLS support in `-streams` attribute for transcoding additional streams.
- ✨ Added support for `.m3u8` and `.ts` extensions in `clear_prev_assets` workflow.
- 🔒️ Added validity check for `.m3u8` extension in output when HLS format is used.
- 🐛 Fixed expected aspect ratio not calculated correctly for additional streams.
- 🏗️ Separated DASH and HLS command handlers.
- 💡 Updated comments in source code.
- 🔊 Updated logging.

👷 CI: Update `mpegdash` dependency to `0.3.0-dev2` version in Appveyor.

Docs:
- 📝 Re-aligned badges in README.md.
- 📝 Updated context.
2021-07-23 11:07:15 +05:30
abhiTronix 71c693c1ff 📝 Docs: Updated context and some minor tweaks. 2021-07-18 09:18:21 +05:30
abhiTronix 11b8c3efcd ✨ NetGear: New Turbo-JPEG compression with simplejpeg (Fixes #202)
- ⚠️ Removed format specific OpenCV decoding and encoding support for NetGear.
- ⚠️ Dropped support for `compression_format`, `compression_param` attributes from NetGear.

- Implemented JPEG compression algorithm for 4-5% performance boost at cost of minor loss in quality.
- Utilized `encode_jpeg` and `decode_jpeg` methods to implement turbo-JPEG transcoding with `simplejpeg`.
- Added options to control JPEG frames quality, enable fastest dct, fast upsampling  to boost performance.
- Added new `jpeg_compression`, `jpeg_compression_quality`, `jpeg_compression_fastdct`, `jpeg_compression_fastupsample` attributes.
- Enabled fast dct by default with JPEG frames at 90%.
- Setup: Added `simplejpeg` package for all platforms.
- Docs: Fixed several typos and improved contexts.
2021-04-23 18:46:51 +05:30
abhishek 9429a5e3a2 📝 Docs: Few minor additions and fixes 2020-12-24 12:57:53 +05:30
abhishek 6c57b66fa0 📝 Rewritten docs from scratch
- Improved complete docs formatting.
- Simplified language for easier understanding.
- Fixed `mkdocstrings` showing root headings.
- Included all APIs methods to `mkdocstrings` docs.
- Removed unnecessary information from docs.
- Corrected Spelling and typos.
- Fixed context and grammar.
- Removed `motivation.md`.
- Renamed many terms.
- Added `gitmoji` for commits.
- Fixed hyper-links.
2020-12-21 17:01:13 +05:30
abhishek 3aef11d381 Finalizing docs
- Updated Licenses for new files and tweaked templates.
- Updated changelog.md and ReadME.md.
- Added  and reformated new assets.
2020-08-30 15:11:05 +05:30
abhishek 88572e8c1e Major Docs Updates and Enhancements:
- Lossless Webp compressed all png assets for faster loading.
- Enabled lazy loading for gifs for Performance Improvements.
- Deleted old Redundant assets and added new ones.
- Updated ReadME.md with new changes.
- Added `Request Info` and `Welcome` GitHub Apps to automate PR and issue workf$
  - Added new `config.yml` for customizations.
  - Added various suitable configurations.
- Updated Issue and PR templates.
- Reimplemented images with  <figure> and <figurecaption> like tags.
- Updated PR guidelines for more clarity.
2020-08-29 21:24:10 +05:30
Abhishek Thakur ba5de279e2 Docs Updates
- ⚠️ Changed Webgear API default address to `localhost` for cross compatibility between differnt OSes.
- Added logging for debugging selected eventloop in NetGear_Async API.
- Many typos and contexts fixed.
- Other minor docs tweaks
2020-06-28 10:46:36 +05:30
Abhishek Thakur 4bc54e8ae0 VidGear Docs: New updates and bugfixes 2020-06-13 12:14:31 +05:30
abhishek 0f2d78649a VidGear Docs: Incorrect relative links fixed. 2020-06-12 10:51:39 +05:30
abhishek 34297216fd VidGear Docs: New Updates
- Updated Release(Changelog).
- Added new images and renamed them accordingly.
- Added credits to designer in Image title.
2020-06-11 14:13:23 +05:30
abhishek 38ad11db9b VidGear Docs: Complete Migration to Mkdocs (Fixes #130)
- Implemented a beautiful, static documentation site based on MkDocs which will then be hosted on GitHub Pages.
- Crafted base mkdocs with third-party elegant `mkdocs-material` theme.
- Implemented new `mkdocs.yml` with relevant data.

- Added new `docs` folder to handle markdown pages and its assets.
- Added new markdown to docs folder, with carefully crafted documents, based on previous wikis, and some completely new additions.
- Added navigation under tabs for easily accessing each document.

- Added new assets like gifs, images, custom scripts, favicons, site.webmanifest 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 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 and git-revision-date-localized plugins support.
- Added various VidGear, and its author's social links to yaml.
- Added support for `en` (English) language.

- Added support for `mkdocstrings` plugin for auto-built API references.
- Added python handler for parsing python source-code to `mkdocstrings`.
- Improved source-code docs for compatibility with `mkdocstrings`.

- Implemented automated Deployment on gh-pages through GitHub Actions workflow.
- Added new workflow yaml for automated docs deployment.
- Adde complete python dependencies and environment.
- Added `master` branch on Ubuntu machine to build matrix.

- Updated Readme.md, Issue and PR templates with new information and updates.
- Updated license and bumped version to `0.1.8` for upcoming stable release.
- Moved changelog.md to `/docs` and updated contribution guidelines.
- Many small typos and bugs fixes.
2020-06-10 23:07:24 +05:30