From ac2238ee707877d5f9a94f6887ace836936156a2 Mon Sep 17 00:00:00 2001
From: Timothy Flynn <trflynn89@pm.me>
Date: Mon, 12 Jun 2023 13:55:43 -0400
Subject: [PATCH] LibWeb: Begin implementing the HTMLAudioElement for audio
 playback

This uses LibAudio to attempt to decode resoures downloaded with <audio>
elements, and draws some basic media controls for the element.
---
 Userland/Libraries/LibWeb/CMakeLists.txt      |  2 +
 Userland/Libraries/LibWeb/Forward.h           |  2 +
 .../LibWeb/HTML/HTMLAudioElement.cpp          | 32 +++++++++
 .../Libraries/LibWeb/HTML/HTMLAudioElement.h  |  8 +++
 .../LibWeb/HTML/HTMLMediaElement.cpp          | 58 ++++++++++------
 Userland/Libraries/LibWeb/Layout/AudioBox.cpp | 35 ++++++++++
 Userland/Libraries/LibWeb/Layout/AudioBox.h   | 28 ++++++++
 .../LibWeb/Painting/AudioPaintable.cpp        | 67 +++++++++++++++++++
 .../LibWeb/Painting/AudioPaintable.h          | 29 ++++++++
 9 files changed, 241 insertions(+), 20 deletions(-)
 create mode 100644 Userland/Libraries/LibWeb/Layout/AudioBox.cpp
 create mode 100644 Userland/Libraries/LibWeb/Layout/AudioBox.h
 create mode 100644 Userland/Libraries/LibWeb/Painting/AudioPaintable.cpp
 create mode 100644 Userland/Libraries/LibWeb/Painting/AudioPaintable.h

