RASPIYUV(1)

NAME
raspiyuv - takes unencoded still captures with the Pi Camera Module

SYNOPSIS
raspiyuv [-3d mode] [-3dswap] [-a flags|text] [-ae size,fg,bg] [-ag value] [-awb mode] [-awbg b,r] [-bm] [-br value] [-cfx u:v] [-co value] [-cs camera] [-dec] [-dg value] [-dn screen] [-drc value] [-ev value] [-ex mode] [-f] [-fli mode] [-fp] [-gps] [-h size] [-hf] [-ifx effect] [-ISO value] [-k] [-l filename] [-md mode] [-mm mode] [-n] [-o filename] [-op opacity] [-p x,y,w,h] [-roi x,y,w,h] [-rot value] [-s] [-sa value] [-set] [-sh value] [-ss value] [-st] [-t ms] [-tl ms] [-v] [-vf] [-w size]
raspiyuv [-?]
raspiyuv [--help]

DESCRIPTION
raspiyuv is a command line utility for capturing unencoded still images from the Raspberry Pi Camera Module (any version), in YUV format by default (see [YUV]). It has numerous options which can be used to customize the capture process, the preview display, or to perform more complex operations like time-lapse or triggered captures.

OPTIONS
The options documented in the following sections are specific to the raspiyuv utility, or commonly used with it. For full details of the other options (which are common to all the camera utilities), please refer to the raspicam(7) manual page.

GENERAL OPTIONS

-?, --help
    Display a concise description of all parameters

-bgr, --bgr
    Saves the image data as BGR data rather than YUV. See --rgb below for more information.

-bm, --burst
    Sets burst capture mode. This prevents the camera from returning to preview mode in between captures, meaning that captures can be taken closer together.

-fp, --fullpreview
    This runs the preview using the full resolution capture mode. Maximum frames per second in this mode is 15fps, and the preview will have the same field of view as the capture. Captures should happen more quickly, as no mode change should be required. This feature is currently under development.

-h, --height size
    Set the image height to size.

-k, --keypress
    The camera is run for the requested time (-t), and a capture can be initiated throughout that time by pressing the Enter key. Pressing X then Enter will exit the application before the timeout is reached. If the timeout is set to 0, the camera will run indefinitely until the user presses X then Enter. Using the verbose option (-v) will display a prompt asking for user input, otherwise no prompt is displayed.

-l, --latest filename
    Makes a file system link under this name to the latest frame.

-y, --luma
    Only outputs the luma (Y) channel of the YUV image. This is effectively the black and white, or intensity, part of the image. See [YUV] for more information.

-o, --output filename
    Specifies the output filename. If not specified, no file is saved. If the filename is “-”, then all output is send to stdout.

-rgb, --rgb
    This option forces the image to be saved as RGB data with 8 bits per channel, rather than YUV420. Note that the image buffers saved in raspiyuv are padded to a horizontal size divisible by 32, so there may be unused bytes at the end of each line. Buffers are also padded vertically to be divisible by 16, and in the YUV mode, each plane of Y,U,V is padded in this way.

-s, --signal
    The camera is run for the requested time (-t), and a capture can be initiated throughout that time by sending a USR1 signal to the camera process. This can be done using the killall(1) command. For example:

        killall -USR1 raspiyuv

-v, --verbose
    Outputs debugging/information messages during the program run.

-w, --width size
    Set the image width to size.

TIMELAPSE OPTIONS

-tl, --timelapse ms
    The specific value is the time between shots in milliseconds. Note that you should specify %04d at the point in the filename where you want a frame count number to appear. So, for example, the code below will produce a capture every 2 seconds, over a total period of 30s, named “image0001.jpg”, “image0002.jpg” and so on, through to “image0015.jpg”:

        -t 30000 -tl 2000 -o image%04d.jpg

    Note that the %04d indicates a 4-digit number, with leading zeroes added to make the required number of digits. So, for example, %08d would result in an 8-digit number. If a timelapse value of 0 is entered, the application will take pictures as fast as possible. Note that there's an minimum enforced pause of 30ms between captures to ensure that exposure calculations can be made.

EXIT STATUS

0   Application ran successfully (EX_OK)

64  Bad command line parameter (EX_USAGE)

70  Software or camera error (EX_SOFTWARE)

130 Application terminated by Ctrl-C

SEE ALSO
raspicam(7), raspistill(1), raspivid(1), raspividyuv(1), vcgencmd(1), [YUV], [SOURCE]

REFERENCES

[SOURCE]
    https://www.raspberrypi.org/documentation/raspbian/applications/camera.md

[YUV]
    https://en.wikipedia.org/wiki/YUV