summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMarvin Schmidt <marvin.schmidt1987@gmail.com>2022-08-29 15:59:50 +0200
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2022-08-30 15:26:04 +0300
commit18764a15c7062e241df3ffb587bf44d0c14c898d (patch)
tree42e798f64241330fabe5c34c2f379248aea1d5de /src
parent4baaecb4ff220d6decb959bef14d91385cbba1ad (diff)
libcamera: media_device: Fix \sa tags for MediaDevice::link
doxygen didn't create proper links to the overloads of MediaDevice::link because the signatures didn't match due to an additional 'const' While at it remove the unnecessary `MediaDevice::` and wrap the lines Fixes: b65feafe3244 ("libcamera: media_device: Add functions to get a MediaLink") Signed-off-by: Marvin Schmidt <marvin.schmidt1987@gmail.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Umang Jain <umang.jain@ideasonboard.com> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'src')
-rw-r--r--src/libcamera/media_device.cpp16
1 files changed, 10 insertions, 6 deletions
diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp
index 7c94da9e..52c8e66e 100644
--- a/src/libcamera/media_device.cpp
+++ b/src/libcamera/media_device.cpp
@@ -352,8 +352,9 @@ MediaEntity *MediaDevice::getEntityByName(const std::string &name) const
* entity with name \a sourceName, to the pad at index \a sinkIdx of the
* sink entity with name \a sinkName, if any.
*
- * \sa MediaDevice::link(const MediaEntity *source, unsigned int sourceIdx, const MediaEntity *sink, unsigned int sinkIdx) const
- * \sa MediaDevice::link(const MediaPad *source, const MediaPad *sink) const
+ * \sa link(const MediaEntity *source, unsigned int sourceIdx,
+ * const MediaEntity *sink, unsigned int sinkIdx)
+ * \sa link(const MediaPad *source, const MediaPad *sink)
*
* \return The link that connects the two pads, or nullptr if no such a link
* exists
@@ -381,8 +382,9 @@ MediaLink *MediaDevice::link(const std::string &sourceName, unsigned int sourceI
* entity \a source, to the pad at index \a sinkIdx of the sink entity \a
* sink, if any.
*
- * \sa MediaDevice::link(const std::string &sourceName, unsigned int sourceIdx, const std::string &sinkName, unsigned int sinkIdx) const
- * \sa MediaDevice::link(const MediaPad *source, const MediaPad *sink) const
+ * \sa link(const std::string &sourceName, unsigned int sourceIdx,
+ * const std::string &sinkName, unsigned int sinkIdx)
+ * \sa link(const MediaPad *source, const MediaPad *sink)
*
* \return The link that connects the two pads, or nullptr if no such a link
* exists
@@ -404,8 +406,10 @@ MediaLink *MediaDevice::link(const MediaEntity *source, unsigned int sourceIdx,
* \param[in] source The source pad
* \param[in] sink The sink pad
*
- * \sa MediaDevice::link(const std::string &sourceName, unsigned int sourceIdx, const std::string &sinkName, unsigned int sinkIdx) const
- * \sa MediaDevice::link(const MediaEntity *source, unsigned int sourceIdx, const MediaEntity *sink, unsigned int sinkIdx) const
+ * \sa link(const std::string &sourceName, unsigned int sourceIdx,
+ * const std::string &sinkName, unsigned int sinkIdx)
+ * \sa link(const MediaEntity *source, unsigned int sourceIdx,
+ * const MediaEntity *sink, unsigned int sinkIdx)
*
* \return The link that connects the two pads, or nullptr if no such a link
* exists
generated by cgit v1.2.1 (git 2.18.0) at 2025-06-09 04:29:39 +0000
68'>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 199 200 201 202 203 204 205 206 207 208 209 210 211 
/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (C) 2020, Sebastian Fricke
 *
 * bayer_format.cpp - BayerFormat class tests
 */

#include <iostream>

#include <libcamera/transform.h>

#include "libcamera/internal/bayer_format.h"

#include "test.h"

using namespace std;
using namespace libcamera;

class BayerFormatTest : public Test
{
protected:
	int run()
	{
		/* An empty Bayer format has to be invalid. */
		BayerFormat bayerFmt;
		if (bayerFmt.isValid()) {
			cerr << "An empty BayerFormat has to be invalid."
			     << endl;
			return TestFail;
		}

		/* A correct Bayer format has to be valid. */
		bayerFmt = BayerFormat(BayerFormat::BGGR, 8, BayerFormat::None);
		if (!bayerFmt.isValid()) {
			cerr << "A correct BayerFormat has to be valid."
			     << endl;
			return TestFail;
		}

		/*
		 * Two bayer formats created with the same order and bit depth
		 * have to be equal.
		 */
		bayerFmt = BayerFormat(BayerFormat::BGGR, 8, BayerFormat::None);
		BayerFormat bayerFmtExpect = BayerFormat(BayerFormat::BGGR, 8,
							 BayerFormat::None);
		if (bayerFmt != bayerFmtExpect) {
			cerr << "Comparison of identical formats failed."
			     << endl;
			return TestFail;
		}

		/*
		 * Two Bayer formats created with the same order but with a
		 * different bitDepth are not equal.
		 */
		bayerFmt = BayerFormat(BayerFormat::BGGR, 8, BayerFormat::None);
		bayerFmtExpect = BayerFormat(BayerFormat::BGGR, 12,
					     BayerFormat::None);
		if (bayerFmt == bayerFmtExpect) {
			cerr << "Comparison of different formats failed."
			     << endl;
			return TestFail;
		}

		/*
		 * Create a Bayer format with a V4L2PixelFormat and check if we
		 * get the same format after converting back to the V4L2 Format.
		 */
		V4L2PixelFormat v4l2FmtExpect = V4L2PixelFormat(
			V4L2_PIX_FMT_SBGGR8);
		bayerFmt = BayerFormat::fromV4L2PixelFormat(v4l2FmtExpect);
		V4L2PixelFormat v4l2Fmt = bayerFmt.toV4L2PixelFormat();
		if (v4l2Fmt != v4l2FmtExpect) {
			cerr << "Expected: '" << v4l2FmtExpect.toString()
			     << "' got: '" << v4l2Fmt.toString() << "'" << endl;
			return TestFail;
		}

		/*
		 * Use an empty Bayer format and verify that no matching
		 * V4L2PixelFormat is found.
		 */
		v4l2FmtExpect = V4L2PixelFormat();
		bayerFmt = BayerFormat();
		v4l2Fmt = bayerFmt.toV4L2PixelFormat();
		if (v4l2Fmt != v4l2FmtExpect) {
			cerr << "Expected: empty V4L2PixelFormat got: '"
			     << v4l2Fmt.toString() << "'" << endl;
			return TestFail;
		}

		/*
		 * Check if we get the expected Bayer format BGGR8
		 * when we convert the V4L2PixelFormat (V4L2_PIX_FMT_SBGGR8)
		 * to a Bayer format.
		 */
		bayerFmtExpect = BayerFormat(BayerFormat::BGGR, 8,
					     BayerFormat::None);
		v4l2Fmt = V4L2PixelFormat(V4L2_PIX_FMT_SBGGR8);
		bayerFmt = BayerFormat::fromV4L2PixelFormat(v4l2Fmt);
		if (bayerFmt != bayerFmtExpect) {
			cerr << "Expected BayerFormat '"
			     << bayerFmtExpect.toString() << "', got: '"
			     << bayerFmt.toString() << "'" << endl;
			return TestFail;
		}

		/*
		 * Confirm that a V4L2PixelFormat that is not found in
		 * the conversion table, doesn't yield a Bayer format.
		 */
		V4L2PixelFormat v4l2FmtUnknown = V4L2PixelFormat(
			V4L2_PIX_FMT_BGRA444);
		bayerFmt = BayerFormat::fromV4L2PixelFormat(v4l2FmtUnknown);
		if (bayerFmt.isValid()) {
			cerr << "Expected empty BayerFormat got: '"
			     << bayerFmt.toString() << "'" << endl;
			return TestFail;
		}

		/*
		 * Test if a valid Bayer format can be converted to a
		 * string representation.
		 */
		bayerFmt = BayerFormat(BayerFormat::BGGR, 8, BayerFormat::None);
		if (bayerFmt.toString() != "BGGR-8") {
			cerr << "String representation != 'BGGR-8' (got: '"
			     << bayerFmt.toString() << "' ) " << endl;
			return TestFail;
		}

		/*
		 * Determine if an empty Bayer format results in no
		 * string representation.
		 */
		bayerFmt = BayerFormat();
		if (bayerFmt.toString() != "INVALID") {
			cerr << "String representation != 'INVALID' (got: '"
			     << bayerFmt.toString() << "' ) " << endl;
			return TestFail;
		}

		/*
		 * Perform a horizontal Flip and make sure that the
		 * order is adjusted accordingly.
		 */
		bayerFmt = BayerFormat(BayerFormat::BGGR, 8, BayerFormat::None);
		bayerFmtExpect = BayerFormat(BayerFormat::GBRG, 8,
					     BayerFormat::None);
		BayerFormat hFlipFmt = bayerFmt.transform(Transform::HFlip);
		if (hFlipFmt != bayerFmtExpect) {
			cerr << "Horizontal flip of 'BGGR-8' should result in '"
			     << bayerFmtExpect.toString() << "', got: '"
			     << hFlipFmt.toString() << "'" << endl;
			return TestFail;
		}

		/*
		 * Perform a vertical Flip and make sure that
		 * the order is adjusted accordingly.
		 */
		bayerFmt = BayerFormat(BayerFormat::BGGR, 8, BayerFormat::None);
		bayerFmtExpect = BayerFormat(BayerFormat::GRBG, 8,
					     BayerFormat::None);
		BayerFormat vFlipFmt = bayerFmt.transform(Transform::VFlip);
		if (vFlipFmt != bayerFmtExpect) {
			cerr << "Vertical flip of 'BGGR-8' should result in '"
			     << bayerFmtExpect.toString() << "', got: '"
			     << vFlipFmt.toString() << "'" << endl;
			return TestFail;
		}

		/*
		 * Perform a transposition on a pixel order with both green
		 * pixels on the bottom left to top right diagonal and make
		 * sure, that it doesn't change.
		 */
		bayerFmt = BayerFormat(BayerFormat::BGGR, 8, BayerFormat::None);
		BayerFormat transposeFmt = bayerFmt.transform(
			Transform::Transpose);
		if (transposeFmt != bayerFmt) {
			cerr << "Transpose with both green pixels on the "
			     << "antidiagonal should not change the order "
			     << "(got '" << transposeFmt.toString() << "')"
			     << endl;
			return TestFail;
		}

		/*
		 * Perform a transposition on an pixel order with red and blue
		 * on the bottom left to top right diagonal and make sure
		 * that their positions are switched.
		 */
		bayerFmt = BayerFormat(BayerFormat::GBRG, 8, BayerFormat::None);
		bayerFmtExpect = BayerFormat(BayerFormat::GRBG, 8,
					     BayerFormat::None);
		transposeFmt = bayerFmt.transform(Transform::Transpose);
		if (transposeFmt != bayerFmtExpect) {
			cerr << "Transpose with the red & blue pixels on the "
			     << "antidiagonal should switch their position "
			     << "(got '" << transposeFmt.toString() << "')"
			     << endl;
			return TestFail;
		}

		return TestPass;
	}
};

TEST_REGISTER(BayerFormatTest)
generated by cgit v1.2.1 (git 2.18.0) at 2025-06-09 04:29:39 +0000