opencv_webcam/README.en.md at 96491e7c2c3be988ebab36925af6a2c525afa3d6

14 KiB

Raw Blame History

Webcam program based on OpenCV, suitable for real-time video frame acquisition, computer vision data collection, etc.

It has the characteristics of convenient installation, simple operation and cross-platform.

🚀Update Trend

2022-01-24 ⚡ opencv-webcam-script v0.4 release officially launched
2022-01-24 ⚡ opencv-webcam-script v0.4 docker version officially launched
2022-01-24 ⚡ opencv-webcam-script v0.4.0 PyPi versionofficially launched
2022-01-24 ⚡ opencv-webcam-script v0.4 Jupyter versionofficially launched
⚡ opencv-webcam-script v0.3
⚡ opencv-webcam-script v0.2
⚡ opencv-webcam-script v0.1

💡Project Structure

.
├── opencv_webcam							# project name
│   ├── utils								# Toolkit
│   │   ├── args_yaml.py					# Instruction management
│   │   ├── compress.py						# Compression management
│   │   ├── frame_opt.py					# Frame save management
│   │   ├── hotkey.py						# Hotkey management
│   │   ├── fonts_opt.py					# Font management
│   │   ├── plot.py							# Drawing management
│   │   ├── __init__.py						# Toolkit initialization
│   │   ├── log.py							# log management
│   │   ├── ows_path.py						# Save path management
│   │   └── time_format.py					# time format
│   ├── tutorial							# ows tutorial
│   │   ├── ows_pypi.md						# ows pypi version tutorial
│   │   ├── ows_docker.md					# ows docker version tutorial
│   │   └── ows_jupyter.md					# ows Jupyter version tutorial
│   ├── v_change							# Version history
│   │   ├── v01_change.md					# v0.1 version change
│   │   ├── v02_change.md					# v0.2 version change
│   │   ├── v03_change.md					# v0.3 version change
│   │   └── README.md						# Version history description
│   ├── __init__.py							# Project initialization
│   ├── opencv_webcam.py					# Script main run file
│   ├── LICENSE								# Project License
│   ├── CodeCheck.md						# Code Check
│   ├── setup.sh							# Environment installation script
│   ├── fonts.sh							# Font download script
│   ├── Dockerfile							# docker build file
│   ├── README.md							# Project description
│   ├── README.en.md						# Project description (English version)
│   └── requirements.txt					# Script dependencies

🔥Installation Tutorial

✅ Method 1: Linux Shell Installation (Development Edition)

Step 1: Clone the project

git clone https://gitee.com/CV_Lab/opencv_webcam.git # clone project

Step 2: Create a virtual environment

# Create a conda virtual environment, taking python 3.8 as an example
conda create -n ows python==3.8 # The virtual environment name is ows
conda activate ows # Activate the virtual environment

Step 3: Install the script

pip install -r ./requirements.txt -U # Install OpenCV Webcam Script

Steps 2 and 3 can also be performed via setup.sh

bash ./setup.sh

✅ Method 2: pip quick installation (PyPi version)

🔥 opencv-webcam-script PyPi version detailed tutorial

🔑 Easy Tutorial

Step 1: Create an ows virtual environment, see Method 1
Step 2: Execute the pip command

pip install opencv-webcam-script==0.4.0

Step 3: Write a python program

from opencv_webcam.opencv_webcam import webcam_opencv
# Example of a few functions
webcam_opencv() # regular call
webcam_opencv(is_autoSaveFrame=True) # Auto save frames
webcam_opencv(is_autoSaveFrame=True, is_compress=True) # compressed frame

✅ Method 3: docker image installation (docker version)

🔥 opencv-webcam-script docker version detailed tutorial

🔑 Easy Tutorial

Step 1: Download the mirror

sudo docker pull zengdockerdocker/opencv-webcam-script:v0.4 # Mirror pull

Step 2: Create the container

xhost +local:root # Allow root user access to running X server (important)
sudo docker run --name=ows --ipc=host -it -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=unix$DISPLAY --device=/dev/video0:/dev/video0 zengdockerdocker/opencv-webcam-script:v0.4 # Create a container named ows

Step 3: Run the program

python3 opencv_webcam.py # run script
python3 opencv_webcam.py -isasf # Auto save frames

# Get docker frame data to this machine
sudo docker cp Container name: container directory local host directory
sudo docker cp ows:/usr/src/app/WebcamFrame /home/username # Example

