summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorTomi Valkeinen <tomi.valkeinen@ideasonboard.com>2022-08-31 16:13:24 +0200
committerMauro Carvalho Chehab <mchehab@kernel.org>2022-09-24 09:07:24 +0200
commitb558ce56b434d8ca633ccc31a4acfee79a29a7a5 (patch)
treec77417c35c263c73e2468ae40e9e42b8b02b6992 /Documentation
parentac5d4d87e1eb8534c4b8148f77a0771825e780f4 (diff)
downloadlinux-stable-b558ce56b434d8ca633ccc31a4acfee79a29a7a5.tar.gz
linux-stable-b558ce56b434d8ca633ccc31a4acfee79a29a7a5.tar.bz2
linux-stable-b558ce56b434d8ca633ccc31a4acfee79a29a7a5.zip
media: Documentation: mc: add definitions for stream and pipeline
The doc talks about streams and pipelines, but doesn't really define them. This is an attempt to define them according to my understanding. Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com> Reviewed-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/driver-api/media/mc-core.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/driver-api/media/mc-core.rst b/Documentation/driver-api/media/mc-core.rst
index 84aa7cdb5341..4bb062d5c2e7 100644
--- a/Documentation/driver-api/media/mc-core.rst
+++ b/Documentation/driver-api/media/mc-core.rst
@@ -214,6 +214,18 @@ Link properties can be modified at runtime by calling
Pipelines and media streams
^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A media stream is a stream of pixels or metadata originating from one or more
+source devices (such as a sensors) and flowing through media entity pads
+towards the final sinks. The stream can be modified on the route by the
+devices (e.g. scaling or pixel format conversions), or it can be split into
+multiple branches, or multiple branches can be merged.
+
+A media pipeline is a set of media streams which are interdependent. This
+interdependency can be caused by the hardware (e.g. configuration of a second
+stream cannot be changed if the first stream has been enabled) or by the driver
+due to the software design. Most commonly a media pipeline consists of a single
+stream which does not branch.
+
When starting streaming, drivers must notify all entities in the pipeline to
prevent link states from being modified during streaming by calling
:c:func:`media_pipeline_start()`.