summaryrefslogtreecommitdiff
path: root/core/java/android/hardware/camera2/impl/CaptureCallback.java
blob: b064e6a1f9752e9f56bcaf7605361685276c4926 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
 * Copyright (C) 2019 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.hardware.camera2.impl;

import android.hardware.camera2.CameraCaptureSession;
import android.hardware.camera2.CameraDevice;
import android.hardware.camera2.CaptureFailure;
import android.hardware.camera2.CaptureRequest;
import android.hardware.camera2.CaptureResult;
import android.hardware.camera2.TotalCaptureResult;
import android.view.Surface;

import java.util.concurrent.Executor;

/**
 * <p>An internal callback for tracking the progress of a {@link CaptureRequest}
 * submitted to the camera device.</p>
 */
public abstract class CaptureCallback {

    private Executor mExecutor;
    private CameraCaptureSession.CaptureCallback mCallback;

    public CaptureCallback(Executor executor, CameraCaptureSession.CaptureCallback callback) {
        mExecutor = executor;
        mCallback = callback;
    }

    /**
     * Retrieve callback executor
     *
     */
    public Executor getExecutor() {
        return mExecutor;
    }

    /**
     * Retrieve capture callback
     *
     */
    public CameraCaptureSession.CaptureCallback getSessionCallback() {
        return mCallback;
    }

    /**
     * This method is called when the camera device has started capturing
     * the output image for the request, at the beginning of image exposure.
     *
     * @see android.media.MediaActionSound
     */
    public abstract void onCaptureStarted(CameraDevice camera,
            CaptureRequest request, long timestamp, long frameNumber);

    /**
     * This method is called when the camera device has started reading out the output
     * image for the request, at the beginning of the sensor image readout.
     */
    public abstract void onReadoutStarted(CameraDevice camera,
            CaptureRequest request, long timestamp, long frameNumber);

    /**
     * This method is called when some results from an image capture are
     * available.
     *
     * @hide
     */
    public abstract void onCapturePartial(CameraDevice camera,
            CaptureRequest request, CaptureResult result);

    /**
     * This method is called when an image capture makes partial forward progress; some
     * (but not all) results from an image capture are available.
     *
     */
    public abstract void onCaptureProgressed(CameraDevice camera,
            CaptureRequest request, CaptureResult partialResult);

    /**
     * This method is called when an image capture has fully completed and all the
     * result metadata is available.
     */
    public abstract void onCaptureCompleted(CameraDevice camera,
            CaptureRequest request, TotalCaptureResult result);

    /**
     * This method is called instead of {@link #onCaptureCompleted} when the
     * camera device failed to produce a {@link CaptureResult} for the
     * request.
     */
    public abstract void onCaptureFailed(CameraDevice camera,
            CaptureRequest request, CaptureFailure failure);

    /**
     * This method is called independently of the others in CaptureCallback,
     * when a capture sequence finishes and all {@link CaptureResult}
     * or {@link CaptureFailure} for it have been returned via this callback.
     */
    public abstract void onCaptureSequenceCompleted(CameraDevice camera,
            int sequenceId, long frameNumber);

    /**
     * This method is called independently of the others in CaptureCallback,
     * when a capture sequence aborts before any {@link CaptureResult}
     * or {@link CaptureFailure} for it have been returned via this callback.
     */
    public abstract void onCaptureSequenceAborted(CameraDevice camera,
            int sequenceId);

    /**
     * This method is called independently of the others in CaptureCallback, if an output buffer
     * is dropped for a particular capture request.
     *
     * Loss of metadata is communicated via onCaptureFailed, independently of any buffer loss.
     */
    public abstract void onCaptureBufferLost(CameraDevice camera,
            CaptureRequest request, Surface target, long frameNumber);
}