unitframesound.pas

unit UnitFrameSound;
// Copyright 2022-2025 Zoran Vučenović
// SPDX-License-Identifier: Apache-2.0

{$mode ObjFPC}{$H+}
{$i zxinc.inc}

interface

uses
  Classes, SysUtils, UnitInputLibraryPathDialog, UnitSpectrum, UnitOptions,
  UnitFrameSoundVolume, CommonFunctionsLCL, UnitCommon, SoundChipAY_3_8912,
  Forms, Controls, ExtCtrls, StdCtrls;

type
  TFrameSound = class(TFrame, ICheckStateValid)
    Bevel1: TBevel;
    Bevel2: TBevel;
    CheckBox1: TCheckBox;
    ComboBox1: TComboBox;
    Label1: TLabel;
    LabelVolume: TLabel;
    Panel1: TPanel;
    Panel2: TPanel;
    Panel4: TPanel;
    PanelVolume: TPanel;
    PanelSoundLibrary: TPanel;
  private
    FrameSoundLib: TFrameInputLibraryPath;
    FSpectrum: TSpectrum;
    FrameSoundVolume: TFrameSoundVolume;
    FSaveLibOnClose: Boolean;

    procedure FormOnShow(Sender: TObject);
    procedure AfterShow(Data: PtrInt);
    function GetSoundMuted: Boolean;
    function GetAYOutputMode: TSoundAY_3_8912.TOutputMode;
    function GetVolLevel: Integer;
    procedure SetFrameSoundLib(AFrameSoundLib: TFrameInputLibraryPath);
    procedure SetSoundMuted(const AValue: Boolean);

    procedure FormOnCloseQuery(Sender: TObject; var CanClose: Boolean);
    procedure FormCloseCallback(Sender: TObject; var {%H-}CloseAction: TCloseAction);
    procedure SetAYOutputMode(AValue: TSoundAY_3_8912.TOutputMode);
    procedure SetVolLevel(AValue: Integer);
  public
    constructor Create(TheOwner: TComponent); override;

    class function CreateForAllOptions(AOptionsDialog: TFormOptions;
      ASpectrum: TSpectrum; AFrameSoundLib: TFrameInputLibraryPath): TFrameSound;

    function IsStateValid: Boolean;
    property VolLevel: Integer read GetVolLevel write SetVolLevel;
    property AYOutputMode: TSoundAY_3_8912.TOutputMode read GetAYOutputMode write SetAYOutputMode;
  end;

implementation

{$R *.lfm}

{ TFrameSound }

procedure TFrameSound.FormOnShow(Sender: TObject);
begin
  AfterShow(2);
end;

procedure TFrameSound.AfterShow(Data: PtrInt);
begin
  if Data > 0 then
    Application.QueueAsyncCall(@AfterShow, Data - 1)
  else begin
    DisableAlign;
    try
      FrameSoundLib.AnchorParallel(akRight, 0, PanelSoundLibrary);
      FrameSoundLib.AutoSize := True;
      PanelSoundLibrary.AnchorParallel(akRight, 0, Panel1);
      Panel1.AnchorParallel(akRight, 0, Self);
    finally
      EnableAlign;
    end;
  end;
end;

function TFrameSound.GetSoundMuted: Boolean;
begin
  Result := CheckBox1.Checked;
end;

function TFrameSound.GetAYOutputMode: TSoundAY_3_8912.TOutputMode;
begin
  Result := TSoundAY_3_8912.TOutputMode(ComboBox1.ItemIndex);
end;

function TFrameSound.GetVolLevel: Integer;
begin
  Result := FrameSoundVolume.Level;
end;

procedure TFrameSound.SetSoundMuted(const AValue: Boolean);
begin
  CheckBox1.Checked := AValue;
end;

procedure TFrameSound.FormOnCloseQuery(Sender: TObject; var CanClose: Boolean);
var
  F: TFormOptions;
begin
  if Assigned(FrameSoundLib) then begin
    F := nil;
    if Sender is TFormOptions then
      F := TFormOptions(Sender);
    if (F = nil) or (F.CurrentControl = Self) then begin
      FrameSoundLib.FormOnCloseQuery(Sender, CanClose);
      FSaveLibOnClose := FSaveLibOnClose or CanClose;
    end;
  end;
end;

