xref: /aosp_15_r20/frameworks/native/libs/gui/view/Surface.cpp (revision 38e8c45f13ce32b0dcecb25141ffecaf386fa17f)
1*38e8c45fSAndroid Build Coastguard Worker /*
2*38e8c45fSAndroid Build Coastguard Worker  * Copyright (C) 2010 The Android Open Source Project
3*38e8c45fSAndroid Build Coastguard Worker  *
4*38e8c45fSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*38e8c45fSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*38e8c45fSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*38e8c45fSAndroid Build Coastguard Worker  *
8*38e8c45fSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*38e8c45fSAndroid Build Coastguard Worker  *
10*38e8c45fSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*38e8c45fSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*38e8c45fSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*38e8c45fSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*38e8c45fSAndroid Build Coastguard Worker  * limitations under the License.
15*38e8c45fSAndroid Build Coastguard Worker  */
16*38e8c45fSAndroid Build Coastguard Worker 
17*38e8c45fSAndroid Build Coastguard Worker #define LOG_TAG "Surface"
18*38e8c45fSAndroid Build Coastguard Worker 
19*38e8c45fSAndroid Build Coastguard Worker #include <android/binder_libbinder.h>
20*38e8c45fSAndroid Build Coastguard Worker #include <android/binder_parcel.h>
21*38e8c45fSAndroid Build Coastguard Worker #include <android/native_window.h>
22*38e8c45fSAndroid Build Coastguard Worker #include <binder/Parcel.h>
23*38e8c45fSAndroid Build Coastguard Worker #include <gui/Surface.h>
24*38e8c45fSAndroid Build Coastguard Worker #include <gui/view/Surface.h>
25*38e8c45fSAndroid Build Coastguard Worker #include <system/window.h>
26*38e8c45fSAndroid Build Coastguard Worker #include <utils/Log.h>
27*38e8c45fSAndroid Build Coastguard Worker 
28*38e8c45fSAndroid Build Coastguard Worker namespace android {
29*38e8c45fSAndroid Build Coastguard Worker namespace view {
30*38e8c45fSAndroid Build Coastguard Worker 
31*38e8c45fSAndroid Build Coastguard Worker // Since this is a parcelable utility and we want to keep the wire format stable, only build this
32*38e8c45fSAndroid Build Coastguard Worker // when building the system libgui to detect any issues loading the wrong libgui from
33*38e8c45fSAndroid Build Coastguard Worker // libnativewindow
34*38e8c45fSAndroid Build Coastguard Worker 
35*38e8c45fSAndroid Build Coastguard Worker #if (!defined(__ANDROID_APEX__) && !defined(__ANDROID_VNDK__))
36*38e8c45fSAndroid Build Coastguard Worker 
android_view_Surface_writeToParcel(ANativeWindow * _Nonnull window,Parcel * _Nonnull parcel)37*38e8c45fSAndroid Build Coastguard Worker extern "C" status_t android_view_Surface_writeToParcel(ANativeWindow* _Nonnull window,
38*38e8c45fSAndroid Build Coastguard Worker                                                        Parcel* _Nonnull parcel) {
39*38e8c45fSAndroid Build Coastguard Worker     int value;
40*38e8c45fSAndroid Build Coastguard Worker     int err = (*window->query)(window, NATIVE_WINDOW_CONCRETE_TYPE, &value);
41*38e8c45fSAndroid Build Coastguard Worker     if (err != OK || value != NATIVE_WINDOW_SURFACE) {
42*38e8c45fSAndroid Build Coastguard Worker         ALOGE("Error: ANativeWindow is not backed by Surface");
43*38e8c45fSAndroid Build Coastguard Worker         return STATUS_BAD_VALUE;
44*38e8c45fSAndroid Build Coastguard Worker     }
45*38e8c45fSAndroid Build Coastguard Worker     // Use a android::view::Surface to parcelize the window
46*38e8c45fSAndroid Build Coastguard Worker     android::view::Surface shimSurface;
47*38e8c45fSAndroid Build Coastguard Worker     shimSurface.graphicBufferProducer = android::Surface::getIGraphicBufferProducer(window);
48*38e8c45fSAndroid Build Coastguard Worker     shimSurface.surfaceControlHandle = android::Surface::getSurfaceControlHandle(window);
49*38e8c45fSAndroid Build Coastguard Worker     return shimSurface.writeToParcel(parcel);
50*38e8c45fSAndroid Build Coastguard Worker }
51*38e8c45fSAndroid Build Coastguard Worker 
android_view_Surface_readFromParcel(const Parcel * _Nonnull parcel,ANativeWindow * _Nullable * _Nonnull outWindow)52*38e8c45fSAndroid Build Coastguard Worker extern "C" status_t android_view_Surface_readFromParcel(
53*38e8c45fSAndroid Build Coastguard Worker         const Parcel* _Nonnull parcel, ANativeWindow* _Nullable* _Nonnull outWindow) {
54*38e8c45fSAndroid Build Coastguard Worker     // Use a android::view::Surface to unparcel the window
55*38e8c45fSAndroid Build Coastguard Worker     android::view::Surface shimSurface;
56*38e8c45fSAndroid Build Coastguard Worker     status_t ret = shimSurface.readFromParcel(parcel);
57*38e8c45fSAndroid Build Coastguard Worker     if (ret != OK) {
58*38e8c45fSAndroid Build Coastguard Worker         ALOGE("%s: Error: Failed to create android::view::Surface from AParcel", __FUNCTION__);
59*38e8c45fSAndroid Build Coastguard Worker         return STATUS_BAD_VALUE;
60*38e8c45fSAndroid Build Coastguard Worker     }
61*38e8c45fSAndroid Build Coastguard Worker     auto surface = sp<android::Surface>::make(shimSurface.graphicBufferProducer, false,
62*38e8c45fSAndroid Build Coastguard Worker                                               shimSurface.surfaceControlHandle);
63*38e8c45fSAndroid Build Coastguard Worker     ANativeWindow* anw = surface.get();
64*38e8c45fSAndroid Build Coastguard Worker     ANativeWindow_acquire(anw);
65*38e8c45fSAndroid Build Coastguard Worker     *outWindow = anw;
66*38e8c45fSAndroid Build Coastguard Worker     return STATUS_OK;
67*38e8c45fSAndroid Build Coastguard Worker }
68*38e8c45fSAndroid Build Coastguard Worker 
69*38e8c45fSAndroid Build Coastguard Worker #endif
70*38e8c45fSAndroid Build Coastguard Worker 
writeToParcel(Parcel * parcel) const71*38e8c45fSAndroid Build Coastguard Worker status_t Surface::writeToParcel(Parcel* parcel) const {
72*38e8c45fSAndroid Build Coastguard Worker     return writeToParcel(parcel, false);
73*38e8c45fSAndroid Build Coastguard Worker }
74*38e8c45fSAndroid Build Coastguard Worker 
writeToParcel(Parcel * parcel,bool nameAlreadyWritten) const75*38e8c45fSAndroid Build Coastguard Worker status_t Surface::writeToParcel(Parcel* parcel, bool nameAlreadyWritten) const {
76*38e8c45fSAndroid Build Coastguard Worker     if (parcel == nullptr) return BAD_VALUE;
77*38e8c45fSAndroid Build Coastguard Worker 
78*38e8c45fSAndroid Build Coastguard Worker     status_t res = OK;
79*38e8c45fSAndroid Build Coastguard Worker 
80*38e8c45fSAndroid Build Coastguard Worker     if (!nameAlreadyWritten) {
81*38e8c45fSAndroid Build Coastguard Worker         res = parcel->writeString16(name);
82*38e8c45fSAndroid Build Coastguard Worker         if (res != OK) return res;
83*38e8c45fSAndroid Build Coastguard Worker 
84*38e8c45fSAndroid Build Coastguard Worker         /* isSingleBuffered defaults to no */
85*38e8c45fSAndroid Build Coastguard Worker         res = parcel->writeInt32(0);
86*38e8c45fSAndroid Build Coastguard Worker         if (res != OK) return res;
87*38e8c45fSAndroid Build Coastguard Worker     }
88*38e8c45fSAndroid Build Coastguard Worker 
89*38e8c45fSAndroid Build Coastguard Worker     res = IGraphicBufferProducer::exportToParcel(graphicBufferProducer, parcel);
90*38e8c45fSAndroid Build Coastguard Worker     if (res != OK) return res;
91*38e8c45fSAndroid Build Coastguard Worker     return parcel->writeStrongBinder(surfaceControlHandle);
92*38e8c45fSAndroid Build Coastguard Worker }
93*38e8c45fSAndroid Build Coastguard Worker 
readFromParcel(const Parcel * parcel)94*38e8c45fSAndroid Build Coastguard Worker status_t Surface::readFromParcel(const Parcel* parcel) {
95*38e8c45fSAndroid Build Coastguard Worker     return readFromParcel(parcel, false);
96*38e8c45fSAndroid Build Coastguard Worker }
97*38e8c45fSAndroid Build Coastguard Worker 
readFromParcel(const Parcel * parcel,bool nameAlreadyRead)98*38e8c45fSAndroid Build Coastguard Worker status_t Surface::readFromParcel(const Parcel* parcel, bool nameAlreadyRead) {
99*38e8c45fSAndroid Build Coastguard Worker     if (parcel == nullptr) return BAD_VALUE;
100*38e8c45fSAndroid Build Coastguard Worker 
101*38e8c45fSAndroid Build Coastguard Worker     status_t res = OK;
102*38e8c45fSAndroid Build Coastguard Worker     if (!nameAlreadyRead) {
103*38e8c45fSAndroid Build Coastguard Worker         name = readMaybeEmptyString16(parcel);
104*38e8c45fSAndroid Build Coastguard Worker         // Discard this for now
105*38e8c45fSAndroid Build Coastguard Worker         int isSingleBuffered;
106*38e8c45fSAndroid Build Coastguard Worker         res = parcel->readInt32(&isSingleBuffered);
107*38e8c45fSAndroid Build Coastguard Worker         if (res != OK) {
108*38e8c45fSAndroid Build Coastguard Worker             ALOGE("Can't read isSingleBuffered");
109*38e8c45fSAndroid Build Coastguard Worker             return res;
110*38e8c45fSAndroid Build Coastguard Worker         }
111*38e8c45fSAndroid Build Coastguard Worker     }
112*38e8c45fSAndroid Build Coastguard Worker 
113*38e8c45fSAndroid Build Coastguard Worker     graphicBufferProducer = IGraphicBufferProducer::createFromParcel(parcel);
114*38e8c45fSAndroid Build Coastguard Worker     surfaceControlHandle = parcel->readStrongBinder();
115*38e8c45fSAndroid Build Coastguard Worker     return OK;
116*38e8c45fSAndroid Build Coastguard Worker }
117*38e8c45fSAndroid Build Coastguard Worker 
readMaybeEmptyString16(const Parcel * parcel)118*38e8c45fSAndroid Build Coastguard Worker String16 Surface::readMaybeEmptyString16(const Parcel* parcel) {
119*38e8c45fSAndroid Build Coastguard Worker     std::optional<String16> str;
120*38e8c45fSAndroid Build Coastguard Worker     parcel->readString16(&str);
121*38e8c45fSAndroid Build Coastguard Worker     return str.value_or(String16());
122*38e8c45fSAndroid Build Coastguard Worker }
123*38e8c45fSAndroid Build Coastguard Worker 
124*38e8c45fSAndroid Build Coastguard Worker #if WB_LIBCAMERASERVICE_WITH_DEPENDENCIES
fromSurface(const sp<android::Surface> & surface)125*38e8c45fSAndroid Build Coastguard Worker Surface Surface::fromSurface(const sp<android::Surface>& surface) {
126*38e8c45fSAndroid Build Coastguard Worker     if (surface == nullptr) {
127*38e8c45fSAndroid Build Coastguard Worker         ALOGE("%s: Error: view::Surface::fromSurface failed due to null surface.", __FUNCTION__);
128*38e8c45fSAndroid Build Coastguard Worker         return Surface();
129*38e8c45fSAndroid Build Coastguard Worker     }
130*38e8c45fSAndroid Build Coastguard Worker     Surface s;
131*38e8c45fSAndroid Build Coastguard Worker     s.name = String16(surface->getConsumerName());
132*38e8c45fSAndroid Build Coastguard Worker     s.graphicBufferProducer = surface->getIGraphicBufferProducer();
133*38e8c45fSAndroid Build Coastguard Worker     s.surfaceControlHandle = surface->getSurfaceControlHandle();
134*38e8c45fSAndroid Build Coastguard Worker     return s;
135*38e8c45fSAndroid Build Coastguard Worker }
136*38e8c45fSAndroid Build Coastguard Worker 
toSurface() const137*38e8c45fSAndroid Build Coastguard Worker sp<android::Surface> Surface::toSurface() const {
138*38e8c45fSAndroid Build Coastguard Worker     if (graphicBufferProducer == nullptr) return nullptr;
139*38e8c45fSAndroid Build Coastguard Worker     return new android::Surface(graphicBufferProducer, false, surfaceControlHandle);
140*38e8c45fSAndroid Build Coastguard Worker }
141*38e8c45fSAndroid Build Coastguard Worker 
getUniqueId(uint64_t * out_id) const142*38e8c45fSAndroid Build Coastguard Worker status_t Surface::getUniqueId(uint64_t* out_id) const {
143*38e8c45fSAndroid Build Coastguard Worker     if (graphicBufferProducer == nullptr) {
144*38e8c45fSAndroid Build Coastguard Worker         ALOGE("android::viewSurface::getUniqueId() failed because it's not initialized.");
145*38e8c45fSAndroid Build Coastguard Worker         return UNEXPECTED_NULL;
146*38e8c45fSAndroid Build Coastguard Worker     }
147*38e8c45fSAndroid Build Coastguard Worker     status_t status = graphicBufferProducer->getUniqueId(out_id);
148*38e8c45fSAndroid Build Coastguard Worker     if (status != OK) {
149*38e8c45fSAndroid Build Coastguard Worker         ALOGE("android::viewSurface::getUniqueId() failed.");
150*38e8c45fSAndroid Build Coastguard Worker         return status;
151*38e8c45fSAndroid Build Coastguard Worker     }
152*38e8c45fSAndroid Build Coastguard Worker     return OK;
153*38e8c45fSAndroid Build Coastguard Worker }
154*38e8c45fSAndroid Build Coastguard Worker 
isEmpty() const155*38e8c45fSAndroid Build Coastguard Worker bool Surface::isEmpty() const {
156*38e8c45fSAndroid Build Coastguard Worker     return graphicBufferProducer == nullptr;
157*38e8c45fSAndroid Build Coastguard Worker }
158*38e8c45fSAndroid Build Coastguard Worker #endif
159*38e8c45fSAndroid Build Coastguard Worker 
toString() const160*38e8c45fSAndroid Build Coastguard Worker std::string Surface::toString() const {
161*38e8c45fSAndroid Build Coastguard Worker     std::stringstream out;
162*38e8c45fSAndroid Build Coastguard Worker     out << name;
163*38e8c45fSAndroid Build Coastguard Worker     return out.str();
164*38e8c45fSAndroid Build Coastguard Worker }
165*38e8c45fSAndroid Build Coastguard Worker 
166*38e8c45fSAndroid Build Coastguard Worker } // namespace view
167*38e8c45fSAndroid Build Coastguard Worker } // namespace android
168