Camera: Add partialResult quirk metadata fields
To be used by HALs to split up capture results into
multiple batches.
Bug: 11115603
Change-Id: I5cfc26b2812f9bf4613944c0679e0e29cfd43616
diff --git a/camera/docs/docs.html b/camera/docs/docs.html
index d4f29fb..0c0b25e 100644
--- a/camera/docs/docs.html
+++ b/camera/docs/docs.html
@@ -386,6 +386,13 @@
<li><a href="#static_android.quirks.meteringCropRegion">android.quirks.meteringCropRegion</a></li>
<li><a href="#static_android.quirks.triggerAfWithAuto">android.quirks.triggerAfWithAuto</a></li>
<li><a href="#static_android.quirks.useZslFormat">android.quirks.useZslFormat</a></li>
+ <li><a href="#static_android.quirks.usePartialResult">android.quirks.usePartialResult</a></li>
+ </ul>
+ </li>
+ <li>
+ <span class="toc_kind_header">dynamic</span>
+ <ul class="toc_section">
+ <li><a href="#dynamic_android.quirks.partialResult">android.quirks.partialResult</a></li>
</ul>
</li>
</ul> <!-- toc_section -->
@@ -6518,6 +6525,129 @@
</tr> <!-- end of entry -->
+
+ <tr class="entry" id="static_android.quirks.usePartialResult">
+ <td class="entry_name">android.<wbr>quirks.<wbr>use<wbr>Partial<wbr>Result</td>
+ <td class="entry_type">
+ <span class="entry_type_name">byte</span>
+
+ <span class="entry_type_visibility"> [system]</span>
+
+
+ </td> <!-- entry_type -->
+
+ <td class="entry_description">
+ If set to 1,<wbr> the HAL will always split result
+ metadata for a single capture into multiple buffers,<wbr>
+ returned using multiple process_<wbr>capture_<wbr>result calls.<wbr>
+
+ </td>
+
+ <td class="entry_units">
+ </td>
+
+ <td class="entry_range">
+ </td>
+
+ <td class="entry_notes">
+ Does not need to be listed in static
+ metadata.<wbr> Support for partial results will be reworked in
+ future versions of camera service.<wbr> This quirk will stop
+ working at that point; DO NOT USE without careful
+ consideration of future support.<wbr>
+
+ </td>
+
+ <td class="entry_tags">
+ </td>
+
+ </tr> <!-- end of entry -->
+
+
+
+ <!-- end of kind -->
+ </tbody>
+ <tr><td colspan="7" class="kind">dynamic</td></tr>
+
+ <thead class="entries_header">
+ <tr>
+ <th class="th_name">Property Name</th>
+ <th class="th_type">Type</th>
+ <th class="th_description">Description</th>
+ <th class="th_units">Units</th>
+ <th class="th_range">Range</th>
+ <th class="th_notes">Notes</th>
+ <th class="th_tags">Tags</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+
+
+
+
+
+
+
+
+ <tr class="entry" id="dynamic_android.quirks.partialResult">
+ <td class="entry_name">android.<wbr>quirks.<wbr>partial<wbr>Result</td>
+ <td class="entry_type">
+ <span class="entry_type_name entry_type_name_enum">byte</span>
+
+ <span class="entry_type_visibility"> [system as boolean]</span>
+
+ <ul class="entry_type_enum">
+ <li>
+ <span class="entry_type_enum_name">FINAL</span>
+ <span class="entry_type_enum_notes">The last or only metadata result buffer
+ for this capture.<wbr></span>
+ </li>
+ <li>
+ <span class="entry_type_enum_name">PARTIAL</span>
+ <span class="entry_type_enum_notes">A partial buffer of result metadata for this
+ capture.<wbr> More result buffers for this capture will be sent
+ by the HAL,<wbr> the last of which will be marked
+ FINAL.<wbr></span>
+ </li>
+ </ul>
+
+ </td> <!-- entry_type -->
+
+ <td class="entry_description">
+ Whether a result given to the framework is the
+ final one for the capture,<wbr> or only a partial that contains a
+ subset of the full set of dynamic metadata
+ values.<wbr>
+ </td>
+
+ <td class="entry_units">
+ </td>
+
+ <td class="entry_range">
+ Optional.<wbr> Default value is FINAL.<wbr>
+ </td>
+
+ <td class="entry_notes">
+ The entries in the result metadata buffers for a
+ single capture may not overlap,<wbr> except for this entry.<wbr> The
+ FINAL buffers must retain FIFO ordering relative to the
+ requests that generate them,<wbr> so the FINAL buffer for frame 3 must
+ always be sent to the framework after the FINAL buffer for frame 2,<wbr> and
+ before the FINAL buffer for frame 4.<wbr> PARTIAL buffers may be returned
+ in any order relative to other frames,<wbr> but all PARTIAL buffers for a given
+ capture must arrive before the FINAL buffer for that capture.<wbr> This entry may
+ only be used by the HAL if quirks.<wbr>usePartialResult is set to 1.<wbr>
+
+ </td>
+
+ <td class="entry_tags">
+ </td>
+
+ </tr> <!-- end of entry -->
+
<!-- end of kind -->