diff options
| author | Marian Cichy <m.cichy@pengutronix.de> | 2021-03-19 17:03:22 +0100 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2021-03-20 22:24:09 +0200 |
| commit | 1a26f79f213f294f16f169d2e3dd9d37517d486d (patch) | |
| tree | a63abc25b43a48ce2aac663015d053119676d1f9 | |
| parent | aade93f503a313217dcaf117b1ba43be473bfe3f (diff) | |
pipeline: simple: Update documentation on pipeline setup
After commit 4671911df040 ("pipeline: simple: Use breadth-first search
to setup media pipeline"), the explanation in the SimplePipeline
documentation how the handler tries to find a valid path to capture
device does not reflect the reality anymore. Update the text to the new
situation.
Fixes: 4671911df040 ("pipeline: simple: Use breadth-first search to setup media pipeline")
Signed-off-by: Marian Cichy <m.cichy@pengutronix.de>
Reviewed-by: Sebastian Fricke <sebastian.fricke@posteo.net>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
| -rw-r--r-- | src/libcamera/pipeline/simple/simple.cpp | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/src/libcamera/pipeline/simple/simple.cpp b/src/libcamera/pipeline/simple/simple.cpp index cdf7e3ee..03d980c6 100644 --- a/src/libcamera/pipeline/simple/simple.cpp +++ b/src/libcamera/pipeline/simple/simple.cpp @@ -69,11 +69,12 @@ LOG_DEFINE_CATEGORY(SimplePipeline) * * When matching a device, the pipeline handler enumerates all camera sensors * and attempts, for each of them, to find a path to a video capture video node. - * It does so by traversing the media graph, following the first non permanently - * disabled downstream link. If such a path is found, the pipeline handler - * creates a corresponding SimpleCameraData instance, and stores the media graph - * path in its entities_ list. - * + * It does so by using a breadth-first search to find the shortest path from the + * sensor device to a valid capture device. This is guaranteed to produce a + * valid path on devices with one only option and is a good heuristic on more + * complex devices to skip paths that aren't suitable for the simple pipeline + * handler. For instance, on the IPU-based i.MX6, the shortest path will skip + * encoders and image converters, and it will end in a CSI capture device. * A more complex graph search algorithm could be implemented if a device that * would otherwise be compatible with the pipeline handler isn't correctly * handled by this heuristic. |