1 /*
2  * Copyright (C) 2018 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 #ifndef _LIBINPUT_TOUCHVIDEOFRAME_H
18 #define _LIBINPUT_TOUCHVIDEOFRAME_H
19 
20 #include <stdint.h>
21 #include <sys/time.h>
22 #include <vector>
23 
24 namespace android {
25 
26 /**
27  * Represents data from a single scan of the touchscreen device.
28  * Similar in concept to a video frame, but the touch strength is used as
29  * the values instead.
30  */
31 class TouchVideoFrame {
32 public:
33     TouchVideoFrame(uint32_t height, uint32_t width, std::vector<int16_t> data,
34             const struct timeval& timestamp);
35 
36     bool operator==(const TouchVideoFrame& rhs) const;
37 
38     /**
39      * Height of the frame
40      */
41     uint32_t getHeight() const;
42     /**
43      * Width of the frame
44      */
45     uint32_t getWidth() const;
46     /**
47      * The touch strength data.
48      * The array is a 2-D row-major matrix, with dimensions (height, width).
49      * Total size of the array should equal getHeight() * getWidth().
50      * Data is allowed to be negative.
51      */
52     const std::vector<int16_t>& getData() const;
53     /**
54      * Time at which the heatmap was taken.
55      */
56     const struct timeval& getTimestamp() const;
57 
58     /**
59      * Rotate the video frame.
60      * The rotation value is an enum from ui/DisplayInfo.h
61      */
62     void rotate(int32_t orientation);
63 
64 private:
65     uint32_t mHeight;
66     uint32_t mWidth;
67     std::vector<int16_t> mData;
68     struct timeval mTimestamp;
69 
70     /**
71      * Common method for 90 degree and 270 degree rotation
72      */
73     void rotateQuarterTurn(bool clockwise);
74     void rotate180();
75 };
76 
77 } // namespace android
78 
79 #endif // _LIBINPUT_TOUCHVIDEOFRAME_H
80