Ticket #8595: mythmusic_popm.diff

mythplugins/mythmusic/mythmusic/decoder.h

@@ -93 +93 @@
     virtual Metadata *getMetadata(void);
     virtual MetaIO *doCreateTagger (void);
     virtual void commitMetadata(Metadata *mdata);
+    virtual void commitPlayCount(const Metadata *mdata);
+    virtual void commitRating(const Metadata *mdata);
 
     // static methods
     static QStringList all();

mythplugins/mythmusic/mythmusic/metaio.h

@@ -16 +16 @@
     virtual ~MetaIO(void);
 
     /*!
-    * \brief Writes metadata back to a file
+    * \brief Writes all metadata back to a file
     *
     * \param mdata A pointer to a Metadata object
     * \returns Boolean to indicate success/failure.
@@ -24 +24 @@
     virtual bool write(Metadata* mdata) = 0;
 
     /*!
+    * \brief Writes playcount (only) back to a file
+    *
+    * \param playcount Integer representing the number of times this file has
+    *                  been played
+    * \returns Boolean to indicate success/failure.
+    */
+    virtual bool writePlayCount(const Metadata* mdata)
+    {
+        (void)mdata;
+        return false;
+    }
+
+    /*!
+    * \brief Writes rating (only) back to a file
+    *
+    * \param rating Integer between 0 and 10 representing the rating given to
+    *               this file by the user
+    * \returns Boolean to indicate success/failure.
+    */
+    virtual bool writeRating(const Metadata* mdata)
+    {
+        (void)mdata;
+        return false;
+    }
+
+    /*!
     * \brief Reads Metadata from a file.
     *
     * \param filename The filename to read metadata from.
@@ -31 +57 @@
     */
     virtual Metadata* read(QString filename) = 0;
 
-    void readFromFilename(QString filename, QString &artist, QString &album, 
+    void readFromFilename(QString filename, QString &artist, QString &album,
                           QString &title, QString &genre, int &tracknum);
 
     Metadata* readFromFilename(QString filename, bool blnLength = false);
 
     void readFromFilename(Metadata *metadata);
-    
+
   protected:
 
   private:

mythplugins/mythmusic/mythmusic/decoder.cpp

@@ -156 +156 @@
     }
 }
 
+/**
+ *  \brief Write the playcount to the \p filename if the tag format supports it.
+ *
+ *  Creates a \p MetaIO object using \p Decoder::doCreateTagger and
+ *  asks the MetaIO object to write the playcount to \p
+ *  filename.
+ *
+ *  \params mdata the metadata to write to the disk
+ */
+void Decoder::commitPlayCount(const Metadata *mdata)
+{
+    MetaIO* p_tagger = doCreateTagger();
+    if (p_tagger)
+    {
+        p_tagger->writePlayCount(mdata);
+        delete p_tagger;
+    }
+}
+
+/**
+ *  \brief Write the rating to the \p filename if the tag format supports it.
+ *
+ *  Creates a \p MetaIO object using \p Decoder::doCreateTagger and
+ *  asks the MetaIO object to write the rating to \p
+ *  filename.
+ *
+ *  \params mdata the metadata to write to the disk
+ */
+void Decoder::commitRating(const Metadata *mdata)
+{
+    MetaIO* p_tagger = doCreateTagger();
+    if (p_tagger)
+    {
+        p_tagger->writeRating(mdata);
+        delete p_tagger;
+    }
+}
+
 // static methods
 
 int Decoder::ignore_id3 = 0;

mythplugins/mythmusic/mythmusic/editmetadata.cpp

@@ -660 +660 @@
 
     m_metadata->dumpToDatabase();
     *m_sourceMetadata = m_metadata;
+
+    if (m_metadata->hasChanged())
+    {
+        // Only save rating, this is safe for ID3 since mythtv uses it's own
+        // labelled field and won't overwrite existing ratings
+        Decoder *decoder = Decoder::create(m_metadata->Filename(), NULL, NULL, true);
+        if (decoder)
+        {
+            decoder->commitRating(m_metadata);
+            delete decoder;
+        }
+    }
+
     accept();
 }
 

mythplugins/mythmusic/mythmusic/metaiotaglib.h

@@ -26 +26 @@
 
     virtual bool write(Metadata* mdata) = 0;
     virtual Metadata* read(QString filename) = 0;
-    
+
   protected:
     int getTrackLength(TagLib::FileRef *file);
     int getTrackLength(QString filename);

mythplugins/mythmusic/mythmusic/metaioid3.cpp

@@ -4 +4 @@
 
 // Libmyth
 #include <mythverbose.h>
+#include <set>
 
