summaryrefslogtreecommitdiffstats
path: root/docs/1. Introduction.md
diff options
context:
space:
mode:
authorJames O'Shannessy <james.oshannessy@fiberdyne.com.au>2018-09-13 17:20:37 -0700
committerMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-26 17:27:44 +1100
commit7e4db2ff6865d723a2a6233a9542730876d06260 (patch)
tree91d37a48772711cd9a3ad85195799cd356377f12 /docs/1. Introduction.md
parent83ab0cdf84def71eebdebf0c813cebfce8f99d06 (diff)
Updating build instructions
Cleaning up build instructions for building AVIRT Signed-off-by: James O'Shannessy <james.oshannessy@fiberdyne.com.au>
Diffstat (limited to 'docs/1. Introduction.md')
-rw-r--r--docs/1. Introduction.md21
1 files changed, 8 insertions, 13 deletions
diff --git a/docs/1. Introduction.md b/docs/1. Introduction.md
index f2d088d..29cac71 100644
--- a/docs/1. Introduction.md
+++ b/docs/1. Introduction.md
@@ -1,18 +1,13 @@
Introduction
===================
-## Problem
-- Insecure
-- Limited
-- Not fully optimised for use case (ie. Routing Audio to DSP vs. Loopback)
-- Not generic interface for highly configurable hardware
--
+The ALSA Virtual Sound Driver (AVIRT) aims to provide a Linux kernel solution to the issue of audio routing in kernel-space, as well as security per-stream, and dynamic configuration of streams at the kernel level.
-## Solution
+A top-level abstract dynamic audio driver is presented to the user-space via an ALSA middle-layer card. From there, respective low-level "real" audio drivers can subscribe to it as an "Audio Path".
-## Added Features
-- Dynamic Runtime Alsa Front end
-- Adjustable Audio Path
-- Mappable Audio Path
-- Secure Audio Routing w/ SMACK
-- \ No newline at end of file
+The top-level driver is configured (currently) using module parameters, as is the norm for sound drivers in the Linux tree, however this will utilise a configfs configuration implementation in future.
+
+A sample dummy Audio Path is provided as an example to show how a low-level audio driver would subscribe to AVIRT, and accept audio routing for playback.
+
+Currently, the Fiberdyne DSP hardmixer is supported on the Renesas R-Car M3 AGL
+reference platform, and a default loopback softmixer is in development. \ No newline at end of file