Changes

Jump to navigation Jump to search

V4L2 mode for Raspberry Pi (view source)

Revision as of 09:29, 20 March 2024

15,491 bytes added ,  20 March
→‎Raspberry Pi 5 Setting
Line 4: Line 4:     
=== Introduction ===
 
=== Introduction ===
 +
For the use of VEYE series and CS series camera modules on the raspberry Pi platform, we provide veye_raspicam software, an application layer open source software similar to the raspicam. This series of software, without driver support, has good compatibility with different versions of piOS.
 +
 +
However, we think that the V4L2 driver mode also has a wide range of applications. The two modes cannot be used at the same time, which is embodied in whether the driver is installed or not. It will be described in detail later.
 +
 +
This article describes how to call the camera modules of VEYE series and CS series through V4L2 on the raspberry Pi platform.
 +
==== Camera module list====
 +
{| class="wikitable"
 +
|+Camera module dirver status list
 +
!Series
 +
! Model
 +
! Status
 +
|-
 +
|VEYE series
 +
|VEYE-MIPI-IMX327S
 +
|Done
 +
|-
 +
|VEYE series
 +
|VEYE-MIPI-IMX385
 +
|Done
 +
|-
 +
|VEYE series
 +
|VEYE-MIPI-IMX462
 +
|Done
 +
|-
 +
|CS series
 +
|CS-MIPI-IMX307
 +
|Done
 +
|-
 +
|CS series
 +
|CS-MIPI-SC132
 +
|Done
 +
|}
 +
In addition, FPD-Link3 mode connection is now supported.
    
=== Hardware Setup ===
 
=== Hardware Setup ===
 +
