From: Vinod Koul <vkoul@kernel.org>
To: Takashi Iwai <tiwai@suse.com>, Jaroslav Kysela <perex@perex.cz>
Cc: alsa-devel@alsa-project.org,
Charles Keepax <ckeepax@opensource.cirrus.com>,
Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>,
linux-kernel@vger.kernel.org, Vinod Koul <vkoul@kernel.org>,
Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
Subject: [PATCH v4 1/3] ALSA: compress: document the compress audio state machine
Date: Mon, 29 Jun 2020 13:20:00 +0530 [thread overview]
Message-ID: <20200629075002.11436-2-vkoul@kernel.org> (raw)
In-Reply-To: <20200629075002.11436-1-vkoul@kernel.org>
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
Reviewed-by: Charles Keepax <ckeepax@opensource.cirrus.com>
Signed-off-by: Vinod Koul <vkoul@kernel.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
next prev parent reply other threads:[~2020-06-29 7:52 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-29 7:49 [PATCH v4 0/3] ALSA: compress: Document stream states and fix gapless SM Vinod Koul
2020-06-29 7:50 ` Vinod Koul [this message]
2020-06-29 9:05 ` [PATCH v4 1/3] ALSA: compress: document the compress audio state machine Amadeusz Sławiński
2020-06-29 9:34 ` Vinod Koul
2020-06-29 10:02 ` Amadeusz Sławiński
2020-06-29 10:59 ` Vinod Koul
2020-06-29 7:50 ` [PATCH v4 2/3] ALSA: compress: document the compress gapless " Vinod Koul
2020-06-29 7:50 ` [PATCH v4 3/3] ALSA: compress: fix partial_drain completion state Vinod Koul
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200629075002.11436-2-vkoul@kernel.org \
--to=vkoul@kernel.org \
--cc=alsa-devel@alsa-project.org \
--cc=ckeepax@opensource.cirrus.com \
--cc=linux-kernel@vger.kernel.org \
--cc=perex@perex.cz \
--cc=pierre-louis.bossart@linux.intel.com \
--cc=srinivas.kandagatla@linaro.org \
--cc=tiwai@suse.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).