ncmpcpp/src/media_library.cpp

/***************************************************************************
 *   Copyright (C) 2008-2010 by Andrzej Rybczak                            *
 *   electricityispower@gmail.com                                          *
 *                                                                         *
 *   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 St, Fifth Floor, Boston, MA 02110-1301, USA.              *
 ***************************************************************************/

#include <algorithm>

#include "charset.h"
#include "display.h"
#include "helpers.h"
#include "global.h"
#include "media_library.h"
#include "mpdpp.h"
#include "playlist.h"
#include "status.h"

using Global::MainHeight;
using Global::MainStartY;
using Global::myScreen;

MediaLibrary *myLibrary = new MediaLibrary;

bool MediaLibrary::hasTwoColumns;
size_t MediaLibrary::itsLeftColWidth;
size_t MediaLibrary::itsMiddleColWidth;
size_t MediaLibrary::itsMiddleColStartX;
size_t MediaLibrary::itsRightColWidth;
size_t MediaLibrary::itsRightColStartX;

void MediaLibrary::Init()
{
	hasTwoColumns = 0;
	itsLeftColWidth = COLS/3-1;
	itsMiddleColWidth = COLS/3;
	itsMiddleColStartX = itsLeftColWidth+1;
	itsRightColWidth = COLS-COLS/3*2-1;
	itsRightColStartX = itsLeftColWidth+itsMiddleColWidth+2;
	
	Artists = new Menu<std::string>(0, MainStartY, itsLeftColWidth, MainHeight, IntoStr(Config.media_lib_primary_tag) + "s", Config.main_color, brNone);
	Artists->HighlightColor(Config.active_column_color);
	Artists->CyclicScrolling(Config.use_cyclic_scrolling);
	Artists->SetSelectPrefix(&Config.selected_item_prefix);
	Artists->SetSelectSuffix(&Config.selected_item_suffix);
	Artists->SetItemDisplayer(Display::Generic);
	
	Albums = new Menu<SearchConstraints>(itsMiddleColStartX, MainStartY, itsMiddleColWidth, MainHeight, "Albums", Config.main_color, brNone);
	Albums->HighlightColor(Config.main_highlight_color);
	Albums->CyclicScrolling(Config.use_cyclic_scrolling);
	Albums->SetSelectPrefix(&Config.selected_item_prefix);
	Albums->SetSelectSuffix(&Config.selected_item_suffix);
	Albums->SetItemDisplayer(DisplayAlbums);
	Albums->SetGetStringFunction(AlbumToString);
	Albums->SetGetStringFunctionUserData(this);
	
	Songs = new Menu<MPD::Song>(itsRightColStartX, MainStartY, itsRightColWidth, MainHeight, "Songs", Config.main_color, brNone);
	Songs->HighlightColor(Config.main_highlight_color);
	Songs->CyclicScrolling(Config.use_cyclic_scrolling);
	Songs->SetSelectPrefix(&Config.selected_item_prefix);
	Songs->SetSelectSuffix(&Config.selected_item_suffix);
	Songs->SetItemDisplayer(Display::Songs);
	Songs->SetItemDisplayerUserData(&Config.song_library_format);
	Songs->SetGetStringFunction(SongToString);
	
	w = Artists;
	isInitialized = 1;
}

void MediaLibrary::Resize()
{
	if (!hasTwoColumns)
	{
		itsLeftColWidth = COLS/3-1;
		itsMiddleColStartX = itsLeftColWidth+1;
		itsMiddleColWidth = COLS/3;
		itsRightColStartX = itsLeftColWidth+itsMiddleColWidth+2;
		itsRightColWidth = COLS-COLS/3*2-1;
	}
	else
	{
		itsMiddleColStartX = 0;
		itsMiddleColWidth = COLS/2;
		itsRightColStartX = itsMiddleColWidth+1;
		itsRightColWidth = COLS-itsMiddleColWidth-1;
	}
	
	Artists->Resize(itsLeftColWidth, MainHeight);
	Albums->Resize(itsMiddleColWidth, MainHeight);
	Songs->Resize(itsRightColWidth, MainHeight);
	
	Artists->MoveTo(0, MainStartY);
	Albums->MoveTo(itsMiddleColStartX, MainStartY);
	Songs->MoveTo(itsRightColStartX, MainStartY);
	
	hasToBeResized = 0;
}