diff --git a/Userland/Libraries/LibWeb/CMakeLists.txt b/Userland/Libraries/LibWeb/CMakeLists.txt
index 61105a4bd6f..fbe9009ee7e 100644
--- a/Userland/Libraries/LibWeb/CMakeLists.txt
+++ b/Userland/Libraries/LibWeb/CMakeLists.txt
@@ -389,6 +389,7 @@ set(SOURCES
     Infra/JSON.cpp
     Infra/Strings.cpp
     IntersectionObserver/IntersectionObserver.cpp
+    Layout/AudioBox.cpp
     Layout/AvailableSpace.cpp
     Layout/BlockContainer.cpp
     Layout/BlockFormattingContext.cpp
@@ -444,6 +445,7 @@ set(SOURCES
     Page/EditEventHandler.cpp
     Page/EventHandler.cpp
     Page/Page.cpp
+    Painting/AudioPaintable.cpp
     Painting/BackgroundPainting.cpp
     Painting/BorderPainting.cpp
     Painting/BorderRadiusCornerClipper.cpp
diff --git a/Userland/Libraries/LibWeb/Forward.h b/Userland/Libraries/LibWeb/Forward.h
index 5a0458fd1bf..72d83d186fd 100644
--- a/Userland/Libraries/LibWeb/Forward.h
+++ b/Userland/Libraries/LibWeb/Forward.h
@@ -445,6 +445,7 @@ class IntersectionObserver;
 }
 
 namespace Web::Layout {
+class AudioBox;
 class BlockContainer;
 class BlockFormattingContext;
 class Box;
@@ -484,6 +485,7 @@ class PerformanceTiming;
 }
 
 namespace Web::Painting {
+class AudioPaintable;
 class ButtonPaintable;
 class CheckBoxPaintable;
 class LabelablePaintable;
diff --git a/Userland/Libraries/LibWeb/HTML/HTMLAudioElement.cpp b/Userland/Libraries/LibWeb/HTML/HTMLAudioElement.cpp
index ea3e83e1e89..2c4d6e03573 100644
--- a/Userland/Libraries/LibWeb/HTML/HTMLAudioElement.cpp
+++ b/Userland/Libraries/LibWeb/HTML/HTMLAudioElement.cpp
@@ -4,8 +4,11 @@
  * SPDX-License-Identifier: BSD-2-Clause
  */
 
+#include <LibWeb/HTML/AudioTrack.h>
+#include <LibWeb/HTML/AudioTrackList.h>
 #include <LibWeb/HTML/HTMLAudioElement.h>
 #include <LibWeb/HTML/Window.h>
+#include <LibWeb/Layout/AudioBox.h>
 
 namespace Web::HTML {
 
@@ -24,4 +27,33 @@ JS::ThrowCompletionOr<void> HTMLAudioElement::initialize(JS::Realm& realm)
     return {};
 }
 
+JS::GCPtr<Layout::Node> HTMLAudioElement::create_layout_node(NonnullRefPtr<CSS::StyleProperties> style)
+{
+    return heap().allocate_without_realm<Layout::AudioBox>(document(), *this, move(style));
+}
+
+Layout::AudioBox* HTMLAudioElement::layout_node()
+{
+    return static_cast<Layout::AudioBox*>(Node::layout_node());
+}
+
+Layout::AudioBox const* HTMLAudioElement::layout_node() const
+{
+    return static_cast<Layout::AudioBox const*>(Node::layout_node());
+}
+
+void HTMLAudioElement::on_playing()
+{
+    audio_tracks()->for_each_enabled_track([](auto& audio_track) {
+        audio_track.play({});
+    });
+}
+
+void HTMLAudioElement::on_paused()
+{
+    audio_tracks()->for_each_enabled_track([](auto& audio_track) {
+        audio_track.pause({});
+    });
+}
+
 }
diff --git a/Userland/Libraries/LibWeb/HTML/HTMLAudioElement.h b/Userland/Libraries/LibWeb/HTML/HTMLAudioElement.h
index 4dadc6c15e2..b383e1a6092 100644
--- a/Userland/Libraries/LibWeb/HTML/HTMLAudioElement.h
+++ b/Userland/Libraries/LibWeb/HTML/HTMLAudioElement.h
@@ -16,10 +16,18 @@ class HTMLAudioElement final : public HTMLMediaElement {
 public:
     virtual ~HTMLAudioElement() override;
 
+    Layout::AudioBox* layout_node();
+    Layout::AudioBox const* layout_node() const;
+
 private:
     HTMLAudioElement(DOM::Document&, DOM::QualifiedName);
 
     virtual JS::ThrowCompletionOr<void> initialize(JS::Realm&) override;
+
+    virtual JS::GCPtr<Layout::Node> create_layout_node(NonnullRefPtr<CSS::StyleProperties>) override;
+
+    virtual void on_playing() override;
+    virtual void on_paused() override;
 };
 
 }
diff --git a/Userland/Libraries/LibWeb/HTML/HTMLMediaElement.cpp b/Userland/Libraries/LibWeb/HTML/HTMLMediaElement.cpp
index 3b251232ae2..ff863fa1b0c 100644
--- a/Userland/Libraries/LibWeb/HTML/HTMLMediaElement.cpp
+++ b/Userland/Libraries/LibWeb/HTML/HTMLMediaElement.cpp
@@ -5,6 +5,7 @@
  * SPDX-License-Identifier: BSD-2-Clause
  */
 
+#include <LibAudio/Loader.h>
 #include <LibJS/Runtime/Promise.h>
 #include <LibVideo/PlaybackManager.h>
 #include <LibWeb/Bindings/HTMLMediaElementPrototype.h>
