/*
 * Copyright 2021 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 androidx.car.app.activity.renderer.surface;

import static java.util.Objects.requireNonNull;

import android.os.IBinder;
import android.view.Surface;
import android.view.SurfaceView;

import androidx.annotation.Dimension;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.car.app.annotations.KeepFields;

/**
 * A class holding the information needed to render the content on a surface.
 */
@KeepFields
public final class SurfaceWrapper {
    @Nullable
    private IBinder mHostToken;
    @Dimension
    private int mWidth;
    @Dimension
    private int mHeight;
    private int mDisplayId;
    private int mDensityDpi;
    @Nullable
    private Surface mSurface;

    /**
     * Creates a {@link SurfaceWrapper}.
     *
     * @param hostToken  a token used for constructing SurfaceControlViewHost. see
     *                   {@link SurfaceView} for more details
     * @param width      the width of the surface view in pixels
     * @param height     the height of the surface view in pixels
     * @param displayId  the ID of the display showing the surface
     * @param densityDpi the density of the display showing the surface expressed as dots-per-inch
     * @param surface    the surface for which the wrapper is created
     */
    public SurfaceWrapper(@Nullable IBinder hostToken, @Dimension int width, @Dimension int height,
            int displayId, int densityDpi, @NonNull Surface surface) {
        mHostToken = hostToken;
        mWidth = width;
        mHeight = height;
        mDisplayId = displayId;
        mDensityDpi = densityDpi;
        mSurface = surface;
    }

    /** Empty constructor needed for serializations. */
    private SurfaceWrapper() {
    }

    /**
     * Returns the host token corresponding to the {@link SurfaceView} contained in this class.
     */
    @Nullable
    public IBinder getHostToken() {
        return mHostToken;
    }

    /**
     * Returns the width of the contained {@link SurfaceView} in pixels.
     */
    @Dimension
    public int getWidth() {
        return mWidth;
    }

    /**
     * Returns the height of the contained {@link SurfaceView} in pixels.
     */
    @Dimension
    public int getHeight() {
        return mHeight;
    }

    /**
     * Returns the display id of the {@link android.view.Display} for the {@link SurfaceView}
     * contained in this class.
     */
    public int getDisplayId() {
        return mDisplayId;
    }

    /**
     * Returns the screen density expressed as dots-per-inch of the {@link android.view.Display}
     * for the contained {@link SurfaceView}.
     */
    public int getDensityDpi() {
        return mDensityDpi;
    }

    /**
     * Returns the {@link Surface} of the contained {@link SurfaceView}.
     */
    @NonNull
    public Surface getSurface() {
        return requireNonNull(mSurface);
    }
}