void MediaLibrary::Refresh()
{
	Artists->Display();
	mvvline(MainStartY, itsMiddleColStartX-1, 0, MainHeight);
	Albums->Display();
	mvvline(MainStartY, itsRightColStartX-1, 0, MainHeight);
	Songs->Display();
	if (Albums->Empty())
	{
		*Albums << XY(0, 0) << "No albums found.";
		Albums->Window::Refresh();
	}
}

void MediaLibrary::SwitchTo()
{
	if (myScreen == this)
	{
		hasTwoColumns = !hasTwoColumns;
		hasToBeResized = 1;
		Artists->Clear();
		Albums->Clear();
		Albums->Reset();
		Songs->Clear();
		if (hasTwoColumns)
		{
			if (w == Artists)
				NextColumn();
			std::string item_type = IntoStr(Config.media_lib_primary_tag);
			ToLower(item_type);
			Albums->SetTitle("Albums (sorted by " + item_type + ")");
		}
		else
			Albums->SetTitle("Albums");
	}
	
	if (!isInitialized)
		Init();
	
	if (hasToBeResized)
		Resize();
	
	if (myScreen != this && myScreen->isTabbable())
		Global::myPrevScreen = myScreen;
	myScreen = this;
	Global::RedrawHeader = 1;
	Refresh();
	UpdateSongList(Songs);
}

std::basic_string<my_char_t> MediaLibrary::Title()
{
	return U("Media library");
}

