├── LICENSE ├── README.md └── vuiet.el /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Vuiet 2 | 3 | ![melpa](https://melpa.org/packages/vuiet-badge.svg) 4 | 5 | Vuiet is a music player and explorer for Emacs users. It is similar in scope to 6 | [lastfm](https://last.fm) on which it is based. All tracks are played from 7 | youtube using mpv in the background and music info taken from last.fm. Vuiet 8 | supports the "discovery mode", where it lets you create your own playlists based 9 | on artist, genre or your loved songs similarities. Or, you can specify single 10 | tracks, top tracks from a given artist, known albums, etc. There is also a 11 | lyrics database that is optionally updated with each track you play and this 12 | database can be searched interactively and played from. 13 | 14 | # Table of Contents 15 | 16 | - [Vuiet](#vuiet) 17 | - [Overview](#overview) 18 | * [Music Browser](#music-browser) 19 | * [Music Player](#music-player) 20 | * [Play by Lyrics](#play-by-lyrics) 21 | * [Other Features](#other-features) 22 | - [Installation Requirements](#installation-requirements) 23 | - [Complete functionality](#complete-functionality) 24 | * [Playlists](#playlists) 25 | * [Browser](#browser) 26 | * [Player Interaction](#player-interaction) 27 | * [Customization](#customization) 28 | 29 | (Table of contents generated with [markdown-toc](http://ecotrust-canada.github.io/markdown-toc/)) 30 | 31 | # Overview 32 | 33 | ## Music Browser 34 | 35 | Browse artists, genres or albums with Emacs, 36 | ```emacs-lisp 37 | (vuiet-tag-info "progressive rock") 38 | (vuiet-album-info "steven wilson" "to the bone") 39 | (vuiet-artist-info "steven wilson") 40 | ... 41 | ``` 42 | 43 | ![image](https://user-images.githubusercontent.com/8273519/107241018-3c270a80-6a33-11eb-9fda-7213a617be2c.png) 44 | 45 | ## Music Player 46 | 47 | Play an artist top songs, sequentially or randomly, 48 | ```emacs-lisp 49 | (vuiet-play-artist '("steven wilson")) 50 | ``` 51 | 52 | or tracks from similar artists, whole albums, loved tracks, or whole genres, 53 | ```emacs-lisp 54 | (vuiet-play-artist-similar '("lost in kiev")) 55 | (vuiet-play-album "anathema" "one last goodbye") 56 | (vuiet-play-tag-similar '("classic rock" "80s" "progressive")) 57 | ... 58 | ``` 59 | 60 | ## Play by Lyrics 61 | 62 | Display the lyrics and search the saved lyrics database for a song to play, 63 | ```emacs-lisp 64 | (vuiet-play-track-by-lyrics "secret") 65 | ``` 66 | ![image](https://user-images.githubusercontent.com/8273519/74035303-b527f800-49c2-11ea-8a32-15087b2f9e3e.png) 67 | 68 | ## Other Features 69 | 70 | - Display the currently playing song in the mode-line, 71 | 72 | ![mode-line](https://user-images.githubusercontent.com/8273519/107336357-ac7c6d00-6ac1-11eb-9789-064c1ccd5c1b.png) 73 | 74 | - Seek forward, backward, replay, play/pause, open currently playing song on 75 | youtube ([details](#player-interaction)), 76 | ```emacs-lisp 77 | (vuiet-seek-forward 15) 78 | (vuiet-playing-track-continue-on-youtube) 79 | ... 80 | ``` 81 | 82 | - Scrobble songs to your last.fm profile and add songs to your list of last.fm 83 | loved songs. 84 | 85 | - Search interactively for songs, artists or even albums (fill out part of the 86 | artist name -> TAB -> select the artist -> select the album -> album is now 87 | playing) 88 | 89 | ![call vuiet-play-album](https://user-images.githubusercontent.com/8273519/107335138-3deadf80-6ac0-11eb-9c87-a820b166b813.png) 90 | ![give artist name](https://user-images.githubusercontent.com/8273519/107335144-3e837600-6ac0-11eb-93de-9a48d528c03a.png) 91 | ![tab for similar 92 | artists](https://user-images.githubusercontent.com/8273519/107335145-3e837600-6ac0-11eb-8c4e-506ddf9ee421.png) 93 | ![select album](https://user-images.githubusercontent.com/8273519/107335147-3f1c0c80-6ac0-11eb-85b2-14daeb9ad118.png) 94 | 95 | # Installation Requirements 96 | 97 | - [vuiet](https://melpa.org/#/vuiet) 98 | - [yt-dlp](https://github.com/yt-dlp/yt-dlp) 99 | - [lastfm](https://last.fm) account plus an API key (see lastfm.el README for details) 100 | - [lastfm.el](https://github.com/mihaiolteanu/lastfm.el) (follow the 101 | instruction on the lastfm.el README page) 102 | - [mpv](https://mpv.io/) 103 | 104 | # Complete functionality 105 | 106 | ## Playlists 107 | 108 | **vuiet-play** *songs (random nil)* 109 | 110 | Play everyting in the SONGS list, randomly or sequentially. 111 | SONGS is a list of type ((artist1 song1) (artist2 song2) ...). 112 | 113 | **vuiet-play-artist** *artist random* 114 | 115 | Play the ARTIST top tracks, RANDOM or sequentially. 116 | 117 | **vuiet-play-playing-artist** *random* 118 | 119 | Play the currently playing artist's top tracks. 120 | 121 | **vuiet-play-playing-track-album** 122 | 123 | Play the full album of the currently playing track. 124 | 125 | **vuiet-info-playing-track-album** 126 | 127 | Open an info buffer for the currently playing track album. 128 | 129 | **vuiet-play-album** *artist album* 130 | 131 | Play the whole ALBUM of the given ARTIST. 132 | If called interactively, the album can be picked interactively 133 | from the ARTIST's top albums. 134 | 135 | **vuiet-play-artist-similar** *artists* 136 | 137 | Play tracks from artists similar to ARTISTS. 138 | ARTISTS is a list of strings of the form '(artist1 artist2 etc.) 139 | If called interactively, multiple artists can be provided in the 140 | minibuffer if they are sepparated by commas. 141 | 142 | **vuiet-play-playing-artist-similar** 143 | 144 | Play tracks from artists similar to the playing artist. 145 | This function is similar to `vuiet-play-artist-similar', only the 146 | list of artists is limited to the artist of the currently playing 147 | track. 148 | 149 | **vuiet-play-tag-similar** *tags* 150 | 151 | Play tracks from artists similar to TAGS. 152 | TAGS is a list of strings of the form '(tag1 tag2 etc.) 153 | If called interactively, multiple tags can be provided in the 154 | minibuffer if they are sepparated by commas. 155 | 156 | **vuiet-play-playing-tags-similar** 157 | 158 | Play tracks from artists with similar tags as the current tags. 159 | Play tracks from random artists that have tags equal to one of 160 | the tags of the currently playing artist. 161 | 162 | **vuiet-play-track** *artist name* 163 | 164 | Play the song NAME from the given ARTIST. 165 | If called interactively, let the user select and play one of the 166 | ARTIST's top songs, where ARTIST is given in the minibuffer. 167 | 168 | **vuiet-play-track-search** *track* 169 | 170 | Search TRACK and play the selected item. 171 | Similar to `vuiet-play-track', but search for TRACK on last.fm 172 | first and then let the user select one of the results. 173 | 174 | **vuiet-play-track-by-lyrics** *lyrics* 175 | 176 | Search a track by LYRICS and play it. 177 | 178 | **vuiet-play-loved-track** 179 | 180 | Select a track from the user loved tracks and play it. 181 | The user loved tracks list is the one associated with the 182 | username given in the setup of the lastfm.el package. 183 | 184 | **vuiet-play-loved-tracks** *(random nil)* 185 | 186 | Play all the tracks from the user loved tracks. 187 | If RANDOM is t, play the tracks at random, indefinitely. 188 | The user loved tracks list is the one associated with the 189 | username given in the setup of the lastfm.el package. 190 | 191 | **vuiet-play-artist-loved-tracks** *artist random* 192 | 193 | Play all the ARTIST tracks found in the user loved tracks. 194 | Similar to `vuiet-play-loved-tracks', but play only the tracks 195 | from the given ARTIST. 196 | 197 | **vuiet-play-recent-track** 198 | 199 | Play one of the recent listened tracks. 200 | 201 | **vuiet-play-loved-tracks-similar** 202 | 203 | Play tracks based on artists similar to loved tracks artists. 204 | Play tracks from random artists similar to a random artist from 205 | the list of user loved tracks. 206 | 207 | ## Browser 208 | 209 | **vuiet-artist-info** *artist* 210 | 211 | Display info about ARTIST in a new buffer. 212 | 213 | p play all the artist songs, sequentially. 214 | s select and display info for a similar artist with ivy. 215 | l visit the artist's lastfm page. 216 | 217 | **vuiet-artist-info-search** *artist* 218 | 219 | Search ARTIST and display info about the selected item. 220 | Similar to `vuiet-artist-info', but search for ARTIST on last.fm 221 | first and then display the info about it. 222 | 223 | **vuiet-tag-info** *tag* 224 | 225 | Display info about TAG in a new buffer. 226 | 227 | **vuiet-loved-tracks-info** *(page 1) (n 50)* 228 | 229 | Display N tracks from the user loved tracks in a new buffer. 230 | If the user has more than N loved tracks, PAGE can be used to show 231 | the next PAGE * N tracks. 232 | 233 | On a song entry, plays that song only. 234 | i Display the next PAGE * N songs. 235 | u Display the previous PAGE * N songs, if N > 1 236 | s Choose a song to play, with ivy. 237 | 238 | **vuiet-album-info** *artist album* 239 | 240 | Display info about the ARTIST's ALBUM in a new buffer. 241 | 242 | s choose a song with ivy. 243 | a pick another album with ivy. 244 | p play all songs from the album. 245 | l save lyrics for this album. 246 | 247 | **vuiet-album-info-search** *artist* 248 | 249 | Search all albums from ARTIST and display the selected one. 250 | The album is displayed in a dedicated buffer. See 251 | `vuiet-album-info' for details regarding the active keybindings 252 | inside this buffer. 253 | 254 | ## Player Interaction 255 | 256 | **vuiet-stop** 257 | 258 | Stop playing and clear the mode line. 259 | 260 | **vuiet-playing-artist** 261 | 262 | Return the currently playing artist. 263 | 264 | **vuiet-playing-track-name** 265 | 266 | Return the currently playing track name. 267 | 268 | **vuiet-playing-track-str** 269 | 270 | Return the playing TRACK as a human-readable string. 271 | 272 | **vuiet-next** 273 | 274 | Skip the currently playing track and play the next. 275 | 276 | **vuiet-peek-next** 277 | 278 | Display the next track in the mode-line for a few seconds. 279 | 280 | **vuiet-previous** 281 | 282 | Replay the previous track. 283 | 284 | **vuiet-replay** 285 | 286 | Play the currently playing track from the beginning. 287 | 288 | **vuiet-seek-backward** *(arg)* 289 | 290 | Seek backward the given number of ARG. ARG defaults to 5 seconds. 291 | 292 | **vuiet-seek-forward** *(arg)* 293 | 294 | Seek forward the given number of ARG. ARG defaults to 5 seconds. 295 | 296 | **vuiet-seek-backward-rate** *(arg)* 297 | 298 | Seek backward ARG% of the track. ARG defaults to 10%. 299 | 300 | **vuiet-seek-forward-rate** *(arg)* 301 | 302 | Seek forward ARG% of the track. ARG defaults to 10%. 303 | 304 | **vuiet-play-pause** 305 | 306 | Toggle the play/pause status. 307 | 308 | **vuiet-player-volume** 309 | 310 | Get the music player volume, between 0% and 100%. 311 | 312 | **vuiet-player-volume-inc** *(arg)* 313 | 314 | Increase the music player volume by ARG percent. ARG defaults to 10%. 315 | 316 | **vuiet-player-volume-dec** *(arg)* 317 | 318 | Decrease the music player volume by ARG percent. ARG defaults to 10%. 319 | 320 | **vuiet-playing-artist-info** 321 | 322 | Display info for the currently playing artist in a new buffer. 323 | 324 | **vuiet-playing-track-search-youtube** 325 | 326 | Open a youtube search for the currently playing track. 327 | 328 | **vuiet-playing-track-continue-on-youtube** 329 | 330 | Pause vuiet and continue playing on youtube. 331 | 332 | **vuiet-playing-track-continue-with-mpv** 333 | 334 | Pause vuiet and continue playing with mpv as a new process. 335 | 336 | **vuiet-artist-lastfm-page** *artist* 337 | 338 | Visit the ARTIST lastfm page." 339 | 340 | **vuiet-playing-artist-lastfm-page** 341 | 342 | Visit he currently playing artist lastfm page. 343 | 344 | **vuiet-love-track** 345 | 346 | Add the currently playing track to the user loved songs. 347 | 348 | **vuiet-unlove-track** 349 | 350 | Remove the currently playing track from the user loved songs. 351 | 352 | **vuiet-playing-track-lyrics** 353 | 354 | Display the lyrics for the currently playing track in a new buffer. 355 | See `versuri-display' for the active keybindings inside this buffer. 356 | 357 | **vuiet-enable-automatic-lyrics** 358 | 359 | Enable saving the lyrics for all listened tracks to the db. 360 | See `vuiet-automatic-lyrics' for details. 361 | 362 | **vuiet-disable-automatic-lyrics** 363 | 364 | Disable saving the lyrics for all listened tracks to the db. 365 | See `vuiet-automatic-lyrics' for details. 366 | 367 | **vuiet-toggle-automatic-lyrics** 368 | 369 | Toggle saving the lyrics for all listened tracks to the db. 370 | See `vuiet-automatic-lyrics' for details. 371 | 372 | **vuiet-update-mode-line** 373 | 374 | Update the mode line. 375 | 376 | ## Customization 377 | 378 | **vuiet-scrobble-timeout** *30* 379 | 380 | Time, in seconds, for the same song to play before scrobbling it. 381 | 382 | **vuiet-scrobble-enabled** *t* 383 | 384 | Enable/disable last.fm scrobbling. 385 | Decide if the currently playing track should appear in your list 386 | of recently played tracks on last.fm. 387 | 388 | **vuiet-automatic-lyrics** *nil* 389 | 390 | Enable/disable the saving of lyrics to the db for all tracks. 391 | If t, download the lyrics for every listened track and save them 392 | to db. This is useful if you're listening to artists and tracks 393 | you already know and like. If nil, the lyrics are only saved 394 | manually, on request, with the `vuiet-playing-track-lyrics'. 395 | This is useful if you're listening to new tracks, some of which 396 | you might not like. Adding the lyrics of such tracks to the db 397 | would only mean adding garbage that you can do without. 398 | 399 | **vuiet-update-mode-line-automatically** t 400 | 401 | Enable/disable the automatic update of the mode-line. 402 | If enabled, the mode-line is automatically updated after 403 | `vuiet-update-mode-line-interval' seconds. More specifically, 404 | `vuiet-update-mode-line' is called periodically while a track is 405 | playing to update it's current playback position. 406 | 407 | **vuiet-update-mode-line-interval** 10 408 | 409 | Timeout, in seconds, after which to update the mode-line. 410 | See the `vuiet-update-mode-line-automatically' custom variable 411 | for details. 412 | 413 | **vuiet-artist-similar-limit** *15* 414 | 415 | Number of artists similar to the given artist. 416 | When considering artists similar to a given artist, take as many 417 | into consideration as this limit. A lower value might mean 418 | artists and tracks you already know and love. A higher value 419 | increases the chances you'll discover something totally new. 420 | 421 | **vuiet-artist-tracks-limit** *15* 422 | 423 | Number of tracks for the given artist. 424 | When considering the top tracks for a given artist, take as many 425 | into consideration as this limit. A lower value might mean 426 | tracks from this artist that you already know and love. A higher 427 | value increases the chances you'll discover something totally new 428 | but it also increases the chances that you'll get wrongly 429 | scrobbled songs and youtube will find something totally unrelated 430 | as a result. 431 | 432 | **vuiet-artist-top-albums-limit** *10* 433 | 434 | Number of top albums for the given artist. 435 | This value is also used in the artist info page (called by 436 | `vuiet-artist-info') to display the number of top albums. 437 | 438 | **vuiet-artist-info-show-top-albums** nil 439 | 440 | Display the artist top albums in the artist info 441 | buffer (created when calling `vuiet-artist-info'). This adds an 442 | extra call to last.fm which, depending on your system, you might 443 | feel it like an unnecessary lag. 444 | 445 | **vuiet-tag-artists-limit** *15* 446 | 447 | Number of artists for the given tag. 448 | When considering the top artists for a given tag, take as many 449 | into consideration as this limit. 450 | 451 | **vuiet-loved-tracks-limit** *500* 452 | 453 | Number of tracks to take into consideration when playing user loved tracks. 454 | A number higher than your actual lastfm loved tracks, will take 455 | all of them into consideration. A lower values is useful for 456 | taking into consideration only the most recently loved tracks. 457 | 458 | **vuiet-youtube-dl-command** *"youtube-dl"* 459 | 460 | The youtube-dl command. 461 | -------------------------------------------------------------------------------- /vuiet.el: -------------------------------------------------------------------------------- 1 | ;;; vuiet.el --- The music player and explorer for Emacs -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2019-2024 Mihai Olteanu 4 | 5 | ;; Author: Mihai Olteanu 6 | ;; Version: 1.0 7 | ;; Package-Requires: ((emacs "26.1") (lastfm "1.1") (versuri "1.0") (s "1.12.0") (bind-key "2.4") (mpv "0.1.0") (ivy "0.14.2")) 8 | ;; Keywords: multimedia 9 | ;; URL: https://github.com/mihaiolteanu/vuiet 10 | 11 | ;; This program is free software; you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation, either version 3 of the License, or 14 | ;; (at your option) any later version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; Vuiet is a music player and explorer for Emacs users. It is similar in scope 27 | ;; to lastfm on which it is based. All tracks are played from youtube using mpv 28 | ;; in the background and music info taken from last.fm. Vuiet supports the 29 | ;; "discovery mode", where it lets you create your own playlists based on 30 | ;; artist, genre or your loved songs similarities. Or, you can specify single 31 | ;; tracks, top tracks from a given artist, known albums, etc. There is also a 32 | ;; lyrics database that is optionally updated with each track you play and this 33 | ;; database can be searched interactively and played from. 34 | 35 | ;;; Code: 36 | 37 | (require 'lastfm) 38 | (require 'versuri) 39 | (require 's) 40 | (require 'cl-lib) 41 | (require 'bind-key) 42 | (require 'mpv) 43 | (require 'generator) 44 | (require 'ivy) 45 | 46 | (defgroup vuiet () 47 | "Emacs music player." 48 | :group 'music 49 | :prefix "vuiet-") 50 | 51 | (defcustom vuiet-scrobble-timeout 30 52 | "Time, in seconds, for the same song to play before scrobbling it." 53 | :type '(number :tag "seconds") 54 | :group 'vuiet) 55 | 56 | (defcustom vuiet-scrobble-enabled t 57 | "Enable/disable last.fm scrobbling. 58 | Decide if the currently playing track should appear in your list 59 | of recently played tracks on last.fm." 60 | :type '(boolean :tag "enabled") 61 | :group 'vuiet) 62 | 63 | (defcustom vuiet-automatic-lyrics nil 64 | "Enable/disable the saving of lyrics to the db for all tracks. 65 | If t, download the lyrics for every listened track and save them 66 | to db. This is useful if you're listening to artists and tracks 67 | you already know and like. If nil, the lyrics are only saved 68 | manually, on request, with the `vuiet-playing-track-lyrics'. 69 | This is useful if you're listening to new tracks, some of which 70 | you might not like. Adding the lyrics of such tracks to the db 71 | would only mean adding garbage that you can do without." 72 | :type '(boolean :tag "enabled") 73 | :group 'vuiet) 74 | 75 | (defcustom vuiet-update-mode-line-automatically t 76 | "Enable/disable the automatic update of the mode-line. 77 | If enabled, the mode-line is automatically updated after 78 | `vuiet-update-mode-line-interval' seconds. More specifically, 79 | `vuiet-update-mode-line' is called periodically while a track is 80 | playing to update it's current playback position." 81 | :type '(boolean :tag "enabled") 82 | :group 'vuiet) 83 | 84 | (defcustom vuiet-update-mode-line-interval 10 85 | "Timeout, in seconds, after which to update the mode-line. 86 | See the `vuiet-update-mode-line-automatically' custom variable 87 | for details." 88 | :type '(number :tag "seconds") 89 | :group 'vuiet) 90 | 91 | (defcustom vuiet-artist-similar-limit 15 92 | "Number of artists similar to the given artist. 93 | When considering artists similar to a given artist, take as many 94 | into consideration as this limit. A lower value might mean 95 | artists and tracks you already know and love. A higher value 96 | increases the chances you'll discover something totally new." 97 | :type '(number :tag "count") 98 | :group 'vuiet) 99 | 100 | (defcustom vuiet-artist-tracks-limit 15 101 | "Number of tracks for the given artist. 102 | When considering the top tracks for a given artist, take as many 103 | into consideration as this limit. A lower value might mean 104 | tracks from this artist that you already know and love. A higher 105 | value increases the chances you'll discover something totally new 106 | but it also increases the chances that you'll get wrongly 107 | scrobbled songs and youtube will find something totally unrelated 108 | as a result." 109 | :type '(number :tag "count") 110 | :group 'vuiet) 111 | 112 | (defcustom vuiet-artist-top-albums-limit 10 113 | "Number of top albums for the given artist. 114 | This value is also used in the artist info page (called by 115 | `vuiet-artist-info') to display the number of top albums." 116 | :type '(number :tag "top-albums-limit") 117 | :group 'vuiet) 118 | 119 | (defcustom vuiet-artist-info-show-top-albums nil 120 | "Display the artist top albums in the artist info 121 | buffer (created when calling `vuiet-artist-info'). This adds an 122 | extra call to last.fm which, depending on your system, you might 123 | feel it like an unnecessary lag." 124 | :type '(boolean :tag "info-show-top-albums") 125 | :group 'vuiet) 126 | 127 | (defcustom vuiet-tag-artists-limit 15 128 | "Number of artists for the given tag. 129 | When considering the top artists for a given tag, take as many 130 | into consideration as this limit." 131 | :type '(number :tag "count") 132 | :group 'vuiet) 133 | 134 | (defcustom vuiet-loved-tracks-limit 500 135 | "Number of tracks to take into consideration when playing user loved tracks. 136 | A number higher than your actual lastfm loved tracks, will take 137 | all of them into consideration. A lower values is useful for 138 | taking into consideration only the most recently loved tracks." 139 | :type '(number :tag "count") 140 | :group 'vuiet) 141 | 142 | (defcustom vuiet-youtube-dl-command "yt-dlp" 143 | "The youtube-dl command." 144 | :type '(string :tag "path") 145 | :group 'vuiet) 146 | 147 | (cl-defstruct vuiet-track 148 | artist name duration) 149 | 150 | (defun vuiet--new-track (artist name &optional duration) 151 | "Prepare the ARTIST and NAME before creating a TRACK object." 152 | (make-vuiet-track :artist (s-trim artist) 153 | :name (s-trim name) 154 | :duration (or duration ""))) 155 | 156 | (defun vuiet--track-as-string (track) 157 | "Return TRACK as a human-readable string." 158 | (format "%s %s" (vuiet-track-artist track) (vuiet-track-name track))) 159 | 160 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 161 | ;; Utils 162 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 163 | 164 | (defmacro vuiet--artist-from-minibuffer-if-nil (artist) 165 | "If ARTIST is nil, request an artist from the minibuffer. 166 | Use lastfm for autocomplete if, while in the minibuffer, the TAB 167 | key is pressed." 168 | (declare (debug t) 169 | (indent defun)) 170 | `(unless ,artist 171 | (let ((keymap (copy-keymap minibuffer-local-map))) 172 | (define-key keymap (kbd "") 173 | (lambda () (interactive) 174 | (ivy-read "Artist: " 175 | (lastfm-artist-search (minibuffer-contents)) 176 | :action (lambda (s) 177 | (setf ,artist (car s)) 178 | (delete-minibuffer-contents) 179 | (exit-minibuffer))))) 180 | (let* ((enable-recursive-minibuffers t) 181 | (mini (read-from-minibuffer 182 | "Artist (TAB for completion): " nil keymap))) 183 | (unless (string-empty-p mini) 184 | ;; if completion was used, the minibuffer returns an empty string. 185 | (setf ,artist mini)))))) 186 | 187 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 188 | ;; Browser 189 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 190 | 191 | (defvar vuiet-mode-map 192 | (let ((keymap (make-sparse-keymap))) 193 | (bind-keys :map keymap 194 | ("C-m" . org-open-at-point) 195 | ("q" . kill-current-buffer) 196 | ("j" . next-line) 197 | ("k" . previous-line) 198 | ("l" . forward-char) 199 | ("h" . backward-char)) 200 | keymap)) 201 | 202 | (define-derived-mode vuiet-mode org-mode "Vuiet") 203 | 204 | (defmacro vuiet--with-vuiet-buffer (name &rest body) 205 | "Basic setup for a VUIET-MODE buffer. 206 | Create a new buffer with name NAME if it does not exist. Turn 207 | on VUIET-MODE for that buffer, eval BODY and then switch to it." 208 | (declare (debug t) 209 | (indent defun)) 210 | (let ((b (make-symbol "buffer"))) 211 | `(aif (get-buffer ,name) 212 | ;; Don't create a new buffer if one already exists. 213 | (switch-to-buffer it) 214 | (let ((,b (generate-new-buffer ,name))) 215 | (with-current-buffer ,b 216 | (vuiet-mode) 217 | ,@body) 218 | (switch-to-buffer ,b) 219 | (org-previous-visible-heading 1))))) 220 | 221 | (defmacro vuiet--local-set-keys (&rest bindings) 222 | "Set multiple key BINDINGS at once. 223 | BINDINGS is a list of (KEY . EXPR) forms. The expansion sets up 224 | a local binding such that KEY executes EXPR." 225 | (declare (debug t) 226 | (indent defun)) 227 | `(progn 228 | ,@(mapcar (lambda (binding) 229 | `(local-set-key 230 | (kbd ,(car binding)) 231 | (lambda () (interactive) 232 | ,(cdr binding)))) 233 | bindings))) 234 | 235 | (defun vuiet-ivy-similar-artists (artist) 236 | "Search similar artists to ARTIST with ivy." 237 | (interactive "sArtist: ") 238 | (ivy-read "Select Artist: " 239 | (lastfm-artist-get-similar 240 | artist 241 | :limit vuiet-artist-similar-limit) 242 | :action (lambda (a) 243 | (vuiet-artist-info (car a))))) 244 | 245 | ;;;###autoload 246 | (defun vuiet-artist-info (&optional artist) 247 | "Display info about ARTIST in a new buffer. 248 | 249 | p play all the artist songs, sequentially. 250 | s select and display info for a similar artist with ivy. 251 | l visit the artist's lastfm page." 252 | (interactive) 253 | (vuiet--artist-from-minibuffer-if-nil artist) 254 | (vuiet--with-vuiet-buffer artist 255 | (let* ((artist-info (lastfm-artist-get-info artist)) 256 | (songs (lastfm-artist-get-top-tracks 257 | artist 258 | :limit vuiet-artist-tracks-limit)) 259 | (bio-summary (car artist-info)) 260 | ;; The subseq indices are based on the standard lastfm.el response 261 | ;; for artist.info 262 | (similar-artists (cl-subseq artist-info 3 7)) 263 | (tags (cl-subseq artist-info 8))) 264 | (insert (format "* %s\n\n %s" 265 | artist 266 | (s-word-wrap 75 (replace-regexp-in-string 267 | "" "" bio-summary)))) 268 | 269 | (insert "\n\n* Similar artists: \n") 270 | (dolist (artist similar-artists) 271 | (insert (format "|[[elisp:(vuiet-artist-info \"%s\")][%s]]| " 272 | artist artist))) 273 | 274 | (insert "\n\n* Popular tags: \n") 275 | (dolist (tag tags) 276 | (insert (format "|[[elisp:(vuiet-tag-info \"%s\")][%s]]| " 277 | tag tag))) 278 | 279 | (insert "\n\n* Top Songs: \n") 280 | (cl-loop for i from 1 281 | for track in songs 282 | as song = (s-replace-all '(("[" . "(") ("]" . ")")) (cadr track)) 283 | do (insert 284 | (format "%2s. [[elisp:(vuiet-play '((\"%s\" \"%s\")))][%s]]\n" 285 | i artist song song))) 286 | 287 | (when vuiet-artist-info-show-top-albums 288 | (insert "\n\n* Top Albums: \n") 289 | (cl-loop for i from 1 290 | for raw-album in (lastfm-artist-get-top-albums 291 | artist :limit vuiet-artist-top-albums-limit) 292 | as album = (s-replace-all '(("(" . "") (")" . "")) (car raw-album)) 293 | do (insert 294 | (format "%2s. [[elisp:(vuiet-album-info \"%s\" \"%s\")][%s]]\n" 295 | i artist album album)))) 296 | 297 | (vuiet--local-set-keys 298 | ("p" . (vuiet-play songs)) 299 | ("s" . (vuiet-ivy-similar-artists artist)) 300 | ("l" . (vuiet-artist-lastfm-page artist)))))) 301 | 302 | ;;;###autoload 303 | (defun vuiet-artist-info-search (artist) 304 | "Search ARTIST and display info about the selected item. 305 | Similar to `vuiet-artist-info', but search for ARTIST on last.fm 306 | first and then display the info about it." 307 | (interactive "sArtist: ") 308 | (ivy-read "Info for artist: " 309 | (mapcar #'car (lastfm-artist-search artist)) 310 | :action #'vuiet-artist-info)) 311 | 312 | ;;;###autoload 313 | (defun vuiet-tag-info (tag) 314 | "Display info about TAG in a new buffer." 315 | (interactive "sTag: ") 316 | (vuiet--with-vuiet-buffer tag 317 | (let ((info (lastfm-tag-get-info tag)) 318 | ;; (songs (lastfm-tag-get-top-tracks tag :limit 15)) ;; Ignore it 319 | ;; (tag-similar (lastfm-tag-get-similar tag)) ;; Empty response 320 | (artists (lastfm-tag-get-top-artists 321 | tag 322 | :limit vuiet-tag-artists-limit))) 323 | (insert (format "* %s\n\n %s \n" 324 | tag 325 | (s-word-wrap 75 (replace-regexp-in-string 326 | "" "" (car info))))) 327 | 328 | (insert "\n* Top Artists: \n") 329 | (cl-loop for i from 1 330 | for artist in artists 331 | do (insert 332 | (format "%2s. [[elisp:(vuiet-artist-info \"%s\")][%s]]\n" 333 | i (car artist) (car artist)))) 334 | ;; Top songs for tags are usually just songs for 2, maximum 3 artists and 335 | ;; are usually bullshit and non-relevant for that tag. Skip it. 336 | ))) 337 | 338 | (defun vuiet--ivy-play-song (songs) 339 | "Choose a song from SONGS with ivy and play it." 340 | (cl-multiple-value-bind (artist-max-len song-max-len) 341 | (cl-loop for entry in songs 342 | maximize (length (car entry)) into artist 343 | maximize (length (cadr entry)) into song 344 | finally (return (cl-values artist song))) 345 | (ivy-read "Play song: " 346 | (mapcar (lambda (song) 347 | (list (format (s-format "%-$0s %-$1s" 'elt 348 | ;; Add the padding 349 | `(,artist-max-len ,song-max-len)) 350 | ;; Add the actual artist and song. 351 | (car song) (cadr song)) 352 | (list (car song) (cadr song)))) 353 | songs) 354 | :action (lambda (selection) 355 | (vuiet-play (list (cadr selection))))))) 356 | 357 | (cl-defun vuiet-loved-tracks-info (&key (page 1) (n 50)) 358 | "Display N tracks from the user loved tracks in a new buffer. 359 | If the user has more than N loved tracks, PAGE can be used to show 360 | the next PAGE * N tracks. 361 | 362 | On a song entry, plays that song only. 363 | i Display the next PAGE * N songs. 364 | u Display the previous PAGE * N songs, if N > 1 365 | s Choose a song to play, with ivy." 366 | (interactive) 367 | (vuiet--with-vuiet-buffer "loved-songs" 368 | (let* ((songs (lastfm-user-get-loved-tracks :limit n :page page)) 369 | (max-len (cl-loop for entry in songs 370 | maximize (length (car entry))))) 371 | (insert (format "** Loved Songs (Page %s): \n" page)) 372 | (cl-loop for i from (+ 1 (* (1- page) n)) 373 | for entry in songs 374 | for artist = (car entry) 375 | for song = (cadr entry) 376 | do (insert 377 | (format (concat "%3s. [[elisp:(vuiet-play '((\"%s\" \"%s\")))][%-" 378 | (number-to-string max-len) 379 | "s %s]]\n") 380 | i artist song artist song)) 381 | 382 | (vuiet--local-set-keys 383 | ("i" . (progn (kill-buffer) 384 | (vuiet-loved-tracks-info :page (1+ page) :n n))) 385 | ("u" . (when (> page 1) 386 | (kill-buffer) 387 | (vuiet-loved-tracks-info :page (1- page) :n n))) 388 | ("s" . (vuiet--ivy-play-song songs))))))) 389 | 390 | (defun vuiet-album-info (&optional artist album) 391 | "Display info about the ARTIST's ALBUM in a new buffer. 392 | 393 | s choose a song with ivy. 394 | a pick another album with ivy. 395 | p play all songs from the album. 396 | l save lyrics for this album." 397 | (interactive) 398 | (vuiet--artist-from-minibuffer-if-nil artist) 399 | (unless album 400 | (ivy-read (format "%s Album:" artist) 401 | (lastfm-artist-get-top-albums 402 | artist :limit vuiet-artist-top-albums-limit) 403 | :action (lambda (a) 404 | (setf album (car a))))) 405 | (vuiet--with-vuiet-buffer (format "%s - %s" artist album) 406 | (let* ((songs (lastfm-album-get-info artist album)) 407 | ;; Align song duration in one nice column. For this, I need to know 408 | ;; the longest song name from the album. 409 | (max-len (cl-loop for entry in songs 410 | maximize (length (cadr entry))))) 411 | 412 | (insert (format "* %s - %s \n\n" artist album)) 413 | (cl-loop for i from 1 414 | for entry in songs 415 | for song = (s-replace-all '(("[" . "(") ("]" . ")")) (cadr entry)) 416 | for duration = (format-seconds 417 | "%m:%02s" (string-to-number (caddr entry))) 418 | do (insert 419 | (format (concat "%2s. [[elisp:(vuiet-play '((\"%s\" \"%s\")))][%-" 420 | (number-to-string (1+ max-len)) 421 | "s]] %s\n") 422 | i artist song song duration))) 423 | 424 | (vuiet--local-set-keys 425 | ("s" . (vuiet--ivy-play-song songs)) 426 | ("a" . (vuiet-album-info-search artist)) ;try another album. 427 | ("p" . (vuiet-play songs)) 428 | ("l" . (versuri-save-bulk songs 10)))))) 429 | 430 | (defun vuiet-album-info-search (artist) 431 | "Search all albums from ARTIST and display the selected one. 432 | The album is displayed in a dedicated buffer. See 433 | `vuiet-album-info' for details regarding the active keybindings 434 | inside this buffer." 435 | (interactive "sArtist: ") 436 | (ivy-read "Select Album: " 437 | (lastfm-artist-get-top-albums 438 | artist :limit vuiet-artist-top-albums-limit) 439 | :action (lambda (album) 440 | (vuiet-album-info artist (car album))))) 441 | 442 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 443 | ;; Player 444 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 445 | 446 | (let (timer) 447 | (defun vuiet--set-update-mode-line-timer () 448 | (unless timer 449 | (when vuiet-update-mode-line-automatically 450 | (setf timer 451 | (run-at-time vuiet-update-mode-line-interval 452 | vuiet-update-mode-line-interval 453 | #'vuiet-update-mode-line))))) 454 | 455 | (defun vuiet--reset-update-mode-line-timer () 456 | (when timer 457 | (cancel-timer timer) 458 | (setf timer nil)))) 459 | 460 | (let (playing-track) 461 | (defun vuiet--playing-track-set (track) 462 | "Update the currently playing track." 463 | (setf playing-track track)) 464 | 465 | (defun vuiet--playing-track () 466 | "Return the currently playing track." 467 | playing-track)) 468 | 469 | (defun vuiet-enable-scrobbling () 470 | "Enable last.fm scrobbling." 471 | (interactive) 472 | (setf vuiet-scrobble-enabled t)) 473 | 474 | (defun vuiet-disable-scrobbling () 475 | "Disable last.fm scrobbling." 476 | (interactive) 477 | (setf vuiet-scrobble-enabled nil)) 478 | 479 | (defun vuiet-enable-automatic-lyrics () 480 | "Enable saving the lyrics for all listened tracks to the db. 481 | See `vuiet-automatic-lyrics' for details." 482 | (interactive) 483 | (setf vuiet-automatic-lyrics t) 484 | (message "Automatic lyrics for vuiet, enabled")) 485 | 486 | (defun vuiet-disable-automatic-lyrics () 487 | "Enable saving the lyrics for all listened tracks to the db. 488 | See `vuiet-automatic-lyrics' for details." 489 | (interactive) 490 | (setf vuiet-automatic-lyrics nil) 491 | (message "Automatic lyrics for vuiet, disabled")) 492 | 493 | (defun vuiet-toggle-automatic-lyrics () 494 | "Toggle saving the lyrics for all listened tracks to the db. 495 | See `vuiet-automatic-lyrics' for details." 496 | (interactive) 497 | (setf vuiet-automatic-lyrics (not vuiet-automatic-lyrics)) 498 | (message (format "Automatic lyrics for vuiet, %s" 499 | (if vuiet-automatic-lyrics "enabled" "disabled")))) 500 | 501 | (defun vuiet-update-mode-line (&optional position) 502 | "Update the mode-line." 503 | (interactive) 504 | (let ((track (vuiet--playing-track))) 505 | (when track 506 | (setq-default mode-line-misc-info 507 | (list (format "%s - %s [%s/%s] " 508 | (vuiet-track-artist track) 509 | (vuiet-track-name track) 510 | (format-time-string "%M:%S" 511 | (or position 512 | ;; At startup, the running track may be set, by the 513 | ;; file might not be loaded yet. 514 | (condition-case nil 515 | (mpv-get-playback-position) 516 | (error 0)))) 517 | (vuiet-track-duration track)))))) 518 | (force-mode-line-update t)) 519 | 520 | (defun vuiet-stop () 521 | "Stop playing and clear the mode line." 522 | (interactive) 523 | (vuiet--playing-track-set nil) 524 | (setf mpv-on-exit-hook nil) 525 | (mpv-kill) 526 | (vuiet--reset-update-mode-line-timer) 527 | (setq-default mode-line-misc-info nil)) 528 | 529 | (defun vuiet-playing-artist () 530 | "Return the currently playing artist." 531 | (awhen (vuiet--playing-track) 532 | (vuiet-track-artist it))) 533 | 534 | (defun vuiet-playing-track-name () 535 | "Return the currently playing track name." 536 | (awhen (vuiet--playing-track) 537 | (vuiet-track-name it))) 538 | 539 | (defun vuiet-playing-track-str () 540 | "Return the playing TRACK as a human-readable string." 541 | (awhen (vuiet--playing-track) 542 | (vuiet--track-as-string it))) 543 | 544 | (defun vuiet-next () 545 | "Skip the currently playing track and play the next." 546 | (interactive) 547 | (condition-case nil 548 | (mpv-run-command "playlist-next") 549 | (error (display-message-or-buffer "No track available; Try again")))) 550 | 551 | (defun vuiet-peek-next () 552 | "Display the next track in the mode-line for a few seconds." 553 | (interactive) 554 | (let ((urls (vuiet--mpv-playlist-remaining-urls))) 555 | (when (> (length urls) 1) 556 | (let ((track (vuiet--track-from-youtube-url 557 | (cadr (vuiet--mpv-playlist-remaining-urls))))) 558 | (setq-default mode-line-misc-info 559 | (list (format "%s - %s (%s) " 560 | (vuiet-track-artist track) 561 | (vuiet-track-name track) 562 | (vuiet-track-duration track)))) 563 | (run-at-time 3 nil #'vuiet-update-mode-line))))) 564 | 565 | (defun vuiet-previous () 566 | "Replay the previous track. 567 | It only considers tracks from the current playlist." 568 | (interactive) 569 | (condition-case nil 570 | (mpv-run-command "playlist-prev") 571 | (error (display-message-or-buffer "This is the first track")))) 572 | 573 | (defun vuiet-replay () 574 | "Play the currently playing track from the beginning." 575 | (interactive) 576 | (mpv-seek 1) 577 | (vuiet-update-mode-line)) 578 | 579 | (defun vuiet-seek-backward (&optional arg) 580 | "Seek backward ARG seconds. ARG defaults to 5." 581 | (interactive "P") 582 | (mpv-seek-backward (or arg 5)) 583 | (vuiet-update-mode-line)) 584 | 585 | (defun vuiet-seek-forward (&optional arg) 586 | "Seek forward ARG seconds. ARG defaults to 5." 587 | (interactive "P") 588 | (mpv-seek-forward (or arg 5)) 589 | (vuiet-update-mode-line)) 590 | 591 | (defun vuiet-seek-backward-rate (&optional arg) 592 | "Seek backward ARG percents of the track. ARG defaults to 10." 593 | (interactive "P") 594 | (mpv-run-command "seek" (- (or arg 10)) "relative-percent") 595 | (vuiet-update-mode-line)) 596 | 597 | (defun vuiet-seek-forward-rate (&optional arg) 598 | "Seek forward ARG percents of the track. ARG defaults to 10." 599 | (interactive "P") 600 | (mpv-run-command "seek" (or arg 10) "relative-percent") 601 | (vuiet-update-mode-line)) 602 | 603 | (defun vuiet-play-pause () 604 | "Toggle the play/pause status." 605 | (interactive) 606 | (mpv-pause) 607 | (vuiet-update-mode-line)) 608 | 609 | (defun vuiet-player-volume () 610 | "Get the music player volume, between 0% and 100%." 611 | (mpv-get-property "volume")) 612 | 613 | (defun vuiet-player-volume-inc (&optional arg) 614 | "Increase the music player volume by ARG percent. ARG defaults to 10." 615 | (interactive "P") 616 | (let* ((volume (vuiet-player-volume)) 617 | (new-volume (+ volume (or arg 10)))) 618 | (when (<= new-volume 100) 619 | (mpv-set-property "volume" new-volume)))) 620 | 621 | (defun vuiet-player-volume-dec (&optional arg) 622 | "Decrease the mpv player volume by ARG percent. ARG defaults to 10." 623 | (interactive "P") 624 | (let* ((volume (vuiet-player-volume)) 625 | (new-volume (- volume (or arg 10)))) 626 | (when (>= new-volume 0) 627 | (mpv-set-property "volume" new-volume)))) 628 | 629 | (defun vuiet-playing-artist-info () 630 | "Display info for the currently playing artist in a new buffer." 631 | (interactive) 632 | (awhen (vuiet-playing-artist) 633 | (vuiet-artist-info it))) 634 | 635 | (defun vuiet-playing-track-search-youtube () 636 | "Open a youtube search for the currently playing track." 637 | (interactive) 638 | (awhen (vuiet-playing-track-str) 639 | (browse-url 640 | (format "https://www.youtube.com/results?search_query=%s" it)))) 641 | 642 | (defun vuiet--youtube-link-at-position () 643 | "Return youtube link of the current track at the playback position." 644 | (concat "https://www.youtube.com/" 645 | (mpv-get-property "filename") 646 | "&t=" (int-to-string 647 | (round (mpv-get-playback-position))))) 648 | 649 | (defun vuiet-playing-track-continue-on-youtube () 650 | "Pause vuiet and continue playing on youtube." 651 | (interactive) 652 | (vuiet-play-pause) 653 | (when (vuiet-playing-artist) 654 | (browse-url 655 | (vuiet--youtube-link-at-position)))) 656 | 657 | (defun vuiet-playing-track-continue-with-mpv () 658 | "Pause vuiet and continue playing with mpv as a new process." 659 | (interactive) 660 | (vuiet-play-pause) 661 | (when (vuiet-playing-artist) 662 | (start-process "vuiet" nil "mpv" 663 | (vuiet--youtube-link-at-position)))) 664 | 665 | (defun vuiet-artist-lastfm-page (artist) 666 | "Visit the ARTIST lastfm page." 667 | (interactive "sArtist: ") 668 | (browse-url 669 | (format "https://last.fm/music/%s" 670 | (s-replace " " "+" artist)))) 671 | 672 | (defun vuiet-playing-artist-lastfm-page () 673 | "Visit he currently playing artist lastfm page." 674 | (interactive) 675 | (awhen (vuiet-playing-artist) 676 | (vuiet-artist-lastfm-page it))) 677 | 678 | (defun vuiet-love-track () 679 | "Add the currently playing track to the user loved songs." 680 | (interactive) 681 | (when (vuiet--playing-track) 682 | (lastfm-track-love (vuiet-playing-artist) 683 | (vuiet-playing-track-name)))) 684 | 685 | (defun vuiet-unlove-track () 686 | "Remove the currently playing track from the user loved songs." 687 | (interactive) 688 | (when (vuiet--playing-track) 689 | (lastfm-track-unlove (vuiet-playing-artist) 690 | (vuiet-playing-track-name)))) 691 | 692 | (defun vuiet-playing-track-lyrics () 693 | "Display the lyrics for the currently playing track in a new buffer. 694 | See `versuri-display' for the active keybindings inside this buffer." 695 | (interactive) 696 | (when (vuiet--playing-track) 697 | (versuri-display (vuiet-playing-artist) 698 | (vuiet-playing-track-name)))) 699 | 700 | (defun vuiet--scrobble-track (track) 701 | "Scrobble TRACK on lastfm, if it's the same as the playing track." 702 | (when (equal track (vuiet--playing-track)) 703 | (let ((timestamp (round (time-to-seconds (current-time))))) 704 | (lastfm-track-scrobble (vuiet-track-artist track) 705 | (vuiet-track-name track) 706 | (int-to-string timestamp))))) 707 | 708 | (defun vuiet--next-track (tracks) 709 | "Yield the next VUIET-TRACK object from the TRACKS list. 710 | If no more objects available, return nil." 711 | (condition-case nil 712 | (iter-next tracks) 713 | (iter-end-of-sequence nil))) 714 | 715 | ;;;:;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 716 | ;; Playlists 717 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 718 | 719 | (iter-defun vuiet--make-generator (songs random) 720 | "Make a generator of VUIET-TRACK objects from the SONGS list. 721 | If RANDOM is true, each call to the generator will yield a random 722 | song and the generator is infinite. Otherwise, the generator 723 | will yield each of the (length songs) elements, sequentially." 724 | (while songs 725 | (let ((song (if random 726 | (seq-random-elt songs) 727 | (prog1 (car songs) 728 | (setf songs (cdr songs)))))) 729 | (iter-yield 730 | (vuiet--new-track (car song) (cadr song)))))) 731 | 732 | ;; Keep a hash table of youtube track ids and vuiet-tracks 733 | (let ((id-tracks (make-hash-table :test 'equal))) 734 | (defun vuiet--add-id-track (id track) 735 | (puthash id track id-tracks)) 736 | 737 | (defun vuiet--get-track-from-id (id) 738 | (gethash id id-tracks))) 739 | 740 | (defun vuiet--mpv-playlist-remaining-urls () 741 | "Return the remaining mpv urls, including this one." 742 | (let ((pos (mpv-get-property "playlist-pos")) 743 | (count (mpv-get-property "playlist-count"))) 744 | (cl-loop for c from pos to (- count 1) 745 | collect (mpv-get-property 746 | (format "playlist/%s/filename" c))))) 747 | 748 | (defun vuiet--mpv-playlist-remaining-urls-count () 749 | (- (mpv-get-property "playlist-count") 750 | (mpv-get-property "playlist-pos-1"))) 751 | 752 | (defun vuiet--track-from-youtube-url (url) 753 | "Return the track object associated with the youtube id." 754 | (vuiet--get-track-from-id 755 | (cadr (s-split "=" url)))) 756 | 757 | (defun vuiet--mpv-playing-track () 758 | "Return the currently mpv playing track." 759 | (vuiet--track-from-youtube-url 760 | (mpv-get-property "filename"))) 761 | 762 | (defun vuiet--mpv-add-track (generator &optional keep-old) 763 | "Append the next track url from GENERATOR to mpv. 764 | If the GENERATOR is not empty, get the next track from it, find 765 | it's youtube url and append it to the currently running mpv 766 | instance playlist. When the url is played in the future, I want 767 | to also have a means to recover the track name from it, thus, I 768 | am saving the track for the given youtube url in a hash table." 769 | (let ((track (vuiet--next-track generator))) 770 | (when track 771 | (set-process-filter 772 | (start-process "ytdl" nil vuiet-youtube-dl-command 773 | (format "ytsearch:%s" (vuiet--track-as-string track)) 774 | "--get-id" 775 | "--get-duration") 776 | (lambda (_ id-duration-str) 777 | (let* ((id-duration (s-split "\n" id-duration-str)) 778 | (id (car id-duration)) 779 | (url (concat "https://www.youtube.com/watch?v=" id)) 780 | (duration (cadr id-duration))) 781 | (setf (vuiet-track-duration track) duration) 782 | (vuiet--add-id-track id track) 783 | (if keep-old 784 | (mpv-run-command "loadfile" url "append-play") 785 | (mpv-run-command "loadfile" url "replace")))))))) 786 | 787 | (let (gen) 788 | (defun vuiet--play (generator) 789 | "Start mpv and play the tracks from the GENERATOR." 790 | (unless (mpv-live-p) 791 | (mpv-start "--no-video" 792 | "--idle=yes" 793 | "--keep-open=yes") 794 | (setf mpv-on-event-hook 795 | (lambda (event) 796 | (pcase (cdr (car event)) 797 | ("playback-restart" 798 | (mpv-set-property "pause" "no")) 799 | ("start-file" 800 | ;; Buffer some tracks beforehand, if needed. 801 | (when (< (vuiet--mpv-playlist-remaining-urls-count) 1) 802 | (vuiet--mpv-add-track gen t))) 803 | ("file-loaded" 804 | (let ((track (vuiet--mpv-playing-track))) 805 | (vuiet--playing-track-set track) 806 | (vuiet-update-mode-line 0) 807 | (mpv-set-property "pause" "no") 808 | (when vuiet-scrobble-enabled 809 | (run-at-time vuiet-scrobble-timeout nil 810 | #'vuiet--scrobble-track track)) 811 | (when vuiet-automatic-lyrics 812 | (versuri-lyrics (vuiet-playing-artist) 813 | (vuiet-playing-track-name) 814 | (lambda (lyrics) "do nothing"))))))))) 815 | ;; If the player was already started, change the generator and clear the 816 | ;; mpv playlist but leave the hooks and everything else in place. 817 | (setf gen generator) 818 | (if current-prefix-arg 819 | ;; Calling any play command with prefix arg, postpones the changing of 820 | ;; playlists until the current track ends. 821 | (progn 822 | (setf current-prefix-arg nil) 823 | ;; Keep only the currently playing track in the playlist. 824 | (mpv-run-command "playlist-clear") 825 | (vuiet--mpv-add-track generator t)) 826 | (mpv-set-property "pause" "yes") 827 | (vuiet--mpv-add-track generator nil)) 828 | (vuiet--set-update-mode-line-timer))) 829 | 830 | ;;;###autoload 831 | (cl-defun vuiet-play (songs &key (random nil)) 832 | "Play everyting in the SONGS list, randomly or sequentially. 833 | SONGS is a list of type ((artist1 song1) (artist2 song2) ...)." 834 | (vuiet--play 835 | (vuiet--make-generator songs random))) 836 | 837 | ;;;###autoload 838 | (defun vuiet-play-artist (&optional artist) 839 | "Play the ARTIST top tracks, RANDOM or sequentially." 840 | (interactive) 841 | (vuiet--artist-from-minibuffer-if-nil artist) 842 | (vuiet-play (lastfm-artist-get-top-tracks 843 | artist 844 | :limit vuiet-artist-tracks-limit) 845 | :random (y-or-n-p (format "%s: Play random? " artist)))) 846 | 847 | ;;;###autoload 848 | (defun vuiet-play-playing-artist () 849 | "Play the currently playing artist's top tracks." 850 | (interactive) 851 | (when (vuiet--playing-track) 852 | (vuiet-play-artist (vuiet-playing-artist)))) 853 | 854 | (defun vuiet-play-playing-track-album () 855 | "Play the full album of the currently playing track." 856 | (interactive) 857 | (when (vuiet--playing-track) 858 | (let* ((artist (vuiet-playing-artist)) 859 | (song (vuiet-playing-track-name)) 860 | (album (car (lastfm-track-get-info artist song)))) 861 | (vuiet-play (lastfm-album-get-info artist album))))) 862 | 863 | (defun vuiet-info-playing-track-album () 864 | "Open an info buffer for the currently playing track album." 865 | (interactive) 866 | (when (vuiet--playing-track) 867 | (let* ((artist (vuiet-playing-artist)) 868 | (song (vuiet-playing-track-name)) 869 | (album (car (lastfm-track-get-info artist song)))) 870 | (vuiet-album-info artist album)))) 871 | 872 | ;;;###autoload 873 | (defun vuiet-play-album (&optional artist album) 874 | "Play the whole ALBUM of the given ARTIST. 875 | If called interactively, the album can be picked interactively 876 | from the ARTIST's top albums, where ARTIST is given in the 877 | minibuffer." 878 | (interactive) 879 | (if (and artist album) 880 | (vuiet-play (lastfm-album-get-info artist album)) 881 | (vuiet--artist-from-minibuffer-if-nil artist) 882 | (ivy-read (format "Play %s Album" artist) 883 | (lastfm-artist-get-top-albums 884 | artist :limit vuiet-artist-top-albums-limit) 885 | :action (lambda (album) 886 | (vuiet-play 887 | (lastfm-album-get-info artist (car album))))))) 888 | 889 | (iter-defun vuiet--artists-similar-tracks (artists) 890 | "Return a generator of tracks based on the given ARTISTS. 891 | The generator yields top tracks from artists similar to the given 892 | artist or the given list of artists." 893 | (while t 894 | (let* ((artists (lastfm-artist-get-similar 895 | (seq-random-elt artists) 896 | :limit vuiet-artist-similar-limit)) 897 | (artist (car (seq-random-elt artists))) 898 | (track (cadr (seq-random-elt 899 | (lastfm-artist-get-top-tracks 900 | artist 901 | :limit vuiet-artist-tracks-limit))))) 902 | (iter-yield (vuiet--new-track artist track))))) 903 | 904 | ;;;###autoload 905 | (defun vuiet-play-artist-similar (&optional artists) 906 | "Play tracks from artists similar to ARTISTS. 907 | ARTISTS is a list of strings of the form '(artist1 artist2 etc.) 908 | If called interactively, multiple artists can be provided in the 909 | minibuffer if they are sepparated by commas." 910 | (interactive) 911 | (vuiet--artist-from-minibuffer-if-nil artists) 912 | (vuiet--play 913 | (vuiet--artists-similar-tracks 914 | (if (stringp artists) 915 | ;; The function was called interactively. 916 | (mapcar #'s-trim (s-split "," artists)) 917 | artists)))) 918 | 919 | (defun vuiet-play-playing-artist-similar () 920 | "Play tracks from artists similar to the playing artist. 921 | This function is similar to `vuiet-play-artist-similar', only the 922 | list of artists is limited to the artist of the currently playing 923 | track." 924 | (interactive) 925 | (vuiet-play-artist-similar (vuiet-playing-artist))) 926 | 927 | (iter-defun vuiet--tags-similar-tracks (tags) 928 | "Return a generator of tracks based on the given TAGS. 929 | Return a random track from a random artist for a random tag in 930 | the list of TAGS." 931 | (while t 932 | (let* ((artists (lastfm-tag-get-top-artists 933 | (seq-random-elt tags) 934 | :limit vuiet-tag-artists-limit)) 935 | (artist (car (seq-random-elt artists))) 936 | (track (cadr (seq-random-elt 937 | (lastfm-artist-get-top-tracks 938 | artist 939 | :limit vuiet-artist-tracks-limit))))) 940 | (iter-yield (vuiet--new-track artist track))))) 941 | 942 | ;;;###autoload 943 | (defun vuiet-play-tag-similar (tags) 944 | "Play tracks from artists similar to TAGS. 945 | TAGS is a list of strings of the form '(tag1 tag2 etc.) 946 | If called interactively, multiple tags can be provided in the 947 | minibuffer if they are sepparated by commas." 948 | (interactive "sTag(s): ") 949 | (vuiet--play 950 | (vuiet--tags-similar-tracks 951 | (if (stringp tags) 952 | ;; The function was called interactively. 953 | (mapcar #'s-trim (s-split "," tags)) 954 | tags)))) 955 | 956 | (defun vuiet-play-playing-tags-similar () 957 | "Play tracks from artists with similar tags as the current tags. 958 | Play tracks from random artists that have tags equal to one of 959 | the tags of the currently playing artist." 960 | (interactive) 961 | (vuiet--play 962 | (vuiet--tags-similar-tracks 963 | (mapcar #'car (lastfm-artist-get-top-tags 964 | (vuiet-playing-artist)))))) 965 | 966 | ;;;###autoload 967 | (defun vuiet-play-track (&optional artist name) 968 | "Play the song NAME from the given ARTIST. 969 | If called interactively, let the user select and play one of the 970 | ARTIST's top songs, where ARTIST is given in the minibuffer." 971 | (interactive) 972 | (if (and artist name) 973 | (vuiet-play `((,artist ,name))) 974 | (vuiet--artist-from-minibuffer-if-nil artist) 975 | (vuiet--ivy-play-song 976 | (lastfm-artist-get-top-tracks artist 977 | :limit vuiet-artist-tracks-limit))) ) 978 | 979 | ;;;###autoload 980 | (defun vuiet-play-track-search (track) 981 | "Search TRACK and play the selected item. 982 | Similar to `vuiet-play-track', but search for TRACK on last.fm 983 | first and then let the user select one of the results." 984 | (interactive "sTrack: ") 985 | (alet (lastfm-track-search track) 986 | (vuiet--ivy-play-song 987 | ;; Transform into a list if last.fm returned only one result. 988 | (if (listp (car it)) it (list it))))) 989 | 990 | ;;;###autoload 991 | (defun vuiet-play-track-by-lyrics (lyrics) 992 | "Search a track by LYRICS and play it." 993 | (interactive "sLyrics: ") 994 | (let ((track (versuri-ivy-search lyrics))) 995 | (vuiet-play (list track)))) 996 | 997 | ;;;###autoload 998 | (defun vuiet-play-loved-track () 999 | "Select a track from the user loved tracks and play it. 1000 | The user loved tracks list is the one associated with the 1001 | username given in the setup of the lastfm.el package." 1002 | (interactive) 1003 | (vuiet--ivy-play-song (lastfm-user-get-loved-tracks 1004 | :limit vuiet-loved-tracks-limit))) 1005 | 1006 | ;;;###autoload 1007 | (defun vuiet-play-loved-tracks (random) 1008 | "Play all the tracks from the user loved tracks. 1009 | If RANDOM is t, play the tracks at random, indefinitely. 1010 | The user loved tracks list is the one associated with the 1011 | username given in the setup of the lastfm.el package." 1012 | (interactive (list (y-or-n-p "Play random? "))) 1013 | (vuiet-play (lastfm-user-get-loved-tracks 1014 | :limit vuiet-loved-tracks-limit) 1015 | :random random)) 1016 | 1017 | ;;;###autoload 1018 | (defun vuiet-play-artist-loved-tracks (&optional artist random) 1019 | "Play all the ARTIST tracks found in the user loved tracks. 1020 | Similar to `vuiet-play-loved-tracks', but play only the tracks 1021 | from the given ARTIST." 1022 | (interactive) 1023 | (unless artist 1024 | (setf artist 1025 | (ivy-read "Artist: " 1026 | (seq-uniq 1027 | (mapcar #'car (lastfm-user-get-loved-tracks 1028 | :limit vuiet-loved-tracks-limit)))))) 1029 | (unless random 1030 | (setf random (y-or-n-p "Play random? "))) 1031 | (vuiet-play 1032 | (seq-filter (lambda (item) 1033 | (string-match artist (car item))) 1034 | (lastfm-user-get-loved-tracks 1035 | :limit vuiet-loved-tracks-limit)) 1036 | :random random)) 1037 | 1038 | ;;;###autoload 1039 | (defun vuiet-play-recent-track () 1040 | "Play one of the recent listened tracks." 1041 | (interactive) 1042 | (vuiet--ivy-play-song (lastfm-user-get-recent-tracks 1043 | :limit 25))) 1044 | 1045 | (iter-defun vuiet--loved-tracks-similar-tracks () 1046 | "Return a generator of tracks based on the user's loved tracks. 1047 | Return a random track from a random artist from the user's loved 1048 | tracks list." 1049 | (while t 1050 | (let* ((artist (car (seq-random-elt 1051 | (lastfm-user-get-loved-tracks 1052 | :limit vuiet-loved-tracks-limit)))) 1053 | (similar (car (seq-random-elt 1054 | (lastfm-artist-get-similar 1055 | artist 1056 | :limit vuiet-artist-similar-limit)))) 1057 | (track (cadr (seq-random-elt 1058 | (lastfm-artist-get-top-tracks 1059 | similar 1060 | :limit vuiet-artist-tracks-limit))))) 1061 | (iter-yield (vuiet--new-track similar track))))) 1062 | 1063 | ;;;###autoload 1064 | (defun vuiet-play-loved-tracks-similar () 1065 | "Play tracks based on artists similar to loved tracks artists. 1066 | Play tracks from random artists similar to a random artist from 1067 | the list of user loved tracks." 1068 | (interactive) 1069 | (vuiet--play (vuiet--loved-tracks-similar-tracks))) 1070 | 1071 | (provide 'vuiet) 1072 | 1073 | ;;; vuiet.el ends here 1074 | --------------------------------------------------------------------------------