Song.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 "XBDateTime.h"
#include "music/tags/ReplayGain.h"
#include "utils/EmbeddedArt.h"
#include "utils/ISerializable.h"

#include <map>
#include <string>
#include <vector>

class CVariant;

class CGenre
{
public:
  int idGenre;
  std::string strGenre;
};

class CFileItem;

class CSong final : public ISerializable
{
public:
  CSong() ;
  explicit CSong(CFileItem& item);
  void Clear() ;
  void MergeScrapedSong(const CSong& source, bool override);
  void Serialize(CVariant& value) const override;

  bool operator<(const CSong &song) const
  {
    if (strFileName < song.strFileName) return true;
    if (strFileName > song.strFileName) return false;
    if (iTrack < song.iTrack) return true;
    return false;
  }

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

  const std::string GetArtistSort() const;

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

  const std::string GetArtistString() const;

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

  const std::vector<std::string> GetAlbumArtist() const { return m_albumArtist; }

  const std::string GetAlbumArtistSort() const { return m_strAlbumArtistSort; }

  const std::string GetDiscSubtitle() const;

  const std::string GetComposerSort() const { return m_strComposerSort; }

  const VECMUSICROLES& GetContributors() const { return m_musicRoles; }
  //void AddArtistRole(const int &role, const std::string &artist);
  void AppendArtistRole(const CMusicRole& musicRole);

  void SetAlbumArtist(const std::vector<std::string>& albumartists) { m_albumArtist = albumartists; }

  bool HasArtistCredits() const { return !artistCredits.empty(); }

  bool HasContributors() const { return !m_musicRoles.empty(); }

  bool HasArt() const;

  bool ArtMatches(const CSong &right) const;

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

  int idSong;
  int idAlbum;
  std::string strFileName;
  std::string strTitle;
  std::string strArtistSort;
  std::string strArtistDesc;
  VECARTISTCREDITS artistCredits;
  std::string strAlbum;
  std::vector<std::string> genre;
  std::string strThumb;
  EmbeddedArtInfo embeddedArt;
  std::string strMusicBrainzTrackID;
  std::string strComment;
  std::string strMood;
  std::string strCueSheet;
  float rating;
  int userrating;
  int votes;
  int iTrack;
  int iDuration;
  std::string strOrigReleaseDate;
  std::string strReleaseDate;
  std::string strDiscSubtitle;
  int iTimesPlayed;
  CDateTime lastPlayed;
  CDateTime dateAdded; // File creation or modification time, or when tags (re-)scanned
  CDateTime dateUpdated; // Time db record Last modified
  CDateTime dateNew;  // Time db record created
  int iStartOffset;
  int iEndOffset;
  bool bCompilation;
  int iBPM;
  int iSampleRate;
  int iBitRate;
  int iChannels;
  std::string strRecordLabel; // Record label from tag for album processing by CMusicInfoScanner::FileItemsToAlbums
  std::string strAlbumType; // (Musicbrainz release type) album type from tag for album processing by CMusicInfoScanner::FileItemsToAlbums
  std::string songVideoURL; // url to song video

  ReplayGain replayGain;
private:
  std::vector<std::string> m_albumArtist; // Album artist from tag for album processing, no desc or MBID
  std::string m_strAlbumArtistSort; // Albumartist sort string from tag for album processing by CMusicInfoScanner::FileItemsToAlbums
  std::string m_strComposerSort;
  VECMUSICROLES m_musicRoles;
};

typedef std::vector<CSong> VECSONGS;

typedef std::map<std::string, VECSONGS> MAPSONGS;

typedef std::vector<CGenre> VECGENRES;