✅ Method 4: Jupyter installation (Jupyter version)

🔥 opencv-webcam-script Jupyter version detailed tutorial

🔑 Easy Tutorial

Step 1: Installation

# First create a virtual environment manually
# conda create -n ows python==3.8 # The virtual environment name is ows
# conda activate ows # Activate the virtual environment
!git clone https://gitee.com/CV_Lab/opencv_webcam.git # clone
%cd opencv_webcam
%pip install -qr requirements.txt -U # install

Step 2: Run

!python opencv_webcam.py # Press the q key to exit by default
!python opencv_webcam.py -isasf # Automatically save video frames

Note: Jupyter version of ows program can run unit instructions through Ctrl+Enter

⚡Usage

💡 regular call

# Press the q key to exit by default
python opencv_webcam.py

💡 Device Selection

# Multi-camera switching example, the default is 0
python opencv_webcam.py -dev 0
python opencv_webcam.py -dev 1
python opencv_webcam.py -dev 2

# RTSP
python opencv_webcam.py -dev rtsp://username:password@xxx.xxx.xxx

💡 set escape key

# By default press the q key to exit
python opencv_webcam.py -q z # set z key to exit
python opencv_webcam.py -q k # set k key to exit

💡 Auto save frames

python opencv_webcam.py -isasf

💡 Save frames every n frames

# save a frame every 10 frames
python opencv_webcam.py -isasf -fns 10

💡 Save frames manually

# By default press a key to capture a frame
python opencv_webcam.py -ishsf

💡 custom capture key

# Set the z key as the capture key, the default is the a key
python opencv_webcam.py -ishsf -fck z

💡 Reshape frame size (custom width and height)

# reshape width 300 height 200
python opencv_webcam.py -isasf -isrf -rf 300 200 # Automatic version
python opencv_webcam.py -ishsf -isrf -rf 300 200 # Manual version

💡 Reshape frame size (custom aspect scaling)

# The aspect ratio is 0.5
python opencv_webcam.py -isasf -isrf -rrf 0.5 # Automatic version
python opencv_webcam.py -ishsf -isrf -rrf 0.5 # Manual version

💡 Custom save path

# Set the save path, the default save path is ./WebcamFrame
python opencv_webcam.py -fsd custom_dir -isasf # Take the automatic version as an example

💡 custom frame directory name

# Set the frame directory name, the default save path is frames
python opencv_webcam.py -fdn frames_custom -isasf # Take the automatic version as an example

💡 Custom frame name prefix

# Set the prefix name of the frame image
python opencv_webcam.py -isasf -fnp webcam

💡 Set the frame save format

# Set JPG quality to 100, default to 95
python opencv_webcam.py -isasf -fss jpg -jq 100

# Set PNG quality to 5, default is 3
python opencv_webcam.py -isasf -fss png -jq 5

💡 set pause button

# Set the w key as the pause key, the default is the p key
python opencv_webcam.py -p w # Press any key to continue

💡 Set the number of frames to save

# Set to save 100 frames
python opencv_webcam.py -isasf -afn 100

💡 log settings

# The log file is saved in the project root directory by default, ows.log
python opencv_webcam.py

# Set the log file name and type, including .log, .txt, .data
python opencv_webcam.py -ln ows02.txt

# Set the log saving method, the default is append mode
python opencv_webcam.py -lm w # set to overlay mode

💡 video frame compression

# Regular compression, default ows.zip (take the automatic version as an example)
python opencv_webcam.py -isasf -isc

# Customize the compressed file name
python opencv_webcam.py -isasf -isc -cn ows02

# Automatically name archives
python opencv_webcam.py -isasf -isc -isacn

# Custom compression mode, default is write overwrite
python opencv_webcam.py -isasf -isc -cm a # Append mode (a mode is only for zip) Note: This command is only available in v0.4
python opencv_webcam.py -isasf -isc -cs tar -cm w:gz # tar compression

💡 Instruction query

# query script parameters
python opencv_webcam.py --help

Command query result

