Browse Source

documentation: Update ilcomponents documentation to match latest firmware

popcornmix 5 years ago
parent
commit
030082b403
34 changed files with 3610 additions and 3937 deletions
  1. 39
    35
      documentation/ilcomponents/audio_capture.html
  2. 40
    40
      documentation/ilcomponents/audio_decode.html
  3. 45
    45
      documentation/ilcomponents/audio_encode.html
  4. 13
    13
      documentation/ilcomponents/audio_lowpower.html
  5. 45
    45
      documentation/ilcomponents/audio_mixer.html
  6. 23
    23
      documentation/ilcomponents/audio_processor.html
  7. 36
    36
      documentation/ilcomponents/audio_render.html
  8. 25
    25
      documentation/ilcomponents/audio_splitter.html
  9. 449
    405
      documentation/ilcomponents/camera.html
  10. 26
    26
      documentation/ilcomponents/clock.html
  11. 498
    498
      documentation/ilcomponents/doxygen.css
  12. 20
    12
      documentation/ilcomponents/egl_render.html
  13. 103
    101
      documentation/ilcomponents/image_decode.html
  14. 35
    33
      documentation/ilcomponents/image_encode.html
  15. 30
    30
      documentation/ilcomponents/image_fx.html
  16. 10
    10
      documentation/ilcomponents/image_read.html
  17. 9
    9
      documentation/ilcomponents/image_write.html
  18. 0
    3
      documentation/ilcomponents/index.html
  19. 23
    23
      documentation/ilcomponents/null_sink.html
  20. 1276
    1726
      documentation/ilcomponents/prop.html
  21. 134
    134
      documentation/ilcomponents/read_media.html
  22. 29
    29
      documentation/ilcomponents/resize.html
  23. 17
    17
      documentation/ilcomponents/source.html
  24. 105
    105
      documentation/ilcomponents/tabs.css
  25. 15
    15
      documentation/ilcomponents/text_scheduler.html
  26. 27
    27
      documentation/ilcomponents/transition.html
  27. 123
    101
      documentation/ilcomponents/video_decode.html
  28. 161
    119
      documentation/ilcomponents/video_encode.html
  29. 31
    29
      documentation/ilcomponents/video_render.html
  30. 25
    25
      documentation/ilcomponents/video_scheduler.html
  31. 50
    50
      documentation/ilcomponents/video_splitter.html
  32. 40
    40
      documentation/ilcomponents/visualisation.html
  33. 55
    55
      documentation/ilcomponents/write_media.html
  34. 53
    53
      documentation/ilcomponents/write_still.html

+ 39
- 35
documentation/ilcomponents/audio_capture.html View File

@@ -57,52 +57,56 @@
57 57
 </table></td>
58 58
 </tr></table><p>
59 59
 <p>
60
-This component interacts with platform-specific audio input devices to
61
-emit raw PCM samples. It can provide a media reference time to a clock
62
-component if connected. If used in this mode, the component will not
63
-output data when the clock is stopped, and will send media time
64
-updates to the clock by default. Time stamps will only reset once the
65
-component is transitioned to loaded. If the audio output port is
66
-executing with the capturing enabled when a connected clock is
67
-transitioned to stop, the component will stop recording data and
68
-transmit its next packet with no data but with the EOS flag set.
60
+This component interacts with platform-specific audio input devices to
61
+emit raw PCM samples. It can provide a media reference time to a clock
62
+component if connected. If used in this mode, the component will not
63
+output data when the clock is stopped, and will send media time
64
+updates to the clock by default. Time stamps will only reset once the
65
+component is transitioned to loaded. If the audio output port is
66
+executing with the capturing enabled when a connected clock is
67
+transitioned to stop, the component will stop recording data and
68
+transmit its next packet with no data but with the EOS flag set.
69 69
 <p>
70 70
 <p>
71 71
 <table border="1" cellspacing="0" cellpadding="2"><tr><td>Port<td>Index<td>Notes
72 72
 <tr valign="top"><td rowspan="6">180<td><tt>OMX_IndexParamPortDefinition</tt>
73
-<td><p>Query / set the port parameters for the audio output stream.  The
74
-  audio format must not be encoded. <tt>nBufferSize</tt> must be a
75
-  multiple of 4 and equal to or larger than 32 (the maximum buffer size
76
-  is limited by the platform-specific audio input device, but may be
77
-  16384). <tt>nBufferAlignment</tt> must be equal to or larger than 32.
73
+<td><p>Query / set the port parameters for the audio output stream.  The
74
+  audio format must not be encoded. <tt>nBufferSize</tt> must be a
75
+  multiple of 4 and equal to or larger than 32 (the maximum buffer size
76
+  is limited by the platform-specific audio input device, but may be
77
+  16384). <tt>nBufferAlignment</tt> must be equal to or larger than 32.
78 78
  <tr valign="top"><td><tt>OMX_IndexParamAudioPcm</tt>
79
-<td> Query / set the PCM format used.  <tt>nChannels</tt> will be 2.
80
-  <tt>eNumData</tt> will be <tt>OMX_NumericalDataSigned</tt>.
81
-  <tt>eEndian</tt> will be <tt>OMX_EndianLittle</tt>.  <tt>bInterleaved</tt>
82
-  will be <tt>OMX_TRUE</tt>.  <tt>nBitPerSample</tt> will be 16.
83
-  <tt>ePCMMode</tt> will be <tt>OMX_AUDIO_PCMModeLinear</tt>.
84
-  <tt>nSamplingRate</tt> can be set and defaults to 32000.
79
+<td> Query / set the PCM format used.  <tt>nChannels</tt> will be 2.
80
+  <tt>eNumData</tt> will be <tt>OMX_NumericalDataSigned</tt>.
81
+  <tt>eEndian</tt> will be <tt>OMX_EndianLittle</tt>.  <tt>bInterleaved</tt>
82
+  will be <tt>OMX_TRUE</tt>.  <tt>nBitPerSample</tt> will be 16.
83
+  <tt>ePCMMode</tt> will be <tt>OMX_AUDIO_PCMModeLinear</tt>.
84
+  <tt>nSamplingRate</tt> can be set and defaults to 32000.
85 85
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmAudioSource">OMX_IndexConfigBrcmAudioSource</a></tt>
86
-<td> Query / set the audio platform-specific source for audio input.
87
-  Currently only supported when the component is not capturing
88
-  audio.
86
+<td> Query / set the audio platform-specific source for audio input.
87
+  Currently only supported when the component is not capturing
88
+  audio.
89 89
  <tr valign="top"><td><tt>OMX_IndexConfigAudioVolume</tt>
90
-<td> Query / set the volume to be applying using a software scaling after
91
-  the audio samples have been initially read.
90
+<td> Query / set the volume to be applying using a software scaling after
91
+  the audio samples have been initially read.
92 92
  <tr valign="top"><td><tt>OMX_IndexConfigAudioMute</tt>
93
-<td> Query / set whether the audio is muted.
93
+<td> Query / set whether the audio is muted.
94 94
  <tr valign="top"><td><tt>OMX_IndexParamAudioPortFormat</tt>
95
-<td> Query / set the audio port format used on this port.  The port
96
-  supports PCM only.
97
- <tr valign="top"><td rowspan="2">181<td><tt>OMX_IndexParamPortDefinition</tt>
98
-<td> Query / set the port parameter to support connecting to a clock
99
-  component output port.
95
+<td> Query / set the audio port format used on this port.  The port
96
+  supports PCM only.
97
+ <tr valign="top"><td rowspan="2">182<td><tt>OMX_IndexParamPortDefinition</tt>
98
+<td> Query / set the port parameter to support connecting to a clock
99
+  component output port.
100 100
  <tr valign="top"><td><tt>OMX_IndexParamOtherPortFormat</tt>
101
-<td> Query / set the other port format used on this port.  The port
102
-  supports time format only.
101
+<td> Query / set the other port format used on this port.  The port
102
+  supports time format only.
103 103
  <tr valign="top"><td rowspan="1">&nbsp;<td><tt>OMX_IndexConfigCapturing</tt>
104
-<td> Query / set whether we are actively capturing audio data, subject to
105
-  the restrictions given about when connected to a clock component.
104
+<td> Query / set whether we are actively capturing audio data, subject to
105
+  the restrictions given about when connected to a clock component.
106
+ <p>N.B. Port 181 is used for audio events. It is defined as an audio
107
+  port (so that MMAL does not misclassify it as a clock port)
108
+  although it is really just a generic data port used to send
109
+  data of type AUDIOPLUS_EVENT_T.
106 110
  </table>
107 111
 
108 112
 </table>

+ 40
- 40
documentation/ilcomponents/audio_decode.html View File

@@ -57,70 +57,70 @@
57 57
 </table></td>
58 58
 </tr></table><p>
59 59
 <p>
60
-This conformant component accepts encoded audio in a number of
61
-different formats, and decodes it to emit raw PCM samples. This
62
-component will buffer encoded audio frames to provide protection
63
-against file system read latency when playing back, and protection
64
-against the media stream interleaving in the file format.
60
+This conformant component accepts encoded audio in a number of
61
+different formats, and decodes it to emit raw PCM samples. This
62
+component will buffer encoded audio frames to provide protection
63
+against file system read latency when playing back, and protection
64
+against the media stream interleaving in the file format.
65 65
 <p>
66 66
 <p>
67 67
 <table border="1" cellspacing="0" cellpadding="2"><tr><td>Port<td>Index<td>Notes
68 68
 <tr valign="top"><td rowspan="15">120<td><tt>OMX_IndexParamPortDefinition</tt>
69
-<td> Query / set the port parameters for the encoded audio stream.
69
+<td> Query / set the port parameters for the encoded audio stream.
70 70
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCodecConfig">OMX_IndexParamCodecConfig</a></tt>
71
-<td> Sets codec configuration data to be used.  These bytes may also be
72
-  supplied in a correctly flagged buffer.
71
+<td> Sets codec configuration data to be used.  These bytes may also be
72
+  supplied in a correctly flagged buffer.
73 73
  <tr valign="top"><td><tt>OMX_IndexParamAudioPcm</tt>
74
-<td> Query / set the properties of the encoded stream for PCM data.
74
+<td> Query / set the properties of the encoded stream for PCM data.
75 75
  <tr valign="top"><td><tt>OMX_IndexParamAudioMp3</tt>
76
-<td> Query / set the properties of the encoded stream for MP3 data.
76
+<td> Query / set the properties of the encoded stream for MP3 data.
77 77
  <tr valign="top"><td><tt>OMX_IndexParamAudioAac</tt>
78
-<td> Query / set the properties of the encoded stream for AAC data.
78
+<td> Query / set the properties of the encoded stream for AAC data.
79 79
  <tr valign="top"><td><tt>OMX_IndexParamAudioWma</tt>
80
-<td> Query / set the properties of the encoded stream for WMA data.
80
+<td> Query / set the properties of the encoded stream for WMA data.
81 81
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamAudioDdp">OMX_IndexParamAudioDdp</a></tt>
82
-<td> Query / set the properties of the encoded stream for Dolby Digital
83
-  (Plus) data.
82
+<td> Query / set the properties of the encoded stream for Dolby Digital
83
+  (Plus) data.
84 84
  <tr valign="top"><td><tt>OMX_IndexParamAudioVorbis</tt>
85
-<td> Query / set the properties of the encoded stream for Vorbis data.
85
+<td> Query / set the properties of the encoded stream for Vorbis data.
86 86
  <tr valign="top"><td><tt>OMX_IndexParamAudioRa</tt>
87
-<td> Query / set the properties of the encoded stream for Real Audio data.
87
+<td> Query / set the properties of the encoded stream for Real Audio data.
88 88
  <tr valign="top"><td><tt>OMX_IndexParamAudioAmr</tt>
89
-<td> Query / set the properties of the encoded stream for AMR data.
89
+<td> Query / set the properties of the encoded stream for AMR data.
90 90
  <tr valign="top"><td><tt>OMX_IndexParamAudioEvrc</tt>
91
-<td> Query / set the properties of the encoded stream for EVRC data.
91
+<td> Query / set the properties of the encoded stream for EVRC data.
92 92
  <tr valign="top"><td><tt>OMX_IndexParamAudioG726</tt>
93
-<td> Query / set the properties of the encoded stream for G726 data.
93
+<td> Query / set the properties of the encoded stream for G726 data.
94 94
  <tr valign="top"><td><tt>OMX_IndexParamAudioMidi</tt>
95
-<td> Query / set the properties of the encoded stream for MIDI data.
95
+<td> Query / set the properties of the encoded stream for MIDI data.
96 96
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamBrcmDataUnit">OMX_IndexParamBrcmDataUnit</a></tt>
97
-<td> Sets the data unit type of the input data.  A value of
98
-  <tt>OMX_DataUnitCodedPicture</tt> indicates that buffers contain at most
99
-  one frame and <tt>OMX_BUFFERFLAG_ENDOFFRAME</tt> is used.  A value of
100
-  <tt>OMX_DataUnitArbitraryStreamSection</tt> implies no guarantees on the
101
-  framing of input data.  Other values are not supported.
97
+<td> Sets the data unit type of the input data.  A value of
98
+  <tt>OMX_DataUnitCodedPicture</tt> indicates that buffers contain at most
99
+  one frame and <tt>OMX_BUFFERFLAG_ENDOFFRAME</tt> is used.  A value of
100
+  <tt>OMX_DataUnitArbitraryStreamSection</tt> implies no guarantees on the
101
+  framing of input data.  Other values are not supported.
102 102
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigAudioMonoTrackControl">OMX_IndexConfigAudioMonoTrackControl</a></tt>
103
-<td> Query / set the options for dual mono audio.
103
+<td> Query / set the options for dual mono audio.
104 104
  <tr valign="top"><td rowspan="3">121<td><tt>OMX_IndexParamPortDefinition</tt>
105
-<td> Query / set the port parameters for the decoded audio stream. Once the first 
106
-  packet has been successfully decoded, the port definition is populated to indicate 
107
-  that this port emits PCM data.
105
+<td> Query / set the port parameters for the decoded audio stream. Once the first 
106
+  packet has been successfully decoded, the port definition is populated to indicate 
107
+  that this port emits PCM data.
108 108
  <tr valign="top"><td><tt>OMX_IndexParamAudioPcm</tt>
109
-<td> Query the PCM format for the decoded audio stream. Once the first packet has been 
110
-  successfully decoded, the PCM mode type is populated to indicate the format of PCM 
111
-  output data. The PCM format cannot be changed as this component doesn't support PCM
112
-  format conversion.
109
+<td> Query the PCM format for the decoded audio stream. Once the first packet has been 
110
+  successfully decoded, the PCM mode type is populated to indicate the format of PCM 
111
+  output data. The PCM format cannot be changed as this component doesn't support PCM
112
+  format conversion.
113 113
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmAudioTrackGaplessPlayback">OMX_IndexConfigBrcmAudioTrackGaplessPlayback</a></tt>
114
-<td> Query encoder/decoder delay and padding information for gapless audio playback.
114
+<td> Query encoder/decoder delay and padding information for gapless audio playback.
115 115
  <tr valign="top"><td rowspan="2">120  121<td><tt>OMX_IndexParamAudioPortFormat</tt>
116
-<td> Query / set the audio port format used on this port.  The input port
117
-  supports a wide range of audio formats, the output port supports PCM
118
-  only.
116
+<td> Query / set the audio port format used on this port.  The input port
117
+  supports a wide range of audio formats, the output port supports PCM
118
+  only.
119 119
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamAudioDts">OMX_IndexParamAudioDts</a></tt>
120
-<td> Query / set the properties of the encoded stream for DTS data.
121
-  Supported on the output port for when pass through mode is enabled.
120
+<td> Query / set the properties of the encoded stream for DTS data.
121
+  Supported on the output port for when pass through mode is enabled.
122 122
  <tr valign="top"><td rowspan="1">&nbsp;<td><tt><a href="prop.html#OMX_IndexConfigBrcmDecoderPassThrough">OMX_IndexConfigBrcmDecoderPassThrough</a></tt>
123
-<td> Query / set the decoder pass-through mode (pass-through of encoded data)
123
+<td> Query / set the decoder pass-through mode (pass-through of encoded data)
124 124
  </table>
125 125
 
126 126
 </table>

+ 45
- 45
documentation/ilcomponents/audio_encode.html View File

@@ -57,64 +57,64 @@
57 57
 </table></td>
58 58
 </tr></table><p>
59 59
 <p>
60
-This conformant component accepts raw PCM audio samples, and can
61
-encode them using a number of formats to produce compressed audio
62
-frames. This component will buffer a small number of PCM samples to
63
-allow re-packetisation depending on the frame size of the encoded
64
-format. It also buffers encoded frames to allow for latency in the
65
-multiplexer file writing.
60
+This conformant component accepts raw PCM audio samples, and can
61
+encode them using a number of formats to produce compressed audio
62
+frames. This component will buffer a small number of PCM samples to
63
+allow re-packetisation depending on the frame size of the encoded
64
+format. It also buffers encoded frames to allow for latency in the
65
+multiplexer file writing.
66 66
 <p>
67 67
 <p>
68 68
 <table border="1" cellspacing="0" cellpadding="2"><tr><td>Port<td>Index<td>Notes
69 69
 <tr valign="top"><td rowspan="2">160<td><tt>OMX_IndexParamPortDefinition</tt>
70
-<td> Query / set the port parameter. Must be set to PCM audio.
70
+<td> Query / set the port parameter. Must be set to PCM audio.
71 71
  <tr valign="top"><td><tt>OMX_IndexParamAudioPcm</tt>
72
-<td> Query / set the port PCM format for the input port.
73
-  <tt>nChannels</tt> must be 1, 2, 4, or 8. 5.1 audio can be carried
74
-  inside 8 channels, with the last two channels advertise as blank.
75
-  <tt>nBitPerSample</tt> must be 16 or 32.
76
-  <tt>eNumData</tt> must be <tt>OMX_NumericalDataSigned</tt>.
77
-  <tt>eEndian</tt> must be <tt>OMX_EndianLittle</tt>.
78
-  <tt>bInterleaved</tt> must be <tt>OMX_TRUE</tt>.
79
-  <tt>ePCMMode</tt> must be <tt>OMX_AUDIO_PCMModeLinear</tt>.
72
+<td> Query / set the port PCM format for the input port.
73
+  <tt>nChannels</tt> must be 1, 2, 4, or 8. 5.1 audio can be carried
74
+  inside 8 channels, with the last two channels advertise as blank.
75
+  <tt>nBitPerSample</tt> must be 16 or 32.
76
+  <tt>eNumData</tt> must be <tt>OMX_NumericalDataSigned</tt>.
77
+  <tt>eEndian</tt> must be <tt>OMX_EndianLittle</tt>.
78
+  <tt>bInterleaved</tt> must be <tt>OMX_TRUE</tt>.
79
+  <tt>ePCMMode</tt> must be <tt>OMX_AUDIO_PCMModeLinear</tt>.
80 80
  <tr valign="top"><td rowspan="6">161<td><tt>OMX_IndexParamPortDefinition</tt>
81
-<td> Query / set the port parameter. The encoder to be used is specified by
82
-  setting the <tt>format.audio.eEncoding</tt> field.  When encoding
83
-  starts, if the maximum size of encoded frame is larger than the
84
-  <tt>nBufferSize</tt> value then the <tt>nBufferSize</tt> is increased to
85
-  this value and an <tt>OMX_EventPortSettingsChanged</tt> event is
86
-  signalled.
81
+<td> Query / set the port parameter. The encoder to be used is specified by
82
+  setting the <tt>format.audio.eEncoding</tt> field.  When encoding
83
+  starts, if the maximum size of encoded frame is larger than the
84
+  <tt>nBufferSize</tt> value then the <tt>nBufferSize</tt> is increased to
85
+  this value and an <tt>OMX_EventPortSettingsChanged</tt> event is
86
+  signalled.
87 87
  <tr valign="top"><td><tt>OMX_IndexParamAudioMp3</tt>
88
-<td> Query / set the MP3 parameters for the encoded bitstream. Only the
89
-  <tt>nBitRate</tt> and <tt>nChannels</tt> (must be 1 or 2) fields are 
90
-  considered; other parameters are copied through from the PCM input 
91
-  port.
88
+<td> Query / set the MP3 parameters for the encoded bitstream. Only the
89
+  <tt>nBitRate</tt> and <tt>nChannels</tt> (must be 1 or 2) fields are 
90
+  considered; other parameters are copied through from the PCM input 
91
+  port.
92 92
  <tr valign="top"><td><tt>OMX_IndexParamAudioAac</tt>
93
-<td> Query / set the AAC parameters for the encoded bitstream. The fields
94
-  <tt>nBitRate</tt>, <tt>eAACStreamFormat</tt>, <tt>nSampleRate</tt> and 
95
-  <tt>nChannels</tt> (must be 1 or 2) are respected; other parameters 
96
-  are copied through from the PCM input port. Stream formats supported 
97
-  are the default value of <tt>MP2ADTS</tt>, and <tt>RAW</tt>.
93
+<td> Query / set the AAC parameters for the encoded bitstream. The fields
94
+  <tt>nBitRate</tt>, <tt>eAACStreamFormat</tt>, <tt>nSampleRate</tt> and 
95
+  <tt>nChannels</tt> (must be 1 or 2) are respected; other parameters 
96
+  are copied through from the PCM input port. Stream formats supported 
97
+  are the default value of <tt>MP2ADTS</tt>, and <tt>RAW</tt>.
98 98
  <tr valign="top"><td><tt>OMX_IndexParamAudioAmr</tt>
99
-<td> Query / set the AMR parameters for the encoded bitstream.
100
-  The field <tt>nChannels</tt> must be 1 (mono).
99
+<td> Query / set the AMR parameters for the encoded bitstream.
100
+  The field <tt>nChannels</tt> must be 1 (mono).
101 101
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCodecConfig">OMX_IndexParamCodecConfig</a></tt>
102
-<td> Query for codec-specific information.
102
+<td> Query for codec-specific information.
103 103
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamBrcmDataUnit">OMX_IndexParamBrcmDataUnit</a></tt>
104
-<td> Query the type of data delivery for the encoded data.  This port emits
105
-  <tt>OMX_DataUnitCodedPicture</tt> format data.
104
+<td> Query the type of data delivery for the encoded data.  This port emits
105
+  <tt>OMX_DataUnitCodedPicture</tt> format data.
106 106
  <tr valign="top"><td rowspan="2">160  161<td><tt>OMX_IndexParamAudioPortFormat</tt>
107
-<td> Query / set the audio port format used on this port.  The input port
108
-  supports PCM only, the output port supports a number of encoded audio
109
-  formats.
107
+<td> Query / set the audio port format used on this port.  The input port
108
+  supports PCM only, the output port supports a number of encoded audio
109
+  formats.
110 110
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamILFifoConfig">OMX_IndexParamILFifoConfig</a></tt>
111
-<td> Set the internal fifo size for both input and output ports.  The input
112
-  port fifo is used to buffer enough PCM audio samples for the encoder
113
-  to consume a whole frame.  The output fifo needs to buffer enough
114
-  encoded frames to cope with variations of writing speed through the
115
-  filesystem.  Both input and output fifos will default to a sensible
116
-  size if this index is not set, the primary use for this index is in
117
-  testing.
111
+<td> Set the internal fifo size for both input and output ports.  The input
112
+  port fifo is used to buffer enough PCM audio samples for the encoder
113
+  to consume a whole frame.  The output fifo needs to buffer enough
114
+  encoded frames to cope with variations of writing speed through the
115
+  filesystem.  Both input and output fifos will default to a sensible
116
+  size if this index is not set, the primary use for this index is in
117
+  testing.
118 118
  </table>
119 119
 
120 120
 </table>

+ 13
- 13
documentation/ilcomponents/audio_lowpower.html View File

@@ -53,24 +53,24 @@
53 53
 </table></td>
54 54
 <td bgcolor="grey" border="1">audio_lowpower</td>  </tr></table><p>
55 55
 <p>
56
-This component accepts encoded audio in mp3 format, and decodes and
57
-plays it to an audio buffer driver.  It is designed for low power
58
-audio playback.  Input buffers can consist of multiple mp3 frames,
59
-there is no requirement to end a buffer on a frame boundary, providing
60
-the remainder of the frame is at the start of the next buffer.  The
61
-parsing is fairly tolerate of skipping extra data such as ID3 tags.
62
-Pausing the component will result in decoding pausing, but there is a
63
-relatively long decoded buffer to play out before audio output will
64
-pause.
56
+This component accepts encoded audio in mp3 format, and decodes and
57
+plays it to an audio buffer driver.  It is designed for low power
58
+audio playback.  Input buffers can consist of multiple mp3 frames,
59
+there is no requirement to end a buffer on a frame boundary, providing
60
+the remainder of the frame is at the start of the next buffer.  The
61
+parsing is fairly tolerate of skipping extra data such as ID3 tags.
62
+Pausing the component will result in decoding pausing, but there is a
63
+relatively long decoded buffer to play out before audio output will
64
+pause.
65 65
 <p>
66 66
 <p>
67 67
 <table border="1" cellspacing="0" cellpadding="2"><tr><td>Port<td>Index<td>Notes
68 68
 <tr valign="top"><td rowspan="2">270<td><tt>OMX_IndexParamPortDefinition</tt>
69
-<td> Query / set the port parameters for the encoded audio stream.
70
-  <tt>nBufferSize</tt> must be at least 32768.  <tt>nBufferCountActual</tt>
71
-  defaults to 10, but can be set to any positive number.
69
+<td> Query / set the port parameters for the encoded audio stream.
70
+  <tt>nBufferSize</tt> must be at least 32768.  <tt>nBufferCountActual</tt>
71
+  defaults to 10, but can be set to any positive number.
72 72
  <tr valign="top"><td><tt>OMX_IndexParamAudioPortFormat</tt>
73
-<td> Query / set the audio port format.  Currently only mp3 is supported.
73
+<td> Query / set the audio port format.  Currently only mp3 is supported.
74 74
  </table>
75 75
 
76 76
 </table>

+ 45
- 45
documentation/ilcomponents/audio_mixer.html View File

@@ -61,70 +61,70 @@
61 61
 </table></td>
62 62
 </tr></table><p>
63 63
 <p>
64
-The conformant audio_mixer component accepts raw PCM audio frames from
65
-enabled input ports sums these onto frames emitted from the output
66
-port.
64
+The conformant audio_mixer component accepts raw PCM audio frames from
65
+enabled input ports sums these onto frames emitted from the output
66
+port.
67 67
 <p>
68
-If necessary, input data is converted to match the PCM configuration of the output port at 
69
-the mixdown stage (see the supported PCM formats). The mixer will perform sampling rate 
70
-conversions, bitrate scaling and channel downmixing. However, at the moment, downmixing
71
-from 8 channels to 4 channels is not supported and only stereo input can be resampled (SW-3833).
68
+If necessary, input data is converted to match the PCM configuration of the output port at 
69
+the mixdown stage (see the supported PCM formats). The mixer will perform sampling rate 
70
+conversions, bitrate scaling and channel downmixing. However, at the moment, downmixing
71
+from 8 channels to 4 channels is not supported and only stereo input can be resampled (SW-3833).
72 72
 <p>
73
-The mixer provides a clock input port that can be used to ensure constant rate 
74
-output regardless of input ports that fail to provide buffers in time to keep up
75
-with the output port frame rate.
73
+The mixer provides a clock input port that can be used to ensure constant rate 
74
+output regardless of input ports that fail to provide buffers in time to keep up
75
+with the output port frame rate.
76 76
 <p>
77
-The mixer output port can buffer up mixed output to be used for gapless and crossfaded 
78
-audio track changes between input ports.
77
+The mixer output port can buffer up mixed output to be used for gapless and crossfaded 
78
+audio track changes between input ports.
79 79
 <p>
80 80
 <p>
81 81
 <table border="1" cellspacing="0" cellpadding="2"><tr><td>Port<td>Index<td>Notes
82 82
 <tr valign="top"><td rowspan="4">231  232  233  234  235<td><tt>OMX_IndexParamPortDefinition</tt>
83
-<td> Query / set the port parameters for the audio input/output streams. 
84
-  The audio format must not be encoded. <tt>nBufferSize</tt> must be a multiple 
85
-  of 32 and and equal to or larger than 1024. <tt>nBufferAlignment</tt> must be 
86
-  equal to or larger than 32.
83
+<td> Query / set the port parameters for the audio input/output streams. 
84
+  The audio format must not be encoded. <tt>nBufferSize</tt> must be a multiple 
85
+  of 32 and and equal to or larger than 1024. <tt>nBufferAlignment</tt> must be 
86
+  equal to or larger than 32.
87 87
  <tr valign="top"><td><tt>OMX_IndexParamAudioPcm</tt>
88
-<td> <tt>nChannels</tt> must be 1, 2, 4, or 8. 5.1 audio can be carried
89
-  inside 8 channels, with the last two channels advertised as blank.
90
-  <tt>eNumData</tt> must be <tt>OMX_NumericalDataSigned</tt>.
91
-  <tt>eEndian</tt> must be <tt>OMX_EndianLittle</tt>.
92
-  <tt>bInterleaved</tt> must be <tt>OMX_TRUE</tt>.
93
-  <tt>nBitPerSample</tt> must be 16 or 32.
94
-  <tt>nSamplingRate</tt> must be less or equal to 96000.
95
-  <tt>ePCMMode</tt> must be <tt>OMX_AUDIO_PCMModeLinear</tt>.
88
+<td> <tt>nChannels</tt> must be 1, 2, 4, or 8. 5.1 audio can be carried
89
+  inside 8 channels, with the last two channels advertised as blank.
90
+  <tt>eNumData</tt> must be <tt>OMX_NumericalDataSigned</tt>.
91
+  <tt>eEndian</tt> must be <tt>OMX_EndianLittle</tt>.
92
+  <tt>bInterleaved</tt> must be <tt>OMX_TRUE</tt>.
93
+  <tt>nBitPerSample</tt> must be 16 or 32.
94
+  <tt>nSamplingRate</tt> must be less or equal to 96000.
95
+  <tt>ePCMMode</tt> must be <tt>OMX_AUDIO_PCMModeLinear</tt>.
96 96
  <tr valign="top"><td><tt>OMX_IndexParamAudioPortFormat</tt>
97
-<td> Query / set the audio port used on the port.  Audio ports currently
98
-  only support PCM format audio.
97
+<td> Query / set the audio port used on the port.  Audio ports currently
98
+  only support PCM format audio.
99 99
  <tr valign="top"><td><tt>OMX_IndexConfigAudioMute</tt>
100
-<td> Query / set the mute status of the port.
100
+<td> Query / set the mute status of the port.
101 101
  <tr valign="top"><td rowspan="4">232  233  234  235<td><tt>OMX_IndexConfigAudioVolume</tt>
102
-<td> Query / set the volume control for the input ports. This controls the 
103
-  software volume scaling that occurs prior to mixdown.
102
+<td> Query / set the volume control for the input ports. This controls the 
103
+  software volume scaling that occurs prior to mixdown.
104 104
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmAudioTrackChangeControl">OMX_IndexConfigBrcmAudioTrackChangeControl</a></tt>
105
-<td> Configure a gapless or an overlapping crossfaded track change from one input
106
-  port to another using the output buffering mechanism in the mixer.
105
+<td> Configure a gapless or an overlapping crossfaded track change from one input
106
+  port to another using the output buffering mechanism in the mixer.
107 107
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmAudioTrackChangeCount">OMX_IndexConfigBrcmAudioTrackChangeCount</a></tt>
108
-<td> Query the number of times the port has completed a track change. A track change
109
-  is complete for an input port when a buffer flagged with <tt>OMX_BUFFERFLAG_EOS</tt> 
110
-  has been fully mixed into output port buffers as is ready to be returned or flushed
111
-  from the input port. This configuration value can be monitored via 
112
-  <tt>OMX_IndexConfigRequestCallback</tt>.
108
+<td> Query the number of times the port has completed a track change. A track change
109
+  is complete for an input port when a buffer flagged with <tt>OMX_BUFFERFLAG_EOS</tt> 
110
+  has been fully mixed into output port buffers as is ready to be returned or flushed
111
+  from the input port. This configuration value can be monitored via 
112
+  <tt>OMX_IndexConfigRequestCallback</tt>.
113 113
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigRequestCallback">OMX_IndexConfigRequestCallback</a></tt>
114
-<td> Set whether we enable a callback to the client when the value of an index 
115
-  structure changes.  Only supported for the index <tt>OMX_IndexConfigBrcmAudioTrackChangeCount</tt>.
114
+<td> Set whether we enable a callback to the client when the value of an index 
115
+  structure changes.  Only supported for the index <tt>OMX_IndexConfigBrcmAudioTrackChangeCount</tt>.
116 116
  <tr valign="top"><td rowspan="2">230<td><tt>OMX_IndexParamPortDefinition</tt>
117
-<td> Query / set the port parameter for the clock port.  Only the number of
118
-  buffers can be modified on this port.
117
+<td> Query / set the port parameter for the clock port.  Only the number of
118
+  buffers can be modified on this port.
119 119
  <tr valign="top"><td><tt>OMX_IndexParamOtherPortFormat</tt>
