NdkCameraDevice.h revision e2b43843fd12783188edd2c54188ea8d26864788
1/*
2 * Copyright (C) 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17/**
18 * @addtogroup Camera
19 * @{
20 */
21
22/**
23 * @file NdkCameraDevice.h
24 */
25
26/*
27 * This file defines an NDK API.
28 * Do not remove methods.
29 * Do not change method signatures.
30 * Do not change the value of constants.
31 * Do not change the size of any of the classes defined in here.
32 * Do not reference types that are not part of the NDK.
33 * Do not #include files that aren't part of the NDK.
34 */
35#include <sys/cdefs.h>
36
37#include <android/native_window.h>
38#include "NdkCameraError.h"
39#include "NdkCaptureRequest.h"
40#include "NdkCameraCaptureSession.h"
41
42#ifndef _NDK_CAMERA_DEVICE_H
43#define _NDK_CAMERA_DEVICE_H
44
45__BEGIN_DECLS
46
47#if __ANDROID_API__ >= 24
48
49/**
50 * ACameraDevice is opaque type that provides access to a camera device.
51 *
52 * A pointer can be obtained using {@link ACameraManager_openCamera} method.
53 */
54typedef struct ACameraDevice ACameraDevice;
55
56/// Enum for ACameraDevice_ErrorStateCallback error code
57enum {
58    /**
59     * The camera device is in use already.
60     */
61    ERROR_CAMERA_IN_USE = 1,
62
63    /**
64     * The system-wide limit for number of open cameras or camera resources has
65     * been reached, and more camera devices cannot be opened until previous
66     * instances are closed.
67     */
68    ERROR_MAX_CAMERAS_IN_USE = 2,
69
70    /**
71     * The camera is disabled due to a device policy, and cannot be opened.
72     */
73    ERROR_CAMERA_DISABLED = 3,
74
75    /**
76     * The camera device has encountered a fatal error.
77     * <p>The camera device needs to be re-opened to be used again.</p>
78     */
79    ERROR_CAMERA_DEVICE = 4,
80
81    /**
82     * The camera service has encountered a fatal error.
83     * <p>The Android device may need to be shut down and restarted to restore
84     * camera function, or there may be a persistent hardware problem.
85     * An attempt at recovery may be possible by closing the
86     * CameraDevice and the CameraManager, and trying to acquire all resources
87     * again from scratch.</p>
88     */
89    ERROR_CAMERA_SERVICE = 5
90};
91
92/**
93 * Camera device state callbacks to be used in {@link ACameraDevice_stateCallbacks}.
94 *
95 * @param context The optional context in {@link ACameraDevice_stateCallbacks} will be
96 *                passed to this callback.
97 * @param device The {@link ACameraDevice} that is being disconnected.
98 */
99typedef void (*ACameraDevice_StateCallback)(void* context, ACameraDevice* device);
100
101/**
102 * Camera device error state callbacks to be used in {@link ACameraDevice_stateCallbacks}.
103 *
104 * @param context The optional context in {@link ACameraDevice_stateCallbacks} will be
105 *                passed to this callback.
106 * @param device The {@link ACameraDevice} that is being disconnected.
107 * @param error The error code describes the cause of this error callback. See the folowing
108 *              links for more detail.
109 *
110 * @see ERROR_CAMERA_IN_USE
111 * @see ERROR_MAX_CAMERAS_IN_USE
112 * @see ERROR_CAMERA_DISABLED
113 * @see ERROR_CAMERA_DEVICE
114 * @see ERROR_CAMERA_SERVICE
115 */
116typedef void (*ACameraDevice_ErrorStateCallback)(void* context, ACameraDevice* device, int error);
117
118typedef struct ACameraDevice_StateCallbacks {
119    /// optional application context.
120    void*                             context;
121
122    /**
123     * The function is  called when a camera device is no longer available for use.
124     *
125     * <p>Any attempt to call API methods on this ACameraDevice will return
126     * {@link ACAMERA_ERROR_CAMERA_DISCONNECTED}. The disconnection could be due to a
127     * change in security policy or permissions; the physical disconnection
128     * of a removable camera device; or the camera being needed for a
129     * higher-priority camera API client.</p>
130     *
131     * <p>Application should clean up the camera with {@link ACameraDevice_close} after
132     * this happens, as it is not recoverable until the camera can be opened
133     * again.</p>
134     *
135     */
136    ACameraDevice_StateCallback       onDisconnected;
137
138    /**
139     * The function called when a camera device has encountered a serious error.
140     *
141     * <p>This indicates a failure of the camera device or camera service in some way.
142     * Any attempt to call API methods on this ACameraDevice in the future will return
143     * {@link ACAMERA_ERROR_CAMERA_DISCONNECTED}.</p>
144     *
145     * <p>There may still be capture completion or camera stream callbacks that will be called
146     * after this error is received.</p>
147     *
148     * <p>Application should clean up the camera with {@link ACameraDevice_close} after this
149     * happens. Further attempts at recovery are error-code specific.</p>
150     *
151     */
152    ACameraDevice_ErrorStateCallback  onError;
153} ACameraDevice_stateCallbacks;
154
155/**
156 * Close the connection and free this ACameraDevice synchronously. Access to the ACameraDevice
157 * after calling this method will cause a crash.
158 *
159 * <p>After this call, all calls to the active ACameraCaptureSession associated to this
160 * ACameraDevice will return {@link ACAMERA_ERROR_SESSION_CLOSED} except for calls to
161 * {@link ACameraCaptureSession_close}.</p>
162 *
163 * <p>This method will stop all repeating captures sent via
164 * {@link ACameraCaptureSession_setRepeatingRequest} and block until all capture requests sent via
165 * {@link ACameraCaptureSession_capture} is complete. Once the method returns, the camera device
166 * will be removed from memory and access to the closed camera device pointer will cause a crash.</p>
167 *
168 * @param device the camera device to be closed
169 *
170 * @return <ul>
171 *         <li>{@link ACAMERA_OK} if the method call succeeds.</li>
172 *         <li>{@link ACAMERA_ERROR_INVALID_PARAMETER} if device is NULL.</li></ul>
173 */
174camera_status_t ACameraDevice_close(ACameraDevice* device);
175
176/**
177 * Return the camera id associated with this camera device.
178 *
179 * @param device the camera device to be closed
180 *
181 * @return camera ID string. The returned string is managed by framework and should not be
182 * delete/free by the application. Also the returned string must not be used after the device
183 * has been closed.
184 */
185const char* ACameraDevice_getId(const ACameraDevice* device);
186
187typedef enum {
188    /**
189     * Create a request suitable for a camera preview window. Specifically, this
190     * means that high frame rate is given priority over the highest-quality
191     * post-processing. These requests would normally be used with the
192     * {@link ACameraCaptureSession_setRepeatingRequest} method.
193     * This template is guaranteed to be supported on all camera devices.
194     *
195     * @see ACameraDevice_createCaptureRequest
196     */
197    TEMPLATE_PREVIEW = 1,
198
199    /**
200     * Create a request suitable for still image capture. Specifically, this
201     * means prioritizing image quality over frame rate. These requests would
202     * commonly be used with the {@link ACameraCaptureSession_capture} method.
203     * This template is guaranteed to be supported on all camera devices.
204     *
205     * @see ACameraDevice_createCaptureRequest
206     */
207    TEMPLATE_STILL_CAPTURE = 2,
208
209    /**
210     * Create a request suitable for video recording. Specifically, this means
211     * that a stable frame rate is used, and post-processing is set for
212     * recording quality. These requests would commonly be used with the
213     * {@link ACameraCaptureSession_setRepeatingRequest} method.
214     * This template is guaranteed to be supported on all camera devices.
215     *
216     * @see ACameraDevice_createCaptureRequest
217     */
218    TEMPLATE_RECORD = 3,
219
220    /**
221     * Create a request suitable for still image capture while recording
222     * video. Specifically, this means maximizing image quality without
223     * disrupting the ongoing recording. These requests would commonly be used
224     * with the {@link ACameraCaptureSession_capture} method while a request based on
225     * {@link TEMPLATE_RECORD} is is in use with {@link ACameraCaptureSession_setRepeatingRequest}.
226     * This template is guaranteed to be supported on all camera devices.
227     *
228     * @see ACameraDevice_createCaptureRequest
229     */
230    TEMPLATE_VIDEO_SNAPSHOT = 4,
231
232    /**
233     * Create a request suitable for zero shutter lag still capture. This means
234     * means maximizing image quality without compromising preview frame rate.
235     * AE/AWB/AF should be on auto mode.
236     *
237     * @see ACameraDevice_createCaptureRequest
238     */
239    TEMPLATE_ZERO_SHUTTER_LAG = 5,
240
241    /**
242     * A basic template for direct application control of capture
243     * parameters. All automatic control is disabled (auto-exposure, auto-white
244     * balance, auto-focus), and post-processing parameters are set to preview
245     * quality. The manual capture parameters (exposure, sensitivity, and so on)
246     * are set to reasonable defaults, but should be overriden by the
247     * application depending on the intended use case.
248     * This template is guaranteed to be supported on camera devices that support the
249     * {@link ACAMERA_REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR} capability.
250     *
251     * @see ACameraDevice_createCaptureRequest
252     */
253    TEMPLATE_MANUAL = 6,
254} ACameraDevice_request_template;
255
256/**
257 * Create a ACaptureRequest for capturing images, initialized with template
258 * for a target use case.
259 *
260 * <p>The settings are chosen to be the best options for this camera device,
261 * so it is not recommended to reuse the same request for a different camera device.</p>
262 *
263 * @param device the camera device of interest
264 * @param templateId the type of capture request to be created.
265 *        See {@link ACameraDevice_request_template}.
266 * @param request the output request will be stored here if the method call succeeds.
267 *
268 * @return <ul>
269 *         <li>{@link ACAMERA_OK} if the method call succeeds. The created capture request will be
270 *                                filled in request argument.</li>
271 *         <li>{@link ACAMERA_ERROR_INVALID_PARAMETER} if device or request is NULL, templateId
272 *                                is undefined or camera device does not support requested template.
273 *                                </li>
274 *         <li>{@link ACAMERA_ERROR_CAMERA_DISCONNECTED} if the camera device is closed.</li>
275 *         <li>{@link ACAMERA_ERROR_CAMERA_DEVICE} if the camera device encounters fatal error.</li>
276 *         <li>{@link ACAMERA_ERROR_CAMERA_SERVICE} if the camera service encounters fatal error.</li>
277 *         <li>{@link ACAMERA_ERROR_UNKNOWN} if the method fails for some other reasons.</li></ul>
278 *
279 * @see TEMPLATE_PREVIEW
280 * @see TEMPLATE_RECORD
281 * @see TEMPLATE_STILL_CAPTURE
282 * @see TEMPLATE_VIDEO_SNAPSHOT
283 * @see TEMPLATE_MANUAL
284 */
285camera_status_t ACameraDevice_createCaptureRequest(
286        const ACameraDevice* device, ACameraDevice_request_template templateId,
287        /*out*/ACaptureRequest** request);
288
289
290typedef struct ACaptureSessionOutputContainer ACaptureSessionOutputContainer;
291
292typedef struct ACaptureSessionOutput ACaptureSessionOutput;
293
294/**
295 * Create a capture session output container.
296 *
297 * <p>The container is used in {@link ACameraDevice_createCaptureSession} method to create a capture
298 * session. Use {@link ACaptureSessionOutputContainer_free} to free the container and its memory
299 * after application no longer needs the ACaptureSessionOutputContainer.</p>
300 *
301 * @param container the output {@link ACaptureSessionOutputContainer} will be stored here if the
302 *                  method call succeeds.
303 *
304 * @return <ul>
305 *         <li>{@link ACAMERA_OK} if the method call succeeds. The created container will be
306 *                                filled in container argument.</li>
307 *         <li>{@link ACAMERA_ERROR_INVALID_PARAMETER} if container is NULL.</li></ul>
308 */
309camera_status_t ACaptureSessionOutputContainer_create(
310        /*out*/ACaptureSessionOutputContainer** container);
311
312/**
313 * Free a capture session output container.
314 *
315 * @param container the {@link ACaptureSessionOutputContainer} to be freed.
316 *
317 * @see ACaptureSessionOutputContainer_create
318 */
319void            ACaptureSessionOutputContainer_free(ACaptureSessionOutputContainer* container);
320
321/**
322 * Create a ACaptureSessionOutput object.
323 *
324 * <p>The ACaptureSessionOutput is used in {@link ACaptureSessionOutputContainer_add} method to add
325 * an output {@link ANativeWindow} to ACaptureSessionOutputContainer. Use
326 * {@link ACaptureSessionOutput_free} to free the object and its memory after application no longer
327 * needs the {@link ACaptureSessionOutput}.</p>
328 *
329 * @param anw the {@link ANativeWindow} to be associated with the {@link ACaptureSessionOutput}
330 * @param output the output {@link ACaptureSessionOutput} will be stored here if the
331 *                  method call succeeds.
332 *
333 * @return <ul>
334 *         <li>{@link ACAMERA_OK} if the method call succeeds. The created container will be
335 *                                filled in the output argument.</li>
336 *         <li>{@link ACAMERA_ERROR_INVALID_PARAMETER} if anw or output is NULL.</li></ul>
337 *
338 * @see ACaptureSessionOutputContainer_add
339 */
340camera_status_t ACaptureSessionOutput_create(
341        ANativeWindow* anw, /*out*/ACaptureSessionOutput** output);
342
343/**
344 * Free a ACaptureSessionOutput object.
345 *
346 * @param output the {@link ACaptureSessionOutput} to be freed.
347 *
348 * @see ACaptureSessionOutput_create
349 */
350void            ACaptureSessionOutput_free(ACaptureSessionOutput* output);
351
352/**
353 * Add an {@link ACaptureSessionOutput} object to {@link ACaptureSessionOutputContainer}.
354 *
355 * @param container the {@link ACaptureSessionOutputContainer} of interest.
356 * @param output the output {@link ACaptureSessionOutput} to be added to container.
357 *
358 * @return <ul>
359 *         <li>{@link ACAMERA_OK} if the method call succeeds.</li>
360 *         <li>{@link ACAMERA_ERROR_INVALID_PARAMETER} if container or output is NULL.</li></ul>
361 */
362camera_status_t ACaptureSessionOutputContainer_add(
363        ACaptureSessionOutputContainer* container, const ACaptureSessionOutput* output);
364
365/**
366 * Remove an {@link ACaptureSessionOutput} object from {@link ACaptureSessionOutputContainer}.
367 *
368 * <p>This method has no effect if the ACaptureSessionOutput does not exist in
369 * ACaptureSessionOutputContainer.</p>
370 *
371 * @param container the {@link ACaptureSessionOutputContainer} of interest.
372 * @param output the output {@link ACaptureSessionOutput} to be removed from container.
373 *
374 * @return <ul>
375 *         <li>{@link ACAMERA_OK} if the method call succeeds.</li>
376 *         <li>{@link ACAMERA_ERROR_INVALID_PARAMETER} if container or output is NULL.</li></ul>
377 */
378camera_status_t ACaptureSessionOutputContainer_remove(
379        ACaptureSessionOutputContainer* container, const ACaptureSessionOutput* output);
380
381/**
382 * Create a new camera capture session by providing the target output set of {@link ANativeWindow}
383 * to the camera device.
384 *
385 * <p>If there is a preexisting session, the previous session will be closed
386 * automatically. However, app still needs to call {@link ACameraCaptureSession_close} on previous
387 * session. Otherwise the resources held by previous session will NOT be freed.</p>
388 *
389 * <p>The active capture session determines the set of potential output {@link ANativeWindow}s for
390 * the camera device for each capture request. A given request may use all
391 * or only some of the outputs. Once the ACameraCaptureSession is created, requests can be
392 * submitted with {@link ACameraCaptureSession_capture} or
393 * {@link ACameraCaptureSession_setRepeatingRequest}.</p>
394 *
395 * <p>Often the {@link ANativeWindow} used with this method can be obtained from a <a href=
396 * "http://developer.android.com/reference/android/view/Surface.html">Surface</a> java object by
397 * {@link ANativeWindow_fromSurface} NDK method. Surfaces or ANativeWindow suitable for inclusion as a camera
398 * output can be created for various use cases and targets:</p>
399 *
400 * <ul>
401 *
402 * <li>For drawing to a
403 *   <a href="http://developer.android.com/reference/android/view/SurfaceView.html">SurfaceView</a>:
404 *   Once the SurfaceView's Surface is created, set the size
405 *   of the Surface with
406 *   <a href="http://developer.android.com/reference/android/view/SurfaceHolder.html#setFixedSize(int, int)">
407 *    android.view.SurfaceHolder\#setFixedSize</a> to be one of the PRIVATE output sizes
408 *   returned by {@link ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS}
409 *   and then obtain the Surface by calling <a href=
410 *   "http://developer.android.com/reference/android/view/SurfaceHolder.html#getSurface()">
411 *   android.view.SurfaceHolder\#getSurface</a>. If the size is not set by the application, it will
412 *   be rounded to the nearest supported size less than 1080p, by the camera device.</li>
413 *
414 * <li>For accessing through an OpenGL texture via a <a href=
415 *   "http://developer.android.com/reference/android/graphics/SurfaceTexture.html">SurfaceTexture</a>:
416 *   Set the size of the SurfaceTexture with <a href=
417 *   "http://developer.android.com/reference/android/graphics/SurfaceTexture.html#setDefaultBufferSize(int, int)">
418 *   setDefaultBufferSize</a> to be one of the PRIVATE output sizes
419 *   returned by {@link ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS}
420 *   before creating a Surface from the SurfaceTexture with <a href=
421 *   "http://developer.android.com/reference/android/view/Surface.html#Surface(android.graphics.SurfaceTexture)">
422 *   Surface\#Surface(SurfaceTextrue)</a>. If the size is not set by the application, it will be set to be the
423 *   smallest supported size less than 1080p, by the camera device.</li>
424 *
425 * <li>For recording with <a href=
426 *     "http://developer.android.com/reference/android/media/MediaCodec.html">
427 *     MediaCodec</a>: Call
428 *   <a href=
429 *     "http://developer.android.com/reference/android/media/MediaCodec.html#createInputSurface()">
430 *     android.media.MediaCodec\#createInputSurface</a> after configuring
431 *   the media codec to use one of the PRIVATE output sizes
432 *   returned by {@link ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS}.
433 *   </li>
434 *
435 * <li>For recording with <a href=
436 *    "http://developer.android.com/reference/android/media/MediaRecorder.html">
437 *    MediaRecorder</a>: Call
438 *   <a href="http://developer.android.com/reference/android/media/MediaRecorder.html#getSurface()">
439 *    android.media.MediaRecorder\#getSurface</a> after configuring the media recorder to use
440 *   one of the PRIVATE output sizes returned by
441 *   {@link ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS}, or configuring it to use one of the supported
442 *   <a href="http://developer.android.com/reference/android/media/CamcorderProfile.html">
443 *    CamcorderProfiles</a>.</li>
444 *
445 * <li>For efficient YUV processing with <a href=
446 *   "http://developer.android.com/reference/android/renderscript/package-summary.html">
447 *   RenderScript</a>:
448 *   Create a RenderScript
449 *   <a href="http://developer.android.com/reference/android/renderscript/Allocation.html">
450 *   Allocation</a> with a supported YUV
451 *   type, the IO_INPUT flag, and one of the YUV output sizes returned by
452 *   {@link ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS},
453 *   Then obtain the Surface with
454 *   <a href="http://developer.android.com/reference/android/renderscript/Allocation.html#getSurface()">
455 *   Allocation#getSurface}</a>.</li>
456 *
457 * <li>For access to RAW, uncompressed YUV, or compressed JPEG data in the application: Create an
458 *   {@link AImageReader} object using the {@link AImageReader_new} method with one of the supported
459 *   output formats given by {@link ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS}. Then obtain a
460 *   ANativeWindow from it with {@link AImageReader_getWindow}.
461 *   If the AImageReader size is not set to a supported size, it will be rounded to a supported
462 *   size less than 1080p by the camera device.
463 *   </li>
464 *
465 * </ul>
466 *
467 * <p>The camera device will query each ANativeWindow's size and formats upon this
468 * call, so they must be set to a valid setting at this time.</p>
469 *
470 * <p>It can take several hundred milliseconds for the session's configuration to complete,
471 * since camera hardware may need to be powered on or reconfigured.</p>
472 *
473 * <p>If a prior ACameraCaptureSession already exists when this method is called, the previous
474 * session will no longer be able to accept new capture requests and will be closed. Any
475 * in-progress capture requests made on the prior session will be completed before it's closed.
476 * To minimize the transition time,
477 * the ACameraCaptureSession_abortCaptures method can be used to discard the remaining
478 * requests for the prior capture session before a new one is created. Note that once the new
479 * session is created, the old one can no longer have its captures aborted.</p>
480 *
481 * <p>Using larger resolution outputs, or more outputs, can result in slower
482 * output rate from the device.</p>
483 *
484 * <p>Configuring a session with an empty list will close the current session, if
485 * any. This can be used to release the current session's target surfaces for another use.</p>
486 *
487 * <p>While any of the sizes from {@link ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS} can be used when
488 * a single output stream is configured, a given camera device may not be able to support all
489 * combination of sizes, formats, and targets when multiple outputs are configured at once.  The
490 * tables below list the maximum guaranteed resolutions for combinations of streams and targets,
491 * given the capabilities of the camera device.</p>
492 *
493 * <p>If an application tries to create a session using a set of targets that exceed the limits
494 * described in the below tables, one of three possibilities may occur. First, the session may
495 * be successfully created and work normally. Second, the session may be successfully created,
496 * but the camera device won't meet the frame rate guarantees as described in
497 * {@link ACAMERA_SCALER_AVAILABLE_MIN_FRAME_DURATIONS}. Or third, if the output set
498 * cannot be used at all, session creation will fail entirely, with
499 * {@link ACAMERA_ERROR_STREAM_CONFIGURE_FAIL} being returned.</p>
500 *
501 * <p>For the type column `PRIV` refers to output format {@link AIMAGE_FORMAT_PRIVATE},
502 * `YUV` refers to output format {@link AIMAGE_FORMAT_YUV_420_888},
503 * `JPEG` refers to output format {@link AIMAGE_FORMAT_JPEG},
504 * and `RAW` refers to output format {@link AIMAGE_FORMAT_RAW16}
505 *
506 *
507 * <p>For the maximum size column, `PREVIEW` refers to the best size match to the
508 * device's screen resolution, or to 1080p `(1920x1080)`, whichever is
509 * smaller. `RECORD` refers to the camera device's maximum supported recording resolution,
510 * as determined by <a href="http://developer.android.com/reference/android/media/CamcorderProfile.html">
511 * android.media.CamcorderProfiles</a>. And `MAXIMUM` refers to the
512 * camera device's maximum output resolution for that format or target from
513 * {@link ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS}.</p>
514 *
515 * <p>To use these tables, determine the number and the formats/targets of outputs needed, and
516 * find the row(s) of the table with those targets. The sizes indicate the maximum set of sizes
517 * that can be used; it is guaranteed that for those targets, the listed sizes and anything
518 * smaller from the list given by {@link ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS} can be
519 * successfully used to create a session.  For example, if a row indicates that a 8 megapixel
520 * (MP) YUV_420_888 output can be used together with a 2 MP `PRIV` output, then a session
521 * can be created with targets `[8 MP YUV, 2 MP PRIV]` or targets `[2 MP YUV, 2 MP PRIV]`;
522 * but a session with targets `[8 MP YUV, 4 MP PRIV]`, targets `[4 MP YUV, 4 MP PRIV]`,
523 * or targets `[8 MP PRIV, 2 MP YUV]` would not be guaranteed to work, unless
524 * some other row of the table lists such a combination.</p>
525 *
526 * <p>Legacy devices ({@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL}
527 * `== `{@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY LEGACY}) support at
528 * least the following stream combinations:
529 *
530 * <table>
531 * <tr><th colspan="7">LEGACY-level guaranteed configurations</th></tr>
532 * <tr> <th colspan="2" id="rb">Target 1</th> <th colspan="2" id="rb">Target 2</th>  <th colspan="2" id="rb">Target 3</th> <th rowspan="2">Sample use case(s)</th> </tr>
533 * <tr> <th>Type</th><th id="rb">Max size</th> <th>Type</th><th id="rb">Max size</th> <th>Type</th><th id="rb">Max size</th></tr>
534 * <tr> <td>`PRIV`</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td colspan="2" id="rb"></td> <td>Simple preview, GPU video processing, or no-preview video recording.</td> </tr>
535 * <tr> <td>`JPEG`</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td colspan="2" id="rb"></td> <td>No-viewfinder still image capture.</td> </tr>
536 * <tr> <td>`YUV `</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td colspan="2" id="rb"></td> <td>In-application video/image processing.</td> </tr>
537 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`JPEG`</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td>Standard still imaging.</td> </tr>
538 * <tr> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`JPEG`</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td>In-app processing plus still capture.</td> </tr>
539 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td colspan="2" id="rb"></td> <td>Standard recording.</td> </tr>
540 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td colspan="2" id="rb"></td> <td>Preview plus in-app processing.</td> </tr>
541 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`JPEG`</td><td id="rb">`MAXIMUM`</td> <td>Still capture plus in-app processing.</td> </tr>
542 * </table><br>
543 * </p>
544 *
545 * <p>Limited-level ({@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL}
546 * `== `{@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED}) devices
547 * support at least the following stream combinations in addition to those for
548 * {@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY LEGACY} devices:
549 *
550 * <table>
551 * <tr><th colspan="7">LIMITED-level additional guaranteed configurations</th></tr>
552 * <tr><th colspan="2" id="rb">Target 1</th><th colspan="2" id="rb">Target 2</th><th colspan="2" id="rb">Target 3</th> <th rowspan="2">Sample use case(s)</th> </tr>
553 * <tr><th>Type</th><th id="rb">Max size</th><th>Type</th><th id="rb">Max size</th><th>Type</th><th id="rb">Max size</th></tr>
554 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`PRIV`</td><td id="rb">`RECORD `</td> <td colspan="2" id="rb"></td> <td>High-resolution video recording with preview.</td> </tr>
555 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`RECORD `</td> <td colspan="2" id="rb"></td> <td>High-resolution in-app video processing with preview.</td> </tr>
556 * <tr> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`RECORD `</td> <td colspan="2" id="rb"></td> <td>Two-input in-app video processing.</td> </tr>
557 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`PRIV`</td><td id="rb">`RECORD `</td> <td>`JPEG`</td><td id="rb">`RECORD `</td> <td>High-resolution recording with video snapshot.</td> </tr>
558 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`RECORD `</td> <td>`JPEG`</td><td id="rb">`RECORD `</td> <td>High-resolution in-app processing with video snapshot.</td> </tr>
559 * <tr> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`JPEG`</td><td id="rb">`MAXIMUM`</td> <td>Two-input in-app processing with still capture.</td> </tr>
560 * </table><br>
561 * </p>
562 *
563 * <p>FULL-level ({@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL}
564 * `== `{@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL}) devices
565 * support at least the following stream combinations in addition to those for
566 * {@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED} devices:
567 *
568 * <table>
569 * <tr><th colspan="7">FULL-level additional guaranteed configurations</th></tr>
570 * <tr><th colspan="2" id="rb">Target 1</th><th colspan="2" id="rb">Target 2</th><th colspan="2" id="rb">Target 3</th> <th rowspan="2">Sample use case(s)</th> </tr>
571 * <tr><th>Type</th><th id="rb">Max size</th><th>Type</th><th id="rb">Max size</th><th>Type</th><th id="rb">Max size</th> </tr>
572 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`PRIV`</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td>Maximum-resolution GPU processing with preview.</td> </tr>
573 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td>Maximum-resolution in-app processing with preview.</td> </tr>
574 * <tr> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td>Maximum-resolution two-input in-app processsing.</td> </tr>
575 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`JPEG`</td><td id="rb">`MAXIMUM`</td> <td>Video recording with maximum-size video snapshot</td> </tr>
576 * <tr> <td>`YUV `</td><td id="rb">`640x480`</td> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`MAXIMUM`</td> <td>Standard video recording plus maximum-resolution in-app processing.</td> </tr>
577 * <tr> <td>`YUV `</td><td id="rb">`640x480`</td> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`MAXIMUM`</td> <td>Preview plus two-input maximum-resolution in-app processing.</td> </tr>
578 * </table><br>
579 * </p>
580 *
581 * <p>RAW-capability ({@link ACAMERA_REQUEST_AVAILABLE_CAPABILITIES} includes
582 * {@link ACAMERA_REQUEST_AVAILABLE_CAPABILITIES_RAW RAW}) devices additionally support
583 * at least the following stream combinations on both
584 * {@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL} and
585 * {@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED} devices:
586 *
587 * <table>
588 * <tr><th colspan="7">RAW-capability additional guaranteed configurations</th></tr>
589 * <tr><th colspan="2" id="rb">Target 1</th><th colspan="2" id="rb">Target 2</th><th colspan="2" id="rb">Target 3</th> <th rowspan="2">Sample use case(s)</th> </tr>
590 * <tr><th>Type</th><th id="rb">Max size</th><th>Type</th><th id="rb">Max size</th><th>Type</th><th id="rb">Max size</th> </tr>
591 * <tr> <td>`RAW `</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td colspan="2" id="rb"></td> <td>No-preview DNG capture.</td> </tr>
592 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`RAW `</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td>Standard DNG capture.</td> </tr>
593 * <tr> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`RAW `</td><td id="rb">`MAXIMUM`</td> <td colspan="2" id="rb"></td> <td>In-app processing plus DNG capture.</td> </tr>
594 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`RAW `</td><td id="rb">`MAXIMUM`</td> <td>Video recording with DNG capture.</td> </tr>
595 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`RAW `</td><td id="rb">`MAXIMUM`</td> <td>Preview with in-app processing and DNG capture.</td> </tr>
596 * <tr> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`RAW `</td><td id="rb">`MAXIMUM`</td> <td>Two-input in-app processing plus DNG capture.</td> </tr>
597 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`JPEG`</td><td id="rb">`MAXIMUM`</td> <td>`RAW `</td><td id="rb">`MAXIMUM`</td> <td>Still capture with simultaneous JPEG and DNG.</td> </tr>
598 * <tr> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`JPEG`</td><td id="rb">`MAXIMUM`</td> <td>`RAW `</td><td id="rb">`MAXIMUM`</td> <td>In-app processing with simultaneous JPEG and DNG.</td> </tr>
599 * </table><br>
600 * </p>
601 *
602 * <p>BURST-capability ({@link ACAMERA_REQUEST_AVAILABLE_CAPABILITIES} includes
603 * {@link ACAMERA_REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE BURST_CAPTURE}) devices
604 * support at least the below stream combinations in addition to those for
605 * {@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED} devices. Note that all
606 * FULL-level devices support the BURST capability, and the below list is a strict subset of the
607 * list for FULL-level devices, so this table is only relevant for LIMITED-level devices that
608 * support the BURST_CAPTURE capability.
609 *
610 * <table>
611 * <tr><th colspan="5">BURST-capability additional guaranteed configurations</th></tr>
612 * <tr><th colspan="2" id="rb">Target 1</th><th colspan="2" id="rb">Target 2</th><th rowspan="2">Sample use case(s)</th> </tr>
613 * <tr><th>Type</th><th id="rb">Max size</th><th>Type</th><th id="rb">Max size</th> </tr>
614 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`PRIV`</td><td id="rb">`MAXIMUM`</td> <td>Maximum-resolution GPU processing with preview.</td> </tr>
615 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`MAXIMUM`</td> <td>Maximum-resolution in-app processing with preview.</td> </tr>
616 * <tr> <td>`YUV `</td><td id="rb">`PREVIEW`</td> <td>`YUV `</td><td id="rb">`MAXIMUM`</td> <td>Maximum-resolution two-input in-app processsing.</td> </tr>
617 * </table><br>
618 * </p>
619 *
620 * <p>LEVEL-3 ({@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL}
621 * `== `{@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL_3 LEVEL_3})
622 * support at least the following stream combinations in addition to the combinations for
623 * {@link ACAMERA_INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL} and for
624 * RAW capability ({@link ACAMERA_REQUEST_AVAILABLE_CAPABILITIES} includes
625 * {@link ACAMERA_REQUEST_AVAILABLE_CAPABILITIES_RAW RAW}):
626 *
627 * <table>
628 * <tr><th colspan="11">LEVEL-3 additional guaranteed configurations</th></tr>
629 * <tr><th colspan="2" id="rb">Target 1</th><th colspan="2" id="rb">Target 2</th><th colspan="2" id="rb">Target 3</th><th colspan="2" id="rb">Target 4</th><th rowspan="2">Sample use case(s)</th> </tr>
630 * <tr><th>Type</th><th id="rb">Max size</th><th>Type</th><th id="rb">Max size</th><th>Type</th><th id="rb">Max size</th><th>Type</th><th id="rb">Max size</th> </tr>
631 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`PRIV`</td><td id="rb">`640x480`</td> <td>`YUV`</td><td id="rb">`MAXIMUM`</td> <td>`RAW`</td><td id="rb">`MAXIMUM`</td> <td>In-app viewfinder analysis with dynamic selection of output format.</td> </tr>
632 * <tr> <td>`PRIV`</td><td id="rb">`PREVIEW`</td> <td>`PRIV`</td><td id="rb">`640x480`</td> <td>`JPEG`</td><td id="rb">`MAXIMUM`</td> <td>`RAW`</td><td id="rb">`MAXIMUM`</td> <td>In-app viewfinder analysis with dynamic selection of output format.</td> </tr>
633 * </table><br>
634 * </p>
635 *
636 * <p>Since the capabilities of camera devices vary greatly, a given camera device may support
637 * target combinations with sizes outside of these guarantees, but this can only be tested for
638 * by attempting to create a session with such targets.</p>
639 *
640 * @param device the camera device of interest.
641 * @param outputs the {@link ACaptureSessionOutputContainer} describes all output streams.
642 * @param callbacks the {@link ACameraCaptureSession_stateCallbacks capture session state callbacks}.
643 * @param session the created {@link ACameraCaptureSession} will be filled here if the method call
644 *        succeeds.
645 *
646 * @return <ul>
647 *         <li>{@link ACAMERA_OK} if the method call succeeds. The created capture session will be
648 *                                filled in session argument.</li>
649 *         <li>{@link ACAMERA_ERROR_INVALID_PARAMETER} if any of device, outputs, callbacks or
650 *                                session is NULL.</li>
651 *         <li>{@link ACAMERA_ERROR_CAMERA_DISCONNECTED} if the camera device is closed.</li>
652 *         <li>{@link ACAMERA_ERROR_CAMERA_DEVICE} if the camera device encounters fatal error.</li>
653 *         <li>{@link ACAMERA_ERROR_CAMERA_SERVICE} if the camera service encounters fatal error.</li>
654 *         <li>{@link ACAMERA_ERROR_UNKNOWN} if the method fails for some other reasons.</li></ul>
655 */
656camera_status_t ACameraDevice_createCaptureSession(
657        ACameraDevice* device,
658        const ACaptureSessionOutputContainer*       outputs,
659        const ACameraCaptureSession_stateCallbacks* callbacks,
660        /*out*/ACameraCaptureSession** session);
661
662#endif /* __ANDROID_API__ >= 24 */
663
664__END_DECLS
665
666#endif /* _NDK_CAMERA_DEVICE_H */
667
668/** @} */
669
670