+const String email = "music@mythtv.org";  // TODO username/ip/hostname?
+
 MetaIOID3::MetaIOID3(void)
     : MetaIOTagLib()
 {
@@ -24 +27 @@
 {
     QByteArray fname = filename.toLocal8Bit();
     TagLib::MPEG::File *mpegfile = new TagLib::MPEG::File(fname.constData());
-    
+
     if (!mpegfile->isOpen())
     {
         delete mpegfile;
@@ -43 +46 @@
 
     if (!mpegfile)
         return false;
-    
+
     TagLib::ID3v2::Tag *tag = mpegfile->ID3v2Tag();
 
     if (!tag)
@@ -51 +54 @@
         delete mpegfile;
         return false;
     }
-    
+
     WriteGenericMetadata(tag, mdata);
-    
-    if (mdata->Rating() > 0 || mdata->PlayCount() > 0)
-    {
-        // Needs to be implemented for taglib by subclassing ID3v2::Frames
-        // with one to handle POPM frames
-    }
-    
+
+    // MythTV rating and playcount, stored in POPM frame
+    writeRating(tag, mdata->Rating());
+    writePlayCount(tag, mdata->PlayCount());
+
     // MusicBrainz ID
     UserTextIdentificationFrame *musicbrainz = NULL;
     musicbrainz = find(tag, "MusicBrainz Album Artist Id");
 
     if (mdata->Compilation())
     {
-        
+
         if (!musicbrainz)
         {
             musicbrainz = new UserTextIdentificationFrame(TagLib::String::UTF8);
             tag->addFrame(musicbrainz);
             musicbrainz->setDescription("MusicBrainz Album Artist Id");
         }
-        
+
         musicbrainz->setText(MYTH_MUSICBRAINZ_ALBUMARTIST_UUID);
     }
     else if (musicbrainz)
@@ -86 +87 @@
         TagLib::ID3v2::FrameList tpelist = tag->frameListMap()["TPE4"];
         if (!tpelist.isEmpty())
             tpe4frame = (TextIdentificationFrame *)tpelist.front();
-        
+
         if (!tpe4frame)
         {
             tpe4frame = new TextIdentificationFrame(TagLib::ByteVector("TPE4"),
@@ -95 +96 @@
         }
         tpe4frame->setText(QStringToTString(mdata->CompilationArtist()));
 
-        
+
         TextIdentificationFrame *tpe2frame = NULL;
         tpelist = tag->frameListMap()["TPE2"];
         if (!tpelist.isEmpty())
@@ -109 +110 @@
         }
         tpe2frame->setText(QStringToTString(mdata->CompilationArtist()));
     }
-    
+
     bool result = mpegfile->save();
 
     delete mpegfile;
-    
+
     return result;
 }
 
@@ -123 +124 @@
 Metadata *MetaIOID3::read(QString filename)
 {
     TagLib::MPEG::File *mpegfile = OpenFile(filename);
-    
+
     if (!mpegfile)
         return NULL;
 
@@ -134 +135 @@
         delete mpegfile;
         return NULL;
     }
-    
+
     Metadata *metadata = new Metadata(filename);
-    
+
     ReadGenericMetadata(tag, metadata);
 
     bool compilation = false;
@@ -151 +152 @@
         tpelist = tag->frameListMap()["TPE2"];
     if (!tpelist.isEmpty())
         tpeframe = (TextIdentificationFrame *)tpelist.front();
-    
+
     if (tpeframe && !tpeframe->toString().isEmpty())
     {
         QString compilation_artist = TStringToQString(tpeframe->toString())
@@ -159 +160 @@
         metadata->setCompilationArtist(compilation_artist);
     }
 
+    // MythTV rating and playcount, stored in POPM frame
+    PopularimeterFrame *popm = findPOPM(tag, email);
+
+    if (!popm)
+    {
+        if (!tag->frameListMap()["POPM"].isEmpty())
+            popm = dynamic_cast<PopularimeterFrame *>
+                                        (tag->frameListMap()["POPM"].front());
+    }
+
+    if (popm)
+    {
+        int rating = popm->rating();
+        rating = static_cast<int>(((static_cast<float>(rating)/255.0)
+                                                                * 10.0) + 0.5);
+        metadata->setRating(rating);
+        metadata->setPlaycount(popm->counter());
+    }
+
     // Look for MusicBrainz Album+Artist ID in TXXX Frame
     UserTextIdentificationFrame *musicbrainz = find(tag,
                                             "MusicBrainz Album Artist Id");
@@ -173 +193 @@
     }
 
     // Length
-    if (!mpegfile->ID3v2Tag()->frameListMap()["TLEN"].isEmpty())
+    if (!tag->frameListMap()["TLEN"].isEmpty())
     {
         int length = tag->frameListMap()["TLEN"].front()->toString().toInt();
         metadata->setLength(length);
@@ -199 +219 @@
     }
     else
         delete mpegfile;
