yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
yaze::editor::MusicAudioDebugPanel Class Reference

EditorPanel providing audio diagnostics for debugging the music editor. More...

#include <music_audio_debug_panel.h>

Inheritance diagram for yaze::editor::MusicAudioDebugPanel:
Collaboration diagram for yaze::editor::MusicAudioDebugPanel:

Public Member Functions

 MusicAudioDebugPanel (editor::music::MusicPlayer *player)
 
std::string GetId () const override
 Unique identifier for this panel.
 
std::string GetDisplayName () const override
 Human-readable name shown in menus and title bars.
 
std::string GetIcon () const override
 Material Design icon for this panel.
 
std::string GetEditorCategory () const override
 Editor category this panel belongs to.
 
int GetPriority () const override
 Get display priority for menu ordering.
 
void Draw (bool *p_open) override
 Draw the panel content.
 
- Public Member Functions inherited from yaze::editor::EditorPanel
virtual ~EditorPanel ()=default
 
virtual void OnOpen ()
 Called when panel becomes visible.
 
virtual void OnClose ()
 Called when panel is hidden.
 
virtual void OnFocus ()
 Called when panel receives focus.
 
virtual PanelCategory GetPanelCategory () const
 Get the lifecycle category for this panel.
 
virtual bool IsEnabled () const
 Check if this panel is currently enabled.
 
virtual std::string GetDisabledTooltip () const
 Get tooltip text when panel is disabled.
 
virtual std::string GetShortcutHint () const
 Get keyboard shortcut hint for display.
 
virtual float GetPreferredWidth () const
 Get preferred width for this panel (optional)
 
virtual bool IsVisibleByDefault () const
 Whether this panel should be visible by default.
 
virtual std::string GetParentPanelId () const
 Get parent panel ID for cascade behavior.
 
virtual bool CascadeCloseChildren () const
 Whether closing this panel should close child panels.
 

Private Member Functions

void DrawBackendInfo (emu::audio::IAudioBackend *backend)
 
void DrawQueueStatus (emu::audio::IAudioBackend *backend)
 
void DrawResamplingStatus (emu::audio::IAudioBackend *backend)
 
void DrawDspStatus ()
 
void DrawApuStatus ()
 
void DrawDebugActions ()
 

Private Attributes

editor::music::MusicPlayerplayer_ = nullptr
 

Detailed Description

EditorPanel providing audio diagnostics for debugging the music editor.

This panel displays detailed information about the audio pipeline including:

  • Backend configuration (sample rate, channels, buffer size)
  • Resampling state (32040Hz -> 48000Hz conversion)
  • Queue status (frames queued, underrun detection)
  • DSP and APU diagnostic information

Definition at line 25 of file music_audio_debug_panel.h.

Constructor & Destructor Documentation

◆ MusicAudioDebugPanel()

yaze::editor::MusicAudioDebugPanel::MusicAudioDebugPanel ( editor::music::MusicPlayer * player)
inlineexplicit

Definition at line 27 of file music_audio_debug_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::MusicAudioDebugPanel::GetId ( ) const
inlineoverridevirtual

Unique identifier for this panel.

Returns
Panel ID in format "{category}.{name}" (e.g., "dungeon.room_selector")

IDs should be:

  • Lowercase with underscores
  • Prefixed with editor category
  • Unique across all panels

Implements yaze::editor::EditorPanel.

Definition at line 34 of file music_audio_debug_panel.h.

◆ GetDisplayName()

std::string yaze::editor::MusicAudioDebugPanel::GetDisplayName ( ) const
inlineoverridevirtual

Human-readable name shown in menus and title bars.

Returns
Display name (e.g., "Room Selector")

Implements yaze::editor::EditorPanel.

Definition at line 35 of file music_audio_debug_panel.h.

◆ GetIcon()

std::string yaze::editor::MusicAudioDebugPanel::GetIcon ( ) const
inlineoverridevirtual

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 36 of file music_audio_debug_panel.h.

References ICON_MD_BUG_REPORT.

◆ GetEditorCategory()

std::string yaze::editor::MusicAudioDebugPanel::GetEditorCategory ( ) const
inlineoverridevirtual

Editor category this panel belongs to.

Returns
Category name matching EditorType (e.g., "Dungeon", "Overworld")

Implements yaze::editor::EditorPanel.

Definition at line 37 of file music_audio_debug_panel.h.

◆ GetPriority()

int yaze::editor::MusicAudioDebugPanel::GetPriority ( ) const
inlineoverridevirtual

Get display priority for menu ordering.

Returns
Priority value (lower = higher in list, default 50)

Reimplemented from yaze::editor::EditorPanel.

Definition at line 38 of file music_audio_debug_panel.h.

◆ Draw()

void yaze::editor::MusicAudioDebugPanel::Draw ( bool * p_open)
inlineoverridevirtual

Draw the panel content.

Parameters
p_openPointer to visibility flag (nullptr if not closable)

Called by PanelManager when the panel is visible. Do NOT call ImGui::Begin/End - the PanelWindow wrapper handles that. Just draw your content directly.

Implements yaze::editor::EditorPanel.

Definition at line 44 of file music_audio_debug_panel.h.

References yaze::emu::Emulator::audio_backend(), DrawApuStatus(), DrawBackendInfo(), DrawDebugActions(), DrawDspStatus(), DrawQueueStatus(), DrawResamplingStatus(), yaze::editor::music::MusicPlayer::emulator(), ICON_MD_ERROR, ICON_MD_INFO, yaze::emu::Emulator::is_snes_initialized(), and player_.

◆ DrawBackendInfo()

void yaze::editor::MusicAudioDebugPanel::DrawBackendInfo ( emu::audio::IAudioBackend * backend)
inlineprivate

Definition at line 80 of file music_audio_debug_panel.h.

References yaze::emu::audio::IAudioBackend::GetBackendName(), yaze::emu::audio::IAudioBackend::GetConfig(), and ICON_MD_SPEAKER.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawQueueStatus()

void yaze::editor::MusicAudioDebugPanel::DrawQueueStatus ( emu::audio::IAudioBackend * backend)
inlineprivate

Definition at line 93 of file music_audio_debug_panel.h.

References yaze::emu::audio::IAudioBackend::GetStatus(), ICON_MD_QUEUE_MUSIC, and ICON_MD_WARNING.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawResamplingStatus()

void yaze::editor::MusicAudioDebugPanel::DrawResamplingStatus ( emu::audio::IAudioBackend * backend)
inlineprivate

◆ DrawDspStatus()

void yaze::editor::MusicAudioDebugPanel::DrawDspStatus ( )
inlineprivate

Definition at line 149 of file music_audio_debug_panel.h.

References yaze::editor::music::MusicPlayer::GetDspStatus(), ICON_MD_MEMORY, and player_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawApuStatus()

void yaze::editor::MusicAudioDebugPanel::DrawApuStatus ( )
inlineprivate

Definition at line 173 of file music_audio_debug_panel.h.

References yaze::editor::music::MusicPlayer::GetApuStatus(), ICON_MD_TIMER, and player_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawDebugActions()

void yaze::editor::MusicAudioDebugPanel::DrawDebugActions ( )
inlineprivate

Member Data Documentation

◆ player_

editor::music::MusicPlayer* yaze::editor::MusicAudioDebugPanel::player_ = nullptr
private

The documentation for this class was generated from the following file: