summaryrefslogtreecommitdiff
path: root/utils/ipu3/ipu3-process.sh
blob: bb4abbe883a05f21ca31b820d9b2c6579e1523a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
#!/bin/bash
# SPDX-License-Identifier: GPL-2.0-or-later
# Copyright (C) 2018, Google Inc.
#
# Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
#
# ipu3-process.sh - Process raw frames with the Intel IPU3
#
# The scripts makes use of the following tools, which are expected to be
# found in $PATH:
#
# - media-ctl (from v4l-utils git://linuxtv.org/v4l-utils.git)
# - raw2pnm (from nvt https://github.com/intel/nvt.git)
# - yavta (from git://git.ideasonboard.org/yavta.git)

imgu_entity="ipu3-imgu 0"

# Locate the media device
find_media_device() {
	local mdev

	for mdev in /dev/media* ; do
		media-ctl -d $mdev -p | grep -q "^driver[ \t]*ipu3-imgu$" && break
		mdev=
	done

	if [[ -z $mdev ]] ; then
		echo "IPU3 media device not found." >&2
		exit 1
	fi

	echo $mdev
}

# Configure the pipeline
configure_pipeline() {
	local enable_3a=1
	local enable_out=1
	local enable_vf=1
	local mode=0

	# Configure the links
	$mediactl -r
	$mediactl -l "\"$imgu_entity input\":0 -> \"$imgu_entity\":0[1]"
	$mediactl -l "\"$imgu_entity\":2 -> \"$imgu_entity output\":0[$enable_out]"
	$mediactl -l "\"$imgu_entity\":3 -> \"$imgu_entity viewfinder\":0[$enable_vf]"
	$mediactl -l "\"$imgu_entity\":4 -> \"$imgu_entity 3a stat\":0[$enable_3a]"

	# Select processing mode (0 for video, 1 for still image)
	yavta --no-query -w "0x009819c1 $mode" $($mediactl -e "$imgu_entity")

	# Set formats. The media bus code doesn't matter as it is ignored by the
	# driver. We should use the FIXED format, but media-ctl doesn't support
	# it.
	$mediactl -V "\"$imgu_entity\":0 [fmt:SBGGR10_1X10/$out_size crop:(0,0)/$in_size compose:(0,0)/$in_size]"
	$mediactl -V "\"$imgu_entity\":2 [fmt:SBGGR10_1X10/$out_size]"
	$mediactl -V "\"$imgu_entity\":3 [fmt:SBGGR10_1X10/$vf_size]"
	$mediactl -V "\"$imgu_entity\":4 [fmt:SBGGR10_1X10/$out_size]"
}

# Perform frame processing through the IMGU
process_frames() {
	configure_pipeline

	local yavta="yavta -n $nbufs -c$frame_count"

	# Save the main and viewfinder outputs to disk, capture and drop 3A
	# statistics. Sleep 500ms between each execution of yavta to keep the
	# stdout messages readable.
	$yavta -f $IMGU_OUT_PIXELFORMAT -s $out_size "-F$output_dir/frame-out-#.bin" \
		$($mediactl -e "$imgu_entity output") &
	sleep 0.5
	$yavta -f $IMGU_VF_PIXELFORMAT -s $vf_size "-F$output_dir/frame-vf-#.bin" \
		$($mediactl -e "$imgu_entity viewfinder") &
	sleep 0.5
	$yavta $($mediactl -e "$imgu_entity 3a stat") &
	sleep 0.5

	# Feed the IMGU input.
	$yavta -f $IMGU_IN_PIXELFORMAT -s $in_size "-F$in_file" \
		$($mediactl -e "$imgu_entity input")
}

# Convert captured files to ppm
convert_files() {
	local index=$1
	local type=$2
	local size=$3
	local format=$4

	local width=$(echo $size | awk -F 'x' '{print $1}')
	local height=$(echo $size | awk -F 'x' '{print $2}')
	local padded_width=$(expr $(expr $width + 63) / 64 \* 64)

	raw2pnm -x$padded_width -y$height -f$format \
		$output_dir/frame-$type-$index.bin \
		$output_dir/frame-$type-$index.ppm
}