120
-<td> Query / set the port format for this clock port.  This port currently
121
-  only supports the time format.
120
+<td> Query / set the port format for this clock port.  This port currently
121
+  only supports the time format.
122 122
  <tr valign="top"><td rowspan="1">&nbsp;<td><tt><a href="prop.html#OMX_IndexConfigBrcmMinimumProcessingLatency">OMX_IndexConfigBrcmMinimumProcessingLatency</a></tt>
123
-<td> Query/set the difference between the actual media time and when the
124
-  mixer receives request fulfillments for media time requests.
123
+<td> Query/set the difference between the actual media time and when the
124
+  mixer receives request fulfillments for media time requests.
125 125
  </table>
126 126
 
127
-
127
+
128 128
 </table>
129 129
 </body>
130 130
 </html>

+ 23
- 23
documentation/ilcomponents/audio_processor.html View File

@@ -57,39 +57,39 @@
57 57
 </table></td>
58 58
 </tr></table><p>
59 59
 <p>
60
-The conformant audio_processor component accepts raw PCM audio from
61
-the input port, passes it through an audio effect or an equalization
62
-stage and forwards it to the output port.
60
+The conformant audio_processor component accepts raw PCM audio from
61
+the input port, passes it through an audio effect or an equalization
62
+stage and forwards it to the output port.
63 63
 <p>
64 64
 <p>
65 65
 <table border="1" cellspacing="0" cellpadding="2"><tr><td>Port<td>Index<td>Notes
66 66
 <tr valign="top"><td rowspan="3">300  301<td><tt>OMX_IndexParamPortDefinition</tt>
67
-<td> Query / set the port parameters for the audio input/output streams. 
68
-  The audio format must not be encoded. code{nBufferSize} must be a multiple 
69
-  of 32 and and equal to or larger than 1024. <tt>nBufferAlignment</tt> must be 
70
-  equal to or larger than 32.
67
+<td> Query / set the port parameters for the audio input/output streams. 
68
+  The audio format must not be encoded. code{nBufferSize} must be a multiple 
69
+  of 32 and and equal to or larger than 1024. <tt>nBufferAlignment</tt> must be 
70
+  equal to or larger than 32.
71 71
  <tr valign="top"><td><tt>OMX_IndexParamAudioPcm</tt>
72
-<td> Query / set the port PCM format (read-only for the output port).
73
-  <tt>nChannels</tt> must be 1, 2, 4, or 8. 5.1 audio can be carried
74
-  inside 8 channels, with the last two channels advertise as blank.
75
-  <tt>eNumData</tt> must be <tt>OMX_NumericalDataSigned</tt>.
76
-  <tt>eEndian</tt> must be <tt>OMX_EndianLittle</tt>.
77
-  <tt>bInterleaved</tt> must be <tt>OMX_TRUE</tt>.
78
-  <tt>nBitPerSample</tt> must be 16 or 32.
79
-  <tt>nSamplingRate</tt> must be less or equal to 96000.
80
-  <tt>ePCMMode</tt> must be <tt>OMX_AUDIO_PCMModeLinear</tt>.
72
+<td> Query / set the port PCM format (read-only for the output port).
73
+  <tt>nChannels</tt> must be 1, 2, 4, or 8. 5.1 audio can be carried
74
+  inside 8 channels, with the last two channels advertise as blank.
75
+  <tt>eNumData</tt> must be <tt>OMX_NumericalDataSigned</tt>.
76
+  <tt>eEndian</tt> must be <tt>OMX_EndianLittle</tt>.
77
+  <tt>bInterleaved</tt> must be <tt>OMX_TRUE</tt>.
78
+  <tt>nBitPerSample</tt> must be 16 or 32.
79
+  <tt>nSamplingRate</tt> must be less or equal to 96000.
80
+  <tt>ePCMMode</tt> must be <tt>OMX_AUDIO_PCMModeLinear</tt>.
81 81
  <tr valign="top"><td><tt>OMX_IndexParamAudioPortFormat</tt>
82
-<td> Query / set audio port format used on this port.  These ports
83
-  support PCM only.
82
+<td> Query / set audio port format used on this port.  These ports
83
+  support PCM only.
84 84
  <tr valign="top"><td rowspan="2">301<td><tt>OMX_IndexConfigAudioEqualizer</tt>
85
-<td> Query / set audio equalizer properties or enable / disable 
86
-  equalizer effect.
85
+<td> Query / set audio equalizer properties or enable / disable 
86
+  equalizer effect.
87 87
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmAudioEffectControl">OMX_IndexConfigBrcmAudioEffectControl</a></tt>
88
-<td> Query / set audio processing plugin properties or enable / disable
89
-  the plugin.
88
+<td> Query / set audio processing plugin properties or enable / disable
89
+  the plugin.
90 90
  </table>
91 91
 
92
-
92
+
93 93
 </table>
94 94
 </body>
95 95
 </html>

+ 36
- 36
documentation/ilcomponents/audio_render.html View File

@@ -54,60 +54,60 @@
54 54
 </table></td>
55 55
 <td bgcolor="grey" border="1">audio_render</td>  </tr></table><p>
56 56
 <p>
57
-This conformant component accepts raw PCM audio, and outputs this data
58
-using platform-specific audio output devices. Control of these
59
-platform-specific devices is outside the scope of IL. By default, when 
60
-connected to a clock component, it will act as a clock reference. The 
61
-time scale of the clock is respected, and when not normal speed no audio
62
-will be played and no reference times will be advertised to the clock.
57
+This conformant component accepts raw PCM audio, and outputs this data
58
+using platform-specific audio output devices. Control of these
59
+platform-specific devices is outside the scope of IL. By default, when 
60
+connected to a clock component, it will act as a clock reference. The 
61
+time scale of the clock is respected, and when not normal speed no audio
62
+will be played and no reference times will be advertised to the clock.
63 63
 <p>
64 64
 <p>
65 65
 <table border="1" cellspacing="0" cellpadding="2"><tr><td>Port<td>Index<td>Notes
66 66
 <tr valign="top"><td rowspan="10">100<td><tt>OMX_IndexParamPortDefinition</tt>
67
-<td> Supports setting the port to PCM or DDP data.
67
+<td> Supports setting the port to PCM or DDP data.
68 68
  <tr valign="top"><td><tt>OMX_IndexParamAudioPortFormat</tt>
69
-<td> Supports setting the port format to PCM unencoded audio, or DDP
70
-  encoded data.
69
+<td> Supports setting the port format to PCM unencoded audio, or DDP
70
+  encoded data.
71 71
  <tr valign="top"><td><tt>OMX_IndexParamAudioPcm</tt>
72
-<td> <tt>nChannels</tt> must be 1, 2, 4, or 8. 5.1 audio can be carried
73
-  inside 8 channels, with the last two channels advertise as blank.
74
-  <tt>eNumData</tt> must be <tt>OMX_NumericalDataSigned</tt>.
75
-  <tt>eEndian</tt> must be <tt>OMX_EndianLittle</tt>.
76
-  <tt>bInterleaved</tt> must be <tt>OMX_TRUE</tt>.
77
-  <tt>nBitPerSample</tt> must be 16 or 32.
78
-  <tt>nSamplingRate</tt> must be greater than or equal to 8000 but
79
-  less than or equal to 96000.
80
-  <tt>ePCMMode</tt> must be <tt>OMX_AUDIO_PCMModeLinear</tt>.
72
+<td> <tt>nChannels</tt> must be 1, 2, 4, or 8. 5.1 audio can be carried
73
+  inside 8 channels, with the last two channels advertise as blank.
74
+  <tt>eNumData</tt> must be <tt>OMX_NumericalDataSigned</tt>.
75
+  <tt>eEndian</tt> must be <tt>OMX_EndianLittle</tt>.
76
+  <tt>bInterleaved</tt> must be <tt>OMX_TRUE</tt>.
77
+  <tt>nBitPerSample</tt> must be 16 or 32.
78
+  <tt>nSamplingRate</tt> must be greater than or equal to 8000 but
79
+  less than or equal to 192000.
80
+  <tt>ePCMMode</tt> must be <tt>OMX_AUDIO_PCMModeLinear</tt>.
81 81
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamAudioDdp">OMX_IndexParamAudioDdp</a></tt>
82
-<td> Query / set the DDP format of this port.
83
-  <tt>nSamplingRate</tt> must be 32000, 44100 or 48000.
82
+<td> Query / set the DDP format of this port.
83
+  <tt>nSamplingRate</tt> must be 32000, 44100 or 48000.
84 84
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamAudioDts">OMX_IndexParamAudioDts</a></tt>
85
-<td> Query / set the DTS format of this port.
85
+<td> Query / set the DTS format of this port.
86 86
  <tr valign="top"><td><tt>OMX_IndexConfigAudioVolume</tt>
87
-<td> Query / set the volume control. This currently controls the software
88
-  volume that occurs prior to mixing in the platform audio output.
87
+<td> Query / set the volume control. This currently controls the software
88
+  volume that occurs prior to mixing in the platform audio output.
89 89
  <tr valign="top"><td><tt>OMX_IndexConfigAudioMute</tt>
90
-<td> Query / set the mute status of the audio output.
90
+<td> Query / set the mute status of the audio output.
91 91
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmAudioDestination">OMX_IndexConfigBrcmAudioDestination</a></tt>
92
-<td> Query / set the audio platform-specific destination for audio output.
92
+<td> Query / set the audio platform-specific destination for audio output.
93 93
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigAudioRenderingLatency">OMX_IndexConfigAudioRenderingLatency</a></tt>
94
-<td> Query the current audio rendering delay in samples.
94
+<td> Query the current audio rendering delay in samples.
95 95
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigLatencyTarget">OMX_IndexConfigLatencyTarget</a></tt>
96
-<td> Query / set the filter values used when tracking audio rendering latency
97
-  by changing the clock speed.
96
+<td> Query / set the filter values used when tracking audio rendering latency
97
+  by changing the clock speed.
98 98
  <tr valign="top"><td rowspan="3">101<td><tt>OMX_IndexParamPortDefinition</tt>
99
-<td> Supports connecting to a port on a clock component.
99
+<td> Supports connecting to a port on a clock component.
100 100
  <tr valign="top"><td><tt>OMX_IndexParamOtherPortFormat</tt>
101
-<td> Supports setting the port format to time format.
101
+<td> Supports setting the port format to time format.
102 102
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigPresentationOffset">OMX_IndexConfigPresentationOffset</a></tt>
103
-<td> Sets custom presentation offset, used to adjust the audio video sync
104
-  offset.
103
+<td> Sets custom presentation offset, used to adjust the audio video sync
104
+  offset.
105 105
  <tr valign="top"><td rowspan="2">&nbsp;<td><tt><a href="prop.html#OMX_IndexConfigBrcmClockReferenceSource">OMX_IndexConfigBrcmClockReferenceSource</a></tt>
106
-<td> Query / set whether (when connected to a clock component) this component 
107
-  acts as a clock master (default behaviour) or as a clock slave scheduling 
108
-  the presentation of audio packets based on the media time reference.
106
+<td> Query / set whether (when connected to a clock component) this component 
107
+  acts as a clock master (default behaviour) or as a clock slave scheduling 
108
+  the presentation of audio packets based on the media time reference.
109 109
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmGlobalAudioMute">OMX_IndexConfigBrcmGlobalAudioMute</a></tt>
110
-<td> Query / set the audio platform-specific mute status of the audio output.
110
+<td> Query / set the audio platform-specific mute status of the audio output.
111 111
  </table>
112 112
 
113 113
 </table>

+ 25
- 25
documentation/ilcomponents/audio_splitter.html View File

@@ -61,43 +61,43 @@
61 61
 </table></td>
62 62
 </tr></table><p>
63 63
 <p>
64
-The conformant audio_splitter component accepts audio frames and
65
-forwards these onto enabled output ports.  The audio input port should
66
-be configured with the correct port and PCM settings, and then
67
-enabled.  At this point the port and PCM settings are copied to all
68
-output ports and a port settings changed message is sent on all output
69
-ports.
64
+The conformant audio_splitter component accepts audio frames and
65
+forwards these onto enabled output ports.  The audio input port should
66
+be configured with the correct port and PCM settings, and then
67
+enabled.  At this point the port and PCM settings are copied to all
68
+output ports and a port settings changed message is sent on all output
69
+ports.
70 70
 <p>
71
-This component has basic functionality, but is more a placeholder for
72
-future development.  Plans for the future include providing logic to
73
-discard data on output ports that fail to provide a buffer to accept
74
-the data within a reasonable timeframe, provided a clock is connected.
75
-There is some support for output ports having different buffer sizes
76
-than the input port, but this is not yet fully available to an IL
77
-client.
71
+This component has basic functionality, but is more a placeholder for
72
+future development.  Plans for the future include providing logic to
73
+discard data on output ports that fail to provide a buffer to accept
74
+the data within a reasonable timeframe, provided a clock is connected.
75
+There is some support for output ports having different buffer sizes
76
+than the input port, but this is not yet fully available to an IL
77
+client.
78 78
 <p>
79 79
 <p>
80 80
 <table border="1" cellspacing="0" cellpadding="2"><tr><td>Port<td>Index<td>Notes
81 81
 <tr valign="top"><td rowspan="1">260<td><tt>OMX_IndexParamPortDefinition</tt>
82
-<td> Query / set the port parameters for the clock port.  Currently this
83
-  port is not advertised so should not be used.
82
+<td> Query / set the port parameters for the clock port.  Currently this
83
+  port is not advertised so should not be used.
84 84
  <tr valign="top"><td rowspan="2">261<td><tt>OMX_IndexParamPortDefinition</tt>
85
-<td> Query / set the port parameters for the audio input stream, which must
86
-  be PCM non-encoded audio.  <tt>nBufferSize</tt> must be at least 256 and
87
-  defaults to 32768, and must be a multiple of 32.
88
-  <tt>nBufferAlignment</tt> must be at least 32.
85
+<td> Query / set the port parameters for the audio input stream, which must
86
+  be PCM non-encoded audio.  <tt>nBufferSize</tt> must be at least 256 and
87
+  defaults to 32768, and must be a multiple of 32.
88
+  <tt>nBufferAlignment</tt> must be at least 32.
89 89
  <tr valign="top"><td><tt>OMX_IndexParamAudioPcm</tt>
90
-<td> Query / set the PCM parameters of the audio input stream.
90
+<td> Query / set the PCM parameters of the audio input stream.
91 91
  <tr valign="top"><td rowspan="2">262  263  264  265<td><tt>OMX_IndexParamPortDefinition</tt>
92
-<td> Query the port parameters for output ports.  
92
+<td> Query the port parameters for output ports.  
93 93
  <tr valign="top"><td><tt>OMX_IndexParamAudioPcm</tt>
94
-<td> Query the PCM parameters of the audio output stream.  
94
+<td> Query the PCM parameters of the audio output stream.  
95 95
  <tr valign="top"><td rowspan="1">261  262  263  264  265<td><tt>OMX_IndexParamAudioPortFormat</tt>
96
-<td> Query / set the port format used on audio ports.  Currently this
97
-  component only supports raw PCM on all audio ports.
96
+<td> Query / set the port format used on audio ports.  Currently this
97
+  component only supports raw PCM on all audio ports.
98 98
  </table>
99 99
 
100
-
100
+
101 101
 </table>
102 102
 </body>
103 103
 </html>

+ 449
- 405
documentation/ilcomponents/camera.html View File

@@ -59,527 +59,571 @@
59 59
 </table></td>
60 60
 </tr></table><p>
61 61
 <p>
62
-This conformant component interfaces to platform-specific camera
63
-hardware, and produces raw YUV images. It has a clock input port for
64
-correctly assigning timestamps to frames.
62
+This conformant component interfaces to platform-specific camera
63
+hardware, and produces raw YUV images. It has a clock input port for
64
+correctly assigning timestamps to frames.
65 65
 <p>
66
-The preview port, 70, will emit video images whenever the component is
67
-in the executing state and the port is not disabled. The video capture port,
68
-71, will emit images only when the capturing configuration parameter
69
-<tt>OMX_IndexConfigPortCapturing</tt> is set for that port, and either 
70
-the clock port is disabled or the connected clock is in the Running state.
66
+The preview port, 70, will emit video images whenever the component is
67
+in the executing state and the port is not disabled. The video capture port,
68
+71, will emit images only when the capturing configuration parameter
69
+<tt>OMX_IndexConfigPortCapturing</tt> is set for that port, and either
70
+the clock port is disabled or the connected clock is in the Running state.
71 71
 <p>