@@ -947,11 +948,12 @@ WebIDL::ExceptionOr<void> HTMLMediaElement::process_media_data(Function<void(Str
     auto& realm = this->realm();
     auto& vm = realm.vm();
 
+    auto audio_loader = Audio::Loader::create(m_media_data.bytes());
     auto playback_manager = Video::PlaybackManager::from_data(m_media_data);
 
     // -> If the media data cannot be fetched at all, due to network errors, causing the user agent to give up trying to fetch the resource
     // -> If the media data can be fetched but is found by inspection to be in an unsupported format, or can otherwise not be rendered at all
-    if (playback_manager.is_error()) {
+    if (audio_loader.is_error() && playback_manager.is_error()) {
         // 1. The user agent should cancel the fetching process.
         m_fetch_controller->stop_fetch();
 
@@ -961,25 +963,38 @@ WebIDL::ExceptionOr<void> HTMLMediaElement::process_media_data(Function<void(Str
         return {};
     }
 
+    JS::GCPtr<AudioTrack> audio_track;
     JS::GCPtr<VideoTrack> video_track;
 
     // -> If the media resource is found to have an audio track
-    {
-        // FIXME: 1. Create an AudioTrack object to represent the audio track.
-        // FIXME: 2. Update the media element's audioTracks attribute's AudioTrackList object with the new AudioTrack object.
-        // FIXME: 3. Let enable be unknown.
+    if (!audio_loader.is_error()) {
+        // 1. Create an AudioTrack object to represent the audio track.
+        audio_track = TRY(vm.heap().allocate<AudioTrack>(realm, realm, *this, audio_loader.release_value()));
+
+        // 2. Update the media element's audioTracks attribute's AudioTrackList object with the new AudioTrack object.
+        TRY_OR_THROW_OOM(vm, m_audio_tracks->add_track({}, *audio_track));
+
+        // 3. Let enable be unknown.
+        auto enable = TriState::Unknown;
+
         // FIXME: 4. If either the media resource or the URL of the current media resource indicate a particular set of audio tracks to enable, or if
         //           the user agent has information that would facilitate the selection of specific audio tracks to improve the user's experience, then:
         //           if this audio track is one of the ones to enable, then set enable to true, otherwise, set enable to false.
-        // FIXME: 5. If enable is still unknown, then, if the media element does not yet have an enabled audio track, then set enable to true, otherwise,
-        //           set enable to false.
-        // FIXME: 6. If enable is true, then enable this audio track, otherwise, do not enable this audio track.
+
+        // 5. If enable is still unknown, then, if the media element does not yet have an enabled audio track, then set enable to true, otherwise,
+        //    set enable to false.
+        if (enable == TriState::Unknown)
+            enable = m_audio_tracks->has_enabled_track() ? TriState::False : TriState::True;
+
+        // 6. If enable is true, then enable this audio track, otherwise, do not enable this audio track.
+        if (enable == TriState::True)
+            audio_track->set_enabled(true);
+
         // FIXME: 7. Fire an event named addtrack at this AudioTrackList object, using TrackEvent, with the track attribute initialized to the new AudioTrack object.
     }
 
     // -> If the media resource is found to have a video track
-    // NOTE: Creating a Video::PlaybackManager above will have failed if there was not a video track.
-    {
+    if (!playback_manager.is_error()) {
         // 1. Create a VideoTrack object to represent the video track.
         video_track = TRY(vm.heap().allocate<VideoTrack>(realm, realm, *this, playback_manager.release_value()));
 
@@ -1009,13 +1024,13 @@ WebIDL::ExceptionOr<void> HTMLMediaElement::process_media_data(Function<void(Str
 
         auto event = TRY(TrackEvent::create(realm, HTML::EventNames::addtrack, event_init));
         m_video_tracks->dispatch_event(event);
-
-        // AD-HOC: After selecting a track, we do not need the source element selector anymore.
-        m_source_element_selector = nullptr;
     }
 
     // -> Once enough of the media data has been fetched to determine the duration of the media resource, its dimensions, and other metadata
-    if (video_track != nullptr) {
+    if (audio_track != nullptr || video_track != nullptr) {
+        // AD-HOC: After selecting a track, we do not need the source element selector anymore.
+        m_source_element_selector = nullptr;
+
         // FIXME: 1. Establish the media timeline for the purposes of the current playback position and the earliest possible position, based on the media data.
         // FIXME: 2. Update the timeline offset to the date and time that corresponds to the zero time in the media timeline established in the previous step,
         //           if any. If no explicit time and date is given by the media resource, the timeline offset must be set to Not-a-Number (NaN).
@@ -1027,12 +1042,12 @@ WebIDL::ExceptionOr<void> HTMLMediaElement::process_media_data(Function<void(Str
         // 4. Update the duration attribute with the time of the last frame of the resource, if known, on the media timeline established above. If it is
         //    not known (e.g. a stream that is in principle infinite), update the duration attribute to the value positive Infinity.
         // FIXME: Handle unbounded media resources.
-        auto duration = static_cast<double>(video_track->duration().to_milliseconds());
-        set_duration(duration / 1000.0);
+        auto duration = audio_track ? audio_track->duration() : video_track->duration();
+        set_duration(static_cast<double>(duration.to_milliseconds()) / 1000.0);
 
         // 5. For video elements, set the videoWidth and videoHeight attributes, and queue a media element task given the media element to fire an event
         //    named resize at the media element.
-        if (is<HTMLVideoElement>(*this)) {
+        if (video_track && is<HTMLVideoElement>(*this)) {
             auto& video_element = verify_cast<HTMLVideoElement>(*this);
             video_element.set_video_width(video_track->pixel_width());
             video_element.set_video_height(video_track->pixel_height());
@@ -1060,15 +1075,18 @@ WebIDL::ExceptionOr<void> HTMLMediaElement::process_media_data(Function<void(Str
         // FIXME: 10. Let the initial playback position be zero.
         // FIXME: 11. If either the media resource or the URL of the current media resource indicate a particular start time, then set the initial playback
         //            position to that time and, if jumped is still false, seek to that time.
-        // FIXME: 12. If there is no enabled audio track, then enable an audio track. This will cause a change event to be fired.
+
+        // 12. If there is no enabled audio track, then enable an audio track. This will cause a change event to be fired.
+        if (audio_track && !m_audio_tracks->has_enabled_track())
+            audio_track->set_enabled(true);
 
         // 13. If there is no selected video track, then select a video track. This will cause a change event to be fired.
-        if (m_video_tracks->selected_index() == -1)
+        if (video_track && m_video_tracks->selected_index() == -1)
             video_track->set_selected(true);
     }
 
     // -> Once the entire media resource has been fetched (but potentially before any of it has been decoded)
-    if (video_track != nullptr) {
+    if (audio_track != nullptr || video_track != nullptr) {
         // Fire an event named progress at the media element.
         dispatch_event(TRY(DOM::Event::create(this->realm(), HTML::EventNames::progress)));
 
diff --git a/Userland/Libraries/LibWeb/Layout/AudioBox.cpp b/Userland/Libraries/LibWeb/Layout/AudioBox.cpp
new file mode 100644
index 00000000000..3301345b7c4
--- /dev/null
+++ b/Userland/Libraries/LibWeb/Layout/AudioBox.cpp
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2023, Tim Flynn <trflynn89@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <LibWeb/HTML/HTMLAudioElement.h>
+#include <LibWeb/Layout/AudioBox.h>
+#include <LibWeb/Painting/AudioPaintable.h>
+
+namespace Web::Layout {
+
+AudioBox::AudioBox(DOM::Document& document, DOM::Element& element, NonnullRefPtr<CSS::StyleProperties> style)
+    : ReplacedBox(document, element, move(style))
+{
+    set_natural_width(300);
+    set_natural_height(40);
+}
+
+HTML::HTMLAudioElement& AudioBox::dom_node()
+{
+    return static_cast<HTML::HTMLAudioElement&>(ReplacedBox::dom_node());
+}
+
+HTML::HTMLAudioElement const& AudioBox::dom_node() const
+{
+    return static_cast<HTML::HTMLAudioElement const&>(ReplacedBox::dom_node());
+}
+
+JS::GCPtr<Painting::Paintable> AudioBox::create_paintable() const
+{
+    return Painting::AudioPaintable::create(*this);
+}
+
+}
diff --git a/Userland/Libraries/LibWeb/Layout/AudioBox.h b/Userland/Libraries/LibWeb/Layout/AudioBox.h
new file mode 100644
index 00000000000..f8f62678887
--- /dev/null
+++ b/Userland/Libraries/LibWeb/Layout/AudioBox.h
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2023, Tim Flynn <trflynn89@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <LibWeb/Forward.h>
+#include <LibWeb/HTML/BrowsingContext.h>
+#include <LibWeb/Layout/ReplacedBox.h>
+
+namespace Web::Layout {
+
+class AudioBox final : public ReplacedBox {
+    JS_CELL(AudioBox, ReplacedBox);
+
+public:
+    HTML::HTMLAudioElement& dom_node();
+    HTML::HTMLAudioElement const& dom_node() const;
+
+    virtual JS::GCPtr<Painting::Paintable> create_paintable() const override;
+
+private:
+    AudioBox(DOM::Document&, DOM::Element&, NonnullRefPtr<CSS::StyleProperties>);
+};
+
+}
diff --git a/Userland/Libraries/LibWeb/Painting/AudioPaintable.cpp b/Userland/Libraries/LibWeb/Painting/AudioPaintable.cpp
new file mode 100644
index 00000000000..82c9a7b897e
--- /dev/null
+++ b/Userland/Libraries/LibWeb/Painting/AudioPaintable.cpp
@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2023, Tim Flynn <trflynn89@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <AK/Array.h>
+#include <AK/NumberFormat.h>
+#include <LibGUI/Event.h>
+#include <LibGfx/AntiAliasingPainter.h>
+#include <LibWeb/DOM/Document.h>
+#include <LibWeb/HTML/AudioTrackList.h>
+#include <LibWeb/HTML/HTMLAudioElement.h>
+#include <LibWeb/HTML/HTMLMediaElement.h>
+#include <LibWeb/Layout/AudioBox.h>
+#include <LibWeb/Painting/AudioPaintable.h>
+#include <LibWeb/Painting/BorderRadiusCornerClipper.h>
+
+namespace Web::Painting {
+
+JS::NonnullGCPtr<AudioPaintable> AudioPaintable::create(Layout::AudioBox const& layout_box)
+{
+    return layout_box.heap().allocate_without_realm<AudioPaintable>(layout_box);
+}
+
+AudioPaintable::AudioPaintable(Layout::AudioBox const& layout_box)
+    : MediaPaintable(layout_box)
+{
+}
+
+Layout::AudioBox& AudioPaintable::layout_box()
+{
+    return static_cast<Layout::AudioBox&>(layout_node());
+}
+
+Layout::AudioBox const& AudioPaintable::layout_box() const
+{
+    return static_cast<Layout::AudioBox const&>(layout_node());
+}
+
+void AudioPaintable::paint(PaintContext& context, PaintPhase phase) const
+{
+    if (!is_visible())
+        return;
+
+    // FIXME: This should be done at a different level.
+    if (is_out_of_view(context))
+        return;
+
+    Base::paint(context, phase);
+
+    if (phase != PaintPhase::Foreground)
+        return;
+
+    auto audio_rect = context.rounded_device_rect(absolute_rect());
+    ScopedCornerRadiusClip corner_clip { context, context.painter(), audio_rect, normalized_border_radii_data(ShrinkRadiiForBorders::Yes) };
+
+    auto const& audio_element = layout_box().dom_node();
+    auto mouse_position = MediaPaintable::mouse_position(context, audio_element);
+
+    auto paint_user_agent_controls = audio_element.has_attribute(HTML::AttributeNames::controls) || audio_element.is_scripting_disabled();
+
+    if (paint_user_agent_controls)
+        paint_media_controls(context, audio_element, audio_rect, mouse_position);
+}
+
+}
diff --git a/Userland/Libraries/LibWeb/Painting/AudioPaintable.h b/Userland/Libraries/LibWeb/Painting/AudioPaintable.h
new file mode 100644
index 00000000000..5e95e26ce8d
--- /dev/null
+++ b/Userland/Libraries/LibWeb/Painting/AudioPaintable.h
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2023, Tim Flynn <trflynn89@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <LibWeb/Forward.h>
+#include <LibWeb/Painting/MediaPaintable.h>
+
+namespace Web::Painting {
+
+class AudioPaintable final : public MediaPaintable {
+    JS_CELL(AudioPaintable, MediaPaintable);
+
+public:
+    static JS::NonnullGCPtr<AudioPaintable> create(Layout::AudioBox const&);
+
+    virtual void paint(PaintContext&, PaintPhase) const override;
+
+    Layout::AudioBox& layout_box();
+    Layout::AudioBox const& layout_box() const;
+
+private:
+    explicit AudioPaintable(Layout::AudioBox const&);
+};
+
+}