-
Notifications
You must be signed in to change notification settings - Fork 23
/
songlist.go
401 lines (351 loc) · 9.64 KB
/
songlist.go
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
package songlist
import (
"fmt"
"sort"
"sync"
"time"
"github.com/fhs/gompd/v2/mpd"
"github.com/ambientsound/pms/console"
"github.com/ambientsound/pms/song"
)
type Songlist interface {
Add(*song.Song) error
AddList(Songlist) error
Clear() error
Delete() error
Duplicate(Songlist) error
Indices([]int) Songlist
InRange(int) bool
Insert(*song.Song, int) error
InsertList(Songlist, int) error
Len() int
Locate(*song.Song) (int, error)
Lock()
Name() string
NextOf([]string, int, int) int
Remove(int) error
RemoveIndices([]int) error
Replace(int, *song.Song) error
SetName(string) error
Song(int) *song.Song
Songs() []*song.Song
Sort([]string) error
Truncate(int) error
Unlock()
ClearSelection()
Columns([]string) Columns
CommitVisualSelection()
Cursor() int
CursorSong() *song.Song
CursorToSong(*song.Song) error
DisableVisualSelection()
EnableVisualSelection()
HasVisualSelection() bool
IndexAtSong(int, *song.Song) bool
MoveCursor(int)
Selected(int) bool
Selection() Songlist
SelectionIndices() []int
SetCursor(int)
SetSelected(int, bool)
SetUpdated()
SetVisualSelection(int, int, int)
ToggleVisualSelection()
Updated() time.Time
ValidateCursor(int, int)
}
type BaseSonglist struct {
name string
songs []*song.Song
mutex sync.Mutex
updated time.Time
columns ColumnMap
cursor int
selection map[int]struct{}
visualSelection [3]int
}
func New() (s *BaseSonglist) {
s = &BaseSonglist{}
s.clear()
return
}
// Add adds a song to the songlist.
func (s *BaseSonglist) Add(song *song.Song) error {
s.add(song)
return nil
}
// add internally adds a song to the songlist, without any side effects at MPD's side.
func (s *BaseSonglist) add(song *song.Song) {
s.songs = append(s.songs, song)
s.ensureColumns(song)
s.columns.Add(song)
}
// AddList appends a songlist to this songlist.
func (s *BaseSonglist) AddList(songlist Songlist) error {
songs := songlist.Songs()
for _, song := range songs {
if err := s.Add(song); err != nil {
return err
}
}
return nil
}
// insert internally inserts a song to the songlist, without any side effects at MPD's side.
func (s *BaseSonglist) insert(newSong *song.Song, position int) {
// create a copy of the list, with the new song inserted at the correct position
songs := make([]*song.Song, len(s.songs)+1)
position += copy(songs[:], s.songs[:position])
songs[position] = newSong
copy(songs[position+1:], s.songs[position:])
s.songs = songs
// expand columns
s.ensureColumns(newSong)
s.columns.Add(newSong)
}
// Insert inserts a song at the specified position.
func (s *BaseSonglist) Insert(song *song.Song, position int) error {
s.insert(song, position)
if position <= s.Cursor() {
s.MoveCursor(1)
}
return nil
}
// InsertList inserts the songs in a songlist into this songlist, at a specified position.
func (s *BaseSonglist) InsertList(list Songlist, position int) error {
size := list.Len()
//console.Log("making size %d array", s.Len()+size)
songs := make([]*song.Song, s.Len()+size)
//console.Log("copy to 0 <- songs[:%d]", position)
copy(songs[:], s.songs[:position])
//console.Log("copy to %d <- list", position)
copy(songs[position:], list.Songs())
//console.Log("copy to %d <- songs[%d:]", position+size, position)
copy(songs[position+size:], s.songs[position:])
s.songs = songs
// Move cursor if pasting above.
if position <= s.Cursor() {
s.MoveCursor(size)
}
// expand columns
for _, newSong := range list.Songs() {
s.ensureColumns(newSong)
s.columns.Add(newSong)
}
return nil
}
func (s *BaseSonglist) Remove(index int) error {
song := s.Song(index)
if song == nil {
return fmt.Errorf("Out of bounds")
}
s.columns.Remove(song)
s.Lock()
defer s.Unlock()
//console.Log("Removing song number %d from songlist '%s'", index, s.Name())
if index+1 == s.Len() {
s.songs = s.songs[:index]
} else {
s.songs = append(s.songs[:index], s.songs[index+1:]...)
}
return nil
}
// RemoveIndices removes a selection of songs from the songlist, having the
// index defined by the int slice parameter.
func (s *BaseSonglist) RemoveIndices(indices []int) error {
// Ensure that indices are removed in reverse order
sort.Sort(sort.Reverse(sort.IntSlice(indices)))
for _, i := range indices {
if err := s.Remove(i); err != nil {
return err
}
}
return nil
}
func (s *BaseSonglist) Lock() {
s.mutex.Lock()
}
func (s *BaseSonglist) Unlock() {
s.mutex.Unlock()
}
// Clear clears the songlist by removing any songs.
func (s *BaseSonglist) Clear() error {
s.clear()
return nil
}
func (s *BaseSonglist) clear() {
s.songs = make([]*song.Song, 0)
s.columns = make(ColumnMap)
s.ClearSelection()
}
// Delete deletes a songlist. This is a placeholder function that should be
// overridden by other classes that need to trigger an action on the MPD side.
func (s *BaseSonglist) Delete() error {
return nil
}
func (s *BaseSonglist) Replace(index int, song *song.Song) error {
if !s.InRange(index) {
return fmt.Errorf("Out of bounds")
}
s.Lock()
defer s.Unlock()
s.songs[index] = song
return nil
}
// Duplicate makes a copy of the current songlist, and places it in dest.
func (s *BaseSonglist) Duplicate(dest Songlist) error {
if err := dest.Clear(); err != nil {
return err
}
oldSongs := s.Songs()
for i := range oldSongs {
newSong := *oldSongs[i]
newSong.ID = song.NullID
newSong.Position = song.NullPosition
if err := dest.Add(&newSong); err != nil {
return err
}
}
return nil
}
func (s *BaseSonglist) Truncate(length int) error {
if length < 0 || length > s.Len() {
return fmt.Errorf("Out of bounds")
}
s.Lock()
defer s.Unlock()
s.songs = s.songs[:length]
return nil
}
// Indices accepts a slice of integers pointing to song positions, returns a
// new songlist with those songs. Any mismatching integers are ignored.
func (s *BaseSonglist) Indices(indices []int) Songlist {
dest := New()
for _, i := range indices {
if song := s.Song(i); song != nil {
dest.Add(song)
} else {
console.Log("BUG: Indices() returned an integer '%d' that resulted in a nil song, ignoring", i)
}
}
return dest
}
func (s *BaseSonglist) Locate(match *song.Song) (int, error) {
if match == nil {
return 0, fmt.Errorf("Attempt to locate nil song")
}
for i, test := range s.songs {
hasId := !(match.NullID() || test.NullID())
switch {
case hasId && match.ID == test.ID:
case !hasId && match.StringTags["file"] == test.StringTags["file"]:
default:
continue
}
return i, nil
}
return 0, fmt.Errorf("Cannot find song in songlist '%s'", s.Name())
}
// IndexAtSong returns true if the song at the specified index is at a song
// with the same ID, or the path if the songlist is not a queue.
func (s *BaseSonglist) IndexAtSong(i int, song *song.Song) bool {
check := s.Song(i)
return song != nil && check != nil && check.StringTags["file"] == song.StringTags["file"]
}
func (s *BaseSonglist) SetName(name string) error {
s.name = name
return nil
}
func (s *BaseSonglist) Name() string {
return s.name
}
func (s *BaseSonglist) Song(i int) *song.Song {
if !s.InRange(i) {
return nil
}
return s.songs[i]
}
func (s *BaseSonglist) Songs() []*song.Song {
return s.songs
}
// NextOf searches forwards or backwards for songs having different tags than the specified song.
// The index of the next song is returned.
func (s *BaseSonglist) NextOf(tags []string, index int, direction int) int {
offset := func(i int) int {
if direction > 0 || i == 0 {
return 0
}
return 1
}
len := s.Len()
index -= offset(index)
check := s.Song(index)
//console.Log("Starting at index %d, cursor at %d, direction %d", index, s.Cursor(), direction)
//console.Log("Check: %+v", check.StringTags)
for ; index < len && index >= 0; index += direction {
//console.Log("trying %d", index)
song := s.Song(index)
//console.Log(".....: %+v", song.StringTags)
if song == nil {
//console.Log("NextOf: empty song, break")
break
}
for _, tag := range tags {
if check.StringTags[tag] != song.StringTags[tag] {
//console.Log("NextOf: tag '%s' on source '%s' differs from destination '%s', breaking", tag, check.StringTags[tag], song.StringTags[tag])
return index + offset(index)
}
}
}
//console.Log("NextOf: fallthrough")
return index + offset(index)
}
// Sort sorts the songlist by the given tags. The first tag is sorted normally,
// while the remaining tags are used for stable sorting.
func (s *BaseSonglist) Sort(fields []string) error {
if len(fields) == 0 {
return fmt.Errorf("Cannot sort without sort criteria")
}
s.Lock()
defer s.Unlock()
stable := false
for _, field := range fields {
s.sortBy(field, stable)
stable = true
}
return nil
}
// sortBy sorts the songlist by the given tag, optionally using stable sort.
func (s *BaseSonglist) sortBy(field string, stable bool) {
sortFunc := func(a, b int) bool {
return s.songs[a].SortTags[field] < s.songs[b].SortTags[field]
}
timer := time.Now()
if stable {
sort.SliceStable(s.songs, sortFunc)
} else {
sort.Slice(s.songs, sortFunc)
}
console.Log("Sorted '%s' by '%s' in %s", s.Name(), field, time.Since(timer).String())
}
func (s *BaseSonglist) Len() int {
return len(s.songs)
}
// InRange returns true if the provided index is within songlist range, false otherwise.
func (s *BaseSonglist) InRange(index int) bool {
return index >= 0 && index < s.Len()
}
func (s *BaseSonglist) AddFromAttrlist(attrlist []mpd.Attrs) {
for _, attrs := range attrlist {
newSong := song.New()
newSong.SetTags(attrs)
s.add(newSong)
}
}
// Updated returns the timestamp of when this songlist was last updated.
func (s *BaseSonglist) Updated() time.Time {
return s.updated
}
// SetUpdated sets the update timestamp of the songlist.
func (s *BaseSonglist) SetUpdated() {
s.updated = time.Now()
}