void MediaLibrary::Update()
{
	if (!hasTwoColumns && Artists->Empty())
	{
		MPD::TagList list;
		Albums->Clear();
		Mpd.GetList(list, Config.media_lib_primary_tag);
		sort(list.begin(), list.end(), CaseInsensitiveSorting());
		for (MPD::TagList::iterator it = list.begin(); it != list.end(); ++it)
		{
			if (!it->empty())
			{
				utf_to_locale(*it);
				Artists->AddOption(*it);
			}
		}
		Artists->Window::Clear();
		Artists->Refresh();
	}
	
	if (!hasTwoColumns && !Artists->Empty() && Albums->Empty())
	{
		Songs->Clear();
		Albums->Reset();
		MPD::TagList list;
		locale_to_utf(Artists->Current());
		Mpd.StartFieldSearch(MPD_TAG_ALBUM);
		Mpd.AddSearch(Config.media_lib_primary_tag, Artists->Current());
		Mpd.CommitSearch(list);
		
		for (MPD::TagList::iterator it = list.begin(); it != list.end(); ++it)
		{
			if (Config.media_library_display_date)
			{
				MPD::TagList l;
				Mpd.StartFieldSearch(MPD_TAG_DATE);
				Mpd.AddSearch(Config.media_lib_primary_tag, Artists->Current());
				Mpd.AddSearch(MPD_TAG_ALBUM, *it);
				Mpd.CommitSearch(l);
				utf_to_locale(*it);
				for (MPD::TagList::iterator j = l.begin(); j != l.end(); ++j)
				{
					utf_to_locale(*j);
					Albums->AddOption(SearchConstraints(*it, *j));
				}
			}
			else
			{
				utf_to_locale(*it);
				Albums->AddOption(SearchConstraints(*it, ""));
			}
		}
		utf_to_locale(Artists->Current());
		if (!Albums->Empty())
			Albums->Sort<SearchConstraintsSorting>();
		Albums->Refresh();
	}
	else if (hasTwoColumns && Albums->Empty())
	{
		Songs->Clear();
		MPD::TagList artists;
		*Albums << XY(0, 0) << "Fetching albums...";
		Albums->Window::Refresh();
		Mpd.GetList(artists, Config.media_lib_primary_tag);
		for (MPD::TagList::iterator i = artists.begin(); i != artists.end(); ++i)
		{
			if (i->empty())
				continue;
			MPD::TagList albums;
			Mpd.StartFieldSearch(MPD_TAG_ALBUM);
			Mpd.AddSearch(Config.media_lib_primary_tag, *i);
			Mpd.CommitSearch(albums);
			for (MPD::TagList::iterator j = albums.begin(); j != albums.end(); ++j)
			{
				if (Config.media_library_display_date)
				{
					if (Config.media_lib_primary_tag != MPD_TAG_DATE)
					{
						MPD::TagList years;
						Mpd.StartFieldSearch(MPD_TAG_DATE);
						Mpd.AddSearch(Config.media_lib_primary_tag, *i);
						Mpd.AddSearch(MPD_TAG_ALBUM, *j);
						Mpd.CommitSearch(years);
						utf_to_locale(*i);
						utf_to_locale(*j);
						for (MPD::TagList::iterator k = years.begin(); k != years.end(); ++k)
						{
							utf_to_locale(*k);
							Albums->AddOption(SearchConstraints(*i, *j, *k));
						}
					}
					else
					{
						utf_to_locale(*i);
						utf_to_locale(*j);
						Albums->AddOption(SearchConstraints(*i, *j, *i));
					}
				}
				else
				{
					utf_to_locale(*i);
					utf_to_locale(*j);
					Albums->AddOption(SearchConstraints(*i, *j, ""));
				}
			}
		}
		if (!Albums->Empty())
			Albums->Sort<SearchConstraintsSorting>();
		Albums->Refresh();
	}
	
	if (!hasTwoColumns && !Artists->Empty() && w == Albums && Albums->Empty())
	{
		Albums->HighlightColor(Config.main_highlight_color);
		Artists->HighlightColor(Config.active_column_color);
		w = Artists;
	}
	
	if ((hasTwoColumns || !Artists->Empty()) && Songs->Empty())
	{
		Songs->Reset();
		MPD::SongList list;
		
		Mpd.StartSearch(1);
		Mpd.AddSearch(Config.media_lib_primary_tag, locale_to_utf_cpy(hasTwoColumns ? Albums->Current().Artist : Artists->Current()));
		if (Albums->Empty()) // left for compatibility with <mpd-0.14
		{
			*Albums << XY(0, 0) << "No albums found.";
			Albums->Window::Refresh();
		}
		else
		{
			Mpd.AddSearch(MPD_TAG_ALBUM, locale_to_utf_cpy(Albums->Current().Album));
			if (Config.media_library_display_date)
				Mpd.AddSearch(MPD_TAG_DATE, locale_to_utf_cpy(Albums->Current().Year));
		}
		Mpd.CommitSearch(list);
		
		sort(list.begin(), list.end(), SortSongsByTrack);
		bool bold = 0;
		
		for (MPD::SongList::const_iterator it = list.begin(); it != list.end(); ++it)
		{
			for (size_t j = 0; j < myPlaylist->Items->Size(); ++j)
			{
				if ((*it)->GetHash() == myPlaylist->Items->at(j).GetHash())
				{
					bold = 1;
					break;
				}
			}
			Songs->AddOption(**it, bold);
			bold = 0;
		}
		FreeSongList(list);
		Songs->Window::Clear();
		Songs->Refresh();
	}
}

void MediaLibrary::SpacePressed()
{
	if (Config.space_selects)
	{
		if (w == Artists)
		{
			Artists->Select(Artists->Choice(), !Artists->isSelected());
			Albums->Clear();
		}
		else if (w == Albums)
		{
			Albums->Select(Albums->Choice(), !Albums->isSelected());
			Songs->Clear();
		}
		else if (w == Songs)
			Songs->Select(Songs->Choice(), !Songs->isSelected());
		w->Scroll(wDown);
	}
	else
		AddToPlaylist(0);
}

