Dodaj nowe formaty pikseli do Androida

Wszystkie nowe formaty pikseli dodane do Androida muszą być uwzględnione w języku definiowania interfejsu Androida (AIDL) oraz w buforze sprzętowym Androida (AHB). AIDL i AHB mają rygorystyczne wymagania dotyczące stabilności i standardów, które wymagają ostrożnego procesu rozszerzania funkcjonalności. Wszystkie nowe formaty pikseli muszą być dostępne w AOSP, a wszystkie aktualizacje muszą być indywidualnie zatwierdzone przez ekspertów AIDL i AHB. Ten proces dokładnego potwierdzenia jest ważnym czynnikiem w standardowym stosowaniu nowych formatów pikseli na platformie.

Na tej stronie opisujemy niezbędne zmiany w kodzie AOSP oraz proces dodawania nowych formatów pikseli w AOSP.

Zanim dodasz nowy format pikselowy, pobierz źródło i prześlij poprawki zgodnie z opisem w artykule Przesyłanie poprawek.

Dodawanie nowego formatu piksela do AIDL

Dodanie obsługi nowego formatu pikseli wymaga wprowadzenia zmian w obu plikach PixelFormat.aidl znajdujących się w pliku AIDL. Kod źródłowy AIDL znajdziesz na stronie hardware/interfaces/graphics/common/aidl/.

Aby dodać nowy format pikselowy do AIDL:

  1. Dodaj nowy format pikselów jako nowy wpis na końcu enumu PixelFormat w pliku PixelFormat.aidl, stosując obowiązującą konwencję kodowania i ustawiając wartość szesnastkową wpisu o jedną większą niż w poprzednim wpisie. Dopasuj zmiany kodu do poprzednich wpisów. Oto przykład wpisu w formacie piksela RGBA_8888:
    /**
     * 32-bit format that has 8-bit R, G, B, and A components, in that order,
     * from the lowest memory address to the highest memory address.
     *
     * The component values are unsigned normalized to the range [0, 1], whose
     * interpretation is defined by the dataspace.
     */
    RGBA_8888 = 0x1,
    

    Ten komunikat o błędzie pojawia się podczas tworzenia kodu po wprowadzeniu zmian w PixelFormat.aidl:

    android_developer:~/android/aosp-main: m
    ...
    ###############################################################################
    # ERROR: AIDL API change detected                                             #
    ###############################################################################
    Above AIDL file(s) has changed. Run `m android.hardware.graphics.common-update-api` to reflect the changes
    to the current version so that it is reviewed by
    android-aidl-api-council@google.com
    And then you need to change dependency on android.hardware.graphics.common-V(n)-* to android.hardware.graphics.common-V(n+1)-* to use
    new APIs.
    
  2. Aby usunąć ten błąd, uruchom to polecenie zgodnie z informacją o błędzie, aby zmienić PixelFormat.aidl w katalogu aidl_api:

    m android.hardware.graphics.common-update-api
    

    Uruchomienie tego polecenia spowoduje zaktualizowanie odpowiedniego pliku, co umożliwi normalne kompilację.

Dodawanie nowego formatu piksela do AHB

Dodanie obsługi nowego formatu pikseli wymaga wprowadzenia zmian w hardware_buffer.h i AHardwareBuffer.cpp. Kod źródłowy AHB znajdziesz w pliku frameworks/native/libs/nativewindow.

