Funkwhale
/
Clementine-audio-player-Mac-Linux-Windows
mirror of https://github.com/clementine-player/Clementine
1
0
Fork 0
Code Issues Releases Wiki Activity
Clementine-audio-player-Mac.../src/playlist/playlist.cpp

2352 lines
72 KiB
C++
Raw Blame History

/* This file is part of Clementine.
Copyright 2010, David Sansome <me@davidsansome.com>
Clementine 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 3 of the License, or
(at your option) any later version.
Clementine 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 Clementine. If not, see <http://www.gnu.org/licenses/>.
*/
#include "playlist.h"
#include <QApplication>
#include <QBuffer>
#include <QCoreApplication>
#include <QDirIterator>
#include <QFileInfo>
#include <QLinkedList>
#include <QMimeData>
#include <QMutableListIterator>
#include <QSortFilterProxyModel>
#include <QUndoStack>
#include <QtConcurrentRun>
#include <QtDebug>
#include <algorithm>
#include <functional>
#include <memory>
#include <unordered_map>
#if (QT_VERSION >= QT_VERSION_CHECK(5, 10, 0))
#include <QRandomGenerator>
#endif
#include "core/application.h"
#include "core/closure.h"
#include "core/logging.h"
#include "core/player.h"
#include "core/tagreaderclient.h"
#include "core/timeconstants.h"
#include "internet/core/internetmimedata.h"
#include "internet/core/internetmodel.h"
#include "internet/core/internetplaylistitem.h"
#include "internet/core/internetsongmimedata.h"
#include "internet/internetradio/savedradio.h"
#include "internet/jamendo/jamendoplaylistitem.h"
#include "internet/jamendo/jamendoservice.h"
#include "internet/magnatune/magnatuneplaylistitem.h"
#include "internet/magnatune/magnatuneservice.h"
#include "library/library.h"
#include "library/librarybackend.h"
#include "library/librarymodel.h"
#include "library/libraryplaylistitem.h"
#include "playlistbackend.h"
#include "playlistfilter.h"
#include "playlistitemmimedata.h"
#include "playlistundocommands.h"
#include "playlistview.h"
#include "queue.h"
#include "smartplaylists/generator.h"
#include "smartplaylists/generatorinserter.h"
#include "smartplaylists/generatormimedata.h"
#include "songloaderinserter.h"
#include "songmimedata.h"
#include "songplaylistitem.h"
using std::shared_ptr;
using std::unordered_map;
using std::placeholders::_1;
using std::placeholders::_2;
using smart_playlists::Generator;
using smart_playlists::GeneratorInserter;
using smart_playlists::GeneratorPtr;
const char* Playlist::kCddaMimeType = "x-content/audio-cdda";
const char* Playlist::kRowsMimetype = "application/x-clementine-playlist-rows";
const char* Playlist::kPlayNowMimetype = "application/x-clementine-play-now";
const int Playlist::kInvalidSongPriority = 200;
const QRgb Playlist::kInvalidSongColor = qRgb(0xC0, 0xC0, 0xC0);
const int Playlist::kDynamicHistoryPriority = 100;
const QRgb Playlist::kDynamicHistoryColor = qRgb(0x80, 0x80, 0x80);
const char* Playlist::kSettingsGroup = "Playlist";
const char* Playlist::kPathType = "path_type";
const char* Playlist::kWriteMetadata = "write_metadata";
const char* Playlist::kSortIgnorePrefix = "sort_ignore_prefix";
const char* Playlist::kSortIgnorePrefixList = "sort_ignore_prefix_list";
const int Playlist::kUndoStackSize = 20;
const int Playlist::kUndoItemLimit = 500;
const qint64 Playlist::kMinScrobblePointNsecs = 31ll * kNsecPerSec;
const qint64 Playlist::kMaxScrobblePointNsecs = 240ll * kNsecPerSec;
namespace {
QString removePrefix(const QString& a, const QStringList& prefixes) {
for (const QString& prefix : prefixes) {
if (a.startsWith(prefix)) {
return a.mid(prefix.size());
}
}
return a;
}
} // namespace
Playlist::Playlist(PlaylistBackend* backend, TaskManager* task_manager,
LibraryBackend* library, int id, const QString& special_type,
bool favorite, QObject* parent)
: QAbstractListModel(parent),
is_loading_(false),
proxy_(new PlaylistFilter(this)),
queue_(new Queue(this)),
backend_(backend),
task_manager_(task_manager),
library_(library),
id_(id),
favorite_(favorite),
current_is_paused_(false),
current_virtual_index_(-1),
is_shuffled_(false),
scrobble_point_(-1),
lastfm_status_(LastFM_New),
have_incremented_playcount_(false),
playlist_sequence_(nullptr),
ignore_sorting_(false),
undo_stack_(new QUndoStack(this)),
special_type_(special_type),
cancel_restore_(false) {
undo_stack_->setUndoLimit(kUndoStackSize);
connect(this, SIGNAL(rowsInserted(const QModelIndex&, int, int)),
SIGNAL(PlaylistChanged()));
connect(this, SIGNAL(rowsRemoved(const QModelIndex&, int, int)),
SIGNAL(PlaylistChanged()));
Restore();
proxy_->setSourceModel(this);
queue_->setSourceModel(this);
connect(queue_, SIGNAL(rowsAboutToBeRemoved(QModelIndex, int, int)),
SLOT(TracksAboutToBeDequeued(QModelIndex, int, int)));
connect(queue_, SIGNAL(rowsRemoved(QModelIndex, int, int)),
SLOT(TracksDequeued()));
connect(queue_, SIGNAL(rowsInserted(const QModelIndex&, int, int)),
SLOT(TracksEnqueued(const QModelIndex&, int, int)));
connect(queue_, SIGNAL(layoutChanged()), SLOT(QueueLayoutChanged()));
column_alignments_ = PlaylistView::DefaultColumnAlignment();
min_play_count_point_nsecs_ = (31ll * kNsecPerSec); // 30 seconds
QSettings settings;
settings.beginGroup(Player::kSettingsGroup);
if (settings.value("play_count_short_duration").toBool()) {
max_play_count_point_nsecs_ = (60ll * kNsecPerSec); // 1 minute
} else {
max_play_count_point_nsecs_ = (240ll * kNsecPerSec); // 4 minutes
}
settings.endGroup();
qLog(Debug) << "k_max_scrobble_point"
<< (max_play_count_point_nsecs_ / kNsecPerSec);
}
Playlist::~Playlist() {
items_.clear();
library_items_by_id_.clear();
}
template <typename T>
void Playlist::InsertSongItems(const SongList& songs, int pos, bool play_now,
bool enqueue, bool enqueue_next) {
PlaylistItemList items;
for (const Song& song : songs) {
items << PlaylistItemPtr(new T(song));
}
InsertItems(items, pos, play_now, enqueue, enqueue_next);
}
QVariant Playlist::headerData(int section, Qt::Orientation, int role) const {
if (role != Qt::DisplayRole && role != Qt::ToolTipRole) return QVariant();
const QString name = column_name((Playlist::Column)section);
if (!name.isEmpty()) return name;
return QVariant();
}
bool Playlist::column_is_editable(Playlist::Column column) {
switch (column) {
case Column_Title:
case Column_Artist:
case Column_Album:
case Column_AlbumArtist:
case Column_Composer:
case Column_Performer:
case Column_Grouping:
case Column_Track:
case Column_Disc:
case Column_Year:
case Column_Genre:
case Column_Score:
case Column_Comment:
return true;
default:
break;
}
return false;
}
bool Playlist::set_column_value(Song& song, Playlist::Column column,
const QVariant& value) {
if (!song.IsEditable()) return false;
switch (column) {
case Column_Title:
song.set_title(value.toString());
break;
case Column_Artist:
song.set_artist(value.toString());
break;
case Column_Album:
song.set_album(value.toString());
break;
case Column_AlbumArtist:
song.set_albumartist(value.toString());
break;
case Column_Composer:
song.set_composer(value.toString());
break;
case Column_Performer:
song.set_performer(value.toString());
break;
case Column_Grouping:
song.set_grouping(value.toString());
break;
case Column_Track:
song.set_track(value.toInt());
break;
case Column_Disc:
song.set_disc(value.toInt());
break;
case Column_Year:
song.set_year(value.toInt());
break;
case Column_Genre:
song.set_genre(value.toString());
break;
case Column_Score:
song.set_score(value.toInt());
break;
case Column_Comment:
song.set_comment(value.toString());
break;
default:
break;
}
return true;
}
QVariant Playlist::data(const QModelIndex& index, int role) const {
switch (role) {
case Role_IsCurrent:
return current_item_index_.isValid() &&
index.row() == current_item_index_.row();
case Role_IsPaused:
return current_is_paused_;
case Role_StopAfter:
return stop_after_.isValid() && stop_after_.row() == index.row();
case Role_QueuePosition:
return queue_->PositionOf(index);
case Role_CanSetRating:
return index.column() == Column_Rating &&
items_[index.row()]->IsLocalLibraryItem() &&
items_[index.row()]->Metadata().id() != -1;
case Qt::EditRole:
case Qt::ToolTipRole:
case Qt::DisplayRole: {
PlaylistItemPtr item = items_[index.row()];
Song song = item->Metadata();
// Don't forget to change Playlist::CompareItems when adding new columns
switch (index.column()) {
case Column_Title:
return song.PrettyTitle();
case Column_Artist:
return song.artist();
case Column_Album:
return song.album();
case Column_Length:
return song.length_nanosec();
case Column_Track:
return song.track();
case Column_Disc:
return song.disc();
case Column_Year:
return song.year();
case Column_OriginalYear:
return song.effective_originalyear();
case Column_Genre:
return song.genre();
case Column_AlbumArtist:
return song.playlist_albumartist();
case Column_Composer:
return song.composer();
case Column_Performer:
return song.performer();
case Column_Grouping:
return song.grouping();
case Column_Rating:
return song.rating();
case Column_PlayCount:
return song.playcount();
case Column_SkipCount:
return song.skipcount();
case Column_LastPlayed:
return song.lastplayed();
case Column_Score:
return song.score();
case Column_BPM:
return song.bpm();
case Column_Bitrate:
return song.bitrate();
case Column_Samplerate:
return song.samplerate();
case Column_Filename:
return song.url();
case Column_BaseFilename:
return song.basefilename();
case Column_Filesize:
return song.filesize();
case Column_Filetype:
return song.filetype();
case Column_DateModified:
return song.mtime();
case Column_DateCreated:
return song.ctime();
case Column_Comment:
if (role == Qt::DisplayRole) return song.comment().simplified();
return song.comment();
case Column_Source:
return item->Url();
}
return QVariant();
}
case Qt::TextAlignmentRole:
return QVariant(column_alignments_.value(
index.column(), (Qt::AlignLeft | Qt::AlignVCenter)));
case Qt::ForegroundRole:
if (data(index, Role_IsCurrent).toBool()) {
// Ignore any custom colours for the currently playing item - they might
// clash with the glowing current track indicator.
return QVariant();
}
if (items_[index.row()]->HasCurrentForegroundColor()) {
return QBrush(items_[index.row()]->GetCurrentForegroundColor());
}
if (index.row() < dynamic_history_length()) {
return QBrush(kDynamicHistoryColor);
}
return QVariant();
case Qt::BackgroundRole:
if (data(index, Role_IsCurrent).toBool()) {
// Ignore any custom colours for the currently playing item - they might
// clash with the glowing current track indicator.
return QVariant();
}
if (items_[index.row()]->HasCurrentBackgroundColor()) {
return QBrush(items_[index.row()]->GetCurrentBackgroundColor());
}
return QVariant();
case Qt::FontRole:
if (items_[index.row()]->GetShouldSkip()) {
QFont track_font;
track_font.setStrikeOut(true);
return track_font;
}
return QVariant();
default:
return QVariant();
}
}
void Playlist::MoodbarUpdated(const QModelIndex& index) {
emit dataChanged(index.sibling(index.row(), Column_Mood),
index.sibling(index.row(), Column_Mood));
}
bool Playlist::setData(const QModelIndex& index, const QVariant& value,
int role) {
int row = index.row();
PlaylistItemPtr item = item_at(row);
Song song = item->Metadata();
if (index.data() == value) return false;
if (!set_column_value(song, (Column)index.column(), value)) return false;
if ((Column)index.column() == Column_Score) {
// The score is only saved in the database, not the file
library_->AddOrUpdateSongs(SongList() << song);
emit EditingFinished(index);
} else {
TagReaderReply* reply =
TagReaderClient::Instance()->SaveFile(song.url().toLocalFile(), song);
NewClosure(reply, SIGNAL(Finished(bool)), this,
SLOT(SongSaveComplete(TagReaderReply*, QPersistentModelIndex)),
reply, QPersistentModelIndex(index));
}
return true;
}
void Playlist::SongSaveComplete(TagReaderReply* reply,
const QPersistentModelIndex& index) {
if (reply->is_successful() && index.isValid()) {
if (reply->message().save_file_response().success()) {
QFuture<void> future = item_at(index.row())->BackgroundReload();
NewClosure(future, this, SLOT(ItemReloadComplete(QPersistentModelIndex)),
index);
} else {
emit Error(
tr("An error occurred writing metadata to '%1'")
.arg(QString::fromStdString(
reply->request_message().save_file_request().filename())));
}
}
reply->deleteLater();
}
void Playlist::ItemReloadComplete(const QPersistentModelIndex& index) {
if (index.isValid()) {
emit dataChanged(index, index);
emit EditingFinished(index);
}
}
int Playlist::current_row() const {
return current_item_index_.isValid() ? current_item_index_.row() : -1;
}
const QModelIndex Playlist::current_index() const {
return current_item_index_;
}
int Playlist::last_played_row() const {
return last_played_item_index_.isValid() ? last_played_item_index_.row() : -1;
}
void Playlist::ShuffleModeChanged(PlaylistSequence::ShuffleMode mode) {
is_shuffled_ = (mode != PlaylistSequence::Shuffle_Off);
ReshuffleIndices();
}
bool Playlist::FilterContainsVirtualIndex(int i) const {
if (i < 0 || i >= virtual_items_.count()) return false;
return proxy_->filterAcceptsRow(virtual_items_[i], QModelIndex());
}
int Playlist::NextVirtualIndex(int i, bool ignore_repeat_track) const {
PlaylistSequence::RepeatMode repeat_mode = playlist_sequence_->repeat_mode();
PlaylistSequence::ShuffleMode shuffle_mode =
playlist_sequence_->shuffle_mode();
bool album_only = repeat_mode == PlaylistSequence::Repeat_Album ||
shuffle_mode == PlaylistSequence::Shuffle_InsideAlbum;
// This one's easy - if we have to repeat the current track then just return i
if (repeat_mode == PlaylistSequence::Repeat_Track && !ignore_repeat_track) {
if (!FilterContainsVirtualIndex(i))
return virtual_items_.count(); // It's not in the filter any more
return i;
}
// If we're not bothered about whether a song is on the same album then
// return the next virtual index, whatever it is.
if (!album_only) {
++i;
// Advance i until we find any track that is in the filter, skipping
// the selected to be skipped
while (i < virtual_items_.count() &&
(!FilterContainsVirtualIndex(i) ||
item_at(virtual_items_[i])->GetShouldSkip())) {
++i;
}
return i;
}
// We need to advance i until we get something else on the same album
Song last_song = current_item_metadata();
for (int j = i + 1; j < virtual_items_.count(); ++j) {
if (item_at(virtual_items_[j])->GetShouldSkip()) {
continue;
}
Song this_song = item_at(virtual_items_[j])->Metadata();
if (((last_song.is_compilation() && this_song.is_compilation()) ||
last_song.effective_albumartist() ==
this_song.effective_albumartist()) &&
last_song.album() == this_song.album() &&
FilterContainsVirtualIndex(j)) {
return j; // Found one
}
}
// Couldn't find one - return past the end of the list
return virtual_items_.count();
}
int Playlist::PreviousVirtualIndex(int i, bool ignore_repeat_track) const {
PlaylistSequence::RepeatMode repeat_mode = playlist_sequence_->repeat_mode();
PlaylistSequence::ShuffleMode shuffle_mode =
playlist_sequence_->shuffle_mode();
bool album_only = repeat_mode == PlaylistSequence::Repeat_Album ||
shuffle_mode == PlaylistSequence::Shuffle_InsideAlbum;
// This one's easy - if we have to repeat the current track then just return i
if (repeat_mode == PlaylistSequence::Repeat_Track && !ignore_repeat_track) {
if (!FilterContainsVirtualIndex(i)) return -1;
return i;
}
// If we're not bothered about whether a song is on the same album then
// return the previous virtual index, whatever it is.
if (!album_only) {
--i;
// Decrement i until we find any track that is in the filter
while (i >= 0 && (!FilterContainsVirtualIndex(i) ||
item_at(virtual_items_[i])->GetShouldSkip()))
--i;
return i;
}
// We need to decrement i until we get something else on the same album
Song last_song = current_item_metadata();
for (int j = i - 1; j >= 0; --j) {
if (item_at(virtual_items_[j])->GetShouldSkip()) {
continue;
}
Song this_song = item_at(virtual_items_[j])->Metadata();
if (((last_song.is_compilation() && this_song.is_compilation()) ||
last_song.artist() == this_song.artist()) &&
last_song.album() == this_song.album() &&
FilterContainsVirtualIndex(j)) {
return j; // Found one
}
}
// Couldn't find one - return before the start of the list
return -1;
}
int Playlist::next_row(bool ignore_repeat_track) const {
// Any queued items take priority
if (!queue_->is_empty()) {
return queue_->PeekNext();
}
int next_virtual_index =
NextVirtualIndex(current_virtual_index_, ignore_repeat_track);
if (next_virtual_index >= virtual_items_.count()) {
// We've gone off the end of the playlist.
switch (playlist_sequence_->repeat_mode()) {
case PlaylistSequence::Repeat_Off:
case PlaylistSequence::Repeat_Intro:
return -1;
case PlaylistSequence::Repeat_Track:
next_virtual_index = current_virtual_index_;
break;
default:
next_virtual_index = NextVirtualIndex(-1, ignore_repeat_track);
break;
}
}
// Still off the end? Then just give up
if (next_virtual_index < 0 || next_virtual_index >= virtual_items_.count())
return -1;
return virtual_items_[next_virtual_index];
}
int Playlist::previous_row(bool ignore_repeat_track) const {
int prev_virtual_index =
PreviousVirtualIndex(current_virtual_index_, ignore_repeat_track);
if (prev_virtual_index < 0) {
// We've gone off the beginning of the playlist.
switch (playlist_sequence_->repeat_mode()) {
case PlaylistSequence::Repeat_Off:
return -1;
case PlaylistSequence::Repeat_Track:
prev_virtual_index = current_virtual_index_;
break;
default:
prev_virtual_index =
PreviousVirtualIndex(virtual_items_.count(), ignore_repeat_track);
break;
}
}
// Still off the beginning? Then just give up
if (prev_virtual_index < 0) return -1;
return virtual_items_[prev_virtual_index];
}
int Playlist::dynamic_history_length() const {
return dynamic_playlist_ && last_played_item_index_.isValid()
? last_played_item_index_.row() + 1
: 0;
}
void Playlist::set_current_row(int i, bool is_stopping) {
QModelIndex old_current_item_index = current_item_index_;
ClearStreamMetadata();
current_item_index_ = QPersistentModelIndex(index(i, 0, QModelIndex()));
// if the given item is the first in the queue, remove it from the queue
if (current_item_index_.row() == queue_->PeekNext()) {
queue_->TakeNext();
}
if (current_item_index_ == old_current_item_index) return;
if (old_current_item_index.isValid()) {
emit dataChanged(old_current_item_index,
old_current_item_index.sibling(
old_current_item_index.row(), ColumnCount - 1));
}
// Update the virtual index
if (i == -1) {
current_virtual_index_ = -1;
} else if (is_shuffled_ && current_virtual_index_ == -1) {
// This is the first thing we're playing so we want to make sure the array
// is shuffled
ReshuffleIndices();
// Bring the one we've been asked to play to the start of the list
virtual_items_.takeAt(virtual_items_.indexOf(i));
virtual_items_.prepend(i);
current_virtual_index_ = 0;
} else if (is_shuffled_) {
current_virtual_index_ = virtual_items_.indexOf(i);
} else {
current_virtual_index_ = i;
}
if (current_item_index_.isValid() && !is_stopping) {
InformOfCurrentSongChange();
}
// The structure of a dynamic playlist is as follows:
// history - active song - future
// We have to ensure that this invariant is maintained.
if (dynamic_playlist_ && current_item_index_.isValid()) {
using smart_playlists::Generator;
// When advancing to the next track
if (i > old_current_item_index.row()) {
// Move the new item one position ahead of the last item in the history.
MoveItemWithoutUndo(current_item_index_.row(), dynamic_history_length());
// Compute the number of new items that have to be inserted. This is not
// necessarily 1 because the user might have added or removed items
// manually. Note that the future excludes the current item.
const int count = dynamic_history_length() + 1 +
dynamic_playlist_->GetDynamicFuture() - items_.count();
if (count > 0) {
InsertDynamicItems(count);
}
// Shrink the history, again this is not necessarily by 1, because the
// user might have moved items by hand.
const int remove_count =
dynamic_history_length() - dynamic_playlist_->GetDynamicHistory();
if (0 < remove_count) RemoveItemsWithoutUndo(0, remove_count);
}
// the above actions make all commands on the undo stack invalid, so we
// better clear it.
undo_stack_->clear();
}
if (current_item_index_.isValid()) {
last_played_item_index_ = current_item_index_;
Save();
}
UpdateScrobblePoint();
}
void Playlist::InsertDynamicItems(int count) {
GeneratorInserter* inserter =
new GeneratorInserter(task_manager_, library_, this);
connect(inserter, SIGNAL(Error(QString)), SIGNAL(Error(QString)));
connect(inserter, SIGNAL(PlayRequested(QModelIndex)),
SIGNAL(PlayRequested(QModelIndex)));
inserter->Load(this, -1, false, false, false, dynamic_playlist_, count);
}
Qt::ItemFlags Playlist::flags(const QModelIndex& index) const {
Qt::ItemFlags flags = Qt::ItemIsEnabled | Qt::ItemIsSelectable;
if (column_is_editable((Column)index.column())) flags |= Qt::ItemIsEditable;
if (index.isValid()) return flags | Qt::ItemIsDragEnabled;
return Qt::ItemIsDropEnabled;
}
QStringList Playlist::mimeTypes() const {
return QStringList() << "text/uri-list" << kRowsMimetype
<< LibraryModel::kSmartPlaylistsMimeType;
}
Qt::DropActions Playlist::supportedDropActions() const {
return Qt::MoveAction | Qt::CopyAction | Qt::LinkAction;
}
bool Playlist::dropMimeData(const QMimeData* data, Qt::DropAction action,
int row, int, const QModelIndex&) {
if (action == Qt::IgnoreAction) return false;
using smart_playlists::GeneratorMimeData;
bool play_now = false;
bool enqueue_now = false;
bool enqueue_next_now = false;
if (const MimeData* mime_data = qobject_cast<const MimeData*>(data)) {
if (mime_data->clear_first_) {
Clear();
}
play_now = mime_data->play_now_;
enqueue_now = mime_data->enqueue_now_;
enqueue_next_now = mime_data->enqueue_next_now_;
}
if (const SongMimeData* song_data = qobject_cast<const SongMimeData*>(data)) {
// Dragged from a library
// We want to check if these songs are from the actual local file backend,
// if they are we treat them differently.
if (song_data->backend &&
song_data->backend->songs_table() == Library::kSongsTable)
InsertSongItems<LibraryPlaylistItem>(song_data->songs, row, play_now,
enqueue_now, enqueue_next_now);
else if (song_data->backend &&
song_data->backend->songs_table() == MagnatuneService::kSongsTable)
InsertSongItems<MagnatunePlaylistItem>(song_data->songs, row, play_now,
enqueue_now, enqueue_next_now);
else if (song_data->backend &&
song_data->backend->songs_table() == JamendoService::kSongsTable)
InsertSongItems<JamendoPlaylistItem>(song_data->songs, row, play_now,
enqueue_now, enqueue_next_now);
else
InsertSongItems<SongPlaylistItem>(song_data->songs, row, play_now,
enqueue_now, enqueue_next_now);
} else if (const InternetMimeData* internet_data =
qobject_cast<const InternetMimeData*>(data)) {
// Dragged from the Internet pane
InsertInternetItems(internet_data->model, internet_data->indexes, row,
play_now, enqueue_now, enqueue_next_now);
} else if (const InternetSongMimeData* internet_song_data =
qobject_cast<const InternetSongMimeData*>(data)) {
InsertInternetItems(internet_song_data->service, internet_song_data->songs,
row, play_now, enqueue_now, enqueue_next_now);
} else if (const GeneratorMimeData* generator_data =
qobject_cast<const GeneratorMimeData*>(data)) {
InsertSmartPlaylist(generator_data->generator_, row, play_now, enqueue_now,
enqueue_next_now);
} else if (const PlaylistItemMimeData* item_data =
qobject_cast<const PlaylistItemMimeData*>(data)) {
InsertItems(item_data->items_, row, play_now, enqueue_now,
enqueue_next_now);
} else if (data->hasFormat(kRowsMimetype)) {
// Dragged from the playlist
// Rearranging it is tricky...
// Get the list of rows that were moved
QList<int> source_rows;
Playlist* source_playlist = nullptr;
qint64 pid = 0;
qint64 own_pid = QCoreApplication::applicationPid();
QDataStream stream(data->data(kRowsMimetype));
stream.readRawData(reinterpret_cast<char*>(&source_playlist),
sizeof(source_playlist));
stream >> source_rows;
if (!stream.atEnd()) {
stream.readRawData((char*)&pid, sizeof(pid));
} else {
pid = !own_pid;
}
std::stable_sort(source_rows.begin(),
source_rows.end()); // Make sure we take them in order
if (source_playlist == this) {
// Dragged from this playlist - rearrange the items
undo_stack_->push(
new PlaylistUndoCommands::MoveItems(this, source_rows, row));
} else if (pid == own_pid) {
// Drag from a different playlist
PlaylistItemList items;
for (int row : source_rows) items << source_playlist->item_at(row);
if (items.count() > kUndoItemLimit) {
// Too big to keep in the undo stack. Also clear the stack because it
// might have been invalidated.
InsertItemsWithoutUndo(items, row, false, false);
undo_stack_->clear();
} else {
undo_stack_->push(
new PlaylistUndoCommands::InsertItems(this, items, row));
}
// Remove the items from the source playlist if it was a move event
if (action == Qt::MoveAction) {
for (int row : source_rows) {
source_playlist->undo_stack()->push(
new PlaylistUndoCommands::RemoveItems(source_playlist, row, 1));
}
}
}
} else if (data->hasFormat(kCddaMimeType)) {
SongLoaderInserter* inserter = new SongLoaderInserter(
task_manager_, library_, backend_->app()->player());
connect(inserter, SIGNAL(Error(QString)), SIGNAL(Error(QString)));
inserter->LoadAudioCD(this, row, play_now, enqueue_now, enqueue_next_now);
} else if (data->hasUrls()) {
// URL list dragged from the file list or some other app
InsertUrls(data->urls(), row, play_now, enqueue_now, enqueue_next_now);
}
return true;
}
void Playlist::InsertUrls(const QList<QUrl>& urls, int pos, bool play_now,
bool enqueue, bool enqueue_next) {
SongLoaderInserter* inserter = new SongLoaderInserter(
task_manager_, library_, backend_->app()->player());
connect(inserter, SIGNAL(Error(QString)), SIGNAL(Error(QString)));
inserter->Load(this, pos, play_now, enqueue, enqueue_next, urls);
}
void Playlist::InsertSmartPlaylist(GeneratorPtr generator, int pos,
bool play_now, bool enqueue,
bool enqueue_next) {
// Hack: If the generator hasn't got a library set then use the main one
if (!generator->library()) {
generator->set_library(library_);
}
GeneratorInserter* inserter =
new GeneratorInserter(task_manager_, library_, this);
connect(inserter, SIGNAL(Error(QString)), SIGNAL(Error(QString)));
inserter->Load(this, pos, play_now, enqueue, enqueue_next, generator);
if (generator->is_dynamic()) {
TurnOnDynamicPlaylist(generator);
}
}
void Playlist::TurnOnDynamicPlaylist(GeneratorPtr gen) {
dynamic_playlist_ = gen;
playlist_sequence_->SetUsingDynamicPlaylist(true);
ShuffleModeChanged(PlaylistSequence::Shuffle_Off);
emit DynamicModeChanged(true);
Save();
}
void Playlist::MoveItemWithoutUndo(int source, int dest) {
MoveItemsWithoutUndo(QList<int>() << source, dest);
}
void Playlist::MoveItemsWithoutUndo(const QList<int>& source_rows, int pos) {
layoutAboutToBeChanged();
PlaylistItemList moved_items;
if (pos < 0) {
pos = items_.count();
}
// Take the items out of the list first, keeping track of whether the
// insertion point changes
int offset = 0;
int start = pos;
for (int source_row : source_rows) {
moved_items << items_.takeAt(source_row - offset);
if (pos > source_row) {
start--;
}
offset++;
}
// Put the items back in
for (int i = start; i < start + moved_items.count(); ++i) {
moved_items[i - start]->RemoveForegroundColor(kDynamicHistoryPriority);
items_.insert(i, moved_items[i - start]);
}
// Update persistent indexes
for (const QModelIndex& pidx : persistentIndexList()) {
const int dest_offset = source_rows.indexOf(pidx.row());
if (dest_offset != -1) {
// This index was moved
changePersistentIndex(
pidx, index(start + dest_offset, pidx.column(), QModelIndex()));
} else {
int d = 0;
for (int source_row : source_rows) {
if (pidx.row() > source_row) d--;
}
if (pidx.row() + d >= start) d += source_rows.count();
changePersistentIndex(
pidx, index(pidx.row() + d, pidx.column(), QModelIndex()));
}
}
current_virtual_index_ = virtual_items_.indexOf(current_row());
layoutChanged();
Save();
}
void Playlist::MoveItemsWithoutUndo(int start, const QList<int>& dest_rows) {
layoutAboutToBeChanged();
PlaylistItemList moved_items;
int pos = start;
for (int dest_row : dest_rows) {
if (dest_row < pos) start--;
}
if (start < 0) {
start = items_.count() - dest_rows.count();
}
// Take the items out of the list first
for (int i = 0; i < dest_rows.count(); i++)
moved_items << items_.takeAt(start);
// Put the items back in
int offset = 0;
for (int dest_row : dest_rows) {
items_.insert(dest_row, moved_items[offset]);
offset++;
}
// Update persistent indexes
for (const QModelIndex& pidx : persistentIndexList()) {
if (pidx.row() >= start && pidx.row() < start + dest_rows.count()) {
// This index was moved
const int i = pidx.row() - start;
changePersistentIndex(pidx,
index(dest_rows[i], pidx.column(), QModelIndex()));
} else {
int d = 0;
if (pidx.row() >= start + dest_rows.count()) d -= dest_rows.count();
for (int dest_row : dest_rows) {
if (pidx.row() + d > dest_row) d++;
}
changePersistentIndex(
pidx, index(pidx.row() + d, pidx.column(), QModelIndex()));
}
}
current_virtual_index_ = virtual_items_.indexOf(current_row());
layoutChanged();
Save();
}
void Playlist::InsertItems(const PlaylistItemList& itemsIn, int pos,
bool play_now, bool enqueue, bool enqueue_next) {
if (itemsIn.isEmpty()) return;
PlaylistItemList items = itemsIn;
// exercise vetoes
SongList songs;
for (PlaylistItemPtr item : items) {
songs << item->Metadata();
}
const int song_count = songs.length();
QSet<Song> vetoed;
for (SongInsertVetoListener* listener : veto_listeners_) {
for (const Song& song :
listener->AboutToInsertSongs(GetAllSongs(), songs)) {
// avoid veto-ing a song multiple times
vetoed.insert(song);
}
if (vetoed.count() == song_count) {
// all songs were vetoed and there's nothing more to do (there's no need
// for an undo step)
return;
}
}
if (!vetoed.isEmpty()) {
QMutableListIterator<PlaylistItemPtr> it(items);
while (it.hasNext()) {
PlaylistItemPtr item = it.next();
const Song& current = item->Metadata();
if (vetoed.contains(current)) {
vetoed.remove(current);
it.remove();
}
}
// check for empty items once again after veto
if (items.isEmpty()) {
return;
}
}
const int start = pos == -1 ? items_.count() : pos;
if (items.count() > kUndoItemLimit) {
// Too big to keep in the undo stack. Also clear the stack because it
// might have been invalidated.
InsertItemsWithoutUndo(items, pos, enqueue, enqueue_next);
undo_stack_->clear();
} else {
undo_stack_->push(new PlaylistUndoCommands::InsertItems(
this, items, pos, enqueue, enqueue_next));
}
if (play_now) emit PlayRequested(index(start, 0));
}
void Playlist::InsertItemsWithoutUndo(const PlaylistItemList& items, int pos,
bool enqueue, bool enqueue_next) {
if (items.isEmpty()) return;
const int start = pos == -1 ? items_.count() : pos;
const int end = start + items.count() - 1;
beginInsertRows(QModelIndex(), start, end);
for (int i = start; i <= end; ++i) {
PlaylistItemPtr item = items[i - start];
items_.insert(i, item);
virtual_items_ << virtual_items_.count();
if (item->IsLocalLibraryItem()) {
int id = item->Metadata().id();
if (id != -1) {
library_items_by_id_.insertMulti(id, item);
}
}
if (item == current_item()) {
// It's one we removed before that got re-added through an undo
current_item_index_ = index(i, 0);
last_played_item_index_ = current_item_index_;
}
}
endInsertRows();
if (enqueue) {
QModelIndexList indexes;
for (int i = start; i <= end; ++i) {
indexes << index(i, 0);
}
queue_->ToggleTracks(indexes);
}
if (enqueue_next) {
QModelIndexList indexes;
for (int i = start; i <= end; ++i) {
indexes << index(i, 0);
}
queue_->InsertFirst(indexes);
}
Save();
ReshuffleIndices();
}
void Playlist::InsertLibraryItems(const SongList& songs, int pos, bool play_now,
bool enqueue, bool enqueue_next) {
InsertSongItems<LibraryPlaylistItem>(songs, pos, play_now, enqueue,
enqueue_next);
}
void Playlist::InsertSongs(const SongList& songs, int pos, bool play_now,
bool enqueue, bool enqueue_next) {
InsertSongItems<SongPlaylistItem>(songs, pos, play_now, enqueue,
enqueue_next);
}
void Playlist::InsertSongsOrLibraryItems(const SongList& songs, int pos,
bool play_now, bool enqueue,
bool enqueue_next) {
PlaylistItemList items;
for (const Song& song : songs) {
if (song.is_library_song()) {
items << PlaylistItemPtr(new LibraryPlaylistItem(song));
} else {
items << PlaylistItemPtr(new SongPlaylistItem(song));
}
}
InsertItems(items, pos, play_now, enqueue, enqueue_next);
}
void Playlist::InsertInternetItems(const InternetModel* model,
const QModelIndexList& items, int pos,
bool play_now, bool enqueue,
bool enqueue_next) {
PlaylistItemList playlist_items;
QList<QUrl> song_urls;
for (const QModelIndex& item : items) {
switch (item.data(InternetModel::Role_PlayBehaviour).toInt()) {
case InternetModel::PlayBehaviour_SingleItem:
playlist_items << shared_ptr<PlaylistItem>(new InternetPlaylistItem(
model->ServiceForIndex(item),
item.data(InternetModel::Role_SongMetadata).value<Song>()));
break;
case InternetModel::PlayBehaviour_UseSongLoader:
song_urls << item.data(InternetModel::Role_Url).toUrl();
break;
}
}
if (!song_urls.isEmpty()) {
InsertUrls(song_urls, pos, play_now, enqueue, enqueue_next);
play_now = false;
}
InsertItems(playlist_items, pos, play_now, enqueue, enqueue_next);
}
void Playlist::InsertInternetItems(InternetService* service,
const SongList& songs, int pos,
bool play_now, bool enqueue,
bool enqueue_next) {
PlaylistItemList playlist_items;
for (const Song& song : songs) {
playlist_items << shared_ptr<PlaylistItem>(
new InternetPlaylistItem(service, song));
}
InsertItems(playlist_items, pos, play_now, enqueue, enqueue_next);
}
void Playlist::UpdateItems(const SongList& songs) {
qLog(Debug) << "Updating playlist with new tracks' info";
// We first convert our songs list into a linked list (a 'real' list),
// because removals are faster with QLinkedList.
// Next, we walk through the list of playlist's items then the list of songs
// we want to update: if an item corresponds to the song (we rely on URL for
// this), we update the item with the new metadata, then we remove song from
// our list because we will not need to check it again.
// And we also update undo actions.
QLinkedList<Song> songs_list;
for (const Song& song : songs) songs_list.append(song);
for (int i = 0; i < items_.size(); i++) {
// Update current items list
QMutableLinkedListIterator<Song> it(songs_list);
while (it.hasNext()) {
const Song& song = it.next();
PlaylistItemPtr& item = items_[i];
if (item->Metadata().url() == song.url() &&
(item->Metadata().filetype() == Song::Type_Unknown ||
// Stream may change and may need to be updated too
item->Metadata().filetype() == Song::Type_Stream ||
// And CD tracks as well (tags are loaded in a second step)
item->Metadata().filetype() == Song::Type_Cdda)) {
PlaylistItemPtr new_item;
if (song.is_library_song()) {
new_item = PlaylistItemPtr(new LibraryPlaylistItem(song));
library_items_by_id_.insertMulti(song.id(), new_item);
} else {
new_item = PlaylistItemPtr(new SongPlaylistItem(song));
}
items_[i] = new_item;
emit dataChanged(index(i, 0), index(i, ColumnCount - 1));
// Also update undo actions
for (int i = 0; i < undo_stack_->count(); i++) {
QUndoCommand* undo_action =
const_cast<QUndoCommand*>(undo_stack_->command(i));
PlaylistUndoCommands::InsertItems* undo_action_insert =
dynamic_cast<PlaylistUndoCommands::InsertItems*>(undo_action);
if (undo_action_insert) {
bool found_and_updated = undo_action_insert->UpdateItem(new_item);
if (found_and_updated) break;
}
}
it.remove();
break;
}
}
}
Save();
}
QMimeData* Playlist::mimeData(const QModelIndexList& indexes) const {
if (indexes.isEmpty()) return nullptr;
// We only want one index per row, but we can't just take column 0 because
// the user might have hidden it.
const int first_column = indexes.first().column();
QMimeData* data = new QMimeData;
QList<QUrl> urls;
QList<int> rows;
for (const QModelIndex& index : indexes) {
if (index.column() != first_column) continue;
urls << items_[index.row()]->Url();
rows << index.row();
}
QBuffer buf;
buf.open(QIODevice::WriteOnly);
QDataStream stream(&buf);
const Playlist* self = this;
const qint64 pid = QCoreApplication::applicationPid();
stream.writeRawData(reinterpret_cast<char*>(&self), sizeof(self));
stream << rows;
stream.writeRawData((char*)&pid, sizeof(pid));
buf.close();
data->setUrls(urls);
data->setData(kRowsMimetype, buf.data());
return data;
}
bool Playlist::CompareItems(int column, Qt::SortOrder order,
shared_ptr<PlaylistItem> _a,
shared_ptr<PlaylistItem> _b,
const QStringList& prefixes) {
shared_ptr<PlaylistItem> a = order == Qt::AscendingOrder ? _a : _b;
shared_ptr<PlaylistItem> b = order == Qt::AscendingOrder ? _b : _a;
#define cmp(field) return a->Metadata().field() < b->Metadata().field()
#define strcmp(field) \
return QString::localeAwareCompare( \
removePrefix(a->Metadata().field().toLower(), prefixes), \
removePrefix(b->Metadata().field().toLower(), prefixes)) < 0;
switch (column) {
case Column_Title:
strcmp(title);
case Column_Artist:
strcmp(artist);
case Column_Album:
strcmp(album);
case Column_Length:
cmp(length_nanosec);
case Column_Track:
cmp(track);
case Column_Disc:
cmp(disc);
case Column_Year:
cmp(year);
case Column_OriginalYear:
cmp(originalyear);
case Column_Genre:
strcmp(genre);
case Column_AlbumArtist:
strcmp(playlist_albumartist);
case Column_Composer:
strcmp(composer);
case Column_Performer:
strcmp(performer);
case Column_Grouping:
strcmp(grouping);
case Column_Rating:
cmp(rating);
case Column_PlayCount:
cmp(playcount);
case Column_SkipCount:
cmp(skipcount);
case Column_LastPlayed:
cmp(lastplayed);
case Column_Score:
cmp(score);
case Column_BPM:
cmp(bpm);
case Column_Bitrate:
cmp(bitrate);
case Column_Samplerate:
cmp(samplerate);
case Column_Filename:
return (QString::localeAwareCompare(a->Url().path().toLower(),
b->Url().path().toLower()) < 0);
case Column_BaseFilename:
cmp(basefilename);
case Column_Filesize:
cmp(filesize);
case Column_Filetype:
cmp(filetype);
case Column_DateModified:
cmp(mtime);
case Column_DateCreated:
cmp(ctime);
case Column_Comment:
strcmp(comment);
case Column_Source:
cmp(url);
}
#undef cmp
#undef strcmp
return false;
}
bool Playlist::ComparePathDepths(Qt::SortOrder order,
shared_ptr<PlaylistItem> _a,
shared_ptr<PlaylistItem> _b) {
shared_ptr<PlaylistItem> a = order == Qt::AscendingOrder ? _a : _b;
shared_ptr<PlaylistItem> b = order == Qt::AscendingOrder ? _b : _a;
int a_dir_level = a->Url().path().count('/');
int b_dir_level = b->Url().path().count('/');
return a_dir_level < b_dir_level;
}
QString Playlist::column_name(Column column) {
switch (column) {
case Column_Title:
return tr("Title");
case Column_Artist:
return tr("Artist");
case Column_Album:
return tr("Album");
case Column_Length:
return tr("Length");
case Column_Track:
return tr("Track");
case Column_Disc:
return tr("Disc");
case Column_Year:
return tr("Year");
case Column_OriginalYear:
return tr("Year - original"); //: Done like this so sorts beside "Year"
// when editing smart playlists
case Column_Genre:
return tr("Genre");
case Column_AlbumArtist:
return tr("Album artist");
case Column_Composer:
return tr("Composer");
case Column_Performer:
return tr("Performer");
case Column_Grouping:
return tr("Grouping");
case Column_Rating:
return tr("Rating");
case Column_PlayCount:
return tr("Play count");
case Column_SkipCount:
return tr("Skip count");
case Column_LastPlayed:
return tr("Last played", "A playlist's tag.");
case Column_Score:
return tr("Score");
case Column_BPM:
return tr("BPM");
case Column_Bitrate:
return tr("Bit rate");
case Column_Samplerate:
return tr("Sample rate");
case Column_Filename:
return tr("File name");
case Column_BaseFilename:
return tr("File name (without path)");
case Column_Filesize:
return tr("File size");
case Column_Filetype:
return tr("File type");
case Column_DateModified:
return tr("Date modified");
case Column_DateCreated:
return tr("Date created");
case Column_Comment:
return tr("Comment");
case Column_Source:
return tr("Source");
case Column_Mood:
return tr("Mood");
default:
return QString();
}
return "";
}
QString Playlist::abbreviated_column_name(Column column) {
const QString& column_name = Playlist::column_name(column);
switch (column) {
case Column_Disc:
case Column_PlayCount:
case Column_SkipCount:
case Column_Track:
return QString("%1#").arg(column_name[0]);
default:
return column_name;
}
return "";
}
void Playlist::sort(int column, Qt::SortOrder order) {
if (ignore_sorting_) return;
PlaylistItemList new_items(items_);
PlaylistItemList::iterator begin = new_items.begin();
if (dynamic_playlist_ && current_item_index_.isValid())
begin += current_item_index_.row() + 1;
QSettings s;
s.beginGroup(Playlist::kSettingsGroup);
QStringList prefixes;
if ((column == Column_Album || column == Column_Artist ||
column == Column_Title) &&
s.value(Playlist::kSortIgnorePrefix, false).toBool()) {
prefixes = s.value(Playlist::kSortIgnorePrefixList, QString())
.toString()
.split(',');
for (QString& prefix : prefixes) {
prefix = prefix.trimmed() + ' ';
}
}
s.endGroup();
if (column == Column_Album) {
// When sorting by album, also take into account discs and tracks.
std::stable_sort(begin, new_items.end(),
std::bind(&Playlist::CompareItems, Column_Track, order, _1,
_2, prefixes));
std::stable_sort(begin, new_items.end(),
std::bind(&Playlist::CompareItems, Column_Disc, order, _1,
_2, prefixes));
std::stable_sort(begin, new_items.end(),
std::bind(&Playlist::CompareItems, Column_Album, order, _1,
_2, prefixes));
} else if (column == Column_Filename) {
// When sorting by full paths we also expect a hierarchical order. This
// returns a breath-first ordering of paths.
std::stable_sort(begin, new_items.end(),
std::bind(&Playlist::CompareItems, Column_Filename, order,
_1, _2, prefixes));
std::stable_sort(begin, new_items.end(),
std::bind(&Playlist::ComparePathDepths, order, _1, _2));
} else {
std::stable_sort(
begin, new_items.end(),
std::bind(&Playlist::CompareItems, column, order, _1, _2, prefixes));
}
undo_stack_->push(
new PlaylistUndoCommands::SortItems(this, column, order, new_items));
ReshuffleIndices();
}
void Playlist::ReOrderWithoutUndo(const PlaylistItemList& new_items) {
layoutAboutToBeChanged();
PlaylistItemList old_items = items_;
items_ = new_items;
QMap<const PlaylistItem*, int> new_rows;
for (int i = 0; i < new_items.length(); ++i) {
new_rows[new_items[i].get()] = i;
}
for (const QModelIndex& idx : persistentIndexList()) {
const PlaylistItem* item = old_items[idx.row()].get();
changePersistentIndex(idx,
index(new_rows[item], idx.column(), idx.parent()));
}
layoutChanged();
emit PlaylistChanged();
Save();
}
void Playlist::Playing() { SetCurrentIsPaused(false); }
void Playlist::Paused() { SetCurrentIsPaused(true); }
void Playlist::Stopped() { SetCurrentIsPaused(false); }
void Playlist::SetCurrentIsPaused(bool paused) {
if (paused == current_is_paused_) return;
current_is_paused_ = paused;
if (current_item_index_.isValid())
dataChanged(index(current_item_index_.row(), 0),
index(current_item_index_.row(), ColumnCount - 1));
}
void Playlist::Save() const {
if (!backend_ || is_loading_) return;
backend_->SavePlaylistAsync(id_, items_, last_played_row(),
dynamic_playlist_);
}
void Playlist::Restore() {
if (!backend_) return;
items_.clear();
virtual_items_.clear();
library_items_by_id_.clear();
cancel_restore_ = false;
QFuture<QList<PlaylistItemPtr>> future =
QtConcurrent::run(backend_, &PlaylistBackend::GetPlaylistItems, id_);
NewClosure(future, this, SLOT(ItemsLoaded(QFuture<PlaylistItemList>)),
future);
}
void Playlist::ItemsLoaded(QFuture<PlaylistItemList> future) {
if (cancel_restore_) return;
PlaylistItemList items = future.result();
// backend returns empty elements for library items which it couldn't
// match (because they got deleted); we don't need those
QMutableListIterator<PlaylistItemPtr> it(items);
while (it.hasNext()) {
PlaylistItemPtr item = it.next();
if (item->IsLocalLibraryItem() && item->Metadata().url().isEmpty()) {
it.remove();
}
}
is_loading_ = true;
InsertItems(items, 0);
is_loading_ = false;
PlaylistBackend::Playlist p = backend_->GetPlaylist(id_);
// the newly loaded list of items might be shorter than it was before so
// look out for a bad last_played index
last_played_item_index_ = p.last_played == -1 || p.last_played >= rowCount()
? QModelIndex()
: index(p.last_played);
if (!p.dynamic_type.isEmpty()) {
GeneratorPtr gen = Generator::Create(p.dynamic_type);
if (gen) {
// Hack: can't think of a better way to get the right backend
LibraryBackend* backend = nullptr;
if (p.dynamic_backend == library_->songs_table())
backend = library_;
else if (p.dynamic_backend == MagnatuneService::kSongsTable)
backend = InternetModel::Service<MagnatuneService>()->library_backend();
else if (p.dynamic_backend == JamendoService::kSongsTable)
backend = InternetModel::Service<JamendoService>()->library_backend();
if (backend) {
gen->set_library(backend);
gen->Load(p.dynamic_data);
TurnOnDynamicPlaylist(gen);
}
}
}
emit RestoreFinished();
QSettings s;
s.beginGroup(kSettingsGroup);
// should we gray out deleted songs asynchronously on startup?
if (s.value("greyoutdeleted", false).toBool()) {
QtConcurrent::run(this, &Playlist::InvalidateDeletedSongs);
}
}
static bool DescendingIntLessThan(int a, int b) { return a > b; }
void Playlist::RemoveItemsWithoutUndo(const QList<int>& indicesIn) {
// Sort the indices descending because removing elements 'backwards'
// is easier - indices don't 'move' in the process.
QList<int> indices = indicesIn;
std::sort(indices.begin(), indices.end(), DescendingIntLessThan);
for (int j = 0; j < indices.count(); j++) {
int beginning = indices[j], end = indices[j];
// Splits the indices into sequences. For example this: [1, 2, 4],
// will get split into [1, 2] and [4].
while (j != indices.count() - 1 && indices[j] == indices[j + 1] + 1) {
beginning--;
j++;
}
// Remove the current sequence.
removeRows(beginning, end - beginning + 1);
}
}
bool Playlist::removeRows(int row, int count, const QModelIndex& parent) {
if (row < 0 || row >= items_.size() || row + count > items_.size()) {
return false;
}
if (count > kUndoItemLimit) {
// Too big to keep in the undo stack. Also clear the stack because it
// might have been invalidated.
RemoveItemsWithoutUndo(row, count);
undo_stack_->clear();
} else if (parent == QModelIndex()) {
RemoveItemsWithoutUndo(row, count);
} else {
undo_stack_->push(new PlaylistUndoCommands::RemoveItems(this, row, count));
}
return true;
}
bool Playlist::removeRows(QList<int>& rows) {
if (rows.isEmpty()) {
return false;
}
// start from the end to be sure that indices won't 'move' during
// the removal process
std::sort(rows.begin(), rows.end(), std::greater<int>());
QList<int> part;
while (!rows.isEmpty()) {
// we're splitting the input list into sequences of consecutive
// numbers
part.append(rows.takeFirst());
while (!rows.isEmpty() && rows.first() == part.last() - 1) {
part.append(rows.takeFirst());
}
// and now we're removing the current sequence
if (!removeRows(part.last(), part.size())) {
return false;
}
part.clear();
}
return true;
}
PlaylistItemList Playlist::RemoveItemsWithoutUndo(int row, int count) {
if (row < 0 || row >= items_.size() || row + count > items_.size()) {
return PlaylistItemList();
}
beginRemoveRows(QModelIndex(), row, row + count - 1);
// Remove items
PlaylistItemList ret;
for (int i = 0; i < count; ++i) {
PlaylistItemPtr item(items_.takeAt(row));
ret << item;
if (item->IsLocalLibraryItem()) {
int id = item->Metadata().id();
if (id != -1) {
library_items_by_id_.remove(id, item);
}
}
}
endRemoveRows();
QList<int>::iterator it = virtual_items_.begin();
int i = 0;
while (it != virtual_items_.end()) {
if (*it >= items_.count())
it = virtual_items_.erase(it);
else
++it;
++i;
}
// Reset current_virtual_index_
if (current_row() == -1)
if (row - 1 > 0 && row - 1 < items_.size()) {
current_virtual_index_ = virtual_items_.indexOf(row - 1);
} else {
current_virtual_index_ = -1;
}
else
current_virtual_index_ = virtual_items_.indexOf(current_row());
Save();
return ret;
}
void Playlist::StopAfter(int row) {
QModelIndex old_stop_after = stop_after_;
if ((stop_after_.isValid() && stop_after_.row() == row) || row == -1)
stop_after_ = QModelIndex();
else
stop_after_ = index(row, 0);
if (old_stop_after.isValid())
emit dataChanged(
old_stop_after,
old_stop_after.sibling(old_stop_after.row(), ColumnCount - 1));
if (stop_after_.isValid())
emit dataChanged(stop_after_,
stop_after_.sibling(stop_after_.row(), ColumnCount - 1));
}
void Playlist::SetStreamMetadata(const QUrl& url, const Song& song) {
if (!current_item()) return;
if (current_item()->Url() != url) return;
// Don't update the metadata if it's only a minor change from before
if (current_item()->Metadata().artist() == song.artist() &&
current_item()->Metadata().title() == song.title())
return;
current_item()->SetTemporaryMetadata(song);
UpdateScrobblePoint();
InformOfCurrentSongChange();
}
void Playlist::ClearStreamMetadata() {
if (!current_item()) return;
current_item()->ClearTemporaryMetadata();
UpdateScrobblePoint();
emit dataChanged(index(current_item_index_.row(), 0),
index(current_item_index_.row(), ColumnCount - 1));
}
bool Playlist::stop_after_current() const {
PlaylistSequence::RepeatMode repeat_mode = playlist_sequence_->repeat_mode();
if (repeat_mode == PlaylistSequence::Repeat_OneByOne) {
return true;
}
return stop_after_.isValid() && current_item_index_.isValid() &&
stop_after_.row() == current_item_index_.row();
}
PlaylistItemPtr Playlist::current_item() const {
// QList[] runs in constant time, so no need to cache current_item
if (current_item_index_.isValid() &&
current_item_index_.row() <= items_.length())
return items_[current_item_index_.row()];
return PlaylistItemPtr();
}
PlaylistItem::Options Playlist::current_item_options() const {
if (!current_item()) return PlaylistItem::Default;
return current_item()->options();
}
Song Playlist::current_item_metadata() const {
if (!current_item()) return Song();
return current_item()->Metadata();
}
/**
* Last.fm defines a track to be scrobbled when
* - the track is longer than 30 seconds
* - the track has been played for at least half its duration, or for 4 minutes
* (whichever occurs earlier.)
*
* If you seek a track, the scrobble point is recalculated from the point seeked
* to (as 50% or 4 minutes).
*/
void Playlist::UpdateScrobblePoint(qint64 seek_point_nanosec) {
const qint64 length = current_item_metadata().length_nanosec();
if (seek_point_nanosec == 0) {
if (length == 0) {
scrobble_point_ = kMaxScrobblePointNsecs; // 4 minutes
} else {
scrobble_point_ =
qBound(kMinScrobblePointNsecs, length / 2, kMaxScrobblePointNsecs);
}
} else {
if (length == 0) {
// current time + 4 minutes
scrobble_point_ = seek_point_nanosec + kMaxScrobblePointNsecs;
} else {
scrobble_point_ = qBound(seek_point_nanosec + kMinScrobblePointNsecs,
seek_point_nanosec + (length / 2),
seek_point_nanosec + kMaxScrobblePointNsecs);
}
}
set_lastfm_status(LastFM_New);
UpdatePlayCountPoint(seek_point_nanosec);
}
/**
* Initially the play count tracking and scrobbling went hand in hand.
* However, it is is possible that someone's preferences for tracking play
* counts are more relaxed than that of scrobbling. For those cases, we use
* the following algorithm to track whether a song should increment it's play
* count or not.
*
* Note that that this is very similar to the scrobbling algorithm with the only
* difference that the requirement of 4 mins worth of listening is now
* configurable via the `max_play_count_point_nsecs_` parameter.
*/
void Playlist::UpdatePlayCountPoint(qint64 seek_point_nanosec) {
const qint64 length = current_item_metadata().length_nanosec();
if (seek_point_nanosec == 0) {
if (length == 0) {
play_count_point_ = max_play_count_point_nsecs_; // 4 minutes
} else {
play_count_point_ = qBound(min_play_count_point_nsecs_, length / 2,
max_play_count_point_nsecs_);
}
} else {
if (length == 0) {
play_count_point_ = seek_point_nanosec + max_play_count_point_nsecs_;
} else {
play_count_point_ =
qBound(seek_point_nanosec + min_play_count_point_nsecs_,
seek_point_nanosec + (length / 2),
seek_point_nanosec + max_play_count_point_nsecs_);
}
}
have_incremented_playcount_ = false;
}
void Playlist::Clear() {
// If loading songs from session restore async, don't insert them
cancel_restore_ = true;
const int count = items_.count();
if (count > kUndoItemLimit) {
// Too big to keep in the undo stack. Also clear the stack because it
// might have been invalidated.
RemoveItemsWithoutUndo(0, count);
undo_stack_->clear();
} else {
undo_stack_->push(new PlaylistUndoCommands::RemoveItems(this, 0, count));
}
TurnOffDynamicPlaylist();
Save();
}
void Playlist::TurnOffDynamicPlaylist() {
dynamic_playlist_.reset();
if (playlist_sequence_) {
playlist_sequence_->SetUsingDynamicPlaylist(false);
ShuffleModeChanged(playlist_sequence_->shuffle_mode());
}
emit DynamicModeChanged(false);
Save();
}
void Playlist::RepopulateDynamicPlaylist() {
if (!dynamic_playlist_) return;
RemoveItemsNotInQueue();
InsertSmartPlaylist(dynamic_playlist_);
}
void Playlist::ExpandDynamicPlaylist() {
if (!dynamic_playlist_) return;
InsertDynamicItems(5);
}
void Playlist::RemoveItemsNotInQueue() {
if (queue_->is_empty() && !current_item_index_.isValid()) {
RemoveItemsWithoutUndo(0, items_.count());
return;
}
int start = 0;
forever {
// Find a place to start - first row that isn't in the queue
forever {
if (start >= rowCount()) return;
if (!queue_->ContainsSourceRow(start) && current_row() != start) break;
start++;
}
// Figure out how many rows to remove - keep going until we find a row
// that is in the queue
int count = 1;
forever {
if (start + count >= rowCount()) break;
if (queue_->ContainsSourceRow(start + count) ||
current_row() == start + count)
break;
count++;
}
RemoveItemsWithoutUndo(start, count);
start++;
}
}
void Playlist::ReloadItems(const QList<int>& rows) {
for (int row : rows) {
PlaylistItemPtr item = item_at(row);
item->Reload();
if (row == current_row()) {
InformOfCurrentSongChange();
} else {
emit dataChanged(index(row, 0), index(row, ColumnCount - 1));
}
}
Save();
}
void Playlist::RateSong(const QModelIndex& index, double rating) {
int row = index.row();
if (has_item_at(row)) {
PlaylistItemPtr item = item_at(row);
if (item && item->IsLocalLibraryItem() && item->Metadata().id() != -1) {
library_->UpdateSongRatingAsync(item->Metadata().id(), rating);
}
}
}
void Playlist::RateSongs(const QModelIndexList& index_list, double rating) {
QList<int> id_list;
for (const QModelIndex& index : index_list) {
int row = index.row();
if (has_item_at(row)) {
PlaylistItemPtr item = item_at(row);
if (item && item->IsLocalLibraryItem() && item->Metadata().id() != -1) {
id_list << item->Metadata().id();
}
}
}
library_->UpdateSongsRatingAsync(id_list, rating);
}
void Playlist::AddSongInsertVetoListener(SongInsertVetoListener* listener) {
veto_listeners_.append(listener);
connect(listener, SIGNAL(destroyed()), this,
SLOT(SongInsertVetoListenerDestroyed()));
}
void Playlist::RemoveSongInsertVetoListener(SongInsertVetoListener* listener) {
disconnect(listener, SIGNAL(destroyed()), this,
SLOT(SongInsertVetoListenerDestroyed()));
veto_listeners_.removeAll(listener);
}
void Playlist::SongInsertVetoListenerDestroyed() {
veto_listeners_.removeAll(qobject_cast<SongInsertVetoListener*>(sender()));
}
void Playlist::Shuffle() {
PlaylistItemList new_items(items_);
int begin = 0;
if (dynamic_playlist_ && current_item_index_.isValid())
begin += current_item_index_.row() + 1;
const int count = items_.count();
for (int i = begin; i < count; ++i) {
#if (QT_VERSION < QT_VERSION_CHECK(5, 10, 0))
int new_pos = i + (qrand() % (count - i));
#else
int new_pos = QRandomGenerator::global()->bounded(i, count);
#endif
std::swap(new_items[i], new_items[new_pos]);
}
undo_stack_->push(new PlaylistUndoCommands::ShuffleItems(this, new_items));
}
namespace {
bool AlbumShuffleComparator(const QMap<QString, int>& album_key_positions,
const QMap<int, QString>& album_keys, int left,
int right) {
const int left_pos = album_key_positions[album_keys[left]];
const int right_pos = album_key_positions[album_keys[right]];
if (left_pos == right_pos) return left < right;
return left_pos < right_pos;
}
} // namespace
void Playlist::ReshuffleIndices() {
if (!playlist_sequence_) {
return;
}
if (playlist_sequence_->shuffle_mode() == PlaylistSequence::Shuffle_Off) {
// No shuffling - sort the virtual item list normally.
std::sort(virtual_items_.begin(), virtual_items_.end());
if (current_row() != -1)
current_virtual_index_ = virtual_items_.indexOf(current_row());
return;
}
// If the user is already playing a song, advance the begin iterator to
// only shuffle items that haven't been played yet.
QList<int>::iterator begin = virtual_items_.begin();
QList<int>::iterator end = virtual_items_.end();
if (current_virtual_index_ != -1)
std::advance(begin, current_virtual_index_ + 1);
switch (playlist_sequence_->shuffle_mode()) {
case PlaylistSequence::Shuffle_Off:
// Handled above.
break;
case PlaylistSequence::Shuffle_All:
case PlaylistSequence::Shuffle_InsideAlbum:
std::random_shuffle(begin, end);
break;
case PlaylistSequence::Shuffle_Albums: {
QMap<int, QString> album_keys; // real index -> key
QSet<QString> album_key_set; // unique keys
// Find all the unique albums in the playlist
for (QList<int>::iterator it = begin; it != end; ++it) {
const int index = *it;
const QString key = items_[index]->Metadata().AlbumKey();
album_keys[index] = key;
album_key_set << key;
}
// Shuffle them
QStringList shuffled_album_keys = album_key_set.values();
std::random_shuffle(shuffled_album_keys.begin(),
shuffled_album_keys.end());
// If the user is currently playing a song, force its album to be first
// Or if the song was not playing but it was selected, force its album
// to be first.
if (current_virtual_index_ != -1 || current_row() != -1) {
const QString key = items_[current_row()]->Metadata().AlbumKey();
const int pos = shuffled_album_keys.indexOf(key);
if (pos >= 1) {
std::swap(shuffled_album_keys[0], shuffled_album_keys[pos]);
}
}
// Create album key -> position mapping for fast lookup
QMap<QString, int> album_key_positions;
for (int i = 0; i < shuffled_album_keys.count(); ++i) {
album_key_positions[shuffled_album_keys[i]] = i;
}
// Sort the virtual items
std::stable_sort(begin, end,
std::bind(AlbumShuffleComparator, album_key_positions,
album_keys, _1, _2));
break;
}
}
}
void Playlist::set_sequence(PlaylistSequence* v) {
playlist_sequence_ = v;
connect(v, SIGNAL(ShuffleModeChanged(PlaylistSequence::ShuffleMode)),
SLOT(ShuffleModeChanged(PlaylistSequence::ShuffleMode)));
ShuffleModeChanged(v->shuffle_mode());
}
QSortFilterProxyModel* Playlist::proxy() const { return proxy_; }
SongList Playlist::GetAllSongs() const {
SongList ret;
for (PlaylistItemPtr item : items_) {
ret << item->Metadata();
}
return ret;
}
PlaylistItemList Playlist::GetAllItems() const { return items_; }
quint64 Playlist::GetTotalLength() const {
quint64 ret = 0;
for (PlaylistItemPtr item : items_) {
quint64 length = item->Metadata().length_nanosec();
if (length > 0) ret += length;
}
return ret;
}
PlaylistItemList Playlist::library_items_by_id(int id) const {
return library_items_by_id_.values(id);
}
void Playlist::TracksAboutToBeDequeued(const QModelIndex&, int begin, int end) {
for (int i = begin; i <= end; ++i) {
temp_dequeue_change_indexes_
<< queue_->mapToSource(queue_->index(i, Column_Title));
}
}
void Playlist::TracksDequeued() {
for (const QModelIndex& index : temp_dequeue_change_indexes_) {
emit dataChanged(index, index);
}
temp_dequeue_change_indexes_.clear();
emit QueueChanged();
}
void Playlist::TracksEnqueued(const QModelIndex&, int begin, int end) {
const QModelIndex& b =
queue_->mapToSource(queue_->index(begin, Column_Title));
const QModelIndex& e = queue_->mapToSource(queue_->index(end, Column_Title));
emit dataChanged(b, e);
}
void Playlist::QueueLayoutChanged() {
for (int i = 0; i < queue_->rowCount(); ++i) {
const QModelIndex& index =
queue_->mapToSource(queue_->index(i, Column_Title));
emit dataChanged(index, index);
}
}
void Playlist::ItemChanged(PlaylistItemPtr item) {
for (int row = 0; row < items_.count(); ++row) {
if (items_[row] == item) {
emit dataChanged(index(row, 0), index(row, ColumnCount - 1));
return;
}
}
}
void Playlist::InformOfCurrentSongChange() {
emit dataChanged(index(current_item_index_.row(), 0),
index(current_item_index_.row(), ColumnCount - 1));
// if the song is invalid, we won't play it - there's no point in
// informing anybody about the change
const Song metadata(current_item_metadata());
if (metadata.is_valid()) {
emit CurrentSongChanged(metadata);
}
}
void Playlist::InvalidateDeletedSongs() {
QList<int> invalidated_rows;
for (int row = 0; row < items_.count(); ++row) {
PlaylistItemPtr item = items_[row];
Song song = item->Metadata();
if (!song.is_stream()) {
bool exists = QFile::exists(song.url().toLocalFile());
if (!exists && !item->HasForegroundColor(kInvalidSongPriority)) {
// gray out the song if it's not there
item->SetForegroundColor(kInvalidSongPriority, kInvalidSongColor);
invalidated_rows.append(row);
} else if (exists && item->HasForegroundColor(kInvalidSongPriority)) {
item->RemoveForegroundColor(kInvalidSongPriority);
invalidated_rows.append(row);
}
}
}
ReloadItems(invalidated_rows);
}
void Playlist::RemoveDeletedSongs() {
QList<int> rows_to_remove;
for (int row = 0; row < items_.count(); ++row) {
PlaylistItemPtr item = items_[row];
Song song = item->Metadata();
if (!song.is_stream() && !QFile::exists(song.url().toLocalFile())) {
rows_to_remove.append(row);
}
}
removeRows(rows_to_remove);
}
struct SongSimilarHash {
long operator()(const Song& song) const { return HashSimilar(song); }
};
struct SongSimilarEqual {
long operator()(const Song& song1, const Song& song2) const {
return song1.IsSimilar(song2);
}
};
void Playlist::RemoveDuplicateSongs() {
QList<int> rows_to_remove;
unordered_map<Song, int, SongSimilarHash, SongSimilarEqual> unique_songs;
for (int row = 0; row < items_.count(); ++row) {
PlaylistItemPtr item = items_[row];
const Song& song = item->Metadata();
bool found_duplicate = false;
auto uniq_song_it = unique_songs.find(song);
if (uniq_song_it != unique_songs.end()) {
const Song& uniq_song = uniq_song_it->first;
if (song.bitrate() > uniq_song.bitrate()) {
rows_to_remove.append(unique_songs[uniq_song]);
unique_songs.erase(uniq_song);
unique_songs.insert(std::make_pair(song, row));
} else {
rows_to_remove.append(row);
}
found_duplicate = true;
}
if (!found_duplicate) {
unique_songs.insert(std::make_pair(song, row));
}
}
removeRows(rows_to_remove);
}
void Playlist::RemoveUnavailableSongs() {
QList<int> rows_to_remove;
for (int row = 0; row < items_.count(); ++row) {
PlaylistItemPtr item = items_[row];
const Song& song = item->Metadata();
// check only local files
if (song.url().isLocalFile() && !QFile::exists(song.url().toLocalFile())) {
rows_to_remove.append(row);
}
}
removeRows(rows_to_remove);
}
bool Playlist::ApplyValidityOnCurrentSong(const QUrl& url, bool valid) {
PlaylistItemPtr current = current_item();
if (current) {
Song current_song = current->Metadata();
// if validity has changed, reload the item
if (!current_song.is_stream() && !current_song.is_cdda() &&
current_song.url() == url &&
current_song.is_valid() !=
QFile::exists(current_song.url().toLocalFile())) {
ReloadItems(QList<int>() << current_row());
}
// gray out the song if it's now broken; otherwise undo the gray color
if (valid) {
current->RemoveForegroundColor(kInvalidSongPriority);
} else {
current->SetForegroundColor(kInvalidSongPriority, kInvalidSongColor);
}
}
return static_cast<bool>(current);
}
void Playlist::SetColumnAlignment(const ColumnAlignmentMap& alignment) {
column_alignments_ = alignment;
}
void Playlist::SkipTracks(const QModelIndexList& source_indexes) {
for (const QModelIndex& source_index : source_indexes) {
PlaylistItemPtr track_to_skip = item_at(source_index.row());
track_to_skip->SetShouldSkip(!((track_to_skip)->GetShouldSkip()));
emit dataChanged(source_index, source_index);
}
}
Reference in New Issue View Git Blame Copy Permalink