extract additional iterator helper to share with Jellyfin

This commit is contained in:
Drew Weymouth
2023-11-14 09:05:02 -08:00
parent 5431fe3058
commit 7637440fd6
3 changed files with 113 additions and 111 deletions
+61 -4
View File
@@ -5,10 +5,67 @@ import (
"strings" "strings"
"github.com/dweymouth/supersonic/backend/mediaprovider" "github.com/dweymouth/supersonic/backend/mediaprovider"
"github.com/dweymouth/supersonic/sharedutil"
) )
type AlbumFetchFn func(offset, limit int) ([]*mediaprovider.Album, error) type AlbumFetchFn func(offset, limit int) ([]*mediaprovider.Album, error)
type baseIter struct {
filter mediaprovider.AlbumFilter
prefetchCB func(string)
serverPos int
fetchFn AlbumFetchFn
prefetched []*mediaprovider.Album
prefetchedPos int
done bool
}
func NewBaseIter(fetchFn AlbumFetchFn, filter mediaprovider.AlbumFilter, cb func(string)) *baseIter {
return &baseIter{
prefetchCB: cb,
filter: filter,
fetchFn: fetchFn,
}
}
func (r *baseIter) Next() *mediaprovider.Album {
if r.done {
return nil
}
if r.prefetched != nil && r.prefetchedPos < len(r.prefetched) {
a := r.prefetched[r.prefetchedPos]
r.prefetchedPos++
return a
}
r.prefetched = nil
for { // keep fetching until we are done or have mathcing results
albums, err := r.fetchFn(r.serverPos, 20)
if err != nil {
log.Printf("error fetching albums: %s", err.Error())
albums = nil
}
if len(albums) == 0 {
r.done = true
return nil
}
r.serverPos += len(albums)
albums = sharedutil.FilterSlice(albums, func(al *mediaprovider.Album) bool {
return filterMatches(r.filter, al)
})
r.prefetched = albums
if len(albums) > 0 {
break
}
}
r.prefetchedPos = 1
if r.prefetchCB != nil {
for _, album := range r.prefetched {
go r.prefetchCB(album.CoverArtID)
}
}
return r.prefetched[0]
}
type randomIter struct { type randomIter struct {
filter mediaprovider.AlbumFilter filter mediaprovider.AlbumFilter
prefetchCB func(coverArtID string) prefetchCB func(coverArtID string)
@@ -60,7 +117,7 @@ func (r *randomIter) Next() *mediaprovider.Album {
} }
r.offset += len(albums) r.offset += len(albums)
for _, album := range albums { for _, album := range albums {
if _, ok := r.albumIDSet[album.ID]; !ok && filterMatches(r.filter, album, false) { if _, ok := r.albumIDSet[album.ID]; !ok && filterMatches(r.filter, album) {
r.prefetched = append(r.prefetched, album) r.prefetched = append(r.prefetched, album)
if r.prefetchCB != nil { if r.prefetchCB != nil {
go r.prefetchCB(album.CoverArtID) go r.prefetchCB(album.CoverArtID)
@@ -83,7 +140,7 @@ func (r *randomIter) Next() *mediaprovider.Album {
// by the filter because we need to know when to move to phase two // by the filter because we need to know when to move to phase two
hitCount++ hitCount++
r.albumIDSet[album.ID] = true r.albumIDSet[album.ID] = true
if filterMatches(r.filter, album, false) { if filterMatches(r.filter, album) {
r.prefetched = append(r.prefetched, album) r.prefetched = append(r.prefetched, album)
if r.prefetchCB != nil { if r.prefetchCB != nil {
go r.prefetchCB(album.CoverArtID) go r.prefetchCB(album.CoverArtID)
@@ -112,7 +169,7 @@ func (r *randomIter) Next() *mediaprovider.Album {
return nil return nil
} }
func filterMatches(f mediaprovider.AlbumFilter, album *mediaprovider.Album, ignoreGenre bool) bool { func filterMatches(f mediaprovider.AlbumFilter, album *mediaprovider.Album) bool {
if album == nil { if album == nil {
return false return false
} }
@@ -125,7 +182,7 @@ func filterMatches(f mediaprovider.AlbumFilter, album *mediaprovider.Album, igno
if y := album.Year; y < f.MinYear || (f.MaxYear > 0 && y > f.MaxYear) { if y := album.Year; y < f.MinYear || (f.MaxYear > 0 && y > f.MaxYear) {
return false return false
} }
if ignoreGenre || len(f.Genres) == 0 { if len(f.Genres) == 0 {
return true return true
} }
return genresMatch(f.Genres, album.Genres) return genresMatch(f.Genres, album.Genres)
@@ -265,7 +265,7 @@ func (j *jellyfinMediaProvider) Scrobble(trackID string, submission bool) error
} }
func (s *jellyfinMediaProvider) RescanLibrary() error { func (s *jellyfinMediaProvider) RescanLibrary() error {
return errors.ErrUnsupported return errors.New("unimplemented")
} }
func toTrack(ch *jellyfin.Song) *mediaprovider.Track { func toTrack(ch *jellyfin.Song) *mediaprovider.Track {
+51 -106
View File
@@ -61,31 +61,49 @@ func filterMatches(f mediaprovider.AlbumFilter, album *subsonic.AlbumID3, ignore
func (s *subsonicMediaProvider) IterateAlbums(sortOrder string, filter mediaprovider.AlbumFilter) mediaprovider.AlbumIterator { func (s *subsonicMediaProvider) IterateAlbums(sortOrder string, filter mediaprovider.AlbumFilter) mediaprovider.AlbumIterator {
if sortOrder == "" && len(filter.Genres) == 1 { if sortOrder == "" && len(filter.Genres) == 1 {
return s.newBaseIter("byGenre", filter, s.prefetchCoverCB, map[string]string{"genre": filter.Genres[0]}) genre := filter.Genres[0]
// The Subsonic API (non-OpenSubsonic) returns only the first genre for multi-genre albums,
// but servers do internally match against all the genres the album is categorized with.
// So we must not additionally filter by genre to avoid excluding results where
// the single genre returned by Subsonic isn't the one we're iterating on.
filter.Genres = nil
fetchFn := func(offset, limit int) ([]*subsonic.AlbumID3, error) {
return s.client.GetAlbumList2("byGenre",
map[string]string{"genre": genre, "offset": strconv.Itoa(offset), "limit": strconv.Itoa(limit)})
}
return helpers.NewBaseIter(makeFetchFn(fetchFn), filter, s.prefetchCoverCB)
} }
if sortOrder == "" && filter.ExcludeUnfavorited { if sortOrder == "" && filter.ExcludeUnfavorited {
return s.newBaseIter("starred", filter, s.prefetchCoverCB, make(map[string]string)) return s.baseIterFromSimpleSortOrder("starred", filter)
} }
if sortOrder == "" { if sortOrder == "" {
sortOrder = AlbumSortRecentlyAdded // default sortOrder = AlbumSortRecentlyAdded // default
} }
switch sortOrder { switch sortOrder {
case AlbumSortRecentlyAdded: case AlbumSortRecentlyAdded:
return s.newBaseIter("newest", filter, s.prefetchCoverCB, make(map[string]string)) return s.baseIterFromSimpleSortOrder("newest", filter)
case AlbumSortRecentlyPlayed: case AlbumSortRecentlyPlayed:
return s.newBaseIter("recent", filter, s.prefetchCoverCB, make(map[string]string)) return s.baseIterFromSimpleSortOrder("recent", filter)
case AlbumSortFrequentlyPlayed: case AlbumSortFrequentlyPlayed:
return s.newBaseIter("frequent", filter, s.prefetchCoverCB, make(map[string]string)) return s.baseIterFromSimpleSortOrder("frequent", filter)
case AlbumSortRandom: case AlbumSortRandom:
return s.newRandomIter(filter, s.prefetchCoverCB) return s.newRandomIter(filter, s.prefetchCoverCB)
case AlbumSortTitleAZ: case AlbumSortTitleAZ:
return s.newBaseIter("alphabeticalByName", filter, s.prefetchCoverCB, make(map[string]string)) return s.baseIterFromSimpleSortOrder("alphabeticalByName", filter)
case AlbumSortArtistAZ: case AlbumSortArtistAZ:
return s.newBaseIter("alphabeticalByArtist", filter, s.prefetchCoverCB, make(map[string]string)) return s.baseIterFromSimpleSortOrder("alphabeticalByArtist", filter)
case AlbumSortYearAscending: case AlbumSortYearAscending:
return s.newBaseIter("byYear", filter, s.prefetchCoverCB, map[string]string{"fromYear": "0", "toYear": "3000"}) fetchFn := func(offset, limit int) ([]*subsonic.AlbumID3, error) {
return s.client.GetAlbumList2("byYear",
map[string]string{"fromYear": "0", "toYear": "3000", "offset": strconv.Itoa(offset), "limit": strconv.Itoa(limit)})
}
return helpers.NewBaseIter(makeFetchFn(fetchFn), filter, s.prefetchCoverCB)
case AlbumSortYearDescending: case AlbumSortYearDescending:
return s.newBaseIter("byYear", filter, s.prefetchCoverCB, map[string]string{"fromYear": "3000", "toYear": "0"}) fetchFn := func(offset, limit int) ([]*subsonic.AlbumID3, error) {
return s.client.GetAlbumList2("byYear",
map[string]string{"fromYear": "3000", "toYear": "0", "offset": strconv.Itoa(offset), "limit": strconv.Itoa(limit)})
}
return helpers.NewBaseIter(makeFetchFn(fetchFn), filter, s.prefetchCoverCB)
default: default:
log.Printf("Undefined album sort order: %s", sortOrder) log.Printf("Undefined album sort order: %s", sortOrder)
return nil return nil
@@ -96,71 +114,6 @@ func (s *subsonicMediaProvider) SearchAlbums(searchQuery string, filter mediapro
return s.newSearchIter(searchQuery, filter, s.prefetchCoverCB) return s.newSearchIter(searchQuery, filter, s.prefetchCoverCB)
} }
type baseIter struct {
listType string
filter mediaprovider.AlbumFilter
prefetchCB func(string)
serverPos int
s *subsonic.Client
opts map[string]string
prefetched []*mediaprovider.Album
prefetchedPos int
done bool
}
func (s *subsonicMediaProvider) newBaseIter(listType string, filter mediaprovider.AlbumFilter, cb func(string), opts map[string]string) *baseIter {
return &baseIter{
prefetchCB: cb,
listType: listType,
filter: filter,
s: s.client,
opts: opts,
}
}
func (r *baseIter) Next() *mediaprovider.Album {
if r.done {
return nil
}
if r.prefetched != nil && r.prefetchedPos < len(r.prefetched) {
a := r.prefetched[r.prefetchedPos]
r.prefetchedPos++
return a
}
r.prefetched = nil
for { // keep fetching until we are done or have mathcing results
r.opts["offset"] = strconv.Itoa(r.serverPos)
albums, err := r.s.GetAlbumList2(r.listType, r.opts)
if err != nil {
log.Printf("error fetching albums: %s", err.Error())
albums = nil
}
if len(albums) == 0 {
r.done = true
return nil
}
r.serverPos += len(albums)
albums = sharedutil.FilterSlice(albums, func(al *subsonic.AlbumID3) bool {
// The Subsonic API returns only the first genre for multi-genre albums,
// but servers do internally match against all the genres the album is categorized with.
// So we must not additionally filter by genre to avoid excluding results where
// the single genre returned by Subsonic isn't the one we're iterating on.
return filterMatches(r.filter, al, r.listType == "byGenre" /*ignoreGenre*/)
})
r.prefetched = sharedutil.MapSlice(albums, toAlbum)
if len(albums) > 0 {
break
}
}
r.prefetchedPos = 1
if r.prefetchCB != nil {
for _, album := range r.prefetched {
go r.prefetchCB(album.CoverArtID)
}
}
return r.prefetched[0]
}
type searchIter struct { type searchIter struct {
searchIterBase searchIterBase
@@ -259,39 +212,31 @@ func (s *searchIter) addNewAlbums(al []*subsonic.AlbumID3) {
} }
} }
type randomIter struct {
filter mediaprovider.AlbumFilter
prefetchCB func(coverArtID string)
albumIDSet map[string]bool
s *subsonic.Client
prefetched []*subsonic.AlbumID3
prefetchedPos int
// Random iter works in two phases - phase 1 by requesting random
// albums from the server. Since the Subsonic API provides no way
// of paginating a single random sort, we may get albums back twice.
// We use albumIDSet to keep track of which albums have already been returned.
// Once we start getting back too many already-returned albums,
// switch to requesting more albums from a deterministic sort order.
phaseTwo bool
offset int
done bool
}
func (s *subsonicMediaProvider) newRandomIter(filter mediaprovider.AlbumFilter, cb func(string)) mediaprovider.AlbumIterator { func (s *subsonicMediaProvider) newRandomIter(filter mediaprovider.AlbumFilter, cb func(string)) mediaprovider.AlbumIterator {
return helpers.NewRandomIter( return helpers.NewRandomIter(
func(offset, limit int) ([]*mediaprovider.Album, error) { s.fetchFnFromStandardSort("newest"),
al, err := s.client.GetAlbumList2("newest", map[string]string{"size": strconv.Itoa(limit), "offset": strconv.Itoa(offset)}) makeFetchFn(func(offset, limit int) ([]*subsonic.AlbumID3, error) {
if err != nil { return s.client.GetAlbumList2("random", map[string]string{"size": strconv.Itoa(limit)})
return nil, err }),
}
return sharedutil.MapSlice(al, toAlbum), nil
},
func(_, limit int) ([]*mediaprovider.Album, error) {
al, err := s.client.GetAlbumList2("random", map[string]string{"size": strconv.Itoa(limit)})
if err != nil {
return nil, err
}
return sharedutil.MapSlice(al, toAlbum), nil
},
filter, s.prefetchCoverCB) filter, s.prefetchCoverCB)
} }
func (s *subsonicMediaProvider) baseIterFromSimpleSortOrder(sort string, filter mediaprovider.AlbumFilter) mediaprovider.AlbumIterator {
return helpers.NewBaseIter(s.fetchFnFromStandardSort(sort), filter, s.prefetchCoverCB)
}
func (s *subsonicMediaProvider) fetchFnFromStandardSort(sort string) helpers.AlbumFetchFn {
return makeFetchFn(func(offset, limit int) ([]*subsonic.AlbumID3, error) {
return s.client.GetAlbumList2(sort, map[string]string{"size": strconv.Itoa(limit), "offset": strconv.Itoa(offset)})
})
}
func makeFetchFn(subsonicFetchFn func(offset, limit int) ([]*subsonic.AlbumID3, error)) helpers.AlbumFetchFn {
return func(offset, limit int) ([]*mediaprovider.Album, error) {
al, err := subsonicFetchFn(offset, limit)
if err != nil {
return nil, err
}
return sharedutil.MapSlice(al, toAlbum), nil
}
}