Base+Utilities: Add the asctl audio utility, replacing avol

The new asctl (audio server control) utility expands on avol with a
completely new command line interface (documented in the man page) that
supports retrieving and setting all exposed audio server settings, like
volume and sample rate. This is currently the only user-facing way of
changing the sample rate.

3 files changed, 158 insertions, 51 deletions

diff --git a/Userland/Utilities/CMakeLists.txt b/Userland/Utilities/CMakeLists.txt
index 97a98ab2ea..3f5d1fd5ed 100644
--- a/Userland/Utilities/CMakeLists.txt
+++ b/Userland/Utilities/CMakeLists.txt
@@ -7,7 +7,7 @@ list(APPEND REQUIRED_TARGETS
     touch tr true umount uname uniq uptime w wc which whoami xargs yes less
 )
 list(APPEND RECOMMENDED_TARGETS
-    adjtime aplay avol bt checksum chres cksum copy fortune gunzip gzip init keymap lsirq lsof lspci man mknod mktemp
+    adjtime aplay asctl bt checksum chres cksum copy fortune gunzip gzip init keymap lsirq lsof lspci man mknod mktemp
     modload modunload nc netstat notify ntpquery open pape passwd pls printf pro shot tar tt unzip zip
 )
 
@@ -52,7 +52,7 @@ foreach(CMD_SRC ${CMD_SOURCES})
 endforeach()
 
 target_link_libraries(aplay LibAudio)
-target_link_libraries(avol LibAudio)
+target_link_libraries(asctl LibAudio)
 target_link_libraries(bt LibSymbolication)
 target_link_libraries(checksum LibCrypto)
 target_link_libraries(chres LibGUI)
