summaryrefslogtreecommitdiff
path: root/com/android/server/wm/Letterbox.java
blob: 8fa79ab5e1892d6d912aecf93d081bfda5e436bb (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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
 * Copyright (C) 2018 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 com.android.server.wm;

import static android.view.SurfaceControl.HIDDEN;

import android.graphics.Rect;
import android.view.SurfaceControl;

import java.util.function.Supplier;

/**
 * Manages a set of {@link SurfaceControl}s to draw a black letterbox between an
 * outer rect and an inner rect.
 */
public class Letterbox {

    private static final Rect EMPTY_RECT = new Rect();

    private final Supplier<SurfaceControl.Builder> mFactory;
    private final Rect mOuter = new Rect();
    private final Rect mInner = new Rect();
    private final LetterboxSurface mTop = new LetterboxSurface("top");
    private final LetterboxSurface mLeft = new LetterboxSurface("left");
    private final LetterboxSurface mBottom = new LetterboxSurface("bottom");
    private final LetterboxSurface mRight = new LetterboxSurface("right");

    /**
     * Constructs a Letterbox.
     *
     * @param surfaceControlFactory a factory for creating the managed {@link SurfaceControl}s
     */
    public Letterbox(Supplier<SurfaceControl.Builder> surfaceControlFactory) {
        mFactory = surfaceControlFactory;
    }

    /**
     * Sets the dimensions of the the letterbox, such that the area between the outer and inner
     * frames will be covered by black color surfaces.
     *
     * @param t     a transaction in which to set the dimensions
     * @param outer the outer frame of the letterbox (this frame will be black, except the area
     *              that intersects with the {code inner} frame).
     * @param inner the inner frame of the letterbox (this frame will be clear)
     */
    public void setDimensions(SurfaceControl.Transaction t, Rect outer, Rect inner) {
        mOuter.set(outer);
        mInner.set(inner);

        mTop.setRect(t, outer.left, outer.top, inner.right, inner.top);
        mLeft.setRect(t, outer.left, inner.top, inner.left, outer.bottom);
        mBottom.setRect(t, inner.left, inner.bottom, outer.right, outer.bottom);
        mRight.setRect(t, inner.right, outer.top, outer.right, inner.bottom);
    }

    /**
     * Hides the letterbox.
     *
     * @param t a transaction in which to hide the letterbox
     */
    public void hide(SurfaceControl.Transaction t) {
        setDimensions(t, EMPTY_RECT, EMPTY_RECT);
    }

    /**
     * Destroys the managed {@link SurfaceControl}s.
     */
    public void destroy() {
        mOuter.setEmpty();
        mInner.setEmpty();

        mTop.destroy();
        mLeft.destroy();
        mBottom.destroy();
        mRight.destroy();
    }

    private class LetterboxSurface {

        private final String mType;
        private SurfaceControl mSurface;

        private int mLastLeft = 0;
        private int mLastTop = 0;
        private int mLastRight = 0;
        private int mLastBottom = 0;

        public LetterboxSurface(String type) {
            mType = type;
        }

        public void setRect(SurfaceControl.Transaction t,
                int left, int top, int right, int bottom) {
            if (mLastLeft == left && mLastTop == top
                    && mLastRight == right && mLastBottom == bottom) {
                // Nothing changed.
                return;
            }

            if (left < right && top < bottom) {
                if (mSurface == null) {
                    createSurface();
                }
                t.setPosition(mSurface, left, top);
                t.setSize(mSurface, right - left, bottom - top);
                t.show(mSurface);
            } else if (mSurface != null) {
                t.hide(mSurface);
            }

            mLastLeft = left;
            mLastTop = top;
            mLastRight = right;
            mLastBottom = bottom;
        }

        private void createSurface() {
            mSurface = mFactory.get().setName("Letterbox - " + mType)
                    .setFlags(HIDDEN).setColorLayer(true).build();
            mSurface.setLayer(-1);
            mSurface.setColor(new float[]{0, 0, 0});
        }

        public void destroy() {
            if (mSurface != null) {
                mSurface.destroy();
                mSurface = null;
            }
        }
    }
}