aboutsummaryrefslogtreecommitdiffstats
path: root/docs/1.Introduction.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/1.Introduction.md')
-rw-r--r--docs/1.Introduction.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/1.Introduction.md b/docs/1.Introduction.md
new file mode 100644
index 0000000..29cac71
--- /dev/null
+++ b/docs/1.Introduction.md
@@ -0,0 +1,13 @@
+Introduction
+===================
+
+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.
+
+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".
+
+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