72
-Due to limitations in the current underlying layers, it is not
73
-currently possible to emit the same frame at multiple
74
-resolutions. This means that to obtain both preview and video capture images
75
-simultaneously, the two ports must be at the same resolution and of
76
-the same image format. If they are different, the capture port takes
77
-precedence, and no images will be emitted from the preview port.
72
+Due to limitations in the current underlying layers, it is not
73
+currently possible to emit the same frame at multiple
74
+resolutions. This means that to obtain both preview and video capture images
75
+simultaneously, the two ports must be at the same resolution and of
76
+the same image format. If they are different, the capture port takes
77
+precedence, and no images will be emitted from the preview port.
78 78
 <p>
79
-If port 71 is executing when a connected clock is transitioned to stop
80
-the component will stop recording data at the end of the current
81
-image, and then transmit a packet with no data but with the EOS flag
82
-set.
79
+If port 71 is executing when a connected clock is transitioned to stop
80
+the component will stop recording data at the end of the current
81
+image, and then transmit a packet with no data but with the EOS flag
82
+set.
83 83
 <p>
84
-Port 72 is for still image captures only.
85
-This uses a second instance of Camplus and will grab the Bayer input
86
-image from the primary Camplus instance, and then process it in the
87
-background. The primary Camplus may resume viewfinder operation
88
-dependent on configuration and memory being available in the input pool.
89
-The port will only capture an image when the port is executing and 
90
-<tt>OMX_IndexConfigPortCapturing</tt> is set for the port. 
91
-If the bOneShot flag is set, an EOS will be emited from the port 
92
-after each complete capture.
84
+Port 72 is for still image captures only.
85
+This uses a second instance of Camplus and will grab the Bayer input
86
+image from the primary Camplus instance, and then process it in the
87
+background. The primary Camplus may resume viewfinder operation
88
+dependent on configuration and memory being available in the input pool.
89
+The port will only capture an image when the port is executing and
90
+<tt>OMX_IndexConfigPortCapturing</tt> is set for the port.
91
+If the bOneShot flag is set, an EOS will be emitted from the port
92
+after each complete capture.
93 93
 <p>
94
-The video ports will emit images in
95
-<tt>OMX_COLOR_FormatYUV420PackedPlanar</tt> or
96
-<tt>OMX_COLOR_FormatYUV420PackedSemiPlanar</tt> or
97
-<tt>OMX_COLOR_FormatYUV422PackedPlanar</tt> format, unless configured
98
-for proprietary tunnelling to a Broadcom component supporting the
99
-OMX_IndexParamImagePoolDisplayFunction callback, or
100
-OMX_IndexParamCameraPoolToEncoderFunction callback, in
101
-which case images can be provided in Broadcom-specific format.
94
+The video ports will emit images in
95
+<tt>OMX_COLOR_FormatYUV420PackedPlanar</tt>,
96
+<tt>OMX_COLOR_FormatYUV420PackedSemiPlanar</tt>,
97
+<tt>OMX_COLOR_FormatYUV422PackedPlanar</tt>,
98
+<tt>OMX_COLOR_FormatYCbYCr</tt>,
99
+<tt>OMX_COLOR_FormatYCrYCb</tt>,
100
+<tt>OMX_COLOR_FormatCbYCrY</tt>, or
101
+<tt>OMX_COLOR_FormatCrYCbY</tt>, format, unless configured
102
+for proprietary tunnelling to a Broadcom component supporting the
103
+OMX_IndexParamImagePoolDisplayFunction callback, or
104
+OMX_IndexParamCameraPoolToEncoderFunction callback, in
105
+which case images can be provided in Broadcom-specific format.
102 106
 <p>
103
-In order to optimise loading of relevant drivers, the recommended
104
-initialisation sequence is:
105
-<ul>
106
-<li> Create component.
107
-<li> Use <tt>OMX_IndexConfigRequestCallback</tt> to request callbacks on
108
-<tt>OMX_IndexParamCameraDeviceNumber</tt>.
109
-<li> Set <tt>OMX_IndexParamISPTunerName</tt>.
110
-<li> Set <tt>OMX_IndexParamCameraFlashType</tt>.
111
-<li> Set <tt>OMX_IndexParamCameraDeviceNumber</tt>.
112
-<li> Wait for the callback that <tt>OMX_IndexParamCameraDeviceNumber</tt> has
113
-changed. At this point, all the drivers have been loaded. Other settings
114
-can be applied whilst waiting for this event.
115
-<li> Query for <tt>OMX_IndexConfigCameraSensorModes</tt> as required.
116
-<li> Change state to IDLE, and proceed as required.
117
-</ul>
118
-The component should function as instructed if this sequence is not
119
-adhered to, but unnecessary drivers and/or tuners may be loaded and then
120
-unloaded, extending the startup latency.
107
+In order to optimise loading of relevant drivers, the recommended
108
+initialisation sequence is:
109
+<ul>
110
+<li> Create component.
111
+<li> Use <tt>OMX_IndexConfigRequestCallback</tt> to request callbacks on
112
+<tt>OMX_IndexParamCameraDeviceNumber</tt>.
113
+<li> Set <tt>OMX_IndexParamISPTunerName</tt>.
114
+<li> Set <tt>OMX_IndexParamCameraFlashType</tt>.
115
+<li> Set <tt>OMX_IndexParamCameraDeviceNumber</tt>.
116
+<li> Wait for the callback that <tt>OMX_IndexParamCameraDeviceNumber</tt> has
117
+changed. At this point, all the drivers have been loaded. Other settings
118
+can be applied whilst waiting for this event.
119
+<li> Query for <tt>OMX_IndexConfigCameraSensorModes</tt> as required.
120
+<li> Change state to IDLE, and proceed as required.
121
+</ul>
122
+The component should function as instructed if this sequence is not
123
+adhered to, but unnecessary drivers and/or tuners may be loaded and then
124
+unloaded, extending the startup latency.
121 125
 <p>
122 126
 <p>
123 127
 <table border="1" cellspacing="0" cellpadding="2"><tr><td>Port<td>Index<td>Notes
124
-<tr valign="top"><td rowspan="87">&nbsp;<td><tt>OMX_IndexParamCommonSensorMode</tt>
125
-<td> Query / set the camera sensor mode. When setting this parameter, only
126
-  bOneShot is used. It will return the actual sensor resolution when
127
-  queried (as per the OMX specification)
128
+<tr valign="top"><td rowspan="98">&nbsp;<td><tt>OMX_IndexParamCommonSensorMode</tt>
129
+<td> Query / set the camera sensor mode. When setting this parameter, only
130
+  bOneShot is used. It will return the actual sensor resolution when
131
+  queried (as per the OMX specification)
128 132
  <tr valign="top"><td><tt>OMX_IndexConfigCommonDigitalZoom</tt>
129
-<td> Query / set the digital zoom factor. The zoomed rectangle is always
130
-  taken from the centre of the image.
133
+<td> Query / set the digital zoom factor. The zoomed rectangle is always
134
+  taken from the centre of the image.
131 135
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigPortCapturing">OMX_IndexConfigPortCapturing</a></tt>
132
-<td> Query / set whether images are to be emitted on the specified port or
133
-  not. Changing to enabling capture when the component is not executing
134
-  will reset the internal counter used for time stamping frames when not
135
-  connected to a clock component.
136
+<td> Query / set whether images are to be emitted on the specified port or
137
+  not. Changing to enabling capture when the component is not executing
138
+  will reset the internal counter used for time stamping frames when not
139
+  connected to a clock component.
136 140
  <tr valign="top"><td><tt>OMX_IndexConfigCapturing</tt>
137
-<td> This index is deprecated and should no longer be used. 
138
-  Use <tt>OMX_IndexConfigPortCapturing</tt> instead.
141
+<td> This index is deprecated and should no longer be used.
142
+  Use <tt>OMX_IndexConfigPortCapturing</tt> instead.
139 143
  <tr valign="top"><td><tt>OMX_IndexAutoPauseAfterCapture</tt>
140
-<td> Query / set option to pause the component after the capture bit has
141
-  been cleared (either by the client or due to the bOneShot flag in
142
-  <tt>OMX_IndexParamCommonSensorMode</tt>)
144
+<td> Query / set option to pause the component after the capture bit has
145
+  been cleared (either by the client or due to the bOneShot flag in
146
+  <tt>OMX_IndexParamCommonSensorMode</tt>)
143 147
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraCamplusId">OMX_IndexParamCameraCamplusId</a></tt>
144
-<td> Query / set the identifier to use with the Broadcom Camplus library
145
-  used by this component.
148
+<td> Query / set the identifier to use with the Broadcom Camplus library
149
+  used by this component.
146 150
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraDeviceNumber">OMX_IndexParamCameraDeviceNumber</a></tt>
147
-<td> Camera device number. Query / set the camera number (as defined by the Videocore make system) to be
148
-  used by this camera component. When set, the value will be checked to ensure that
149
-  the camera number specified is defined for the platform.
150
-  Setting this parameter also triggers loading of the relevant drivers to speed up
151
-  queries for <tt>OMX_IndexConfigCameraSensorModes</tt>, which require the drivers to be loaded.
152
-  This parameter is supported by <tt>OMX_IndexConfigRequestCallback</tt>, so the client can be
153
-  notified once that driver is loaded, rather than having to poll the settings.
151
+<td> Camera device number. Query / set the camera number (as defined by the Videocore make system) to be
152
+  used by this camera component. When set, the value will be checked to ensure that
153
+  the camera number specified is defined for the platform.
154
+  Setting this parameter also triggers loading of the relevant drivers to speed up
155
+  queries for <tt>OMX_IndexConfigCameraSensorModes</tt>, which require the drivers to be loaded.
156
+  This parameter is supported by <tt>OMX_IndexConfigRequestCallback</tt>, so the client can be
157
+  notified once that driver is loaded, rather than having to poll the settings.
154 158
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraDevicesPresent">OMX_IndexParamCameraDevicesPresent</a></tt>
155
-<td> Query the camera devices defined for this platform. The result is a bitmask
156
-  indicating which cameras ahve been detected.
159
+<td> Query the camera devices defined for this platform. The result is a bitmask
160
+  indicating which cameras have been detected.
157 161
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamISPTunerName">OMX_IndexParamISPTunerName</a></tt>
158
-<td> ISP tuner name. Allow the client to query / set the name of the camera tuner module to be
159
-  used by Camplus. If tuner_name is a null string, the default tuner
160
-  for the camera module is loaded.
161
-  It is recommended that this parameter is set before <tt>OMX_IndexParamCameraDeviceNumber</tt>
162
-  to avoid reloading the CDI and default tuner.
162
+<td> ISP tuner name. Allow the client to query / set the name of the camera tuner module to be
163
+  used by Camplus. If tuner_name is a null string, the default tuner
164
+  for the camera module is loaded.
165
+  It is recommended that this parameter is set before <tt>OMX_IndexParamCameraDeviceNumber</tt>
166
+  to avoid reloading the CDI and default tuner.
163 167
  <tr valign="top"><td><tt>OMX_IndexConfigCommonFrameStabilisation</tt>
164
-<td> Query / set the state of the image stabilisation function of the
165
-  camera (NB the image will be automatically zoomed by approx 10% to
166
-  allow the stabilisation alogrithm space to operate in)
168
+<td> Query / set the state of the image stabilisation function of the
169
+  camera (NB the image will be automatically zoomed by approx 10% to
170
+  allow the stabilisation algorithm space to operate in)
167 171
  <tr valign="top"><td><tt>OMX_IndexConfigCommonExposure</tt>
168
-<td> Query / set the exposure mode for the camera.
172
+<td> Query / set the exposure mode for the camera.
169 173
  <tr valign="top"><td><tt>OMX_IndexConfigCommonExposureValue</tt>
170
-<td> Query / set the exposure parameters for the camera
174
+<td> Query / set the exposure parameters for the camera
171 175
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraImagePool">OMX_IndexParamCameraImagePool</a></tt>
172
-<td> Set the image pool parameters for to be used by the components. This
173
-  allows a client to specifies the size, type, and number of images in each 
174
-  pool. By default the sizes are left as 0 so the size is determined by 
175
-  <tt>OMX_IndexParamPortMaxFrameSize</tt>. The number of images in each pool is always
176
-  determined by the settings in this parameter.
176
+<td> Set the image pool parameters for to be used by the components. This
177
+  allows a client to specifies the size, type, and number of images in each
178
+  pool. By default the sizes are left as 0 so the size is determined by
179
+  <tt>OMX_IndexParamPortMaxFrameSize</tt>. The number of images in each pool is always
180
+  determined by the settings in this parameter.
177 181
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraISPOutputPoolHeight">OMX_IndexConfigCameraISPOutputPoolHeight</a></tt>
178
-<td> Set the height of the high-resolution output image in stills capture only.
179
-  The component will copy out of this image into OMX buffers as required, or
180
-  pass pointers to stripes within the buffer. If the height of this buffer is
181
-  less than nFrameHeight for a port, then attempts to use
182
-  <tt>OMX_IndexParamImagePoolDisplayFunction</tt>, or
183
-  <tt>OMX_IndexParamCameraPoolToEncoderFunction</tt> will be rejected as the
184
-  complete frame isn't available.  A value of 0 is interpreted as
185
-  allocate full frames.
186
-  The value must be a multiple of 16.
182
+<td> Set the height of the high-resolution output image in stills capture only.
183
+  The component will copy out of this image into OMX buffers as required, or
184
+  pass pointers to stripes within the buffer. If the height of this buffer is
185
+  less than nFrameHeight for a port, then attempts to use
186
+  <tt>OMX_IndexParamImagePoolDisplayFunction</tt>, or
187
+  <tt>OMX_IndexParamCameraPoolToEncoderFunction</tt> will be rejected as the
188
+  complete frame isn't available.  A value of 0 is interpreted as
189
+  allocate full frames.
190
+  The value must be a multiple of 16.
187 191
  <tr valign="top"><td><tt>OMX_IndexConfigFocusControl</tt>
188
-<td> Query/set the focus mode.
192
+<td> Query/set the focus mode.
189 193
  <tr valign="top"><td><tt>OMX_IndexConfigCommonFocusStatus</tt>
