首页 发现 帮助
登录
AndDT
/
slackbuilds
关注 1
点赞 0
派生 0
文件 工单管理 0 合并请求 0 Wiki
目录树: f27ea5443b
分支列表 标签列表
slackbuilds
/
multimedia
/
glyr
/
README.html

README.html 10 KB
文件历史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
    2. 

  2. <html><head><title>Glyr is a search engine for music related metadata</title></head><body><h1>Glyr is a search engine for music related metadata</h1>
    3. 

  3. 

  4. <p>The finest search you can buy for no money <sup>TM</sup></p>
    5. 

  5. 

  6. <p><img src="https://github.com/sahib/glyr/blob/master/doc/screenshot.png" alt="[screenshot]" /></p>
    7. 

  7. 

  8. It comes both in a command-line interface tool and as a C library, both with an easy to use interface.<br />
    9. 

  9. The sort of metadata glyr is searching (and downloading) is usually the data you see in your musicplayer.<br />
    10. 

  10. And indeed, originally it was written to serve as internally library for a musicplayer, but has been extended to <br />
    11. 

  11. work as a standalone program which is able to download:<br />
    12. 

  12. <p>
    13. 

  13. <table border="1">
    14. 

  14. <tr>
    15. 

  15. <th>Getter</th><th>Description</th>
    16. 

  16. </tr>
    17. 

  17. <tr><td>cover</td><td>Coverart (front images supported only)</td></tr>
    18. 

  18. <tr><td>lyrics</td><td>Songtext</td></tr>
    19. 

  19. <tr><td>artistphotos</td><td>Photos of a certain band (press or live)</td></tr>
    20. 

  20. <tr><td>artistbio</td><td>Artist biography from various sites</td></tr>
    21. 

  21. <tr><td>review</td><td>album reviews from various sites</td></tr>
    22. 

  22. <tr><td>albumlist</td><td>A list of albums from a specific artist.</td></tr>
    23. 

  23. <tr><td>tags</td><td>Tags, either related to artist, album or title</td></tr>
    24. 

  24. <tr><td>relations</td><td>links to wikipedia, myspace, musicbrainz ...</td></tr>
    25. 

  25. <tr><td>similarartists</td><td>similar artists</td></tr>
    26. 

  26. <tr><td>similarsongs</td><td>similar songs</td></tr>
    27. 

  27. <tr><td>tracklist</td><td>tracklists of an album</td></tr>
    28. 

  28. <tr><td>guitartabs</td><td>guitartabs in textual form</td></tr>
    29. 

  29. <tr><td>backdrops</td><td> Large artist photos, suitable for backgrounds</td></tr>
    30. 

  30. </table>
    31. 

  31. </p>
    32. 

  32. 

  33. <p><strong>Terminology</strong>:<br />
    34. 

  34. To prevent disambiguation the following terms are used below: 	<br />
    35. 

  35. * <em>glyrc</em> is the command-line interface to libglyr.<br />
    36. 

  36. * <em>libglyr</em> is the library behind, which may be used by your program.<br />
    37. 

  37. * a <em>getter</em> is a type of metadata to download, e.g. <code>cover</code>, sometimes also called <em>fetcher</em><br />
    38. 

  38. * a <em>provider</em> is a source libglyr queries in order to find the data.<br />
    39. 

  39. * <em>glyros</em> is the ruby wrapper for this lib. Currently it is not maintained.</p>
    40. 

  40. 

  41. <h2><span class="caps">FEATURES</span></h2>
    42. 

  42. 

  43. <ul>
    44. 

  44. <li>Many built-in providers (46 at time of writing, ~30 distinct sites), high success-rate (the longer the search, the higher the risk :))</li>
    45. 

  45. <li>Portable: Windows and Linux are supported (Developement on Linux) see <sub><sup class="footnote"><a href="#fn1">1</a></sup></sub> for Mac <span class="caps">OSX, </span></li>
    46. 

  46. <li>Fuzzy matching: Search providers with Levenshtein algorithm to eliminate typos and enhance search results.</li>
    47. 

  47. <li>Decent Unicode support: All sort of valid <span class="caps">UTF8 </span>is taken, and UTf8 output can be forced.</li>
    48. 

  48. <li>Fast Download: libcurl is used internally, and sources are searched in parallel, unneeded data is not downloaded if possible.</li>
    49. 

  49. <li>Lightweight dependencies: libcurl, glib and sqlite (for caching) - typical linux systems have those installed.</li>
    50. 

  50. <li>Download of a user defined amount of items, <code>glyrc cover -a Foo -b Bar -n 30</code> tries to load 30 covers of album &#39;Bar&#39; by artist &#39;Foo&#39;.</li>
    51. 

  51. <li>Grouped download: Query providers by descending Accuray / Speed; controllable by the user over the <code>qsratio</code></li>
    52. 

  52. <li>Optional download of images, <span class="caps">URL </span>is returned otherwise - so it can act a bit like a search-engine.</li>
    53. 

  53. <li>Free Software licensed under the terms of the <span class="caps">GPL</span>v3</li>
    54. 

  54. <li>libglyr is portable, easy, threadsafe and lowlevel enough for everyone.</li>
    55. 

  55. <li>...lots of other options like min/max size for images.</li>
    56. 

  56. <li>A built-in cache to store the metadata (using <span class="caps">SQL</span>ite)</li>
    57. 

  57. </ul>
    58. 

  58. 

  59. <h2><span class="caps">GETTING STARTED</span></h2>
    60. 

  60. 

  61. <h3>Compiling</h3>
    62. 

  62. 

  63. <p>See the <a href="https://github.com/sahib/glyr/wiki/Compiling">compile page</a>.</p>
    64. 

  64. 

  65. <h3>libglyr:</h3>
    66. 

  66. 

  67. <p>See the <a href="https://github.com/sahib/glyr/wiki">examples in src/examples</a> for a quickstart.<br />
    68. 

  68. There&#39;s also a more <a href="https://github.com/sahib/glyr/wiki/Introduction-to-libglyr">gentle (and brief) introduction.</a><br />
    69. 

  69. Also see the <a href="http://sahib.github.com/glyr/doc/html/index.html"><span class="caps">API</span> Reference</a><br />
    70. 

  70. <strong>Please note:</strong> Since version 1.0.0 the <span class="caps">API </span>will be stable, and will only be open for extensions.</p>
    71. 

  71. 

  72. <h3>glyrc:</h3>
    73. 

  73. 

  74. <p>Please refer to <code>glyrc -h</code> which gives you a brief introduction to the arguments you can pass,<br />
    75. 

  75. See the <a href="https://github.com/sahib/glyr/wiki/Commandline-arguments">wiki</a> for more detailed information about the options.</p>
    76. 

  76. 

  77. <h2><span class="caps">FAQ</span></h2>
    78. 

  78. 

  79. <h3>Anyone using it already?</h3>
    80. 

  80. 

  81. <ul>
    82. 

  82. <li><a href="http://gmpc.wikia.com/wiki/Gnome_Music_Player_Client"><span class="caps">GMPC</span></a></li>
    83. 

  83. <li><a href="http://pragha.wikispaces.com/">Pragha</a></li>
    84. 

  84. <li><a href="https://github.com/studentkittens/Freya">Freya</a></li>
    85. 

  85. <li><a href="http://ok100.github.com/lyvi/">lyvi</a></li>
    86. 

  86. </ul>
    87. 

  87. 

  88. <h3>Glyr.. such a silly name! Why? </h3>
    89. 

  89. 

  90. <p>Indeed. Should have named it &#39;Glyros&#39; (too late, damnit).</p>
    91. 

  91. 

  92. <h3>Is it hard to write something with it?</h3>
    93. 

  93. 

  94. <p>Some knowledge of C might be required, but the code is straight forward most of the time.</p>
    95. 

  95. 

  96. <p>Bash scripts are pretty straight-forward:<br />
    97. 

  97. <code>glyrc cover --artist Equilibrium --album Sagas --write &#39;/tmp/:artist:_:album:.:format:&#39; --callback &#39;sxiv &quot;:path:&quot;&#39;</code></p>
    98. 

  98. 

  99. <p>Additionally there are bindings to Python and Ruby:</p>
    100. 

  100. 

  101. <ul>
    102. 

  102. <li><a href="https://github.com/sahib/python-glyr">plyr</a> by me (complete <span class="caps">API</span>).</li>
    103. 

  103. <li><a href="https://github.com/meh/ruby-glyr">ruby-glyr</a> by meh (complete <span class="caps">API</span>).</li>
    104. 

  104. </ul>
    105. 

  105. 

  106. 

  107. <h3>How..how am I supposed to use it?</h3>
    108. 

  108. 

  109. <p>Well, as normal user you could use <code>glyrc</code> to retrieve some metadata in a batchlike fashion.<br />
    110. 

  110. As developers you have lots of option, you could write glyr-plugins for musicplayers (gmpc!), set up a webserver with this,<br />
    111. 

  111. hack up little scripts showing covers on the desktop.. everything related to musicmetadat is possible here.<br />
    112. 

  112. You could also extend libglyr itself but that&#39;s a little harder.</p>
    113. 

  113. 

  114. <h3>Isn&#39;t there musicbrainz already?</h3>
    115. 

  115. 

  116. <ol>
    117. 

  117. <li>The kind of metadata downloaded by glyr differs heavily from musicbrainz.<br />
    118. 

  118. i.e. glyr finds metadata for musicplayers while musicbrainz finds data for CD Rippers and taggers.</li>
    119. 

  119. <li>Musicbrainz runs remotely on some server and uses a large database which is searched through lucene.<br />
    120. 

  120. Glyr is a client program which hops over several sites and does not cache anything, unless you do it yourself.<br />
    121. 

  121. You could of course let glyr run on a (remote) server, and cache all results to do something similiar.</li>
    122. 

  122. <li>There is <a href="http://www.coverartarchive.org">coverarchive.org</a> , but it does not seem to fully work yet. But it will be accessible once it does.</li>
    123. 

  123. </ol>
    124. 

  124. 

  125. <h2><span class="caps">AUTHOR</span></h2>
    126. 

  126. 

  127. <p>See the <span class="caps">AUTHORS </span>file that comes in glyr&#39;s distribution.<br />
    128. 

  128. See also <span class="caps">COPYING </span>to know about your rights.</p>
    129. 

  129. 

  130. <h2>I <span class="caps">CAN HAZ HELP</span>?</h2>
    131. 

  131. 

  132. <h3><span class="caps">BUGS</span></h3>
    133. 

  133. 

  134. <p>If you found one: <em>Meh. Sorry for that.</em><br />
    135. 

  135. If you file a bugreport: <em>Hey, thank you!</em></p>
    136. 

  136. 

  137. <p>Use the <a href="https://github.com/sahib/glyr/issues">Issue Tracker</a> to share your find.<br />
    138. 

  138. Alternatively you may drop me a mail at <sahib@online.de></p>
    139. 

  139. 

  140. <h3><span class="caps">PATCHES</span></h3>
    141. 

  141. 

  142. <p>If you hacked one: Excellent! Send it to me via mail or see below.<br />
    143. 

  143. If you want to add new providers you should look at the existing provider plugins to get an idea how to write one.<br />
    144. 

  144. Starting with lib/cover/lastfm.c isn&#39;t a bad idea either, because it is one of the very simple ones.</p>
    145. 

  145. 

  146. <p><i>Take the usual Git(Hub) approach:</i><br />
    147. 

  147. # Fork this project<br />
    148. 

  148. # Make your changes<br />
    149. 

  149. # Make a Pull request</p>
    150. 

  150. 

  151. <p>If you&#39;re not familiar with git, or just don&#39;t like it,<br />
    152. 

  152. you can also send me the patch via mail: <sahib@online.de></p>
    153. 

  153. 

  154. <p>Thanks for any help in advance!</p>
    155. 

  155. 

  156. <h3><span class="caps">WRITE SOFTWARE THAT USES GLYR</span></h3>
    157. 

  157. 

  158. <p>May sound strange, but you&#39;re giving me a reason to maintain it, write new providers etc.<br />
    159. 

  159. Also bugreports (well, there are no bugs, just in case) are appreciated, or just questions.<br />
    160. 

  160. Those help to make the documentation more clear.</p>
    161. 

  161. 

  162. <h3><span class="caps">DONATE</span></h3>
    163. 

  163. 

  164. <p>You also might consider a small (CS-Students are already motivated by 1 Cent <img src="http://www.blendpolis.de/images/smilies/icon_wink.gif"/>) donation if you use feel like it:<a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="https://github.com/sahib/glyr"></a><br />
    165. 

  165. <noscript><a href="http://flattr.com/thing/302682/libglyr" target="_blank"><br />
    166. 

  166. <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0" /></a></noscript>
    167. 

  167. (For now only possible via Flattr or <a href="http://sahib.github.com/donate.html">Paypal</a> , you gonna need an account there - Sorry)</p>
    168. 

  168. 

  169. <h2><span class="caps">DISCLAIMER</span></h2>
    170. 

  170. 

  171. <p>As usual, no warranty is granted that this software works like expected.<br />
    172. 

  172. Refer to the <span class="caps">GPL</span>v3 copy you got with libglyr. It is <a href="https://github.com/sahib/glyr/blob/master/COPYING">here.</a><br />
    173. 

  173. Glyr is just a way to find the data, it does not own any rights on the data it found.</p>
    174. 

  174. 

  175. <p><b>All retrieved items are copyrighted by their respective copyright owners.</b></p>
    176. 

  176. 

  177. <p>Refer to the provider&#39;s terms of use. Every item you get from libglyr contains the name and a url to the provider, so lookup there terms of use there.</p>
    178. 

  178. 

  179. <p><br /><br />
    180. 

  180. <br /></p>
    181. 

  181. 

  182. 

  183. 

  184. <p>[1] Glyr has not been tested on Mac <span class="caps">OSX </span>yet. If you own a Mac, any help with &#39;porting&#39; glyr is highly appreciated. My guess would be that no to almost no changes need to be done though.</p></body></html>
    185.