Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d10247b7 authored by Kevin Rocard's avatar Kevin Rocard
Browse files

Audio HAL: Update file tree documentation 



Test: none, its doc
Change-Id: Ifc97425ca3bdc41d61c986e4e59b8b2733f3da9c
Signed-off-by: default avatarKevin Rocard <krocard@google.com>
parent 96d2cd9d

audio/README

+16 −31
Original line number Diff line number Diff line 
Directory structure of the audio HIDL related code.



audio

|-- 2.0              <== HIDL (.hal) can not be moved to fit the directory structure

|                        because that would create a separate HAL

|-- 2.0              <== core 2.0 HIDL API. .hal can not be moved into the core directory

|                        because that would change its namespace and include path

|-- 4.0              <== Version 4.0 of the core API

|

|-- ...

|

|-- common           <== code common to audio core and effect API

|   |-- 2.0

|   |   |-- default  <== code that wraps the legacy API

|   |   `-- vts      <== vts of 2.0 core and effect API common code

|   |-- 2.0          <== HIDL API of V2

|   |-- 4.0

|   |   |-- default

|   |   `-- vts

|   |-- ...          <== The future versions should continue this structure

|   |   |-- default

|   |   `-- vts

|   |-- ...

|   `-- all_versions <== code common to all version of both core and effect API

|       |-- default

|       `-- vts      <== vts of core and effect API common version independent code

|       |-- default  <== implementation shared code between core and effect impl

|       |-- test     <== utilities used by tests

|       `-- util     <== utilities used by both implementation and tests

|

|-- core           <== code relative to the core API

|   |-- 2.0          <== 2.0 core API code (except .hal, see audio/2.0)

|   |   |-- default

|   |   `-- vts

|-- core             <== VTS and default implementation of the core API (not HIDL, see /audio/2.0))

|   `-- all_versions <== Code is version independent through #if and separate files

|       |-- default  <== code that wraps the legacy API

|       `-- vts      <== vts of core API

|           |-- 2.0  <== 2.0 specific tests and helpers

|           |-- 4.0

|   |   |-- default  <== default implementation of the core 4.0 api

|   |   `-- vts      <== vts code of the 4.0 API

|           |-- ...

|   |   |-- default

|   |   `-- vts

|   `-- all_versions

|       |-- default

|       `-- vts      <== vts of core API common version independent code

|

`-- effect           <== idem for the effect API

    |-- 2.0

    |   |-- default

    |   `-- vts

    |-- 4.0

    |   |-- default

    |   `-- vts

    |-- ...

    |   |-- default

    |   `-- vts

    `-- all_versions

        |-- default

        `-- vts