190
-<td> Query the focus position, and the state of the auto/manual focus
191
-  operations.
194
+<td> Query the focus position, and the state of the auto/manual focus
195
+  operations.
192 196
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamImagePoolExternal">OMX_IndexParamImagePoolExternal</a></tt>
193
-<td> Allows pointers to external image pools to be passed in to the
194
-  component to be used for image capture. <tt>image_pool</tt> is used as
195
-  the ISP high resolution image pool, <tt>image_pool2</tt> as the ISP low
196
-  res pool, <tt>image_pool3</tt> as the input pool, <tt>image_pool3</tt> as the 
197
-  high res stills pool, and <tt>image_pool5</tt> as the stills input pool. 
198
-  If being used, all five must be valid image pools. If not, all five must 
199
-  be <tt>NULL</tt>, the default, which causes the component to allocate pools 
200
-  when active.
197
+<td> Allows pointers to external image pools to be passed in to the
198
+  component to be used for image capture. <tt>image_pool</tt> is used as
199
+  the ISP high resolution image pool, <tt>image_pool2</tt> as the ISP low
200
+  res pool, <tt>image_pool3</tt> as the input pool, <tt>image_pool3</tt> as the
201
+  high res stills pool, and <tt>image_pool5</tt> as the stills input pool.
202
+  If being used, all five must be valid image pools. If not, all five must
203
+  be <tt>NULL</tt>, the default, which causes the component to allocate pools
204
+  when active.
201 205
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmCameraStats">OMX_IndexConfigBrcmCameraStats</a></tt>
202
-<td> Camera frame statistics. Allows the Camplus frame counts for number of frames produced and dropped
203
-  to be read by the client. These counts get reset whenever a new mode is
204
-  requested from Camplus. Additional knowledge of when this occurs is required
205
-  to obtain meaningful results from this config.
206
+<td> Camera frame statistics. Allows the Camplus frame counts for number of frames produced and dropped
207
+  to be read by the client. These counts get reset whenever a new mode is
208
+  requested from Camplus. Additional knowledge of when this occurs is required
209
+  to obtain meaningful results from this config.
206 210
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraSwapImagePools">OMX_IndexParamCameraSwapImagePools</a></tt>
207
-<td> Swap over image pools. Configures the camera component to swap over the two image pools when
208
-  in stills capture mode. The behind this logic being that the viewfinder
209
-  high res images and the capture low res images are approximately the same
210
-  size, and the viewfinder low res images and the capture high res circular
211
-  output buffer are approximately the same size.
212
-  DO NOT USE WITH PARALLEL CAPTURE, AS POOL ALLOCATIONS ALREADY TAKE THIS INTO ACCOUNT
211
+<td> Swap over image pools. Configures the camera component to swap over the two image pools when
212
+  in stills capture mode. The behind this logic being that the viewfinder
213
+  high res images and the capture low res images are approximately the same
214
+  size, and the viewfinder low res images and the capture high res circular
215
+  output buffer are approximately the same size.
216
+  DO NOT USE WITH PARALLEL CAPTURE, AS POOL ALLOCATIONS ALREADY TAKE THIS INTO ACCOUNT
213 217
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraSingleBufferCaptureInput">OMX_IndexParamCameraSingleBufferCaptureInput</a></tt>
214
-<td> Save memory by using a single input buffer. Configures the camera
215
-  component to switch to a single input buffer when capturing, therefore
216
-  saving the memory requirement of having two full resolution bayer
217
-  input buffers to store the input images.
218
+<td> Save memory by using a single input buffer. Configures the camera
219
+  component to switch to a single input buffer when capturing, therefore
220
+  saving the memory requirement of having two full resolution bayer
221
+  input buffers to store the input images.
218 222
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCommonRedEyeRemoval">OMX_IndexConfigCommonRedEyeRemoval</a></tt>
219
-<td> Red eye reduction/removal configuration. Configures the red eye
220
-  reduction algorithm in the camera processing pipeline. The stage is
221
-  only enabled if the flash mode is not FlashOff.  The
222
-  <tt>OMX_RedEyeRemovalSimple</tt> mode requests that the algorithm uses a
223
-  reduced complexity algorithm to reduce the processing time.
223
+<td> Red eye reduction/removal configuration. Configures the red eye
224
+  reduction algorithm in the camera processing pipeline. The stage is
225
+  only enabled if the flash mode is not FlashOff.  The
226
+  <tt>OMX_RedEyeRemovalSimple</tt> mode requests that the algorithm uses a
227
+  reduced complexity algorithm to reduce the processing time.
224 228
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraSensorModes">OMX_IndexConfigCameraSensorModes</a></tt>
225
-<td> Query the image sensor modes supported by the selected CDI. This will
226
-  return the number of modes supported, and allow to iteratively query
227
-  for them.
228
-  If the CDI is not available, then the error <tt>OMX_ErrorNotReady</tt> will be
229
-  returned. It is the responsibility of the client to delay and retry the
230
-  request.
229
+<td> Query the image sensor modes supported by the selected CDI. This will
230
+  return the number of modes supported, and allow to iteratively query
231
+  for them.
232
+  If the CDI is not available, then the error <tt>OMX_ErrorNotReady</tt> will be
233
+  returned. It is the responsibility of the client to delay and retry the
234
+  request.
231 235
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCommonSharpness">OMX_IndexConfigCommonSharpness</a></tt>
232
-<td> Image sharpening.  Query / set the sharpening/softening of the output
233
-  image.  -100 = max softening. 0 = no change. +100 = max sharpening.
236
+<td> Image sharpening.  Query / set the sharpening/softening of the output
237
+  image.  -100 = max softening. 0 = no change. +100 = max sharpening.
234 238
  <tr valign="top"><td><tt>OMX_IndexConfigCommonContrast</tt>
235
-<td> Query / set the contrast. As per the OMX-IL 1.1.1 spec, the range is
236
-  -100 to 100, with 0 indicating no change.
239
+<td> Query / set the contrast. As per the OMX-IL 1.1.1 spec, the range is
240
+  -100 to 100, with 0 indicating no change.
237 241
  <tr valign="top"><td><tt>OMX_IndexConfigCommonBrightness</tt>
238
-<td> Query / set the brightness. As per the OMX-IL 1.1.1 spec, the range is
239
-  +0 to 100, representing 0 to 100%.
242
+<td> Query / set the brightness. As per the OMX-IL 1.1.1 spec, the range is
243
+  +0 to 100, representing 0 to 100%.
240 244
  <tr valign="top"><td><tt>OMX_IndexConfigCommonSaturation</tt>
241
-<td> Query / set the image saturation. As per the OMX-IL 1.1.1 spec, the range is
242
-  -100 to 100, with 0 indicating no change, -100 will result in a completely
243
-  black image, and 100 will result in a completely white image.
244
-  This setting is ignored if <tt>OMX_IndexConfigCommonColorEnhancement</tt> is enabled.
245
+<td> Query / set the image saturation. As per the OMX-IL 1.1.1 spec, the range is
246
+  -100 to 100, with 0 indicating no change, -100 will result in a completely
247
+  black image, and 100 will result in a completely white image.
248
+  This setting is ignored if <tt>OMX_IndexConfigCommonColorEnhancement</tt> is enabled.
245 249
  <tr valign="top"><td><tt>OMX_IndexConfigCommonColorEnhancement</tt>
246
-<td> Query / set the values with which to fill the U and V planes of the output
247
-  image. This feature overrides any saturation settings when enabled. The
248
-  change is made within the ISP, so postprocessor software stages will not
249
-  have any colour data to work with. Use of functions such as red eye reduction
250
-  when colour enhancement is active may produce indeterminate results.
250
+<td> Query / set the values with which to fill the U and V planes of the output
251
+  image. This feature overrides any saturation settings when enabled. The
252
+  change is made within the ISP, so postprocessor software stages will not
253
+  have any colour data to work with. Use of functions such as red eye reduction
254
+  when colour enhancement is active may produce indeterminate results.
251 255
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCommonFlickerCancellation">OMX_IndexConfigCommonFlickerCancellation</a></tt>
252
-<td> Query / set the flicker cancellation frequency. Values are defined for Off,
253
-  50Hz, 60Hz, or auto. The method for auto detecting the flicker frequency is
254
-  not defined, and currently results in the feature being turned off.
256
+<td> Query / set the flicker cancellation frequency. Values are defined for Off,
257
+  50Hz, 60Hz, or auto. The method for auto detecting the flicker frequency is
258
+  not defined, and currently results in the feature being turned off.
255 259
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigInputCropPercentages">OMX_IndexConfigInputCropPercentages</a></tt>
256
-<td> Set crop region seen by ISP. Query / set the region of the input image
257
-  that will be cropped before being processed by the ISP. It is
258
-  specified as a fraction of the input width and height, expressed as a
259
-  16p16 value.
260
+<td> Set crop region seen by ISP. Query / set the region of the input image
261
+  that will be cropped before being processed by the ISP. It is
262
+  specified as a fraction of the input width and height, expressed as a
263
+  16p16 value.
260 264
  <tr valign="top"><td><tt>OMX_IndexConfigCommonWhiteBalance</tt>
261
-<td> Query / set the auto white balance operating mode.
265
+<td> Query / set the auto white balance operating mode.
262 266
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigStillsAntiShakeEnable">OMX_IndexConfigStillsAntiShakeEnable</a></tt>
263
-<td> Query / set the state of the antishake function of the camera.
267
+<td> Query / set the state of the antishake function of the camera.
264 268
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigStillColourDenoiseEnable">OMX_IndexConfigStillColourDenoiseEnable</a></tt>
265
-<td> Configure still colour denoise. Query / set the state of the still
266
-  colour denoise function of the camera. This is only applicable whilst
267
-  doing a stills capture in YUV422 or YUV420 planar format.
269
+<td> Configure still colour denoise. Query / set the state of the still
270
+  colour denoise function of the camera. This is only applicable whilst
271
+  doing a stills capture in YUV422 or YUV420 planar format.
268 272
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigVideoColourDenoiseEnable">OMX_IndexConfigVideoColourDenoiseEnable</a></tt>
269
-<td> Configure video colour denoise. Query / set the state of the video
270
-  colour denoising function of the camera. This is only applicable
271
-  whilst the camera is producing images in the Broadcom-specific format
272
-  or YUV420.
273
+<td> Configure video colour denoise. Query / set the state of the video
274
+  colour denoising function of the camera. This is only applicable
275
+  whilst the camera is producing images in the Broadcom-specific format
276
+  or YUV420.
273 277
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigTemporalDenoiseEnable">OMX_IndexConfigTemporalDenoiseEnable</a></tt>
274
-<td> Configure temporal denoise. Query / set the state of the temporal
275
-  denoising function of the camera. This is only applicable
276
-  whilst the camera is producing images in the Broadcom-specific format
277
-  or YUV420.
278
+<td> Configure temporal denoise. Query / set the state of the temporal
279
+  denoising function of the camera. This is only applicable
280
+  whilst the camera is producing images in the Broadcom-specific format
281
+  or YUV420.
278 282
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCommonFaceDetectionControl">OMX_IndexConfigCommonFaceDetectionControl</a></tt>
279
-<td> Face detection. Query / set the state of the face detection algorithm.
280
-  Will return <tt>OMX_ErrorUnsupportedIndex</tt> if the algorithm is not loaded.
283
+<td> Face detection. Query / set the state of the face detection algorithm.
284
+  Will return <tt>OMX_ErrorUnsupportedIndex</tt> if the algorithm is not loaded.
281 285
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigDrawBoxAroundFaces">OMX_IndexConfigDrawBoxAroundFaces</a></tt>
282
-<td> Draw boxes around faces. Query / set the state of adding boxes around
283
-  the faces detected in the viewfinder frames.
286
+<td> Draw boxes around faces. Query / set the state of adding boxes around
287
+  the faces detected in the viewfinder frames.
284 288
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigDrawBoxLineParams">OMX_IndexConfigDrawBoxLineParams</a></tt>
285
-<td> Face box style parameters. Query / set the parameters for the box to
286
-  be drawn around faces/focus regions.
289
+<td> Face box style parameters. Query / set the parameters for the box to
290
+  be drawn around faces/focus regions.
287 291
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCommonFaceDetectionRegion">OMX_IndexConfigCommonFaceDetectionRegion</a></tt>
288
-<td> Face detection output. Query the currently detected face regions
289
-  within the viewfinder image.  Will return
290
-  <tt>OMX_ErrorUnsupportedIndex</tt> if the algorithm is not loaded.
292
+<td> Face detection output. Query the currently detected face regions
293
+  within the viewfinder image.  Will return
294
+  <tt>OMX_ErrorUnsupportedIndex</tt> if the algorithm is not loaded.
291 295
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigAFAssistLight">OMX_IndexConfigAFAssistLight</a></tt>
292
-<td> Query / set the mode for the Auto focus assist light. It is
293
-  assumed that the platform supports such a feature.
296
+<td> Query / set the mode for the Auto focus assist light. It is
297
+  assumed that the platform supports such a feature.
294 298
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigSmartShakeReductionEnable">OMX_IndexConfigSmartShakeReductionEnable</a></tt>
295
-<td> Smart Shake Reduction (SSR). Query / set the state of the Smart Shake
296
-  Reduction function.  Will return <tt>OMX_ErrorUnsupportedIndex</tt> if the
297
-  algorithm is not loaded.
299
+<td> Smart Shake Reduction (SSR). Query / set the state of the Smart Shake
300
+  Reduction function.  Will return <tt>OMX_ErrorUnsupportedIndex</tt> if the
301
+  algorithm is not loaded.
298 302
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigWaitForFocusBeforeCapture">OMX_IndexConfigWaitForFocusBeforeCapture</a></tt>
299
-<td> Wait for focus before capture. Query / set whether the camera
300
-  component will ensure that the camera module has reported the lens
301
-  back at the focused position before stopping capturing with the
302
-  OneShot flag set. This may lead to multiple complete images being
303
-  emitted from the capture port, and any receiving component/client
304
-  should be prepared for this.
303
+<td> Wait for focus before capture. Query / set whether the camera
304
+  component will ensure that the camera module has reported the lens
305
+  back at the focused position before stopping capturing with the
306
+  OneShot flag set. This may lead to multiple complete images being
307
+  emitted from the capture port, and any receiving component/client
308
+  should be prepared for this.
305 309
  <tr valign="top"><td><tt>OMX_IndexConfigCommonImageFilter</tt>
306
-<td> Query / select image effects to be applied to the viewfinder and capture images
310
+<td> Query / select image effects to be applied to the viewfinder and capture images
307 311
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCommonImageFilterParameters">OMX_IndexConfigCommonImageFilterParameters</a></tt>
308
-<td> Query / set optional parameters for the selected image filter.
312
+<td> Query / set optional parameters for the selected image filter.
309 313
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigPrivacyIndicator">OMX_IndexConfigPrivacyIndicator</a></tt>
310
-<td> Query / set whether the privacy indicator light should be switched on
311
-  whenever the component is capturing. The indicator used depends on the
312
-  capabilities of the flash driver selected.
314
+<td> Query / set whether the privacy indicator light should be switched on
315
+  whenever the component is capturing. The indicator used depends on the
316
+  capabilities of the flash driver selected.
313 317
  <tr valign="top"><td><tt>OMX_IndexParamFlashControl</tt>
