Skip to content

L
linux
Commit b69d5f26 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files
Options

[media] DocBook: add placeholders for ATSC M/H properties 

The ATSC M/H specific properties are not properly documented.
This became crearer when converting the existing data into
tables and adding cross references.

For now, just add placeholders, as a further investigation
about the meaning of each parameter is required.

Cc: Michael Ira Krufky <mkrufky@linuxtv.org>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 2acf9146
Show whitespace changes
Inline Side-by-side
Showing with 129 additions and 71 deletions
Documentation/DocBook/media/dvb/dvbproperty.xml
View file @ b69d5f26
...@@ -726,114 +726,172 @@ typedef enum fe_delivery_system { ...@@ -726,114 +726,172 @@ typedef enum fe_delivery_system {
</section> </section>
<section id="DTV-ATSCMH-RS-FRAME-MODE"> <section id="DTV-ATSCMH-RS-FRAME-MODE">
<title><constant>DTV_ATSCMH_RS_FRAME_MODE</constant></title> <title><constant>DTV_ATSCMH_RS_FRAME_MODE</constant></title>
<para>RS frame mode.</para> <para>Reed Solomon (RS) frame mode.</para>
<para>Possible values are:</para> <para>Possible values are:</para>
<para id="atscmh-rs-frame-mode"> <table pgwide="1" frame="none" id="atscmh-rs-frame-mode">
<programlisting> <title>enum atscmh_rs_frame_mode</title>
typedef enum atscmh_rs_frame_mode { <tgroup cols="2">
ATSCMH_RSFRAME_PRI_ONLY = 0, &cs-def;
ATSCMH_RSFRAME_PRI_SEC = 1, <thead>
} atscmh_rs_frame_mode_t; <row>
</programlisting> <entry>ID</entry>
</para> <entry>Description</entry>
</row>
</thead>
<tbody valign="top">
<row>
<entry id="ATSCMH-RSFRAME-PRI-ONLY"><constant>ATSCMH_RSFRAME_PRI_ONLY</constant></entry>
<entry>to be documented.</entry>
</row><row>
<entry id="ATSCMH-RSFRAME-PRI-SEC"><constant>ATSCMH_RSFRAME_PRI_SEC</constant></entry>
<entry>to be documented.</entry>
</row>
</tbody>
</tgroup>
</table>
</section> </section>
<section id="DTV-ATSCMH-RS-FRAME-ENSEMBLE"> <section id="DTV-ATSCMH-RS-FRAME-ENSEMBLE">
<title><constant>DTV_ATSCMH_RS_FRAME_ENSEMBLE</constant></title> <title><constant>DTV_ATSCMH_RS_FRAME_ENSEMBLE</constant></title>
<para>RS frame ensemble.</para> <para>RS frame ensemble.</para>
<para>Possible values are:</para> <para>Possible values are:</para>
<para id="atscmh-rs-frame-ensemble"> <table pgwide="1" frame="none" id="atscmh-rs-frame-ensemble">
<programlisting> <title>enum atscmh_rs_frame_ensemble</title>
typedef enum atscmh_rs_frame_ensemble { <tgroup cols="2">
ATSCMH_RSFRAME_ENS_PRI = 0, &cs-def;
ATSCMH_RSFRAME_ENS_SEC = 1, <thead>
} atscmh_rs_frame_ensemble_t; <row>
</programlisting> <entry>ID</entry>
</para> <entry>Description</entry>
</row>
</thead>
<tbody valign="top">
<row>
<entry id="ATSCMH-RSFRAME-ENS-PRI"><constant>ATSCMH_RSFRAME_ENS_PRI</constant></entry>
<entry>to be documented.</entry>
</row><row>
<entry id="ATSCMH-RSFRAME-ENS-SEC"><constant>AATSCMH_RSFRAME_PRI_SEC</constant></entry>
<entry>to be documented.</entry>
</row><row>
<entry id="ATSCMH-RSFRAME-RES"><constant>AATSCMH_RSFRAME_RES</constant></entry>
<entry>to be documented.</entry>
</row>
</tbody>
</tgroup>
</table>
</section> </section>
<section id="DTV-ATSCMH-RS-CODE-MODE-PRI"> <section id="DTV-ATSCMH-RS-CODE-MODE-PRI">
<title><constant>DTV_ATSCMH_RS_CODE_MODE_PRI</constant></title> <title><constant>DTV_ATSCMH_RS_CODE_MODE_PRI</constant></title>
<para>RS code mode (primary).</para> <para>RS code mode (primary).</para>
<para>Possible values are:</para> <para>Possible values are:</para>
<para id="atscmh-rs-code-mode"> <table pgwide="1" frame="none" id="atscmh-rs-code-mode">
<programlisting> <title>enum atscmh_rs_code_mode</title>
typedef enum atscmh_rs_code_mode { <tgroup cols="2">
ATSCMH_RSCODE_211_187 = 0, &cs-def;
ATSCMH_RSCODE_223_187 = 1, <thead>
ATSCMH_RSCODE_235_187 = 2, <row>
} atscmh_rs_code_mode_t; <entry>ID</entry>
</programlisting> <entry>Description</entry>
</para> </row>
</thead>
<tbody valign="top">
<row>
<entry id="ATSCMH-RSCODE-211-187"><constant>ATSCMH_RSCODE_211_187</constant></entry>
<entry>to be documented.</entry>
</row><row>
<entry id="ATSCMH-RSCODE-223-187"><constant>ATSCMH_RSCODE_223_187</constant></entry>
<entry>to be documented.</entry>
</row><row>
<entry id="ATSCMH-RSCODE-235-187"><constant>ATSCMH_RSCODE_235_187</constant></entry>
<entry>to be documented.</entry>
</row><row>
<entry id="ATSCMH-RSCODE-RES"><constant>ATSCMH_RSCODE_RES</constant></entry>
<entry>to be documented.</entry>
</row>
</tbody>
</tgroup>
</table>
</section> </section>
<section id="DTV-ATSCMH-RS-CODE-MODE-SEC"> <section id="DTV-ATSCMH-RS-CODE-MODE-SEC">
<title><constant>DTV_ATSCMH_RS_CODE_MODE_SEC</constant></title> <title><constant>DTV_ATSCMH_RS_CODE_MODE_SEC</constant></title>
<para>RS code mode (secondary).</para> <para>RS code mode (secondary).</para>
<para>Possible values are:</para> <para>Possible values are the same as documented on
<programlisting> &atscmh-rs-code-mode;:</para>
typedef enum atscmh_rs_code_mode {
ATSCMH_RSCODE_211_187 = 0,
ATSCMH_RSCODE_223_187 = 1,
ATSCMH_RSCODE_235_187 = 2,
} atscmh_rs_code_mode_t;
</programlisting>
</section> </section>
<section id="DTV-ATSCMH-SCCC-BLOCK-MODE"> <section id="DTV-ATSCMH-SCCC-BLOCK-MODE">
<title><constant>DTV_ATSCMH_SCCC_BLOCK_MODE</constant></title> <title><constant>DTV_ATSCMH_SCCC_BLOCK_MODE</constant></title>
<para>Series Concatenated Convolutional Code Block Mode.</para> <para>Series Concatenated Convolutional Code Block Mode.</para>
<para>Possible values are:</para> <para>Possible values are:</para>
<para id="atscmh-sccc-block-mode"> <table pgwide="1" frame="none" id="atscmh-sccc-block-mode">
<programlisting> <title>enum atscmh_scc_block_mode</title>
typedef enum atscmh_sccc_block_mode { <tgroup cols="2">
ATSCMH_SCCC_BLK_SEP = 0, &cs-def;
ATSCMH_SCCC_BLK_COMB = 1, <thead>
} atscmh_sccc_block_mode_t; <row>
</programlisting> <entry>ID</entry>
</para> <entry>Description</entry>
</row>
</thead>
<tbody valign="top">
<row>
<entry id="ATSCMH-SCCC-BLK-SEP"><constant>ATSCMH_SCCC_BLK_SEP</constant></entry>
<entry>to be documented.</entry>
</row><row>
<entry id="ATSCMH-SCCC-BLK-COMB"><constant>ATSCMH_SCCC_BLK_COMB</constant></entry>
<entry>to be documented.</entry>
</row><row>
<entry id="ATSCMH-SCCC-BLK-RES"><constant>ATSCMH_SCCC_BLK_RES</constant></entry>
<entry>to be documented.</entry>
</row>
</tbody>
</tgroup>
</table>
</section> </section>
<section id="DTV-ATSCMH-SCCC-CODE-MODE-A"> <section id="DTV-ATSCMH-SCCC-CODE-MODE-A">
<title><constant>DTV_ATSCMH_SCCC_CODE_MODE_A</constant></title> <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_A</constant></title>
<para>Series Concatenated Convolutional Code Rate.</para> <para>Series Concatenated Convolutional Code Rate.</para>
<para>Possible values are:</para> <para>Possible values are:</para>
<para id="atscmh-sccc-code-mode"> <table pgwide="1" frame="none" id="atscmh-sccc-code-mode">
<programlisting> <title>enum atscmh_sccc_code_mode</title>
typedef enum atscmh_sccc_code_mode { <tgroup cols="2">
ATSCMH_SCCC_CODE_HLF = 0, &cs-def;
ATSCMH_SCCC_CODE_QTR = 1, <thead>
} atscmh_sccc_code_mode_t; <row>
</programlisting> <entry>ID</entry>
</para> <entry>Description</entry>
</row>
</thead>
<tbody valign="top">
<row>
<entry id="ATSCMH-SCCC-CODE-HLF"><constant>ATSCMH_SCCC_CODE_HLF</constant></entry>
<entry>to be documented.</entry>
</row><row>
<entry id="ATSCMH-SCCC-CODE-QTR"><constant>ATSCMH_SCCC_CODE_QTR</constant></entry>
<entry>to be documented.</entry>
</row><row>
<entry id="ATSCMH-SCCC-CODE-RES"><constant>ATSCMH_SCCC_CODE_RES</constant></entry>
<entry>to be documented.</entry>
</row>
</tbody>
</tgroup>
</table>
</section> </section>
<section id="DTV-ATSCMH-SCCC-CODE-MODE-B"> <section id="DTV-ATSCMH-SCCC-CODE-MODE-B">
<title><constant>DTV_ATSCMH_SCCC_CODE_MODE_B</constant></title> <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_B</constant></title>
<para>Series Concatenated Convolutional Code Rate.</para> <para>Series Concatenated Convolutional Code Rate.</para>
<para>Possible values are:</para> <para>Possible values are the same as documented on
<programlisting> &atscmh-sccc-code-mode;.</para>
typedef enum atscmh_sccc_code_mode {
ATSCMH_SCCC_CODE_HLF = 0,
ATSCMH_SCCC_CODE_QTR = 1,
} atscmh_sccc_code_mode_t;
</programlisting>
</section> </section>
<section id="DTV-ATSCMH-SCCC-CODE-MODE-C"> <section id="DTV-ATSCMH-SCCC-CODE-MODE-C">
<title><constant>DTV_ATSCMH_SCCC_CODE_MODE_C</constant></title> <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_C</constant></title>
<para>Series Concatenated Convolutional Code Rate.</para> <para>Series Concatenated Convolutional Code Rate.</para>
<para>Possible values are:</para> <para>Possible values are the same as documented on
<programlisting> &atscmh-sccc-code-mode;.</para>
typedef enum atscmh_sccc_code_mode {
ATSCMH_SCCC_CODE_HLF = 0,
ATSCMH_SCCC_CODE_QTR = 1,
} atscmh_sccc_code_mode_t;
</programlisting>
</section> </section>
<section id="DTV-ATSCMH-SCCC-CODE-MODE-D"> <section id="DTV-ATSCMH-SCCC-CODE-MODE-D">
<title><constant>DTV_ATSCMH_SCCC_CODE_MODE_D</constant></title> <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_D</constant></title>
<para>Series Concatenated Convolutional Code Rate.</para> <para>Series Concatenated Convolutional Code Rate.</para>
<para>Possible values are:</para> <para>Possible values are the same as documented on
<programlisting> &atscmh-sccc-code-mode;.</para>
typedef enum atscmh_sccc_code_mode {
ATSCMH_SCCC_CODE_HLF = 0,
ATSCMH_SCCC_CODE_QTR = 1,
} atscmh_sccc_code_mode_t;
</programlisting>
</section> </section>
</section> </section>
<section id="DTV-API-VERSION"> <section id="DTV-API-VERSION">
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7