← Back to branch summary

~ubuntu-branches/ubuntu/lucid/schroedinger/lucid

« back to all changes in this revision

Viewing changes to doc/xml/schrolimits.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2009-10-03 18:49:33 UTC
  • mfrom: (1.1.7 upstream) (6.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20091003184933-mmkb7rff1nblsq6m
Tags: 1.0.8-2
* debian/control:
  + Build-depend on pkg-config to fix FTBFS.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/schrolimits.xml
11
11
<refnamediv>
12
12
<refname>schrolimits</refname>
13
13
<refpurpose></refpurpose>
14
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
14
</refnamediv>
16
15
 
17
16
<refsynopsisdiv id="schroedinger-schrolimits.synopsis" role="synopsis">
18
17
<title role="synopsis.title">Synopsis</title>
19
18
 
20
19
<synopsis>
21
 
#define             <link linkend="SCHRO-LIMIT-WIDTH:CAPS">SCHRO_LIMIT_WIDTH</link>
22
 
#define             <link linkend="SCHRO-LIMIT-ENCODER-TRANSFORM-DEPTH:CAPS">SCHRO_LIMIT_ENCODER_TRANSFORM_DEPTH</link>
23
 
#define             <link linkend="SCHRO-LIMIT-FRAME-QUEUE-LENGTH:CAPS">SCHRO_LIMIT_FRAME_QUEUE_LENGTH</link>
24
 
#define             <link linkend="SCHRO-LIMIT-REFERENCE-FRAMES:CAPS">SCHRO_LIMIT_REFERENCE_FRAMES</link>
25
 
#define             <link linkend="SCHRO-LIMIT-SUBBANDS:CAPS">SCHRO_LIMIT_SUBBANDS</link>
26
 
#define             <link linkend="SCHRO-LIMIT-TRANSFORM-DEPTH:CAPS">SCHRO_LIMIT_TRANSFORM_DEPTH</link>
27
 
#define             <link linkend="SCHRO-LIMIT-BLOCK-SIZE:CAPS">SCHRO_LIMIT_BLOCK_SIZE</link>
28
 
#define             <link linkend="SCHRO-LIMIT-METRIC-SCAN:CAPS">SCHRO_LIMIT_METRIC_SCAN</link>
 
20
#define             <link linkend="SCHRO-LIMIT-WIDTH--CAPS">SCHRO_LIMIT_WIDTH</link>
 
21
#define             <link linkend="SCHRO-LIMIT-ENCODER-TRANSFORM-DEPTH--CAPS">SCHRO_LIMIT_ENCODER_TRANSFORM_DEPTH</link>
 
22
#define             <link linkend="SCHRO-LIMIT-FRAME-QUEUE-LENGTH--CAPS">SCHRO_LIMIT_FRAME_QUEUE_LENGTH</link>
 
23
#define             <link linkend="SCHRO-LIMIT-REFERENCE-FRAMES--CAPS">SCHRO_LIMIT_REFERENCE_FRAMES</link>
 
24
#define             <link linkend="SCHRO-LIMIT-SUBBANDS--CAPS">SCHRO_LIMIT_SUBBANDS</link>
 
25
#define             <link linkend="SCHRO-LIMIT-TRANSFORM-DEPTH--CAPS">SCHRO_LIMIT_TRANSFORM_DEPTH</link>
 
26
#define             <link linkend="SCHRO-LIMIT-BLOCK-SIZE--CAPS">SCHRO_LIMIT_BLOCK_SIZE</link>
 
27
#define             <link linkend="SCHRO-LIMIT-METRIC-SCAN--CAPS">SCHRO_LIMIT_METRIC_SCAN</link>
29
28
</synopsis>
30
29
</refsynopsisdiv>
31
30
 
40
39
<refsect1 id="schroedinger-schrolimits.description" role="desc">
41
40
<title role="desc.title">Description</title>
42
41
<para>
43
 
 
44
42
</para>
45
43
</refsect1>
46
44
 
47
45
<refsect1 id="schroedinger-schrolimits.details" role="details">
48
46
<title role="details.title">Details</title>
49
 
<refsect2 id="SCHRO-LIMIT-WIDTH:CAPS" role="macro">
 
47
<refsect2 id="SCHRO-LIMIT-WIDTH--CAPS" role="macro">
50
48
<title>SCHRO_LIMIT_WIDTH</title>
51
 
<indexterm zone="SCHRO-LIMIT-WIDTH:CAPS"><primary>SCHRO_LIMIT_WIDTH</primary></indexterm><programlisting>#define SCHRO_LIMIT_WIDTH 2048
 
49
<indexterm zone="SCHRO-LIMIT-WIDTH--CAPS"><primary sortas="SCHRO_LIMIT_WIDTH">SCHRO_LIMIT_WIDTH</primary></indexterm><programlisting>#define SCHRO_LIMIT_WIDTH 2048
52
50
</programlisting>
53
51
<para>
54
52
Maximum picture width.</para>
55
53
<para>
56
 
 
57
54
</para></refsect2>
58
 
<refsect2 id="SCHRO-LIMIT-ENCODER-TRANSFORM-DEPTH:CAPS" role="macro">
 
55
<refsect2 id="SCHRO-LIMIT-ENCODER-TRANSFORM-DEPTH--CAPS" role="macro">
59
56
<title>SCHRO_LIMIT_ENCODER_TRANSFORM_DEPTH</title>
60
 
<indexterm zone="SCHRO-LIMIT-ENCODER-TRANSFORM-DEPTH:CAPS"><primary>SCHRO_LIMIT_ENCODER_TRANSFORM_DEPTH</primary></indexterm><programlisting>#define SCHRO_LIMIT_ENCODER_TRANSFORM_DEPTH 6
 
57
<indexterm zone="SCHRO-LIMIT-ENCODER-TRANSFORM-DEPTH--CAPS"><primary sortas="SCHRO_LIMIT_ENCODER_TRANSFORM_DEPTH">SCHRO_LIMIT_ENCODER_TRANSFORM_DEPTH</primary></indexterm><programlisting>#define SCHRO_LIMIT_ENCODER_TRANSFORM_DEPTH 6
61
58
</programlisting>
62
59
<para>
63
60
The maximum transform depth that the encoder can handle.  Must be
64
61
less than SCHRO_LIMIT_TRANSFORM_DEPTH.</para>
65
62
<para>
66
 
 
67
63
</para></refsect2>
68
 
<refsect2 id="SCHRO-LIMIT-FRAME-QUEUE-LENGTH:CAPS" role="macro">
 
64
<refsect2 id="SCHRO-LIMIT-FRAME-QUEUE-LENGTH--CAPS" role="macro">
69
65
<title>SCHRO_LIMIT_FRAME_QUEUE_LENGTH</title>
70
 
<indexterm zone="SCHRO-LIMIT-FRAME-QUEUE-LENGTH:CAPS"><primary>SCHRO_LIMIT_FRAME_QUEUE_LENGTH</primary></indexterm><programlisting>#define SCHRO_LIMIT_FRAME_QUEUE_LENGTH 40
 
66
<indexterm zone="SCHRO-LIMIT-FRAME-QUEUE-LENGTH--CAPS"><primary sortas="SCHRO_LIMIT_FRAME_QUEUE_LENGTH">SCHRO_LIMIT_FRAME_QUEUE_LENGTH</primary></indexterm><programlisting>#define SCHRO_LIMIT_FRAME_QUEUE_LENGTH 40
71
67
</programlisting>
72
68
<para>
73
69
The maximum number of pictures being processed by the encoder.</para>
74
70
<para>
75
 
 
76
71
</para></refsect2>
77
 
<refsect2 id="SCHRO-LIMIT-REFERENCE-FRAMES:CAPS" role="macro">
 
72
<refsect2 id="SCHRO-LIMIT-REFERENCE-FRAMES--CAPS" role="macro">
78
73
<title>SCHRO_LIMIT_REFERENCE_FRAMES</title>
79
 
<indexterm zone="SCHRO-LIMIT-REFERENCE-FRAMES:CAPS"><primary>SCHRO_LIMIT_REFERENCE_FRAMES</primary></indexterm><programlisting>#define SCHRO_LIMIT_REFERENCE_FRAMES 8
 
74
<indexterm zone="SCHRO-LIMIT-REFERENCE-FRAMES--CAPS"><primary sortas="SCHRO_LIMIT_REFERENCE_FRAMES">SCHRO_LIMIT_REFERENCE_FRAMES</primary></indexterm><programlisting>#define SCHRO_LIMIT_REFERENCE_FRAMES 8
80
75
</programlisting>
81
76
<para>
82
77
The maximum number of active reference frames.  In the encoder,
83
78
the number of active reference frames may be much larger than in
84
79
the resulting stream.</para>
85
80
<para>
86
 
 
87
81
</para></refsect2>
88
 
<refsect2 id="SCHRO-LIMIT-SUBBANDS:CAPS" role="macro">
 
82
<refsect2 id="SCHRO-LIMIT-SUBBANDS--CAPS" role="macro">
89
83
<title>SCHRO_LIMIT_SUBBANDS</title>
90
 
<indexterm zone="SCHRO-LIMIT-SUBBANDS:CAPS"><primary>SCHRO_LIMIT_SUBBANDS</primary></indexterm><programlisting>#define SCHRO_LIMIT_SUBBANDS (1+3*SCHRO_LIMIT_TRANSFORM_DEPTH)
 
84
<indexterm zone="SCHRO-LIMIT-SUBBANDS--CAPS"><primary sortas="SCHRO_LIMIT_SUBBANDS">SCHRO_LIMIT_SUBBANDS</primary></indexterm><programlisting>#define SCHRO_LIMIT_SUBBANDS (1+3*SCHRO_LIMIT_TRANSFORM_DEPTH)
91
85
</programlisting>
92
86
<para>
93
87
The maximum number of subbands.</para>
94
88
<para>
95
 
 
96
89
</para></refsect2>
97
 
<refsect2 id="SCHRO-LIMIT-TRANSFORM-DEPTH:CAPS" role="macro">
 
90
<refsect2 id="SCHRO-LIMIT-TRANSFORM-DEPTH--CAPS" role="macro">
98
91
<title>SCHRO_LIMIT_TRANSFORM_DEPTH</title>
99
 
<indexterm zone="SCHRO-LIMIT-TRANSFORM-DEPTH:CAPS"><primary>SCHRO_LIMIT_TRANSFORM_DEPTH</primary></indexterm><programlisting>#define SCHRO_LIMIT_TRANSFORM_DEPTH 6
 
92
<indexterm zone="SCHRO-LIMIT-TRANSFORM-DEPTH--CAPS"><primary sortas="SCHRO_LIMIT_TRANSFORM_DEPTH">SCHRO_LIMIT_TRANSFORM_DEPTH</primary></indexterm><programlisting>#define SCHRO_LIMIT_TRANSFORM_DEPTH 6
100
93
</programlisting>
101
94
<para>
102
95
The maximum transform depth that the decoder can handle.</para>
103
96
<para>
104
 
 
105
97
</para></refsect2>
106
 
<refsect2 id="SCHRO-LIMIT-BLOCK-SIZE:CAPS" role="macro">
 
98
<refsect2 id="SCHRO-LIMIT-BLOCK-SIZE--CAPS" role="macro">
107
99
<title>SCHRO_LIMIT_BLOCK_SIZE</title>
108
 
<indexterm zone="SCHRO-LIMIT-BLOCK-SIZE:CAPS"><primary>SCHRO_LIMIT_BLOCK_SIZE</primary></indexterm><programlisting>#define SCHRO_LIMIT_BLOCK_SIZE 64
 
100
<indexterm zone="SCHRO-LIMIT-BLOCK-SIZE--CAPS"><primary sortas="SCHRO_LIMIT_BLOCK_SIZE">SCHRO_LIMIT_BLOCK_SIZE</primary></indexterm><programlisting>#define SCHRO_LIMIT_BLOCK_SIZE 64
109
101
</programlisting>
110
102
<para>
111
103
Maximum block size.  Both length and separation must be less than
112
104
or equal to this limit.</para>
113
105
<para>
114
 
 
115
106
</para></refsect2>
116
 
<refsect2 id="SCHRO-LIMIT-METRIC-SCAN:CAPS" role="macro">
 
107
<refsect2 id="SCHRO-LIMIT-METRIC-SCAN--CAPS" role="macro">
117
108
<title>SCHRO_LIMIT_METRIC_SCAN</title>
118
 
<indexterm zone="SCHRO-LIMIT-METRIC-SCAN:CAPS"><primary>SCHRO_LIMIT_METRIC_SCAN</primary></indexterm><programlisting>#define SCHRO_LIMIT_METRIC_SCAN 32
 
109
<indexterm zone="SCHRO-LIMIT-METRIC-SCAN--CAPS"><primary sortas="SCHRO_LIMIT_METRIC_SCAN">SCHRO_LIMIT_METRIC_SCAN</primary></indexterm><programlisting>#define SCHRO_LIMIT_METRIC_SCAN 32
119
110
</programlisting>
120
111
<para>
121
 
 
122
112
</para></refsect2>
123
113
 
124
114
</refsect1>