314
-<td> Query / set the flash control, which controls the basic mode of flash operation.
318
+<td> Query / set the flash control, which controls the basic mode of flash operation.
315 319
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraFlashType">OMX_IndexParamCameraFlashType</a></tt>
316
-<td> Query / set which type of flash (xenon/LED) to use if flash is requested. Changing
317
-  this value requires the drivers to be reloaded, so it is recommended this is set
318
-  before setting <tt>OMX_IndexParamCameraDeviceNumber</tt>.
320
+<td> Query / set which type of flash (xenon/LED) to use if flash is requested. Changing
321
+  this value requires the drivers to be reloaded, so it is recommended this is set
322
+  before setting <tt>OMX_IndexParamCameraDeviceNumber</tt>.
319 323
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraFlashConfig">OMX_IndexConfigCameraFlashConfig</a></tt>
320
-<td> Query / set the flags to use to modify the flash algorithm.
324
+<td> Query / set the flags to use to modify the flash algorithm.
321 325
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigFlashChargeLevel">OMX_IndexConfigFlashChargeLevel</a></tt>
322
-<td> Query the charge level of the currently selected flash device. This is updated at the
323
-  start of every frame.
326
+<td> Query the charge level of the currently selected flash device. This is updated at the
327
+  start of every frame.
324 328
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraEnableStatsPass">OMX_IndexConfigCameraEnableStatsPass</a></tt>
325
-<td> Query / set whether a separate stats pass should be done before each capture.
326
-  This will be done automatically if flash is requested.
329
+<td> Query / set whether a separate stats pass should be done before each capture.
330
+  This will be done automatically if flash is requested.
327 331
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCaptureRawImageURI">OMX_IndexConfigCaptureRawImageURI</a></tt>
328
-<td> Configure filename for raw Bayer image. Query / set whether the
329
-  filename to which the raw Bayer format image should be written out to
330
-  file. Follows the standard URI structure.  Can NOT be set when the
331
-  capture bit is set and the capture port is executing.  Will return
332
-  <tt>OMX_ErrorUnsupportedIndex</tt> if the algorithm is not loaded.
332
+<td> Configure filename for raw Bayer image. Query / set whether the
333
+  filename to which the raw Bayer format image should be written out to
334
+  file. Follows the standard URI structure.  Can NOT be set when the
335
+  capture bit is set and the capture port is executing.  Will return
336
+  <tt>OMX_ErrorUnsupportedIndex</tt> if the algorithm is not loaded.
333 337
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraIsoReferenceValue">OMX_IndexConfigCameraIsoReferenceValue</a></tt>
334
-<td> Allows the client to obtain the ISO reference for unity analogue gain.
338
+<td> Allows the client to obtain the ISO reference for unity analogue gain.
335 339
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraCaptureAbortsAutoFocus">OMX_IndexConfigCameraCaptureAbortsAutoFocus</a></tt>
336
-<td> Starting a capture aborts AF. Query / set whether setting the capture
337
-  bit will abort any AF cycle that is in progress, or if the AF cycle
338
-  should continue and the capture happen automatically on completion.
340
+<td> Starting a capture aborts AF. Query / set whether setting the capture
341
+  bit will abort any AF cycle that is in progress, or if the AF cycle
342
+  should continue and the capture happen automatically on completion.
339 343
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraDisableAlgorithm">OMX_IndexParamCameraDisableAlgorithm</a></tt>
340
-<td> Disabling processing stages. This allows optional processing stages to
341
-  be totally disabled, and hence not loaded when the component is taken
342
-  from Loaded to Idle.
344
+<td> Disabling processing stages. This allows optional processing stages to
345
+  be totally disabled, and hence not loaded when the component is taken
346
+  from Loaded to Idle.
343 347
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraCaptureEventFunction">OMX_IndexParamCameraCaptureEventFunction</a></tt>
344
-<td> Allows a VideoCore callback function to be registered to be used as
345
-  an indication of when a capture is being started. This will not work over ILCS.
346
- <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraUseCase">OMX_IndexParamCameraUseCase</a></tt>
347
-<td> Camera use case. Query / set the use case to be passed into the tuner
348
-  module.
348
+<td> Allows a VideoCore callback function to be registered to be used as
349
+  an indication of when a capture is being started. This will not work over ILCS.
350
+ <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraUseCase">OMX_IndexConfigCameraUseCase</a></tt>
351
+<td> Camera use case. Query / set the use case to be passed into the tuner
352
+  module.
349 353
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraInputFrame">OMX_IndexConfigCameraInputFrame</a></tt>
350
-<td> This parameter allows a Videocore component to obtain the pointer
351
-  for the camera input frame (typically Bayer). For debug use only,
352
-  and will not work over ILCS.
354
+<td> This parameter allows a Videocore component to obtain the pointer
355
+  for the camera input frame (typically Bayer). For debug use only,
356
+  and will not work over ILCS.
353 357
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamDynamicParameterFile">OMX_IndexParamDynamicParameterFile</a></tt>
354
-<td> Specify a dynamic parameter file to use or not. If a file is to be used,
355
-  <tt>OMX_IndexParamUseDynamicParameterFile</tt> must be set.
358
+<td> Specify a dynamic parameter file to use or not. If a file is to be used,
359
+  <tt>OMX_IndexParamUseDynamicParameterFile</tt> must be set.
356 360
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamUseDynamicParameterFile">OMX_IndexParamUseDynamicParameterFile</a></tt>
357
-<td> Specify whether we wish to load the DPF file.
361
+<td> Specify whether we wish to load the DPF file.
362
+  The filename is set with <tt>OMX_IndexParamDynamicParameterFile</tt>.
358 363
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamDynamicParameterFileFailFatal">OMX_IndexParamDynamicParameterFileFailFatal</a></tt>
359
-<td> Classify error condition when DFP fails to load.  This specifies whether the
360
-  failure to load the DPF file should this be treated as a fatal error
361
-  Enables loading of a dynamic parameter file. The filename is set with
362
-  <tt>OMX_IndexParamDynamicParameterFile</tt>.
364
+<td> Classify error condition when DFP fails to load.  This specifies whether the
365
+  failure to load the DPF file should be treated as a fatal error.
366
+ <tr valign="top"><td><tt>OMX_IndexParamConfigFileRegisters</tt>
367
+<td> Specify a register settings file to use instead of hard-coded defaults.
368
+  If a file is to be used, <tt>OMX_IndexParamUseRegisterFile</tt> must be set.
369
+ <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamBrcmConfigFileChunkRegisters">OMX_IndexParamBrcmConfigFileChunkRegisters</a></tt>
370
+<td> Specify a chunk of data for a register settings file.
371
+  <tt>OMX_IndexParamConfigFileRegisters</tt> must be called first.
372
+ <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmUseRegisterFile">OMX_IndexConfigBrcmUseRegisterFile</a></tt>
373
+<td> Specify whether we wish to load the register settings file.
374
+  The file is specified with <tt>OMX_IndexParamConfigFileRegisters</tt>.
375
+ <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmRegisterFileFailFatal">OMX_IndexConfigBrcmRegisterFileFailFatal</a></tt>
376
+<td> Classify error condition when register file fails to load.  This specifies whether
377
+  the failure to load the register file should be treated as a fatal error.
363 378
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraInfo">OMX_IndexConfigCameraInfo</a></tt>
364
-<td> Query the camera and lens information for the current camera.
379
+<td> Query the camera and lens information for the current camera.
365 380
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraFeatures">OMX_IndexConfigCameraFeatures</a></tt>
366
-<td> Camera features. Query the capabilities of the current camera (lens and shutter).
367
-  Some information is only valid when the component is Idle or Executing.
381
+<td> Camera features. Query the capabilities of the current camera (lens and shutter).
382
+  Some information is only valid when the component is Idle or Executing.
368 383
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigRequestCallback">OMX_IndexConfigRequestCallback</a></tt>
369
-<td> Query / set whether a <tt>RIL_CALLBACK_CONFIGCHANGED</tt> should be
370
-  generated when parameters change state within the component.
371
-  Currently supported for 
372
-  <tt>OMX_IndexConfigCommonFocusStatus</tt>,
373
-  <tt>OMX_IndexParamCommonSensorMode</tt>,
374
-  <tt>OMX_IndexConfigCameraSettings</tt>,
375
-  <tt>OMX_IndexParamCameraDeviceNumber</tt>,
376
-  <tt>OMX_IndexConfigCommonSceneDetected</tt>,
377
-  <tt>OMX_IndexConfigCommonFaceDetectionRegion</tt>,
378
-  <tt>OMX_IndexParamCaptureStatus</tt>, and 
379
-  <tt>OMX_IndexConfigFieldOfView</tt> only.
384
+<td> Query / set whether a <tt>RIL_CALLBACK_CONFIGCHANGED</tt> should be
385
+  generated when parameters change state within the component.
386
+  Currently supported for
387
+  <tt>OMX_IndexConfigCommonFocusStatus</tt>,
388
+  <tt>OMX_IndexParamCommonSensorMode</tt>,
389
+  <tt>OMX_IndexConfigCameraSettings</tt>,
390
+  <tt>OMX_IndexParamCameraDeviceNumber</tt>,
391
+  <tt>OMX_IndexConfigCommonSceneDetected</tt>,
392
+  <tt>OMX_IndexConfigCommonFaceDetectionRegion</tt>,
393
+  <tt>OMX_IndexParamCaptureStatus</tt>, and
394
+  <tt>OMX_IndexConfigFieldOfView</tt> only.
380 395
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCommonFocusRegionXY">OMX_IndexConfigCommonFocusRegionXY</a></tt>
381
-<td> Query / set the focus regions to use as a set of x/y/width/height boxes.
396
+<td> Query / set the focus regions to use as a set of x/y/width/height boxes.
382 397
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigUserSettingsId">OMX_IndexConfigUserSettingsId</a></tt>
383
-<td> Frame identification. Sets an identifier to be set on the start of the
384
-  next frame.  Gets the identifier seen on the last frame from Camplus.
385
-  This allows a client to identify when a group of settings have all
386
-  been applied to Camplus (apply settings, change
387
-  <tt>OMX_IndexConfigUserSettingsId</tt>, wait for value read back from
388
-  <tt>OMX_IndexConfigUserSettingsId</tt> to change to match).
398
+<td> Frame identification. Sets an identifier to be set on the start of the
399
+  next frame.  Gets the identifier seen on the last frame from Camplus.
400
+  This allows a client to identify when a group of settings have all
401
+  been applied to Camplus (apply settings, change
402
+  <tt>OMX_IndexConfigUserSettingsId</tt>, wait for value read back from
403
+  <tt>OMX_IndexConfigUserSettingsId</tt> to change to match).
389 404
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraSettings">OMX_IndexConfigCameraSettings</a></tt>
390
-<td> Get the parameters applied to the last frame from the camera. The
391
-  client can also set <tt>OMX_IndexConfigRequestCallback</tt> for this config.
405
+<td> Get the parameters applied to the last frame from the camera. The
406
+  client can also set <tt>OMX_IndexConfigRequestCallback</tt> for this config.
392 407
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBurstCapture">OMX_IndexConfigBurstCapture</a></tt>
393
-<td> Set the camera into a mode where it is only doing captures. The viewfinder port can
394
-  be executing, but will only emit the snapshot images associated to any captures
395
-  requested, and not viewfinder frames. This is an optimisation, and not essential.
408
+<td> Set the camera into a mode where it is only doing captures. The viewfinder port can
409
+  be executing, but will only emit the snapshot images associated to any captures
410
+  requested, and not viewfinder frames. This is an optimisation, and not essential.
396 411
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigPowerDown">OMX_IndexConfigPowerDown</a></tt>
397
-<td> Standby/power control. Query /set the power status of the camera
398
-  module. Setting this parameter to <tt>OMX_TRUE</tt> instructs the component to
399
-  power down the sensor, but keeping all memory allocated as required by
400
-  the component state.
412
+<td> Standby/power control. Query /set the power status of the camera
413
+  module. Setting this parameter to <tt>OMX_TRUE</tt> instructs the component to
414
+  power down the sensor, but keeping all memory allocated as required by
415
+  the component state.
401 416
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamBrcmCameraInputAspectRatio">OMX_IndexParamBrcmCameraInputAspectRatio</a></tt>
402
-<td> Sensor aspect ratio selection. Query / set the prefered aspect ratio
403
-  of the sensor CDI mode. The CDI will use the nearest value to this.
404
-  If both are left as 0, then the aspect ratio of the requested output
405
-  mode is used to bias the sensor mode selection.
417
+<td> Sensor aspect ratio selection. Query / set the prefered aspect ratio
418
+  of the sensor CDI mode. The CDI will use the nearest value to this.
419
+  If both are left as 0, then the aspect ratio of the requested output
420
+  mode is used to bias the sensor mode selection.
406 421
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigDynamicRangeExpansion">OMX_IndexConfigDynamicRangeExpansion</a></tt>
407
-<td> Dynamic range expansion. Configures the dynamic range expansion
408
-  Camplus software stage.
422
+<td> Dynamic range expansion. Configures the dynamic range expansion
423
+  Camplus software stage.
409 424
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigFaceRecognitionControl">OMX_IndexConfigFaceRecognitionControl</a></tt>
410
-<td> Face Recognition Control. Enables/disables the face recognition
411
-  software stage (if present)
425
+<td> Face Recognition Control. Enables/disables the face recognition
426
+  software stage (if present)
412 427
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigFaceRecognitionSaveFace">OMX_IndexConfigFaceRecognitionSaveFace</a></tt>
413
-<td> Face Recognition Face Learning. Instructs the face recognition stage
414
-  to save the next primary face it sees into the database with the
415
-  supplied ID.
428
+<td> Face Recognition Face Learning. Instructs the face recognition stage
429
+  to save the next primary face it sees into the database with the
430
+  supplied ID.
416 431
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigFaceRecognitionDatabaseUri">OMX_IndexConfigFaceRecognitionDatabaseUri</a></tt>
417
-<td> Face Recognition Database File. Specifies the URI of the database file
418
-  to be used by face recognition.
432
+<td> Face Recognition Database File. Specifies the URI of the database file
433
+  to be used by face recognition.
419 434
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigFlashInfo">OMX_IndexConfigFlashInfo</a></tt>
420
-<td> Flash Information. Queries for the information on the flash devices
421
-  present.
435
+<td> Flash Information. Queries for the information on the flash devices
436
+  present.
422 437
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCommonFaceBeautification">OMX_IndexConfigCommonFaceBeautification</a></tt>
423
-<td> Face Beautification. Enables/disables the face beautification
424
-  algorithm, if it is present.
438
+<td> Face Beautification. Enables/disables the face beautification
439
+  algorithm, if it is present.
425 440
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCommonSceneDetectionControl">OMX_IndexConfigCommonSceneDetectionControl</a></tt>
426
-<td> Automatic Scene Detection Control. Enables/disables the scene
427
-  detection algorithm, if it is present.
441
+<td> Automatic Scene Detection Control. Enables/disables the scene
442
+  detection algorithm, if it is present.
428 443
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCommonSceneDetected">OMX_IndexConfigCommonSceneDetected</a></tt>
429
-<td> Automatic Scene Detection Status. Returns the currently detected scene
430
-  type, as reported by the scene detection algorithm.  This config also
431
-  supports <tt>OMX_IndexConfigRequestCallback</tt> to report changes in value.
444
+<td> Automatic Scene Detection Status. Returns the currently detected scene
445
+  type, as reported by the scene detection algorithm.  This config also
446
+  supports <tt>OMX_IndexConfigRequestCallback</tt> to report changes in value.
432 447
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamDisableVllPool">OMX_IndexParamDisableVllPool</a></tt>
433
-<td> Controls whether Camplus software stages are loaded into a memory
434
-  pool allocated by this component, or loaded without specifying
435
-  where to store the VLLs. If a memory pool is not used, then
436
-  there is the possibility that a software stage will fail to load
437
-  due to insufficient memory - this consideration must be made by the
438
-  application/user.
448
+<td> Controls whether Camplus software stages are loaded into a memory
449
+  pool allocated by this component, or loaded without specifying
450
+  where to store the VLLs. If a memory pool is not used, then
451
+  there is the possibility that a software stage will fail to load
452
+  due to insufficient memory - this consideration must be made by the
453
+  application/user.
439 454
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmDrawStaticBox">OMX_IndexConfigBrcmDrawStaticBox</a></tt>
440
-<td><p>Define a static box to be drawn on the viewfinder images.
441
- <p>Allows a client to set a static box to be drawn on the viewfinder
442
-  images using the parameters specified for other types of boxes
443
-  (face tracking, or focus results). This box will always be drawn when
444
-  it is defined, overriding any face tracking or focus cycle results.
455
+<td><p>Define a static box to be drawn on the viewfinder images.
456
+ <p>Allows a client to set a static box to be drawn on the viewfinder
457
+  images using the parameters specified for other types of boxes
458
+  (face tracking, or focus results). This box will always be drawn when
459
+  it is defined, overriding any face tracking or focus cycle results.
445 460
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraCaptureMode">OMX_IndexParamCameraCaptureMode</a></tt>
446
-<td> Allow the client to specify the behaviour desired for stills captures.
447
-  Options are:
448
-   <tt>OMX_CameraCaptureModeWaitForCaptureEnd</tt>:
449
-        Wait for capture to complete before resuming viewfinder.
450
-   <tt>OMX_CameraCaptureModeWaitForCaptureEndAndUsePreviousInputImage</tt>:
451
-        Reprocess the same input frame multiple times with different settings.
452
-        Currently not implemented in the Camplus levels.
453
-   <tt>OMX_CameraCaptureModeResumeViewfinderImmediately</tt>:
454
-        Resume viewfinder/video encode as soon as the input image for the still
455
-        has been acquired, and then process the still in a parallel thread. This
456
-        requires <tt>image_pool_params.eInputPoolMode</tt> to be set to
457
-        <tt>OMX_CAMERAIMAGEPOOLINPUTMODE_TWOPOOLS</tt>, and 
458
-        <tt>image_pool_params.nNumHiResStillsFrames</tt>
459
-        to be non-zero, otherwise the image pools won't split in a manner that
460
-        allows viewfinder to be resumed.
461
+<td> Allow the client to specify the behaviour desired for stills captures.
462
+  Options are:
463
+   <tt>OMX_CameraCaptureModeWaitForCaptureEnd</tt>:
464
+        Wait for capture to complete before resuming viewfinder.
465
+   <tt>OMX_CameraCaptureModeWaitForCaptureEndAndUsePreviousInputImage</tt>:
466
+        Reprocess the same input frame multiple times with different settings.
467
+        Currently not implemented in the Camplus levels.
468
+   <tt>OMX_CameraCaptureModeResumeViewfinderImmediately</tt>:
469
+        Resume viewfinder/video encode as soon as the input image for the still
470
+        has been acquired, and then process the still in a parallel thread. This
471
+        requires <tt>image_pool_params.eInputPoolMode</tt> to be set to
472
+        <tt>OMX_CAMERAIMAGEPOOLINPUTMODE_TWOPOOLS</tt>, and
473
+        <tt>image_pool_params.nNumHiResStillsFrames</tt>
474
+        to be non-zero, otherwise the image pools won't split in a manner that
475
+        allows viewfinder to be resumed.
461 476
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmCameraRnDPreprocess">OMX_IndexConfigBrcmCameraRnDPreprocess</a></tt>
462
-<td> Test control allowing a software stage to be dropped into the preprocessor
463
-  pipeline easily and controlled through OMX. Software stage must be called
464
-  rnd_prep_stage, and SW_STAGE_DISABLE_RND_PREPROC must be undefined in
465
-  camera_config.h. It is inserted into both video and stills pipelines as
466
-  the last software stage.
477
+<td> Test control allowing a software stage to be dropped into the preprocessor
478
+  pipeline easily and controlled through OMX. Software stage must be called
479
+  rnd_prep_stage, and SW_STAGE_DISABLE_RND_PREPROC must be undefined in
480
+  camera_config.h. It is inserted into both video and stills pipelines as
481
+  the last software stage.
467 482
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmCameraRnDPostprocess">OMX_IndexConfigBrcmCameraRnDPostprocess</a></tt>
468
-<td> Test control allowing a software stage to be dropped into the postprocessor
469
-  pipeline easily and controlled through OMX. Software stage must be called
470
-  rnd_prep_stage, and SW_STAGE_DISABLE_RND_POSTPROC must be undefined in
471
-  camera_config.h. It is inserted into both video and stills pipelines as
472
-  the last software stage.
483
+<td> Test control allowing a software stage to be dropped into the postprocessor
484
+  pipeline easily and controlled through OMX. Software stage must be called
485
+  rnd_prep_stage, and SW_STAGE_DISABLE_RND_POSTPROC must be undefined in
486
+  camera_config.h. It is inserted into both video and stills pipelines as
487
+  the last software stage.
473 488
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCommonUseStcTimestamps">OMX_IndexParamCommonUseStcTimestamps</a></tt>
474
-<td> This parameter selects how the component timestamps buffers if there is
475
-  no clock. The options are:
476
-   <tt>OMX_TimestampModeZero</tt>:
477
-        Always timestamp them as time 0.
478
-   <tt>OMX_TimestampModeRawStc</tt>:
479
-        Read the STC timestamp of when the frame was captured, and use that
480
-        raw value.
481
-   <tt>OMX_TimestampModeResetStc</tt>:
482
-        Store the STC of the 1st frame sent on the video port, and subtract
483
-        that value from all frames. The offset value will get reset whenever
484
-        video capture is started with either the port capturing flag or 
485
-        enabling the port, so a capture pause function can not be achieved
486
-        in this mode.
487
-  If passing buffers it also relies on passing the entire frame in one buffer, 
488
-  as the time information is not available until the whole frame has been 
489
-  received from Camplus.
489
+<td> This parameter selects how the component timestamps buffers if there is
490
+  no clock. The options are:
491
+   <tt>OMX_TimestampModeZero</tt>:
492
+        Always timestamp them as time 0.
493
+   <tt>OMX_TimestampModeRawStc</tt>:
494
+        Read the STC timestamp of when the frame was captured, and use that
495
+        raw value.
496
+   <tt>OMX_TimestampModeResetStc</tt>:
497
+        Store the STC of the 1st frame sent on the video port, and subtract
498
+        that value from all frames. The offset value will get reset whenever
499
+        video capture is started with either the port capturing flag or
500
+        enabling the port, so a capture pause function can not be achieved
501
+        in this mode.
502
+  If passing buffers it also relies on passing the entire frame in one buffer,
503
+  as the time information is not available until the whole frame has been
504
+  received from Camplus.
490 505
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCaptureStatus">OMX_IndexParamCaptureStatus</a></tt>
491
-<td> Returns the actual capture status of the camera component. Set to True when
492
-  a stills capture starts, and will be cleared when the capture image has been 
493
-  passed downstream.
494
-  This parameter is supported by <tt>OMX_IndexConfigRequestCallback</tt>
495
-  to allow a client to do stuff on image capture (eg play a shutter sound).
506
+<td> Returns the actual capture status of the camera component. Set to True when
507
+  a stills capture starts, and will be cleared when the capture image has been
508
+  passed downstream.
509
+  This parameter is supported by <tt>OMX_IndexConfigRequestCallback</tt>
510
+  to allow a client to do stuff on image capture (eg play a shutter sound).
496 511
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamBrcmLazyImagePoolDestroy">OMX_IndexParamBrcmLazyImagePoolDestroy</a></tt>
497
-<td> The image pool will be deleted lazily, i.e. we will not wait for the images
498
-  to be returned from the pool, but instead rely on the image pool tidying itself
499
-  up automatically when all references are released.
512
+<td> The image pool will be deleted lazily, i.e. we will not wait for the images
513
+  to be returned from the pool, but instead rely on the image pool tidying itself
514
+  up automatically when all references are released.
500 515
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmHighDynamicRange">OMX_IndexConfigBrcmHighDynamicRange</a></tt>
501
-<td> Enable / disable the High Dynamic Range (HDR) software stage.
516
+<td> Enable / disable the High Dynamic Range (HDR) software stage.
502 517
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigFieldOfView">OMX_IndexConfigFieldOfView</a></tt>
503
-<td> Image field of view.
504
-  Returns the field of view provided by the current camera settings.
505
-  Read only.
518
+<td> Image field of view.
519
+  Returns the field of view provided by the current camera settings.
520
+  Read only.
506 521
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmPoolMemAllocSize">OMX_IndexConfigBrcmPoolMemAllocSize</a></tt>
507
-<td> Returns the amount of memory being used by the component's 
508
-  image pools. Read only.
522
+<td> Returns the amount of memory being used by the component's
523
+  image pools. Read only.
524
+ <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigContrastEnhance">OMX_IndexConfigContrastEnhance</a></tt>
525
+<td> Enable / disable contrast enhancement.
526
+ <tr valign="top"><td><tt>OMX_IndexParamCameraCustomSensorConfig</tt>
527
+<td> Allows a request to be made to the sensor driver to use an alternate set of
528
+  configuration registers. The meaning of these will be sensor specific.
529
+  The setting will only be changed on the next call to the sensor set_mode,
530
+  hence this is enforced as an IL parameter that the component must be loaded,
531
+  or all ports disabled in order to change it.
532
+ <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraZeroShutterLag">OMX_IndexParamCameraZeroShutterLag</a></tt>
533
+<td> Two parameters.
534
+  The first requests that the camera should run preview using
535
+  the full resolution sensor mode.
536
+  The second controls whether captures should then grab the last raw
537
+  preview image and generate the capture based on that.
538
+ <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCaptureExposureCompensation">OMX_IndexParamCaptureExposureCompensation</a></tt>
539
+<td> Sets the exposure compensation that should be applied to a stills capture
540
+  compared to the previous preview frames.
541
+ <tr valign="top"><td><tt>OMX_IndexParamSWSharpenDisable</tt>
542
+<td> Requests the tuner to disable the software sharpen stage for improved
543
+  capture performance.
544
+ <tr valign="top"><td><tt>OMX_IndexParamSWSaturationDisable</tt>
545
+<td> Requests the tuner to disable the software saturation stage for improved
546
+  capture performance.
547
+ <tr valign="top"><td><tt>OMX_IndexConfigBrcmFlashRequired</tt>
548
+<td> Returns the tuner indication whether a flash (normal or fill-in)
549
+  is required for the capture. Read only.
509 550
  <tr valign="top"><td rowspan="6">70<td><tt>OMX_IndexParamPortDefinition</tt>
