From 16793744c0100cf3fd56250ddd6b9e6a6c1f0e23 Mon Sep 17 00:00:00 2001
From: Arnaud Bienner <arnaud.bienner@gmail.com>
Date: Thu, 28 Feb 2013 02:17:15 +0100
Subject: [PATCH] Read and write POPM tags

---
 ext/libclementine-tagreader/tagreader.cpp |  65 ++++++++++++++++++++++
 ext/libclementine-tagreader/tagreader.h   |   5 ++
 tests/data/fmpspopmrating.mp3             | Bin 0 -> 6614 bytes
 tests/data/popmrating.mp3                 | Bin 0 -> 6614 bytes
 tests/data/testdata.qrc                   |   2 +
 tests/song_test.cpp                       |  14 +++++
 6 files changed, 86 insertions(+)
 create mode 100644 tests/data/fmpspopmrating.mp3
 create mode 100644 tests/data/popmrating.mp3

diff --git a/ext/libclementine-tagreader/tagreader.cpp b/ext/libclementine-tagreader/tagreader.cpp
index beb6c70c7..362d9376d 100644
--- a/ext/libclementine-tagreader/tagreader.cpp
+++ b/ext/libclementine-tagreader/tagreader.cpp
@@ -40,6 +40,7 @@
 #include <opusfile.h>
 #endif
 #include <oggflacfile.h>
+#include <popularimeterframe.h>
 #include <speexfile.h>
 #include <tag.h>
 #include <textidentificationframe.h>
@@ -180,6 +181,25 @@ void TagReader::ReadFile(const QString& filename,
                          song);
         }
       }
