aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@redhat.com>2011-06-08 10:56:57 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-07-27 16:52:57 -0400
commitfb029093e7408efa177e80444199746638c7d79d (patch)
treec638cbffde3104ff816a22a6c473626447ec0458 /Documentation/DocBook
parentcde291dfd7df3f7202078afcf27e9bb21ea76d0c (diff)
[media] DocBook/demux.xml: Fix section references with dmx.h.xml
Make the reference links at dmx.h.xml to match the ones at demux.xml. While here, also syncronizes the structures defined inside the API, in order to match the current API. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/Makefile2
-rw-r--r--Documentation/DocBook/media/dvb/demux.xml177
2 files changed, 91 insertions, 88 deletions
diff --git a/Documentation/DocBook/media/Makefile b/Documentation/DocBook/media/Makefile
index 249edd353968..0b055ad411c8 100644
--- a/Documentation/DocBook/media/Makefile
+++ b/Documentation/DocBook/media/Makefile
@@ -150,7 +150,7 @@ DVB_DOCUMENTED = \
150 -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ 150 -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
151 -e "s,<link linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\)<\/link>,\1,g" \ 151 -e "s,<link linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\)<\/link>,\1,g" \
152 -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \ 152 -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
153 -e "s,\(audio-mixer\|audio-karaoke\|audio-status\|ca-slot-info\|ca-descr-info\|ca-caps\|ca-msg\|ca-descr\|ca-pid\)-t,\1,g" \ 153 -e "s,\(audio-mixer\|audio-karaoke\|audio-status\|ca-slot-info\|ca-descr-info\|ca-caps\|ca-msg\|ca-descr\|ca-pid\|dmx-filter\|dmx-caps\)-t,\1,g" \
154 -e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \ 154 -e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \
155 -e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ 155 -e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
156 156
diff --git a/Documentation/DocBook/media/dvb/demux.xml b/Documentation/DocBook/media/dvb/demux.xml
index 1b8c4e9835b9..a297f0aadd0a 100644
--- a/Documentation/DocBook/media/dvb/demux.xml
+++ b/Documentation/DocBook/media/dvb/demux.xml
@@ -7,15 +7,19 @@ accessed by including <emphasis role="tt">linux/dvb/dmx.h</emphasis> in your app
7<section id="dmx_types"> 7<section id="dmx_types">
8<title>Demux Data Types</title> 8<title>Demux Data Types</title>
9 9
10<section id="dmx_output_t"> 10<section id="dmx-output-t">
11<title>dmx_output_t</title> 11<title>dmx_output_t</title>
12 <programlisting> 12<programlisting>
13 typedef enum 13typedef enum
14 { 14{
15 DMX_OUT_DECODER, 15 DMX_OUT_DECODER, /&#x22C6; Streaming directly to decoder. &#x22C6;/
16 DMX_OUT_TAP, 16 DMX_OUT_TAP, /&#x22C6; Output going to a memory buffer &#x22C6;/
17 DMX_OUT_TS_TAP 17 /&#x22C6; (to be retrieved via the read command).&#x22C6;/
18 } dmx_output_t; 18 DMX_OUT_TS_TAP, /&#x22C6; Output multiplexed into a new TS &#x22C6;/
19 /&#x22C6; (to be retrieved by reading from the &#x22C6;/
20 /&#x22C6; logical DVR device). &#x22C6;/
21 DMX_OUT_TSDEMUX_TAP /&#x22C6; Like TS_TAP but retrieved from the DMX device &#x22C6;/
22} dmx_output_t;
19</programlisting> 23</programlisting>
20<para><emphasis role="tt">DMX_OUT_TAP</emphasis> delivers the stream output to the demux device on which the ioctl is 24<para><emphasis role="tt">DMX_OUT_TAP</emphasis> delivers the stream output to the demux device on which the ioctl is
21called. 25called.
@@ -26,96 +30,95 @@ specified.
26</para> 30</para>
27</section> 31</section>
28 32
29<section id="dmx_input_t"> 33<section id="dmx-input-t">
30<title>dmx_input_t</title> 34<title>dmx_input_t</title>
31 <programlisting> 35<programlisting>
32 typedef enum 36typedef enum
33 { 37{
34 DMX_IN_FRONTEND, 38 DMX_IN_FRONTEND, /&#x22C6; Input from a front-end device. &#x22C6;/
35 DMX_IN_DVR 39 DMX_IN_DVR /&#x22C6; Input from the logical DVR device. &#x22C6;/
36 } dmx_input_t; 40} dmx_input_t;
37</programlisting> 41</programlisting>
38</section> 42</section>
39 43
40<section id="dmx_pes_type_t"> 44<section id="dmx-pes-type-t">
41<title>dmx_pes_type_t</title> 45<title>dmx_pes_type_t</title>
42 <programlisting> 46<programlisting>
43 typedef enum 47typedef enum
44 { 48{
45 DMX_PES_AUDIO, 49 DMX_PES_AUDIO0,
46 DMX_PES_VIDEO, 50 DMX_PES_VIDEO0,
47 DMX_PES_TELETEXT, 51 DMX_PES_TELETEXT0,
48 DMX_PES_SUBTITLE, 52 DMX_PES_SUBTITLE0,
49 DMX_PES_PCR, 53 DMX_PES_PCR0,
50 DMX_PES_OTHER
51 } dmx_pes_type_t;
52</programlisting>
53</section>
54 54
55<section id="dmx_event_t"> 55 DMX_PES_AUDIO1,
56<title>dmx_event_t</title> 56 DMX_PES_VIDEO1,
57 <programlisting> 57 DMX_PES_TELETEXT1,
58 typedef enum 58 DMX_PES_SUBTITLE1,
59 { 59 DMX_PES_PCR1,
60 DMX_SCRAMBLING_EV,
61 DMX_FRONTEND_EV
62 } dmx_event_t;
63</programlisting>
64</section>
65 60
66<section id="dmx_scrambling_status_t"> 61 DMX_PES_AUDIO2,
67<title>dmx_scrambling_status_t</title> 62 DMX_PES_VIDEO2,
68 <programlisting> 63 DMX_PES_TELETEXT2,
69 typedef enum 64 DMX_PES_SUBTITLE2,
70 { 65 DMX_PES_PCR2,
71 DMX_SCRAMBLING_OFF, 66
72 DMX_SCRAMBLING_ON 67 DMX_PES_AUDIO3,
73 } dmx_scrambling_status_t; 68 DMX_PES_VIDEO3,
69 DMX_PES_TELETEXT3,
70 DMX_PES_SUBTITLE3,
71 DMX_PES_PCR3,
72
73 DMX_PES_OTHER
74} dmx_pes_type_t;
74</programlisting> 75</programlisting>
75</section> 76</section>
76 77
77<section id="dmx_filter"> 78<section id="dmx-filter">
78<title>struct dmx_filter</title> 79<title>struct dmx_filter</title>
79 <programlisting> 80 <programlisting>
80 typedef struct dmx_filter 81 typedef struct dmx_filter
81 { 82{
82 uint8_t filter[DMX_FILTER_SIZE]; 83 __u8 filter[DMX_FILTER_SIZE];
83 uint8_t mask[DMX_FILTER_SIZE]; 84 __u8 mask[DMX_FILTER_SIZE];
84 } dmx_filter_t; 85 __u8 mode[DMX_FILTER_SIZE];
86} dmx_filter_t;
85</programlisting> 87</programlisting>
86</section> 88</section>
87 89
88<section id="dmx_sct_filter_params"> 90<section id="dmx-sct-filter-params">
89<title>struct dmx_sct_filter_params</title> 91<title>struct dmx_sct_filter_params</title>
90 <programlisting> 92<programlisting>
91 struct dmx_sct_filter_params 93struct dmx_sct_filter_params
92 { 94{
93 uint16_t pid; 95 __u16 pid;
94 dmx_filter_t filter; 96 dmx_filter_t filter;
95 uint32_t timeout; 97 __u32 timeout;
96 uint32_t flags; 98 __u32 flags;
97 #define DMX_CHECK_CRC 1 99#define DMX_CHECK_CRC 1
98 #define DMX_ONESHOT 2 100#define DMX_ONESHOT 2
99 #define DMX_IMMEDIATE_START 4 101#define DMX_IMMEDIATE_START 4
100 }; 102#define DMX_KERNEL_CLIENT 0x8000
103};
101</programlisting> 104</programlisting>
102</section> 105</section>
103 106
104<section id="dmx_pes_filter_params"> 107<section id="dmx-pes-filter-params">
105<title>struct dmx_pes_filter_params</title> 108<title>struct dmx_pes_filter_params</title>
106 <programlisting> 109<programlisting>
107 struct dmx_pes_filter_params 110struct dmx_pes_filter_params
108 { 111{
109 uint16_t pid; 112 __u16 pid;
110 dmx_input_t input; 113 dmx_input_t input;
111 dmx_output_t output; 114 dmx_output_t output;
112 dmx_pes_type_t pes_type; 115 dmx_pes_type_t pes_type;
113 uint32_t flags; 116 __u32 flags;
114 }; 117};
115</programlisting> 118</programlisting>
116</section> 119</section>
117 120
118<section id="dmx_event"> 121<section id="dmx-event">
119<title>struct dmx_event</title> 122<title>struct dmx_event</title>
120 <programlisting> 123 <programlisting>
121 struct dmx_event 124 struct dmx_event
@@ -130,14 +133,14 @@ specified.
130</programlisting> 133</programlisting>
131</section> 134</section>
132 135
133<section id="dmx_stc"> 136<section id="dmx-stc">
134<title>struct dmx_stc</title> 137<title>struct dmx_stc</title>
135 <programlisting> 138 <programlisting>
136 struct dmx_stc { 139struct dmx_stc {
137 unsigned int num; /&#x22C6; input : which STC? 0..N &#x22C6;/ 140 unsigned int num; /&#x22C6; input : which STC? 0..N &#x22C6;/
138 unsigned int base; /&#x22C6; output: divisor for stc to get 90 kHz clock &#x22C6;/ 141 unsigned int base; /&#x22C6; output: divisor for stc to get 90 kHz clock &#x22C6;/
139 uint64_t stc; /&#x22C6; output: stc in 'base'&#x22C6;90 kHz units &#x22C6;/ 142 __u64 stc; /&#x22C6; output: stc in 'base'&#x22C6;90 kHz units &#x22C6;/
140 }; 143};
141</programlisting> 144</programlisting>
142 </section> 145 </section>
143 146
@@ -491,7 +494,7 @@ specified.
491 </row></tbody></tgroup></informaltable> 494 </row></tbody></tgroup></informaltable>
492</section> 495</section>
493 496
494<section id="dmx_start"> 497<section id="DMX_START">
495<title>DMX_START</title> 498<title>DMX_START</title>
496<para>DESCRIPTION 499<para>DESCRIPTION
497</para> 500</para>
@@ -556,7 +559,7 @@ specified.
556 </row></tbody></tgroup></informaltable> 559 </row></tbody></tgroup></informaltable>
557</section> 560</section>
558 561
559<section id="dmx_stop"> 562<section id="DMX_STOP">
560<title>DMX_STOP</title> 563<title>DMX_STOP</title>
561<para>DESCRIPTION 564<para>DESCRIPTION
562</para> 565</para>
@@ -603,7 +606,7 @@ specified.
603 </row></tbody></tgroup></informaltable> 606 </row></tbody></tgroup></informaltable>
604</section> 607</section>
605 608
606<section id="dmx_set_filter"> 609<section id="DMX_SET_FILTER">
607<title>DMX_SET_FILTER</title> 610<title>DMX_SET_FILTER</title>
608<para>DESCRIPTION 611<para>DESCRIPTION
609</para> 612</para>
@@ -673,7 +676,7 @@ specified.
673 </row></tbody></tgroup></informaltable> 676 </row></tbody></tgroup></informaltable>
674</section> 677</section>
675 678
676<section id="dmx_set_pes_filter"> 679<section id="DMX_SET_PES_FILTER">
677<title>DMX_SET_PES_FILTER</title> 680<title>DMX_SET_PES_FILTER</title>
678<para>DESCRIPTION 681<para>DESCRIPTION
679</para> 682</para>
@@ -756,7 +759,7 @@ specified.
756 </row></tbody></tgroup></informaltable> 759 </row></tbody></tgroup></informaltable>
757</section> 760</section>
758 761
759<section id="dms_set_buffer_size"> 762<section id="DMX_SET_BUFFER_SIZE">
760<title>DMX_SET_BUFFER_SIZE</title> 763<title>DMX_SET_BUFFER_SIZE</title>
761<para>DESCRIPTION 764<para>DESCRIPTION
762</para> 765</para>
@@ -819,7 +822,7 @@ specified.
819 </row></tbody></tgroup></informaltable> 822 </row></tbody></tgroup></informaltable>
820</section> 823</section>
821 824
822<section id="dmx_get_event"> 825<section id="DMX_GET_EVENT">
823<title>DMX_GET_EVENT</title> 826<title>DMX_GET_EVENT</title>
824<para>DESCRIPTION 827<para>DESCRIPTION
825</para> 828</para>
@@ -899,7 +902,7 @@ specified.
899 </row></tbody></tgroup></informaltable> 902 </row></tbody></tgroup></informaltable>
900</section> 903</section>
901 904
902<section id="dmx_get_stc"> 905<section id="DMX_GET_STC">
903<title>DMX_GET_STC</title> 906<title>DMX_GET_STC</title>
904<para>DESCRIPTION 907<para>DESCRIPTION
905</para> 908</para>