2014-01-07 21:39:47 +01:00
|
|
|
/*
|
2017-01-03 20:48:59 +01:00
|
|
|
* Copyright 2003-2017 The Music Player Daemon Project
|
2014-01-07 21:39:47 +01:00
|
|
|
* http://www.musicpd.org
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef MPD_DETACHED_SONG_HXX
|
|
|
|
#define MPD_DETACHED_SONG_HXX
|
|
|
|
|
|
|
|
#include "check.h"
|
|
|
|
#include "tag/Tag.hxx"
|
2014-08-28 06:54:19 +02:00
|
|
|
#include "Chrono.hxx"
|
2014-01-07 21:39:47 +01:00
|
|
|
#include "Compiler.h"
|
|
|
|
|
|
|
|
#include <string>
|
|
|
|
#include <utility>
|
|
|
|
|
|
|
|
#include <time.h>
|
|
|
|
|
2014-01-19 10:51:34 +01:00
|
|
|
struct LightSong;
|
2014-02-07 00:29:07 +01:00
|
|
|
class Storage;
|
2015-10-20 12:10:42 +02:00
|
|
|
class Path;
|
2014-01-07 21:39:47 +01:00
|
|
|
|
|
|
|
class DetachedSong {
|
2014-02-07 00:29:07 +01:00
|
|
|
friend DetachedSong DatabaseDetachSong(const Storage &db,
|
|
|
|
const LightSong &song);
|
2014-01-14 23:28:36 +01:00
|
|
|
|
2014-01-07 21:39:47 +01:00
|
|
|
/**
|
|
|
|
* An UTF-8-encoded URI referring to the song file. This can
|
|
|
|
* be one of:
|
|
|
|
*
|
|
|
|
* - an absolute URL with a scheme
|
|
|
|
* (e.g. "http://example.com/foo.mp3")
|
|
|
|
*
|
|
|
|
* - an absolute file name
|
|
|
|
*
|
|
|
|
* - a file name relative to the music directory
|
|
|
|
*/
|
|
|
|
std::string uri;
|
|
|
|
|
2014-01-18 18:20:54 +01:00
|
|
|
/**
|
|
|
|
* The "real" URI, the one to be used for opening the
|
|
|
|
* resource. If this attribute is empty, then #uri shall be
|
|
|
|
* used.
|
|
|
|
*
|
|
|
|
* This attribute is used for songs from the database which
|
|
|
|
* have a relative URI.
|
|
|
|
*/
|
|
|
|
std::string real_uri;
|
|
|
|
|
2014-01-07 21:39:47 +01:00
|
|
|
Tag tag;
|
|
|
|
|
2017-01-18 13:13:36 +01:00
|
|
|
time_t mtime = 0;
|
2014-01-07 21:39:47 +01:00
|
|
|
|
|
|
|
/**
|
2014-08-28 06:54:19 +02:00
|
|
|
* Start of this sub-song within the file.
|
2014-01-07 21:39:47 +01:00
|
|
|
*/
|
2017-01-18 13:13:36 +01:00
|
|
|
SongTime start_time = SongTime::zero();
|
2014-01-07 21:39:47 +01:00
|
|
|
|
|
|
|
/**
|
2014-08-28 06:54:19 +02:00
|
|
|
* End of this sub-song within the file.
|
2014-01-07 21:39:47 +01:00
|
|
|
* Unused if zero.
|
|
|
|
*/
|
2017-01-18 13:13:36 +01:00
|
|
|
SongTime end_time = SongTime::zero();
|
2014-01-07 21:39:47 +01:00
|
|
|
|
2014-01-19 10:51:34 +01:00
|
|
|
explicit DetachedSong(const LightSong &other);
|
2014-01-14 23:28:36 +01:00
|
|
|
|
2014-01-07 21:39:47 +01:00
|
|
|
public:
|
2014-01-21 21:06:46 +01:00
|
|
|
explicit DetachedSong(const DetachedSong &) = default;
|
2014-01-07 21:39:47 +01:00
|
|
|
|
|
|
|
explicit DetachedSong(const char *_uri)
|
2017-01-18 13:13:36 +01:00
|
|
|
:uri(_uri) {}
|
2014-01-07 21:39:47 +01:00
|
|
|
|
|
|
|
explicit DetachedSong(const std::string &_uri)
|
2017-01-18 13:13:36 +01:00
|
|
|
:uri(_uri) {}
|
2014-01-07 21:39:47 +01:00
|
|
|
|
|
|
|
explicit DetachedSong(std::string &&_uri)
|
2017-01-18 13:13:36 +01:00
|
|
|
:uri(std::move(_uri)) {}
|
2014-01-07 21:39:47 +01:00
|
|
|
|
|
|
|
template<typename U>
|
|
|
|
DetachedSong(U &&_uri, Tag &&_tag)
|
|
|
|
:uri(std::forward<U>(_uri)),
|
2017-01-18 13:13:36 +01:00
|
|
|
tag(std::move(_tag)) {}
|
2014-01-07 21:39:47 +01:00
|
|
|
|
2014-01-21 21:06:46 +01:00
|
|
|
DetachedSong(DetachedSong &&) = default;
|
2014-01-07 21:39:47 +01:00
|
|
|
|
2014-01-23 21:21:27 +01:00
|
|
|
~DetachedSong();
|
|
|
|
|
2014-01-07 21:39:47 +01:00
|
|
|
gcc_pure
|
2017-05-08 14:44:49 +02:00
|
|
|
const char *GetURI() const noexcept {
|
2014-01-07 21:39:47 +01:00
|
|
|
return uri.c_str();
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename T>
|
|
|
|
void SetURI(T &&_uri) {
|
|
|
|
uri = std::forward<T>(_uri);
|
|
|
|
}
|
|
|
|
|
2014-01-18 18:20:54 +01:00
|
|
|
/**
|
|
|
|
* Does this object have a "real" URI different from the
|
|
|
|
* displayed URI?
|
|
|
|
*/
|
|
|
|
gcc_pure
|
2017-05-08 14:44:49 +02:00
|
|
|
bool HasRealURI() const noexcept {
|
2014-01-18 18:20:54 +01:00
|
|
|
return !real_uri.empty();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns "real" URI (#real_uri) and falls back to just
|
|
|
|
* GetURI().
|
|
|
|
*/
|
|
|
|
gcc_pure
|
2017-05-08 14:44:49 +02:00
|
|
|
const char *GetRealURI() const noexcept {
|
2014-01-18 18:20:54 +01:00
|
|
|
return (HasRealURI() ? real_uri : uri).c_str();
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename T>
|
|
|
|
void SetRealURI(T &&_uri) {
|
|
|
|
real_uri = std::forward<T>(_uri);
|
|
|
|
}
|
|
|
|
|
2014-01-07 21:39:47 +01:00
|
|
|
/**
|
|
|
|
* Returns true if both objects refer to the same physical
|
|
|
|
* song.
|
|
|
|
*/
|
|
|
|
gcc_pure
|
2017-05-08 14:44:49 +02:00
|
|
|
bool IsSame(const DetachedSong &other) const noexcept {
|
2017-01-15 00:54:09 +01:00
|
|
|
return uri == other.uri &&
|
|
|
|
start_time == other.start_time &&
|
|
|
|
end_time == other.end_time;
|
2014-01-07 21:39:47 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
gcc_pure gcc_nonnull_all
|
2017-05-08 14:44:49 +02:00
|
|
|
bool IsURI(const char *other_uri) const noexcept {
|
2014-01-07 21:39:47 +01:00
|
|
|
return uri == other_uri;
|
|
|
|
}
|
|
|
|
|
|
|
|
gcc_pure
|
2017-05-08 14:44:49 +02:00
|
|
|
bool IsRemote() const noexcept;
|
2014-01-07 21:39:47 +01:00
|
|
|
|
|
|
|
gcc_pure
|
|
|
|
bool IsFile() const {
|
|
|
|
return !IsRemote();
|
|
|
|
}
|
|
|
|
|
|
|
|
gcc_pure
|
2017-05-08 14:44:49 +02:00
|
|
|
bool IsAbsoluteFile() const noexcept;
|
2014-01-07 21:39:47 +01:00
|
|
|
|
|
|
|
gcc_pure
|
2017-05-08 14:44:49 +02:00
|
|
|
bool IsInDatabase() const noexcept;
|
2014-01-07 21:39:47 +01:00
|
|
|
|
|
|
|
const Tag &GetTag() const {
|
|
|
|
return tag;
|
|
|
|
}
|
|
|
|
|
|
|
|
Tag &WritableTag() {
|
|
|
|
return tag;
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetTag(const Tag &_tag) {
|
|
|
|
tag = Tag(_tag);
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetTag(Tag &&_tag) {
|
|
|
|
tag = std::move(_tag);
|
|
|
|
}
|
|
|
|
|
|
|
|
void MoveTagFrom(DetachedSong &&other) {
|
|
|
|
tag = std::move(other.tag);
|
|
|
|
}
|
|
|
|
|
2016-02-23 20:59:23 +01:00
|
|
|
/**
|
|
|
|
* Similar to the MoveTagFrom(), but move only the #TagItem
|
|
|
|
* array.
|
|
|
|
*/
|
|
|
|
void MoveTagItemsFrom(DetachedSong &&other) {
|
|
|
|
tag.MoveItemsFrom(std::move(other.tag));
|
|
|
|
}
|
|
|
|
|
2014-01-07 21:39:47 +01:00
|
|
|
time_t GetLastModified() const {
|
|
|
|
return mtime;
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetLastModified(time_t _value) {
|
|
|
|
mtime = _value;
|
|
|
|
}
|
|
|
|
|
2014-08-28 06:54:19 +02:00
|
|
|
SongTime GetStartTime() const {
|
|
|
|
return start_time;
|
2014-01-07 21:39:47 +01:00
|
|
|
}
|
|
|
|
|
2014-08-28 06:54:19 +02:00
|
|
|
void SetStartTime(SongTime _value) {
|
|
|
|
start_time = _value;
|
2014-01-07 21:39:47 +01:00
|
|
|
}
|
|
|
|
|
2014-08-28 06:54:19 +02:00
|
|
|
SongTime GetEndTime() const {
|
|
|
|
return end_time;
|
2014-01-07 21:39:47 +01:00
|
|
|
}
|
|
|
|
|
2014-08-28 06:54:19 +02:00
|
|
|
void SetEndTime(SongTime _value) {
|
|
|
|
end_time = _value;
|
2014-01-07 21:39:47 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
gcc_pure
|
2017-05-08 14:44:49 +02:00
|
|
|
SignedSongTime GetDuration() const noexcept;
|
2014-01-15 12:05:44 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Update the #tag and #mtime.
|
|
|
|
*
|
|
|
|
* @return true on success
|
|
|
|
*/
|
|
|
|
bool Update();
|
2015-10-20 12:10:42 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Load #tag and #mtime from a local file.
|
|
|
|
*/
|
|
|
|
bool LoadFile(Path path);
|
2014-01-07 21:39:47 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|