Ticket #11947: flac_embedded_art.patch

mythtv/libs/libmythmetadata

@@ -41 +41 @@
         return new MetaIOOggVorbis;
     else if (extension == "flac")
     {
-        MetaIOID3 *tagger = new MetaIOID3;
+        MetaIOFLACVorbis *tagger = new MetaIOFLACVorbis;
         if (tagger->TagExists(filename))
             return tagger;
         else
         {
             delete tagger;
-            return new MetaIOFLACVorbis;
+            return new MetaIOID3;
         }
     }
     else if (extension == "m4a")

mythtv/libs/libmythmetadata

@@ -2 +2 @@
 // Libmyth
 #include <mythcontext.h>
 
+// qt
+#include <QBuffer>
+
 // Taglib
 #include <xiphcomment.h>
 
@@ -145 +148 @@
     return metadata;
 }
 
+/*!
+ * \brief Read the albumart image from the file
+ *
+ * \param filename The filename for which we want to find the albumart.
+ * \param type The type of image we want - front/back etc
+ * \returns A pointer to a QImage owned by the caller or NULL if not found.
+ */
+QImage* MetaIOFLACVorbis::getAlbumArt(const QString &filename, ImageType type)
+{
+    QImage *picture = new QImage();
+    TagLib::FLAC::File * flacfile = OpenFile(filename);
+
+    if(flacfile) {
+        TagLib::FLAC::Picture* pic = getPictureFromFile(flacfile, type);
+        if(pic) {
+            picture->loadFromData((const uchar *)pic->data().data(),
+                                            pic->data().size());
+        } else {
+            delete picture;
+            return NULL;
+        }
+        delete flacfile;
+    }
+    return picture;
+}
+
+TagLib::FLAC::Picture *MetaIOFLACVorbis::getPictureFromFile(
+                                        TagLib::FLAC::File *flacfile,
+                                        ImageType type) {
+    using TagLib::FLAC::Picture;
+
+    Picture *pic = NULL;
+
+    if (flacfile) {
+        Picture::Type artType = PictureTypeFromImageType(type);
+
+        // From what I can tell, FLAC::File maintains ownership of the Picture pointers, so no need to delete
+        const TagLib::List<Picture *>& picList = flacfile->pictureList();
+
+        for(TagLib::List<Picture *>::ConstIterator it = picList.begin();
+                it != picList.end(); it++) {
+            pic = *it;
+            if(pic->type() == artType) { //found the type we were looking for
+                break;
+            }
+        }
+    }
+
+    return pic;
+}
+
+TagLib::FLAC::Picture::Type MetaIOFLACVorbis::PictureTypeFromImageType(
+                                                ImageType itype) {
+    using TagLib::FLAC::Picture;
+    Picture::Type artType = Picture::Other;
+    switch (itype)
+    {
+        case IT_UNKNOWN :
+            artType = Picture::Other;
+            break;
+        case IT_FRONTCOVER :
+            artType = Picture::FrontCover;
+            break;
+        case IT_BACKCOVER :
+            artType = Picture::BackCover;
+            break;
+        case IT_CD :
+            artType = Picture::Media;
+            break;
+        case IT_INLAY :
+            artType = Picture::LeafletPage;
+            break;
+        case IT_ARTIST :
+            artType = Picture::Artist;
+            break;
+        default:
+            return Picture::Other;
+    }
+    return artType;
+}
+
+/*!
+ * \brief Read the albumart images from the file
+ *
+ * \param filename The filename for which we want to find the images.
+ */
+AlbumArtList MetaIOFLACVorbis::getAlbumArtList(const QString &filename)
+{
+    using TagLib::FLAC::Picture;
+    AlbumArtList artlist;
+    TagLib::FLAC::File * flacfile = OpenFile(filename);
+
+    if (flacfile) {
+        const TagLib::List<Picture *>& picList = flacfile->pictureList();
+
+        for(TagLib::List<Picture *>::ConstIterator it = picList.begin();
+                it != picList.end(); it++) {
+            Picture* pic = *it;
+            // Assume a valid image would have at least
+            // 100 bytes of data (1x1 indexed gif is 35 bytes)
+            if (pic->data().size() < 100)
+            {
+                LOG(VB_GENERAL, LOG_NOTICE,
+                    "Music Scanner - Discarding picture "
+                    "with size less than 100 bytes");
+                continue;
+            }
+
+            AlbumArtImage *art = new AlbumArtImage();
+
+            if (pic->description().isEmpty())
+                art->description.clear();
+            else
+                art->description = TStringToQString(pic->description());
+
+            art->embedded = true;
+
+            QString ext = getExtFromMimeType(
+                                TStringToQString(pic->mimeType()).toLower());
+
+            switch (pic->type())
+            {
+                case Picture::FrontCover :
+                    art->imageType = IT_FRONTCOVER;
+                    art->filename = QString("front") + ext;
+                    break;
+                case Picture::BackCover :
+                    art->imageType = IT_BACKCOVER;
+                    art->filename = QString("back") + ext;
+                    break;
+                case Picture::Media :
+                    art->imageType = IT_CD;
+                    art->filename = QString("cd") + ext;
+                    break;
+                case Picture::LeafletPage :
+                    art->imageType = IT_INLAY;
+                    art->filename = QString("inlay") + ext;
+                    break;
+                case Picture::Artist :
+                    art->imageType = IT_ARTIST;
+                    art->filename = QString("artist") + ext;
+                    break;
+                case Picture::Other :
+                    art->imageType = IT_UNKNOWN;
+                    art->filename = QString("unknown") + ext;
+                    break;
+                default:
+                    LOG(VB_GENERAL, LOG_ERR, "Music Scanner - picture found "
+                                             "with unsupported type");
+                    delete art;
+                    continue;
+            }
+
+            artlist.append(art);
+        }
+    }
+
+    delete flacfile;
+    return artlist;
+}
+
+/*!
+ * \brief Write the albumart image to the file
+ *
+ * \param filename The music file to add the albumart
+ * \param albumart The Album Art image to write
+ * \returns True if successful
+ *
+ * \Note We always save the image in JPEG format
+ */
+bool MetaIOFLACVorbis::writeAlbumArt(const QString &filename,
+                              const AlbumArtImage *albumart)
+{
+    using TagLib::FLAC::Picture;
+    if (filename.isEmpty() || !albumart)
+        return false;
+
+    bool retval = false;
+    
+    // load the image into a QByteArray
+    QImage image(albumart->filename);
+    QByteArray imageData;
+    QBuffer buffer(&imageData);
+    buffer.open(QIODevice::WriteOnly);
+    // Write the image data to a file
+    image.save(&buffer, "JPEG");
+
+    TagLib::FLAC::File * flacfile = OpenFile(filename);
+
+    // This presumes that there is only one art item of each type
+    if (flacfile) {
+        // Now see if the art is in the FLAC file
+        Picture *pic = getPictureFromFile(flacfile, albumart->imageType);
+
+        if (pic)
+        {
+            // Remove the embedded image of the matching type
+            flacfile->removePicture(pic, false);
+        } else
+        {
+            // Create a new image of the correct type
+            pic = new Picture();
+            pic->setType(PictureTypeFromImageType(albumart->imageType));
+        }
+
+        TagLib::ByteVector bytevector;
+        bytevector.setData(imageData.data(), imageData.size());
+
+        pic->setData(bytevector);
+        QString mimetype = "image/jpeg";
+
+        pic->setMimeType(QStringToTString(mimetype));
+        pic->setDescription(QStringToTString(albumart->description));
+
+        flacfile->addPicture(pic);
+        
+        retval = flacfile->save();
+
+        delete flacfile;
+    } else
+    {
+        retval = false;
+    }
+
+    return retval;
+}
+
+/*!
+ * \brief Remove the albumart image from the file
+ *
+ * \param filename The music file to remove the albumart
+ * \param albumart The Album Art image to remove
+ * \returns True if successful
+ */
+bool MetaIOFLACVorbis::removeAlbumArt(const QString &filename,
+                               const AlbumArtImage *albumart)
+{
+    if (filename.isEmpty() || !albumart)
+        return false;
+
+    bool retval = false;
+    
+    TagLib::FLAC::File * flacfile = OpenFile(filename);
+
+    // This presumes that there is only one art item of each type
+    if (flacfile) {
+        // Now see if the art is in the FLAC file
+        TagLib::FLAC::Picture *pic = getPictureFromFile(flacfile, albumart->imageType);
+
+        if (pic)
+        {
+            // Remove the embedded image of the matching type
+            flacfile->removePicture(pic, false);
+            flacfile->save();
+            retval = true;
+        } else
+        {
+            retval = false;
+        }
+        delete flacfile;
+    } else
+    {
+        retval = false;
+    }
+
+    return retval;
+}
+
+bool MetaIOFLACVorbis::changeImageType(const QString &filename,
+                                const AlbumArtImage* albumart,
+                                ImageType newType)
+{
+    if (filename.isEmpty() || !albumart)
+        return false;
+
+    if (albumart->imageType == newType)
+        return true;
+
+    bool retval = false;
+
+    TagLib::FLAC::File * flacfile = OpenFile(filename);
+
+    // This presumes that there is only one art item of each type
+    if (flacfile) {
+        // Now see if the art is in the FLAC file
+        TagLib::FLAC::Picture *pic = getPictureFromFile(flacfile, albumart->imageType);
+
+        if (pic)
+        {
+            pic->setType(PictureTypeFromImageType(newType));
+            flacfile->save();
+            retval = true;
+        } else
+        {
+            retval = false;
+        }
+        delete flacfile;
+    } else
+    {
+        retval = false;
+    }
+
+    return retval;
+}
+
 bool MetaIOFLACVorbis::TagExists(const QString &filename)
 {
     TagLib::FLAC::File *flacfile = OpenFile(filename);
@@ -162 +470 @@
 
     return retval;
 }