void MediaLibrary::MouseButtonPressed(MEVENT me)
{
	if (!Artists->Empty() && Artists->hasCoords(me.x, me.y))
	{
		if (w != Artists)
		{
			PrevColumn();
			PrevColumn();
		}
		if (size_t(me.y) < Artists->Size() && (me.bstate & (BUTTON1_PRESSED | BUTTON3_PRESSED)))
		{
			Artists->Goto(me.y);
			if (me.bstate & BUTTON3_PRESSED)
			{
				size_t pos = Artists->Choice();
				SpacePressed();
				if (pos < Artists->Size()-1)
					Artists->Scroll(wUp);
			}
		}
		else
			Screen<Window>::MouseButtonPressed(me);
		Albums->Clear();
		Songs->Clear();
	}
	else if (!Albums->Empty() && Albums->hasCoords(me.x, me.y))
	{
		if (w != Albums)
			w == Artists ? NextColumn() : PrevColumn();
		if (size_t(me.y) < Albums->Size() && (me.bstate & (BUTTON1_PRESSED | BUTTON3_PRESSED)))
		{
			Albums->Goto(me.y);
			if (me.bstate & BUTTON3_PRESSED)
			{
				size_t pos = Albums->Choice();
				SpacePressed();
				if (pos < Albums->Size()-1)
					Albums->Scroll(wUp);
			}
		}
		else
			Screen<Window>::MouseButtonPressed(me);
		Songs->Clear();
	}
	else if (!Songs->Empty() && Songs->hasCoords(me.x, me.y))
	{
		if (w != Songs)
		{
			NextColumn();
			NextColumn();
		}
		if (size_t(me.y) < Songs->Size() && (me.bstate & (BUTTON1_PRESSED | BUTTON3_PRESSED)))
		{
			Songs->Goto(me.y);
			if (me.bstate & BUTTON1_PRESSED)
			{
				size_t pos = Songs->Choice();
				SpacePressed();
				if (pos < Songs->Size()-1)
					Songs->Scroll(wUp);
			}
			else
				EnterPressed();
		}
		else
			Screen<Window>::MouseButtonPressed(me);
	}
}

MPD::Song *MediaLibrary::CurrentSong()
{
	return w == Songs && !Songs->Empty() ? &Songs->Current() : 0;
}

List *MediaLibrary::GetList()
{
	if (w == Artists)
		return Artists;
	else if (w == Albums)
		return Albums;
	else if (w == Songs)
		return Songs;
	else // silence compiler
		return 0;
}

void MediaLibrary::ReverseSelection()
{
	if (w == Artists)
		Artists->ReverseSelection();
	else if (w == Albums)
		Albums->ReverseSelection();
	else if (w == Songs)
		Songs->ReverseSelection();
}

