MusicBee 歌词插件（基于QQ音乐API）

MusicBee 歌词插件（基于QQ音乐API）

MusicBee 是一个很棒的免费音乐管理、播放软件，支持通过插件来扩展功能。然而 MusicBee 在初始情况下仅对外国的几个歌词数据库进行检索，得到的结果一般是不带时间轴的纯文本歌词，并且检索成功率并不高。自己写咯。

MusicBee歌词插件下载

GitHub链接
使用方法：下载后将所有文件复制到 MusicBee 目录下的 Plugins 文件夹内，重启 MusicBee，在首选项-插件中看到 GetLyrics 插件即成功启用。
在歌词界面 右键-重新搜索 可以查找歌词，默认在切歌时会查找一次，右键-查找下一个提供者 会在插件提供的歌词和内置的数据库查询结果中切换。

2017-8-3 更新

现在可以自己选择搜索结果了

MusicBee插件开发

获取模板

从这里下载MusicBee的插件开发模板。本文以C#为开发语言，熟悉VB的也可以去官网下载VB语言的插件开发模板，具体细节应该大同小异。官方并没有给出任何插件相关文档，所有API和要求都写在了模板里（偷懒，报警了！）。
下载解压应该得到类似的目录结构：

用宇宙最强IDE打开 .csproj 的项目工程文件，其中 TestCSharpDll.cs 这个文件可以随意重命名。在VS中打开以后，可以看到我们主要需要改写的就是这个 TestCSharpDll.cs 文件。

基础信息改写

整个插件有一些基础信息可供定制，改写的位置在 TestCSharpDll.cs -> Initialise方法里面。大概长这样，注意看注释咯：

public PluginInfo Initialise(IntPtr apiInterfacePtr)
        {
            mbApiInterface = new MusicBeeApiInterface();
            mbApiInterface.Initialise(apiInterfacePtr);
            about.PluginInfoVersion = PluginInfoVersion;
            about.Name = "GetLyrics";//你的插件的名字
            about.Description = "Get Lyrics From Internet";//插件描述
            about.Author = "Dixeran";//插件作者
            about.TargetApplication = "";   
            // current only applies to artwork, lyrics or instant messenger name that appears in the provider drop down selector or target Instant Messenger（不知道啥用，别改）
            about.Type = PluginType.LyricsRetrieval;
            //这个很重要，速览定义可以看到，这是一个枚举类型，决定了插件被调用的函数，我这里写的是提供歌词的插件，所以必须是这个值。
            about.VersionMajor = 1;  // your plugin version（插件版本号）
            about.VersionMinor = 0;
            about.Revision = 1;
            about.MinInterfaceVersion = MinInterfaceVersion;
            about.MinApiRevision = MinApiRevision;
            about.ReceiveNotifications = ReceiveNotificationFlags.DownloadEvents;
            about.ConfigurationPanelHeight = 0;   // height in pixels that musicbee should reserve in a panel for config settings. When set, a handle to an empty panel will be passed to the Configure function
            return about;
        }

更改完毕以后，已经可以试着生成了！如果参数都正确的话，把生成的插件（三个文件）放到 MusicBee 安装目录的 Plugins 文件夹内，启动 MusicBee，在首选项->插件中应该可以看到刚刚生成的插件啦。

关键函数改写

插件要起作用，关键在于改写特定的被调函数并且返回正确的格式。例如这里是歌词插件，可以看到在代码中最下面有一个函数RetrieveLyrics(...)，上面还有一大段注释，大概意思就是如果插件类型是PluginType.LyricsRetrieval，这个函数就会被调用，你提供的歌词以 string 对象返回，如果没有查到歌词，返回 null。函数调用提供了很多歌曲相关的参数，足够我们查找歌词了，接下来就是抓取QQ音乐的API并且把查询方法写入函数中。

using System.Net;
using System.IO;
using Newtonsoft.Json.Linq;
using System.Web;