510
-<td> Query / set the preview port resolution. Parts of this value may be
511
-  overwritten by the component if Camplus needs to apply additional
512
-  conditions on the image format.
551
+<td> Query / set the preview port resolution. Parts of this value may be
552
+  overwritten by the component if Camplus needs to apply additional
553
+  conditions on the image format.
513 554
  <tr valign="top"><td><tt>OMX_IndexConfigVideoFramerate</tt>
514
-<td> Query / set the framerate including when the port is already executing.
555
+<td> Query / set the framerate including when the port is already executing.
515 556
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamImagePoolDisplayFunction">OMX_IndexParamImagePoolDisplayFunction</a></tt>
516
-<td> Used to set up proprietary communication with the next component.  The
517
-  current default when using proprietary communication is to use the
518
-  Broadcom-specific image format in place of
519
-  <tt>OMX_COLOR_FormatYUV420PackedPlanar</tt>, provided that the capture
520
-  port has not requested YUV420 explicitly.  This is to allow a
521
-  performance optimisation to be used within the denoising algorithm.
557
+<td> Used to set up proprietary communication with the next component.  The
558
+  current default when using proprietary communication is to use the
559
+  Broadcom-specific image format in place of
560
+  <tt>OMX_COLOR_FormatYUV420PackedPlanar</tt>, provided that the capture
561
+  port has not requested YUV420 explicitly.  This is to allow a
562
+  performance optimisation to be used within the denoising algorithm.
522 563
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraSensorModes">OMX_IndexConfigCameraSensorModes</a></tt>
523
-<td> Query the image sensor mode that would be used for the currently
524
-  defined port definition.
564
+<td> Query the image sensor mode that would be used for the currently
565
+  defined port definition.
525 566
  <tr valign="top"><td><tt>OMX_IndexConfigCommonRotate</tt>
526
-<td> Query / set the rotation requirements for images emitted from the
527
-  viewfinder port. Only rotations of 0, 90, 180, and 270 degrees are
528
-  supported.
567
+<td> Query / set the rotation requirements for images emitted from the
568
+  viewfinder port. Only rotations of 0, 90, 180, and 270 degrees are
569
+  supported.
529 570
  <tr valign="top"><td><tt>OMX_IndexConfigCommonMirror</tt>
530
-<td> Query / set the mirroring requirements for images emitted from the
531
-  viewfinder port. These are always used in combination with the
532
-  rotation parameters, so <tt>OMX_MirrorBoth</tt> and rotate 180 will
533
-  result in the image being back at upright. 
571
+<td> Query / set the mirroring requirements for images emitted from the
572
+  viewfinder port. These are always used in combination with the
573
+  rotation parameters, so <tt>OMX_MirrorBoth</tt> and rotate 180 will
574
+  result in the image being back at upright.
534 575
  <tr valign="top"><td rowspan="7">71<td><tt>OMX_IndexParamPortDefinition</tt>
535
-<td> Query / set the capture port resolution.
576
+<td> Query / set the capture port resolution.
536 577
  <tr valign="top"><td><tt>OMX_IndexConfigVideoFramerate</tt>
537
-<td> Query / set the framerate including when the port is already executing.
578
+<td> Query / set the framerate including when the port is already executing.
538 579
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamImagePoolDisplayFunction">OMX_IndexParamImagePoolDisplayFunction</a></tt>
539
-<td> Used to set up proprietary communication with the next component.
580
+<td> Used to set up proprietary communication with the next component.
540 581
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamCameraPoolToEncoderFunction">OMX_IndexParamCameraPoolToEncoderFunction</a></tt>
541
-<td><p>Used to set up proprietary communication with the next component
542
-  (video encoder specific)
582
+<td><p>Used to set up proprietary communication with the next component
583
+  (video encoder specific)
543 584
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraSensorModes">OMX_IndexConfigCameraSensorModes</a></tt>
544
-<td> Query the image sensor mode that would be used for the currently
545
-  defined port definition.
585
+<td> Query the image sensor mode that would be used for the currently
586
+  defined port definition.
546 587
  <tr valign="top"><td><tt>OMX_IndexConfigCommonRotate</tt>
547
-<td> Query / set the rotation requirements for images emitted from the
548
-  capture port. Only rotations of 0, 90, 180, and 270 degrees
549
-  are supported.
588
+<td> Query / set the rotation requirements for images emitted from the
589
+  capture port. Only rotations of 0, 90, 180, and 270 degrees
590
+  are supported.
550 591
  <tr valign="top"><td><tt>OMX_IndexConfigCommonMirror</tt>
551
-<td> Query / set the mirroring requirements for images emitted from the
552
-  capture port. These are always used in combination with
553
-  the rotation parameters, so <tt>OMX_MirrorBoth</tt> and rotate 180 will result in
554
-  the image being back at upright.
592
+<td> Query / set the mirroring requirements for images emitted from the
593
+  capture port. These are always used in combination with
594
+  the rotation parameters, so <tt>OMX_MirrorBoth</tt> and rotate 180 will result in
595
+  the image being back at upright.
555 596
  <tr valign="top"><td rowspan="3">72<td><tt><a href="prop.html#OMX_IndexParamCameraStripeFunction">OMX_IndexParamCameraStripeFunction</a></tt>
556
-<td> Used to set up proprietary communication with the next component when
557
-  passing image stripes (write still specific)
597
+<td> Used to set up proprietary communication with the next component when
598
+  passing image stripes (write still specific)
558 599
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigCameraStripeFuncMinLines">OMX_IndexConfigCameraStripeFuncMinLines</a></tt>
559
-<td> Used to set the minimum number of lines to be passed using the stripe function. The stripe
560
-  function itself is set with <tt>OMX_IndexParamCameraStripeFunction</tt>.
600
+<td> Used to set the minimum number of lines to be passed using the stripe function. The stripe
601
+  function itself is set with <tt>OMX_IndexParamCameraStripeFunction</tt>.
561 602
  <tr valign="top"><td><tt>OMX_IndexParamImagePortFormat</tt>
562
-<td> Query / set the video port format.  This port supports a small range of
563
-  uncompressed pixel formats.
603
+<td> Query / set the video port format.  This port supports a small range of
604
+  uncompressed pixel formats.
564 605
  <tr valign="top"><td rowspan="1">70  71<td><tt>OMX_IndexParamVideoPortFormat</tt>
565
-<td> Query / set the video port format.  These ports support a small range of
566
-  uncompressed pixel formats.
606
+<td> Query / set the video port format.  These ports support a small range of
607
+  uncompressed pixel formats.
567 608
  <tr valign="top"><td rowspan="2">70  71  72<td><tt><a href="prop.html#OMX_IndexParamBrcmDisableProprietaryTunnels">OMX_IndexParamBrcmDisableProprietaryTunnels</a></tt>
568
-<td> Tells the component not to use proprietary communication for the selected
569
-  output port.
609
+<td> Tells the component not to use proprietary communication for the selected
610
+  output port.
570 611
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexParamPortMaxFrameSize">OMX_IndexParamPortMaxFrameSize</a></tt>
571
-<td> Allows the defining of the maximum frame size to be used on the 
572
-  specified port. Image pools will be sized based on this information
573
-  in the absence of any additional configuration from the application 
574
-  (via <tt>OMX_IndexParamCameraImagePool</tt>).
575
-  The size passed in <tt>OMX_IndexParamPortDefinition</tt> will be checked 
576
-  against this setting (potentially tranposed) to ensure that the images 
577
-  can fit in the pool.
612
+<td> Allows the defining of the maximum frame size to be used on the
613
+  specified port. Image pools will be sized based on this information
614
+  in the absence of any additional configuration from the application
615
+  (via <tt>OMX_IndexParamCameraImagePool</tt>).
616
+  The size passed in <tt>OMX_IndexParamPortDefinition</tt> will be checked
617
+  against this setting (potentially transposed) to ensure that the images
618
+  can fit in the pool.
619
+ <tr valign="top"><td rowspan="1">70  71<td><tt><a href="prop.html#OMX_IndexParamBrcmFpsRange">OMX_IndexParamBrcmFpsRange</a></tt>
620
+<td> Allows a variable frame rate range to be defined. Used if xFramerate
621
+  in the port definition is 0.
578 622
  <tr valign="top"><td rowspan="1">73<td><tt>OMX_IndexParamOtherPortFormat</tt>
579
-<td> Query / set the format used by this port.  This port supports only the clock format type.
623
+<td> Query / set the format used by this port.  This port supports only the clock format type.
580 624
  </table>
581 625
 
582
-
626
+
583 627
 </table>
584 628
 </body>
585 629
 </html>

+ 26
- 26
documentation/ilcomponents/clock.html View File

@@ -58,51 +58,51 @@
58 58
 </table></td>
59 59
 </tr></table><p>
60 60
 <p>
61
-A conformant clock component, designed to be compatible with a
62
-standard clock component. It currently supports 6 output clock ports.
61
+A conformant clock component, designed to be compatible with a
62
+standard clock component. It currently supports 6 output clock ports.
63 63
 <p>
64 64
 <p>
65 65
 <table border="1" cellspacing="0" cellpadding="2"><tr><td>Port<td>Index<td>Notes
66 66
 <tr valign="top"><td rowspan="13">80  81  82  83  84  85<td><tt>OMX_IndexParamPortDefinition</tt>
67
-<td> The port definition can be used to connect each port to a clock port
68
-  on another component.
67
+<td> The port definition can be used to connect each port to a clock port
68
+  on another component.
69 69
  <tr valign="top"><td><tt>OMX_IndexParamOtherPortFormat</tt>
70
-<td> This param is used to confirm that this port supports clock messages.
70
+<td> This param is used to confirm that this port supports clock messages.
71 71
  <tr valign="top"><td><tt>OMX_IndexConfigTimeScale</tt>
72
-<td> We support setting the timescale to achieve slow motion, fast forward,
73
-  paused, and rewind playback. To achieve rewind and fast forward, note the
74
-  extra playmode config in the read_media.
72
+<td> We support setting the timescale to achieve slow motion, fast forward,
73
+  paused, and rewind playback. To achieve rewind and fast forward, note the
74
+  extra playmode config in the read_media.
75 75
  <tr valign="top"><td><tt>OMX_IndexConfigTimeClockState</tt>
76
-<td> Query / set current clock state.
76
+<td> Query / set current clock state.
77 77
  <tr valign="top"><td><tt>OMX_IndexConfigTimeCurrentWallTime</tt>
78
-<td> Query current wall time.
78
+<td> Query current wall time.
79 79
  <tr valign="top"><td><tt>OMX_IndexConfigTimeActiveRefClock</tt>
80
-<td> Query / set the active reference clock.
80
+<td> Query / set the active reference clock.
81 81
  <tr valign="top"><td><tt>OMX_IndexConfigTimeCurrentMediaTime</tt>
82
-<td> Query current media time.
82
+<td> Query current media time.
83 83
  <tr valign="top"><td><tt>OMX_IndexConfigTimeClientStartTime</tt>
