<!--
  Copyright (C) 2026 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.
-->

# SDV Media prebuilt Mesa GLES libraries

This directory contains prebuilt `libGLES_mesa.so` libraries for SDV Media.
These libraries are provided as a temporary solution for AOSP dropping support
for Mesa OpenGL over virgl while SDV Media migrates to use ANGLE OpenGL over
gfxstream Vulkan.

Note that due to challenges in maintaining the Mesa GL build in Android, these
binaries are built from relatively old sources (v20.3.4, dated 2021-01-29) and
not expected to be updated.

The migration is expected to finish by EOY 2024 and is tracked in b/326956485.
Once it's done, the Mesa libraries will get deprecated and eventually removed.

## Reproduce the binaries

### Build locally from AOSP sources

```
mkdir aosp
cd aosp
# top of AOSP main branch at the time of writing this (2024-03-07)
repo init -b 0042526a019ee0bdc946655d9f8e0d2d50b75062 \
          -u https://android.googlesource.com/platform/manifest
repo sync

source build/envsetup.sh
# or aosp_cf_x86_64_phone-trunk_staging-userdebug
lunch aosp_cf_arm64_phone-trunk_staging-userdebug
m libGLES_mesa libglapi gallium_dri

# compiled binaries:
# - $OUT/vendor/lib64/dri/gallium_dri.so
# - $OUT/vendor/lib64/egl/libGLES_mesa.so
# - $OUT/vendor/lib64/libglapi.so
```

### Build in Android Build infra

Binaries included in this directory were compiled this way.

1.  Create a temporary CL that adds `libGLES_mesa.so` and its dependencies
    (`libglapi.so`, `gallium_dri.so`) to artifacts generated by `m dist` target.

    The Android Prebuilt Drop tool works only with artifacts included in the
    `dist` output.

    ```
    croot device/google/sdv
    repo start mesa-prebuilt .
    cat <<EOF >>./sdv_media_base/sdv_media_base.mk
    \$(call dist-for-goals,dist_files,\$(OUT_DIR)/target/product/\$(TARGET_PRODUCT)/vendor/lib64/egl/libGLES_mesa.so)
    \$(call dist-for-goals,dist_files,\$(OUT_DIR)/target/product/\$(TARGET_PRODUCT)/vendor/lib64/libglapi.so)
    \$(call dist-for-goals,dist_files,\$(OUT_DIR)/target/product/\$(TARGET_PRODUCT)/vendor/lib64/dri/gallium_dri.so)
    EOF
    git commit -am "DO NOT SUBMIT: CL for generating libGLES_mesa.so prebuilt"
    repo upload --no-verify --wip --cbr .
    ```

2.  Trigger a build for the CL from step 1 on Android infra with go/forrest-cli

    ```
    # set to the CL ID generated by repo upload from step 1
    CL_NUMBER=12345678

    # Note: this is a busytown target name (go/android-build-targets), not Android
    # lunch target. See http://shortn/_huQCYlJKIt for SDV target definitions.
    for TARGET in sdv_media_arm64 sdv_media_cf; do
       /google/bin/releases/atp-dev/tools/forrest-mpm/forrest-mpm/forrest.par \
           build \
           th:cl:$CL_NUMBER:$TARGET-userdebug:git_udc-swcar-dev
    done
    ```

3.  Use Android Prebuilt Drop tool (go/android-prebuilt) to pull the artifact
    from ab/ and create a CL with it. Make sure to go through the setup steps at
    go/android-prebuilt to set up `~/.gitcookies` first.

    ```
    # Execute for each build started at step 2.

    # Set to build ID from the go/forrest-run/L.... link displayed by forrest.par
    # run from step 2 (Look for "Build: <id>", where <id> is P<somenumbers>).
    # Include the P in ID.
    BUILD_ID=P1234567

    # This or sdv_media_cf-userdebug, matching build ID
    # Note: this is a busytown target name (go/android-build-targets), not Android
    # lunch target. See http://shortn/_huQCYlJKIt for SDV target definitions.
    TARGET=sdv_media_arm64-userdebug

    # Build architecture. x86_64 for sdv_media_cf, arm64 for sdv_media_arm64
    ARCH=arm64

    # set to the version from external/mesa3d/VERSION file
    VERSION=20.3.4

    /google/data/ro/projects/android/prebuilt_drop_tool/prebuilt_drop.par \
       --dest_host='https://googleplex-android-review.googlesource.com' \
       --dest_project='device/google/sdv' \
       --dest_git_branch='udc-swcar-dev' \
       --build_id=$BUILD_ID \
       --target=$TARGET \
       --source_dest_file_pair=libGLES_mesa.so:prebuilts/$ARCH/libGLES_mesa.so \
       --source_dest_file_pair=libglapi.so:prebuilts/$ARCH/libglapi.so \
       --source_dest_file_pair=gallium_dri.so:prebuilts/$ARCH/gallium_dri.so \
       --file_version=$VERSION \
       --use_git
    ```

4.  Abandon the CL from step 1, submit CLs generated in step 3.