-    
+
     return metadata;
 }
 
@@ -237 +257 @@
         default:
             return picture;
     }
-    
+
     QByteArray fname = filename.toLocal8Bit();
     TagLib::MPEG::File *mpegfile = new TagLib::MPEG::File(fname.constData());
 
@@ -364 +384 @@
     if (f && f->description() == description)
       return f;
   }
-  return 0;
+  return NULL;
 }
+
+/*!
+ * \brief Find the POPM tag associated with MythTV
+ *        This is a copy of the same function in the
+ *        TagLib::ID3v2::UserTextIdentificationFrame Class with a static
+ *        instead of dynamic cast.
+ *
+ * \param tag Pointer to TagLib::ID3v2::Tag object
+ * \param email Email address associated with this POPM frame
+ * \returns Pointer to frame
+ */
+PopularimeterFrame* MetaIOID3::findPOPM(TagLib::ID3v2::Tag *tag,
+                                        const String &email)
+{
+  TagLib::ID3v2::FrameList l = tag->frameList("POPM");
+  for(TagLib::ID3v2::FrameList::Iterator it = l.begin(); it != l.end(); ++it)
+  {
+    PopularimeterFrame *f = static_cast<PopularimeterFrame *>(*it);
+    if (f && f->email() == email)
+      return f;
+  }
+  return NULL;
+}
+
+bool MetaIOID3::writePlayCount(const Metadata* mdata)
+{
+    QString filename = mdata->Filename();
+    int playcount = mdata->PlayCount();
+    TagLib::MPEG::File *mpegfile = OpenFile(filename);
+
+    if (!mpegfile)
+        return false;
+
+    TagLib::ID3v2::Tag *tag = mpegfile->ID3v2Tag();
+
+    if (!tag)
+    {
+        delete mpegfile;
+        return false;
+    }
+
+    bool result = writePlayCount(tag, playcount);
+
+    mpegfile->save();
+    delete mpegfile;
+
+    return result;
+}
+
+bool MetaIOID3::writePlayCount(TagLib::ID3v2::Tag *tag, int playcount)
+{
+    if (!tag)
+        return false;
+
+    PopularimeterFrame *popm = findPOPM(tag, email);
+
+    if (!popm)
+    {
+        popm = new PopularimeterFrame();
+        tag->addFrame(popm);
+        popm->setEmail(email);
+    }
+
+    popm->setCounter(playcount);
+
+    return true;
+}
+
+bool MetaIOID3::writeRating(const Metadata* mdata)
+{
+    QString filename = mdata->Filename();
+    int rating = mdata->Rating();
+    TagLib::MPEG::File *mpegfile = OpenFile(filename);
+
+    if (!mpegfile)
+        return false;
+
+    TagLib::ID3v2::Tag *tag = mpegfile->ID3v2Tag();
+
+    if (!tag)
+    {
+        delete mpegfile;
+        return false;
+    }
+
+    bool result = writeRating(tag, rating);
+
+    mpegfile->save();
+    delete mpegfile;
+
+    return result;
+}
+
+bool MetaIOID3::writeRating(TagLib::ID3v2::Tag *tag, int rating)
+{
+    if (!tag)
+        return false;
+
+    PopularimeterFrame *popm = findPOPM(tag, email);
+
+    if (!popm)
+    {
+        popm = new PopularimeterFrame();
+        tag->addFrame(popm);
+        popm->setEmail(email);
+    }
+    int popmrating = static_cast<int>(((static_cast<float>(rating) / 10.0)
+                                                               * 255.0) + 0.5);
+    popm->setRating(popmrating);
+
+    return true;
+}

mythplugins/mythmusic/mythmusic/musicplayer.cpp

@@ -166 +166 @@
             m_output->addListener(visual);
             m_output->addVisual(visual);
         }
- 
+
         m_visualisers.insert(visual);
     }
 }
@@ -355 +355 @@
     if (m_currentMetadata)
     {
         if (m_currentMetadata->hasChanged())
+        {
             m_currentMetadata->persist();
+            m_decoder->commitPlayCount(m_currentMetadata);
+        }
         delete m_currentMetadata;
     }
     m_currentMetadata = NULL;
@@ -768 +771 @@
     {
         m_currentTrack = position;
     }
-    
+
     m_currentFile.clear();
     Track *track = m_currentPlaylist->getSongAt(m_currentTrack);
     if (track)
         m_currentFile = getFilenameFromID(track->getValue());
-    
+
     if (!m_currentFile.isEmpty())
         play();
 }
@@ -989 +992 @@
 
 void MusicPlayer::toMap(QHash<QString, QString> &map)
 {
-    map["volumemute"] = QString("%1%").arg(getVolume()) + 
+    map["volumemute"] = QString("%1%").arg(getVolume()) +
                         (isMuted() ? " (" + tr("Muted") + ")" : "");
     map["volume"] = QString("%1").arg(getVolume());
     map["volumepercent"] = QString("%1%").arg(getVolume());

mythplugins/mythmusic/mythmusic/metaioavfcomment.h

@@ -21 +21 @@
 public:
     MetaIOAVFComment(void);
     virtual ~MetaIOAVFComment(void);
-    
+
     bool write(Metadata* mdata);
     Metadata* read(QString filename);
-    
+
 private:
     int getTrackLength(QString filename);
     int getTrackLength(AVFormatContext* p_context);

mythplugins/mythmusic/mythmusic/metaioid3.h

@@ -9 +9 @@
 #include <id3v2tag.h>
 #include <textidentificationframe.h>
 #include <attachedpictureframe.h>
+#include <popularimeterframe.h>
 #include <mpegproperties.h>
 #include <mpegfile.h>
 #include <tfile.h>
@@ -18 +19 @@
 
 using TagLib::ID3v2::UserTextIdentificationFrame;
 using TagLib::ID3v2::TextIdentificationFrame;
+using TagLib::ID3v2::PopularimeterFrame;
 using TagLib::ID3v2::AttachedPictureFrame;
 using TagLib::MPEG::Properties;
 
@@ -37 +39 @@
   public:
     MetaIOID3(void);
     virtual ~MetaIOID3(void);
-    
+
     bool write(Metadata* mdata);
+
+    bool writePlayCount(const Metadata* mdata);
+    bool writePlayCount(TagLib::ID3v2::Tag *tag, int playcount);
+    bool writeRating(const Metadata* mdata);
+    bool writeRating(TagLib::ID3v2::Tag *tag, int rating);
+
     Metadata* read(QString filename);
     static QImage getAlbumArt(QString filename, ImageType type);
 
@@ -47 +55 @@
 
     AlbumArtList readAlbumArt(TagLib::ID3v2::Tag *tag);
     UserTextIdentificationFrame* find(TagLib::ID3v2::Tag *tag, const String &description);
+    PopularimeterFrame* findPOPM(TagLib::ID3v2::Tag *tag, const String &email);
 };
 
 #endif

mythplugins/mythmusic/mythmusic/musiccommon.cpp

@@ -191 +191 @@
 
     if (m_currentPlaylist)
     {
-        connect(m_currentPlaylist, SIGNAL(itemClicked(MythUIButtonListItem*)), 
+        connect(m_currentPlaylist, SIGNAL(itemClicked(MythUIButtonListItem*)),
                 this, SLOT(playlistItemClicked(MythUIButtonListItem*)));
-        connect(m_currentPlaylist, SIGNAL(itemSelected(MythUIButtonListItem*)), 
+        connect(m_currentPlaylist, SIGNAL(itemSelected(MythUIButtonListItem*)),
                 this, SLOT(playlistItemSelected(MythUIButtonListItem*)));
 
         updateUIPlaylist();
@@ -836 +836 @@
     {
         curMeta->incRating();
         curMeta->persist();
+        if (gPlayer->getDecoder())
+            gPlayer->getDecoder()->commitRating(curMeta);
         m_ratingState->DisplayState(QString("%1").arg(curMeta->Rating()));
 
         // if all_music is still in scope we need to keep that in sync
@@ -843 +845 @@
         {
             Metadata *mdata = gMusicData->all_music->getMetadata(curMeta->ID());
             if (mdata)
+            {
                 mdata->incRating();
+            }
         }
     }
 }
@@ -859 +863 @@
     {
         curMeta->decRating();
         curMeta->persist();
+        if (gPlayer->getDecoder())
+            gPlayer->getDecoder()->commitRating(curMeta);
         m_ratingState->DisplayState(QString("%1").arg(curMeta->Rating()));
 
         // if all_music is still in scope we need to keep that in sync
@@ -1256 +1262 @@
     MetadataMap metadataMap;
     mdata->toMap(metadataMap);
     SetTextFromMap(metadataMap);
-    
+
     m_maxTime = mdata->Length() / 1000;
     if (m_coverartImage)
     {
@@ -1383 +1389 @@
         Metadata *mdata = gMusicData->all_music->getMetadata(trackid);
         if (mdata)
         {
-            MythUIButtonListItem *item = 
+            MythUIButtonListItem *item =
                 new MythUIButtonListItem(m_currentPlaylist, "", qVariantFromValue(mdata));
 
             MetadataMap metadataMap;