void MediaLibrary::GetSelectedSongs(MPD::SongList &v)
{
	std::vector<size_t> selected;
	if (w == Artists && !Artists->Empty())
	{
		Artists->GetSelected(selected);
		if (selected.empty())
			selected.push_back(Artists->Choice());
		for (std::vector<size_t>::const_iterator it = selected.begin(); it != selected.end(); ++it)
		{
			MPD::SongList list;
			Mpd.StartSearch(1);
			Mpd.AddSearch(Config.media_lib_primary_tag, locale_to_utf_cpy(Artists->at(*it)));
			Mpd.CommitSearch(list);
			for (MPD::SongList::const_iterator sIt = list.begin(); sIt != list.end(); ++sIt)
				v.push_back(new MPD::Song(**sIt));
			FreeSongList(list);
		}
	}
	else if (w == Albums && !Albums->Empty())
	{
		Albums->GetSelected(selected);
		if (selected.empty())
		{
			// shortcut via the existing song list in right column
			if (v.empty())
				v.reserve(Songs->Size());
			for (size_t i = 0; i < Songs->Size(); ++i)
				v.push_back(new MPD::Song((*Songs)[i]));
		}
		else
		{
			for (std::vector<size_t>::const_iterator it = selected.begin(); it != selected.end(); ++it)
			{
				MPD::SongList list;
				Mpd.StartSearch(1);
				Mpd.AddSearch(Config.media_lib_primary_tag, hasTwoColumns
						?  Albums->at(*it).Artist
						: locale_to_utf_cpy(Artists->Current()));
				Mpd.AddSearch(MPD_TAG_ALBUM, Albums->at(*it).Album);
				Mpd.AddSearch(MPD_TAG_DATE, Albums->at(*it).Year);
				Mpd.CommitSearch(list);
				for (MPD::SongList::const_iterator sIt = list.begin(); sIt != list.end(); ++sIt)
					v.push_back(new MPD::Song(**sIt));
				FreeSongList(list);
			}
		}
	}
	else if (w == Songs && !Songs->Empty())
	{
		Songs->GetSelected(selected);
		if (selected.empty())
			selected.push_back(Songs->Choice());
		for (std::vector<size_t>::const_iterator it = selected.begin(); it != selected.end(); ++it)
			v.push_back(new MPD::Song(Songs->at(*it)));
	}
}

void MediaLibrary::ApplyFilter(const std::string &s)
{
	GetList()->ApplyFilter(s, 0, REG_ICASE | Config.regex_type);
}

void MediaLibrary::NextColumn()
{
	if (w == Artists)
	{
		if (!hasTwoColumns && Songs->Empty())
			return;
		Artists->HighlightColor(Config.main_highlight_color);
		w->Refresh();
		w = Albums;
		Albums->HighlightColor(Config.active_column_color);
		if (!Albums->Empty())
			return;
	}
	if (w == Albums && !Songs->Empty())
	{
		Albums->HighlightColor(Config.main_highlight_color);
		w->Refresh();
		w = Songs;
		Songs->HighlightColor(Config.active_column_color);
	}
}

void MediaLibrary::PrevColumn()
{
	if (w == Songs)
	{
		Songs->HighlightColor(Config.main_highlight_color);
		w->Refresh();
		w = Albums;
		Albums->HighlightColor(Config.active_column_color);
		if (!Albums->Empty())
			return;
	}
	if (w == Albums && !hasTwoColumns)
	{
		Albums->HighlightColor(Config.main_highlight_color);
		w->Refresh();
		w = Artists;
		Artists->HighlightColor(Config.active_column_color);
	}
}

void MediaLibrary::LocateSong(const MPD::Song &s)
{
	std::string primary_tag;
	switch (Config.media_lib_primary_tag)
	{
		case MPD_TAG_ARTIST:
			primary_tag = s.GetArtist();
			break;
		case MPD_TAG_DATE:
			primary_tag = s.GetDate();
			break;
		case MPD_TAG_GENRE:
			primary_tag = s.GetGenre();
			break;
		case MPD_TAG_COMPOSER:
			primary_tag = s.GetComposer();
			break;
		case MPD_TAG_PERFORMER:
			primary_tag = s.GetPerformer();
			break;
		default:
			ShowMessage("Invalid tag type in left column of the media library");
			return;
	}
	if (primary_tag.empty())
	{
		std::string item_type = IntoStr(Config.media_lib_primary_tag);
		ToLower(item_type);
		ShowMessage("Can't jump to media library because the song has no %s tag set.", item_type.c_str());
		return;
	}
	
	if (myScreen != this)
		SwitchTo();
	Statusbar() << "Jumping to song...";
	Global::wFooter->Refresh();
	
	if (!hasTwoColumns)
	{
		if (Artists->Empty())
			Update();
		if (primary_tag != Artists->Current())
		{
			for (size_t i = 0; i < Artists->Size(); ++i)
			{
				if (primary_tag == (*Artists)[i])
				{
					Artists->Highlight(i);
					Albums->Clear();
					break;
				}
			}
		}
	}
	
	if (Albums->Empty())
		Update();
	
	std::string album = s.GetAlbum();
	std::string date = s.GetDate();
	if ((hasTwoColumns && Albums->Current().Artist != primary_tag)
	||  album != Albums->Current().Album
	||  date != Albums->Current().Year)
	{
		for (size_t i = 0; i < Albums->Size(); ++i)
		{
			if ((!hasTwoColumns || (*Albums)[i].Artist == primary_tag)
			&&   album == (*Albums)[i].Album
			&&   date == (*Albums)[i].Year)
			{
				Albums->Highlight(i);
				Songs->Clear();
				break;
			}
		}
	}
	
	if (Songs->Empty())
		Update();
	
	std::string song = s.GetTitle();
	if (song != Songs->Current().GetTitle())
	{
		for (size_t i = 0; i < Songs->Size(); ++i)
		{
			if (song == (*Songs)[i].GetTitle())
			{
				Songs->Highlight(i);
				break;
			}
		}
	}
	
	Artists->HighlightColor(Config.main_highlight_color);
	Albums->HighlightColor(Config.main_highlight_color);
	Songs->HighlightColor(Config.active_column_color);
	w = Songs;
	Refresh();
}

