alsa-devel.alsa-project.org archive mirror
 help / color / mirror / Atom feed
From: "Amadeusz Sławiński" <amadeuszx.slawinski@linux.intel.com>
To: Vinod Koul <vkoul@kernel.org>, Takashi Iwai <tiwai@suse.com>,
	Jaroslav Kysela <perex@perex.cz>
Cc: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>,
	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
Subject: Re: [PATCH v4 1/3] ALSA: compress: document the compress audio state machine
Date: Mon, 29 Jun 2020 11:05:38 +0200	[thread overview]
Message-ID: <c29b3199-cebd-2153-5530-e75f76aa8b4b@linux.intel.com> (raw)
In-Reply-To: <20200629075002.11436-2-vkoul@kernel.org>



On 6/29/2020 9:50 AM, Vinod Koul wrote:
> 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()                  |
> +  |          |                              |                                |
> +  |          |                              |                                |
> +  |          |                         +----------+                          |
> +  |          |                         |          |   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
>   ================
> 

Line containing compr_free (between SETUP and FREE) seems to be misaligned?

If you move prepare to the left and drain in place of drain, it feels 
like you won't need this weird indirection with A
Something like:

 >> +                                             v
>> +         compr_free()                   +----------+
>> +  +------------------------------------|          |
>> +  |                                    |   SETUP  |
>> +  |          +------------------------>|          |<-------------------------+
>> +  |          | compr_write()           +----------+                          |
>> +  |          |                              ^                                |
>> +  |          |                              | compr_drain_notify() or        |
>> +  |          |                              | compr_stop()                   |
>> +  |          |                              |                                |
>> +  |          |                              |                                |
>> +  |          |                         +----------+                          |
>> +  |          |                         |          |                          |
>> +  |          |                         |  DRAIN   |                          |
>> +  |          |                         |          |                          |
>> +  |          |                         +----------+                          |
>> +  |          |                              ^                                |
>> +  |          |                              |                                |
>> +  |          |                              | compr_drain()                  |
>> +  |          |                              |                                |
>> +  |          |                              |                                |
>> +  |    +----------+                    +----------+                          |
>> +  |    |          |    compr_start()   |          |        compr_stop()      |
>> +  |    |  PREPARE |------------------->|  RUNNING |--------------------------+
>> +  |    |          |                    |          |                          |
>> +  |    +----------+                    +----------+                          |
>> +  |          |                            |    ^                             |
>> +  |          | compr_free()               |    |                             |
>> +  |          |              compr_pause() |    | compr_resume()              |
>> +  |          |                            |    |                             |
>> +  |          v                            v    |                             |
>> +  |    +----------+                   +----------+                           |
>> +  |    |          |                   |          |         compr_stop()      |
>> +  +--->|   FREE   |                   |  PAUSE   |---------------------------+
>> +       |          |                   |          |
>> +       +----------+                   +----------+
>> +

but this makes me question PREPARE state, how do you enter it?

  reply	other threads:[~2020-06-29  9:07 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 ` [PATCH v4 1/3] ALSA: compress: document the compress audio state machine Vinod Koul
2020-06-29  9:05   ` Amadeusz Sławiński [this message]
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=c29b3199-cebd-2153-5530-e75f76aa8b4b@linux.intel.com \
    --to=amadeuszx.slawinski@linux.intel.com \
    --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 \
    --cc=vkoul@kernel.org \
    /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).