Metadata Class Reference

#include <metadata.h>

List of all members.


Detailed Description

Definition at line 44 of file mythmusic/mythmusic/metadata.h.


Public Types

typedef std::pair< int, QString > genre_entry
typedef std::pair< int, QString > country_entry
typedef std::pair< int, QString > cast_entry
typedef std::vector< genre_entrygenre_list
typedef std::vector
< country_entry
country_list
typedef std::vector< cast_entrycast_list

Public Member Functions

 Metadata (QString lfilename="", QString lartist="", QString lcompilation_artist="", QString lalbum="", QString ltitle="", QString lgenre="", int lyear=0, int ltracknum=0, int llength=0, int lid=0, int lrating=0, int lplaycount=0, QString llastplay="", bool lcompilation=false, QString lformat="")
 Metadata (const Metadata &other)
Metadataoperator= (Metadata *rhs)
QString Artist () const
void setArtist (const QString &lartist)
QString CompilationArtist () const
void setCompilationArtist (const QString &lcompilation_artist)
QString Album () const
void setAlbum (const QString &lalbum)
QString Title () const
void setTitle (const QString &ltitle)
QString FormatArtist ()
QString FormatTitle ()
QString Genre ()
void setGenre (const QString &lgenre)
void setDirectoryId (int ldirectoryid)
int getDirectoryId () const
void setArtistId (int lartistid)
int getArtistId () const
void setAlbumId (int lalbumid)
int getAlbumId () const
void setGenreId (int lgenreid)
int getGenreId () const
int Year ()
void setYear (int lyear)
int Track () const
void setTrack (int ltrack)
int Length () const
void setLength (int llength)
int Playcount () const
void setPlaycount (int lplaycount)
unsigned int ID () const
void setID (int lid)
QString Filename () const
void setFilename (const QString &lfilename)
QString Format () const
void setFormat (const QString &lformat)
int Rating () const
void decRating ()
void incRating ()
void setRating (int lrating)
double LastPlay ()
QString LastPlayStr () const
void setLastPlay ()
int PlayCount () const
void incPlayCount ()
bool isVisible () const
void setVisible (bool visible)
bool Compilation () const
void setCompilation (bool state)
bool determineIfCompilation (bool cd=false)
void setEmbeddedAlbumArt (QValueList< struct AlbumArtImage > art)
bool isInDatabase (void)
void dumpToDatabase (void)
void setField (const QString &field, const QString &data)
void getField (const QString &field, QString *data)
void persist ()
bool hasChanged ()
int compare (Metadata *other)
QImage getAlbumArt (void)
QImage getAlbumArt (ImageType type)
 Metadata (const QString &filename="", const QString &coverfile="", const QString &title="", int year=VIDEO_YEAR_DEFAULT, const QString &inetref="", const QString &director="", const QString &plot="", float userrating=0.0, const QString &rating="", int length=0, int id=0, ParentalLevel::Level showlevel=ParentalLevel::plLowest, int categoryID=0, int childID=-1, bool browse=true, const QString &playcommand="", const QString &category="", const genre_list &genres=genre_list(), const country_list &countries=country_list(), const cast_list &cast=cast_list())
 ~Metadata ()
 Metadata (MSqlQuery &query)
 Metadata (const Metadata &rhs)