procedure TFrameSound.FormCloseCallback(Sender: TObject;
  var CloseAction: TCloseAction);
begin
  if (Sender is TCustomForm) and (TCustomForm(Sender).ModalResult = mrOK) then begin
    FSpectrum.SoundMuted := GetSoundMuted;
    FSpectrum.AYOutputMode := GetAYOutputMode;
    if Assigned(FrameSoundLib) then
      if FSaveLibOnClose then
        FrameSoundLib.FormOnClose(Sender, CloseAction);
  end;
end;

procedure TFrameSound.SetAYOutputMode(AValue: TSoundAY_3_8912.TOutputMode);
begin
  ComboBox1.ItemIndex := Integer(AValue);
end;

procedure TFrameSound.SetVolLevel(AValue: Integer);
begin
  FrameSoundVolume.Level := AValue;
end;

constructor TFrameSound.Create(TheOwner: TComponent);
begin
  inherited Create(TheOwner);

  Name := TCommonFunctions.GlobalObjectNameGenerator(Self);
  Caption := 'Sound options';

  FSaveLibOnClose := True;
  PanelSoundLibrary.BevelOuter := bvNone;
  PanelSoundLibrary.Caption := '';
  Panel1.BevelOuter := bvNone;
  Panel1.Caption := '';
  Panel2.Caption := '';
  Panel4.BevelOuter := bvNone;
  Panel4.Caption := '';
  PanelVolume.BevelOuter := bvNone;
  PanelVolume.Caption := '';

  PanelSoundLibrary.AutoSize := True;

  FrameSoundVolume := TFrameSoundVolume.Create(PanelVolume);
  FrameSoundVolume.VerticalOrientation := False;
  FrameSoundVolume.Anchors := [];
  FrameSoundVolume.AnchorParallel(akTop, 0, PanelVolume);
  FrameSoundVolume.AnchorToNeighbour(akLeft, 5, LabelVolume);
  FrameSoundVolume.Parent := PanelVolume;

  PanelVolume.OnMouseWheel := FrameSoundVolume.TrackBar1.OnMouseWheel;
  Panel2.OnMouseWheel := FrameSoundVolume.TrackBar1.OnMouseWheel;

  PanelVolume.AutoSize := True;
  Panel1.AutoSize := True;
  Panel4.AutoSize := True;
  Self.AutoSize := True;
end;

procedure TFrameSound.SetFrameSoundLib(AFrameSoundLib: TFrameInputLibraryPath);
begin
  FrameSoundLib := AFrameSoundLib;
  FrameSoundLib.Anchors := [];
  FrameSoundLib.AnchorParallel(akLeft, 0, PanelSoundLibrary);
  FrameSoundLib.AnchorParallel(akTop, 0, PanelSoundLibrary);
  FrameSoundLib.Parent := PanelSoundLibrary;
end;

class function TFrameSound.CreateForAllOptions(AOptionsDialog: TFormOptions;
  ASpectrum: TSpectrum; AFrameSoundLib: TFrameInputLibraryPath): TFrameSound;
var
  Fm: TFrameSound;
begin
  Result := nil;
  if Assigned(AOptionsDialog)
    and Assigned(ASpectrum)
    and Assigned(AFrameSoundLib)
  then begin
    Fm := TFrameSound.Create(AOptionsDialog);
    try
      Fm.SetFrameSoundLib(AFrameSoundLib);
      Fm.FSpectrum := ASpectrum;
      Fm.SetSoundMuted(ASpectrum.SoundMuted);
      Fm.FSaveLibOnClose := False;

      AOptionsDialog.AddHandlerFirstShow(@AFrameSoundLib.OnFormFirstShow);

      AOptionsDialog.AddHandlerFirstShow(@Fm.FormOnShow);
      AOptionsDialog.AddCloseQuery(@Fm.FormOnCloseQuery);
      AOptionsDialog.AddHandlerClose(@Fm.FormCloseCallback);

      AOptionsDialog.AddAnOptionControl(Fm, 'Sound');

      Result := Fm;
    except
      FreeAndNil(Fm);
    end;
  end;
end;

function TFrameSound.IsStateValid: Boolean;
begin
  Result := (FrameSoundLib = nil) or FrameSoundLib.IsStateValid;
  FSaveLibOnClose := True;
end;

end.