public string RetrieveLyrics(string sourceFileUrl, string artist, string trackTitle, string album, bool synchronisedPreferred, string provider)
        {
            string SearchUrl = String.Format("http://c.y.qq.com/soso/fcgi-bin/client_search_cp?ct=24&qqmusic_ver=1298&new_json=1&remoteplace=txt.yqq.song&t=0&aggr=1&cr=1&catZhida=1&lossless=0&flag_qc=0&p=1&n=20&w={0} {1}&g_tk=5381&hostUin=0&format=jsonp&inCharset=utf8&outCharset=utf-8&notice=0&platform=yqq&needNewCode=0", trackTitle, artist);
            var request = (HttpWebRequest)WebRequest.Create(SearchUrl);
            var response = (HttpWebResponse)request.GetResponse();
            var SearchString = new StreamReader(response.GetResponseStream()).ReadToEnd();
            SearchString = SearchString.Replace("callback(", "");
            SearchString = SearchString.Replace("})", "}");//删除回调中的多余字符

            JObject SearchResult = JObject.Parse(SearchString);//解析搜索结果
            JArray SongList = (JArray)SearchResult["data"]["song"]["list"];//搜索结果曲目列表

            int ID = SongList[0]["id"].ToObject<int>();//从曲目列表得到歌曲唯一id（默认首选）

            var LyricsUrl = String.Format("http://c.y.qq.com/lyric/fcgi-bin/fcg_query_lyric.fcg?nobase64=1&musicid={0}&callback=jsonp1&g_tk=5381&jsonpCallback=jsonp1&loginUin=0&hostUin=0&format=jsonp&inCharset=utf8&outCharset=utf-8&notice=0&platform=yqq&needNewCode=0", ID.ToString());
            var Lyrequest = (HttpWebRequest)WebRequest.Create(LyricsUrl);
            Lyrequest.Referer = "https://y.qq.com/";//QQ音乐查询歌词必带
            var Lyresponse = (HttpWebResponse)Lyrequest.GetResponse();
            var LyricsRawString = new StreamReader(Lyresponse.GetResponseStream()).ReadToEnd();
            LyricsRawString = LyricsRawString.Replace("jsonp1(", "");
            LyricsRawString = LyricsRawString.Replace("})", "}");//删除回调中的多余字符

            JObject LyricsResult = JObject.Parse(LyricsRawString);//解析得到的JSON
            int Lycode = LyricsResult["retcode"].ToObject<int>();//判断是否存在歌词
            if(Lycode != 0)
            {
                return null;
            }
            else
            {
                string LyricsString = LyricsResult["lyric"].ToObject<string>();//解析JSON中的歌词
                LyricsString = HttpUtility.HtmlDecode(LyricsString);
                return LyricsString;
            }
        }

很简短的代码噢，为了解析JSON额外引入了 Newtonsoft.Json 这个库。只要搞懂了下面这个QQ音乐API的解析，代码的逻辑就很明显啦。

QQ音乐API分析

使用的是QQ音乐网页版的API。通过使用Fiddler抓包可以看到，搜索歌曲的时候调用的是

http://c.y.qq.com/soso/fcgi-bin/client_search_cp?ct=24&qqmusic_ver=1298&new_json=1&remoteplace=txt.yqq.song&t=0&aggr=1&cr=1&catZhida=1&lossless=0&flag_qc=0&p=1&n=20&w={关键字}&g_tk=5381&hostUin=0&format=jsonp&inCharset=utf8&outCharset=utf-8&notice=0&platform=yqq&needNewCode=0

返回的结构大概是这样的：

Callback({
    json
})

对回调中的json进行解析，可以得到类似的结构

候选歌曲的列表在data-song-list这个列表，list中的每一个item都是这样的结构

通过这些数据，我们可以做进一步的校验，判断这个item是不是我们所需的音乐；而获取对应歌词的关键是其中的”id”字段，接下来要通过歌曲id请求歌词。

请求歌词的地址是

http://c.y.qq.com/lyric/fcgi-bin/fcg_query_lyric.fcg?nobase64=1&musicid={歌曲id}&callback=jsonp1&g_tk=5381&loginUin=0&hostUin=0&format=jsonp&inCharset=utf8&outCharset=utf-8&notice=0&platform=yqq&needNewCode=0

请求的时候 Refer 必须为https://y.qq.com/，返回的数据类似这样：

Callback({
        json
})

解析其中的json，”lyric”字段就是我们所需的歌词（经过HtmlEncode）。于是通过HtmlDecode()方法即可得到最终的歌词。