commit 1a878b536bd4aff22f972976620ab4b48770465b Author: oSumAtrIX Date: Mon Oct 11 02:12:22 2021 +0200 Add initial files diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..4886b5a --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,24 @@ +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +name: "Build project" + +env: + CARGO_TERM_COLOR: always + +jobs: + build_and_test: + name: DownOnSpot + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - run: sudo apt install -y libasound2-dev libmp3lame-dev + - uses: actions-rs/toolchain@v1 + with: + override: true + toolchain: nightly + - run: cargo build --release --all-features \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e8c7448 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/target +settings.json +Cargo.lock +libmp3lame.dll \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..fd02e6b --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,47 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "type": "lldb", + "request": "launch", + "name": "Debug executable 'down_on_spot'", + "cargo": { + "args": [ + "build", + "--bin=down_on_spot", + "--package=down_on_spot" + ], + "filter": { + "name": "down_on_spot", + "kind": "bin" + } + }, + "args": [ + "https://open.spotify.com/track/2Ju1xUOXSS1C6GOvlTHXUp?si=60e759a084d2470d" + ], + "cwd": "${workspaceFolder}" + }, + { + "type": "lldb", + "request": "launch", + "name": "Debug unit tests in executable 'down_on_spot'", + "cargo": { + "args": [ + "test", + "--no-run", + "--bin=down_on_spot", + "--package=down_on_spot" + ], + "filter": { + "name": "down_on_spot", + "kind": "bin" + } + }, + "args": [], + "cwd": "${workspaceFolder}" + } + ] +} \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..c0af5a3 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,45 @@ +cargo-features = ["strip"] + +[profile.release] +strip = true +opt-level = "z" +lto = true +codegen-units = 1 +panic = "abort" + +[package] +name = "down_on_spot" +version = "0.0.1" +edition = "2018" +authors = ["exttex", "oSumAtrIX"] +build = "build.rs" + +[target.'cfg(windows)'.build-dependencies] +winres = "0.1.12" + +[dependencies] +log = "0.4.14" +url = "2.2" +id3 = "0.6" +dirs = "3.0" +chrono = "0.4" +lewton = "0.10" +futures = "0.3" +reqwest = "0.11" +colored = "2" +lame = "0.1.3" +aspotify = "0.7" +librespot = "0.2" +async-std = { version = "1.10.0", features = ["attributes", "tokio1"] } +serde_json = "1.0" +async-stream = "0.3" +oggvorbismeta = "0.1" +sanitize-filename = "0.3" +serde = { version = "1.0.130", features = ["derive"] } +tokio = { version = "1.12", features = ["fs"] } + +[package.metadata.winres] +OriginalFilename = "DownOnSpot.exe" +FileDescription = "Download songs from spotify with rust" +ProductName = "DownOnSpot" +ProductVersion = "0.0.1" \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6ceba7a --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +
+ +# DownOnSpot + +### A Spotify downloader written in Rust + +drawing +
+ +## Disclaimer + +```text +DownOnSpot was not developed for piracy, but educational and private usage. +It may be illegal to use this in your country! +I am not responsible in any way for the usage of this app. +``` + +## Features + +- Multi-threaded +- Download 320 kbit/s audio from spotify, directly +- Download playlists and albums +- Convert to mp3 +- Simple usage over CLI + +## Building + +To build this project you will need `Nightly Rust`. You can install it by following [rustup.rs](https://rustup.rs) instructions. + +```bash +git clone https://github.com/oSumAtrIX/DownOnSpot.git +cd DownOnSpot +cargo build --release +``` + +If you get a linker error, you might need to download the [standard libmp3lame](https://www.rarewares.org/mp3-lame-libraries.php#libmp3lame) library. + +## Usage/Examples + +To install and use DownOnSpot, edit the configuration file which is being created in the same directory as your shell on first launch. + +```bash +$ down_on_spot.exe +Settings could not be loaded, because of the following error: IO: NotFound No such file or directory. (os error 2)... +..but default settings have been created successfully. Edit them and run the program again. + +$ down_on_spot.exe +Usage: +down_on_spot.exe (track_url | album_url | playlist_url) +``` + +## Authors + +- [@oSumAtrIX](https://osumatrix.me/#github) +- [@exttex](https://git.freezer.life/exttex) + +## License + +[GPL3](https://choosealicense.com/licenses/agpl-3.0/) diff --git a/assets/icon.afdesign b/assets/icon.afdesign new file mode 100644 index 0000000..bcf991f Binary files /dev/null and b/assets/icon.afdesign differ diff --git a/assets/icon.ico b/assets/icon.ico new file mode 100644 index 0000000..a1cfe9a Binary files /dev/null and b/assets/icon.ico differ diff --git a/assets/icon.svg b/assets/icon.svg new file mode 100644 index 0000000..06607d0 --- /dev/null +++ b/assets/icon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/build.rs b/build.rs new file mode 100644 index 0000000..f6a0d28 --- /dev/null +++ b/build.rs @@ -0,0 +1,9 @@ +fn main() { + #[cfg(windows)] + { + winres::WindowsResource::new() + .set_icon("assets/icon.ico") + .compile() + .unwrap(); + } +} diff --git a/mp3lame.lib b/mp3lame.lib new file mode 100644 index 0000000..7824f1b Binary files /dev/null and b/mp3lame.lib differ diff --git a/src/converter.rs b/src/converter.rs new file mode 100644 index 0000000..08563a7 --- /dev/null +++ b/src/converter.rs @@ -0,0 +1,160 @@ +use lewton::inside_ogg::OggStreamReader; +use std::io::{Error, ErrorKind, Read, Seek}; + +use crate::downloader::{AudioFormat, Quality}; +use crate::error::SpotifyError; +use crate::error::SpotifyError::{LameConverterError, InvalidFormat}; + +/// Converts audio to MP3 +pub enum AudioConverter { + OGG { + decoder: OggStreamReader, + lame: lame::Lame, + lame_end: bool, + }, +} + +unsafe impl Send for AudioConverter {} + +impl AudioConverter { + /// Wrap reader + pub fn new( + read: Box<(dyn Read + Send + 'static)>, + format: AudioFormat, + quality: Quality, + ) -> Result { + // Create encoder + let bitrate = match quality { + Quality::Q320 => 320, + Quality::Q256 => 256, + Quality::Q160 => 160, + Quality::Q96 => 96, + }; + + let mut lame = lame::Lame::new().unwrap(); + + match lame.set_channels(2) { + Ok(_) => {} + Err(_) => return Err(LameConverterError("Channels".to_string())) + }; + + match lame.set_quality(0) { + Ok(_) => {} + Err(_) => return Err(LameConverterError("Quality".to_string())) + }; + match lame.set_kilobitrate(bitrate) { + Ok(_) => {} + Err(_) => return Err(LameConverterError("Bitrate".to_string())) + }; + + match format { + AudioFormat::AAC => todo!(), + AudioFormat::MP4 => todo!(), + // Lewton decoder + AudioFormat::OGG => { + let decoder = OggStreamReader::new(ReadWrap::new(Box::new(read)))?; + let sample_rate = decoder.ident_hdr.audio_sample_rate; + // Init lame + match lame.set_sample_rate(sample_rate) { + Ok(_) => {} + Err(_) => return Err(LameConverterError("Sample rate".to_string())) + }; + match lame.init_params() { + Ok(_) => {} + Err(_) => return Err(LameConverterError("Init".to_string())) + }; + + Ok(AudioConverter::OGG { + lame, + decoder, + lame_end: false, + }) + } + AudioFormat::MP3 => panic!("No reencoding allowd!"), + _ => Err(InvalidFormat), + } + } +} + +impl Read for AudioConverter { + fn read(&mut self, buf: &mut [u8]) -> std::io::Result { + match self { + AudioConverter::OGG { + decoder, + lame, + lame_end, + } => { + match decoder.read_dec_packet() { + Ok(packet) => match packet { + Some(data) => { + // 0 sized packets aren't EOF + if data[0].is_empty() { + return self.read(buf); + } + + let result = match lame.encode(&data[0], &data[1], buf) { + Ok(size) => { + if size == 0 { + return self.read(buf); + } + size + } + Err(_e) => { + drop(lame); + return Err(Error::new( + ErrorKind::InvalidData, + format!("Lame error: {:?}", _e), + )); + } + }; + Ok(result as usize) + } + None => { + if *lame_end { + return Ok(0); + } + // Flush buffer + drop(lame); + *lame_end = true; + Ok(0) + } + }, + Err(e) => { + // Close lame + if !*lame_end { + drop(lame); + *lame_end = true; + } + warn!("Lawton error: {}, calling EOF", e); + Ok(0) + } + } + } + } + } +} + +pub struct ReadWrap { + source: Box<(dyn Read + Send + 'static)>, +} + +impl ReadWrap { + pub fn new(read: Box<(dyn Read + Send + 'static)>) -> ReadWrap { + ReadWrap { + source: Box::new(read), + } + } +} + +impl Read for ReadWrap { + fn read(&mut self, buf: &mut [u8]) -> std::io::Result { + self.source.read(buf) + } +} + +/// Fake seek for Rodio +impl Seek for ReadWrap { + fn seek(&mut self, _pos: std::io::SeekFrom) -> std::io::Result { + Ok(0) + } +} diff --git a/src/downloader.rs b/src/downloader.rs new file mode 100644 index 0000000..b238bac --- /dev/null +++ b/src/downloader.rs @@ -0,0 +1,811 @@ +use async_std::channel::{bounded, Receiver, Sender}; +use async_stream::try_stream; +use chrono::NaiveDate; +use futures::stream::FuturesUnordered; +use futures::{pin_mut, select, FutureExt, Stream, StreamExt}; +use librespot::audio::{AudioDecrypt, AudioFile}; +use librespot::core::audio_key::AudioKey; +use librespot::core::session::Session; +use librespot::core::spotify_id::SpotifyId; +use librespot::metadata::{FileFormat, Metadata, Track}; +use sanitize_filename::sanitize; +use serde::{Deserialize, Serialize}; +use std::io::Read; +use std::path::{Path, PathBuf}; +use tokio::fs::File; +use tokio::io::AsyncWriteExt; + +use crate::converter::AudioConverter; +use crate::error::SpotifyError; +use crate::spotify::{Spotify, SpotifyItem}; +use crate::tag::{Field, TagWrap}; + +/// Wrapper for use with UI +#[derive(Debug, Clone)] +pub struct Downloader { + rx: Receiver, + tx: Sender, + + spotify: Spotify, +} +impl Downloader { + /// Create new instance + pub fn new(config: DownloaderConfig, spotify: Spotify) -> Downloader { + let (tx_0, rx_0) = bounded(1); + let (tx_1, rx_1) = bounded(1); + + let tx_clone = tx_1.clone(); + let spotify_clone = spotify.clone(); + tokio::spawn(async move { + communication_thread(config, spotify_clone, rx_1, tx_0, tx_clone).await + }); + Downloader { + rx: rx_0, + tx: tx_1, + spotify, + } + } + /// Add item to download queue + pub async fn add_to_queue(&self, download: Download) { + self.tx + .send(Message::AddToQueue(vec![download])) + .await + .unwrap(); + } + + /// Add multiple items to queue + pub async fn add_to_queue_multiple(&self, downloads: Vec) { + self.tx.send(Message::AddToQueue(downloads)).await.unwrap(); + } + + /// Add URL or URI to queue + pub async fn add_uri(&self, uri: &str) -> Result<(), SpotifyError> { + let uri = Spotify::parse_uri(uri)?; + let item = self.spotify.resolve_uri(&uri).await?; + match item { + SpotifyItem::Track(t) => self.add_to_queue(t.into()).await, + SpotifyItem::Album(a) => { + let tracks = self.spotify.full_album(&a.id).await?; + let queue: Vec = tracks.into_iter().map(|t| t.into()).collect(); + self.add_to_queue_multiple(queue).await; + } + SpotifyItem::Playlist(p) => { + let tracks = self.spotify.full_playlist(&p.id).await?; + let queue: Vec = tracks.into_iter().map(|t| t.into()).collect(); + self.add_to_queue_multiple(queue).await; + } + // Unsupported + SpotifyItem::Other(u) => { + error!("Unsupported URI: {}", u); + return Err(SpotifyError::Unavailable); + } + }; + Ok(()) + } + + /// Get all downloads + pub async fn get_downloads(&self) -> Vec { + self.tx.send(Message::GetDownloads).await.unwrap(); + let Response::Downloads(d) = self.rx.recv().await.unwrap(); + d + } +} + +async fn communication_thread( + config: DownloaderConfig, + spotify: Spotify, + rx: Receiver, + tx: Sender, + self_tx: Sender, +) { + // Downloader + let downloader = DownloaderInternal::new(spotify.clone(), self_tx.clone()); + let downloader_tx = downloader.tx.clone(); + tokio::spawn(async move { + downloader.download_loop().await; + }); + let mut waiting_for_job = false; + let mut queue: Vec = vec![]; + + // Receive messages + while let Ok(msg) = rx.recv().await { + match msg { + // Send job to worker thread + Message::GetJob => { + if let Some(d) = queue.iter_mut().find(|i| i.state == DownloadState::None) { + d.state = DownloadState::Lock; + downloader_tx + .send(DownloaderMessage::Job(d.clone().into(), config.clone())) + .await + .unwrap(); + waiting_for_job = false; + } else { + waiting_for_job = true; + } + } + // Update state of download + Message::UpdateState(id, state) => { + let i = queue.iter().position(|i| i.id == id).unwrap(); + queue[i].state = state.clone(); + if state == DownloadState::Done { + queue.remove(i); + } + } + Message::AddToQueue(download) => { + // Assign new IDs and reset state + let mut id = queue.iter().map(|i| i.id).max().unwrap_or(0); + let downloads: Vec = download + .into_iter() + .map(|mut d| { + d.id = id; + d.state = DownloadState::None; + id += 1; + d + }) + .collect(); + queue.extend(downloads); + // Update worker threads if locked + if waiting_for_job { + let d = queue + .iter_mut() + .find(|i| i.state == DownloadState::None) + .unwrap(); + d.state = DownloadState::Lock; + downloader_tx + .send(DownloaderMessage::Job(d.clone().into(), config.clone())) + .await + .unwrap(); + waiting_for_job = false; + } + } + Message::GetDownloads => { + tx.send(Response::Downloads(queue.clone())).await.ok(); + } + } + } +} + +/// Spotify downloader +pub struct DownloaderInternal { + spotify: Spotify, + pub tx: Sender, + rx: Receiver, + event_tx: Sender, +} + +pub enum DownloaderMessage { + Job(DownloadJob, DownloaderConfig), +} + +impl DownloaderInternal { + /// Create new instance + pub fn new(spotify: Spotify, event_tx: Sender) -> DownloaderInternal { + let (tx, rx) = bounded(1); + DownloaderInternal { + spotify, + tx, + rx, + event_tx, + } + } + + /// Downloader loop + pub async fn download_loop(&self) { + let mut queue = vec![]; + let mut tasks = FuturesUnordered::new(); + let mut job_future = Box::pin(self.get_job()).fuse(); + + loop { + select! { + job = job_future => { + if let Some((job, config)) = job { + if tasks.len() < config.concurrent_downloads { + tasks.push(self.download_job_wrapper(job.clone(), config).boxed()) + } else { + queue.push((job, config)); + } + } + job_future = Box::pin(self.get_job()).fuse(); + }, + // Task finished + () = tasks.select_next_some() => { + if let Some((job, config)) = queue.first() { + tasks.push(self.download_job_wrapper(job.clone(), config.clone()).boxed()); + queue.remove(0); + } + } + }; + } + } + + // Get job from parent + async fn get_job(&self) -> Option<(DownloadJob, DownloaderConfig)> { + self.event_tx.send(Message::GetJob).await.unwrap(); + match self.rx.recv().await.ok()? { + DownloaderMessage::Job(job, config) => Some((job, config)), + } + } + + /// Wrapper for download_job for error handling + async fn download_job_wrapper(&self, job: DownloadJob, config: DownloaderConfig) { + let track_id = job.track_id.clone(); + let id = job.id; + match self.download_job(job, config).await { + Ok(_) => {} + Err(e) => { + error!("Download job for track {} failed. {}", track_id, e); + self.event_tx + .send(Message::UpdateState( + id, + DownloadState::Error(e.to_string()), + )) + .await + .unwrap(); + } + } + } + + // Wrapper for downloading and tagging + async fn download_job( + &self, + job: DownloadJob, + config: DownloaderConfig, + ) -> Result<(), SpotifyError> { + // Fetch metadata + let track = self + .spotify + .spotify + .tracks() + .get_track(&job.track_id, None) + .await? + .data; + let album = self + .spotify + .spotify + .albums() + .get_album(&track.album.id.ok_or(SpotifyError::Unavailable)?, None) + .await? + .data; + // Generate path + let mut filename = config.filename_template.to_owned(); + let tags: Vec<(&str, String)> = vec![ + ("%title%", sanitize(&track.name)), + ( + "%artist%", + sanitize( + &track + .artists + .iter() + .map(|a| a.name.as_str()) + .collect::>() + .first() + .unwrap_or(&""), + ), + ), + ( + "%artists%", + sanitize( + &track + .artists + .iter() + .map(|a| a.name.as_str()) + .collect::>() + .join(", "), + ), + ), + ("%track%", track.track_number.to_string()), + ("%0track%", format!("{:02}", track.track_number)), + ("%disc%", track.disc_number.to_string()), + ("%0disc%", format!("{:02}", track.disc_number)), + ("%id%", job.track_id.to_string()), + ("%album%", sanitize(&track.album.name)), + ( + "%albumArtist%", + sanitize( + &track + .album + .artists + .iter() + .map(|a| a.name.as_str()) + .collect::>() + .first() + .unwrap_or(&""), + ), + ), + ( + "%albumArtists%", + sanitize( + &track + .album + .artists + .iter() + .map(|a| a.name.as_str()) + .collect::>() + .join(", "), + ), + ), + ]; + for (t, v) in tags { + filename = filename.replace(t, &v); + } + let path = config.path.join(filename); + tokio::fs::create_dir_all(path.parent().unwrap()).await?; + + // Download + let (path, format) = DownloaderInternal::download_track( + &self.spotify.session, + &job.track_id, + path, + config.clone(), + self.event_tx.clone(), + job.id, + ) + .await?; + // Post processing + self.event_tx + .send(Message::UpdateState(job.id, DownloadState::Post)) + .await + .ok(); + + // Download cover + let mut cover = None; + if let Some(image) = track.album.images.first() { + match DownloaderInternal::download_cover(&image.url).await { + Ok(c) => cover = Some(c), + Err(e) => warn!("Failed downloading cover! {}", e), + } + } + + let tags = vec![ + (Field::Title, vec![track.name.to_string()]), + (Field::Album, vec![track.album.name.to_string()]), + ( + Field::Artist, + track + .artists + .iter() + .map(|a| a.name.to_string()) + .collect::>(), + ), + ( + Field::AlbumArtist, + track + .album + .artists + .iter() + .map(|a| a.name.to_string()) + .collect::>(), + ), + (Field::TrackNumber, vec![track.track_number.to_string()]), + (Field::DiscNumber, vec![track.disc_number.to_string()]), + (Field::Genre, album.genres.clone()), + (Field::Label, vec![album.label.to_string()]), + ]; + let date = album.release_date; + // Write tags + let config = config.clone(); + tokio::task::spawn_blocking(move || { + DownloaderInternal::write_tags(path, format, tags, date, cover, config) + }) + .await??; + + // Done + self.event_tx + .send(Message::UpdateState(job.id, DownloadState::Done)) + .await + .ok(); + Ok(()) + } + + /// Download cover, returns mime and data + async fn download_cover(url: &str) -> Result<(String, Vec), SpotifyError> { + let res = reqwest::get(url).await?; + let mime = res + .headers() + .get("content-type") + .ok_or(SpotifyError::Error("Missing cover mime!".into()))? + .to_str() + .unwrap() + .to_string(); + let data = res.bytes().await?.to_vec(); + Ok((mime, data)) + } + + /// Write tags to file ( BLOCKING ) + fn write_tags( + path: impl AsRef, + format: AudioFormat, + tags: Vec<(Field, Vec)>, + date: NaiveDate, + cover: Option<(String, Vec)>, + config: DownloaderConfig, + ) -> Result<(), SpotifyError> { + let mut tag_wrap = TagWrap::new(path, format)?; + // Format specific + match &mut tag_wrap { + TagWrap::ID3(id3) => id3.use_id3_v24(config.id3v24), + _ => {} + } + + let tag = tag_wrap.get_tag(); + tag.set_separator(&config.separator); + for (field, value) in tags { + tag.set_field(field, value); + } + tag.set_release_date(date); + // Cover + if let Some((mime, data)) = cover { + tag.add_cover(&mime, data); + } + tag.save()?; + Ok(()) + } + + /// Download track by id + async fn download_track( + session: &Session, + id: &str, + path: impl AsRef, + config: DownloaderConfig, + tx: Sender, + job_id: i64, + ) -> Result<(PathBuf, AudioFormat), SpotifyError> { + let id = SpotifyId::from_base62(id)?; + let track = Track::get(session, id).await?; + // Fallback if unavailable + if !track.available { + for alt in track.alternatives { + let t = Track::get(session, alt).await?; + if t.available { + break; + } + } + return Err(SpotifyError::Unavailable); + } + // Quality fallback + let mut quality = config.quality; + let (mut file_id, mut file_format) = (None, None); + 'outer: loop { + for format in quality.get_file_formats() { + if let Some(f) = track.files.get(&format) { + info!("{} Using {:?} format.", id.to_base62(), format); + file_id = Some(f); + file_format = Some(format); + break 'outer; + } + } + // Fallback to worser quality + match quality.fallback() { + Some(q) => quality = q, + None => break, + } + warn!("{} Falling back to: {:?}", id.to_base62(), quality); + } + let file_id = file_id.ok_or(SpotifyError::Unavailable)?; + let file_format = file_format.unwrap(); + + // Path with extension + let mut audio_format: AudioFormat = file_format.into(); + let path = format!( + "{}.{}", + path.as_ref().to_str().unwrap(), + match config.convert_to_mp3 { + true => "mp3".to_string(), + false => audio_format.extension(), + } + ); + let path = Path::new(&path).to_owned(); + let path_clone = path.clone(); + + let key = session.audio_key().request(track.id, *file_id).await?; + let encrypted = AudioFile::open(session, *file_id, 1024 * 1024, true).await?; + let size = encrypted.get_stream_loader_controller().len(); + // Download + let s = match config.convert_to_mp3 { + true => { + let s = DownloaderInternal::download_track_convert_stream( + path_clone, + encrypted, + key, + audio_format.clone(), + quality, + ) + .boxed(); + audio_format = AudioFormat::MP3; + s + } + false => DownloaderInternal::download_track_stream(path_clone, encrypted, key).boxed(), + }; + pin_mut!(s); + // Read progress + let mut read = 0; + while let Some(result) = s.next().await { + match result { + Ok(r) => { + read += r; + tx.send(Message::UpdateState( + job_id, + DownloadState::Downloading(read, size), + )) + .await + .ok(); + } + Err(e) => { + tokio::fs::remove_file(path).await.ok(); + return Err(e); + } + } + } + + info!("Done downloading: {}", track.id.to_base62()); + Ok((path, audio_format)) + } + + fn download_track_stream( + path: impl AsRef, + encrypted: AudioFile, + key: AudioKey, + ) -> impl Stream> { + try_stream! { + let mut file = File::create(path).await?; + let mut decrypted = AudioDecrypt::new(key, encrypted); + // Skip (i guess encrypted shit) + let mut skip: [u8; 0xa7] = [0; 0xa7]; + let mut decrypted = tokio::task::spawn_blocking(move || { + match decrypted.read_exact(&mut skip) { + Ok(_) => Ok(decrypted), + Err(e) => Err(e) + } + }).await??; + // Custom reader loop for decrypting + loop { + // Blocking reader + let (d, read, mut buf) = tokio::task::spawn_blocking(move || { + let mut buf = vec![0; 1024 * 64]; + match decrypted.read(&mut buf) { + Ok(r) => Ok((decrypted, r, buf)), + Err(e) => Err(e) + } + }).await??; + decrypted = d; + if read == 0 { + break; + } + file.write_all(&mut buf[0..read]).await?; + yield read; + } + } + } + + /// Download and convert to MP3 + fn download_track_convert_stream( + path: impl AsRef, + encrypted: AudioFile, + key: AudioKey, + format: AudioFormat, + quality: Quality, + ) -> impl Stream> { + try_stream! { + let mut file = File::create(path).await?; + let mut decrypted = AudioDecrypt::new(key, encrypted); + // Skip (i guess encrypted shit) + let mut skip: [u8; 0xa7] = [0; 0xa7]; + let decrypted = tokio::task::spawn_blocking(move || { + match decrypted.read_exact(&mut skip) { + Ok(_) => Ok(decrypted), + Err(e) => Err(e) + } + }).await??; + // Convertor + let mut decrypted = tokio::task::spawn_blocking(move || { + AudioConverter::new(Box::new(decrypted), format, quality) + }).await??; + + // Custom reader loop for decrypting + loop { + // Blocking reader + let (d, read, mut buf) = tokio::task::spawn_blocking(move || { + let mut buf = vec![0; 1024 * 64]; + match decrypted.read(&mut buf) { + Ok(r) => Ok((decrypted, r, buf)), + Err(e) => Err(e) + } + }).await??; + decrypted = d; + if read == 0 { + break; + } + file.write_all(&mut buf[0..read]).await?; + yield read; + } + } + } +} + +#[derive(Debug, Clone)] +pub enum AudioFormat { + OGG, + AAC, + MP3, + MP4, + Unknown, +} + +impl AudioFormat { + /// Get extension + pub fn extension(&self) -> String { + match self { + AudioFormat::OGG => "ogg", + AudioFormat::AAC => "m4a", + AudioFormat::MP3 => "mp3", + AudioFormat::MP4 => "mp4", + AudioFormat::Unknown => "", + } + .to_string() + } +} + +impl From for AudioFormat { + fn from(f: FileFormat) -> Self { + match f { + FileFormat::OGG_VORBIS_96 => Self::OGG, + FileFormat::OGG_VORBIS_160 => Self::OGG, + FileFormat::OGG_VORBIS_320 => Self::OGG, + FileFormat::MP3_256 => Self::MP3, + FileFormat::MP3_320 => Self::MP3, + FileFormat::MP3_160 => Self::MP3, + FileFormat::MP3_96 => Self::MP3, + FileFormat::MP3_160_ENC => Self::MP3, + FileFormat::MP4_128_DUAL => Self::MP4, + FileFormat::OTHER3 => Self::Unknown, + FileFormat::AAC_160 => Self::AAC, + FileFormat::AAC_320 => Self::AAC, + FileFormat::MP4_128 => Self::MP4, + FileFormat::OTHER5 => Self::Unknown, + } + } +} + +impl Quality { + /// Get librespot FileFormat + pub fn get_file_formats(&self) -> Vec { + match self { + Self::Q320 => vec![ + FileFormat::OGG_VORBIS_320, + FileFormat::AAC_320, + FileFormat::MP3_320, + ], + Self::Q256 => vec![FileFormat::MP3_256], + Self::Q160 => vec![ + FileFormat::OGG_VORBIS_160, + FileFormat::AAC_160, + FileFormat::MP3_160, + ], + Self::Q96 => vec![FileFormat::OGG_VORBIS_96, FileFormat::MP3_96], + } + } + + /// Fallback to lower quality + pub fn fallback(&self) -> Option { + match self { + Self::Q320 => Some(Quality::Q256), + Self::Q256 => Some(Quality::Q160), + Self::Q160 => Some(Quality::Q96), + Self::Q96 => None, + } + } +} + +#[derive(Debug, Clone)] +pub struct DownloadJob { + pub id: i64, + pub track_id: String, +} + +#[derive(Debug, Clone)] +pub enum Message { + // Send job to worker + GetJob, + // Update state of download + UpdateState(i64, DownloadState), + AddToQueue(Vec), + // Get all downloads to UI + GetDownloads, +} + +#[derive(Debug, Clone)] +pub enum Response { + Downloads(Vec), +} + +#[derive(Debug, Clone)] +pub struct Download { + pub id: i64, + pub track_id: String, + pub title: String, + pub subtitle: String, + pub state: DownloadState, +} + +impl Into for aspotify::Track { + fn into(self) -> Download { + Download { + id: 0, + track_id: self.id.unwrap(), + title: self.name, + subtitle: self + .artists + .first() + .map(|a| a.name.to_owned()) + .unwrap_or_default(), + state: DownloadState::None, + } + } +} + +impl Into for aspotify::TrackSimplified { + fn into(self) -> Download { + Download { + id: 0, + track_id: self.id.unwrap(), + title: self.name, + subtitle: self + .artists + .first() + .map(|a| a.name.to_owned()) + .unwrap_or_default(), + state: DownloadState::None, + } + } +} + +impl Into for Download { + fn into(self) -> DownloadJob { + DownloadJob { + id: self.id, + track_id: self.track_id, + } + } +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum DownloadState { + None, + Lock, + Downloading(usize, usize), + Post, + Done, + Error(String), +} + +/// Bitrate of music +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Copy)] +pub enum Quality { + Q320, + Q256, + Q160, + Q96, +} + +impl ToString for Quality { + fn to_string(&self) -> String { + match self { + Quality::Q320 => "320kbps", + Quality::Q256 => "256kbps", + Quality::Q160 => "160kbps", + Quality::Q96 => "96kbps", + } + .to_string() + } +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct DownloaderConfig { + pub concurrent_downloads: usize, + pub quality: Quality, + pub path: PathBuf, + pub filename_template: String, + pub id3v24: bool, + pub convert_to_mp3: bool, + pub separator: String, +} diff --git a/src/error.rs b/src/error.rs new file mode 100644 index 0000000..11c8a43 --- /dev/null +++ b/src/error.rs @@ -0,0 +1,134 @@ +use std::fmt; + +#[derive(Debug, Clone)] +pub enum SpotifyError { + Error(String), + IoError(std::io::ErrorKind, String), + MercuryError, + AuthenticationError, + Unavailable, + SpotifyIdError, + ChannelError, + AudioKeyError, + LameConverterError(String), + JoinError, + ASpotify(String), + Serde(String, usize, usize), + InvalidUri, + ParseError(url::ParseError), + ID3Error(String, String), + Reqwest(String), + InvalidFormat, +} + +impl std::error::Error for SpotifyError {} +impl fmt::Display for SpotifyError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + SpotifyError::Error(e) => write!(f, "Error: {}", e), + SpotifyError::MercuryError => write!(f, "Mercury Error"), + SpotifyError::IoError(kind, err) => write!(f, "IO: {:?} {}", kind, err), + SpotifyError::AuthenticationError => write!(f, "Authentication Error"), + SpotifyError::Unavailable => write!(f, "Unavailable!"), + SpotifyError::SpotifyIdError => write!(f, "Invalid Spotify ID"), + SpotifyError::ChannelError => write!(f, "Channel Error"), + SpotifyError::AudioKeyError => write!(f, "Audio Key Error"), + SpotifyError::LameConverterError(e) => write!(f, "Lame error: {}", e), + SpotifyError::JoinError => write!(f, "Tokio Join Error"), + SpotifyError::ASpotify(e) => write!(f, "Spotify Error: {}", e), + SpotifyError::Serde(e, l, c) => write!(f, "Serde Error @{}:{} {}", l, c, e), + SpotifyError::InvalidUri => write!(f, "Invalid URI"), + SpotifyError::ParseError(e) => write!(f, "Parse Error: {}", e), + SpotifyError::ID3Error(k, e) => write!(f, "ID3 Error: {} {}", k, e), + SpotifyError::Reqwest(e) => write!(f, "Reqwest Error: {}", e), + SpotifyError::InvalidFormat => write!(f, "Invalid Format!"), + } + } +} +impl From for SpotifyError { + fn from(e: std::io::Error) -> Self { + Self::IoError(e.kind(), e.to_string()) + } +} +impl From> for SpotifyError { + fn from(e: Box) -> Self { + Self::Error(e.to_string()) + } +} + +impl From for SpotifyError { + fn from(_: librespot::core::mercury::MercuryError) -> Self { + Self::MercuryError + } +} + +impl From for SpotifyError { + fn from(e: librespot::core::session::SessionError) -> Self { + match e { + librespot::core::session::SessionError::IoError(e) => e.into(), + librespot::core::session::SessionError::AuthenticationError(_) => { + SpotifyError::AuthenticationError + } + } + } +} + +impl From for SpotifyError { + fn from(_: librespot::core::spotify_id::SpotifyIdError) -> Self { + Self::SpotifyIdError + } +} + +impl From for SpotifyError { + fn from(_: librespot::core::channel::ChannelError) -> Self { + Self::ChannelError + } +} + +impl From for SpotifyError { + fn from(_: librespot::core::audio_key::AudioKeyError) -> Self { + Self::AudioKeyError + } +} + +impl From for SpotifyError { + fn from(_: tokio::task::JoinError) -> Self { + Self::JoinError + } +} + +impl From for SpotifyError { + fn from(e: aspotify::Error) -> Self { + Self::ASpotify(e.to_string()) + } +} + +impl From for SpotifyError { + fn from(e: serde_json::Error) -> Self { + Self::Serde(e.to_string(), e.line(), e.column()) + } +} + +impl From for SpotifyError { + fn from(e: url::ParseError) -> Self { + Self::ParseError(e) + } +} + +impl From for SpotifyError { + fn from(e: id3::Error) -> Self { + Self::ID3Error(e.kind.to_string(), e.description.to_string()) + } +} + +impl From for SpotifyError { + fn from(e: reqwest::Error) -> Self { + Self::Reqwest(e.to_string()) + } +} + +impl From for SpotifyError { + fn from(e: lewton::VorbisError) -> Self { + SpotifyError::Error(format!("Lewton: {}", e)) + } +} diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..d821ad7 --- /dev/null +++ b/src/main.rs @@ -0,0 +1,161 @@ +#[macro_use] +extern crate log; + +mod converter; +mod downloader; +mod error; +mod settings; +mod spotify; +mod tag; + +use async_std::{task, task::block_on}; +use colored::Colorize; +use downloader::{DownloadState, Downloader}; +use settings::Settings; +use spotify::Spotify; +use std::{ + env, + ffi::OsStr, + path::Path, + time::{Duration, Instant}, +}; + +fn main() { + block_on(start()); +} + +async fn start() { + let settings = match Settings::load().await { + Ok(settings) => { + println!( + "{} {}.", + "Settings successfully loaded. Continuing with spotify account:".green(), + settings.username + ); + settings + } + Err(_e) => { + println!( + "{} {}...", + "Settings could not be loaded, because of the following error:".red(), + _e + ); + let default_settings = + Settings::new("username", "password", "client_id", "secret").unwrap(); + match default_settings.save().await { + Ok(_) => { + println!( + "{}", + "..but default settings have been created successfully. Edit them and run the program again.".green() + ); + } + Err(_e) => { + println!( + "{} {}", + "..and default settings could not be written:".red(), + _e + ); + } + }; + return; + } + }; + + let args: Vec = env::args().collect(); + if args.len() > 1 { + let spotify = match Spotify::new( + &settings.username, + &settings.password, + &settings.client_id, + &settings.client_secret, + ) + .await + { + Ok(spotify) => { + println!("{}", "Login succeeded.".green()); + spotify + } + Err(_e) => { + println!( + "{} {}", + "Login failed, possibly due to invalid credentials or settings:".red(), + _e + ); + return; + } + }; + + let downloader = Downloader::new(settings.downloader, spotify); + + match downloader.add_uri(&args[1]).await { + Ok(_) => {} + Err(_e) => { + error!("{} {}", "Adding url failed:".red(), _e) + } + } + + let refresh = Duration::from_secs(settings.refresh_ui_seconds); + let now = Instant::now(); + let mut time_elapsed: u64; + + 'outer: loop { + print!("{esc}[2J{esc}[1;1H", esc = 27 as char); + let mut exit_flag: i8 = 1; + + for download in downloader.get_downloads().await { + let state = download.state; + + let progress: String; + + if state != DownloadState::Done { + exit_flag &= 0; + progress = match state { + DownloadState::Downloading(r, t) => { + let p = r as f32 / t as f32 * 100.0; + if p > 100.0 { + "100%".to_string() + } else { + format!("{}%", p as i8) + } + } + DownloadState::Post => "Postprocessing... ".to_string(), + DownloadState::None => "Preparing... ".to_string(), + DownloadState::Lock => "Holding... ".to_string(), + DownloadState::Error(e) => { + exit_flag |= 1; + format!("{} ", e) + }, + DownloadState::Done => { + exit_flag |= 1; + "Impossible state".to_string() + } + }; + } else { + progress = "Done.".to_string(); + } + + println!("{:<19}| {}", progress, download.title); + } + time_elapsed = now.elapsed().as_secs(); + if exit_flag == 1 { + break 'outer; + } + + println!("\nElapsed second(s): {}", time_elapsed); + task::sleep(refresh).await + } + println!("Finished download(s) in {} second(s).", time_elapsed); + } else { + println!( + "Usage:\n{} (track_url | album_url | playlist_url)", + env::args() + .next() + .as_ref() + .map(Path::new) + .and_then(Path::file_name) + .and_then(OsStr::to_str) + .map(String::from) + .unwrap() + ); + } +} diff --git a/src/settings.rs b/src/settings.rs new file mode 100644 index 0000000..6f08f3e --- /dev/null +++ b/src/settings.rs @@ -0,0 +1,62 @@ +use crate::downloader::DownloaderConfig; +use crate::downloader::Quality; +use crate::error::SpotifyError; +use serde::{Deserialize, Serialize}; + +use tokio::{ + fs::File, + io::{AsyncReadExt, AsyncWriteExt}, +}; + +// Structure for holding all the settings +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct Settings { + pub username: String, + pub password: String, + pub client_id: String, + pub client_secret: String, + pub refresh_ui_seconds: u64, + pub downloader: DownloaderConfig, +} +impl Settings { + // Create new instance + pub fn new( + username: &str, + password: &str, + client_id: &str, + client_secret: &str, + ) -> Option { + Some(Settings { + username: username.to_string(), + password: password.to_string(), + client_id: client_id.to_string(), + client_secret: client_secret.to_string(), + refresh_ui_seconds: 1, + downloader: DownloaderConfig { + concurrent_downloads: 4, + quality: Quality::Q320, + path: dirs::audio_dir().unwrap().join("downloads"), + filename_template: "%artist% - %title%".to_string(), + id3v24: true, + convert_to_mp3: false, + separator: ", ".to_string(), + }, + }) + } + + // Serialize the settings to a json file + pub async fn save(&self) -> Result<(), SpotifyError> { + let data = serde_json::to_string_pretty(self)?; + let mut file = File::create("settings.json").await?; + file.write_all(data.as_bytes()).await?; + Ok(()) + } + + // Deserialize the settings from a json file + pub async fn load() -> Result { + let mut file = File::open("settings.json").await?; + let mut buf = String::new(); + file.read_to_string(&mut buf).await?; + Ok(serde_json::from_str(&buf)?) + } +} diff --git a/src/spotify.rs b/src/spotify.rs new file mode 100644 index 0000000..ae13e0e --- /dev/null +++ b/src/spotify.rs @@ -0,0 +1,168 @@ +use aspotify::{ + Album, Client, ClientCredentials, Playlist, PlaylistItemType, Track, TrackSimplified, +}; +use librespot::core::authentication::Credentials; +use librespot::core::config::SessionConfig; +use librespot::core::session::Session; +use std::fmt; +use url::Url; + +use crate::error::SpotifyError; + +pub struct Spotify { + // librespotify sessopm + pub session: Session, + pub spotify: Client, +} + +impl Spotify { + /// Create new instance + pub async fn new( + username: &str, + password: &str, + client_id: &str, + client_secret: &str, + ) -> Result { + // librespot + let credentials = Credentials::with_password(username, password); + let session = Session::connect(SessionConfig::default(), credentials, None).await?; + //rspoitfy + let credentials = ClientCredentials { + id: client_id.to_string(), + secret: client_secret.to_string(), + }; + let spotify = Client::new(credentials); + + Ok(Spotify { session, spotify }) + } + + /// Parse URI or URL into URI + pub fn parse_uri(uri: &str) -> Result { + // Already URI + if uri.starts_with("spotify:") { + if uri.split(':').collect::>().len() < 3 { + return Err(SpotifyError::InvalidUri); + } + return Ok(uri.to_string()); + } + + // Parse URL + let url = Url::parse(uri)?; + // Spotify Web Player URL + if url.host_str() == Some("open.spotify.com") { + let path = url + .path_segments() + .ok_or(SpotifyError::Error("Missing URL path".into()))? + .collect::>(); + if path.len() < 2 { + return Err(SpotifyError::InvalidUri); + } + return Ok(format!("spotify:{}:{}", path[0], path[1])); + } + Err(SpotifyError::InvalidUri) + } + + /// Fetch data for URI + pub async fn resolve_uri(&self, uri: &str) -> Result { + let parts = uri.split(':').skip(1).collect::>(); + let id = parts[1]; + match parts[0] { + "track" => { + let track = self.spotify.tracks().get_track(id, None).await?; + Ok(SpotifyItem::Track(track.data)) + } + "playlist" => { + let playlist = self.spotify.playlists().get_playlist(id, None).await?; + Ok(SpotifyItem::Playlist(playlist.data)) + } + "album" => { + let album = self.spotify.albums().get_album(id, None).await?; + Ok(SpotifyItem::Album(album.data)) + } + // Unsupported / Unimplemented + _ => Ok(SpotifyItem::Other(uri.to_string())), + } + } + + /// Get all tracks from playlist + pub async fn full_playlist(&self, id: &str) -> Result, SpotifyError> { + let mut items = vec![]; + let mut offset = 0; + loop { + let page = self + .spotify + .playlists() + .get_playlists_items(id, 100, offset, None) + .await?; + items.append( + &mut page + .data + .items + .iter() + .filter_map(|i| { + if let Some(item) = &i.item { + if let PlaylistItemType::Track(t) = item { + Some(t.to_owned()) + } else { + None + } + } else { + None + } + }) + .collect(), + ); + + // End + offset += page.data.items.len(); + if page.data.total == offset { + return Ok(items); + } + } + } + + /// Get all tracks from album + pub async fn full_album(&self, id: &str) -> Result, SpotifyError> { + let mut items = vec![]; + let mut offset = 0; + loop { + let page = self + .spotify + .albums() + .get_album_tracks(id, 50, offset, None) + .await?; + items.append(&mut page.data.items.to_vec()); + + // End + offset += page.data.items.len(); + if page.data.total == offset { + return Ok(items); + } + } + } +} + +impl Clone for Spotify { + fn clone(&self) -> Self { + Self { + session: self.session.clone(), + spotify: Client::new(self.spotify.credentials.clone()), + } + } +} + +/// Basic debug implementation so can be used in other structs +impl fmt::Debug for Spotify { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "") + } +} + +#[derive(Debug, Clone)] +pub enum SpotifyItem { + Track(Track), + Album(Album), + Playlist(Playlist), + /// Unimplemented + Other(String), +} diff --git a/src/tag/id3.rs b/src/tag/id3.rs new file mode 100644 index 0000000..87edd27 --- /dev/null +++ b/src/tag/id3.rs @@ -0,0 +1,85 @@ +use chrono::{Datelike, NaiveDate}; +use id3::frame::{Picture, PictureType, Timestamp}; +use id3::{Tag, Version}; +use std::path::{Path, PathBuf}; + +use crate::error::SpotifyError; + +use super::Field; + +pub struct ID3Tag { + path: PathBuf, + tag: Tag, + separator: String, + version: Version, +} + +impl ID3Tag { + /// Load form path + pub fn open(path: impl AsRef) -> Result { + let tag = Tag::read_from_path(&path).unwrap_or_default(); + + Ok(ID3Tag { + path: path.as_ref().to_owned(), + tag, + separator: String::new(), + version: Version::Id3v23, + }) + } + + /// Wether to use ID3v2.4 + pub fn use_id3_v24(&mut self, v: bool) { + match v { + true => self.version = Version::Id3v24, + false => self.version = Version::Id3v23, + } + } +} + +impl super::Tag for ID3Tag { + fn set_separator(&mut self, separator: &str) { + self.separator = separator.to_string(); + } + + fn set_raw(&mut self, tag: &str, value: Vec) { + self.tag.set_text(tag, value.join(&self.separator)); + } + + fn set_field(&mut self, field: Field, value: Vec) { + let tag = match field { + Field::Title => "TIT2", + Field::Artist => "TPE1", + Field::Album => "TALB", + Field::TrackNumber => "TPOS", + Field::DiscNumber => "TRCK", + Field::Genre => "TCON", + Field::Label => "TPUB", + Field::AlbumArtist => "TPE2", + }; + self.set_raw(tag, value); + } + + fn save(&mut self) -> Result<(), SpotifyError> { + Ok(self.tag.write_to_path(&self.path, self.version)?) + } + + fn add_cover(&mut self, mime: &str, data: Vec) { + self.tag.add_picture(Picture { + mime_type: mime.to_owned(), + picture_type: PictureType::CoverFront, + description: "cover".to_string(), + data, + }); + } + + fn set_release_date(&mut self, date: NaiveDate) { + self.tag.set_date_recorded(Timestamp { + year: date.year(), + month: Some(date.month() as u8), + day: Some(date.day() as u8), + hour: None, + minute: None, + second: None, + }) + } +} diff --git a/src/tag/mod.rs b/src/tag/mod.rs new file mode 100644 index 0000000..929a4c1 --- /dev/null +++ b/src/tag/mod.rs @@ -0,0 +1,57 @@ +use chrono::NaiveDate; +use std::path::Path; + +use crate::downloader::AudioFormat; +use crate::error::SpotifyError; + +use self::id3::ID3Tag; +use ogg::OGGTag; + +mod id3; +mod ogg; + +pub enum TagWrap { + OGG(OGGTag), + ID3(ID3Tag), +} + +impl TagWrap { + /// Load from file + pub fn new(path: impl AsRef, format: AudioFormat) -> Result { + match format { + AudioFormat::OGG => Ok(TagWrap::OGG(OGGTag::open(path)?)), + AudioFormat::MP3 => Ok(TagWrap::ID3(ID3Tag::open(path)?)), + _ => Err(SpotifyError::Error("Invalid format!".into())), + } + } + + /// Get Tag trait + pub fn get_tag(&mut self) -> Box<&mut dyn Tag> { + match self { + TagWrap::OGG(tag) => Box::new(tag), + TagWrap::ID3(tag) => Box::new(tag), + } + } +} + +pub trait Tag { + // Set tag values separator + fn set_separator(&mut self, separator: &str); + fn set_raw(&mut self, tag: &str, value: Vec); + fn set_field(&mut self, field: Field, value: Vec); + fn set_release_date(&mut self, date: NaiveDate); + fn add_cover(&mut self, mime: &str, data: Vec); + fn save(&mut self) -> Result<(), SpotifyError>; +} + +#[derive(Debug, Clone)] +pub enum Field { + Title, + Artist, + Album, + TrackNumber, + DiscNumber, + AlbumArtist, + Genre, + Label, +} diff --git a/src/tag/ogg.rs b/src/tag/ogg.rs new file mode 100644 index 0000000..a0fa21e --- /dev/null +++ b/src/tag/ogg.rs @@ -0,0 +1,68 @@ +use chrono::{Datelike, NaiveDate}; +use oggvorbismeta::{read_comment_header, replace_comment_header, CommentHeader, VorbisComments}; +use std::fs::File; +use std::path::{Path, PathBuf}; + +use super::Field; +use crate::error::SpotifyError; + +pub struct OGGTag { + path: PathBuf, + tag: CommentHeader, +} + +impl OGGTag { + /// Load tag from file + pub fn open(path: impl AsRef) -> Result { + let mut file = File::open(&path)?; + let tag = read_comment_header(&mut file); + Ok(OGGTag { + path: path.as_ref().to_owned(), + tag, + }) + } +} + +impl super::Tag for OGGTag { + fn set_separator(&mut self, _separator: &str) {} + + fn set_field(&mut self, field: Field, value: Vec) { + let tag = match field { + Field::Title => "TITLE", + Field::Artist => "ARTIST", + Field::Album => "ALBUM", + Field::TrackNumber => "TRACKNUMBER", + Field::DiscNumber => "DISCNUMBER", + Field::Genre => "GENRE", + Field::Label => "LABEL", + Field::AlbumArtist => "ALBUMARTIST", + }; + self.set_raw(tag, value); + } + + fn add_cover(&mut self, _mime: &str, _data: Vec) { + error!("ALBUM ART IN OGG NOT SUPPORTED!"); + } + + fn set_raw(&mut self, tag: &str, value: Vec) { + self.tag.add_tag_multi( + tag, + &value.iter().map(|v| v.as_str()).collect::>(), + ); + } + + fn save(&mut self) -> Result<(), SpotifyError> { + let file = File::open(&self.path)?; + let mut out = replace_comment_header(file, self.tag.clone()); + let mut file = File::create(&self.path)?; + std::io::copy(&mut out, &mut file)?; + Ok(()) + } + + fn set_release_date(&mut self, date: NaiveDate) { + self.tag.add_tag_single( + "DATE", + &format!("{}-{:02}-{:02}", date.year(), date.month(), date.day()), + ) + } +}