aboutsummaryrefslogtreecommitdiff
path: root/src/core/hle/service/am/display_layer_manager.cpp
blob: cd9e26e8999b2b056d52304dc4ed9b1134beb794 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
// SPDX-FileCopyrightText: Copyright 2026 Eden Emulator Project
// SPDX-License-Identifier: GPL-3.0-or-later

// SPDX-FileCopyrightText: Copyright 2024 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later

#include "core/core.h"
#include "core/hle/service/am/display_layer_manager.h"
#include "core/hle/service/nvnflinger/hwc_layer.h"
#include "core/hle/service/sm/sm.h"
#include "core/hle/service/vi/application_display_service.h"
#include "core/hle/service/vi/container.h"
#include "core/hle/service/vi/manager_display_service.h"
#include "core/hle/service/vi/manager_root_service.h"
#include "core/hle/service/vi/shared_buffer_manager.h"
#include "core/hle/service/vi/vi_results.h"
#include "core/hle/service/vi/vi_types.h"

namespace Service::AM {

DisplayLayerManager::DisplayLayerManager() = default;
DisplayLayerManager::~DisplayLayerManager() {
    this->Finalize();
}

void DisplayLayerManager::Initialize(Core::System& system, Kernel::KProcess* process,
                                     AppletId applet_id, LibraryAppletMode mode) {
    R_ASSERT(system.ServiceManager()
                 .GetService<VI::IManagerRootService>("vi:m", true)
                 ->GetDisplayService(&m_display_service, VI::Policy::Compositor));
    R_ASSERT(m_display_service->GetManagerDisplayService(&m_manager_display_service));

    m_process = process;
    m_system_shared_buffer_id = 0;
    m_system_shared_layer_id = 0;
    m_applet_id = applet_id;
    m_library_applet_mode = mode;
    m_buffer_sharing_enabled = false;
    m_blending_enabled = mode == LibraryAppletMode::PartialForeground ||
                         mode == LibraryAppletMode::PartialForegroundIndirectDisplay;
}

void DisplayLayerManager::Finalize() {
    if (!m_manager_display_service) {
        return;
    }

    // Clean up managed layers.
    for (const auto& layer : m_managed_display_layers) {
        m_manager_display_service->DestroyManagedLayer(layer);
    }

    for (const auto& layer : m_managed_display_recording_layers) {
        m_manager_display_service->DestroyManagedLayer(layer);
    }

    // Clean up shared layers.
    if (m_buffer_sharing_enabled) {
        m_manager_display_service->DestroySharedLayerSession(m_process);
    }

    m_manager_display_service = nullptr;
    m_display_service = nullptr;
}

Result DisplayLayerManager::CreateManagedDisplayLayer(u64* out_layer_id) {
    R_UNLESS(m_manager_display_service != nullptr, VI::ResultOperationFailed);

    // TODO(Subv): Find out how AM determines the display to use, for now just
    // create the layer in the Default display.
    u64 display_id;
    R_TRY(m_display_service->OpenDisplay(&display_id, VI::DisplayName{"Default"}));
    R_TRY(m_manager_display_service->CreateManagedLayer(
        out_layer_id, 0, display_id, Service::AppletResourceUserId{m_process->GetProcessId()}));

    m_manager_display_service->SetLayerVisibility(m_visible, *out_layer_id);
    (void)m_display_service->GetContainer()->SetLayerStackMask(*out_layer_id,
                                                              this->GetLayerStackMask());

    if (m_applet_id != AppletId::Application) {
        (void)m_manager_display_service->SetLayerBlending(m_blending_enabled, *out_layer_id);
        if (m_applet_id == AppletId::OverlayDisplay) {
            (void)m_manager_display_service->SetLayerZIndex(Overlay, *out_layer_id);
        } else {
            (void)m_manager_display_service->SetLayerZIndex(Foreground, *out_layer_id);
        }
    }

    m_display_service->GetContainer()->SetLayerZIndex(*out_layer_id, true);
    m_managed_display_layers.emplace(*out_layer_id);

    R_SUCCEED();
}

Result DisplayLayerManager::CreateManagedDisplaySeparableLayer(u64* out_layer_id,
                                                               u64* out_recording_layer_id) {
    R_UNLESS(m_manager_display_service != nullptr, VI::ResultOperationFailed);

    // TODO(Subv): Find out how AM determines the display to use, for now just
    // create the layer in the Default display.
    // This calls nn::vi::CreateRecordingLayer() which creates another layer.
    // Currently we do not support more than 1 layer per display, output 1 layer id for now.
    // Outputting 1 layer id instead of the expected 2 has not been observed to cause any adverse
    // side effects.
    *out_recording_layer_id = 0;
    R_RETURN(this->CreateManagedDisplayLayer(out_layer_id));
}

Result DisplayLayerManager::IsSystemBufferSharingEnabled() {
    // Succeed if already enabled.
    R_SUCCEED_IF(m_buffer_sharing_enabled);

    // Ensure we can access shared layers.
    R_UNLESS(m_manager_display_service != nullptr, VI::ResultOperationFailed);
    R_UNLESS(m_applet_id != AppletId::Application, VI::ResultPermissionDenied);

    // Create the shared layer.
    u64 display_id;
    R_TRY(m_display_service->OpenDisplay(&display_id, VI::DisplayName{"Default"}));
    R_TRY(m_manager_display_service->CreateSharedLayerSession(m_process, &m_system_shared_buffer_id,
                                                              &m_system_shared_layer_id, display_id,
                                                              m_blending_enabled));

    // We succeeded, so set up remaining state.
    m_buffer_sharing_enabled = true;

    // Ensure the overlay layer is visible
    m_manager_display_service->SetLayerVisibility(m_visible, m_system_shared_layer_id);
    (void)m_manager_display_service->SetLayerBlending(m_blending_enabled, m_system_shared_layer_id);
    s32 initial_z = Foreground;
    if (m_applet_id == AppletId::OverlayDisplay) {
        initial_z = Overlay;
        (void)m_manager_display_service->SetLayerZIndex(initial_z, m_system_shared_layer_id);
        (void)m_display_service->GetContainer()->SetLayerIsOverlay(m_system_shared_layer_id, true);
    }
    m_manager_display_service->SetLayerZIndex(initial_z, m_system_shared_layer_id);
    m_display_service->GetContainer()->SetLayerZIndex(m_system_shared_layer_id, true);
    m_managed_display_layers.emplace(m_system_shared_layer_id);
    R_SUCCEED();
}

Result DisplayLayerManager::GetSystemSharedLayerHandle(u64* out_system_shared_buffer_id,
                                                       u64* out_system_shared_layer_id) {
    R_TRY(this->IsSystemBufferSharingEnabled());

    *out_system_shared_buffer_id = m_system_shared_buffer_id;
    *out_system_shared_layer_id = m_system_shared_layer_id;

    R_SUCCEED();
}

u32 DisplayLayerManager::GetLayerStackMask() const {
    using Nvnflinger::LayerStackBit;
    using Nvnflinger::LayerStackId;

    constexpr u32 Displayed = LayerStackBit(LayerStackId::Default);
    constexpr u32 Screenshot = LayerStackBit(LayerStackId::Screenshot);
    constexpr u32 Recording = LayerStackBit(LayerStackId::Recording);
    constexpr u32 LastFrame = LayerStackBit(LayerStackId::LastFrame);
    constexpr u32 Debug = LayerStackBit(LayerStackId::ApplicationForDebug);

    switch (m_applet_id) {
        case AppletId::Application:
            return Displayed | Screenshot | Recording | LastFrame | Debug;
        case AppletId::OverlayDisplay:
            return Displayed;
        case AppletId::QLaunch:
            return Displayed;
        default:
            break;
    }

    switch (m_library_applet_mode) {
    case LibraryAppletMode::AllForeground:
    case LibraryAppletMode::AllForegroundInitiallyHidden:
        return Displayed | Screenshot | LastFrame;
    default:
        return Displayed | Screenshot;
    }
}

void DisplayLayerManager::SetWindowVisibility(bool visible) {
    if (m_visible == visible) {
        return;
    }

    m_visible = visible;

    if (m_manager_display_service) {
        if (m_system_shared_layer_id) {
            LOG_INFO(Service_VI, "shared_layer={} visible={} applet_id={}",
                     m_system_shared_layer_id, m_visible, static_cast<u32>(m_applet_id));
            m_manager_display_service->SetLayerVisibility(m_visible, m_system_shared_layer_id);
        }

        for (const auto layer_id : m_managed_display_layers) {
            LOG_INFO(Service_VI, "managed_layer={} visible={} applet_id={}",
                     layer_id, m_visible, static_cast<u32>(m_applet_id));
            m_manager_display_service->SetLayerVisibility(m_visible, layer_id);
        }
    }
}

bool DisplayLayerManager::GetWindowVisibility() const {
    return m_visible;
}

void DisplayLayerManager::SetOverlayZIndex(s32 z_index) {
    if (!m_manager_display_service) {
        return;
    }

    if (m_system_shared_layer_id) {
        m_manager_display_service->SetLayerZIndex(z_index, m_system_shared_layer_id);
        LOG_INFO(Service_VI, "called, shared_layer={} z={}", m_system_shared_layer_id, z_index);
    }

    for (const auto layer_id : m_managed_display_layers) {
        m_manager_display_service->SetLayerZIndex(z_index, layer_id);
        LOG_INFO(Service_VI, "called, managed_layer={} z={}", layer_id, z_index);
    }
}

Result DisplayLayerManager::WriteAppletCaptureBuffer(bool* out_was_written,
                                                     s32* out_fbshare_layer_index,
                                                     VI::CaptureKind kind) {
    R_UNLESS(m_buffer_sharing_enabled, VI::ResultPermissionDenied);
    R_RETURN(m_display_service->GetContainer()->GetSharedBufferManager()->WriteAppletCaptureBuffer(
        out_was_written, out_fbshare_layer_index, kind));
}

Result DisplayLayerManager::ClearAppletCaptureBuffer(s32 fbshare_layer_index, u32 color) {
    R_UNLESS(m_buffer_sharing_enabled, VI::ResultPermissionDenied);
    R_RETURN(m_display_service->GetContainer()->GetSharedBufferManager()->ClearAppletCaptureBuffer(
        fbshare_layer_index, color));
}

} // namespace Service::AM