Metadataoperator= (const Metadata &rhs)
bool hasSortKey () const
const SortKeygetSortKey () const
void setSortKey (const SortKey &sort_key)
void setFlatIndex (int index)
int getFlatIndex () const
const QString & getPrefix () const
void setPrefix (const QString &prefix)
const QString & Title () const
void setTitle (const QString &title)
int Year () const
void setYear (int year)
const QString & InetRef () const
void setInetRef (const QString &inetRef)
const QString & Director () const
void setDirector (const QString &director)
const QString & Plot () const
void setPlot (const QString &plot)
float UserRating () const
void setUserRating (float userRating)
const QString & Rating () const
void setRating (const QString &rating)
int Length () const
void setLength (int length)
unsigned int ID () const
void setID (int id)
int ChildID () const
void setChildID (int childID)
bool Browse () const
void setBrowse (bool browse)
const QString & PlayCommand () const
void setPlayCommand (const QString &playCommand)
ParentalLevel::Level ShowLevel () const
void setShowLevel (ParentalLevel::Level showLevel)
const QString & Filename () const
void setFilename (const QString &filename)
QString getFilenameNoPrefix () const
const QString & CoverFile () const
void setCoverFile (const QString &coverFile)
const QString & Category () const
const genre_listGenres () const
void setGenres (const genre_list &genres)
const cast_listgetCast () const
void setCast (const cast_list &cast)
const country_listCountries () const
void setCountries (const country_list &countries)
int getCategoryID () const
void setCategoryID (int id)
void dumpToDatabase ()
void updateDatabase ()
bool fillDataFromFilename (const MetadataListManager &cache)
bool deleteFile ()
bool dropFromDB ()
void Reset ()
 Resets to default metadata.

Static Public Member Functions

static void setArtistAndTrackFormats ()
static void SetStartdir (const QString &dir)
static QString GetStartdir ()
static QStringList fillFieldList (QString field)
static MetadatagetMetadataFromID (int id)
static SortKey GenerateDefaultSortKey (const Metadata &m, bool ignore_case)
static QString FilenameToTitle (const QString &file_name)
static QString trimTitle (const QString &title, bool ignore_case)
static QString getPlayer (const Metadata *item)
static QString getPlayer (const Metadata *item, QString &internal_mrl)
static QString getPlayCommand (const Metadata *item)
static bool getPlayer (const QString &extension, QString &player, bool &use_default)

Private Member Functions

void setCompilationFormatting (bool cd=false)
QString formatReplaceSymbols (const QString &format)
void checkEmptyFields (void)

Private Attributes

QString m_artist
QString m_compilation_artist
QString m_album
QString m_title
QString m_formattedartist
QString m_formattedtitle
QString m_genre
QString m_format
int m_year
int m_tracknum
int m_length
int m_rating
int m_directoryid
int m_artistid
int m_compartistid
int m_albumid
int m_genreid
QString m_lastplay
int m_playcount
bool m_compilation
QValueList< struct AlbumArtImagem_albumart
unsigned int m_id
QString m_filename
bool m_changed
bool m_show
class MetadataImpm_imp

Static Private Attributes

static QString m_startdir = ""
static QString m_formatnormalfileartist = "ARTIST"
static QString m_formatnormalfiletrack = "TITLE"
static QString m_formatnormalcdartist = "ARTIST"
static QString m_formatnormalcdtrack = "TITLE"
static QString m_formatcompilationfileartist = "COMPARTIST"
static QString m_formatcompilationfiletrack = "TITLE (ARTIST)"
static QString m_formatcompilationcdartist = "COMPARTIST"
static QString m_formatcompilationcdtrack = "TITLE (ARTIST)"

Classes

class  SortKey

Member Typedef Documentation

typedef std::pair<int, QString> Metadata::genre_entry

Definition at line 21 of file mythvideo/mythvideo/metadata.h.

typedef std::pair<int, QString> Metadata::country_entry

Definition at line 22 of file mythvideo/mythvideo/metadata.h.

typedef std::pair<int, QString> Metadata::cast_entry

Definition at line 23 of file mythvideo/mythvideo/metadata.h.

typedef std::vector<genre_entry> Metadata::genre_list

Definition at line 24 of file mythvideo/mythvideo/metadata.h.

typedef std::vector<country_entry> Metadata::country_list

Definition at line 25 of file mythvideo/mythvideo/metadata.h.

typedef std::vector<cast_entry> Metadata::cast_list

Definition at line 26 of file mythvideo/mythvideo/metadata.h.


Constructor & Destructor Documentation

Metadata::Metadata ( QString  lfilename = "",
QString  lartist = "",
QString  lcompilation_artist = "",
QString  lalbum = "",
QString  ltitle = "",
QString  lgenre = "",
int  lyear = 0,
int  ltracknum = 0,
int  llength = 0,
int  lid = 0,
int  lrating = 0,
int  lplaycount = 0,
QString  llastplay = "",
bool  lcompilation = false,
QString  lformat = "" 
) [inline]

Definition at line 47 of file mythmusic/mythmusic/metadata.h.

Referenced by getMetadataFromID().

Metadata::Metadata ( const Metadata other  )  [inline]

Definition at line 81 of file mythmusic/mythmusic/metadata.h.

Metadata::Metadata ( const QString &  filename = "",
const QString &  coverfile = "",
const QString &  title = "",
int  year = VIDEO_YEAR_DEFAULT,
const QString &  inetref = "",
const QString &  director = "",
const QString &  plot = "",
float  userrating = 0.0,
const QString &  rating = "",
int  length = 0,
int  id = 0,
ParentalLevel::Level  showlevel = ParentalLevel::plLowest,
int  categoryID = 0,
int  childID = -1,
bool  browse = true,
const QString &  playcommand = "",
const QString &  category = "",
const genre_list genres = genre_list(),
const country_list countries = country_list(),
const cast_list cast = cast_list() 
)

Definition at line 903 of file mythvideo/mythvideo/metadata.cpp.

Metadata::~Metadata (  ) 

Definition at line 921 of file mythvideo/mythvideo/metadata.cpp.

Metadata::Metadata ( MSqlQuery query  ) 

Definition at line 926 of file mythvideo/mythvideo/metadata.cpp.

Metadata::Metadata ( const Metadata rhs  ) 


Member Function Documentation

Metadata & Metadata::operator= ( Metadata rhs  ) 

Definition at line 42 of file mythmusic/mythmusic/metadata.cpp.

QString Metadata::Artist (  )  const [inline]

void Metadata::setArtist ( const QString &  lartist  )  [inline]

QString Metadata::CompilationArtist (  )  const [inline]

void Metadata::setCompilationArtist ( const QString &  lcompilation_artist  )  [inline]

QString Metadata::Album (  )  const [inline]

void Metadata::setAlbum ( const QString &  lalbum  )  [inline]

const QString & Metadata::Title (  )  const [inline]

void Metadata::setTitle ( const QString &  ltitle  )  [inline]

QString Metadata::FormatArtist (  ) 

QString Metadata::FormatTitle (  ) 

QString Metadata::Genre (  )  [inline]

void Metadata::setGenre ( const QString &  lgenre  )  [inline]

void Metadata::setDirectoryId ( int  ldirectoryid  )  [inline]

int Metadata::getDirectoryId (  )  const [inline]

Definition at line 118 of file mythmusic/mythmusic/metadata.h.

void Metadata::setArtistId ( int  lartistid  )  [inline]

int Metadata::getArtistId (  )  const [inline]

void Metadata::setAlbumId ( int  lalbumid  )  [inline]

int Metadata::getAlbumId (  )  const [inline]

void Metadata::setGenreId ( int  lgenreid  )  [inline]

int Metadata::getGenreId (  )  const [inline]

int Metadata::Year (  )  [inline]

void Metadata::setYear ( int  lyear  )  [inline]

int Metadata::Track (  )  const [inline]

void Metadata::setTrack ( int  ltrack  )  [inline]

Definition at line 133 of file mythmusic/mythmusic/metadata.h.

int Metadata::Length ( void   )  const [inline]

void Metadata::setLength ( int  llength  )  [inline]

int Metadata::Playcount (  )  const [inline]

Definition at line 138 of file mythmusic/mythmusic/metadata.h.

void Metadata::setPlaycount ( int  lplaycount  )  [inline]

Definition at line 139 of file mythmusic/mythmusic/metadata.h.

unsigned int Metadata::ID (  )  const [inline]

void Metadata::setID ( int  lid  )  [inline]

Definition at line 142 of file mythmusic/mythmusic/metadata.h.

Referenced by FileScanner::UpdateFileInDB().

const QString & Metadata::Filename (  )  const [inline]

void Metadata::setFilename ( const QString &  lfilename  )  [inline]

QString Metadata::Format (  )  const [inline]

Definition at line 147 of file mythmusic/mythmusic/metadata.h.

void Metadata::setFormat ( const QString &  lformat  )  [inline]

Definition at line 148 of file mythmusic/mythmusic/metadata.h.

const QString & Metadata::Rating (  )  const [inline]

void Metadata::decRating (  ) 

void Metadata::incRating (  ) 

void Metadata::setRating ( int  lrating  )  [inline]

double Metadata::LastPlay (  ) 

QString Metadata::LastPlayStr (  )  const [inline]

Definition at line 156 of file mythmusic/mythmusic/metadata.h.

void Metadata::setLastPlay (  ) 

Definition at line 669 of file mythmusic/mythmusic/metadata.cpp.

Referenced by MusicPlayer::updateLastplay().

int Metadata::PlayCount (  )  const [inline]

void Metadata::incPlayCount (  ) 

Definition at line 676 of file mythmusic/mythmusic/metadata.cpp.

Referenced by MusicPlayer::updateLastplay().

bool Metadata::isVisible ( void   )  const [inline]

Definition at line 162 of file mythmusic/mythmusic/metadata.h.

Referenced by AllMusic::buildTree(), and Playlist::writeTree().

void Metadata::setVisible ( bool  visible  )  [inline]

bool Metadata::Compilation (  )  const [inline]

void Metadata::setCompilation ( bool  state  )  [inline]

bool Metadata::determineIfCompilation ( bool  cd = false  ) 

Definition at line 498 of file mythmusic/mythmusic/metadata.cpp.

Referenced by MetaIOAVFComment::read().

void Metadata::setEmbeddedAlbumArt ( QValueList< struct AlbumArtImage art  ) 

Definition at line 682 of file mythmusic/mythmusic/metadata.cpp.

Referenced by MetaIOTagLib::read().

bool Metadata::isInDatabase ( void   ) 

Definition at line 109 of file mythmusic/mythmusic/metadata.cpp.

Referenced by Decoder::getMetadata().

void Metadata::dumpToDatabase ( void   ) 

void Metadata::setField ( const QString &  field,
const QString &  data 
)

Definition at line 589 of file mythmusic/mythmusic/metadata.cpp.

void Metadata::getField ( const QString &  field,
QString *  data 
)

Definition at line 623 of file mythmusic/mythmusic/metadata.cpp.

Referenced by MusicFieldTreeBuilder::getField().

void Metadata::persist (  ) 

bool Metadata::hasChanged (  )  [inline]

Definition at line 180 of file mythmusic/mythmusic/metadata.h.

Referenced by AllMusic::save(), and MusicPlayer::stopDecoder().

int Metadata::compare ( Metadata other  ) 

Definition at line 87 of file mythmusic/mythmusic/metadata.cpp.

void Metadata::setArtistAndTrackFormats (  )  [static]

Definition at line 460 of file mythmusic/mythmusic/metadata.cpp.

Referenced by preMusic().

void Metadata::SetStartdir ( const QString &  dir  )  [static]

Definition at line 67 of file mythmusic/mythmusic/metadata.cpp.

Referenced by mythplugin_config(), and preMusic().

static QString Metadata::GetStartdir (  )  [inline, static]

QStringList Metadata::fillFieldList ( QString  field  )  [static]

Metadata * Metadata::getMetadataFromID ( int  id  )  [static]

QImage Metadata::getAlbumArt ( void   ) 

QImage Metadata::getAlbumArt ( ImageType  type  ) 

Definition at line 759 of file mythmusic/mythmusic/metadata.cpp.

void Metadata::setCompilationFormatting ( bool  cd = false  )  [inline, private]

QString Metadata::formatReplaceSymbols ( const QString &  format  )  [inline, private]

Definition at line 507 of file mythmusic/mythmusic/metadata.cpp.

Referenced by setCompilationFormatting().

void Metadata::checkEmptyFields ( void   )  [private]

Definition at line 517 of file mythmusic/mythmusic/metadata.cpp.

Referenced by dumpToDatabase(), and Metadata().

Metadata::SortKey Metadata::GenerateDefaultSortKey ( const Metadata m,
bool  ignore_case 
) [static]

QString Metadata::FilenameToTitle ( const QString &  file_name  )  [static]

QString Metadata::trimTitle ( const QString &  title,
bool  ignore_case 
) [static]

Definition at line 793 of file mythvideo/mythvideo/metadata.cpp.

Referenced by GenerateDefaultSortKey().

QString Metadata::getPlayer ( const Metadata item  )  [static]

QString Metadata::getPlayer ( const Metadata item,
QString &  internal_mrl 
) [static]

Definition at line 806 of file mythvideo/mythvideo/metadata.cpp.

QString Metadata::getPlayCommand ( const Metadata item  )  [static]

Definition at line 836 of file mythvideo/mythvideo/metadata.cpp.

Referenced by PlayVideo().

bool Metadata::getPlayer ( const QString &  extension,
QString &  player,
bool use_default 
) [static]

Definition at line 882 of file mythvideo/mythvideo/metadata.cpp.

Metadata & Metadata::operator= ( const Metadata rhs  ) 

Definition at line 936 of file mythvideo/mythvideo/metadata.cpp.

bool Metadata::hasSortKey (  )  const

const Metadata::SortKey & Metadata::getSortKey (  )  const

void Metadata::setSortKey ( const SortKey sort_key  ) 

Definition at line 956 of file mythvideo/mythvideo/metadata.cpp.

void Metadata::setFlatIndex ( int  index  ) 

Definition at line 961 of file mythvideo/mythvideo/metadata.cpp.

int Metadata::getFlatIndex (  )  const

Definition at line 966 of file mythvideo/mythvideo/metadata.cpp.

const QString & Metadata::getPrefix (  )  const

Definition at line 972 of file mythvideo/mythvideo/metadata.cpp.

void Metadata::setPrefix ( const QString &  prefix  ) 

Definition at line 977 of file mythvideo/mythvideo/metadata.cpp.

const QString& Metadata::Title (  )  const

void Metadata::setTitle ( const QString &  title  ) 

int Metadata::Year (  )  const

Definition at line 992 of file mythvideo/mythvideo/metadata.cpp.

void Metadata::setYear ( int  year  ) 

const QString & Metadata::InetRef (  )  const

void Metadata::setInetRef ( const QString &  inetRef  ) 

const QString & Metadata::Director (  )  const

void Metadata::setDirector ( const QString &  director  ) 

const QString & Metadata::Plot (  )  const

void Metadata::setPlot ( const QString &  plot  ) 

float Metadata::UserRating (  )  const

void Metadata::setUserRating ( float  userRating  ) 

const QString& Metadata::Rating (  )  const

void Metadata::setRating ( const QString &  rating  ) 

Definition at line 1047 of file mythvideo/mythvideo/metadata.cpp.

int Metadata::Length (  )  const

void Metadata::setLength ( int  length  ) 

unsigned int Metadata::ID (  )  const

void Metadata::setID ( int  id  ) 

int Metadata::ChildID (  )  const

void Metadata::setChildID ( int  childID  ) 

bool Metadata::Browse (  )  const

void Metadata::setBrowse ( bool  browse  ) 

const QString & Metadata::PlayCommand (  )  const

Definition at line 1092 of file mythvideo/mythvideo/metadata.cpp.

Referenced by getPlayer().

void Metadata::setPlayCommand ( const QString &  playCommand  ) 

Definition at line 1097 of file mythvideo/mythvideo/metadata.cpp.

Referenced by EditMetadataDialog::setPlayer().

ParentalLevel::Level Metadata::ShowLevel (  )  const

void Metadata::setShowLevel ( ParentalLevel::Level  showLevel  ) 

const QString& Metadata::Filename (  )  const

void Metadata::setFilename ( const QString &  filename  ) 

QString Metadata::getFilenameNoPrefix (  )  const

const QString & Metadata::CoverFile (  )  const

void Metadata::setCoverFile ( const QString &  coverFile  ) 

const QString & Metadata::Category (  )  const

const Metadata::genre_list & Metadata::Genres (  )  const

void Metadata::setGenres ( const genre_list genres  ) 

const Metadata::cast_list & Metadata::getCast (  )  const

void Metadata::setCast ( const cast_list cast  ) 

const Metadata::country_list & Metadata::Countries (  )  const

void Metadata::setCountries ( const country_list countries  ) 

int Metadata::getCategoryID (  )  const

void Metadata::setCategoryID ( int  id  ) 

Definition at line 1182 of file mythvideo/mythvideo/metadata.cpp.

Referenced by EditMetadataDialog::setCategory().

void Metadata::dumpToDatabase (  ) 

void Metadata::updateDatabase (  ) 

bool Metadata::fillDataFromFilename ( const MetadataListManager cache  ) 

Definition at line 1214 of file mythvideo/mythvideo/metadata.cpp.

bool Metadata::deleteFile (  ) 

Definition at line 1230 of file mythvideo/mythvideo/metadata.cpp.

bool Metadata::dropFromDB (  ) 

Definition at line 1235 of file mythvideo/mythvideo/metadata.cpp.

void Metadata::Reset ( void   ) 

Resets to default metadata.

Definition at line 1240 of file mythvideo/mythvideo/metadata.cpp.

Referenced by mythvideo_videomanager::VideoManagerImp::ResetItem().


Member Data Documentation

QString Metadata::m_artist [private]

QString Metadata::m_compilation_artist [private]

QString Metadata::m_album [private]

QString Metadata::m_title [private]

QString Metadata::m_formattedartist [private]

QString Metadata::m_formattedtitle [private]

QString Metadata::m_genre [private]

QString Metadata::m_format [private]

int Metadata::m_year [private]

int Metadata::m_tracknum [private]

int Metadata::m_length [private]

int Metadata::m_rating [private]

int Metadata::m_directoryid [private]

Definition at line 212 of file mythmusic/mythmusic/metadata.h.

Referenced by dumpToDatabase(), getDirectoryId(), and setDirectoryId().

int Metadata::m_artistid [private]

Definition at line 213 of file mythmusic/mythmusic/metadata.h.

Referenced by dumpToDatabase(), getArtistId(), and setArtistId().

int Metadata::m_compartistid [private]

Definition at line 214 of file mythmusic/mythmusic/metadata.h.

Referenced by dumpToDatabase().

int Metadata::m_albumid [private]

Definition at line 215 of file mythmusic/mythmusic/metadata.h.

Referenced by dumpToDatabase(), getAlbumId(), and setAlbumId().

int Metadata::m_genreid [private]

Definition at line 216 of file mythmusic/mythmusic/metadata.h.

Referenced by dumpToDatabase(), getGenreId(), and setGenreId().

QString Metadata::m_lastplay [private]

int Metadata::m_playcount [private]

QValueList<struct AlbumArtImage> Metadata::m_albumart [private]

Definition at line 220 of file mythmusic/mythmusic/metadata.h.

Referenced by dumpToDatabase(), and setEmbeddedAlbumArt().

unsigned int Metadata::m_id [private]

QString Metadata::m_filename [private]

Definition at line 226 of file mythmusic/mythmusic/metadata.h.

Referenced by isVisible(), and setVisible().

QString Metadata::m_startdir = "" [static, private]

QString Metadata::m_formatnormalfileartist = "ARTIST" [static, private]

QString Metadata::m_formatnormalfiletrack = "TITLE" [static, private]

QString Metadata::m_formatnormalcdartist = "ARTIST" [static, private]

QString Metadata::m_formatnormalcdtrack = "TITLE" [static, private]

QString Metadata::m_formatcompilationfileartist = "COMPARTIST" [static, private]

QString Metadata::m_formatcompilationfiletrack = "TITLE (ARTIST)" [static, private]

QString Metadata::m_formatcompilationcdartist = "COMPARTIST" [static, private]

QString Metadata::m_formatcompilationcdtrack = "TITLE (ARTIST)" [static, private]

class MetadataImp* Metadata::m_imp [private]


The documentation for this class was generated from the following files:

Generated on Sat Dec 18 05:16:05 2010 for MythTV by  doxygen 1.5.5