camera3: Update availableEffects, effectMode tags.
Change-Id: I1edc89f7af9ef15894cfd398116730afa6b0053c
diff --git a/camera/docs/docs.html b/camera/docs/docs.html
index b05afe9..06661ac 100644
--- a/camera/docs/docs.html
+++ b/camera/docs/docs.html
@@ -2176,7 +2176,7 @@
<tr class="entry" id="controls_android.control.effectMode">
- <td class="entry_name" rowspan="1">
+ <td class="entry_name" rowspan="3">
android.<wbr/>control.<wbr/>effect<wbr/>Mode
</td>
<td class="entry_type">
@@ -2187,46 +2187,63 @@
<ul class="entry_type_enum">
<li>
<span class="entry_type_enum_name">OFF</span>
+ <span class="entry_type_enum_notes"><p>No color effect will be applied.<wbr/></p></span>
</li>
<li>
<span class="entry_type_enum_name">MONO</span>
<span class="entry_type_enum_optional">optional</span>
+ <span class="entry_type_enum_notes"><p>A "monocolor" effect where the image is mapped into
+a single color.<wbr/> This will typically be grayscale.<wbr/></p></span>
</li>
<li>
<span class="entry_type_enum_name">NEGATIVE</span>
<span class="entry_type_enum_optional">optional</span>
+ <span class="entry_type_enum_notes"><p>A "photo-negative" effect where the image's colors
+are inverted.<wbr/></p></span>
</li>
<li>
<span class="entry_type_enum_name">SOLARIZE</span>
<span class="entry_type_enum_optional">optional</span>
+ <span class="entry_type_enum_notes"><p>A "solarisation" effect (Sabattier effect) where the
+image is wholly or partially reversed in
+tone.<wbr/></p></span>
</li>
<li>
<span class="entry_type_enum_name">SEPIA</span>
<span class="entry_type_enum_optional">optional</span>
+ <span class="entry_type_enum_notes"><p>A "sepia" effect where the image is mapped into warm
+gray,<wbr/> red,<wbr/> and brown tones.<wbr/></p></span>
</li>
<li>
<span class="entry_type_enum_name">POSTERIZE</span>
<span class="entry_type_enum_optional">optional</span>
+ <span class="entry_type_enum_notes"><p>A "posterization" effect where the image uses
+discrete regions of tone rather than a continuous
+gradient of tones.<wbr/></p></span>
</li>
<li>
<span class="entry_type_enum_name">WHITEBOARD</span>
<span class="entry_type_enum_optional">optional</span>
+ <span class="entry_type_enum_notes"><p>A "whiteboard" effect where the image is typically displayed
+as regions of white,<wbr/> with black or grey details.<wbr/></p></span>
</li>
<li>
<span class="entry_type_enum_name">BLACKBOARD</span>
<span class="entry_type_enum_optional">optional</span>
+ <span class="entry_type_enum_notes"><p>A "blackboard" effect where the image is typically displayed
+as regions of black,<wbr/> with white or grey details.<wbr/></p></span>
</li>
<li>
<span class="entry_type_enum_name">AQUA</span>
<span class="entry_type_enum_optional">optional</span>
+ <span class="entry_type_enum_notes"><p>An "aqua" effect where a blue hue is added to the image.<wbr/></p></span>
</li>
</ul>
</td> <!-- entry_type -->
<td class="entry_description">
- <p>Whether any special color effect is in use.<wbr/>
-Only used if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF</p>
+ <p>A special color effect to apply.<wbr/></p>
</td>
<td class="entry_units">
@@ -2243,6 +2260,21 @@
</td>
</tr>
+ <tr class="entries_header">
+ <th class="th_details" colspan="5">Details</th>
+ </tr>
+ <tr class="entry_cont">
+ <td class="entry_details" colspan="5">
+ <p>When this mode is set,<wbr/> a color effect will be applied
+to images produced by the camera device.<wbr/> The interpretation
+and implementation of these color effects is left to the
+implementor of the camera device,<wbr/> and should not be
+depended on to be consistent (or present) across all
+devices.<wbr/></p>
+<p>A color effect will only be applied if
+<a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF.<wbr/></p>
+ </td>
+ </tr>
<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
@@ -2804,7 +2836,7 @@
<tr class="entry" id="static_android.control.availableEffects">
- <td class="entry_name" rowspan="1">
+ <td class="entry_name" rowspan="3">
android.<wbr/>control.<wbr/>available<wbr/>Effects
</td>
<td class="entry_type">
@@ -2815,21 +2847,23 @@
n
</span>
<span class="entry_type_visibility"> [public]</span>
- <div class="entry_type_notes">list of enums</div>
+ <div class="entry_type_notes">List of enums (android.<wbr/>control.<wbr/>effect<wbr/>Mode).<wbr/></div>
</td> <!-- entry_type -->
<td class="entry_description">
- <p>what subset of the full color effect enum
-list is supported</p>
+ <p>List containing the subset of color effects
+specified in <a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a> that is supported by
+this device.<wbr/></p>
</td>
<td class="entry_units">
</td>
<td class="entry_range">
- <p>OFF must be listed</p>
+ <p>Any subset of enums from those specified in
+<a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a>.<wbr/> OFF must be included in any subset.<wbr/></p>
</td>
<td class="entry_tags">
@@ -2839,6 +2873,21 @@
</td>
</tr>
+ <tr class="entries_header">
+ <th class="th_details" colspan="5">Details</th>
+ </tr>
+ <tr class="entry_cont">
+ <td class="entry_details" colspan="5">
+ <p>This list contains the color effect modes that can be applied to
+images produced by the camera device.<wbr/> Only modes that have
+been fully implemented for the current device may be included here.<wbr/>
+Implementations are not expected to be consistent across all devices.<wbr/>
+If no color effect modes are available for a device,<wbr/> this should
+simply be set to OFF.<wbr/></p>
+<p>A color effect will only be applied if
+<a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF.<wbr/></p>
+ </td>
+ </tr>
<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
diff --git a/camera/docs/metadata_properties.xml b/camera/docs/metadata_properties.xml
index db40996..f1f9bf5 100644
--- a/camera/docs/metadata_properties.xml
+++ b/camera/docs/metadata_properties.xml
@@ -792,19 +792,74 @@
</entry>
<entry name="effectMode" type="byte" visibility="public" enum="true">
<enum>
- <value>OFF</value>
- <value optional="true">MONO</value>
- <value optional="true">NEGATIVE</value>
- <value optional="true">SOLARIZE</value>
- <value optional="true">SEPIA</value>
- <value optional="true">POSTERIZE</value>
- <value optional="true">WHITEBOARD</value>
- <value optional="true">BLACKBOARD</value>
- <value optional="true">AQUA</value>
+ <value>OFF
+ <notes>
+ No color effect will be applied.
+ </notes>
+ </value>
+ <value optional="true">MONO
+ <notes>
+ A "monocolor" effect where the image is mapped into
+ a single color. This will typically be grayscale.
+ </notes>
+ </value>
+ <value optional="true">NEGATIVE
+ <notes>
+ A "photo-negative" effect where the image's colors
+ are inverted.
+ </notes>
+ </value>
+ <value optional="true">SOLARIZE
+ <notes>
+ A "solarisation" effect (Sabattier effect) where the
+ image is wholly or partially reversed in
+ tone.
+ </notes>
+ </value>
+ <value optional="true">SEPIA
+ <notes>
+ A "sepia" effect where the image is mapped into warm
+ gray, red, and brown tones.
+ </notes>
+ </value>
+ <value optional="true">POSTERIZE
+ <notes>
+ A "posterization" effect where the image uses
+ discrete regions of tone rather than a continuous
+ gradient of tones.
+ </notes>
+ </value>
+ <value optional="true">WHITEBOARD
+ <notes>
+ A "whiteboard" effect where the image is typically displayed
+ as regions of white, with black or grey details.
+ </notes>
+ </value>
+ <value optional="true">BLACKBOARD
+ <notes>
+ A "blackboard" effect where the image is typically displayed
+ as regions of black, with white or grey details.
+ </notes>
+ </value>
+ <value optional="true">AQUA
+ <notes>
+ An "aqua" effect where a blue hue is added to the image.
+ </notes>
+ </value>
</enum>
- <description>Whether any special color effect is in use.
- Only used if android.control.mode != OFF</description>
+ <description>A special color effect to apply.</description>
<range>android.control.availableEffects</range>
+ <details>
+ When this mode is set, a color effect will be applied
+ to images produced by the camera device. The interpretation
+ and implementation of these color effects is left to the
+ implementor of the camera device, and should not be
+ depended on to be consistent (or present) across all
+ devices.
+
+ A color effect will only be applied if
+ android.control.mode != OFF.
+ </details>
<tag id="BC" />
</entry>
<entry name="mode" type="byte" visibility="public" enum="true">
@@ -982,13 +1037,30 @@
<tag id="BC" />
</entry>
<entry name="availableEffects" type="byte" visibility="public"
- type_notes="list of enums" container="array">
+ type_notes="List of enums (android.control.effectMode)." container="array">
<array>
<size>n</size>
</array>
- <description>what subset of the full color effect enum
- list is supported</description>
- <range>OFF must be listed</range>
+ <description>
+ List containing the subset of color effects
+ specified in android.control.effectMode that is supported by
+ this device.
+ </description>
+ <range>
+ Any subset of enums from those specified in
+ android.control.effectMode. OFF must be included in any subset.
+ </range>
+ <details>
+ This list contains the color effect modes that can be applied to
+ images produced by the camera device. Only modes that have
+ been fully implemented for the current device may be included here.
+ Implementations are not expected to be consistent across all devices.
+ If no color effect modes are available for a device, this should
+ simply be set to OFF.
+
+ A color effect will only be applied if
+ android.control.mode != OFF.
+ </details>
<tag id="BC" />
</entry>
<entry name="availableSceneModes" type="byte" visibility="public"