\n\n \n\nVidGear is a powerful python Video Processing library built with multi-threaded [**Gears**](#gear)(_a.k.a APIs_) each with a unique set of trailblazing features. These APIs provides a easy-to-use, highly extensible, and multi-threaded wrapper around many underlying state-of-the-art python libraries such as *[OpenCV \u27b6][opencv], [FFmpeg \u27b6][ffmpeg], [picamera \u27b6][picamera], [pafy \u27b6][pafy], [pyzmq \u27b6][pyzmq] and [python-mss \u27b6][mss]*\n\n \n\nThe following **functional block diagram** clearly depicts the functioning of VidGear library:\n\n
\n \n
\n\n \n\n## Table of Contents\n\n[**TL;DR**](#tldr)\n\n[**New Release : VidGear 0.1.5**](#new-release-sneekpeak--vidgear-015)\n\n[**Installation Options**](#installation)\n * [**Prerequisites**](#prerequisites)\n * [**1 - PyPI Install**](#option-1-pypi-install)\n * [**2 - Release Archive Download**](#option-2-release-archive-download)\n * [**3 - Clone Repo**](#option-3-clone-the-repo)\n\n[**Gears: What are these?**](#gears)\n * [**CamGear**](#camgear)\n * [**PiGear**](#pigear)\n * [**VideoGear**](#videogear)\n * [**ScreenGear**](#screengear)\n * [**WriteGear**](#writegear)\n * [**NetGear**](#netgear)\n\n**For Developers/Contributors**\n * [**Testing**](#testing)\n * [**Contributing**](#contributing)\n\n[**Documentation**](#documentation)\n\n[**Project Motivation**](#project-motivation)\n\n**Additional Info**\n * [**Supported Python legacies**](#supported-python-legacies)\n * [**Changelog**](#changelog)\n * [**License**](#license)\n\n \n\n## TL;DR\n *VidGear is an [ultrafast\u27b6][ultrafast-wiki], compact, flexible and easy-to-adapt complete Video Processing Python Library.*\n\n Built with simplicity in mind, VidGear lets programmers and software developers to easily integrate and perform complex Video Processing tasks in their existing or new applications, without going through various underlying python library's documentation and using just a few lines of code. Beneficial for both, if you're new to Programming with Python language or a pro at it. \n\n For more advanced information see the [Wiki Documentation \u27b6][wiki].\n\n\n\n\n \n\n## New Release SneekPeak : VidGear 0.1.5\n * Released new ScreenGear API, supports Live ScreenCasting.\n * Released new NetGear API, aids real-time frame transfer through messaging(ZmQ) over the network.\n * Released new Stabilizer Class, for minimum latency Video Stabilization with OpenCV.\n * Updated VideoGear API to be used as an internal wrapper around Stabilizer Class.\n * Implemented exclusive Threaded Queue Mode for blazingly fast, synchronized and error-free multi-threading APIs.\n * Added Option to use VidGear API's standalone.\n * Several Performance enhancements and Bugs exterminated.\n * Revamped Docs and [many more...](changelog.md)\n\n \n\n## Installation\n\n### Prerequisites\n\nTo use VidGear in your python application, you must check the following dependencies before you install VidGear :\n\n* Must support [these Python legacies](#supported-python-legacies) and [pip][pip] already installed.\n\n\n* **`OpenCV:`** VidGear must require OpenCV(3.0+) python enabled binaries to be installed on your machine for its core functions. For its installation, you can follow these online tutorials for [linux][OpenCV-linux] and [raspberry pi][OpenCV-pi], otherwise, install it via pip:\n\n ```sh\n pip install opencv-python\n ```\n\n* **`FFmpeg:`** VidGear must require FFmpeg for its powerful video compression and encoding capabilities. :star2: Follow this [**FFmpeg wiki page**][ffmpeg-wiki] for its installation. :star2:\n\n* **`picamera:`** Required for using Raspberry Pi Camera Modules(_such as OmniVision OV5647 Camera Module_) on your Raspberry Pi machine. You can easily install it via pip:\n\n ```sh\n pip install picamera\n ``` \n Also, make sure to enable Raspberry Pi hardware-specific settings prior to using this library.\n\n* **`mss:`** Required for Screen Casting. Install it via pip:\n\n ```sh\n pip install mss\n ```\n* **`pyzmq:`** Required for transferring video frames through _ZeroMQ messaging system_ over the network. Install it via pip:\n\n ```sh\n pip install pyzmq\n ```\n\n* **`pafy:`** For direct YouTube Video streaming, Vidgear needs [`pafy`][pafy] and latest [`youtube-dl`][yt-dl](as pafy's backend) python libraries installed. Install it via pip:\n\n ```sh\n pip install pafy\n pip install -U youtube-dl\n ```\n\n\n \n\n### Option 1: PyPI Install\n\n> Best option for **quickly** getting VidGear installed.\n\n```sh\n pip install vidgear\n```\n \n\n### Option 2: Release Archive Download\n\n> Best option if you want a **compressed archive**.\n\nVidGear releases are available for download as packages in the [latest release][release]\n\n \n\n### Option 3: Clone the Repository\n\n> Best option for **automatically installing required dependencies**(_except FFmpeg_), or for **latest patches**(_maybe experimental_), or **contributing** to development.\n\nYou can clone this repository's `testing` branch for development and thereby can install as follows:\n```sh\n git clone https://github.com/abhiTronix/vidgear.git\n cd vidgear\n git checkout testing\n pip install .\n```\n\n \n\n## Gears:\n\nVidGear is built with multi-threaded **Gears** each with some unique function/mechanism. Each **Gear** is designed exclusively to handle/control different device-specific video streams, network streams, and media encoders. These APIs provides an easy-to-use, highly extensible, and a multi-threaded wrapper around many underlying various python libraries to exploit their features and functions directly while providing robust error-handling. \n\n**These Gears can be classified as follows:**\n\n**A. VideoCapture Gears:**\n\n * [**CamGear:**](#camgear) _Targets various IP-USB-Cameras/Network-Streams/YouTube-Video-URL._\n * [**PiGear:**](#pigear) _Targets various Raspberry Pi Camera Modules._\n * [**ScreenGear:**](#screengear) _Enables ultra-fast Screen Casting._ \n * [**VideoGear:**](#videogear) _A common API with Video Stabilizer wrapper._ \n\n**B. VideoWriter Gear:**\n\n * [**WriteGear:**](#writegear) _Handles easy Lossless Video Encoding and Compression._\n\n**C. Network Gear:**\n\n * [**NetGear:**](#netgear) _Targets synchronous video frames transferring between interconnecting systems over the network._\n\n \n\n### CamGear\n\nCamGear supports a diverse range of video streams which can handle/control video stream almost any IP/USB Cameras, multimedia video file format ([_upto 4k tested_][test-4k]), network stream URL such as `http(s), rtp, rstp, mms, etc.` In addition to this, it also supports live Gstreamer's RAW pipelines and YouTube video/livestreams URLs. CamGear provides a flexible, high-level multi-threaded wrapper around `OpenCV's` [VideoCapture class][opencv-vc] with access almost all of its available parameters and also employs `pafy's` APIs for live [YouTube streaming][youtube-wiki]. Furthermore, CamGear relies exclusively on [**Threaded Queue mode**][TQM-wiki] for ultra-fast, error-free and synchronized frame handling.\n\n\n**Following simplified functional block diagram depicts CamGear API's generalized working:**\n\n
\n \n
\n\n**CamGear API Guide:**\n\n[>>> Usage Guide][camgear-wiki]\n\n \n\n### VideoGear\n\nVideoGear API provides a special internal wrapper around VidGear's exclusive [**Video Stabilizer**][stablizer-wiki] class. Furthermore, VideoGear API can provide internal access to both [CamGear](#camgear) and [PiGear](#pigear) APIs separated by a special flag. Thereby, _this API holds the exclusive power for any incoming VideoStream from any source, whether it is live or not, to stabilize it directly with minimum latency and memory requirements._\n\n**Below is a snapshot of a VideoGear Stabilizer in action:**\n\n
\n\nCode to generate above VideoGear API Stabilized Video(_See more detailed usage examples [here][stablizer-wiki-ex]_): \n\n```python\n# import libraries\nfrom vidgear.gears import VideoGear\nimport numpy as np\nimport cv2\n\nstream_stab = VideoGear(source='test.mp4', stabilize = True).start() # To open any valid video stream with `stabilize` flag set to True.\nstream_org = VideoGear(source='test.mp4').start() # open same stream without stabilization for comparison\n\n# infinite loop\nwhile True:\n\n frame_stab = stream_stab.read()\n # read stabilized frames\n\n # check if frame is None\n if frame_stab is None:\n #if True break the infinite loop\n break\n\n #read original frame\n frame_org = stream_org.read()\n\n #concatenate both frames\n output_frame = np.concatenate((frame_org, frame_stab), axis=1)\n\n #put text\n cv2.putText(output_frame, \"Before\", (10, output_frame.shape[0] - 10),cv2.FONT_HERSHEY_SIMPLEX, 0.6, (0,255,0), 2)\n cv2.putText(output_frame, \"After\", (output_frame.shape[1]//2+10, frame.shape[0] - 10),cv2.FONT_HERSHEY_SIMPLEX, 0.6, (0,255,0), 2)\n\n cv2.imshow(\"Stabilized Frame\", output_frame)\n # Show output window\n\n key = cv2.waitKey(1) & 0xFF\n # check for 'q' key-press\n if key == ord(\"q\"):\n #if 'q' key-pressed break out\n break\n\ncv2.destroyAllWindows()\n# close output window\nstream_org.stop()\nstream_stab.stop()\n# safely close video streams.\n```\n\n\n**VideoGear API Guide:**\n\n[>>> Usage Guide][videogear-wiki]\n\n \n\n### PiGear\n\nPiGear is similar to CamGear but made to support various Raspberry Pi Camera Modules (such as [OmniVision OV5647 Camera Module][OV5647-picam] and [Sony IMX219 Camera Module][IMX219-picam]). To interface with these modules correctly, PiGear provides a flexible multi-threaded wrapper around complete [picamera][picamera] python library, and provides us the ability to exploit its various features like `brightness, saturation, sensor_mode, etc.` effortlessly. \n\n**Following simplified functional block diagram depicts PiGear API:**\n\n
\n \n
\n\n**PiGear API Guide:**\n\n[>>> Usage Guide][pigear-wiki]\n\n \n\n### ScreenGear\n\nWith ScreenGear, we can easily define an area on the computer screen or an open window to record the live screen frames in real-time at the expense of insignificant latency. To achieve this, ScreenGear provides a high-level multi-threaded wrapper around [**`mss`**][mss] python library API and also supports the flexible direct parameter manipulation. \n\n**Below is a snapshot of a ScreenGear API in action:**\n\n
\n \n
\n\nCode to generate the above result:\n\n```python\n# import libraries\nfrom vidgear.gears import ScreenGear\nimport cv2\n\nstream = ScreenGear().start()\n\n# infinite loop\nwhile True:\n\n frame = stream.read()\n # read frames\n\n # check if frame is None\n if frame is None:\n #if True break the infinite loop\n break\n\n cv2.imshow(\"Output Frame\", frame)\n # Show output window\n\n key = cv2.waitKey(1) & 0xFF\n # check for 'q' key-press\n if key == ord(\"q\"):\n #if 'q' key-pressed break out\n break\n\ncv2.destroyAllWindows()\n# close output window\n\nstream.stop()\n# safely close video stream.\n```\n\n**ScreenGear API Guide:**\n\n[>>> Usage Guide][screengear-wiki]\n\n\n \n\n\n### WriteGear\n\nWriteGear is undoubtedly the most powerful Video Processing Gear of them all. It solely handles various powerful FFmpeg tools that allow us to do almost anything you can imagine with multimedia files. With WriteGear API, you can process real-time video frames into a lossless format and specification suitable for our playback in just a few lines of codes. These specifications include setting bitrate, codec, framerate, resolution, subtitles, compression, etc. Furthermore, we can multiplex extracted audio at the output with compression and all that in real-time(see this example). In addition to this, WriteGear also provides flexible access to OpenCV's VideoWriter API which provides some basic tools for video frames encoding but without compression.\n\n**WriteGear primarily operates in the following two modes:**\n\n * **Compression Mode:** In this mode, WriteGear utilizes [**`FFmpeg's`**][ffmpeg] inbuilt encoders to encode lossless multimedia files. It provides us the ability to exploit almost any available parameters available within FFmpeg, with so much ease and flexibility and while doing that it robustly handles all errors/warnings quietly. **You can find more about this mode [here][cm-writegear-wiki]**.\n\n * **Non-Compression Mode:** In this mode, WriteGear utilizes basic OpenCV's inbuilt [**VideoWriter API**][opencv-vw]. Similar to compression mode, WriteGear also supports all parameters manipulation available within OpenCV's VideoWriter API. But this mode lacks the ability to manipulate encoding parameters and other important features like video compression, audio encoding, etc. **You can learn about this mode [here][ncm-writegear-wiki]**.\n\n**Following functional block diagram depicts WriteGear API's generalized working:**\n\n
\n \n
\n\n**WriteGear API Guide:**\n\n[>>> Usage Guide][writegear-wiki]\n\n \n\n### NetGear\n\nNetGear is exclusively designed to transfer video frames synchronously between interconnecting systems over the network in real-time. This is achieved by implementing a high-level wrapper around [PyZmQ][pyzmq] python library that contains python bindings for [ZeroMQ](http://zeromq.org/) - a high-performance asynchronous distributed messaging library that aim to be used in distributed or concurrent applications. It provides a message queue, but unlike message-oriented middleware, a ZeroMQ system can run without a dedicated message broker. Furthermore, NetGear currently supports two ZeroMQ messaging patterns: i.e `zmq.PAIR` and `zmq.REQ and zmq.REP`.\n\n**NetGear API has two modes of operations:**\n * **Send Mode:**(a.k.a Server configuration) which employs `send()` function to send frames to the client(s). You can use this function to send messages to client(s) too.\n * **Receive Mode:**(a.k.a Client configuration) which employs `recv()` function to receive frames sent by server. Client send back confirmation when frame is received successfully.\n\n\n**Following functional block diagram depicts NetGear API:**\n\n
![\"VidGear](\"https://abhitronix.github.io/img/vidgear/vidgear)
\n![\"@Vidgear](\"https://abhitronix.github.io/img/vidgear/vidgear_function2-01.svg\")
\n![\"CamGear](\"https://github.com/abhiTronix/Imbakup/raw/master/Images/CamGear.png\")
\n![\"VideoGear](\"https://github.com/abhiTronix/Imbakup/raw/master/Images/stabilizer.gif\")
\n ![\"PiGear](\"https://github.com/abhiTronix/Imbakup/raw/master/Images/PiGear.png\")
\n![\"ScreenGear](\"https://github.com/abhiTronix/Imbakup/raw/master/Images/screengear.gif\")
\n![\"WriteGear](\"https://github.com/abhiTronix/Imbakup/raw/master/Images/WriteGear.png\")
\n![\"NetGear](\"https://github.com/abhiTronix/Imbakup/raw/master/Images/NetGear.png\")
\n