xref: /aosp_15_r20/frameworks/native/include/gui/view/Surface.h (revision 38e8c45f13ce32b0dcecb25141ffecaf386fa17f)

/*
 * Copyright (C) 2010 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.
 */

#ifndef ANDROID_GUI_VIEW_SURFACE_H
#define ANDROID_GUI_VIEW_SURFACE_H

#include <utils/Errors.h>
#include <utils/StrongPointer.h>
#include <utils/String16.h>

#include <binder/IBinder.h>
#include <binder/Parcelable.h>

#include <gui/Flags.h>
#include <gui/IGraphicBufferProducer.h>
#include <gui/Surface.h>

namespace android {

namespace view {

/**
 * A simple holder for an IGraphicBufferProducer, to match the managed-side
 * android.view.Surface parcelable behavior.
 *
 * This implements android/view/Surface.aidl
 *
 * TODO: Convert IGraphicBufferProducer into AIDL so that it can be directly
 * used in managed Binder calls.
 */
class Surface : public Parcelable {
  public:

    String16 name;
    sp<IGraphicBufferProducer> graphicBufferProducer;
    sp<IBinder> surfaceControlHandle;

#if WB_LIBCAMERASERVICE_WITH_DEPENDENCIES
    // functions used to convert to a parcelable Surface so it can be passed over binder.
    static Surface fromSurface(const sp<android::Surface>& surface);
    sp<android::Surface> toSurface() const;

    status_t getUniqueId(/* out */ uint64_t* id) const;

    bool isEmpty() const;

    bool operator==(const Surface& other) const {
        return graphicBufferProducer == other.graphicBufferProducer;
    }
    bool operator!=(const Surface& other) const { return !(*this == other); }
    bool operator==(const sp<android::Surface> other) const {
        if (other == nullptr) return graphicBufferProducer == nullptr;
        return graphicBufferProducer == other->getIGraphicBufferProducer();
    }
    bool operator!=(const sp<android::Surface> other) const { return !(*this == other); }
    bool operator<(const Surface& other) const {
        return graphicBufferProducer < other.graphicBufferProducer;
    }
    bool operator>(const Surface& other) const { return other < *this; }
#endif

    virtual status_t writeToParcel(Parcel* parcel) const override;
    virtual status_t readFromParcel(const Parcel* parcel) override;

    // nameAlreadyWritten set to true by Surface.java, because it splits
    // Parceling itself between managed and native code, so it only wants a part
    // of the full parceling to happen on its native side.
    status_t writeToParcel(Parcel* parcel, bool nameAlreadyWritten) const;

    // nameAlreadyRead set to true by Surface.java, because it splits
    // Parceling itself between managed and native code, so it only wants a part
    // of the full parceling to happen on its native side.
    status_t readFromParcel(const Parcel* parcel, bool nameAlreadyRead);

    std::string toString() const;

private:
    static String16 readMaybeEmptyString16(const Parcel* parcel);
};

} // namespace view
} // namespace android

#endif  // ANDROID_GUI_VIEW_SURFACE_H