84
-<td> Set the start time of a client stream, typically used by
85
-  a tunneled component.
84
+<td> Set the start time of a client stream, typically used by
85
+  a tunneled component.
86 86
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigTimeInvalidStartTime">OMX_IndexConfigTimeInvalidStartTime</a></tt>
87
-<td> Notification that a client will not be sending a start time.
87
+<td> Notification that a client will not be sending a start time.
88 88
  <tr valign="top"><td><tt>OMX_IndexConfigTimeCurrentAudioReference</tt>
89
-<td> Set the instantaneous audio reference clock value.  Time values
90
-  received are filtered to remove jitter.
89
+<td> Set the instantaneous audio reference clock value.  Time values
90
+  received are filtered to remove jitter.
91 91
  <tr valign="top"><td><tt>OMX_IndexConfigTimeCurrentVideoReference</tt>
92
-<td> Set the instantaneous video reference clock value.
92
+<td> Set the instantaneous video reference clock value.
93 93
  <tr valign="top"><td><tt>OMX_IndexConfigTimeMediaTimeRequest</tt>
94
-<td> Make a media time request.
94
+<td> Make a media time request.
95 95
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigBrcmClockMissCount">OMX_IndexConfigBrcmClockMissCount</a></tt>
96
-<td> Return a count of the number of media time requests that were missed, because they
97
-  arrived too late (after the requested time).
96
+<td> Return a count of the number of media time requests that were missed, because they
97
+  arrived too late (after the requested time).
98 98
  <tr valign="top"><td rowspan="3">&nbsp;<td><tt><a href="prop.html#OMX_IndexConfigSingleStep">OMX_IndexConfigSingleStep</a></tt>
99
-<td> Advance a paused clock through the next set of requested media times.
99
+<td> Advance a paused clock through the next set of requested media times.
100 100
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigClockAdjustment">OMX_IndexConfigClockAdjustment</a></tt>
101
-<td> Get the total amount that the clock media time has shifted due to
102
-  clock reference time updates since the clock started running.
101
+<td> Get the total amount that the clock media time has shifted due to
102
+  clock reference time updates since the clock started running.
103 103
  <tr valign="top"><td><tt><a href="prop.html#OMX_IndexConfigLatencyTarget">OMX_IndexConfigLatencyTarget</a></tt>
104
-<td> Query / set the filter values used when tracking offset between media time
105
-  and reference clock source by applying small changes to media time speed.
104
+<td> Query / set the filter values used when tracking offset between media time
105
+  and reference clock source by applying small changes to media time speed.
106 106
  </table>
107 107
 
108 108
 </table>

+ 498
- 498
documentation/ilcomponents/doxygen.css View File

@@ -1,498 +1,498 @@
1
-/* The standard CSS for doxygen */
2
-
3
-body, table, div, p, dl {
4
-	font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
5
-	font-size: 12px;
6
-}
7
-
8
-/* @group Heading Levels */
9
-
10
-h1 {
11
-	text-align: center;
12
-	font-size: 150%;
13
-}
14
-
15
-h2 {
16
-	font-size: 120%;
17
-}
18
-
19
-h3 {
20
-	font-size: 100%;
21
-}
22
-
23
-dt {
24
-	font-weight: bold;
25
-}
26
-
27
-div.multicol {
28
-	-moz-column-gap: 1em;
29
-	-webkit-column-gap: 1em;
30
-	-moz-column-count: 3;
31
-	-webkit-column-count: 3;
32
-}
33
-
34
-p.startli, p.startdd {
35
-	margin-top: 2px;
36
-}
37
-
38
-p.endli {
39
-	margin-bottom: 0px;
40
-}
41
-
42
-p.enddd {
43
-	margin-bottom: 4px;
44
-}
45
-
46
-/* @end */
47
-
48
-caption {
49
-	font-weight: bold;
50
-}
51
-
52
-span.legend {
53
-        font-size: 70%;
54
-        text-align: center;
55
-}
56
-
57
-div.qindex, div.navtab{
58
-	background-color: #e8eef2;
59
-	border: 1px solid #84b0c7;
60
-	text-align: center;
61
-	margin: 2px;
62
-	padding: 2px;
63
-}
64
-
65
-div.qindex, div.navpath {
66
-	width: 100%;
67
-	line-height: 140%;
68
-}
69
-
70
-div.navtab {
71
-	margin-right: 15px;
72
-}
73
-
74
-/* @group Link Styling */
75
-
76
-a {
77
-	color: #153788;
78
-	font-weight: normal;
79
-	text-decoration: none;
80
-}
81
-
82
-.contents a:visited {
83
-	color: #1b77c5;
84
-}
85
-
86
-a:hover {
87
-	text-decoration: underline;
88
-}
89
-
90
-a.qindex {
91
-	font-weight: bold;
92
-}
93
-
94
-a.qindexHL {
95
-	font-weight: bold;
96
-	background-color: #6666cc;
97
-	color: #ffffff;
98
-	border: 1px double #9295C2;
99
-}
100
-
101
-.contents a.qindexHL:visited {
102
-        color: #ffffff;
103
-}
104
-
105
-a.el {
106
-	font-weight: bold;
107
-}
108
-
109
-a.elRef {
110
-}
111
-
112
-a.code {
113
-}
114
-
115
-a.codeRef {
116
-}
117
-
118
-/* @end */
119
-
120
-dl.el {
121
-	margin-left: -1cm;
122
-}
123
-
124
-.fragment {
125
-	font-family: monospace, fixed;
126
-	font-size: 105%;
127
-}
128
-
129
-pre.fragment {
130
-	border: 1px solid #CCCCCC;
131
-	background-color: #f5f5f5;
132
-	padding: 4px 6px;
133
-	margin: 4px 8px 4px 2px;
134
-}
135
-
136
-div.ah {
137
-	background-color: black;
138
-	font-weight: bold;
139
-	color: #ffffff;
140
-	margin-bottom: 3px;
141
-	margin-top: 3px
142
-}
143
-
144
-div.groupHeader {
145
-	margin-left: 16px;
146
-	margin-top: 12px;
147
-	margin-bottom: 6px;
148
-	font-weight: bold;
149
-}
150
-
151
-div.groupText {
152
-	margin-left: 16px;
153
-	font-style: italic;
154
-}
155
-
156
-body {
157
-	background: white;
158
-	color: black;
159
-	margin-right: 20px;
160
-	margin-left: 20px;
161
-}
162
-
163
-td.indexkey {
164
-	background-color: #e8eef2;
165
-	font-weight: bold;
166
-	border: 1px solid #CCCCCC;
167
-	margin: 2px 0px 2px 0;
168
-	padding: 2px 10px;
169
-}
170
-
171
-td.indexvalue {
172
-	background-color: #e8eef2;
173
-	border: 1px solid #CCCCCC;
174
-	padding: 2px 10px;
175
-	margin: 2px 0px;
176
-}
177
-
178
-tr.memlist {
179
-	background-color: #f0f0f0;
180
-}
181
-
182
-p.formulaDsp {
183
-	text-align: center;
184
-}
185
-
186
-img.formulaDsp {
187
-	
188
-}
189
-
190
-img.formulaInl {
191
-	vertical-align: middle;
192
-}
193
-
194
-div.center {
195
-	text-align: center;
196
-        margin-top: 0px;
197
-        margin-bottom: 0px;
198
-        padding: 0px;
199
-}
200
-
201
-div.center img {
202
-	border: 0px;
203
-}
204
-
205
-img.footer {
206
-	border: 0px;
207
-	vertical-align: middle;
208
-}
209
-
210
-/* @group Code Colorization */
211
-
212
-span.keyword {
213
-	color: #008000
214
-}
215
-
216
-span.keywordtype {
217
-	color: #604020
218
-}
219
-
220
-span.keywordflow {
221
-	color: #e08000
222
-}
223
-
224
-span.comment {
225
-	color: #800000
226
-}
227
-
228
-span.preprocessor {
229
-	color: #806020
230
-}
231
-
232
-span.stringliteral {
233
-	color: #002080
234
-}
235
-
236
-span.charliteral {
237
-	color: #008080
238
-}
239
-
240
-span.vhdldigit { 
241
-	color: #ff00ff 
242
-}
243
-
244
-span.vhdlchar { 
245
-	color: #000000 
246
-}
247
-
248
-span.vhdlkeyword { 
249
-	color: #700070 
250
-}
251
-
252
-span.vhdllogic { 
253
-	color: #ff0000 
254
-}
255
-
256
-/* @end */
257
-
258
-.search {
259
-	color: #003399;
260
-	font-weight: bold;
261
-}
262
-
263
-form.search {
264
-	margin-bottom: 0px;
265
-	margin-top: 0px;
266
-}
267
-
268
-input.search {
269
-	font-size: 75%;
270
-	color: #000080;
271
-	font-weight: normal;
272
-	background-color: #e8eef2;
273
-}
274
-
275
-td.tiny {
276
-	font-size: 75%;
277
-}
278
-
279
-.dirtab {
280
-	padding: 4px;
281
-	border-collapse: collapse;
282
-	border: 1px solid #84b0c7;
283
-}
284
-
285
-th.dirtab {
286
-	background: #e8eef2;
287
-	font-weight: bold;
288
-}
289
-
290
-hr {
291
-	height: 0;
292
-	border: none;
293
-	border-top: 1px solid #666;
294
-}
295
-
296
-/* @group Member Descriptions */
297
-
298
-.mdescLeft, .mdescRight,
299
-.memItemLeft, .memItemRight,
300
-.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
301
-	background-color: #FAFAFA;
302
-	border: none;
303
-	margin: 4px;
304
-	padding: 1px 0 0 8px;
305
-}
306
-
307
-.mdescLeft, .mdescRight {
308
-	padding: 0px 8px 4px 8px;
309
-	color: #555;
310
-}
311
-
312
-.memItemLeft, .memItemRight, .memTemplParams {
313
-	border-top: 1px solid #ccc;
314
-}
315
-
316
-.memItemLeft, .memTemplItemLeft {
317
-        white-space: nowrap;
318
-}
319
-
320
-.memTemplParams {
321
-	color: #606060;
322
-        white-space: nowrap;
323
-}
324
-
325
-/* @end */
326
-
327
-/* @group Member Details */
328
-
329
-/* Styles for detailed member documentation */
330
-
331
-.memtemplate {
332
-	font-size: 80%;
333
-	color: #606060;
334
-	font-weight: normal;
335
-	margin-left: 3px;
336
-}
337
-
338
-.memnav {
339
-	background-color: #e8eef2;
340
-	border: 1px solid #84b0c7;
341
-	text-align: center;
342
-	margin: 2px;
343
-	margin-right: 15px;
344
-	padding: 2px;
345
-}
346
-
347
-.memitem {
348
-	padding: 0;
349
-	margin-bottom: 10px;
350
-}
351
-
352
-.memname {
353
-	white-space: nowrap;
354
-	font-weight: bold;
355
-}
356
-
357
-.memproto, .memdoc {
358
-	border: 1px solid #84b0c7;	
359
-}
360
-
361
-.memproto {
362
-	padding: 0;
363
-	background-color: #d5e1e8;
364
-	font-weight: bold;
365
-	-webkit-border-top-left-radius: 8px;
366
-	-webkit-border-top-right-radius: 8px;
367
-        -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
368
-	-moz-border-radius-topleft: 8px;
369
-	-moz-border-radius-topright: 8px;
370
-        -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
371
-
372
-}
373
-
374
-.memdoc {
375
-	padding: 2px 5px;
376
-	background-color: #eef3f5;
377
-	border-top-width: 0;
378
-	-webkit-border-bottom-left-radius: 8px;
379
-	-webkit-border-bottom-right-radius: 8px;
380
-        -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
381
-	-moz-border-radius-bottomleft: 8px;
382
-	-moz-border-radius-bottomright: 8px;
383
-        -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
384
-}
385
-
386
-.paramkey {
387
-	text-align: right;
388
-}
389
-
390
-.paramtype {
391
-	white-space: nowrap;
392
-}
393
-
394
-.paramname {
395
-	color: #602020;
396
-	white-space: nowrap;
397
-}
398
-.paramname em {
399
-	font-style: normal;
400
-}
401
-
402
-/* @end */
403
-
404
-/* @group Directory (tree) */
405
-
406
-/* for the tree view */
407
-
408
-.ftvtree {
409
-	font-family: sans-serif;
410
-	margin: 0.5em;
411
-}
412
-
413
-/* these are for tree view when used as main index */
414
-
415
-.directory {
416
-	font-size: 9pt;
417
-	font-weight: bold;
418
-}
419
-
420
-.directory h3 {
421
-	margin: 0px;
422
-	margin-top: 1em;
423
-	font-size: 11pt;
424
-}
425
-
426
-/*
427
-The following two styles can be used to replace the root node title
428
-with an image of your choice.  Simply uncomment the next two styles,
429
-specify the name of your image and be sure to set 'height' to the
430
-proper pixel height of your image.
431
-*/
432
-
433
-/*
434
-.directory h3.swap {
435
-	height: 61px;
436
-	background-repeat: no-repeat;
437
-	background-image: url("yourimage.gif");
438
-}
439
-.directory h3.swap span {
440
-	display: none;
441
-}
442
-*/
443
-
444
-.directory > h3 {
445
-	margin-top: 0;
446
-}
447
-
448
-.directory p {
449
-	margin: 0px;
450
-	white-space: nowrap;
451
-}
452
-
453
-.directory div {
454
-	display: none;
455
-	margin: 0px;
456
-}
457
-
458
-.directory img {
459
-	vertical-align: -30%;
460
-}
461
-
462
-/* these are for tree view when not used as main index */
463
-
464
-.directory-alt {
465
-	font-size: 100%;
466
-	font-weight: bold;
467
-}
468
-
469
-.directory-alt h3 {
470
-	margin: 0px;
471
-	margin-top: 1em;
472
-	font-size: 11pt;
473
-}
474
-
475
-.directory-alt > h3 {
476
-	margin-top: 0;
477
-}
478
-
479
-.directory-alt p {
480
-	margin: 0px;
481
-	white-space: nowrap;
482
-}
483
-
484
-.directory-alt div {
485
-	display: none;
486
-	margin: 0px;
487
-}
488
-
489
-.directory-alt img {
490
-	vertical-align: -30%;
491
-}
492
-
493
-/* @end */
494
-
495
-address {
496
-	font-style: normal;
497
-	color: #333;
498
-}
1
+/* The standard CSS for doxygen */
2
+
3
+body, table, div, p, dl {
4
+	font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
5
+	font-size: 12px;
6
+}
7
+
8
+/* @group Heading Levels */
9
+
10
+h1 {
11
+	text-align: center;
12
+	font-size: 150%;
13
+}
14
+
15
+h2 {
16
+	font-size: 120%;
17
+}
18
+
19
+h3 {
20
+	font-size: 100%;
21
+}
22
+
23
+dt {
24
+	font-weight: bold;
25
+}
26
+
27
+div.multicol {
28
+	-moz-column-gap: 1em;
29
+	-webkit-column-gap: 1em;
30
+	-moz-column-count: 3;
31
+	-webkit-column-count: 3;
32
+}
33
+
34
+p.startli, p.startdd {
35
+	margin-top: 2px;
36
+}
37
+
38
+p.endli {
39
+	margin-bottom: 0px;
40
+}
41
+
42
+p.enddd {
43
+	margin-bottom: 4px;
44
+}
45
+
46
+/* @end */
47
+
48
+caption {
49
+	font-weight: bold;
50
+}
51
+
52
+span.legend {
53
+        font-size: 70%;
54
+        text-align: center;
55
+}
56
+
57
+div.qindex, div.navtab{
58
+	background-color: #e8eef2;
59
+	border: 1px solid #84b0c7;
60
+	text-align: center;
61
+	margin: 2px;
62
+	padding: 2px;
63
+}
64
+
65
+div.qindex, div.navpath {
66
+	width: 100%;
67
+	line-height: 140%;
68
+}
69
+
70
+div.navtab {
71
+	margin-right: 15px;
72
+}
73
+
74
+/* @group Link Styling */
75
+
76
+a {
77
+	color: #153788;
78
+	font-weight: normal;
79
+	text-decoration: none;
80
+}
81
+
82
+.contents a:visited {
83
+	color: #1b77c5;
84
+}
85
+
86
+a:hover {
87
+	text-decoration: underline;
88
+}
89
+
90
+a.qindex {
91
+	font-weight: bold;
92
+}
93
+
94
+a.qindexHL {
95
+	font-weight: bold;
96
+	background-color: #6666cc;
97
+	color: #ffffff;
98
+	border: 1px double #9295C2;
99
+}
100
+
101
+.contents a.qindexHL:visited {
102
+        color: #ffffff;
103
+}
104
+
105
+a.el {
106
+	font-weight: bold;
107
+}
108
+
109
+a.elRef {
110
+}
111
+
112
+a.code {
113
+}
114
+