run_test() {
	IMGU_IN_PIXELFORMAT=IPU3_SGRBG10
	IMGU_OUT_PIXELFORMAT=NV12
	IMGU_VF_PIXELFORMAT=NV12

	echo "==== Test ===="
	echo "input:  $in_file"
	echo "output: $IMGU_OUT_PIXELFORMAT/$out_size"
	echo "vf:     $IMGU_VF_PIXELFORMAT/$vf_size"

	process_frames

	for i in `seq -f '%06.0f' 0 $(($frame_count - 1))`; do
		convert_files $i out $out_size $IMGU_OUT_PIXELFORMAT
		convert_files $i vf $vf_size $IMGU_VF_PIXELFORMAT
	done
}

validate_size() {
	local size=$1
	local width=$(echo $size | awk -F 'x' '{print $1}')
	local height=$(echo $size | awk -F 'x' '{print $2}')

	[[ "x${size}" == "x${width}x${height}" ]]
}

# Print usage message
usage() {
	echo "Usage: $(basename $1) [options] <input-file>"
	echo "Supported options:"
	echo "--out size        output frame size (defaults to input size)"
	echo "--vf size         viewfinder frame size (defaults to input size)"
	echo ""
	echo "Where the input file name and size are"
	echo ""
	echo "input-file = prefix '-' width 'x' height '.' extension"
	echo "size = width 'x' height"
}

# Parse command line arguments
while (( "$#" )) ; do
	case $1 in
	--out)
		out_size=$2
		if ! validate_size $out_size ; then
			echo "Invalid size '$out_size'"
			usage $0
			exit 1
		fi
		shift 2
		;;
	--vf)
		vf_size=$2
		if ! validate_size $vf_size ; then
			echo "Invalid size '$vf_size'"
			usage $0
			exit 1
		fi
		shift 2
		;;
	-*)
		echo "Unsupported option $1" >&2
		usage $0
		exit 1
		;;
	*)
		break
		;;
	esac
done