usage: opencv_webcam.py [-h] [--device DEVICE] [--quit QUIT] [--is_autoSaveFrame] [--is_handSaveFrame] [--is_resizeFrame] [--frame_saveDir FRAME_SAVEDIR] [--frame_dirName FRAME_DIRNAME]
                        [--frame_nSave FRAME_NSAVE] [--frame_capKey FRAME_CAPKEY] [--resize_frame RESIZE_FRAME [RESIZE_FRAME ...]] [--resizeRatio_frame RESIZERATIO_FRAME]
                        [--frame_namePrefix FRAME_NAMEPREFIX] [--frame_saveStyle FRAME_SAVESTYLE] [--jpg_quality JPG_QUALITY] [--png_quality PNG_QUALITY] [--pause PAUSE]
                        [--auto_frameNum AUTO_FRAMENUM] [--logName LOGNAME] [--logMode LOGMODE] [--is_compress] [--compressStyle COMPRESSSTYLE] [--is_autoCompressName]
                        [--compressName COMPRESSNAME] [--compressMode COMPRESSMODE]

OpenCV Webcam Script v0.4

optional arguments:
  -h, --help            show this help message and exit
  --device DEVICE, -dev DEVICE
                        device index for webcam, 0 or rtsp
  --quit QUIT, -q QUIT  quit key for webcam
  --is_autoSaveFrame, -isasf
                        is auto save frame
  --is_handSaveFrame, -ishsf
                        is hand save frame
  --is_resizeFrame, -isrf
                        is resize frame
  --frame_saveDir FRAME_SAVEDIR, -fsd FRAME_SAVEDIR
                        save frame dir
  --frame_dirName FRAME_DIRNAME, -fdn FRAME_DIRNAME
                        save frame dir name
  --frame_nSave FRAME_NSAVE, -fns FRAME_NSAVE
                        n frames save a frame (auto save frame)
  --frame_capKey FRAME_CAPKEY, -fck FRAME_CAPKEY
                        frame capture key (hand save frame)
  --resize_frame RESIZE_FRAME [RESIZE_FRAME ...], -rf RESIZE_FRAME [RESIZE_FRAME ...]
                        resize frame save
  --resizeRatio_frame RESIZERATIO_FRAME, -rrf RESIZERATIO_FRAME
                        resize ratio frame save
  --frame_namePrefix FRAME_NAMEPREFIX, -fnp FRAME_NAMEPREFIX
                        frame name prefix
  --frame_saveStyle FRAME_SAVESTYLE, -fss FRAME_SAVESTYLE
                        frame save style
  --jpg_quality JPG_QUALITY, -jq JPG_QUALITY
                        frame save jpg quality (0-100) default 95
  --png_quality PNG_QUALITY, -pq PNG_QUALITY
                        frame save jpg quality (0-9) default 3
  --pause PAUSE, -p PAUSE
                        webcam pause
  --auto_frameNum AUTO_FRAMENUM, -afn AUTO_FRAMENUM
                        auto save number of frames
  --logName LOGNAME, -ln LOGNAME
                        log save name
  --logMode LOGMODE, -lm LOGMODE
                        log write mode
  --is_compress, -isc   is compress file
  --compressStyle COMPRESSSTYLE, -cs COMPRESSSTYLE
                        compress style
  --is_autoCompressName, -isacn
                        is auto compress name
  --compressName COMPRESSNAME, -cn COMPRESSNAME
                        compress save name
  --compressMode COMPRESSMODE, -cm COMPRESSMODE
                        compress save mode, tar w:gz

14 KiB Raw Blame History

🚀Update Trend

💡Project Structure

🔥Installation Tutorial

✅ Method 1: Linux Shell Installation (Development Edition)

✅ Method 2: pip quick installation (PyPi version)

🔥 opencv-webcam-script PyPi version detailed tutorial

🔑 Easy Tutorial

✅ Method 3: docker image installation (docker version)

🔥 opencv-webcam-script docker version detailed tutorial

🔑 Easy Tutorial

✅ Method 4: Jupyter installation (Jupyter version)

🔥 opencv-webcam-script Jupyter version detailed tutorial

🔑 Easy Tutorial

⚡Usage

💡 regular call

💡 Device Selection

💡 set escape key

💡 Auto save frames

💡 Save frames every n frames

💡 Save frames manually

💡 custom capture key

💡 Reshape frame size (custom width and height)

💡 Reshape frame size (custom aspect scaling)

💡 Custom save path

💡 custom frame directory name

💡 Custom frame name prefix

💡 Set the frame save format

💡 set pause button

💡 Set the number of frames to save

💡 log settings

💡 video frame compression

💡 Instruction query

14 KiB

Raw Blame History