Skip to contentSkip to conversation

ALSA: compress: Document stream states and fix gapless SM

PATCH Superseded Vinod Koul 3 participants 8 messages Jun 22, 2020 – Jun 23, 2020

Subsystems (4)

v2 of 5 Superseded Latest is v5 →

lore
Share & tools
lore

Vinod Koul

author maintainer
#0 lore raw

v2 cover ALSA: compress: Document stream states and fix gapless SM

Srini found issue with gapless implementation which prompted to look deeper into SM for compressed stream.

So documenting SM was first step, so first two patches add that. Last patch fixes the issue by keeping track on partial_drain and then moving state to 'running' in snd_compr_drain_notify() for partial_drain case on success. While at it, noticed snd_compr_drain_notify() is lockless state change, so fixed that as well.

I have tested this on Dragon board RB3, compressed audio works out of the box on that platform and Srini will send driver and fcplay patches for gapless soon.

Changes in v2:
- Added tested tag by Srini
- Update compress SM with Free state and compr_stop() transitions

Vinod Koul (3):
ALSA: compress: document the compress audio state machine
ALSA: compress: document the compress gapless audio state machine
ALSA: compress: fix partial_drain completion state

 .../sound/designs/compress-offload.rst        | 84 +++++++++++++++++++
 include/sound/compress_driver.h               | 12 ++-
 sound/core/compress_offload.c                 |  4 +
 3 files changed, 99 insertions(+), 1 deletion(-)
Signature · 1 line
2.26.2
author maintainer
#1 lore raw

PATCH v2 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

---
 .../sound/designs/compress-offload.rst        | 52 +++++++++++++++++++
 1 file changed, 52 insertions(+)
Documentation/sound/designs/compress-offload.rst +52 -0
index ad4bfbdacc83..6f86db82298b 100644
@@ -151,6 +151,58 @@ 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()    +----------+                                  |
+  |           |                              |                                        |
+  |           |                              |                                        |
+  |           |                              | compr_write()                          |
+  |           |                              |                                        |
+  |           |                              v                                        |
+  |           |                         +----------+                                  |
+  |           |                         |          |                                  |
+  |           |                         |  PREPARE |                                  |
+  |           |                         |          |                                  |
+  |           |                         +----------+                                  |
+  |           |                              |                                        |
+  |           |                              |                                        |
+  |           |                              | compr_start()                          |
+  |           |                              |                                        |
+  |           |                              v                                        |
+  |     +----------+                    +----------+  compr_pause()  +----------+     |
+  |     |          |    compr_drain()   |          |---------------->|          |     |
+  |     |  DRAIN   |<-------------------|  RUNNING |                 |  PAUSE   |     |
+  |     |          |                    |          |<----------------|          |     |
+  |     +----------+                    +----------+  compr_resume() +----------+     |
+  |           |                           |      |                                    |
+  |           |                           |      |                                    |
+  |           |                           |      |                                    |
+  |           |                           |      |          compr_stop()              |
+  |           |                           |      +------------------------------------+
+  |           |       +----------+        |
+  |           |       |          |        |
+  +-----------+------>|          |<-------+
+     compr_free()     |   FREE   |  compr_free()
+                      |          |
+                      +----------+
+
 
 Gapless Playback
 ================
Signature · 1 line
2.26.2
#2 lore raw

Re: [PATCH v2 1/3] ALSA: compress: document the compress audio state machine

Quoted 58 lines · Vinod Koul

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

---
  .../sound/designs/compress-offload.rst        | 52 +++++++++++++++++++
  1 file changed, 52 insertions(+)
