How zivkovicmilos/pianoplayer works
Project type and purpose
• Type: Stand-alone desktop application (Java Swing)
• Purpose: Load, display, play, record, and export piano compositions (VirtualPiano text or MIDI) using Java Sound API.
File structure
• src/pianosystem: all Java classes, grouped roughly by responsibility
• data/: static input files (map.csv, VirtualPiano .txt compositions)
• resources/imgs: GUI assets (play/pause/stop buttons, PSDs, logos)
• out/, artifacts/: compiled JAR and build outputs
Key insights from README
• MVC-style separation: Reader → Composition (Model) → View (NoteView, Piano) → Controller (Player/Recorder)
• Two input sources: CSV mapping for key→note, VirtualPiano text for compositions
• Two output targets: text export (VirtualPiano format) and MIDI export
• Playback uses Java Sound API
Main components
A. User Interface Layer (Blue)
– Main Window (Main.java)
– ControlBoard (play, pause, stop, record buttons)
– Piano View (Piano.java, WhiteKey/BlackKey)
– Dialogs (About.java, SaveDialog.java)
B. Controller Layer (Yellow)
– Main controller (Main.java orchestrates startup)
– Reader (Reader.java: parses map.csv and VirtualPiano text via regex)
– Player (Player.java: drives playback events)
– NotePlayer (NotePlayer.java: interacts with Java Sound API)
– Recorder (Recorder.java: captures live input events)
C. Model Layer (Green)
– Composition (Composition.java: ordered MusicSymbol list)
– MusicSymbol (MusicSymbol.java: wrapper for Note or Pause)
– Note (Note.java: pitch + octave)
– Duration (Duration.java: timing info)
D. Data & External Services (Red)
– Local files (data/map.csv, data/input/*.txt)
– Java Sound API (javax.sound.midi or javax.sound.sampled)
– File export modules (MIDI export, VirtualPiano TXT via SaveDialog)
Relationships and data flow
• On launch, Main initializes Reader → loads map.csv + composition file → builds Composition model
• UI renders Composition via NoteView and Piano
• User actions on ControlBoard trigger Player or Recorder
• Player drives NotePlayer to send MIDI events to Java Sound API → audio output
• Recorder captures keyboard/mouse events → stores MusicSymbols in Composition
• SaveDialog exports Composition to TXT or MIDI
Architectural patterns & design principles
• MVC (Model: Composition/MusicSymbol; View: NoteView/Piano/ControlBoard; Controller: Player/Recorder/Reader)
• Single-Module Java application: separation of concerns by package pianosystem
• Resource abstraction: externalize images and data under /resources and /data
Technologies & frameworks
• Java SE (Swing GUI, Streams, Regex)
• Java Sound API for playback/export
• Standard file I/O for reading .csv/.txt and writing .txt/.mid
• Build artifacts: single executable JAR (PianoPlayer.jar)