summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSebastian Dröge <slomo@circular-chaos.org>2013-09-17 13:33:33 +0200
committerSebastian Dröge <slomo@circular-chaos.org>2013-09-17 13:36:49 +0200
commit2ae9809ae8b2da1ab92f34550f836884530b5d69 (patch)
treebdd28106dc80972a04f6a3ccea2da84c292a74a7 /docs
parent4d367dc1b0d4ecb37f4d27267e03d7bf0c6c06a6 (diff)
context: Update documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/design/part-context.txt31
1 files changed, 15 insertions, 16 deletions
diff --git a/docs/design/part-context.txt b/docs/design/part-context.txt
index ad2073bbf..ed071292e 100644
--- a/docs/design/part-context.txt
+++ b/docs/design/part-context.txt
@@ -1,14 +1,15 @@
Context
-------
-GstContext is a container object, containing a generic GstStructure.
-It is used to store and propagate context information in a pipeline,
-like device handles, display server connections and other information
-that should be shared between multiple elements in a pipeline.
+GstContext is a container object, containing a type string and a
+generic GstStructure. It is used to store and propagate context
+information in a pipeline, like device handles, display server
+connections and other information that should be shared between
+multiple elements in a pipeline.
For sharing context objects and distributing them between application
-and elements in a pipeline, there are downstream queries, downstream
-events, messages and functions to set a context on a complete pipeline.
+and elements in a pipeline, there are downstream queries, upstream
+queries, messages and functions to set a context on a complete pipeline.
Context types
@@ -24,19 +25,21 @@ Elements that need a specific context for their operation would
do the following steps until one succeeds:
1) Check if the element already has a context of the specific type,
- i.e. by checking the context returned by gst_element_get_context()
+ i.e. it was previoulsy set via gst_element_set_context().
2) Query downstream with GST_QUERY_CONTEXT for the context and check if
downstream already has a context of the specific type
- 3) Post a GST_MESSAGE_NEED_CONTEXT message on the bus with the required
+ 3) Query upstream with GST_QUERY_CONTEXT for the context and check if
+ upstream already has a context of the specific type
+
+ 4) Post a GST_MESSAGE_NEED_CONTEXT message on the bus with the required
context types and afterwards check if a usable context was set now
as in 1). The message could be handled by the parent bins of the
element and the application.
4) Create a context by itself and post a GST_MESSAGE_HAVE_CONTEXT message
- and send a GST_EVENT_CONTEXT event downstream, containing the complete
- context information at this time.
+ on the bus.
Bins will propagate any context that is set on them via
@@ -58,10 +61,6 @@ create a context of the requested type or pass an already existing
context to the element (or the complete pipeline).
Whenever an element creates a context internally it will post a
-GST_MESSAGE_HAVE_CONTEXT message on the bus. Applications should store
-the context of these messages, for example by creating a GstContext
-containing all the contexts of the pipeline by merging the structures.
-Applications can also just set the context contained in the
-GST_MESSAGE_HAVE_CONTEXT message on the complete pipeline to make sure it
-is shared between all elements.
+GST_MESSAGE_HAVE_CONTEXT message on the bus. Bins will cache these
+contexts and pass them to any future elements that request them.