+
+      // Check POPM tags
+      // We do this after checking FMPS frames, so FMPS have precedence, as we
+      // will consider POPM tags iff song has no rating/playcount already set.
+      qLog(Debug) << "POPM";
+      if (!map["POPM"].isEmpty()) {
+        const TagLib::ID3v2::PopularimeterFrame* frame =
+            dynamic_cast<const TagLib::ID3v2::PopularimeterFrame*>(map["POPM"].front());
+        if (frame) {
+          // Take a user rating only if there's no rating already set
+          if (song->rating() <= 0 && frame->rating() > 0) {
+            song->set_rating(ConvertPOPMRating(frame->rating()));
+          }
+          if (song->playcount() <= 0 && frame->counter() > 0) {
+            song->set_playcount(frame->counter());
+          }
+        }
+      }
+
     }
   } else if (TagLib::Ogg::Vorbis::File* file = dynamic_cast<TagLib::Ogg::Vorbis::File*>(fileref->file())) {
     if (file->tag()) {
@@ -486,8 +506,26 @@ bool TagReader::SaveSongStatisticsToFile(const QString& filename,
 
   if (TagLib::MPEG::File* file = dynamic_cast<TagLib::MPEG::File*>(fileref->file())) {
     TagLib::ID3v2::Tag* tag = file->ID3v2Tag(true);
+
+    // Save as FMPS
     SetUserTextFrame("FMPS_Rating", QString::number(song.rating()), tag);
     SetUserTextFrame("FMPS_PlayCount", QString::number(song.playcount()), tag);
+
+    // Also save as POPM
+    TagLib::ID3v2::PopularimeterFrame* frame = NULL;
+
+    const TagLib::ID3v2::FrameListMap& map = file->ID3v2Tag()->frameListMap();
+    if (!map["POPM"].isEmpty()) {
+      frame = dynamic_cast<TagLib::ID3v2::PopularimeterFrame*>(map["POPM"].front());
+    }
+
+    if (!frame) {
+      frame = new TagLib::ID3v2::PopularimeterFrame();
+      tag->addFrame(frame);
+    }
+
+    frame->setRating(ConvertToPOPMRating(song.rating()));
+    frame->setCounter(song.playcount());
   } else {
     // Nothing to save: stop now
     return true;
@@ -734,3 +772,30 @@ bool TagReader::ReadCloudFile(const QUrl& download_url,
 }
 #endif // HAVE_GOOGLE_DRIVE
 
+float TagReader::ConvertPOPMRating(const int POPM_rating) {
+  if (POPM_rating < 0x01) {
+    return 0.0;
+  } else if (POPM_rating < 0x40) {
+    return 0.20; // 1 star
+  } else if (POPM_rating < 0x80) {
+    return 0.40; // 2 stars
+  } else if (POPM_rating < 0xC0) {
+    return 0.60; // 3 stars
+  } else if (POPM_rating < 0xFF) {
+    return 0.80; // 4 stars
+  }
+  return 1.0; // 5 stars
+}
+
+int TagReader::ConvertToPOPMRating(const float rating) {
+  if (rating < 0.20) {
+    return 0x00;
+  } else if (rating < 0.40) {
+    return 0x01;
+  } else if (rating < 0.60) {
+    return 0x80;
+  } else if (rating < 0.80) {
+    return 0xC0;
+  }
+  return 0xFF;
+}
diff --git a/ext/libclementine-tagreader/tagreader.h b/ext/libclementine-tagreader/tagreader.h
index 314f11bb7..e21384dac 100644
--- a/ext/libclementine-tagreader/tagreader.h
+++ b/ext/libclementine-tagreader/tagreader.h
@@ -93,6 +93,11 @@ class TagReader {
                     TagLib::ID3v2::Tag* tag) const;
 
 private:
+  // Returns a float in [0.0..1.0] corresponding to the rating range we use in Clementine
+  static float ConvertPOPMRating(const int POPM_rating);
+  // Reciprocal
+  static int ConvertToPOPMRating(const float rating);
+
   FileRefFactory* factory_;
   QNetworkAccessManager* network_;
 
diff --git a/tests/data/fmpspopmrating.mp3 b/tests/data/fmpspopmrating.mp3
new file mode 100644
index 0000000000000000000000000000000000000000..c1f8bf629d861753899e08d1f2021e5f91a958e0
GIT binary patch
literal 6614
zcmeI1cT`j78^>=*2mvBxN&<*XDazq@vlz+<A?&?}C?pISDj?7zT1nVN3MhyWP(g+a
zs|d7KK?wv2$`D0SYH7eoEe?o~Qj~FjL2CPF&uM#pL;arf-t*jd-TOYD_j&L8p6fs*
zzyXm^3f>Ohc#$C~N|f;MIE{UA1aE(Tf6=X+DA~HWdj)&a5~KF-0YF0{-rddJWxY0q
zwm%^<JRD$%Za?ay2R?e>z3~9FRM-Omiit-}d@eJjv6?R|E$I{h78(;{^cf+*0WU~E
zZ8t)}iz`fXLZc~!_#!1N?$!JzEY3q=gCyuKf9GteJ=|S|QHZQ`k*KWLge<FzVnvkI
zWmi4>g?`B->r<uN8=>6UhxecTI?LlGzv6QX)Ty;ID@%)$lMIm;VUr@gGp0ouXjgT0
z^+J(BPEJlfA}X=0nw(t*&;pTGMA@dzg85YdfHTN&hG~WdC7Z)!FhE)4zf4_iw{A9f
zVzaRb7F!1v`Yn^9u%W|;56=OnKW$c0cD50mL+cGUX$JG)m`rbUg<RqpxOt8c?O(*e
z``R3{`3|eQjZLehF^^70Bf;!khwT<f35qPnT7peeGlVfF0+G_NK!f9FCPMl&nT$9y
zqy&2cqm3ko08&gQc^fnlf)Y<Z$o!Tp27`x7YXS^7^qOds<zJ>%gJ5a(NJEf~{4)pT
zW7HlMXwu!An(SnT1>i7-loza7DnYy+(+cRQrX!XOL&HkAtseH@v?>>xLrced<izar
z^i*~U7#iIf;Ypp5&ID<)dMjdCg@ZIu<|EH5Rg0lfS}UY2+B@P=*DQL%9<2amWTkFE
zmNYi%b(<q5yWmQ@^38Hq!Ihk5&&?eXGm>q4_x)1VvduF%6eOFk9#(k19f0G?(G$l=
z(uI%9=cUlTeCxDYzEy`eN77!o$h8>l>_v>$c;Mk>uFyq^kp3h<{m`<<1kU@clh$2~
znKD+)scf-GwcW7vOHQR~+ETCTzVx%0yej7kogY-FXH-<aVky4Dx;tPfh&p(1wszve
z4(OG2Gz39BXvOluY6i4AsGp->Ul-2R6Yur;>%wcC#E10~tV~H+f#9udYm!s44@pl#
z8EmH@jN}o0Kc$Bm48cQ4QI!ZAmp#5gpt0y3-sz1RZFst(06Cd*x_XiJGS7DJsog4j
zJ@Q;>3y8=sc8*=A|1|N1YU=LDHpxszuFMnLDMiN9HA1K0c5&KjuBmCX&6)HYJfY*N
zJ)(T>+qHgI3!pa&vR)p}{rRrac_;q*$ljNhc(qczdp|+fg5($ja_sh!u%;~H0+#}|
zq$!hf$+v7q_B6`Kd6AA4BOG1)0(Yj;g4g``R#w?C&ElG|x-Yx9ZP;9U^Z4%B`(0iB
z=3Ti5Hhwu+z-*ANs%dPfzAIOfS(Q<lB15=5XY58>BLt<}^=V^dpfnl^!56<RaC`<q
zP0-4=`p#J45eWLla^=YRXu4Fiep&p@uK44PAF}Y6GCXyN0J9@)Oa`xJpCnGD+$M6e
z_koR+EyTwe{Wbg;y`jxi(v@VigD8el1ld20(osg?G>xcdz6Yqo^fUR_<K^O5aSi#S
z^m_5cg!0kot#grg+afDYhX)*>$!es(n1u2?cTROah8lU0Fm;^}w^(nDkd=<O7LzBm
z_xttbofY12Tk6<1gTtk1tlWs8193s&?@Ju~opIn5OYz_ce#)8neJ0pq*Fn6{E+FP}
zi@_=}W8(Jj26_nlYxDI<q&s`jt`5q9pDkV<e-}b4eV{xb0~)Y1K@XS;c!J`B^U0Pn
zxs=pra##X`3!v1Rjy)m4QiwJ*qI@7ervp4JXJh->I-%afx^H91K%BltXw{b8v#CKC
z>%i(N<SiVzy)Y|!%1F?~>%l9Q5yd@<_q_1@qBOql-x=!vX<GvTuA1Ye)*q^SJi(IB
zku=#~WO2@a#7wZ)3+23-6H;v?U)}S$WiY?mRzkf=QQAD&ZzZAJpIq=8r;Zx}wL!Yc
zgL?zdqk&$6dhyS;(`rxM)SvW{rR!fN=Z%iu8$m|id9&QFkkL&JX@7zHZI#P=OUTMO
z_i^TG&i9W}bxQ<AkDkYVezBlw=FpOIJG7i`bkOmd_s(;rufF~xtinFH1rH@6WN)o{
zv`ELZ+Ds<_)e&dCBPOES^xl4L3ARR&(*+~uNdJDz3-fhWD2iV*@#VEvXv(>}lFuHN
z4|+5O&ar;r8fv0uPArAIOxBF!?m+(_)UO}oPTW^MJd(#AKw!EHGg@;aMmH~xGZHUt
zY<ja!$R4As;tJ8NsF`#tQ4B4_crGN3*%Vv8u4{N;e7EBa_iEkQ6I$n5)%8zqYOM49
zfEPa8VmVIu5PvY3xUmi_$<Zc2N2UmTi6t<DLdV0yhH2Kxn}(dkjPy0se4Nht+JwSl
z-QF#8LI@frrmLW>RrAYFN7-VgwV#}NdaC3UM|-Yxx+_=xC|GW|%*vQkaXVEOompxx
zxAE(pYM0ju*}l+QBSec9*Mf-%&EYJb&hlP7;$BM(4)hwi<oe@}nd28D(!b&JeM6^*
zjvQ@c$JR#uzIk>0fFcPeWZ@>p@ji6ItxI5Dp9P__^D3d%9s?dsi^Xj#yu%=*u=2g<
zjc{m<^Cu14vK|IB&b%W8LDQfTqXYz*iC_tn4DxNi!c7k~SOf^u%vDQz33553xaxF8
zFa`b${22~{<M0-6D{P$*cX@rMuzQ`5Ke&lu0d4>=yYz<wnq>gCzl@+$!ldkUxIk?(
zEB=BcSty%nwYnvpiHbGtFH7)gK$#}^^i>dLvTX5jL0Db4s-F+-fYl|n_Eorls-{_$
z6S~D;bYwL_rF^xDQOfNr9KL~Y=J+-7@9e&qnj^(MW_aG0I$%8elyT9I+sZA_+U0*!
z!T1Q27`mq*n#!z?Ri_T}x#JifcU+5l|3|ZPgZ!BS9xu6;^!YK;uZLzo;mrtZ&8J-s
z&CZ-GNMihPKKRGyj_Ak?M<K<SK!_|_zlVAwNqRtvjq0v<3OC+>1QvU|i34tkVm1+>
z(^4cMy9=~~#goOI`>~j24NQolu{A(8xJm<1w0g&ohlV)=!nSrEnxi}@Z<Ke{09_$p
z<kPN!jY);dwW?S~S!IvSSk1o?nt1yivK}O!6}v8g<zZhWnd#?_gw$q1(EQmG)l;zv
z4Uw(KM~ZGYX_xETv9=G<h%$Z<^tvu%^76KW4N=q8H3wU6Rn<9IRUvfppD!6SY;Y7!
zo#jE#o?G%^eR0A8dg)C%nL9Dj-;&rjr^AiAZ8E^suelPczBa?=l@S~{1bhP%uGEtt
zYdwNy&nqIdKY>@H0ggOpUdH;6B`^{W^L+f~Rzv4ngB7U(B)}kxDPp965*M8TF+dtT
z4rrj;rZ0$0`)S9hAgp&(cX4kJrZ}pW8q8a3BvO*n_SvL$bNxEzOoZ??zi)oF{uxqd
zD;FDrp{a=>{?BUuQ{`_7F$_G$%mZc^vH(C#X8?$Qs`K}-pZ^k}bT$C15yh{Dh!6w#
VNa%lRW_erLz59nELi8UO^ly>v-k$&f

literal 0
HcmV?d00001

diff --git a/tests/data/popmrating.mp3 b/tests/data/popmrating.mp3
new file mode 100644
index 0000000000000000000000000000000000000000..9408934e0c2717adb381cb37502a80b841bd8328
GIT binary patch
literal 6614
zcmeI1c~leE7sn?ggg_!?H3=ZHN>L8K$;P5AA%uP37g0!9%Ax`SEuw{ly+{EC5dtd6
zB8yc7TC1RhMS`-3qA0aAV5AloKu9UdGQS|T{j=w^J-?;;{bSCZH*??2yPtROym!Wq
zPC@`8q2xX7Jc%Mh5&+<|(9jsQ{V^n07gwi^CK}^FTzF_Gz!IH)(1!?oh`{?00cg3P
z2LKe}j~aPhW})%wFU-xEGyoPH6=m=#$<K~B7l+zufPxp58)pYc(nzs|ig?1Sg)Ml3
zoBSq8&{giv*%Dj0s}idKS>Ys6QN9IPS{uO$E3M6{eD*W*l2PWzia9red9x4iKl^2t
z&r5tI;N`2*Yi3rLmnJ7!q5#7tMS5pUiyAP_s;a65B7>Tkn3ycOVqQ5py8>Y5L|PR!
z8#m1@tceO3iwb8Mr>oJjy4friD1-c$v9tB|t)>oKE*`<*YQciPVbkO{wR;KR*}(M2
zO^R4YtGRO+o#96HKt3Fo;fX1ijXwi7%@$&O3t2>Ot7BH*;<a~h85Ion(aA_8n3ZF<
z(+nv=lfhX^a2YE4FxG@W5)Jd$JAP&&s85~EiZMY-a3^q@NNNxu#b#4?KodbI@w7wi
zZ>VB0cqm#OV8Nl+WUEZyQjKZ^N23P~K~{3l?6Ak^Jxb7|t0z6t!2}P$VJs;RSd&zo
zcpa_<&{9rAtmp@a6!Ti#Y`<>77MMcI$9rVOY;$##_RO)=y3#`vI>H@EXsT)pVnwMN
zsfQIH&ns4mVNe>Ylx>>3Vo}%3dO{wp0#sy$wqGV1AMv`?9+#DWr44(tjFW#QyUBfP
zd)SO*>%RRzmp1Qk4-5vWrfWy!pYH_Vgfh&;F$%iiaoK_t##>;SS|hM%_w1Im#TGgj
zVH`ckk!lazJWS;~X<_J({8SIGxJ?i|&pK$_#hGC7Vh*KCh01OEC0}$`D5oy>D(_D_
zi_5KaEZ6#8iGD^&=}V5nE4-^6j)tg(2WDx;FYba~Sw=z-#D`YRAFQQAYlFJkx^=ao
zJRR{~uRkxM+DT$aFUi7~lIaiL%Ce+5BzjSFB(Pu`4PhXM==(7(L~jTlM2V<CSUG*-
z9RM1N-r=3zs4#}7%kz<wNvErp7%y|J_nq3Sw9hTqnX!ln|9tn@b>@!~pDU;A4R4jq
zVC6_Zv7S<3JzXbs3T_jlsp6cH%GjF0yulaRuh}BX=D%6*cP$@!BQN9O=GdR-jLtpr
z=STKW@g%C05MBF8+GZ5{D6rdR9|dpBAusZ1U~?*#l0&^^HS$S=w5$i^SP{bB$;W?p
z3L|hmj&Eg=1ye7o9;^MLlh=yRu{DkDn!VrI>1*1Vb8zz)gZb=wbY*ozebrsr;*84l
ziX>^$<#|IF#yTM=&8ANiCk>@CPzZte?K%5r5Yz~*?x^dC7A8Z`&*rPi=OdX?k-DX^
zH#=jGH@wdx;!271Arj1nvN;jFnst&qm2{ijowXlqplu^RPVcW4MClA|rBkjXV(dgY
zlr)$1<0unl5Xw-Cc;<bOKFmCmcRf}%h7(htH_EINkB=)GjodyTez!He{B)?_L57T4
z+KWjj*M0X?$78604+&E?2=R(^)(Kf?iEFU=LR+6-Ufx;d54Wa_eLXl_lFG>m3pf}P
z5c*HagTFEkqCyD~93f6QlE2FUn{C?37ux2?dAuU9Qp}LN^V@+Q(t(;hT?*ySK8&*+
z*8kI`%j54-XtfWN1EfJcZU*QEQvy%WoCsc7Qbv~&`izc9;0S)S8so7i6j&13ib0n1
zCuX;UM`W$6KiweIdqn$f4(W+A*9omzb9=Vb3#08godx{G<lBq0qNj`mT)ZB*Y93b9
zqj1lIC@4%7X#bU={-65l0dVDP50(C4?c;Igf^JEp1BGVid`C>?_IaQjw{{0r8OT-j
zd}bafsIrz&ZB#&;Ci<+#mHAThf92GEV@_p|Y4qUU!1G9;m!w+sll8R9Qy0}Iy;OAF
z%f#H#(R(Av@H=l-`sLHRs6lNn2)|aj+_!`*9CIFLtYv@qC`G$?uJF<G=+7?ZH_jYh
z#<oE#X$FVvuX*l1SMuts-_t7Oy(@Sq5g}Vk<)ejK?o}pQaj5nf%Uw}nRmS%YXi9L^
z3LP#Out)k2m|s|^wLsB)n#eD&wLnvjT@?cEuw1~SDR7?iJx^a9HFIJ)=w+gM3~v|a
zd!cUK7;oY}_Q*&scL0IwDoAh12^-zIG|q~@w7K!k1|eIVwvsc%w4i4&EkrrA80Eg0
zFlJR`{<^mQf#KcuGrX&{XHRIHYf;rbxuv1j`#mmvgrzcq@FDR~AbE2wSe&g%f|935
z0*PfXoyH`>LxvfaiCcyo#0+%RRJ<I{d0Pd;qFvsVIUxiMlhc$imdbf$rz5O!)0$6C
zJv~)?s#|luWV$m)^(a`TzrsnMS8_R38ktdIE4%rt-71$i2wA_-StrDZ6xV=>2+b4B
zp3d@LJmOu85A^pKx#axA4;kYZ!_vMM2)u)*hmw!Ba-(Y^ep|fSzekxw5ON3;<3uke
z>DDDMx6h2!(Q%bjV~Yb1rA8BW6x?Bvk~n#u3kC#?+WC|Et(gz~8fM-Rf}m+okyQ+W
z?0B%4O$7zkUlOK=>dpLwsiw-sy(HP}Q9@Ok0+<AU2L1#G!EtyqxE;1Zh_|w_QrNpe
z$QRtgG6OdOxIMZ<eofK<*H?P3L&B)^bm*MQWM=FINvcpL!(we)8XFaD++P~!RgW@`
z^Xe-nOJ`aWV*>EnE|otW-UX{oXz43={a8i4GCO#iuV~9^gi88y4X2pXS1^17;n?ld
zD7drtVoJ6Y@0k91Z~B1Y>{Hf7A6^SDUt^E&O?ks)C_ea;{75>xE?Sj7DBz9b_`Goq
z`u!hF&J7A?^7;J48p>zKD8C$@{fIv!tTCN-Iy^gbGCzU!`~Ki>pF5&0GaQ8!V*^1l
z7~LNFjRf?76c^Q1=MZYR2?;Fqc#;QP5Jg-vLaVt@LS_$W1B<1KJNDyoO=`Fx1w%`K
zs&|zEpcr-bK@at_2ZXI{d`vfXP|hItsvf3XuF$JZ4Ih;Pm1$IR3^Gd}n{b+bB{cE&
zJ7hUXJ}Y*84wj35kzk^mGZIvj2|){IPgG4s$JK|o93LsX-KbfnZNu3)#2`!iK+x;j
z^vTOR4%J6YS5+TszExRkXHkjJ%6q=7SHH<#G<8-6-Ft4yh4jS;2bd){nN;4yM1OO9
z-@Fzt=C;uQPq+F?u<H5@Tfic^WfAaAY`9`ioQ&lNhP$AE(EJEqg#o(dx)-D^51Ruc
zp)mKyZ*J9htUIhq4Ilv)RZIaV1r$4J4Tu3~@Hn7`X`Q|xGHs{rBLeWA5nV;S0l1=w
z8hRjq-ASYb#htSW8|KDw%#jQctAAVkZ2u#qjuuW<Bz<Eeec~V8`FCA^ONgcCHfHKK
z!;%32avBRj{9T>@1N-?e5lZ6%uxe5Ms)-1(fDeTJr)HL?h0VKvC?Z7vaY6qE7hu?U

literal 0
HcmV?d00001

diff --git a/tests/data/testdata.qrc b/tests/data/testdata.qrc
index 97d7dceb0..42716808b 100644
--- a/tests/data/testdata.qrc
+++ b/tests/data/testdata.qrc
@@ -11,6 +11,7 @@
         <file>fmpsplaycount.mp3</file>
         <file>fmpsplaycountboth.mp3</file>
         <file>fmpsplaycountuser.mp3</file>
+        <file>fmpspopmrating.mp3</file>
         <file>fmpsrating.mp3</file>
         <file>fmpsratingboth.mp3</file>
         <file>fmpsratinguser.mp3</file>
@@ -18,6 +19,7 @@
         <file>manyfiles.cue</file>
         <file>manyfilesbroken.cue</file>
         <file>onesong.cue</file>
+        <file>popmrating.mp3</file>
         <file>pls_one.pls</file>
         <file>pls_somafm.pls</file>
         <file>secretagent.asx</file>
diff --git a/tests/song_test.cpp b/tests/song_test.cpp
index bb92a3312..cb4d5d10a 100644
--- a/tests/song_test.cpp
+++ b/tests/song_test.cpp
@@ -146,4 +146,18 @@ TEST_F(SongTest, FMPSPlayCountBoth) {
   EXPECT_EQ(123, song.playcount());
 }
 
+TEST_F(SongTest, POPMRating) {
+  TemporaryResource r(":/testdata/popmrating.mp3");
+  Song song = ReadSongFromFile(r.fileName());
+  EXPECT_FLOAT_EQ(0.60, song.rating());
+}
+
+TEST_F(SongTest, BothFMPSPOPMRating) {
+  // fmpspopmrating.mp3 contains FMPS with rating 0.42 and POPM with 0x80
+  // (corresponds to 0.60 rating for us): check that FMPS tag has precedence
+  TemporaryResource r(":/testdata/fmpspopmrating.mp3");
+  Song song = ReadSongFromFile(r.fileName());
+  EXPECT_FLOAT_EQ(0.42, song.rating());
+}
+
 }  // namespace