Documentation/sound/designs/compress-offload.rst +42 -0
index ad4bfbdacc83..6f86db82298b 100644
@@ -151,6 +151,58 @@ 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()    +----------+                                  |
+  |           |                              |                                        |
+  |           |                              |                                        |
+  |           |                              | compr_write()                          |
+  |           |                              |                                        |
+  |           |                              v                                        |
+  |           |                         +----------+                                  |
+  |           |                         |          |                                  |
+  |           |                         |  PREPARE |                                  |
+  |           |                         |          |                                  |
+  |           |                         +----------+                                  |
+  |           |                              |                                        |
+  |           |                              |                                        |
+  |           |                              | compr_start()                          |
+  |           |                              |                                        |
+  |           |                              v                                        |
+  |     +----------+                    +----------+  compr_pause()  +----------+     |
+  |     |          |    compr_drain()   |          |---------------->|          |     |
+  |     |  DRAIN   |<-------------------|  RUNNING |                 |  PAUSE   |     |
+  |     |          |                    |          |<----------------|          |     |
+  |     +----------+                    +----------+  compr_resume() +----------+     |
+  |           |                           |      |                                    |
+  |           |                           |      |                                    |

Documentation/sound/designs/compress-offload.rst Modifications include: · line 205

Quoted 10 lines
Documentation/sound/designs/compress-offload.rst +10 -0
+  |           |                           |      |                                    |
+  |           |                           |      |          compr_stop()              |
+  |           |                           |      +------------------------------------+
+  |           |       +----------+        |
+  |           |       |          |        |
+  +-----------+------>|          |<-------+
+     compr_free()     |   FREE   |  compr_free()
+                      |          |
+                      +----------+
+

Sorry, this confuses me even more...

a) can you clarify if we can go from running to free directly? is this really a legit transition? There's already the option of doing a stop and a a drain.

b) no way to go back to SETUP from PREPARE? What happens if the app never starts but want to tear down the resources?

c) no way to stop a paused stream?

#3 lore raw

Re: [PATCH v2 1/3] ALSA: compress: document the compress audio state machine

Quoted 47 lines · Pierre-Louis Bossart
Quoted 36 lines · Vinod Koul
Documentation/sound/designs/compress-offload.rst +36 -0
+                                        +----------+
+                                        |          |
+                                        |   OPEN   |
+                                        |          |
+                                        +----------+
+                                             |
+                                             |
+                                             | compr_set_params()
+                                             |
+                                             v
+         compr_free()                   +----------+
+  +-------------------------------------|          |
+  |                                     |   SETUP  |
+  |           +------------------------>|          |<---------------------------------+
+  |           | compr_drain_notify()    +----------+                                  |
+  |           |                              |                                        |
+  |           |                              |                                        |
+  |           |                              | compr_write()                          |
+  |           |                              |                                        |
+  |           |                              v                                        |
+  |           |                         +----------+                                  |
+  |           |                         |          |                                  |
+  |           |                         |  PREPARE |                                  |
+  |           |                         |          |                                  |
+  |           |                         +----------+                                  |
+  |           |                              |                                        |
+  |           |                              |                                        |
+  |           |                              | compr_start()                          |
+  |           |                              |                                        |
+  |           |                              v                                        |
+  |     +----------+                    +----------+  compr_pause()  +----------+     |
+  |     |          |    compr_drain()   |          |---------------->|          |     |
+  |     |  DRAIN   |<-------------------|  RUNNING |                 |  PAUSE   |     |
+  |     |          |                    |          |<----------------|          |     |
+  |     +----------+                    +----------+  compr_resume() +----------+     |
+  |           |                           |      |                                    |

Documentation/sound/designs/compress-offload.rst Modifications include: · line 204

Quoted 10 lines
Documentation/sound/designs/compress-offload.rst +10 -0
+  |           |                           |      |                                    |
+  |           |                           |      |                                    |
+  |           |                           |      |          compr_stop()              |
+  |           |                           |      +------------------------------------+
+  |           |       +----------+        |
+  |           |       |          |        |
+  +-----------+------>|          |<-------+
+     compr_free()     |   FREE   |  compr_free()
+                      |          |
+                      +----------+
Quoted 4 lines

a) can you clarify if we can go from running to free directly? is this really a legit transition? There's already the option of doing a stop and a a drain.

This is allowed in the current code, the kernel sends the stop internally in this case, so it kinda does go through the setup state just not from the users view point. I am not sure I have a good handle on if that makes sense or not.

Quoted 1 line

c) no way to stop a paused stream?

Currently the code does allow this and it certainly makes sense so should probably be added.

Thanks,
Charles

author maintainer
#4 lore raw

