api

type Browser interface {

	// GetArtists returns all artists
	GetArtists(query *interfaces.QueryOpts) ([]*models.Artist, int, error)

	// GetAlbumArtists returns artists that are marked as album artists. See GetArtists.
	GetAlbumArtists(query *interfaces.QueryOpts) ([]*models.Artist, int, error)
	// GetAlbums gets albums with given paging. Only PageSize and CurrentPage are used. Total count is returned
	GetAlbums(query *interfaces.QueryOpts) ([]*models.Album, int, error)

	// GetArtistAlbums returns albums that artist takes part in.
	GetArtistAlbums(artist models.Id) ([]*models.Album, error)

	// GetAlbumSongs returns songs for given album id.
	GetAlbumSongs(album models.Id) ([]*models.Song, error)
	// GetPlaylists returns all playlists.
	GetPlaylists() ([]*models.Playlist, error)
	// GetPlaylistSongs fills songs array for playlist. If there's error, songs will not be filled
	GetPlaylistSongs(playlist models.Id) ([]*models.Song, error)

	// GetSimilarArtists returns similar artists for artist id
	GetSimilarArtists(artist models.Id) ([]*models.Artist, error)

	// GetsimilarAlbums returns list of similar albums.
	GetSimilarAlbums(album models.Id) ([]*models.Album, error)

	// GetRecentlyPlayed returns songs that have been played last.
	GetRecentlyPlayed(paging interfaces.Paging) ([]*models.Song, int, error)

	// GetSongs returns songs by paging. It also returns total number of songs.
	GetSongs(query *interfaces.QueryOpts) ([]*models.Song, int, error)

	// GetGenres returns music genres with paging. Return genres, total genres and possible error
	GetGenres(paging interfaces.Paging) ([]*models.IdName, int, error)

	// GetAlbumArtist returns main artist for album.
	GetAlbumArtist(album *models.Album) (*models.Artist, error)

	// GetInstantMix returns instant mix based on given item.
	GetInstantMix(item models.Item) ([]*models.Song, error)

	// GetLink returns a link to item that can be opened with browser.
	// If there is no link or item is invalid, empty link is returned.
	GetLink(item models.Item) string

	// Search returns values matching query and itemType, limited by number of maxResults,
	// Only items of itemType should ne returned.
	Search(query string, itemType models.ItemType, maxResults int) ([]models.Item, error)

	GetAlbum(id models.Id) (*models.Album, error)

	GetArtist(id models.Id) (*models.Artist, error)

	GetImageUrl(item models.Id, itemType models.ItemType) string
}

type Cacher interface {

	// CanCacheSong returns true if caching songs by Browser.GetSongs is implemented.
	// Else, player tries to pull songs directly using Browser.GetAlbumSongs.
	// GetAlbumSongs is slower method (when album contains less songs then paged song list).
	CanCacheSongs() bool
}

type MediaServer interface {
	Streamer
	Browser
	RemoteServer
}

type MockConfig struct {
}

type MockServer struct {
	Artists         []*models.Artist
	FavoriteArtists []*models.Artist
	AlbumArtists    []*models.Artist
	Albums          []*models.Album
	AlbumSongs      map[models.Id][]*models.Song
	Playlists       []*models.Playlist
	PlaylistSongs   map[models.Id]*models.Song
	Songs           []*models.Song
}

type RemoteController interface {
	// SetPlayer allows connecting remote controller to player, which can
	// then be controlled remotely.
	SetPlayer(player interfaces.Player)

	SetQueue(q interfaces.QueueController)

	RemoteControlEnabled() error
}

type RemoteServer interface {
	// GetInfo returns general info
	GetInfo() (*models.ServerInfo, error)

	// ConnectionOk returns nil of connection ok, else returns description for failure.
	ConnectionOk() error

	// GetConfig returns backend config that is saved to config file.
	GetConfig() config.Backend

	// ReportProgress reports player progress to remote controller.
	ReportProgress(state *interfaces.ApiPlaybackState) error

	// Start starts background service for remote server, if any.
	Start() error

	// Stop stops background service for remote server, if any.
	Stop() error

	// GetId returns unique id for server. If server does not provide one,
	// it can be e.g. hashed from url and user.
	GetId() string
}

type StreamBuffer struct {
	// contains filtered or unexported fields
}

type Streamer interface {

	// Stream streams song. If server does not implement separate streaming endpoint,
	// implementcation can wrap Download.
	Stream(Song *models.Song) (io.ReadCloser, interfaces.AudioFormat, error)

	// Download downloads original audio file.
	Download(Song *models.Song) (io.ReadCloser, interfaces.AudioFormat, error)
}