Aby dodać nowy format pikselowy do AHB:

  1. hardware_buffer.h dodaj nowy format pikselów jako nowy wpis na końcu enumeracji AHardwareBuffer_Format. Stosuj obowiązujące konwencje kodowania.

    Na przykładzie formatu pikseli RGBA_8888 dodaj nowy wpis formatu pikseli w ten sposób:

    /**
     * Corresponding formats:
     *   Vulkan: VK_FORMAT_R8G8B8A8_UNORM
     *   OpenGL ES: GL_RGBA8
     */
    AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM = 1,
    

    Pamiętaj, że nowy format piksela ma nazwę w AHB, która musi zaczynać się od AHARDWAREBUFFER_FORMAT_, a następnie zawierać skróty kanałów i głębie bitowe, a na końcu kodowanie. Ten wpis w algorytmie musi mieć tę samą wartość heksadecymalną co PixelFormat.aidl.

    Format piksela powinien mieć co najmniej 1 powiązany format Vulkan lub OpenGL ES. W razie potrzeby określ powiązany format. Jeśli nie ma powiązanego formatu, wpisz N/A.

  2. Dodaj format pikselowy do opcjonalnych testów w CTS, jeśli ma on powiązany format OpenGL ES. Aby to zrobić, dodaj nowy format GL do AHardwareBufferGLTest.cpp w AHBFormatAsString(int32_t format) z FORMAT_CASE(...) i GL_FORMAT_CASE(...) dla nowego formatu, jak pokazano poniżej:

    const char* AHBFormatAsString(int32_t format) {
      switch (format) {
          ...
          FORMAT_CASE(R8G8B8A8_UNORM);
          ...
          GL_FORMAT_CASE(GL_RGB8);
      }
      return "";
    }
    
  3. Następnie dodaj nowy test do AHardwareBufferGLTest.cpp w ten sposób:

    class RGBA8Test : public AHardwareBufferGLTest {};
    
    // Verify that if we can allocate an RGBA8 AHB we can render to it.
    TEST_P(RGBA8Test, Write) {
        AHardwareBuffer_Desc desc = GetParam();
        desc.usage = AHARDWAREBUFFER_USAGE_GPU_FRAMEBUFFER;
        if (!SetUpBuffer(desc)) {
            return;
        }
    
        ASSERT_NO_FATAL_FAILURE(SetUpFramebuffer(desc.width, desc.height, 0, kBufferAsRenderbuffer));
        ASSERT_NO_FATAL_FAILURE(
            SetUpProgram(kVertexShader, kColorFragmentShader, kPyramidPositions, 0.5f));
    
        glDrawArrays(GL_TRIANGLES, 0, kPyramidVertexCount);
        ASSERT_EQ(GLenum{GL_NO_ERROR}, glGetError());
    }
    
    INSTANTIATE_TEST_CASE_P(
        SingleLayer, RGBA8Test,
        ::testing::Values(
            AHardwareBuffer_Desc{57, 33, 1, AHARDWAREBUFFER_FORMAT_R16G16_UINT, 0, 0, 0, 0}),
        &GetTestName);
    

    Podaj co najmniej 1 zbiór wartości AHardwareBuffer_Desc. W razie potrzeby dodaj więcej wartości.

  4. W pliku AHardwareBuffer.cpp znajdź koniec stwierdzeń statycznych znalezionych w ramach:

    // ----------------------------------------------------------------------------
    // Validate hardware_buffer.h and PixelFormat.aidl agree
    // ----------------------------------------------------------------------------
    

    Dodaj nową wartość static_assert dla nowego formatu pikseli, używając enumeracji PixelFormat::, a nie stałej HAL_PIXEL_FORMAT. Korzystając z tego samego przykładu formatu pikselowego RGBA_8888 z sekcji Dodaj nowy format pikselowy do AIDL, dodaj nowy wpis formatu pikselowego w ten sposób:

    static_assert(static_cast(aidl::android::hardware::graphics::common::PixelFormat::RGBA_8888) ==
      AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM,
    "HAL and AHardwareBuffer pixel format don't match");
    
  5. Dodaj nowy format pikselów do odpowiednich testów, dołączając go na końcu parametru PrintAhbFormat()AHardwareBufferTest.cpp. Postępuj zgodnie z dotychczasową konwencją kodowania, jak pokazano poniżej:

    void PrintAhbFormat(std::ostream& os, uint64_t format) {
        switch (format) {
            ...
            FORMAT_CASE(R8G8B8A8_UNORM);
            default: os << "unknown"; break;
        }
    }
    
  6. Dodaj nowy format pliku do pakietu SDK HardwareBufferHardwareBuffer.java: dołącz nowy wpis do pliku @IntDef. Na przykład wpis w formacie RGBA_8888 wygląda tak:

    @Retention(RetentionPolicy.SOURCE)
    @IntDef(prefix = { "RGB", "BLOB", "YCBCR_", "D_", "DS_", "S_" }, value = {
      ...
      RGBA_8888,
    })
    

    Jeśli wartości składowe nie są znormalizowane bez znaku, podaj wartość bezpośrednio w nazwie zmiennej. Na przykład nazwa zmiennej dla bez znaku 16-bitowego formatu tylko kanału czerwonego musi mieć postać R_16UI, a ten sam format z dodatkowym bez znaku 16-bitowym formatem kanału zielonego musi mieć postać RG_16UI16UI.

  7. Dodaj nowy format pikselowy jako static intHardwareBuffer.java, dodając nową publiczną zmienną członkowską na końcu @Format:

    @Format
    ...
    /** Format: 8 bits each red, green, blue, alpha */
    public static final int RGBA_8888 = 0x1;
    

    Ten wpis w algorytmie musi mieć tę samą wartość szesnastkową co PixelFormat.aidlhardware_buffer.h. Przestrzegaj istniejących konwencji.

  8. Próba kompilacji z tymi zmianami kodu powoduje błąd kompilacji:

    android_developer:~/android/aosp-main: m
    ...
    ******************************
    You have tried to change the API from what has been previously approved.
    
    To make these errors go away, you have two choices:
       1. You can add '@hide' javadoc comments (and remove @SystemApi/@TestApi/etc)
          to the new methods, etc. shown in the above diff.
    
       2. You can update current.txt and/or removed.txt by executing the following command:
             m api-stubs-docs-non-updatable-update-current-api
    
          To submit the revised current.txt to the main Android repository,
          you will need approval.
    ******************************
    ...
    

    Aby usunąć ten błąd, uruchom to polecenie zgodnie z informacjami podanymi w komunikacie o błędzie, aby wprowadzić zmiany:current.txt

    m api-stubs-docs-non-updatable-update-current-api
    

    Uruchomienie tego polecenia spowoduje zaktualizowanie odpowiedniego pliku, co umożliwi normalne kompilację.

  9. Dodaj nowy format pikselów do testów w języku Java, dołączając nowy format pikselów do końca paramsForTestCreateOptionalFormats()HardwareBufferTest.java, jak pokazano poniżej:

    private static Object[] paramsForTestCreateOptionalFormats() {
      return new Integer[]{
          HardwareBuffer.RGBA_8888
      };
    

Dodawanie nowego formatu pikseli do integracji z systemem Window

Aby użyć nowego formatu piksela jako formatu framebuffer w interfejsie Graphics API, dodaj go do odpowiedniej integracji systemu Windows (WSI) dla odpowiedniego interfejsu Graphics API. W przypadku aplikacji lub procesu systemowego korzystającego z interfejsu Vulkan API zaktualizuj Vulkan Replacechain. W przypadku aplikacji lub procesu systemowego korzystającego z interfejsu OpenGL ES zaktualizuj interfejs EGL.

Zmiany w Vulkan WSI dotyczące nowych formatów pikseli

Zaktualizuj interfejs Vulkan WSI w następujący sposób:
  1. Dodaj nowy przypadek do funkcji GetNativePixelFormat(VkFormat format) w funkcji swapchain.cpp:

    android::PixelFormat GetNativePixelFormat(VkFormat format) {
      ...
      switch (format) {
          ...
          case VK_FORMAT_R8G8B8A8_UNORM:
              native_format = PixelFormat::RGBA_8888;
              break;
          ...
          default:
              ALOGV("unsupported swapchain format %d", format);
              break;
      }
      return native_format;
    }
    
  2. Prześlij zapytanie do rozszerzenia Vulkan, jeśli format pikseli wymaga rozszerzenia Vulkan. Na przykład w przypadku rozszerzeń bocznych używaj instance_data, jak pokazano poniżej:
    bool colorspace_ext = instance_data.hook_extensions.test(ProcHook::EXT_swapchain_colorspace);
    

    W przypadku rozszerzeń po stronie urządzenia użyj tych komponentów:

    bool rgba10x6_formats_ext = false;
    uint32_t exts_count;
    const auto& driver = GetData(pdev).driver;
    driver.EnumerateDeviceExtensionProperties(pdev, nullptr, &exts_count,
                                              nullptr);
    std::vector props(exts_count);
    driver.EnumerateDeviceExtensionProperties(pdev, nullptr, &exts_count,
                                              props.data());
    for (uint32_t i = 0; i < exts_count; i++) {
        VkExtensionProperties prop = props[i];
        if (strcmp(prop.extensionName,
                   VK_EXT_RGBA10X6_FORMATS_EXTENSION_NAME) == 0) {
            rgba10x6_formats_ext = true;
        }
    }
    

    Google obsługuje infrastrukturę wymaganą do udostępnienia instancji lub rozszerzenia urządzenia swapchain.cpp. Początkowa lista zmian nie jest wymagana do prawidłowej konfiguracji rozszerzeń przez ładowarkę Vulkan.

  3. Następnie wylicz pary formatu i przestrzeni kolorów:
    desc.format = AHARDWAREBUFFER_FORMAT_R10G10B10A10_UNORM;
    if (AHardwareBuffer_isSupported(&desc) && rgba10x6_formats_ext) {
      all_formats.emplace_back(
          VkSurfaceFormatKHR{VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16,
                             VK_COLOR_SPACE_SRGB_NONLINEAR_KHR});
      if (colorspace_ext) {
        all_formats.emplace_back(
            VkSurfaceFormatKHR{VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16,
                               VK_COLOR_SPACE_PASS_THROUGH_EXT});
        all_formats.emplace_back(
            VkSurfaceFormatKHR{VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16,
                               VK_COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT});
    }
    

    Musisz znać pary zgodnych formatów i przestrzeni kolorów.

  4. Dodaj nowy format do dEQP-VK, który znajduje się na stronie external/deqp.
  5. Zaktualizuj testy zgodności Vulkana w vktApiExternalMemoryTests.cppvktExternalMemoryUtil.cpp, wyciągając wymagane zmiany z dotychczasowego źródła lub kontaktując się z zespołem pomocy Androida.

Zmiany w EGL dotyczące nowych formatów pikseli

Zaktualizuj EGL w ten sposób:

  1. W funkcji getNativePixelFormat() zmodyfikuj drzewo if-else tak, aby zwracało wyliczenie AIDL dla nowego formatu pikseli. Przykład dla formatu RGBA_8888:
    if (a == 0) {
      ...
    } else {
      if (componentType == EGL_COLOR_COMPONENT_TYPE_FIXED_EXT) {
          if (colorDepth > 24) {
              ...
          } else {
              *format = PixelFormat::RGBA_8888;
          }
      } else {
        ...
      }
    }
    
  2. Aby dodać nowy format do dEQP, dodaj nowy wpis do enumeracji androidFormats, jak pokazano poniżej:
    static const GLenum androidFormats[] =
    {
      ...
      GL_RGBA8,
      ...
    };
    

Prześlij aktualizację

Aby współtwórcy mogli tworzyć listy zmian i udostępniać je odpowiedniemu zespołowi: