Album.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "Artist.h"
#include "Song.h"
#include "XBDateTime.h"
#include "utils/ScraperUrl.h"

#include <map>
#include <vector>

class TiXmlNode;
class CFileItem;
class CAlbum
{
public:
  explicit CAlbum(const CFileItem& item);
  CAlbum() = default;
  bool operator<(const CAlbum &a) const;
  void MergeScrapedAlbum(const CAlbum& album, bool override = true);

  void Reset()
  {
    idAlbum = -1;
    strAlbum.clear();
    strMusicBrainzAlbumID.clear();
    strReleaseGroupMBID.clear();
    artistCredits.clear();
    strArtistDesc.clear();
    strArtistSort.clear();
    genre.clear();
    thumbURL.Clear();
    moods.clear();
    styles.clear();
    themes.clear();
    art.clear();
    strReview.clear();
    strLabel.clear();
    strType.clear();
    strReleaseStatus.clear();
    strPath.clear();
    fRating = -1;
    iUserrating = -1;
    iVotes = -1;
    strOrigReleaseDate.clear();
    strReleaseDate.clear();
    bCompilation = false;
    bBoxedSet = false;
    iTimesPlayed = 0;
    dateAdded.Reset();
    dateUpdated.Reset();
    dateNew.Reset();
    lastPlayed.Reset();
    iTotalDiscs = -1;
    songs.clear();
    releaseType = Album;
    strLastScraped.clear();
    bScrapedMBID = false;
    bArtistSongMerge = false;
    iAlbumDuration = 0;
  }

  const std::vector<std::string> GetAlbumArtist() const;

  const std::vector<std::string> GetMusicBrainzAlbumArtistID() const;
  std::string GetGenreString() const;

  const std::string GetAlbumArtistString() const;

  const std::string GetAlbumArtistSort() const;

  const std::vector<int> GetArtistIDArray() const;

  typedef enum ReleaseType {
    Album = 0,
    Single
  } ReleaseType;

  std::string GetReleaseType() const;
  void SetReleaseType(const std::string& strReleaseType);
  void SetDateAdded(const std::string& strDateAdded);
  void SetDateUpdated(const std::string& strDateUpdated);
  void SetDateNew(const std::string& strDateNew);
  void SetLastPlayed(const std::string& strLastPlayed);

  static std::string ReleaseTypeToString(ReleaseType releaseType);
  static ReleaseType ReleaseTypeFromString(const std::string& strReleaseType);

  void SetArtistCredits(const std::vector<std::string>& names, const std::vector<std::string>& hints,
                        const std::vector<std::string>& mbids,
                        const std::vector<std::string>& artistnames = std::vector<std::string>(),
                        const std::vector<std::string>& artisthints = std::vector<std::string>(),
                        const std::vector<std::string>& artistmbids = std::vector<std::string>());

  bool Load(const TiXmlElement *element, bool append = false, bool prioritise = false);
  bool Save(TiXmlNode *node, const std::string &tag, const std::string& strPath);

  int idAlbum = -1;
  std::string strAlbum;
  std::string strMusicBrainzAlbumID;
  std::string strReleaseGroupMBID;
  std::string strArtistDesc;
  std::string strArtistSort;
  VECARTISTCREDITS artistCredits;
  std::vector<std::string> genre;
  CScraperUrl thumbURL;
  std::vector<std::string> moods;
  std::vector<std::string> styles;
  std::vector<std::string> themes;
  std::map<std::string, std::string> art;
  std::string strReview;
  std::string strLabel;
  std::string strType;
  std::string strReleaseStatus;
  std::string strPath;
  float fRating = -1;
  int iUserrating = -1;
  int iVotes = -1;
  std::string strReleaseDate;
  std::string strOrigReleaseDate;
  bool bBoxedSet = false;
  bool bCompilation = false;
  int iTimesPlayed = 0;
  CDateTime dateAdded; // From related file creation or modification times, or when (re-)scanned
  CDateTime dateUpdated; // Time db record Last modified
  CDateTime dateNew;  // Time db record created
  CDateTime lastPlayed;
  int iTotalDiscs = -1;
  VECSONGS songs;     
  ReleaseType releaseType = Album;
  std::string strLastScraped;
  bool bScrapedMBID = false;
  bool bArtistSongMerge = false;
  int iAlbumDuration = 0;
};

typedef std::vector<CAlbum> VECALBUMS;