Re: [PATCH v2 1/3] ALSA: compress: document the compress audio state machine

Quoted 2 lines · Charles Keepax
Quoted 1 line · Pierre-Louis Bossart

On 6/22/20 1:58 AM, Vinod Koul wrote:

                      +----------+
Quoted 9 lines
Quoted 4 lines

a) can you clarify if we can go from running to free directly? is this really a legit transition? There's already the option of doing a stop and a a drain.

This is allowed in the current code, the kernel sends the stop internally in this case, so it kinda does go through the setup state just not from the users view point. I am not sure I have a good handle on if that makes sense or not.

The idea was to stop first so that we can handle dmas which might be setup (like running/paused/prepared). So we should stop first and then free up. But i think it was an overkill... :)

Quoted 4 lines
Quoted 1 line

c) no way to stop a paused stream?

Currently the code does allow this and it certainly makes sense so should probably be added.

Yes will add

Signature · 1 line
~Vinod
author maintainer
#5 lore raw

Re: [PATCH v2 1/3] ALSA: compress: document the compress audio state machine

In reply to Pierre-Louis Bossart
Quoted 64 lines · Pierre-Louis Bossart
Quoted 61 lines · Vinod Koul

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

---
  .../sound/designs/compress-offload.rst        | 52 +++++++++++++++++++
  1 file changed, 52 insertions(+)
Documentation/sound/designs/compress-offload.rst +46 -0
index ad4bfbdacc83..6f86db82298b 100644
@@ -151,6 +151,58 @@ 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()    +----------+                                  |
+  |           |                              |                                        |
+  |           |                              |                                        |
+  |           |                              | compr_write()                          |
+  |           |                              |                                        |
+  |           |                              v                                        |
+  |           |                         +----------+                                  |
+  |           |                         |          |                                  |
+  |           |                         |  PREPARE |                                  |
+  |           |                         |          |                                  |
+  |           |                         +----------+                                  |
+  |           |                              |                                        |
+  |           |                              |                                        |
+  |           |                              | compr_start()                          |
+  |           |                              |                                        |
+  |           |                              v                                        |
+  |     +----------+                    +----------+  compr_pause()  +----------+     |
+  |     |          |    compr_drain()   |          |---------------->|          |     |
+  |     |  DRAIN   |<-------------------|  RUNNING |                 |  PAUSE   |     |
+  |     |          |                    |          |<----------------|          |     |
+  |     +----------+                    +----------+  compr_resume() +----------+     |
+  |           |                           |      |                                    |
+  |           |                           |      |                                    |
+  |           |                           |      |                                    |
+  |           |                           |      |          compr_stop()              |
+  |           |                           |      +------------------------------------+
+  |           |       +----------+        |
Quoted 8 lines

Documentation/sound/designs/compress-offload.rst Modifications include: · line 205

Quoted 6 lines
Documentation/sound/designs/compress-offload.rst +6 -0
+  |           |       |          |        |
+  +-----------+------>|          |<-------+
+     compr_free()     |   FREE   |  compr_free()
+                      |          |
+                      +----------+
+

Sorry, this confuses me even more...

Oops

Quoted 3 lines

a) can you clarify if we can go from running to free directly? is this really a legit transition? There's already the option of doing a stop and a a drain.

As Charles pointed it is legit one, but then from SM we should remove running->free arrow to clarify. Internally, free in running, draining and paused triggers a stop and then free.

Quoted 2 lines

b) no way to go back to SETUP from PREPARE? What happens if the app never starts but want to tear down the resources?

See above, free would trigger an internal step to stop (setup) and then freed.

Btw I am not adding changes to code but documenting the 'existing' behaviour, so a code lookup will help

Quoted 1 line

c) no way to stop a paused stream?

Yes missed that, will add.

Signature · 1 line
~Vinod
author maintainer
#6 lore raw

PATCH v2 2/3 ALSA: compress: document the compress gapless audio state machine

In reply to Vinod Koul

Also documented the galpess transitions. Please note that these are not really stream states, but show how the stream steps in gapless mode

---
 .../sound/designs/compress-offload.rst        | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)
