blob: f71503988ff1b4065850dec33418d8b8396489f9 [file] [log] [blame]
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -08001/*
2 * Copyright (C) 2022 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#pragma once
18
Derek Wu705068d2024-03-20 10:41:37 -070019#include <array>
Philip Quinn8f953ab2022-12-06 15:37:07 -080020#include <cstdint>
21#include <memory>
22#include <mutex>
Cody Heiner7b26dbe2023-11-14 14:47:10 -080023#include <optional>
Philip Quinnbd66e622023-02-10 11:45:01 -080024#include <string>
Philip Quinn8f953ab2022-12-06 15:37:07 -080025#include <unordered_map>
26
Siarhei Vishniakou33cb38b2023-02-23 18:52:34 -080027#include <android-base/result.h>
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080028#include <android-base/thread_annotations.h>
29#include <android/sysprop/InputProperties.sysprop.h>
30#include <input/Input.h>
Cody Heiner088c63e2023-06-15 12:06:09 -070031#include <input/MotionPredictorMetricsManager.h>
Derek Wu705068d2024-03-20 10:41:37 -070032#include <input/RingBuffer.h>
Philip Quinn8f953ab2022-12-06 15:37:07 -080033#include <input/TfLiteMotionPredictor.h>
Cody Heiner088c63e2023-06-15 12:06:09 -070034#include <utils/Timers.h> // for nsecs_t
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080035
36namespace android {
37
38static inline bool isMotionPredictionEnabled() {
39 return sysprop::InputProperties::enable_motion_prediction().value_or(true);
40}
41
Derek Wu705068d2024-03-20 10:41:37 -070042// Tracker to calculate jerk from motion position samples.
43class JerkTracker {
44public:
45 // Initialize the tracker. If normalizedDt is true, assume that each sample pushed has dt=1.
46 JerkTracker(bool normalizedDt);
47
48 // Add a position to the tracker and update derivative estimates.
49 void pushSample(int64_t timestamp, float xPos, float yPos);
50
51 // Reset JerkTracker for a new motion input.
52 void reset();
53
54 // Return last jerk calculation, if enough samples have been collected.
55 // Jerk is defined as the 3rd derivative of position (change in
56 // acceleration) and has the units of d^3p/dt^3.
57 std::optional<float> jerkMagnitude() const;
58
59private:
60 const bool mNormalizedDt;
61
62 RingBuffer<int64_t> mTimestamps{4};
63 std::array<float, 4> mXDerivatives{}; // [x, x', x'', x''']
64 std::array<float, 4> mYDerivatives{}; // [y, y', y'', y''']
65};
66
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080067/**
68 * Given a set of MotionEvents for the current gesture, predict the motion. The returned MotionEvent
Philip Quinn8f953ab2022-12-06 15:37:07 -080069 * contains a set of samples in the future.
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080070 *
71 * The typical usage is like this:
72 *
73 * MotionPredictor predictor(offset = MY_OFFSET);
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080074 * predictor.record(DOWN_MOTION_EVENT);
75 * predictor.record(MOVE_MOTION_EVENT);
Philip Quinn8f953ab2022-12-06 15:37:07 -080076 * prediction = predictor.predict(futureTime);
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080077 *
Philip Quinn8f953ab2022-12-06 15:37:07 -080078 * The resulting motion event will have eventTime <= (futureTime + MY_OFFSET). It might contain
79 * historical data, which are additional samples from the latest recorded MotionEvent's eventTime
80 * to the futureTime + MY_OFFSET.
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080081 *
82 * The offset is used to provide additional flexibility to the caller, in case the default present
83 * time (typically provided by the choreographer) does not account for some delays, or to simply
Philip Quinn8f953ab2022-12-06 15:37:07 -080084 * reduce the aggressiveness of the prediction. Offset can be positive or negative.
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080085 */
86class MotionPredictor {
87public:
Cody Heiner7b26dbe2023-11-14 14:47:10 -080088 using ReportAtomFunction = MotionPredictorMetricsManager::ReportAtomFunction;
89
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080090 /**
91 * Parameters:
92 * predictionTimestampOffsetNanos: additional, constant shift to apply to the target
Philip Quinn8f953ab2022-12-06 15:37:07 -080093 * prediction time. The prediction will target the time t=(prediction time +
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080094 * predictionTimestampOffsetNanos).
95 *
Cody Heiner7b26dbe2023-11-14 14:47:10 -080096 * checkEnableMotionPrediction: the function to check whether the prediction should run. Used to
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -080097 * provide an additional way of turning prediction on and off. Can be toggled at runtime.
Cody Heiner7b26dbe2023-11-14 14:47:10 -080098 *
99 * reportAtomFunction: the function that will be called to report prediction metrics. If
100 * omitted, the implementation will choose a default metrics reporting mechanism.
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -0800101 */
Siarhei Vishniakoufd0a68e2023-02-28 13:25:36 -0800102 MotionPredictor(nsecs_t predictionTimestampOffsetNanos,
Cody Heiner7b26dbe2023-11-14 14:47:10 -0800103 std::function<bool()> checkEnableMotionPrediction = isMotionPredictionEnabled,
104 ReportAtomFunction reportAtomFunction = {});
Cody Heiner088c63e2023-06-15 12:06:09 -0700105
Siarhei Vishniakou33cb38b2023-02-23 18:52:34 -0800106 /**
107 * Record the actual motion received by the view. This event will be used for calculating the
108 * predictions.
109 *
110 * @return empty result if the event was processed correctly, error if the event is not
111 * consistent with the previously recorded events.
112 */
113 android::base::Result<void> record(const MotionEvent& event);
Cody Heiner088c63e2023-06-15 12:06:09 -0700114
Siarhei Vishniakou33cb38b2023-02-23 18:52:34 -0800115 std::unique_ptr<MotionEvent> predict(nsecs_t timestamp);
Cody Heiner088c63e2023-06-15 12:06:09 -0700116
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -0800117 bool isPredictionAvailable(int32_t deviceId, int32_t source);
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -0800118
119private:
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -0800120 const nsecs_t mPredictionTimestampOffsetNanos;
121 const std::function<bool()> mCheckMotionPredictionEnabled;
Philip Quinn8f953ab2022-12-06 15:37:07 -0800122
123 std::unique_ptr<TfLiteMotionPredictorModel> mModel;
Siarhei Vishniakou33cb38b2023-02-23 18:52:34 -0800124
125 std::unique_ptr<TfLiteMotionPredictorBuffers> mBuffers;
126 std::optional<MotionEvent> mLastEvent;
Derek Wu705068d2024-03-20 10:41:37 -0700127 // mJerkTracker assumes normalized dt = 1 between recorded samples because
128 // the underlying mModel input also assumes fixed-interval samples.
129 // Normalized dt as 1 is also used to correspond with the similar Jank
130 // implementation from the JetPack MotionPredictor implementation.
131 JerkTracker mJerkTracker{true};
Cody Heiner088c63e2023-06-15 12:06:09 -0700132
133 std::optional<MotionPredictorMetricsManager> mMetricsManager;
Cody Heiner7b26dbe2023-11-14 14:47:10 -0800134
135 const ReportAtomFunction mReportAtomFunction;
Siarhei Vishniakou39147ce2022-11-15 12:13:04 -0800136};
137
138} // namespace android