Skip to content

WebGear Examples⚓

 

Using WebGear with RaspberryPi Camera Module⚓

Because of WebGear API's flexible internal wapper around VideoGear, it can easily access any parameter of CamGear and PiGear videocapture APIs.

Following usage examples are just an idea of what can be done with WebGear API, you can try various VideoGear, CamGear and PiGear parameters directly in WebGear API in the similar manner.

Here's a bare-minimum example of using WebGear API with the Raspberry Pi camera module while tweaking its various properties in just one-liner:

# import libs
import uvicorn
from vidgear.gears.asyncio import WebGear

# various webgear performance and Raspberry Pi camera tweaks
options = {
    "frame_size_reduction": 40,
    "jpeg_compression_quality": 80,
    "jpeg_compression_fastdct": True,
    "jpeg_compression_fastupsample": False,
    "hflip": True,
    "exposure_mode": "auto",
    "iso": 800,
    "exposure_compensation": 15,
    "awb_mode": "horizon",
    "sensor_mode": 0,
}

# initialize WebGear app
web = WebGear(
    enablePiCamera=True, resolution=(640, 480), framerate=60, logging=True, **options
)

# run this app on Uvicorn server at address http://localhost:8000/
uvicorn.run(web(), host="localhost", port=8000)

# close app safely
web.shutdown()

 

Using WebGear with real-time Video Stabilization enabled⚓

Here's an example of using WebGear API with real-time Video Stabilization enabled:

# import libs
import uvicorn
from vidgear.gears.asyncio import WebGear

# various webgear performance tweaks
options = {
    "frame_size_reduction": 40,
    "jpeg_compression_quality": 80,
    "jpeg_compression_fastdct": True,
    "jpeg_compression_fastupsample": False,
}

# initialize WebGear app  with a raw source and enable video stabilization(`stabilize=True`)
web = WebGear(source="foo.mp4", stabilize=True, logging=True, **options)

# run this app on Uvicorn server at address http://localhost:8000/
uvicorn.run(web(), host="localhost", port=8000)

# close app safely
web.shutdown()

 

Display Two Sources Simultaneously in WebGear⚓

In this example, we'll be displaying two video feeds side-by-side simultaneously on browser using WebGear API by defining two separate frame generators:

New in v0.2.2

This example was added in v0.2.2.

Step-1 (Trigger Auto-Generation Process): Firstly, run this bare-minimum code to trigger the Auto-generation process, this will create .vidgear directory at current location (directory where you'll run this code):

# import required libraries
import uvicorn
from vidgear.gears.asyncio import WebGear

# provide current directory to save data files
options = {"custom_data_location": "./"}

# initialize WebGear app
web = WebGear(source=0, logging=True, **options)

# close app safely
web.shutdown()

Step-2 (Replace HTML file): Now, go inside .vidgear ➡ webgear ➡ templates directory at current location of your machine, and there replace content of index.html file with following:

{% extends "base.html" %}
{% block content %}
  <h1 class="glow">WebGear Video Feed</h1>
   <div class="rows">
     <img src="/video" alt="Feed"/>
     <img src="/video2" alt="Feed"/>
   </div>
{% endblock %}

Step-3 (Build your own Frame Producers): Now, create a python script code with OpenCV source, as follows:

# import necessary libs
import uvicorn, asyncio, cv2
from vidgear.gears.asyncio import WebGear
from vidgear.gears.asyncio.helper import reducer
from starlette.responses import StreamingResponse
from starlette.routing import Route

# provide current directory to load data files
options = {"custom_data_location": "./"}

# initialize WebGear app without any source
web = WebGear(logging=True, **options)

# create your own custom frame producer
async def my_frame_producer1():

   # !!! define your first video source here !!!
   # Open any video stream such as "foo1.mp4"
   stream = cv2.VideoCapture("foo1.mp4")
   # loop over frames
   while True:
       # read frame from provided source
       (grabbed, frame) = stream.read()
       # break if NoneType
       if not grabbed:
           break

       # do something with your OpenCV frame here

       # reducer frames size if you want more performance otherwise comment this line
       frame = await reducer(frame, percentage=30)  # reduce frame by 30%
       # handle JPEG encoding
       encodedImage = cv2.imencode(".jpg", frame)[1].tobytes()
       # yield frame in byte format
       yield (b"--frame\r\nContent-Type:video/jpeg2000\r\n\r\n" + encodedImage + b"\r\n")
       await asyncio.sleep(0.00001)
   # close stream
   stream.release()


# create your own custom frame producer
async def my_frame_producer2():

   # !!! define your second video source here !!!
   # Open any video stream such as "foo2.mp4"
   stream = cv2.VideoCapture("foo2.mp4")
   # loop over frames
   while True:
       # read frame from provided source
       (grabbed, frame) = stream.read()
       # break if NoneType
       if not grabbed:
           break

       # do something with your OpenCV frame here

       # reducer frames size if you want more performance otherwise comment this line
       frame = await reducer(frame, percentage=30)  # reduce frame by 30%
       # handle JPEG encoding
       encodedImage = cv2.imencode(".jpg", frame)[1].tobytes()
       # yield frame in byte format
       yield (b"--frame\r\nContent-Type:video/jpeg2000\r\n\r\n" + encodedImage + b"\r\n")
       await asyncio.sleep(0.00001)
   # close stream
   stream.release()


async def custom_video_response(scope):
   """
   Return a async video streaming response for `my_frame_producer2` generator
   """
   assert scope["type"] in ["http", "https"]
   await asyncio.sleep(0.00001)
   return StreamingResponse(
       my_frame_producer2(),
       media_type="multipart/x-mixed-replace; boundary=frame",
   )


# add your custom frame producer to config
web.config["generator"] = my_frame_producer1

# append new route i.e. new custom route with custom response
web.routes.append(
    Route("/video2", endpoint=custom_video_response)
    )

# run this app on Uvicorn server at address http://localhost:8000/
uvicorn.run(web(), host="localhost", port=8000)

# close app safely
web.shutdown()

On successfully running this code, the output stream will be displayed at address http://localhost:8000/ in Browser.

 


Last update: October 7, 2021