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

Commit 1074c22f authored by Mikhail Naganov's avatar Mikhail Naganov
Browse files

audio: Reformat README as Markdown 

Rename README -> README.md, reformat it as Markdown.
Provide missing descriptions for some directories.

Bug: 142480271
Test: N/A
Change-Id: Ic6f60a21def4bf210a7e1446454d709f68a13422
Merged-In: Ic6f60a21def4bf210a7e1446454d709f68a13422
parent 355dd063

audio/README

deleted100644 → 0
+0 −36
Original line number Diff line number Diff line 
Directory structure of the audio HIDL related code.



Run `common/all-versions/copyHAL.sh` to create a new version of the audio HAL

based on an existing one.



audio

|-- 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          <== HIDL API of V2

|   |-- 4.0

|   |-- ...

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

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

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

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

|

|-- 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

|           |-- ...

|

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

    |-- 2.0

    |-- 4.0

    |-- ...

    `-- all-versions

        |-- default

        `-- vts

audio/README.md

0 → 100644
+49 −0
Original line number Diff line number Diff line 
# Audio HAL



Directory structure of the audio HAL related code.



Run `common/all-versions/copyHAL.sh` to create a new version of the audio HAL

based on an existing one.



## Directory Structure



* `2.0` -- version 2.0 of the core HIDL API. Note that `.hal` files

  can not be moved into the `core` directory because that would change

  its namespace and include path.

   - `config` -- the XSD schema for the Audio Policy Manager

     configuration file.

* `4.0` -- version 4.0 of the core HIDL API.

* ...

* `common` -- common types for audio core and effect HIDL API.

   - `2.0` -- version 2.0 of the common types HIDL API.

   - `4.0` -- version 4.0.

   - ...

   - `all-versions` -- code common to all version of both core and effect API.

      - `default` -- shared code of the default implementation.

         - `service` -- vendor HAL service for hosting the default

           implementation.

      - `test` -- utilities used by tests.

      - `util` -- utilities used by both implementation and tests.

* `core` -- VTS tests and the default implementation of the core API

  (not HIDL API, it's in `audio/N.M`).

   - `7.0` -- code specific to version V7.0 of the core HIDL API

   - `all-versions` -- the code is common between all versions,

     version-specific parts are enclosed into conditional directives

     of preprocessor or reside in dedicated files.

       - `default` -- code that wraps the legacy API (from

         `hardware/libhardware`).

       - `vts` VTS tests for the core HIDL API.

* `effect` -- same for the effect HIDL API.

   - `2.0`

      - `config` -- the XSD schema for the Audio Effects configuration

        file.

   - `4.0`

   - ...

   - `all-versions`

      - `default`

      - `vts`

* `policy` -- Configurable Audio Policy schemes.

   - `1.0` -- note that versions of CAP are not linked to the versions

     of audio HAL.

      - `vts` -- VTS tests for validating actual configuration files.

      - `xml` -- XSD schemas for CAP configuration files.