void MediaLibrary::AddToPlaylist(bool add_n_play)
{
	if (w == Songs && !Songs->Empty())
		Songs->Bold(Songs->Choice(), myPlaylist->Add(Songs->Current(), Songs->isBold(), add_n_play));
	else
	{
		MPD::SongList list;
		GetSelectedSongs(list);

		if (myPlaylist->Add(list, add_n_play))
		{
			if (!Artists->Empty() && w == Artists)
			{
				std::string tag_type = IntoStr(Config.media_lib_primary_tag);
				ToLower(tag_type);
				ShowMessage("Adding songs of %s \"%s\"", tag_type.c_str(), Artists->Current().c_str());
			}
			else if (w == Albums)
				ShowMessage("Adding songs from album \"%s\"", Albums->Current().Album.c_str());
		}
	}

	if (!add_n_play)
	{
		w->Scroll(wDown);
		if (w == Artists)
		{
			Albums->Clear();
			Songs->Clear();
		}
		else if (w == Albums)
			Songs->Clear();
	}
}

std::string MediaLibrary::SongToString(const MPD::Song &s, void *)
{
	return s.toString(Config.song_library_format);
}

std::string MediaLibrary::AlbumToString(const SearchConstraints &sc, void *ptr)
{
	std::string result;
	if (!sc.Artist.empty())
		(result += sc.Artist) += " - ";
	if ((!static_cast<MediaLibrary *>(ptr)->hasTwoColumns || Config.media_lib_primary_tag != MPD_TAG_DATE) && !sc.Year.empty())
		((result += "(") += sc.Year) += ") ";
	result += sc.Album.empty() ? "<no album>" : sc.Album;
	return result;
}

void MediaLibrary::DisplayAlbums(const SearchConstraints &sc, void *, Menu<SearchConstraints> *menu)
{
	*menu << AlbumToString(sc, 0);
}

bool MediaLibrary::SearchConstraintsSorting::operator()(const SearchConstraints &a, const SearchConstraints &b) const
{
	int result;
	CaseInsensitiveStringComparison cmp;
	if (!a.Artist.empty() || b.Artist.empty())
	{
		result = cmp(a.Artist, b.Artist);
		if (result != 0)
			return result < 0;
	}
	result = cmp(a.Year, b.Year);
	return (result == 0 ? cmp(a.Album, b.Album) : result) < 0;
}

bool MediaLibrary::SortSongsByTrack(MPD::Song *a, MPD::Song *b)
{
	if (a->GetDisc() == b->GetDisc())
		return StrToInt(a->GetTrack()) < StrToInt(b->GetTrack());
	else
		return StrToInt(a->GetDisc()) < StrToInt(b->GetDisc());
}