mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-14 05:12:09 +00:00
Code Issues 1 Projects Releases Wiki Activity

design: Update states architectural documentation

Browse source 
We now have STATE_TARGET, which is subtly different from STATE_PENDING

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-docs/-/merge_requests/149>
This commit is contained in:
Nirbheek Chauhan 2021-03-15 16:07:30 +05:30
parent c1fa62f971
commit 3b2f3939a4
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
markdown/additional/design/states.md
View file

@ -87,20 +87,30 @@ the following state changes are possible:
## State variables ## State variables
An element has 4 state variables that are protected with the object LOCK: An element has 5 state variables that are protected with the object LOCK:
- `STATE` - `STATE`
- `STATE_NEXT` - `STATE_NEXT`
- `STATE_PENDING` - `STATE_PENDING`
- `STATE_TARGET`
- `STATE_RETURN` - `STATE_RETURN`
The `STATE` always reflects the current state of the element. The `STATE` always reflects the current state of the element.
`STATE_NEXT` reflects the next state the element will go to. The
`STATE_PENDING` always reflects the required state of the element. The `STATE_NEXT` reflects the next state the element will go to.
`STATE_PENDING` always reflects the final state that the element is going to.
This is different than `STATE_NEXT` when the final state involves going through
multiple state changes, like from `PLAYING -> NULL`.
`STATE_TARGET` is the final state that the element should go to as set by the
application. `STATE_PENDING` can diverge from `STATE_TARGET` during `ASYNC`
state changes when the element does state transitions.
`STATE_RETURN` reflects the last return value of a state change. `STATE_RETURN` reflects the last return value of a state change.
The `STATE_NEXT` and `STATE_PENDING` can be `VOID_PENDING` if the element `STATE_NEXT` and `STATE_PENDING` can be `VOID_PENDING` if the element is
is in the right state. already in the right state.
An element has a special lock to protect against concurrent invocations An element has a special lock to protect against concurrent invocations
of `set_state()`, called the `STATE_LOCK`. of `set_state()`, called the `STATE_LOCK`.