aboutsummaryrefslogtreecommitdiff
path: root/docs/pwg
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian@centricular.com>2014-05-03 17:39:29 +0200
committerSebastian Dröge <sebastian@centricular.com>2014-05-03 17:39:29 +0200
commit71fa795ffb1b32d47842f2be790168d55ee790e3 (patch)
tree048e6a37c0f792cac1e761b1b980f63f6e949d1b /docs/pwg
parent1adbba7bfff7853fca8b02aec57dbe1850d4a55c (diff)
Imported Upstream version 1.3.1upstream/1.3.1
Diffstat (limited to 'docs/pwg')
-rw-r--r--docs/pwg/Makefile.in1
-rw-r--r--docs/pwg/advanced-clock.xml8
-rw-r--r--docs/pwg/advanced-negotiation.xml6
-rw-r--r--docs/pwg/advanced-types.xml132
4 files changed, 115 insertions, 32 deletions
diff --git a/docs/pwg/Makefile.in b/docs/pwg/Makefile.in
index c4fe440..4732ae1 100644
--- a/docs/pwg/Makefile.in
+++ b/docs/pwg/Makefile.in
@@ -112,7 +112,6 @@ am__aclocal_m4_deps = $(top_srcdir)/common/m4/as-ac-expand.m4 \
$(top_srcdir)/common/m4/as-compiler-flag.m4 \
$(top_srcdir)/common/m4/as-docbook.m4 \
$(top_srcdir)/common/m4/as-libtool.m4 \
- $(top_srcdir)/common/m4/as-scrub-include.m4 \
$(top_srcdir)/common/m4/as-version.m4 \
$(top_srcdir)/common/m4/ax_create_stdint_h.m4 \
$(top_srcdir)/common/m4/gst-arch.m4 \
diff --git a/docs/pwg/advanced-clock.xml b/docs/pwg/advanced-clock.xml
index 89c1f29..4618167 100644
--- a/docs/pwg/advanced-clock.xml
+++ b/docs/pwg/advanced-clock.xml
@@ -125,7 +125,7 @@
<sect2>
<title>Parser/Decoder/Encoder elements </title>
<para>
- Parser/Decoder elements must use the incomming timestamps and transfer
+ Parser/Decoder elements must use the incoming timestamps and transfer
those to the resulting output buffers. They are allowed to interpolate
or reconstruct timestamps on missing input buffers when they can.
</para>
@@ -137,7 +137,7 @@
Demuxer elements can usually set the timestamps stored inside the media
file onto the outgoing buffers. They need to make sure that outgoing
buffers that are to be played at the same time have the same
- running-time. Demuxers also need to take into account the incomming
+ running-time. Demuxers also need to take into account the incoming
timestamps on buffers and use that to calculate an offset on the outgoing
buffer timestamps.
</para>
@@ -146,8 +146,8 @@
<sect2>
<title>Muxer elements</title>
<para>
- Muxer elements should use the incomming buffer running-time to mux the
- different streams together. They should copy the incomming running-time
+ Muxer elements should use the incoming buffer running-time to mux the
+ different streams together. They should copy the incoming running-time
to the outgoing buffers.
</para>
</sect2>
diff --git a/docs/pwg/advanced-negotiation.xml b/docs/pwg/advanced-negotiation.xml
index 9ec9993..db9b8cd 100644
--- a/docs/pwg/advanced-negotiation.xml
+++ b/docs/pwg/advanced-negotiation.xml
@@ -249,7 +249,7 @@ gst_my_filter_setcaps (GstMyFilter *filter,
outcaps = gst_caps_new_simple ("audio/x-raw",
"format", G_TYPE_STRING, GST_AUDIO_NE(S16),
- "rate", G_TYPE_INT, samplerate,
+ "rate", G_TYPE_INT, rate,
"channels", G_TYPE_INT, channels, NULL);
ret = gst_pad_set_caps (filter->srcpad, outcaps);
gst_caps_unref (outcaps);
@@ -463,7 +463,7 @@ gst_my_filter_chain (GstPad *pad,
to reconfigure its caps by doing a new query for the allowed caps and then
choosing a new caps. The element that sends out the RECONFIGURE event
would influence the selection of the new caps by returning the new
- prefered caps from its GST_QUERY_CAPS query function. The RECONFIGURE
+ preferred caps from its GST_QUERY_CAPS query function. The RECONFIGURE
event will set the GST_PAD_FLAG_NEED_RECONFIGURE on all pads that it
travels over.
</para>
@@ -477,7 +477,7 @@ gst_my_filter_chain (GstPad *pad,
Elements that want to propose a new format upstream need to first
check if the new caps are acceptable upstream with an ACCEPT_CAPS
query. Then they would send a RECONFIGURE event and be prepared to
- answer the CAPS query with the new prefered format. It should be
+ answer the CAPS query with the new preferred format. It should be
noted that when there is no upstream element that can (or wants)
to renegotiate, the element needs to deal with the currently
configured format.
diff --git a/docs/pwg/advanced-types.xml b/docs/pwg/advanced-types.xml
index 9898476..d1c8b35 100644
--- a/docs/pwg/advanced-types.xml
+++ b/docs/pwg/advanced-types.xml
@@ -229,8 +229,8 @@ plugin_init (GstPlugin *plugin)
<!-- ############ type ############# -->
<row>
- <entry morerows="1">audio/*</entry>
- <entry morerows="1">
+ <entry morerows="4">audio/*</entry>
+ <entry morerows="4">
<emphasis>All audio types</emphasis>
</entry>
<entry>rate</entry>
@@ -248,6 +248,34 @@ plugin_init (GstPlugin *plugin)
The number of channels of audio data.
</entry>
</row>
+ <row>
+ <entry>channel-mask</entry>
+ <entry>bitmask</entry>
+ <entry></entry>
+ <entry>
+ Channel positions present. See <quote>GstAudioChannelPosition</quote>.
+ 0 means unpositioned.
+ </entry>
+ </row>
+ <row>
+ <entry>format</entry>
+ <entry>string</entry>
+ <entry>
+ S8 U8 S16LE S16BE U16LE U16BE S24_32LE S24_32BE U24_32LE U24_32BE S32LE S32BE U32LE U32BE
+ S24LE S24BE U24LE U24BE S20LE S20BE U20LE U20BE S18LE S18BE U18LE U18BE F32LE F32BE F64LE F64BE
+ </entry>
+ <entry>
+ The format of the sample data.
+ </entry>
+ </row>
+ <row>
+ <entry>layout</entry>
+ <entry>string</entry>
+ <entry>"interleaved" or "non-interleaved"</entry>
+ <entry>
+ Layout of channels within a buffer.
+ </entry>
+ </row>
<!-- ############ subtitle ############# -->
@@ -264,14 +292,11 @@ plugin_init (GstPlugin *plugin)
<entry>
Unstructured and uncompressed raw audio data.
</entry>
- <entry>format</entry>
- <entry>string</entry>
- <entry>
- S8 U8 S16LE S16BE U16LE U16BE S24_32LE S24_32BE U24_32LE U24_32BE S32LE S32BE U32LE U32BE
- S24LE S24BE U24LE U24BE S20LE S20BE U20LE U20BE S18LE S18BE U18LE U18BE F32LE F32BE F64LE F64BE
- </entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
<entry>
- The format of the sample data.
+ All properties (except channel-mask, in the mono and stereo cases) are mandatory.
</entry>
</row>
@@ -657,8 +682,8 @@ plugin_init (GstPlugin *plugin)
<!-- ############ type ############# -->
<row>
- <entry morerows="2">video/*</entry>
- <entry morerows="2">
+ <entry morerows="9">video/*</entry>
+ <entry morerows="9">
<emphasis>All video types</emphasis>
</entry>
<entry>width</entry>
@@ -675,29 +700,67 @@ plugin_init (GstPlugin *plugin)
<row>
<entry>framerate</entry>
<entry>fraction</entry>
- <entry>greater or equal 0</entry>
+ <entry>greater or equal 0; default 0/1</entry>
<entry>
The (average) framerate in frames per second. Note that this
property does not guarantee in <emphasis>any</emphasis> way that
it will actually come close to this value. If you need a fixed
framerate, please use an element that provides that (such as
- <quote>videorate</quote>). 0 means a variable framerate.
+ <quote>videorate</quote>). 0/1 means a variable framerate.
</entry>
</row>
-
- <!-- ############ subtitle ############# -->
-
<row>
- <entry spanname="fullwidth">
- <emphasis>All raw video types.</emphasis>
+ <entry>max-framerate</entry>
+ <entry>fraction</entry>
+ <entry>greater or equal 0; default as framerate</entry>
+ <entry>
+ For variable framerates, the maximum framerate that is expected.
+ Only valid when framerate is 0/1.
+ </entry>
+ </row>
+ <row>
+ <entry>views</entry>
+ <entry>integer</entry>
+ <entry>greater than 0; default 1</entry>
+ <entry>
+ The number of views for multiview video. Each buffer contains
+ multiple <quote>GstVideoMeta</quote> buffers that describe each view. Use the
+ frame ID to get access to the different views.
+ </entry>
+ </row>
+ <row>
+ <entry>interlace-mode</entry>
+ <entry>string</entry>
+ <entry>progressive, interleaved, mixed, fields; default progressive</entry>
+ <entry>
+ The interlace mode. Extra buffer flags describe the frame and fields.
+ </entry>
+ </row>
+ <row>
+ <entry>chroma-site</entry>
+ <entry>string</entry>
+ <entry>jpeg, mpeg2, dv; default UNKNOWN</entry>
+ <entry>
+ The chroma siting of the video frames.
+ </entry>
+ </row>
+ <row>
+ <entry>colorimetry</entry>
+ <entry>string</entry>
+ <entry>bt601, bt709, smpte240m; default UNKNOWN</entry>
+ <entry>
+ The colorimetry of the video frames.
+ </entry>
+ </row>
+ <row>
+ <entry>pixel-aspect-ratio</entry>
+ <entry>fraction</entry>
+ <entry>greater than 0; default 1/1</entry>
+ <entry>
+ The pixel aspect ratio of the video.
</entry>
</row>
-
- <!-- ############ type ############# -->
-
<row>
- <entry>video/x-raw</entry>
- <entry>Unstructured and uncompressed raw video data.</entry>
<entry>format</entry>
<entry>string</entry>
<entry>
@@ -707,7 +770,7 @@ plugin_init (GstPlugin *plugin)
IYU1 ARGB64 AYUV64 r210 I420_10LE I420_10BE I422_10LE I422_10BE
</entry>
<entry>
- The layout of the video. See <ulink type="http"
+ The format of the video. See <ulink type="http"
url="http://www.fourcc.org/">FourCC definition site</ulink>
for references and definitions. YUY2, YVYU and UYVY are 4:2:2
packed-pixel, Y41P is 4:1:1 packed-pixel and IYU2 is 4:4:4
@@ -721,6 +784,27 @@ plugin_init (GstPlugin *plugin)
<row>
<entry spanname="fullwidth">
+ <emphasis>All raw video types.</emphasis>
+ </entry>
+ </row>
+
+ <!-- ############ type ############# -->
+
+ <row>
+ <entry>video/x-raw</entry>
+ <entry>Unstructured and uncompressed raw video data.</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>
+ The properties width, height and format are mandatory.
+ </entry>
+ </row>
+
+ <!-- ############ subtitle ############# -->
+
+ <row>
+ <entry spanname="fullwidth">
<emphasis>All encoded video types.</emphasis>
</entry>
</row>