lkml.org 
[lkml]   [2020]   [Jun]   [29]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v5 1/3] ALSA: compress: document the compress audio state machine
    Date
    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..ad89af9b31c9 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_write() +----------+ |
    + | | ^ |
    + | | | compr_drain_notify() |
    + | | | or |
    + | | | compr_stop() |
    + | | | |
    + | | +----------+ |
    + | | | | |
    + | | | DRAIN | |
    + | | | | |
    + | | +----------+ |
    + | | ^ |
    + | | | |
    + | | | compr_drain() |
    + | | | |
    + | v | |
    + | +----------+ +----------+ |
    + | | | compr_start() | | compr_stop() |
    + | | PREPARE |------------------->| RUNNING |--------------------------+
    + | | | | | |
    + | +----------+ +----------+ |
    + | | | ^ |
    + | |compr_free() | | |
    + | | compr_pause() | | compr_resume() |
    + | | | | |
    + | v v | |
    + | +----------+ +----------+ |
    + | | | | | compr_stop() |
    + +--->| FREE | | PAUSE |---------------------------+
    + | | | |
    + +----------+ +----------+
    +

    Gapless Playback
    ================
    --
    2.26.2
    \
     
     \ /
      Last update: 2020-06-29 20:41    [W:2.742 / U:0.372 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site