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

[Charles Keepax]

On Mon, Jun 22, 2020 at 08:28:48AM -0500, Pierre-Louis Bossart wrote:
> On 6/22/20 1:58 AM, Vinod Koul wrote:
> >+                                        +----------+
> >+                                        |          |
> >+                                        |   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()
> >+                      |          |
> >+                      +----------+
> 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.

> 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