Documentation/sound/designs/compress-offload.rst +32 -0
index 6f86db82298b..0bebfd33b933 100644
@@ -251,6 +251,38 @@ Sequence flow for gapless would be:
 
 (note: order for partial_drain and write for next track can be reversed as well)
 
+Gapless Playback SM
+===================
+
+For Gapless, we move from running state to partial drain and back, along
+with setting of meta_data and signalling for next track ::
+
+
+                                        +----------+
+                compr_drain_notify()    |          |
+              +------------------------>|  RUNNING |
+              |                         |          |
+              |                         +----------+
+              |                              |
+              |                              |
+              |                              | compr_next_track()
+              |                              |
+              |                              V
+              |                         +----------+
+              |                         |          |
+              |                         |NEXT_TRACK|
+              |                         |          |
+              |                         +----------+
+              |                              |
+              |                              |
+              |                              | compr_partial_drain()
+              |                              |
+              |                              V
+              |                         +----------+
+              |                         |          |
+              +------------------------ | PARTIAL_ |
+                                        |  DRAIN   |
+                                        +----------+
 
 Not supported
 =============
Signature · 1 line
2.26.2
author maintainer
#7 lore raw

PATCH v2 3/3 ALSA: compress: fix partial_drain completion state

In reply to Vinod Koul

On partial_drain completion we should be in SNDRV_PCM_STATE_RUNNING state, so set that for partially draining streams in snd_compr_drain_notify() and use a flag for partially draining streams

While at it, add locks for stream state change in
snd_compr_drain_notify() as well.

Fixes f44f2a5417b2 ("ALSA: compress: fix drain calls blocking other compress functions (v6)")
---
 include/sound/compress_driver.h | 12 +++++++++++-
 sound/core/compress_offload.c   |  4 ++++
 2 files changed, 15 insertions(+), 1 deletion(-)
include/sound/compress_driver.h +11 -1
index 3df8d8c90191..93a5897201ea 100644
@@ -66,6 +66,7 @@ struct snd_compr_runtime {
  * @direction: stream direction, playback/recording
  * @metadata_set: metadata set flag, true when set
  * @next_track: has userspace signal next track transition, true when set
+ * @partial_drain: undergoing partial_drain for stream, true when set
  * @private_data: pointer to DSP private data
  * @dma_buffer: allocated buffer if any
  */
@@ -78,6 +79,7 @@ struct snd_compr_stream {
 	enum snd_compr_direction direction;
 	bool metadata_set;
 	bool next_track;
+	bool partial_drain;
 	void *private_data;
 	struct snd_dma_buffer dma_buffer;
 };
@@ -187,7 +189,15 @@ static inline void snd_compr_drain_notify(struct snd_compr_stream *stream)
 	if (snd_BUG_ON(!stream))
 		return;
 
-	stream->runtime->state = SNDRV_PCM_STATE_SETUP;
+	mutex_lock(&stream->device->lock);
+	/* for partial_drain case we are back to running state on success */
+	if (stream->partial_drain) {
+		stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
+		stream->partial_drain = false; /* clear this flag as well */
+	} else {
+		stream->runtime->state = SNDRV_PCM_STATE_SETUP;
+	}
+	mutex_unlock(&stream->device->lock);
 
 	wake_up(&stream->runtime->sleep);
 }
sound/core/compress_offload.c +4 -0
index e618580feac4..1c4b2cf450a0 100644
@@ -803,6 +803,9 @@ static int snd_compr_stop(struct snd_compr_stream *stream)
 
 	retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
 	if (!retval) {
+		/* clear flags and stop any drain wait */
+		stream->partial_drain = false;
+		stream->metadata_set = false;
 		snd_compr_drain_notify(stream);
 		stream->runtime->total_bytes_available = 0;
 		stream->runtime->total_bytes_transferred = 0;
@@ -960,6 +963,7 @@ static int snd_compr_partial_drain(struct snd_compr_stream *stream)
 	if (stream->next_track == false)
 		return -EPERM;
 
+	stream->partial_drain = true;
 	retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_PARTIAL_DRAIN);
 	if (retval) {
 		pr_debug("Partial drain returned failure\n");
Signature · 1 line
2.26.2