Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_images/arc_roadmap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
102 changes: 102 additions & 0 deletions docs/_sources/arc/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
.. _arc_design:

AudioReach Creator
##################################################

.. contents::
:local:
:depth: 3

Introduction
-------------------

AudioReach Creator (ARC), also known as Qualcomm Audio Calibration Tool (QACT) for older version, is an open source and cross-platform software providing a user interface to audio design, software, and tuning engineers for composing, configuring, tuning, and storing audio graphs into audio calibration database (ACDB) for intended use cases.

Roadmap
-------------------
.. figure:: images/arc_roadmap.png
:figclass: fig-center
:scale: 70%

AudioReach Creator (ARC) Roadmap

Architecture
--------------------------------------
AudioReach Creator (ARC) architecture will contain two separate parts: UI (Frontend) and ARC Engine (Backend).

.. figure:: images/arc_hld_overview.png
:figclass: fig-center
:scale: 70 %

AudioReach Creator (ARC) High-Level Software Component View


ARC UI (Frontend)
^^^^^^^^^^^^^^^^^
Frontend will contain all the required user interfaces and will be developed using Electron and React.

.. figure:: images/arc_hld_frontend.png
:figclass: fig-center
:scale: 80 %

AudioReach Creator (ARC) High-Level Software Component View (Frontend)

Presentation Layer
""""""""""""""""""

- React components that handle UI and user interactions.
- Communicates only with the Facade.
- They receive data via @Input() and emit events via @Output().

Major UI Features
*****************

**Start Page:** Entry page of ARC application which will holds buttons to allow users to open file, connect to a device etc.

**Graph View:** After opening a file or connecting to a device, selected usecase's graphs will be displayed. User can modify and tune usecases in Graph View.

**Calibration View:** For a selected module, its calibration data can be tuned through Calibration View.

**Log View:** Will show all log messages for each UI operation.

**Discovery Wizard:** Will provide UI workflow to import definitions for modules and some meta information so that they can be used in usecases. For those modules which are already being used in some usecases, updated module definitions can be applied to usecases automatically through Discovery Wizard.

**ACDB Merge:** Will provide workflow to compare and merge data between ACDB files. This feature will be helpful for users to manage their files between different branches.

Facade Layer
"""""""""""""""""

- Acts as an intermediary between the presentation and state layers.
- Exposes observables and methods to the components.
- Dispatches actions or calls services to update the state.

State Layer
"""""""""""""""""

- Manages application state using a store (e.g., NgRx or a custom service).
- Handles API calls and updates state accordingly.
- Exposes state as observables.


ARC Engine (Backend)
^^^^^^^^^^^^^^^^^^^^

ARC Engine will work as a web server to provide all APIs for Frontend to access/update data from database. It will contain Presentation and Domain layers.

.. figure:: images/arc_hld_backend.png
:figclass: fig-center
:scale: 80 %

AudioReach Creator (ARC) High-Level Software Component View (Backend)

Presentation Layer
""""""""""""""""""

- Provides web REST apis to handle http/https requests.
- Provides gRPC apis to communicate large size data in real time for high-performance and low-latency requirement (typically used for RTM).
- Provides notification mechanism with SignalR.

Domain Layer
"""""""""""""""""

- Provides services with core business logic and rules to query/update data from/to database.
1 change: 0 additions & 1 deletion docs/_sources/design/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ AudioReach Designs
args_design
gpr_design
lx_design
arc_design
1 change: 1 addition & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Table of Contents
design/index.rst
api/index.rst
dev/index.rst
arc/index.rst
platform/index.rst

Indices and tables
Expand Down
1 change: 1 addition & 0 deletions docs/api/args_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">AudioReach Developer Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../arc/index.html">AudioReach Creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../platform/index.html">Platform Reference Guide</a></li>
</ul>

Expand Down
1 change: 1 addition & 0 deletions docs/api/args_arosal.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">AudioReach Developer Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../arc/index.html">AudioReach Creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../platform/index.html">Platform Reference Guide</a></li>
</ul>

Expand Down
1 change: 1 addition & 0 deletions docs/api/args_gsl.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">AudioReach Developer Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../arc/index.html">AudioReach Creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../platform/index.html">Platform Reference Guide</a></li>
</ul>

Expand Down
1 change: 1 addition & 0 deletions docs/api/arspf_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">AudioReach Developer Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../arc/index.html">AudioReach Creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../platform/index.html">Platform Reference Guide</a></li>
</ul>

Expand Down
1 change: 1 addition & 0 deletions docs/api/gpr_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">AudioReach Developer Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../arc/index.html">AudioReach Creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../platform/index.html">Platform Reference Guide</a></li>
</ul>

Expand Down
5 changes: 3 additions & 2 deletions docs/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="AudioReach Engine APIs" href="arspf_api.html" />
<link rel="prev" title="AudioReach Creator Design" href="../design/arc_design.html" />
<link rel="prev" title="Linux ASoC Architecture" href="../design/linux_asoc_arch.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -56,6 +56,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">AudioReach Developer Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../arc/index.html">AudioReach Creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../platform/index.html">Platform Reference Guide</a></li>
</ul>

Expand Down Expand Up @@ -98,7 +99,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../design/arc_design.html" class="btn btn-neutral float-left" title="AudioReach Creator Design" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../design/linux_asoc_arch.html" class="btn btn-neutral float-left" title="Linux ASoC Architecture" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="arspf_api.html" class="btn btn-neutral float-right" title="AudioReach Engine APIs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
1 change: 1 addition & 0 deletions docs/api/posal_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">AudioReach Developer Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../arc/index.html">AudioReach Creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../platform/index.html">Platform Reference Guide</a></li>
</ul>

Expand Down
1 change: 1 addition & 0 deletions docs/api/spf_capi.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">AudioReach Developer Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../arc/index.html">AudioReach Creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../platform/index.html">Platform Reference Guide</a></li>
</ul>

Expand Down
Loading
Loading