app.go 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465
  1. // Package app is the Wails service the frontend calls. It owns the current
  2. // project and returns a fresh State after every call; the frontend keeps no
  3. // project data of its own (build plan 4.6 and 5).
  4. package app
  5. import (
  6. "crypto/sha256"
  7. "encoding/hex"
  8. "errors"
  9. "fmt"
  10. "path/filepath"
  11. "strings"
  12. "sync"
  13. "git.monoexp.com/bajdev/mpckit/internal/export"
  14. "git.monoexp.com/bajdev/mpckit/internal/project"
  15. )
  16. // Version and Commit are set by production builds (Taskfile.yml) with
  17. // -ldflags "-X git.monoexp.com/bajdev/mpckit/internal/app.Version=0.5.2
  18. // -X git.monoexp.com/bajdev/mpckit/internal/app.Commit=2354f57".
  19. var (
  20. Version = "dev"
  21. Commit = ""
  22. )
  23. // DefaultName is the name of a new project.
  24. const DefaultName = "NewKit"
  25. // Pad is one pad as the frontend shows it.
  26. type Pad struct {
  27. Slot int `json:"slot"`
  28. Label string `json:"label"` // "A01" .. "H16"
  29. Name string `json:"name"` // sample name; empty for an empty pad
  30. File string `json:"file"` // pool file name
  31. Coarse int `json:"coarse"`
  32. Fine int `json:"fine"`
  33. MuteGroup int `json:"muteGroup"`
  34. HasNotes bool `json:"hasNotes"`
  35. // Audio is the URL the preview loads the sample from; empty for an
  36. // empty pad. It changes when the pad's source file changes.
  37. Audio string `json:"audio"`
  38. // Start and End are the slice's first and last frame. The preview
  39. // plays only this region, as the device does.
  40. Start int64 `json:"start"`
  41. End int64 `json:"end"`
  42. // Source is where the sample is copied from at export; Missing is set
  43. // when that file no longer exists.
  44. Source string `json:"source"`
  45. Missing bool `json:"missing"`
  46. }
  47. // Sequence is one existing sequence.
  48. type Sequence struct {
  49. Slot int `json:"slot"`
  50. Label string `json:"label"` // slot label, "A01" .. "H16"
  51. Name string `json:"name"`
  52. BPM float64 `json:"bpm"`
  53. Bars int `json:"bars"`
  54. HasNotes bool `json:"hasNotes"`
  55. }
  56. // Limits are the ranges the UI offers, from the device checks.
  57. type Limits struct {
  58. Pads int `json:"pads"`
  59. MaxSamples int `json:"maxSamples"`
  60. MaxSequences int `json:"maxSequences"`
  61. MinCoarse int `json:"minCoarse"`
  62. MaxCoarse int `json:"maxCoarse"`
  63. MinFine int `json:"minFine"`
  64. MaxFine int `json:"maxFine"`
  65. MaxMuteGroup int `json:"maxMuteGroup"`
  66. MinBPM float64 `json:"minBPM"`
  67. MaxBPM float64 `json:"maxBPM"`
  68. MaxBars int `json:"maxBars"`
  69. }
  70. // State is everything the frontend shows about the project.
  71. type State struct {
  72. Name string `json:"name"`
  73. Dirty bool `json:"dirty"`
  74. Pads []Pad `json:"pads"` // all 128, in slot order
  75. Sequences []Sequence `json:"sequences"` // existing ones, in slot order
  76. SampleCount int `json:"sampleCount"`
  77. MissingCount int `json:"missingCount"` // pool files whose source is missing
  78. SequenceCount int `json:"sequenceCount"`
  79. Limits Limits `json:"limits"`
  80. }
  81. // About is the text for the About dialog.
  82. type About struct {
  83. Version string `json:"version"`
  84. Commit string `json:"commit"` // empty in dev builds
  85. License string `json:"license"`
  86. Repo string `json:"repo"`
  87. }
  88. // LoadResult is what Load returns. Path is empty if the dialog was
  89. // cancelled. Warnings describe differences from the tested firmware.
  90. type LoadResult struct {
  91. Path string `json:"path"`
  92. State State `json:"state"`
  93. Warnings []string `json:"warnings"`
  94. }
  95. // ExportResult is what an export call returns. If Exists is not empty,
  96. // nothing was written: the frontend asks the user, then calls again with
  97. // overwrite set.
  98. type ExportResult struct {
  99. Path string `json:"path"`
  100. Exists []string `json:"exists"`
  101. }
  102. // Dialogs are the native file dialogs. Each returns "" when the user
  103. // cancels. main.go implements them with Wails; tests use a fake.
  104. type Dialogs interface {
  105. OpenWAV() (string, error)
  106. OpenProject() (string, error)
  107. ChooseFolder() (string, error)
  108. SaveZip(defaultName string) (string, error)
  109. }
  110. // Service is registered with Wails; its exported methods become the
  111. // frontend bindings.
  112. type Service struct {
  113. mu sync.Mutex
  114. p *project.Project
  115. dialogs Dialogs
  116. closer func() // closes the window without asking; set by main.go
  117. // Where the next export goes, as chosen in the dialog. The frontend
  118. // never passes a path itself, so a script in the window cannot make
  119. // MPCkit write (or, with overwrite, delete) anywhere else.
  120. exportDir, zipPath string
  121. }
  122. // SetCloser sets what CloseWindow calls.
  123. //
  124. //wails:ignore
  125. func (s *Service) SetCloser(f func()) { s.closer = f }
  126. // Dirty reports whether the project has changes not yet exported.
  127. //
  128. //wails:ignore
  129. func (s *Service) Dirty() bool {
  130. s.mu.Lock()
  131. defer s.mu.Unlock()
  132. return s.p.Dirty
  133. }
  134. // CloseWindow closes the app without asking about unsaved changes. The
  135. // frontend calls it after the user chose to discard them.
  136. func (s *Service) CloseWindow() {
  137. if s.closer != nil {
  138. s.closer()
  139. }
  140. }
  141. // NewService returns a service holding a new, empty project.
  142. func NewService(d Dialogs) *Service {
  143. s := &Service{dialogs: d}
  144. s.reset()
  145. return s
  146. }
  147. func (s *Service) reset() {
  148. p, err := project.New(DefaultName)
  149. if err != nil {
  150. panic(err) // the embedded template and a constant name
  151. }
  152. s.use(p)
  153. }
  154. // use makes p the current project and forgets the export targets chosen
  155. // for the previous one. Callers hold s.mu.
  156. func (s *Service) use(p *project.Project) {
  157. s.p = p
  158. s.exportDir, s.zipPath = "", ""
  159. }
  160. // New replaces the current project with a new, empty one.
  161. func (s *Service) New() State {
  162. s.mu.Lock()
  163. defer s.mu.Unlock()
  164. s.reset()
  165. return s.state()
  166. }
  167. // State returns the current project's state.
  168. func (s *Service) State() State {
  169. s.mu.Lock()
  170. defer s.mu.Unlock()
  171. return s.state()
  172. }
  173. // Version returns the app version.
  174. func (s *Service) Version() string { return Version }
  175. // About returns the About dialog text.
  176. func (s *Service) About() About {
  177. return About{
  178. Version: Version,
  179. Commit: Commit,
  180. License: "MIT License, copyright (c) 2026 bajdev",
  181. Repo: "https://git.monoexp.com/bajdev/mpckit",
  182. }
  183. }
  184. // Label returns the label the UI and the device use for a pad or sequence
  185. // slot: bank letter and two-digit pad number, e.g. 0 -> "A01", 17 -> "B02".
  186. func Label(slot int) string {
  187. return fmt.Sprintf("%c%02d", 'A'+slot/16, slot%16+1)
  188. }
  189. func (s *Service) state() State {
  190. p := s.p
  191. st := State{
  192. Name: p.Name,
  193. Dirty: p.Dirty,
  194. Pads: make([]Pad, 0, project.Pads),
  195. Sequences: []Sequence{},
  196. SampleCount: p.SampleCount(),
  197. Limits: Limits{
  198. Pads: project.Pads,
  199. MaxSamples: project.MaxSamples,
  200. MaxSequences: project.MaxSequences,
  201. MinCoarse: project.MinCoarse,
  202. MaxCoarse: project.MaxCoarse,
  203. MinFine: project.MinFine,
  204. MaxFine: project.MaxFine,
  205. MaxMuteGroup: project.MaxMuteGroup,
  206. MinBPM: project.MinBPM,
  207. MaxBPM: project.MaxBPM,
  208. MaxBars: project.MaxBars,
  209. },
  210. }
  211. missing := map[string]bool{} // pool file -> source missing, as export sees it
  212. for _, f := range p.PoolFiles() {
  213. src := p.Sources[f]
  214. missing[f] = src == "" || !export.Usable(src)
  215. }
  216. for slot := 0; slot < project.Pads; slot++ {
  217. v, err := p.Pad(slot)
  218. if err != nil {
  219. // A loaded file with an odd pad; show it as empty.
  220. st.Pads = append(st.Pads, Pad{Slot: slot, Label: Label(slot)})
  221. continue
  222. }
  223. pad := Pad{Slot: slot, Label: Label(slot), Name: v.SampleName, File: v.File,
  224. Coarse: v.Coarse, Fine: v.Fine, MuteGroup: v.MuteGroup, Start: v.Start, End: v.End}
  225. if !v.Empty() {
  226. pad.HasNotes = p.PadHasNotes(slot)
  227. pad.Source = p.Sources[v.File]
  228. pad.Missing = missing[v.File]
  229. if !pad.Missing {
  230. pad.Audio = audioURL(slot, pad.Source)
  231. }
  232. }
  233. st.Pads = append(st.Pads, pad)
  234. }
  235. for _, q := range p.Sequences() {
  236. st.Sequences = append(st.Sequences, Sequence{Slot: q.Slot, Label: Label(q.Slot),
  237. Name: q.Name, BPM: q.BPM, Bars: q.Bars, HasNotes: q.HasNotes})
  238. }
  239. st.SequenceCount = len(st.Sequences)
  240. for _, m := range missing {
  241. if m {
  242. st.MissingCount++
  243. }
  244. }
  245. return st
  246. }
  247. // audioURL is the preview URL for a pad. The key in the query changes with
  248. // the source file, so the frontend's cache never plays a stale sample.
  249. func audioURL(slot int, src string) string {
  250. sum := sha256.Sum256([]byte(src))
  251. return fmt.Sprintf("%s%d?k=%s", AudioPrefix, slot, hex.EncodeToString(sum[:6]))
  252. }
  253. // edit runs fn on the project under the lock and returns the new state.
  254. // The state is returned even on error, so the frontend stays in step.
  255. func (s *Service) edit(fn func(p *project.Project) error) (State, error) {
  256. s.mu.Lock()
  257. defer s.mu.Unlock()
  258. err := fn(s.p)
  259. return s.state(), err
  260. }
  261. // SetName renames the project.
  262. func (s *Service) SetName(name string) (State, error) {
  263. return s.edit(func(p *project.Project) error { return p.SetName(strings.TrimSpace(name)) })
  264. }
  265. // AssignSampleDialog asks for a WAV file and puts it on the pad in slot.
  266. // Cancelling the dialog changes nothing.
  267. func (s *Service) AssignSampleDialog(slot int) (State, error) {
  268. path, err := s.dialogs.OpenWAV()
  269. if err != nil || path == "" {
  270. return s.State(), err
  271. }
  272. return s.AssignSamplePath(slot, path)
  273. }
  274. // AssignSamplePath puts the WAV at path on the pad in slot. main.go's file
  275. // drop handler uses it; it is not bound, so the window cannot pass a path.
  276. //
  277. //wails:ignore
  278. func (s *Service) AssignSamplePath(slot int, path string) (State, error) {
  279. return s.edit(func(p *project.Project) error { return p.AssignSample(slot, path) })
  280. }
  281. // ClearPad empties the pad in slot.
  282. func (s *Service) ClearPad(slot int) (State, error) {
  283. return s.edit(func(p *project.Project) error { return p.ClearPad(slot) })
  284. }
  285. // SetTune sets a pad's tuning in semitones and cents.
  286. func (s *Service) SetTune(slot, coarse, fine int) (State, error) {
  287. return s.edit(func(p *project.Project) error { return p.SetTune(slot, coarse, fine) })
  288. }
  289. // SetMuteGroup sets a pad's mute group; 0 is off.
  290. func (s *Service) SetMuteGroup(slot, group int) (State, error) {
  291. return s.edit(func(p *project.Project) error { return p.SetMuteGroup(slot, group) })
  292. }
  293. // ChooseExportFolder asks for the folder to export into and remembers it
  294. // for ExportFolder. It returns the folder, or "" if cancelled.
  295. func (s *Service) ChooseExportFolder() (string, error) {
  296. dir, err := s.dialogs.ChooseFolder()
  297. s.mu.Lock()
  298. defer s.mu.Unlock()
  299. s.exportDir = ""
  300. if err == nil {
  301. s.exportDir = dir
  302. }
  303. return dir, err
  304. }
  305. // ChooseZipPath asks where to save the zip and remembers it for ExportZip.
  306. // It returns the path, or "" if cancelled.
  307. func (s *Service) ChooseZipPath() (string, error) {
  308. s.mu.Lock()
  309. name := s.p.Name
  310. s.mu.Unlock()
  311. path, err := s.dialogs.SaveZip(name + ".zip")
  312. if path != "" && !strings.EqualFold(filepath.Ext(path), ".zip") {
  313. path += ".zip"
  314. }
  315. s.mu.Lock()
  316. defer s.mu.Unlock()
  317. s.zipPath = ""
  318. if err == nil {
  319. s.zipPath = path
  320. }
  321. return path, err
  322. }
  323. // errNoTarget is returned by an export with no target chosen.
  324. var errNoTarget = errors.New("choose where to export first")
  325. // ExportFolder writes the project into the folder ChooseExportFolder
  326. // chose. If the project is already there and overwrite is false, nothing
  327. // is written and Exists lists it.
  328. func (s *Service) ExportFolder(overwrite bool) (ExportResult, error) {
  329. s.mu.Lock()
  330. defer s.mu.Unlock()
  331. if s.exportDir == "" {
  332. return ExportResult{}, errNoTarget
  333. }
  334. path, err := export.Folder(s.p, s.exportDir, overwrite)
  335. return s.exported(path, err)
  336. }
  337. // ExportZip writes the project as a zip where ChooseZipPath chose. If the
  338. // file exists and overwrite is false, nothing is written and Exists lists it.
  339. func (s *Service) ExportZip(overwrite bool) (ExportResult, error) {
  340. s.mu.Lock()
  341. defer s.mu.Unlock()
  342. if s.zipPath == "" {
  343. return ExportResult{}, errNoTarget
  344. }
  345. path := s.zipPath
  346. err := export.Zip(s.p, path, overwrite)
  347. return s.exported(path, err)
  348. }
  349. func (s *Service) exported(path string, err error) (ExportResult, error) {
  350. var exists *export.ExistsError
  351. if errors.As(err, &exists) {
  352. return ExportResult{Exists: exists.Paths}, nil
  353. }
  354. if err != nil {
  355. return ExportResult{}, err
  356. }
  357. s.p.Dirty = false
  358. s.exportDir, s.zipPath = "", "" // the next export asks again
  359. return ExportResult{Path: path}, nil
  360. }
  361. // MovePad moves the pad in from to slot to, replacing what was there.
  362. // Recorded notes stay on their slots; the frontend warns first.
  363. func (s *Service) MovePad(from, to int) (State, error) {
  364. return s.edit(func(p *project.Project) error { return p.MovePad(from, to) })
  365. }
  366. // CopyPad copies the pad in from to slot to, replacing what was there.
  367. func (s *Service) CopyPad(from, to int) (State, error) {
  368. return s.edit(func(p *project.Project) error { return p.CopyPad(from, to) })
  369. }
  370. // SwapPads exchanges two pads.
  371. func (s *Service) SwapPads(a, b int) (State, error) {
  372. return s.edit(func(p *project.Project) error { return p.SwapPads(a, b) })
  373. }
  374. // Load asks for a project file and opens it in place of the current one.
  375. // The frontend asks about unsaved changes first.
  376. func (s *Service) Load() (LoadResult, error) {
  377. path, err := s.dialogs.OpenProject()
  378. if err != nil || path == "" {
  379. return LoadResult{State: s.State()}, err
  380. }
  381. return s.LoadPath(path)
  382. }
  383. // LoadPath opens the project at path in place of the current one. Load
  384. // uses it after the dialog; it is not bound, so the window cannot pass a
  385. // path.
  386. //
  387. //wails:ignore
  388. func (s *Service) LoadPath(path string) (LoadResult, error) {
  389. p, warnings, err := project.Load(path)
  390. if err != nil {
  391. return LoadResult{State: s.State()}, fmt.Errorf("%s: %w", filepath.Base(path), err)
  392. }
  393. s.mu.Lock()
  394. defer s.mu.Unlock()
  395. s.use(p)
  396. if warnings == nil {
  397. warnings = []string{}
  398. }
  399. return LoadResult{Path: path, State: s.state(), Warnings: warnings}, nil
  400. }
  401. // AddSequence adds a sequence in an empty slot: "Sequence NN", 2 bars, at
  402. // the BPM of the most recently edited sequence (else 120).
  403. func (s *Service) AddSequence(slot int) (State, error) {
  404. return s.edit(func(p *project.Project) error { return p.AddSequence(slot) })
  405. }
  406. // RemoveSequence deletes a sequence and its recorded notes. The last
  407. // sequence cannot be removed.
  408. func (s *Service) RemoveSequence(slot int) (State, error) {
  409. return s.edit(func(p *project.Project) error { return p.RemoveSequence(slot) })
  410. }
  411. // SetSequence sets a sequence's name, BPM and length in bars. Notes past a
  412. // new, shorter end are left in the file.
  413. func (s *Service) SetSequence(slot int, name string, bpm float64, bars int) (State, error) {
  414. return s.edit(func(p *project.Project) error {
  415. return p.SetSequence(slot, strings.TrimSpace(name), bpm, bars)
  416. })
  417. }