128 lines
3.0 KiB
C++
128 lines
3.0 KiB
C++
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
// Copyright The Music Player Daemon Project
|
|
|
|
#ifndef MPD_DATABASE_INTERFACE_HXX
|
|
#define MPD_DATABASE_INTERFACE_HXX
|
|
|
|
#include "Visitor.hxx"
|
|
|
|
#include <chrono>
|
|
#include <cstdint>
|
|
#include <span>
|
|
#include <string>
|
|
|
|
enum TagType : uint8_t;
|
|
struct DatabasePlugin;
|
|
struct DatabaseStats;
|
|
struct DatabaseSelection;
|
|
struct LightSong;
|
|
template<typename Key> class RecursiveMap;
|
|
|
|
class Database {
|
|
const DatabasePlugin &plugin;
|
|
|
|
protected:
|
|
Database(const DatabasePlugin &_plugin) noexcept
|
|
:plugin(_plugin) {}
|
|
|
|
public:
|
|
/**
|
|
* Free instance data.
|
|
*/
|
|
virtual ~Database() noexcept = default;
|
|
|
|
const DatabasePlugin &GetPlugin() const noexcept {
|
|
return plugin;
|
|
}
|
|
|
|
/**
|
|
* Open the database. Read it into memory if applicable.
|
|
*
|
|
* Throws on error (e.g. #DatabaseError).
|
|
*/
|
|
virtual void Open() {
|
|
}
|
|
|
|
/**
|
|
* Close the database, free allocated memory.
|
|
*/
|
|
virtual void Close() noexcept {}
|
|
|
|
/**
|
|
* Look up a song (including tag data) in the database. When
|
|
* you don't need this anymore, call ReturnSong().
|
|
*
|
|
* Throws on error. "Not found" is an error that throws
|
|
* DatabaseErrorCode::NOT_FOUND.
|
|
*
|
|
* @param uri_utf8 the URI of the song within the music
|
|
* directory (UTF-8)
|
|
* @return a pointer that must be released with ReturnSong()
|
|
*/
|
|
virtual const LightSong *GetSong(std::string_view uri_utf8) const = 0;
|
|
|
|
/**
|
|
* Mark the song object as "unused". Call this on objects
|
|
* returned by GetSong().
|
|
*/
|
|
virtual void ReturnSong(const LightSong *song) const noexcept = 0;
|
|
|
|
/**
|
|
* Visit the selected entities.
|
|
*
|
|
* Throws on error.
|
|
*/
|
|
virtual void Visit(const DatabaseSelection &selection,
|
|
VisitDirectory visit_directory,
|
|
VisitSong visit_song,
|
|
VisitPlaylist visit_playlist) const = 0;
|
|
|
|
void Visit(const DatabaseSelection &selection,
|
|
VisitDirectory visit_directory,
|
|
VisitSong visit_song) const {
|
|
Visit(selection, visit_directory, visit_song, VisitPlaylist());
|
|
}
|
|
|
|
void Visit(const DatabaseSelection &selection,
|
|
VisitSong visit_song) const {
|
|
return Visit(selection, VisitDirectory(), visit_song);
|
|
}
|
|
|
|
/**
|
|
* Collect unique values of the given tag types. Each item in
|
|
* the #tag_types parameter results in one nesting level in
|
|
* the return value.
|
|
*
|
|
* Throws on error.
|
|
*/
|
|
virtual RecursiveMap<std::string> CollectUniqueTags(const DatabaseSelection &selection,
|
|
std::span<const TagType> tag_types) const = 0;
|
|
|
|
/**
|
|
* Throws on error.
|
|
*/
|
|
virtual DatabaseStats GetStats(const DatabaseSelection &selection) const = 0;
|
|
|
|
/**
|
|
* Update the database.
|
|
*
|
|
* Throws on error.
|
|
*
|
|
* @return the job id or 0 if not implemented
|
|
*/
|
|
virtual unsigned Update([[maybe_unused]] const char *uri_utf8,
|
|
[[maybe_unused]] bool discard) {
|
|
/* not implemented: return 0 */
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Returns the time stamp of the last database update.
|
|
* Returns a negative value if that is not not known/available.
|
|
*/
|
|
[[gnu::pure]]
|
|
virtual std::chrono::system_clock::time_point GetUpdateStamp() const noexcept = 0;
|
|
};
|
|
|
|
#endif
|