[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <20200625154651.99758-2-vkoul@kernel.org>
Date: Thu, 25 Jun 2020 21:16:49 +0530
From: Vinod Koul <vkoul@...nel.org>
To: Takashi Iwai <tiwai@...e.com>, Jaroslav Kysela <perex@...ex.cz>
Cc: Vinod Koul <vkoul@...nel.org>,
Srinivas Kandagatla <srinivas.kandagatla@...aro.org>,
Pierre-Louis Bossart <pierre-louis.bossart@...ux.intel.com>,
Charles Keepax <ckeepax@...nsource.cirrus.com>,
alsa-devel@...a-project.org, linux-kernel@...r.kernel.org
Subject: [PATCH v3 1/3] ALSA: compress: document the compress audio state machine
So we had some discussions of the stream states, so I thought it is a
good idea to document the state transitions, so add it documentation
Signed-off-by: Vinod Koul <vkoul@...nel.org>
---
.../sound/designs/compress-offload.rst | 51 +++++++++++++++++++
1 file changed, 51 insertions(+)
diff --git a/Documentation/sound/designs/compress-offload.rst b/Documentation/sound/designs/compress-offload.rst
index ad4bfbdacc83..b6e9025ae105 100644
--- a/Documentation/sound/designs/compress-offload.rst
+++ b/Documentation/sound/designs/compress-offload.rst
@@ -151,6 +151,57 @@ Modifications include:
- Addition of encoding options when required (derived from OpenMAX IL)
- Addition of rateControlSupported (missing in OpenMAX AL)
+State Machine
+=============
+
+The compressed audio stream state machine is described below ::
+
+ +----------+
+ | |
+ | OPEN |
+ | |
+ +----------+
+ |
+ |
+ | compr_set_params()
+ |
+ v
+ compr_free() +----------+
+ +------------------------------------| |
+ | | SETUP |
+ | +------------------------>| |<-------------------------+
+ | | compr_drain_notify() +----------+ |
+ | | or | |
+ | | compr_stop() | |
+ | | | compr_write() |
+ | | | |
+ | | v |
+ | | +----------+ |
+ | | | | compr_free() |
+ | | | PREPARE |---------------> A |
+ | | | | |
+ | | +----------+ |
+ | | | |
+ | | | |
+ | | | compr_start() |
+ | | | |
+ | | v |
+ | +----------+ +----------+ |
+ | | | compr_drain() | | compr_stop() |
+ | | DRAIN |<-------------------| RUNNING |--------------------------+
+ | | | | | |
+ | +----------+ +----------+ |
+ | | ^ |
+ | A | | |
+ | | compr_pause() | | compr_resume() |
+ | | | | |
+ | v v | |
+ | +----------+ +----------+ |
+ | | | | | compr_stop() |
+ +--->| FREE | | PAUSE |---------------------------+
+ | | | |
+ +----------+ +----------+
+
Gapless Playback
================
--
2.26.2
Powered by blists - more mailing lists