+
+QString MetaIOFLACVorbis::getExtFromMimeType(const QString &mimeType)
+{
+    if (mimeType == "image/png")
+        return QString(".png");
+    else if (mimeType == "image/jpeg" || mimeType == "image/jpg")
+        return QString(".jpg");
+    else if (mimeType == "image/gif")
+        return QString(".gif");
+    else if (mimeType == "image/bmp")
+        return QString(".bmp");
+
+    LOG(VB_GENERAL, LOG_ERR,
+        "Music Scanner - Unknown image mimetype found - " + mimeType);
+
+    return QString();
+}

mythtv/libs/libmythmetadata

@@ -25 +25 @@
     virtual ~MetaIOFLACVorbis(void);
 
     bool write(const MusicMetadata* mdata);
+    bool writeAlbumArt(const QString &filename, const AlbumArtImage *albumart);
+    bool removeAlbumArt(const QString &filename, const AlbumArtImage *albumart);
+
     MusicMetadata* read(const QString &filename);
+    AlbumArtList getAlbumArtList(const QString &filename);
+    QImage *getAlbumArt(const QString &filename, ImageType type);
+
+    bool supportsEmbeddedImages(void) { return true; }
+
+    bool changeImageType(const QString &filename, const AlbumArtImage *albumart,
+                         ImageType newType);
 
     virtual bool TagExists(const QString &filename);
 
 private:
     TagLib::FLAC::File *OpenFile(const QString &filename);
+    TagLib::FLAC::Picture *getPictureFromFile(TagLib::FLAC::File *flacfile,
+                                            ImageType type);
+    TagLib::FLAC::Picture::Type PictureTypeFromImageType(ImageType itype);
+    QString getExtFromMimeType(const QString &mimeType);
 };
 
 #endif