diff --git a/Userland/Utilities/asctl.cpp b/Userland/Utilities/asctl.cpp
new file mode 100644
index 0000000000..e3e023a9b4
--- /dev/null
+++ b/Userland/Utilities/asctl.cpp
@@ -0,0 +1,156 @@
+/*
+ * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
+ * Copyright (c) 2021, kleines Filmröllchen <malu.bertsch@gmail.com>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <AK/Variant.h>
+#include <AK/Vector.h>
+#include <LibAudio/Buffer.h>
+#include <LibAudio/ClientConnection.h>
+#include <LibCore/ArgsParser.h>
+#include <LibCore/EventLoop.h>
+#include <LibCore/File.h>
+#include <stdio.h>
+#include <sys/ioctl.h>
+
+enum AudioVariable : u32 {
+    Volume,
+    Mute,
+    SampleRate
+};
+
+// asctl: audio server control utility
+int main(int argc, char** argv)
+{
+    Core::EventLoop loop;
+    auto audio_client = Audio::ClientConnection::construct();
+
+    String command = String::empty();
+    Vector<String> arguments;
+    bool human_mode = false;
+
+    Core::ArgsParser args_parser;
+    args_parser.set_general_help("Send control signals to the audio server and hardware.");
+    args_parser.add_option(human_mode, "Print human-readable output", "human-readable", 'h');
+    args_parser.add_positional_argument(command, "Command, either (g)et or (s)et\n\n\tThe get command accepts a list of variables to print.\n\tThey are printed in the given order.\n\tIf no value is specified, all are printed.\n\n\tThe set command accepts a any number of variables\n\tfollowed by the value they should be set to.\n\n\tPossible variables are (v)olume, (m)ute, sample(r)ate.\n", "command");
+    args_parser.add_positional_argument(arguments, "Arguments for the command", "args", Core::ArgsParser::Required::No);
+    args_parser.parse(argc, argv);
+
+    if (command.equals_ignoring_case("get") || command == "g") {
+        // Get variables
+        Vector<AudioVariable> values_to_print;
+        if (arguments.is_empty()) {
+            values_to_print.append(AudioVariable::Volume);
+            values_to_print.append(AudioVariable::Mute);
+            values_to_print.append(AudioVariable::SampleRate);
+        } else {
+            for (auto& variable : arguments) {
+                if (variable.is_one_of("v"sv, "volume"sv))
+                    values_to_print.append(AudioVariable::Volume);
+                else if (variable.is_one_of("m"sv, "mute"sv))
+                    values_to_print.append(AudioVariable::Mute);
+                else if (variable.is_one_of("r"sv, "samplerate"sv))
+                    values_to_print.append(AudioVariable::SampleRate);
+                else {
+                    warnln("Error: Unrecognized variable {}", variable);
+                    return 1;
+                }
+            }
+        }
+
+        for (auto to_print : values_to_print) {
+            switch (to_print) {
+            case AudioVariable::Volume: {
+                i16 volume = audio_client->get_main_mix_volume();
+                if (human_mode)
+                    outln("Volume: {:3d}%", volume);
+                else
+                    out("{} ", volume);
+                break;
+            }
+            case AudioVariable::Mute: {
+                bool muted = audio_client->get_muted();
+                if (human_mode)
+                    outln("Muted: {}", muted ? "Yes" : "No");
+                else
+                    out("{} ", muted ? 1 : 0);
+                break;
+            }
+            case AudioVariable::SampleRate: {
+                u16 sample_rate = audio_client->get_sample_rate();
+                if (human_mode)
+                    outln("Sample rate: {:5d} Hz", sample_rate);
+                else
+                    out("{} ", sample_rate);
+                break;
+            }
+            }
+        }
+        if (!human_mode)
+            outln();
+    } else if (command.equals_ignoring_case("set") || command == "s") {
+        // Set variables
+        HashMap<AudioVariable, Variant<int, bool>> values_to_set;
+        for (size_t i = 0; i < arguments.size(); ++i) {
+            if (i == arguments.size() - 1) {
+                warnln("Error: value missing for last variable");
+                return 1;
+            }
+            auto& variable = arguments[i];
+            if (variable.is_one_of("v"sv, "volume"sv)) {
+                auto volume = arguments[++i].to_int();
+                if (!volume.has_value()) {
+                    warnln("Error: {} is not an integer volume", arguments[i - 1]);
+                    return 1;
+                }
+                values_to_set.set(AudioVariable::Volume, volume.value());
+            } else if (variable.is_one_of("m"sv, "mute"sv)) {
+                String& mute_text = arguments[++i];
+                bool mute;
+                if (mute_text.equals_ignoring_case("true") || mute_text == "1") {
+                    mute = true;
+                } else if (mute_text.equals_ignoring_case("false") || mute_text == "0") {
+                    mute = false;
+                } else {
+                    warnln("Error: {} is not one of {{0, 1, true, false}}", mute_text);
+                    return 1;
+                }
+                values_to_set.set(AudioVariable::Mute, mute);
+            } else if (variable.is_one_of("r"sv, "samplerate"sv)) {
+                auto sample_rate = arguments[++i].to_int();
+                if (!sample_rate.has_value()) {
+                    warnln("Error: {} is not an integer sample rate", arguments[i - 1]);
+                    return 1;
+                }
+                values_to_set.set(AudioVariable::SampleRate, sample_rate.value());
+            } else {
+                warnln("Error: Unrecognized variable {}", arguments[i]);
+                return 1;
+            }
+        }
+
+        for (auto to_set : values_to_set) {
+            switch (to_set.key) {
+            case AudioVariable::Volume: {
+                int& volume = to_set.value.get<int>();
+                audio_client->set_main_mix_volume(volume);
+                break;
+            }
+            case AudioVariable::Mute: {
+                bool& mute = to_set.value.get<bool>();
+                audio_client->set_muted(mute);
+                break;
+            }
+            case AudioVariable::SampleRate: {
+                int& sample_rate = to_set.value.get<int>();
+                audio_client->set_sample_rate(sample_rate);
+                break;
+            }
+            }
+        }
+    }
+
+    return 0;
+}
diff --git a/Userland/Utilities/avol.cpp b/Userland/Utilities/avol.cpp
deleted file mode 100644
index d70d106ce9..0000000000
--- a/Userland/Utilities/avol.cpp
+++ /dev/null
@@ -1,49 +0,0 @@
-/*
- * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
- *
- * SPDX-License-Identifier: BSD-2-Clause
- */
-
-#include <LibAudio/Buffer.h>
-#include <LibAudio/ClientConnection.h>
-#include <LibCore/ArgsParser.h>
-#include <LibCore/EventLoop.h>
-#include <stdio.h>
-
-int main(int argc, char** argv)
-{
-    Core::EventLoop loop;
-    auto audio_client = Audio::ClientConnection::construct();
-
-    bool mute = false;
-    bool unmute = false;
-    // FIXME: What is a good way to have an optional int argument?
-    const char* volume = nullptr;
-
-    Core::ArgsParser args_parser;
-    args_parser.add_option(mute, "Mute volume", "mute", 'm');
-    args_parser.add_option(unmute, "Unmute volume", "unmute", 'M');
-    args_parser.add_positional_argument(volume, "Volume to set", "volume", Core::ArgsParser::Required::No);
-    args_parser.parse(argc, argv);
-
-    if (!mute && !unmute && !volume) {
-        auto volume = audio_client->get_main_mix_volume();
-        outln("Volume: {}", volume);
-        return 0;
-    }
-    if (!(mute ^ unmute ^ (volume != nullptr))) {
-        warnln("Only one of mute, unmute or volume must be used");
-        return 1;
-    }
-    if (mute) {
-        audio_client->set_muted(true);
-        outln("Muted.");
-    } else if (unmute) {
-        audio_client->set_muted(false);
-        outln("Unmuted.");
-    } else {
-        auto new_volume = atoi(volume);
-        audio_client->set_main_mix_volume(new_volume);
-    }
-    return 0;
-}