[[VEYE-MIPI-290/327 for Raspberry Pi#Hardware Setup|VEYE series camera module setup on rpi]]
 +
 +
[[CS-MIPI-X for Raspberry Pi#Hardware Setup|CS series camera module setup on rpi]]
    
=== RaspberryPi System Setup and Configuration ===
 
=== RaspberryPi System Setup and Configuration ===
 +
[[CS-MIPI-X for Raspberry Pi#RaspberryPi System Setup and Configuration|RaspberryPi System Setup and Configuration]]
    
=== Driver Installation ===
 
=== Driver Installation ===
 +
We have saved the code for v4l2 driver mode in this [https://github.com/veyeimaging/raspberrypi_v4l2 github repository].
 +
 +
==== Download the driver ====
 +
<code>wget <nowiki>https://github.com/veyeimaging/raspberrypi_v4l2/releases/latest/download/raspberrypi_v4l2.tgz</nowiki></code>
 +
 +
==== Install the driver ====
 +
<code>tar -xzvf raspberrypi_v4l2.tgz</code>
 +
 +
<code>cd raspberrypi_v4l2/release/</code>
 +
 +
<code>chmod +x *</code>
 +
 +
* For Raspberry Pi 5
 +
 +
<code>sudo ./install_driver_rpi5.sh camera_module_name</code>
 +
 +
It will install both CAM1 and CAM0 overlays in /boot/config.txt.
 +
 +
* For other Raspberry Pi
 +
 +
<code>sudo ./install_driver.sh camera_module_name</code>
 +
 +
camera_module_name：could be veye327,csimx307,cssc132,veyecam2m.
 +
 +
'''Note: veyecam2m is a new version driver that can replace veye327 and supports all modules of the VEYE series with 200W resolution.'''
 +
 +
'''please use veyecam2m instead of veye327 which will be discarded.'''
 +
 +
Note: For VEYE-MIPI-IMX327S or VEYE-MIPI-IMX462, please make sure '''hdver''' must >= 0x5.
 +
 +
http://wiki.veye.cc/index.php/VEYE-MIPI-IMX327S_version_log
 +
 +
==== Uninstall the driver ====
 +
If you need to change to using the camera by veye_raspicam software, or if you want to change to a driver of another camera module model, you must first uninstall the current driver.
 +
 +
<code>sudo ./uninstall_driver.sh camera_module_name</code>
 +
 +
camera_module_name：could be veye327,csimx307,cssc132,veyecam2m.
 +
 +
==== Camera in FPD-Link3 Mode ====
 +
For a camera operating in FPD-Link3 transmission mode, it is necessary to ensure that the ds90ub954 driver is loaded and initialized before loading the camera driver and performing probe.
 +
 +
Take the VEYE-MIPI-IMX327S camera in FPD-Link3 mode as an example:
 +
 +
Install the drivers correctly:
 +
 +
<code>sudo ./install_driver.sh ds90ub954</code>
 +
 +
<code>sudo ./install_driver.sh veyecam2m</code>
    
=== Check and Test the Camera ===
 
=== Check and Test the Camera ===
 +
Check the camera probe status
 +
 +
* VEYE-MIPI-327
 +
 +
<code>dmesg | grep veye</code>
 +
 +
You can see:
 +
 +
<code>veye327 camera probed</code>
 +
 +
* CS-MIPI-IMX307
 +
 +
<code>dmesg | grep 307</code>
 +
 +
You can see:
 +
 +
<code>camera id is cs-mipi-imx307</code>
 +
 +
* CS-MIPI-SC132
 +
 +
<code>dmesg | grep 132</code>
 +
 +
You can see:
 +
 +
<code>camera id is cs-mipi-sc132</code>
 +
 +
==== List the video device ====
 +
<code>ls /dev/video0</code>
 +
 +
The device node exsit.
 +
 +
==== List the available video modes ====
 +
<code>v4l2-ctl --list-formats-ext</code>
 +
===Raspberry Pi 5 Setting===
 +
On Raspberry Pi 5,the drivers now use the media controller API, and we must setup the media graph correctly first. This includes setting up the media pad formats correctly and correctly linking them together.
 +
 +
We provide a series of scripts to implement this functionality, saved in the rpi5_scripts directory.
 +
 +
*./find_entity.sh
 +
 +
<code>$ ./find_entity.sh</code>
 +
 +
<code>Found veyecam2m @ i2c-6 entity on /dev/media0</code>
 +
 +
<code>Plese get frame from /dev/video0 and use /dev/v4l-subdev2 for camera setting.</code>
   −
=== Gstreamer usage Demo ===
+
After a reboot of Raspberry Pi 5, the media node and video node of the camera may change. Therefore, it is recommended to execute <code>./find_entity.sh</code> before performing subsequent operations to identify the device nodes.
 +
 
 +
The above prompt shows that the system has detected two cameras and their corresponding device nodes.
 +
 
 +
<code>i2c-4</code> corresponds to the CAM1 port on the board, and <code>i2c-6</code> corresponds to the CAM0 port on the board.
 +
 
 +
*media_setting_rpi5.sh
 +
 
 +
<code>./media_setting_rpi5.sh</code>
 +
 
 +
<code>Usage: ./media_setting_rpi5.sh veyecam2m/csimx307/cssc132/mvcam -fmt [UYVY/RAW8/RAW10/RAW12] -w [width] -h [height]</code>
 +
 
 +
<code>This shell script is designed to detect the connection of a camera on Raspberry Pi 5.</code>
 +
 
 +
<code>    It utilizes media-ctl and v4l2-ctl commands to configure the linking relationships and data formats of the media pad.</code>
 +
 
 +
<code>    Once completed, you can directly use /dev/video0 or /dev/video8 to obtain image data</code>
 +
 
 +
'''Note: This script must be executed after each startup to complete the configuration of the parameters before proceeding with further operations.'''
 +
 
 +
For instance:
 +
 
 +
<code>./media_setting_rpi5.sh veyecam2m</code>
 +
===Preview===
 +
On a raspberry pi 5, VLC for preview is now having problems and not working.
 +
==== Preview using VLC ====
 +
1. Open VLC with command line <code>vlc</code> , or click the icon to launch.
 +
 
 +
2. Hit the <code>▶</code>(Play) button to call the open media window.
 +
 
 +
3. In <code>Capture Device</code> >> <code>Device Selection</code> >> <code>Video device name</code>, select the camera video node.
 +
 
 +
4. Hit <code>Advanced Options...</code> button
 +
 
 +
5. In Advanced Options window >> <code>Video input chroma format</code>, type <code>UYUV</code>.
 +
 
 +
6. Type in the <code>width</code> and <code>height</code>, for example, 1920 and 1080.
 +
 
 +
7. Hit <code>OK</code> to save the settings and see the video feed.
 +
[[File:Play camera using VLC on RPI.png|alt=Play camera using VLC on RPI|center|thumb|1000x1000px|Play camera using VLC on RPI]]
 
<br />
 
<br />
 +
======Preview using qv4l2======
 +
Install qv4l2，
 +
 +
<code>sudo apt install qv4l2</code>
 +
 +
1. Open VLC with command line <code>vlc</code> to launch.
 +
 +
2. Hit the <code>▶</code>(Play) button to call the open media window.
 +
=== Gstreamer usage samples ===
 +
<code>export DISPLAY=:0</code>
 +
 +
==== install gstreamer ====
 +
<code>sudo apt-get install gstreamer1.0-tools</code>
 +
 +
<code>sudo apt-get install libx264-dev libjpeg-dev</code>
 +
 +
<code>sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgstreamer-plugins-bad1.0-dev gstreamer1.0-plugins-ugly gstreamer1.0-tools gstreamer1.0-gl gstreamer1.0-gtk3</code>
 +
 +
==== Run gstreamer videotest command ====
 +
<code>gst-launch-1.0 videotestsrc ! videoconvert ! autovideosink</code>
 +
 +
==== Snap a picture (VEYE-MIPI-327,CS-MIPI-IMX307 @1080p mode) ====
 +
<code>gst-launch-1.0 v4l2src num-buffers=1 device=/dev/video0 ! 'video/x-raw, format=(string)UYVY, width=1920,height=1080' ! jpegenc ! filesink location=test_image.jpg</code>
 +
 +
==== Frame rate test (VEYE-MIPI-327,CS-MIPI-IMX307 @1080p mode) ====
 +
<code>gst-launch-1.0 v4l2src device=/dev/video0 ! "video/x-raw,format=(string)UYVY, width=(int)1920, height=(int)1080,framerate=(fraction)30/1" ! videoconvert ! fpsdisplaysink video-sink=fakesink -v</code>
 +
 +
==== Preview (VEYE-MIPI-327,CS-MIPI-IMX307 @1080p mode) ====
 +
<code>gst-launch-1.0 v4l2src io-mode=dmabuf device=/dev/video0 ! "video/x-raw,format=(string)UYVY, width=(int)1920, height=(int)1080,framerate=(fraction)30/1" ! v4l2convert capture-io-mode=dmabuf output-io-mode=dmabuf ! autovideosink sync=false -v</code>
 +
 +
Or：
 +
 +
<code>gst-launch-1.0 v4l2src device=/dev/video0 ! "video/x-raw,format=(string)UYVY, width=(int)1920, height=(int)1080,framerate=(fraction)30/1" ! videoconvert ! autovideosink  sync=false -v</code>
 +
 +
==== Preview and Scale with timestamp on (VEYE-MIPI-327,CS-MIPI-IMX307 @1080p mode) ====
 +
<code>gst-launch-1.0 v4l2src device=/dev/video0 ! "video/x-raw,format=(string)UYVY, width=(int)1920, height=(int)1080,framerate=(fraction)30/1"  ! videoconvert ! videoscale ! clockoverlay time-format="%D %H:%M:%S" ! video/x-raw, width=640, height=360 ! autovideosink sync=false -v</code>
 +
 +
==== Preview (CS-MIPI-IMX307,CS-MIPI-SC132 @720p mode) ====
 +
<code>gst-launch-1.0 v4l2src device=/dev/video0 ! "video/x-raw,format=(string)UYVY, width=(int)1280, height=(int)720,framerate=(fraction)60/1" ! videoconvert ! autovideosink sync=false -v</code>
 +
 +
==== Preview (CS-MIPI-IMX307,CS-MIPI-SC132 @vga mode) ====
 +
<code>gst-launch-1.0 v4l2src device=/dev/video0 ! "video/x-raw,format=(string)UYVY, width=(int)640, height=(int)480" ! videoconvert ! autovideosink sync=false -v</code>
 +
 +
==== Preview (CS-MIPI-SC132 @1280*1080@45 mode) ====
 +
<code>gst-launch-1.0 v4l2src device=/dev/video0 ! "video/x-raw,format=(string)UYVY, width=(int)1280, height=(int)1080,framerate=(fraction)45/1" ! videoconvert ! autovideosink sync=false -v</code>
 +
 +
==== Streaming to file，save as mkv file(VEYE-MIPI-X,CS-MIPI-IMX307 @1080p mode) ====
 +
<code>gst-launch-1.0 -e v4l2src io-mode=dmabuf device=/dev/video0 num-buffers=300 ! "video/x-raw,format=(string)UYVY, width=(int)1920, height=(int)1080,framerate=(fraction)30/1" ! v4l2h264enc capture-io-mode=dmabuf output-io-mode=dmabuf extra-controls="controls, h264_profile=4, video_bitrate=6200000" ! 'video/x-h264, profile=high, level=(string)4' ! h264parse ! matroskamux ! filesink location=output.mkv</code>
 +
 +
==== Streaming to file，save as mp4 file(VEYE-MIPI-X,CS-MIPI-IMX307 @1080p mode) ====
 +
<code>gst-launch-1.0 -e v4l2src io-mode=dmabuf device=/dev/video0 num-buffers=300 ! "video/x-raw,format=(string)UYVY, width=(int)1920, height=(int)1080,framerate=(fraction)30/1" ! v4l2h264enc capture-io-mode=dmabuf output-io-mode=dmabuf extra-controls="controls, h264_profile=4, video_bitrate=6200000" ! 'video/x-h264, profile=high, level=(string)4' ! h264parse ! mp4mux ! filesink location=video.mp4</code>
 +
==== TCP streaming====
 +
'''''raspberrypi（sender）'''''
 +
 +
<code>gst-launch-1.0 -v v4l2src device=/dev/video0 num-buffers=-1 ! "video/x-raw,format=(string)UYVY, width=(int)1920, height=(int)1080,framerate=(fraction)30/1" ! v4l2h264enc extra-controls="controls, h264_profile=4, video_bitrate=4000000" ! 'video/x-h264, profile=high, level=(string)4' ! h264parse ! rtph264pay config-interval=1 pt=96 ! gdppay ! tcpserversink  host=x.x.x.x port=5000</code>
 +
 +
The bandwidth of the stream is 4Mbps, continuous transmission, and the listening port is 5000.
 +
 +
'''''Client'''''
 +
 +
<code>gst-launch-1.0 -v tcpclientsrc host=x.x.x.x port=5000 ! gdpdepay ! rtph264depay ! avdec_h264 ! autovideosink sync=false</code>
 +
 +
Where x.x.x.x is the IP address of the Raspberry Pi (Server).
 +
 +
It is recommended to use powershell if client is a windows system. '''''gstreamer''''' windows version download [https://gstreamer.freedesktop.org/documentation/installing/on-windows.html?gi-language=c here].
 +
 +
=== Stream to OpenCV ===
 +
<code>pip uninstall opencv-python</code>
 +
 +
<code>sudo apt install python3-opencv</code>
 +
 +
To import camera data from v4l2 devices to opencv, we provide several [https://github.com/veyeimaging/raspberrypi_v4l2/tree/main/samples/opencv samples].
 +
===V4l2-ctl usage examples===
 +
====install v4l2-utils====
 +
<code>sudo apt-get install v4l-utils</code>
 +
====v4l2-ctl test====
 +
 +
*Snap one UYVY raw data picture (1080p mode)
 +
 +
<code>v4l2-ctl --set-fmt-video=width=1920,height=1080,pixelformat=UYVY --stream-mmap --stream-count=1 --stream-to=uyvy-1920x1080.yuv</code>
 +
 +
* Snap 10 UYVY raw data pictures (1080p mode)
 +
 +
<code>v4l2-ctl --set-fmt-video=width=1920,height=1080,pixelformat=UYVY --stream-mmap --stream-count=10 --stream-to=uyvy-1920x1080_stream.yuv</code>
 +
 +
=== yavta usage examples ===
 +
 +
==== download yavta ====
 +
<code>git clone <nowiki>git://git.ideasonboard.org/yavta.git</nowiki></code>
 +
 +
<code>cd yavta;make</code>
 +
 +
==== yavta test ====
 +
<code>./yavta -c8 -Fuyvy_1920X1080.yuv --skip 0 -f UYVY -s 1920x1080 /dev/video0</code>
 +
 +
PS, UYVY file can be played by [https://yuv-player-deluxe.software.informer.com/2.6/ YUV Displayer Deluxe].
 +
 +
=== Video Control Toolkits Manual ===
 +
Because of the high flexibility of our camera parameters, we do not use V4L2 parameters to control, but use scripts to configure parameters.
 +
 +
https://github.com/veyeimaging/raspberrypi_v4l2/tree/main/i2c_cmd
 +
 +
[[VEYE-MIPI-290/327 for Raspberry Pi#Video Control Toolkits Manual|VEYE Series Video Control Toolkits Manual]]
 +
 +
[[CS-MIPI-X for Raspberry Pi#Video Control Toolkits Manual|CS Series Video Control Toolkits Manual]]
 +
 +
=== Notes for CM4 ===
 +
Cm4 supports the use of two cameras at the same time. Following above steps will only be able to use CAM1. To use two cameras, follow the following steps:
 +
 +
===== Hardware Connection =====
 +
Refer to [https://www.raspberrypi.com/documentation/computers/compute-module.html this Raspberry Pi instruction] ， add jumper to J6.
 +
 +
==== Upgrade dt-blob.bin ====
 +
<code>sudo wget <nowiki>https://datasheets.raspberrypi.com/cmio/dt-blob-dualcam.bin</nowiki> -O /boot/dt-blob.bin</code>
 +
 +
==== For Buster OS（kernel5.10） ====
 +
Upgrade dual camera version dtbo file, Use csimx307 as an example.
 +
 +
<code>sudo cp raspberrypi_v4l2/release/driver_bin/$(uname -r)/csimx307-dual-cm4.dtbo /boot/overlays/csimx307.dtbo</code>
 +
 +
<code>sudo reboot</code>
 +
 +
==== For Bullseye OS（kernel5.15） ====
 +
Edit file<code>/boot/config.txt</code>，Add one line<code>dtoverlay=[camera],cam0</code>.
 +
 +
Take veyecam2m as an example.
 +
 +
<code>[all]</code>
 +
 +
<code>dtparam=i2c_vc=on</code>
 +
 +
<code>dtoverlay=veyecam2m</code>
 +
 +
<code>dtoverlay=veyecam2m,cam0</code>
 +
 +
==== Device node description ====
 +
The CM4 module uses two I2C channels to communicate with the two cameras, respectively.
 +
{| class="wikitable"
 +
! description
 +
!i2c bus num
 +
!video node
 +
|-
 +
|CAM0
 +
|0
 +
|video0
 +
|-
 +
|CAM1
 +
|10
 +
|video2（Buster），video1（Bullseye）
 +
|}
 +
Note: If there is only one camera, video node is always video0.
 +
 +
==== Gstreamer usage samples ====
 +
<code>export DISPLAY=:0</code>
 +
 +
*CAM0 preview(VEYE-MIPI-327,CS-MIPI-IMX307 @1080p mode)
 +
 +
<code>gst-launch-1.0 v4l2src io-mode=dmabuf device=/dev/video0 ! "video/x-raw,format=(string)UYVY, width=(int)1920, height=(int)1080,framerate=(fraction)30/1" ! v4l2convert capture-io-mode=dmabuf output-io-mode=dmabuf ! autovideosink sync=false -v</code>
 +
 +
*CAM1 preview(VEYE-MIPI-327,CS-MIPI-IMX307 @1080p mode)
 +
 +
<code>gst-launch-1.0 v4l2src io-mode=dmabuf device=/dev/video1 ! "video/x-raw,format=(string)UYVY, width=(int)1920, height=(int)1080,framerate=(fraction)30/1" ! v4l2convert capture-io-mode=dmabuf output-io-mode=dmabuf ! autovideosink sync=false -v</code>
 +
=== Source code compilation ===
 +
Please refer to: [[Build drivers from source for rpi]].
 +
 +
=== Document History ===
 +
 +
* 2024-01-01
 +
 +
Add support for Raspberrypi 5.
 +
 +
* 20230607
 +
 +
Add FPD-Link3 Driver and Its Description.
 +
 +
* 20230304
 +
 +
Add the instructions related to CM4 in Bullseye system.
 +
 +
* 20220706
 +
 +
To optimize gstreamer's pipeline, it is recommended to use v4l2convert instead of videoconvert and try to use the capture-io-mode output-io-mode io-mode option.
 +
 +
* 20220505
 +
 +
Refine the description of CM4.
 +
 +
*20220411
 +
 +
The source code compilation method is separate to a separate article.
 +
 +
* 20220302
 +
 +
Add v4l2-ctl and yavta examples.
 +
 +
* 20220301
 +
 +
Support 64-bit piOS
 +
 +
* 20220225
 +
 +
Add the application samples of gstreamer.
 +
 +
*20211125
   −
=== Source code cross compilation ===
+
Add VLC preview section.<br />
Retrieved from "http://wiki.veye.cc/index.php/Special:MobileDiff/3576...7320"

Navigation menu