Automotive display proxy service

This simple framework service lets vendor processes use SurfaceFlinger/EGL in HAL implementations, without linking libgui. AOSP provides the default implementation of this service, which is fully functional. However, the vendor must also implement APIs to provide this service on their platform.

package android.frameworks.automotive.display@1.0;

import android.hardware.graphics.bufferqueue@2.0::IGraphicBufferProducer;

interface IAutomotiveDisplayProxyService {
    /**
     * Gets an IGraphicBufferProducer instance from the service.
     *
     * @param  id   Target's stable display identifier
     *
     * @return igbp Returns an IGraphicBufferProducer object, that can be
     *              converted to an ANativeWindow object.
     */
    getIGraphicBufferProducer(uint64_t id) generates (IGraphicBufferProducer igbp);

    /**
     * Sets the ANativeWindow, which is associated with the
     * IGraphicBufferProducer, to be visible and to take over the display.
     *
     * @param  id      Target display ID
     *
     * @return success Returns true on success.
     */
    showWindow(uint64_t id) generates (bool success);

    /**
     * Sets the ANativeWindow, which is associated with the
     * IGraphicBufferProducer, to be invisible and to release the control
     * over display.
     *
     * @param  id      Target display ID
     *
     * @return success Returns true on success.
     */
    hideWindow(uint64_t id) generates (bool success);

    /**
     * Returns the stable identifiers of all available displays.
     *
     * @return ids A list of stable display identifiers.
     */
    getDisplayIdList() generates (vec<uint64_t> ids);

    /**
     * Returns the descriptor of the target display.
     *
     * @param  id    Stable ID of a target display.
     * @return cfg   DisplayConfig of the active display.
     * @return state Current state of the active display.
     */
    getDisplayInfo(uint64_t id) generates (HwDisplayConfig cfg, HwDisplayState state);
}

To use this service:

1. Get IAutomotiveDisplayProxyService.

   android::sp<IAutomotiveDisplayProxyService> windowProxyService =
       IAutomotiveDisplayProxyService::getService("default");
   if (windowProxyService == nullptr) {
       LOG(ERROR) << "Cannot use AutomotiveDisplayProxyService. Exiting.";
       return 1;
   }

2. Retrieve an active display information from the service to determine the resolution.

   // We use the first display in the list as the primary.
   pWindowProxy->getDisplayInfo(displayId, [this](auto dpyConfig, auto dpyState) {
       DisplayConfig *pConfig = (DisplayConfig*)dpyConfig.data();
       mWidth = pConfig->resolution.getWidth();
       mHeight = pConfig->resolution.getHeight();
   
       ui::DisplayState* pState = (ui::DisplayState*)dpyState.data();
       if (pState->orientation != ui::ROTATION_0 &&
           pState->orientation != ui::ROTATION_180) {
           // rotate
           std::swap(mWidth, mHeight);
       }
   
       LOG(DEBUG) << "Display resolution is " << mWidth << " x " << mHeight;
   });

3. Retrieve a hardware IGraphicBufferProducer (or, HIDL GraphicBufferProducer (HGBP) from IAutomotiveDisplayProxyService:

   mGfxBufferProducer = pWindowProxy->getIGraphicBufferProducer(displayId);
   if (mGfxBufferProducer == nullptr) {
       LOG(ERROR) << "Failed to get IGraphicBufferProducer from "
                  << "IAutomotiveDisplayProxyService.";
       return false;
   }

4. Get a SurfaceHolder from a retrieved HGBP, by using the API libbufferqueueconverter:

   mSurfaceHolder = getSurfaceFromHGBP(mGfxBufferProducer);
   if (mSurfaceHolder == nullptr) {
       LOG(ERROR) << "Failed to get a Surface from HGBP.";
       return false;
   }

5. Convert a SurfaceHolder into a native window by using the API libbufferqueueconverter:

   mWindow = getNativeWindow(mSurfaceHolder.get());
   if (mWindow == nullptr) {
       LOG(ERROR) << "Failed to get a native window from Surface.";
       return false;
   }

6. Create an EGL window surface with a native window and then render:

   // Set up our OpenGL ES context associated with the default display
   mDisplay = eglGetDisplay(EGL_DEFAULT_DISPLAY);
   if (mDisplay == EGL_NO_DISPLAY) {
       LOG(ERROR) << "Failed to get egl display";
       return false;
   }
   ...
   
   // Create the EGL render target surface
   mSurface = eglCreateWindowSurface(mDisplay, egl_config, mWindow, nullptr);
   if (mSurface == EGL_NO_SURFACE) {
       LOG(ERROR) << "eglCreateWindowSurface failed.";
       return false;
   }
   ...

7. Call IAutomotiveDisplayProxyService::showWindow() to display the rendered view on the screen. This service has the highest priority and, therefore, always takes control of the screen from the current owner:

   mAutomotiveDisplayProxyService->showWindow();

See service.cpp and GlWrapper.cpp in $ANDROID_BUILD_TOP/packages/services/Car/evs/sampleDriver/ for more implementation details.

An EVS HAL implementation requires the additional libraries displayed in bold below.

cc_binary {
    name: "android.hardware.automotive.evs@1.1-sample",

    vendor: true,

    srcs: [
        ...
    ],

    shared_libs: [
        ...
        "libbufferqueueconverter",
        "android.hidl.token@1.0-utils",
        "android.frameworks.automotive.display@1.0",
        "android.hardware.graphics.bufferqueue@1.0",
        "android.hardware.graphics.bufferqueue@2.0",
    ],

Multi-display support

Display device enumeration and retrieve display information

Like the camera device enumeration, the EVS framework provides a method to enumerate the available displays. The static display identifier encodes a type-long identifier, the display port information in the lower byte and Extended Display IDentification Data in upper bits. IAutomotiveDisplayProxyService::getDisplayIdList() returns a list of display IDs of physical local displays, which are available to EVS service, and IEvsEnumerator::getDisplayIdList() returns a list of display ports detected displays are connected to. The first ID in the list is always of the primary display.

interface IEvsEnumerator extends @1.0::IEvsEnumerator {
    ...
    /**
     * Returns a list of all EVS displays available to the system
     *
     * @return displayIds Identifiers of available displays.
     */
    getDisplayIdList() generates (vec<uint8_t> displayIds);
};

Open target display device

EVS app calls IEvsEnumerator::openDisplay_1_1() with a target display port number:

android::sp<IEvsDisplay> pDisplay = pEvs->openDisplay_1_1(displayId);
if (pDisplay.get() == nullptr) {
    LOG(ERROR) << "EVS Display unavailable. Exiting.";
    return 1;
}

Note: Only a single display can be in use at one time, which means the current EVS client loses its display when another EVS client requests to open the display, even when they are not the same.