if [ $# != 1 ] ; then
	usage $0
	exit 1
fi

in_file=$1

# Parse the size from the input file name and perform minimal sanity
# checks.
in_size=$(echo $in_file | sed 's/.*-\([0-9]*\)x\([0-9]*\)\.[a-z0-9]*$/\1x\2/')
validate_size $in_size
if [[ $? != 0 ]] ; then
	echo "Invalid input file name $in_file" >&2
	usage $0
	exit 1
fi

out_size=${out_size:-$in_size}
vf_size=${vf_size:-$in_size}

mdev=$(find_media_device) || exit
mediactl="media-ctl -d $mdev"
echo "Using device $mdev"

output_dir="/tmp"
frame_count=5
nbufs=7
run_test
relates to header files, but shall be stored in the .cpp source files in order to group the implementation and documentation. Every documented header file shall have a \file documentation block in the .cpp source file. The following comment block shows an example of correct documentation for a member function of the PipelineHandler class. :: /** * \fn PipelineHandler::start() * \brief Start capturing from a group of streams * \param[in] camera The camera to start * * Start the group of streams that have been configured for capture by * \a configureStreams(). The intended caller of this function is the Camera * class which will in turn be called from the application to indicate that * it has configured the streams and is ready to capture. * * \return 0 on success or a negative error code otherwise */ The comment block shall be placed right before the function it documents. If the function is defined inline in the class definition in the header file, the comment block shall be placed alone in the .cpp source file in the same order as the function definitions in the header file and shall start with an \fn line. Otherwise no \fn line shall be present. The \brief directive shall be present. If the function takes parameters, \param directives shall be present, with the appropriate [in], [out] or [inout] specifiers. Only when the direction of the parameters isn't known (for instance when defining a template function with variadic arguments) the direction specifier shall be omitted. The \return directive shall be present when the function returns a value, and shall be omitted otherwise. The long description is optional. When present it shall be surrounded by empty lines and may span multiple paragraphs. No blank lines shall otherwise be added between the \fn, \brief, \param and \return directives. Tools ----- The 'clang-format' code formatting tool can be used to reformat source files with the libcamera coding style, defined in the .clang-format file at the root of the source tree. As clang-format is a code formatter, it operates on full files and outputs reformatted source code. While it can be used to reformat code before sending patches, it may generate unrelated changes. To avoid this, libcamera provides a 'checkstyle.py' script wrapping the formatting tools to only retain related changes. This should be used to validate modifications before submitting them for review. The script operates on one or multiple git commits specified on the command line. It does not modify the git tree, the index or the working directory and is thus safe to run at any point. Commits are specified using the same revision range syntax as 'git log'. The most usual use cases are to specify a single commit by sha1, branch name or tag name, or a commit range with the <from>..<to> syntax. When no arguments are given, the topmost commit of the current branch is selected. :: $ ./utils/checkstyle.py cc7d204b2c51 ---------------------------------------------------------------------------------- cc7d204b2c51853f7d963d144f5944e209e7ea29 libcamera: Use the logger instead of cout ---------------------------------------------------------------------------------- No style issue detected When operating on a range of commits, style checks are performed on each commit from oldest to newest. :: $ ../utils/checkstyle.py 3b56ddaa96fb~3..3b56ddaa96fb ---------------------------------------------------------------------------------- b4351e1a6b83a9cfbfc331af3753602a02dbe062 libcamera: log: Fix Doxygen documentation ---------------------------------------------------------------------------------- No style issue detected -------------------------------------------------------------------------------------- 6ab3ff4501fcfa24db40fcccbce35bdded7cd4bc libcamera: log: Document the LogMessage class -------------------------------------------------------------------------------------- No style issue detected --------------------------------------------------------------------------------- 3b56ddaa96fbccf4eada05d378ddaa1cb6209b57 build: Add 'std=c++11' cpp compiler flag --------------------------------------------------------------------------------- Commit doesn't touch source files, skipping Commits that do not touch any .c, .cpp or .h files are skipped. :: $ ./utils/checkstyle.py edbd2059d8a4 ---------------------------------------------------------------------- edbd2059d8a4bd759302ada4368fa4055638fd7f libcamera: Add initial logger ---------------------------------------------------------------------- --- src/libcamera/include/log.h +++ src/libcamera/include/log.h @@ -21,11 +21,14 @@ { public: LogMessage(const char *fileName, unsigned int line, - LogSeverity severity); - LogMessage(const LogMessage&) = delete; + LogSeverity severity); + LogMessage(const LogMessage &) = delete; ~LogMessage(); - std::ostream& stream() { return msgStream; } + std::ostream &stream() + { + return msgStream; + } private: std::ostringstream msgStream; --- src/libcamera/log.cpp +++ src/libcamera/log.cpp @@ -42,7 +42,7 @@ static const char *log_severity_name(LogSeverity severity) { - static const char * const names[] = { + static const char *const names[] = { "INFO", "WARN", " ERR", --- 2 potential style issues detected, please review When potential style issues are detected, they are displayed in the form of a diff that fixes the issues, on top of the corresponding commit. As the script is in early development false positive are expected. The flagged issues should be reviewed, but the diff doesn't need to be applied blindly. Execution of checkstyle.py can be automated through git commit hooks. Example of pre-commit and post-commit hooks are available in `utils/hooks/pre-commit` and `utils/hooks/post-commit`. You can install either hook by copying it to `.git/hooks/`. The post-commit hook is easier to start with as it will only flag potential issues after committing, while the pre-commit hook will abort the commit if issues are detected and requires usage of `git commit --no-verify` to ignore false positives. Happy hacking, libcamera awaits your patches!