18 files changed, 2298 insertions, 0 deletions
diff --git a/benoit-cli/COPYING b/benoit-cli/COPYING
new file mode 100644
index 0000000..f288702
--- /dev/null
+++ b/benoit-cli/COPYING
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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 <https://www.gnu.org/licenses/>.
+
+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:
+
+ <program> Copyright (C) <year> <name of author>
+ 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
+<https://www.gnu.org/licenses/>.
+
+ 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
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/benoit-cli/Cargo.toml b/benoit-cli/Cargo.toml
new file mode 100644
index 0000000..8c92f6c
--- /dev/null
+++ b/benoit-cli/Cargo.toml
@@ -0,0 +1,26 @@
+[package]
+name = "benoit-cli"
+edition = "2021"
+license = "GPL-3.0-or-later"
+
+version.workspace = true
+authors.workspace = true
+
+[features]
+notify = ["notify-rust"]
+
+[dependencies]
+benoit = { path = "../benoit" }
+
+ctrlc = "3.4.4"
+num-traits = "0.2.18"
+rug = "1.24.0"
+toml = "0.8.10"
+
+notify-rust = { version = "4.10.0", optional = true }
+
+[target.'cfg(windows)'.dependencies]
+windows = "0.54.0"
+
+[lints]
+workspace = true
diff --git a/benoit-cli/src/config/config/load.rs b/benoit-cli/src/config/config/load.rs
new file mode 100644
index 0000000..8ac0165
--- /dev/null
+++ b/benoit-cli/src/config/config/load.rs
@@ -0,0 +1,50 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::config::Config;
+use crate::error::Error;
+
+use std::env::args;
+
+impl Config {
+ /// Loads the configuration file as specified on the command line.
+ ///
+ /// # Errors
+ ///
+ /// Returns an error depending on the command line arguments and validity of the configuration file.
+ pub fn load() -> Result<Self, Error> {
+ let mut args = args().skip(0x1);
+
+ let Some(config_path) = args.next() else {
+ return Err(Error::MissingConfigPath);
+ };
+
+ if args.next().is_some() { return Err(Error::TooManyCliArguments) };
+
+ let config = Self::load_from(config_path)?;
+ config.validate()?;
+
+ Ok(config)
+ }
+}
diff --git a/benoit-cli/src/config/config/load_from.rs b/benoit-cli/src/config/config/load_from.rs
new file mode 100644
index 0000000..61ae5cd
--- /dev/null
+++ b/benoit-cli/src/config/config/load_from.rs
@@ -0,0 +1,89 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in (the) hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::config::{Config, Section, Take};
+use crate::error::Error;
+use crate::keyframe::Keyframe;
+
+use std::path::Path;
+
+macro_rules! take_field {
+ ($name:ident in ($section:expr)) => {{
+ $section.get_child(stringify!($name)).take()?
+ }};
+
+ ($name:ident in ($section:expr) str) => {{
+ $section.get_child(stringify!($name)).take_from_str()??
+ }};
+}
+
+impl Config {
+ /// Loads the configuration file at `path`.
+ ///
+ /// # Errors
+ ///
+ /// If the configuration file could not be read or parsed, an error message is returned.
+ pub fn load_from<P: AsRef<Path>>(path: P) -> Result<Self, Error> {
+ let root_section = Section::create_root(path)?;
+
+ let render_section: Section = root_section.get_child("render").take()?;
+ let final_section: Section = root_section.get_child("final").take()?;
+ let output_section: Section = root_section.get_child("output").take()?;
+
+ let render_start_section: Section = render_section.get_child("start").take()?;
+ let render_stop_section: Section = render_section.get_child("stop").take()?;
+
+ let render_width = take_field!(width in (render_section));
+ let render_height = take_field!(height in (render_section));
+
+ Ok(Self {
+ frame_count: take_field!(count in (render_section)),
+ render_size: (render_width, render_height),
+ fractal: take_field!(fractal in (render_section) str),
+ inverse: take_field!(inverse in (render_section)),
+ julia: take_field!(julia in (render_section)),
+
+ start: Keyframe {
+ frame: take_field!(frame in (render_start_section)),
+ max_iter_count: take_field!(max_iter_count in (render_start_section)),
+ centre: take_field!(centre in (render_start_section)),
+ seed: take_field!(seed in (render_start_section)),
+ zoom: take_field!(zoom in (render_start_section)),
+ colour_range: take_field!(colour_range in (render_start_section)),
+ },
+ stop: Keyframe {
+ frame: take_field!(frame in (render_stop_section)),
+ max_iter_count: take_field!(max_iter_count in (render_stop_section)),
+ centre: take_field!(centre in (render_stop_section)),
+ seed: take_field!(seed in (render_stop_section)),
+ zoom: take_field!(zoom in (render_stop_section)),
+ colour_range: take_field!(colour_range in (render_stop_section)),
+ },
+
+ palette: take_field!(palette in (final_section) str),
+
+ output_directory: take_field!(directory in (output_section)),
+ })
+ }
+}
diff --git a/benoit-cli/src/config/config/mod.rs b/benoit-cli/src/config/config/mod.rs
new file mode 100644
index 0000000..e10c25e
--- /dev/null
+++ b/benoit-cli/src/config/config/mod.rs
@@ -0,0 +1,124 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+mod load;
+mod load_from;
+mod print_help;
+
+use crate::error::Error;
+use crate::keyframe::Keyframe;
+
+use benoit::fractal::Fractal;
+use benoit::palette::Palette;
+use std::path::PathBuf;
+
+/// For configuring animations.
+///
+/// A configuration can be loaded from a file using [`load_from`](Config::load_from).
+///
+/// An example of a configuration is the following:
+///
+/// ```toml
+/// # This renders a single frame.
+///
+/// [render]
+/// count = 1
+/// width = 1024
+/// height = 1024
+///
+/// fractal = "mandelbrot" # multibrot2
+/// inverse = false
+/// julia = false
+///
+/// [render.start]
+/// frame = 0
+///
+/// max_iter_count = 0x100
+///
+/// centre = "0.0+0.0i"
+/// seed = "0.0+0.0i"
+/// zoom = "1.0"
+///
+/// colour_range = 64.0
+///
+/// [render.stop]
+/// frame = 0
+///
+/// max_iter_count = 0x100
+///
+/// centre = "0.0+0.0i"
+/// seed = "0.0+0.0i"
+/// zoom = "1.0"
+///
+/// colour_range = 64.0
+///
+/// [final]
+/// palette = "fire"
+///
+/// [output]
+/// directory = "render/"
+/// ```
+#[derive(Clone, Debug)]
+pub struct Config {
+ pub frame_count: u32,
+ pub render_size: (u32, u32),
+ pub fractal: Fractal,
+ pub inverse: bool,
+ pub julia: bool,
+
+ pub start: Keyframe,
+ pub stop: Keyframe,
+
+ pub palette: Palette,
+
+ pub output_directory: PathBuf,
+}
+
+impl Config {
+ /// Tries to validate `self`.
+ ///
+ /// # Errors
+ ///
+ /// If any configuration field couldn't be validated, an `Err` object is returned.
+ pub fn validate(&self) -> Result<(), Error> {
+ self.start.validate()?;
+ self.stop.validate()?;
+
+ if self.start.frame > self.stop.frame {
+ Err(
+ Error::InvalidConfig {
+ message: format!("start frame ({}) cannot be after stop frame ({})", self.start.frame, self.stop.frame),
+ },
+ )
+ } else if self.stop.frame >= self.frame_count {
+ Err(
+ Error::InvalidConfig {
+ message: format!("stop frame ({}) cannot be after last frame ({})", self.stop.frame, self.frame_count - 0x1),
+ },
+ )
+ } else {
+ Ok(())
+ }
+ }
+}
diff --git a/benoit-cli/src/config/config/print_help.rs b/benoit-cli/src/config/config/print_help.rs
new file mode 100644
index 0000000..b16d6f8
--- /dev/null
+++ b/benoit-cli/src/config/config/print_help.rs
@@ -0,0 +1,45 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::config::Config;
+
+use benoit::VERSION;
+use std::process::exit;
+
+impl Config {
+ /// Prints help to `stdout`.
+ ///
+ /// This function marks the end of execution and does therefore not return.
+ pub fn print_help() -> ! {
+ println!("Benoit {}.{}.{}", VERSION.0, VERSION.1, VERSION.2);
+ println!();
+ println!("Usage:");
+ println!(" benoit <path>");
+ println!();
+ println!("Wherein <path> denotes the path to the configuration file.");
+ println!();
+
+ exit(0x0);
+ }
+}
diff --git a/benoit-cli/src/config/field/mod.rs b/benoit-cli/src/config/field/mod.rs
new file mode 100644
index 0000000..489dc7a
--- /dev/null
+++ b/benoit-cli/src/config/field/mod.rs
@@ -0,0 +1,68 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::error::Error;
+
+use std::str::FromStr;
+use toml::Value;
+
+/// Denotes a configuration field.
+///
+/// By default, these fields are typeless.
+/// They can, however, be "transformed" to a given type using the [`Take`](crate::config::Take) trait.
+pub struct Field<'a> {
+ pub(in super) name: String,
+ pub(in super) value: Option<&'a Value>,
+}
+
+impl<'a> Field<'a> {
+ /// Borows the contained value.
+ ///
+ /// The returned reference is still considered "typeless," as is defined by `toml`'s own [`Value`] type.
+ ///
+ /// # Errors
+ ///
+ /// Returns an error if the field could not be found.
+ pub(in super) fn borrow_value(&mut self) -> Result<&'a Value, Error> {
+ self.value
+ .take()
+ .ok_or_else(|| Error::MissingConfigField { name: self.name.clone() })
+ }
+}
+
+impl Field<'_> {
+ /// Transforms the field into the given type `T`.
+ /// The result of [`FromStr`] implementation is passed on.
+ ///
+ /// # Errors
+ ///
+ /// Returns an error if the field doesn't exist, or is a different type, or if the [`FromStr`] implementation failed.
+ pub fn take_from_str<T: FromStr>(mut self) -> Result<Result<T, <T as FromStr>::Err>, Error> {
+ let Value::String(ref s) = *self.borrow_value()? else {
+ return Err(Error::WrongFieldType { name: self.name, ok_type: "string" })
+ };
+
+ Ok(FromStr::from_str(s))
+ }
+}
diff --git a/benoit-cli/src/config/mod.rs b/benoit-cli/src/config/mod.rs
new file mode 100644
index 0000000..aeba3b4
--- /dev/null
+++ b/benoit-cli/src/config/mod.rs
@@ -0,0 +1,31 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+//! Animation configuration.
+
+use crate::use_mod;
+use_mod!(pub, config);
+use_mod!(pub, field);
+use_mod!(pub, section);
+use_mod!(pub, take);
diff --git a/benoit-cli/src/config/section/mod.rs b/benoit-cli/src/config/section/mod.rs
new file mode 100644
index 0000000..59d716a
--- /dev/null
+++ b/benoit-cli/src/config/section/mod.rs
@@ -0,0 +1,86 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::config::Field;
+use crate::error::Error;
+
+use std::borrow::Cow;
+use std::fs::read_to_string;
+use std::path::Path;
+use std::str::FromStr;
+use toml::Table;
+
+/// Denotes a configuration section.
+pub struct Section<'a> {
+ pub(in super) name: Option<String>,
+ pub(in super) table: Cow<'a, Table>,
+}
+
+impl<'a> Section<'a> {
+ /// Creates a new root section.
+ ///
+ /// This is done by parsing the configuration file at `path`.
+ ///
+ /// # Errors
+ ///
+ /// Returns an error if unable to read and parse the configuration file.
+ pub fn create_root<P: AsRef<Path>>(path: P) -> Result<Self, Error> {
+ let path = path.as_ref();
+
+ let config = read_to_string(path)
+ .map_err(|e| Error::ConfigReadFailure { path: path.to_owned(), source: e })?;
+
+ let table = Table::from_str(&config)
+ .map_err(|e| Error::ConfigParseFailure { path: path.to_owned(), source: e })?;
+
+ Ok(Self {
+ name: None,
+ table: Cow::Owned(table)
+ })
+ }
+
+ /// Searches the section's table for children.
+ ///
+ /// The returned child will reference its parent section.
+ ///
+ /// The child isn't guaranteed to exist, and in the event that it does, is typeless.
+ /// See the [`Field`] type for more information.
+ #[must_use]
+ pub fn get_child(&'a self, name: &str) -> Field<'a> {
+ let value = self.table.get(name);
+
+ let name = self.name
+ .as_ref()
+ .map_or_else(
+ || name.to_owned(),
+
+ |parent| format!("{parent}.{name}"),
+ );
+
+ Field {
+ name,
+ value,
+ }
+ }
+}
diff --git a/benoit-cli/src/config/take/mod.rs b/benoit-cli/src/config/take/mod.rs
new file mode 100644
index 0000000..4580e5b
--- /dev/null
+++ b/benoit-cli/src/config/take/mod.rs
@@ -0,0 +1,282 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::config::{Field, Section};
+use crate::error::Error;
+
+use benoit::PRECISION;
+use benoit::complex::Complex;
+use rug::Float;
+use std::borrow::Cow;
+use std::fs::canonicalize;
+use std::path::PathBuf;
+use std::str::FromStr;
+use toml::Value;
+
+/// Used for loading configuration fields.
+///
+/// More specifically, this is to be used with the untyped [`Field`] type, where using [`take`](Take::take) collapses the field into a definitively typed object.
+pub trait Take<T> {
+ /// Collapses the field into the given type `T`.
+ ///
+ /// # Errors
+ ///
+ /// Returns an error if the field doesn't exist or is a different type.
+
+ fn take(self) -> Result<T, Error>;
+}
+
+fn test_field_domain<T, U>(name: &str, value: &T, min: U, max: U) -> Result<(), Error>
+where
+ T: PartialOrd + ToString,
+ U: Copy + Into<T> + ToString, {
+ if *value < min.into() {
+ Err(Error::FieldLowerBounds {
+ name: name.to_owned(),
+ value: value.to_string(),
+ limit: min.to_string(),
+ })
+ } else if *value > max.into() {
+ Err(Error::FieldUpperBounds {
+ name: name.to_owned(),
+ value: value.to_string(),
+ limit: max.to_string(),
+ })
+ } else {
+ Ok(())
+ }
+}
+
+impl Take<bool> for Field<'_> {
+ fn take(mut self) -> Result<bool, Error> {
+ let Value::Boolean(value) = *self.borrow_value()? else {
+ return Err(Error::WrongFieldType { name: self.name, ok_type: "bool" });
+ };
+
+ Ok(value)
+ }
+}
+
+impl Take<Complex> for Field<'_> {
+ fn take(mut self) -> Result<Complex, Error> {
+ let s = if let Value::String(ref s) = *self.borrow_value()? {
+ Ok(s)
+ } else {
+ Err(Error::WrongFieldType { name: self.name, ok_type: "complex" })
+ }?;
+
+ FromStr::from_str(s).map_err(Into::into)
+ }
+}
+
+impl Take<f32> for Field<'_> {
+ fn take(mut self) -> Result<f32, Error> {
+ if let Value::Float(value) = *self.borrow_value()? {
+ // Is this even possible?
+ if value.is_nan() {
+ return Err(Error::NonNumberField { name: self.name });
+ }
+
+ if value.is_infinite() {
+ return Err(Error::InfiniteField { name: self.name });
+ }
+
+ test_field_domain(&self.name, &value, -f32::MAX, f32::MAX)?;
+
+ Ok(value as f32)
+ } else {
+ Err(Error::WrongFieldType { name: self.name, ok_type: "float" })
+ }
+ }
+}
+
+impl Take<f64> for Field<'_> {
+ fn take(mut self) -> Result<f64, Error> {
+ if let Value::Float(value) = *self.borrow_value()? {
+ // Is this even possible?
+ if value.is_nan() {
+ return Err(Error::NonNumberField { name: self.name });
+ }
+
+ if value.is_infinite() {
+ return Err(Error::InfiniteField { name: self.name });
+ }
+
+ Ok(value)
+ } else {
+ Err(Error::WrongFieldType { name: self.name, ok_type: "float" })
+ }
+ }
+}
+
+impl Take<Float> for Field<'_> {
+ fn take(mut self) -> Result<Float, Error> {
+ if let Value::String(ref value) = *self.borrow_value()? {
+ if let Ok(value) = Float::parse(value) {
+ return Ok(Float::with_val(PRECISION, value));
+ }
+ }
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "bigfloat" })
+ }
+}
+
+impl Take<i16> for Field<'_> {
+ fn take(mut self) -> Result<i16, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ test_field_domain(&self.name, &value, i16::MIN, i16::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<i32> for Field<'_> {
+ fn take(mut self) -> Result<i32, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ test_field_domain(&self.name, &value, i32::MIN, i32::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<i64> for Field<'_> {
+ fn take(mut self) -> Result<i64, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ return Ok(value);
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<i8> for Field<'_> {
+ fn take(mut self) -> Result<i8, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ test_field_domain(&self.name, &value, i8::MIN, i8::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<PathBuf> for Field<'_> {
+ fn take(self) -> Result<PathBuf, Error> {
+ let s = <Self as Take<String>>::take(self)?;
+
+ canonicalize(&s).map_err(|e| Error::InvalidPath { path: s, source: e })
+ }
+}
+
+impl<'a> Take<Section<'a>> for Field<'a> {
+ fn take(mut self) -> Result<Section<'a>, Error> {
+ if let Value::Table(ref table) = *self.borrow_value()? {
+ return Ok(Section {
+ name: Some(self.name),
+ table: Cow::Borrowed(table),
+ });
+ }
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "section" })
+ }
+}
+
+impl Take<String> for Field<'_> {
+ fn take(mut self) -> Result<String, Error> {
+ if let Value::String(ref s) = *self.borrow_value()? {
+ Ok(s.to_owned())
+ } else {
+ Err(Error::WrongFieldType { name: self.name, ok_type: "string" })
+ }
+ }
+}
+
+impl Take<u16> for Field<'_> {
+ fn take(mut self) -> Result<u16, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ if value.is_negative() {
+ return Err(Error::NegativeField { name: self.name });
+ }
+
+ test_field_domain(&self.name, &value, u16::MIN, u16::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<u32> for Field<'_> {
+ fn take(mut self) -> Result<u32, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ if value.is_negative() {
+ return Err(Error::NegativeField { name: self.name });
+ }
+
+ test_field_domain(&self.name, &value, u32::MIN, u32::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<u64> for Field<'_> {
+ fn take(mut self) -> Result<u64, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ if value.is_negative() {
+ return Err(Error::NegativeField { name: self.name })
+ }
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<u8> for Field<'_> {
+ fn take(mut self) -> Result<u8, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ if value.is_negative() {
+ return Err(Error::NegativeField { name: self.name });
+ }
+
+ test_field_domain(&self.name, &value, u8::MIN, u8::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
diff --git a/benoit-cli/src/error/mod.rs b/benoit-cli/src/error/mod.rs
new file mode 100644
index 0000000..32a9f40
--- /dev/null
+++ b/benoit-cli/src/error/mod.rs
@@ -0,0 +1,159 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit.
+
+ benoit is free software: you can redistribute it
+ and/or modify it under the terms of the GNU Af-
+ fero General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit 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
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Af-
+ fero General Public License along with benoit.
+ If not, see <https://www.gnu.org/licenses/>.
+*/
+
+use benoit::error::Error as LibError;
+use std::error::Error as StdError;
+use std::fmt::{Display, Formatter, Result as FmtResult};
+use std::io::Error as IoError;
+use std::path::PathBuf;
+use toml::de::Error as TomlError;
+
+/// Denotes an error.
+#[derive(Debug)]
+pub enum Error {
+ BenoitError { source: LibError },
+
+ ConfigParseFailure { path: PathBuf, source: TomlError },
+
+ ConfigReadFailure { path: PathBuf, source: IoError },
+
+ InvalidConfig { message: String },
+
+ InvalidKeyframe { message: String },
+
+ InvalidPath { path: String, source: IoError },
+
+ FieldLowerBounds { name: String, value: String, limit: String },
+
+ FieldUpperBounds { name: String, value: String, limit: String },
+
+ InfiniteField { name: String },
+
+ MissingConfigField { name: String },
+
+ MissingConfigPath,
+
+ NegativeField { name: String },
+
+ NonNumberField { name: String },
+
+ TooManyCliArguments,
+
+ WrongFieldType { name: String, ok_type: &'static str },
+}
+
+impl Display for Error {
+ fn fmt(&self, f: &mut Formatter) -> FmtResult {
+ #[allow(clippy::enum_glob_use)]
+ use Error::*;
+
+ match *self {
+ BenoitError { ref source } => {
+ write!(f, "{source}")
+ },
+
+ ConfigParseFailure { ref path, ref source } => {
+ write!(f, "unable to parse configuration at \"{}\": \"{source}\"", path.display())
+ }
+
+ ConfigReadFailure { ref path, ref source } => {
+ write!(f, "unable to read configuration at \"{}\": \"{source}\"", path.display())
+ },
+
+ FieldLowerBounds { ref name, ref value, ref limit } => {
+ write!(f, "field `{name}` cannot be less than ({limit}) but was ({value})")
+ },
+
+ FieldUpperBounds { ref name, ref value, ref limit } => {
+ write!(f, "field `{name}` cannot be greater than ({limit}) but was ({value})")
+ },
+
+ InfiniteField { ref name } => {
+ write!(f, "field `{name}` must be finite (was infinite)")
+ },
+
+ InvalidConfig { ref message } => {
+ write!(f, "invalid configuration: {message}")
+ },
+
+ InvalidKeyframe { ref message } => {
+ write!(f, "invalid keyframe: {message}")
+ },
+
+ InvalidPath { ref path, ref source } => {
+ write!(f, "invalid path \"{path}\": \"{source}\"")
+ },
+
+ MissingConfigField { ref name } => {
+ write!(f, "missing configuration field `{name}`")
+ },
+
+ MissingConfigPath => {
+ write!(f, "missing configuration path")
+ },
+
+ NegativeField { ref name } => {
+ write!(f, "field `{name}` cannot be negative")
+ },
+
+ NonNumberField { ref name } => {
+ write!(f, "field `{name}` must be a number (was NaN)")
+ },
+
+ TooManyCliArguments => {
+ write!(f, "too many arguments provided on the command line")
+ },
+
+ WrongFieldType { ref name, ok_type } => {
+ write!(f, "type of field `{name} should'be been `{ok_type}`")
+ },
+ }
+ }
+}
+
+impl From<LibError> for Error {
+ fn from(value: LibError) -> Self {
+ Self::BenoitError { source: value }
+ }
+}
+
+impl StdError for Error {
+ fn source(&self) -> Option<&(dyn StdError + 'static)> {
+ #[allow(clippy::enum_glob_use)]
+ use Error::*;
+
+ #[allow(clippy::match_same_arms, clippy::wildcard_enum_match_arm)]
+ match *self {
+ BenoitError { ref source } => Some(source),
+
+ ConfigParseFailure { ref source, .. } => Some(source),
+
+ ConfigReadFailure { ref source, .. } => Some(source),
+
+ InvalidPath { ref source, .. } => Some(source),
+
+ _ => None,
+ }
+ }
+}
diff --git a/benoit-cli/src/instance/mod.rs b/benoit-cli/src/instance/mod.rs
new file mode 100644
index 0000000..26f67a0
--- /dev/null
+++ b/benoit-cli/src/instance/mod.rs
@@ -0,0 +1,48 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+//! Runtime.
+
+mod run;
+
+use rug::float::{free_cache, FreeCache};
+
+/// Denotes a programme instance.
+///
+/// In theory, due to Rust's safety, any ammount of instances can be created at any time... disregarding hardware constraints, of course.
+///
+/// The choice of creating this structure in the first place is a personal one.
+/// I can be argued, however, that some things should be leveraged using [`Drop`].
+pub struct Instance;
+
+impl Default for Instance {
+ #[inline(always)]
+ fn default() -> Self { Self }
+}
+
+impl Drop for Instance {
+ fn drop(&mut self) {
+ free_cache(FreeCache::All);
+ }
+}
diff --git a/benoit-cli/src/instance/run.rs b/benoit-cli/src/instance/run.rs
new file mode 100644
index 0000000..8ba86ab
--- /dev/null
+++ b/benoit-cli/src/instance/run.rs
@@ -0,0 +1,138 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::set_title;
+use crate::error::Error;
+use crate::instance::Instance;
+use crate::config::Config;
+use crate::keyframe::Keyframe;
+
+use benoit::log;
+use benoit::render::{Render, RenderConfig};
+use benoit::stopwatch::Stopwatch;
+use std::path::Path;
+
+#[cfg(feature = "notify")]
+use notify_rust::{Notification, Timeout};
+
+impl Instance {
+ /// Consumes the programme instance and starts execution.
+ ///
+ /// # Errors
+ ///
+ /// Returns any error that occurs during executiom, if any at all.
+ ///
+ /// This does not include panics, which are *not* handled by us (at the moment).
+
+ #[allow(clippy::unused_self)]
+ pub fn run(self, config: &Config) -> Result<(), Error> {
+ let mut render = Render::new(config.render_size.0, config.render_size.1)?;
+
+ let mut dump_frame = |keyframe: &Keyframe, path: &Path| -> Result<(), Error> {
+ let render_config = RenderConfig {
+ fractal: config.fractal.clone(),
+ inverse: config.inverse,
+ julia: config.julia,
+
+ max_iter_count: keyframe.max_iter_count,
+ centre: keyframe.centre.clone(),
+ seed: keyframe.seed.clone(),
+ zoom: keyframe.zoom.clone(),
+ };
+
+ run_job("render", || render.generate(&render_config));
+ run_job("paint", || render.plot(config.palette, keyframe.colour_range))?;
+ run_job("dump", || render.dump_image(path))?;
+
+ Ok(())
+ };
+
+ let mut global_timer = Stopwatch::from_now();
+
+ for keyframe in config.start.interpolate_between(&config.stop, config.frame_count) {
+ log!(value, keyframe);
+
+ let path = {
+ let mut path = config.output_directory.clone();
+ path.push(format!("frame{:010}.png", keyframe.frame));
+
+ path
+ };
+
+ eprint!("\u{001B}[1m");
+ eprintln!("frame no. {:.>10} \u{2510}", keyframe.frame);
+ eprintln!(" of {:.>10} total \u{2534}> \"{}\"", config.stop.frame, path.display());
+ eprint!("\u{001B}[22m");
+
+ let frame_timer = Stopwatch::test_result(|| dump_frame(&keyframe, &path))?;
+ global_timer.note();
+
+ eprintln!(" = \u{001B}[4m{frame_timer}\u{001B}[24m\u{001B}[2m ({global_timer} total)\u{001B}[22m");
+ eprintln!();
+ }
+
+ global_timer.note();
+
+ eprintln!("\u{001B}[1manimation completed\u{001B}[22m - took {global_timer} in total");
+ set_title!("done");
+
+ #[cfg(feature = "notify")]
+ {
+ // We don't really care if the notification fails.
+ let _ = Notification::new()
+ .appname("Benoit")
+ .summary("\u{2728} Animation completed! \u{2728}")
+ .body(&format!("Took {global_timer}."))
+ .icon("benoit")
+ .timeout(Timeout::Never)
+ .show();
+ }
+
+ Ok(())
+ }
+}
+
+pub fn run_job<F: FnOnce() -> Output, Output>(name: &str, func: F) -> Output {
+ eprint!("\u{2610} running job `{name}` ...");
+ set_title!("{name}");
+
+ let (timer, result) = Stopwatch::test(func);
+
+ // Indent to the 40th column; two have already been
+ // used for the bullet:
+ eprintln!("\r\u{2612} \u{001B}[2m{: <38}\u{001B}[22m\u{001B}[1m+ {timer}\u{001B}[22m", format!("completed job `{name}`"));
+
+ result
+}
+
+//
+// ## ##
+// # # #
+// # #
+// # #
+// # #
+// # #
+// # #
+// #
+//
diff --git a/benoit-cli/src/keyframe/keyframe/interpolate_between.rs b/benoit-cli/src/keyframe/keyframe/interpolate_between.rs
new file mode 100644
index 0000000..42e8c3e
--- /dev/null
+++ b/benoit-cli/src/keyframe/keyframe/interpolate_between.rs
@@ -0,0 +1,165 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::keyframe::{Keyframe, KeyframeInterpolater};
+
+use benoit::{log, PRECISION};
+use benoit::complex::Complex;
+use num_traits::Num;
+use rug::Float;
+use rug::ops::PowAssign;
+
+impl Keyframe {
+ /// Interpolates between `self` and the given other keyframe.
+ ///
+ /// The returned interpolater can be used as an iterator.
+ ///
+ /// The way in which the values are interpolated differ:
+ /// The centre, seed, and colour range values are interpreted as linear functions of the form (*a* &middot; *b* + *c*).
+ /// The zoom value, however, is interpreted as a growth function of the form (*a*<sup>*x*</sup> &middot; *b*).
+ ///
+ /// # Panics
+ ///
+ /// Panics if frame indices don't match.
+
+ #[must_use]
+ pub fn interpolate_between(&self, other: &Self, frame_count: u32) -> KeyframeInterpolater {
+ assert!(self.frame <= other.frame, "starting frame ({}) is after stopping frame ({})", self.frame, other.frame);
+ assert!(other.frame < frame_count, "stopping frame ({}) is after last frame ({})", other.frame, frame_count - 0x1);
+
+ let first_possible_frame = 0x0;
+ let last_possible_frame = frame_count - 0x1;
+
+ let max_iter_count_step = linear_step(
+ (first_possible_frame, i64::try_from(self.max_iter_count).unwrap()),
+ (last_possible_frame, i64::try_from(other.max_iter_count).unwrap()),
+ );
+
+ let centre_step = linear_step_complex( (first_possible_frame, &self.centre), (last_possible_frame, &other.centre));
+ let seed_step = linear_step_complex( (first_possible_frame, &self.seed), (last_possible_frame, &other.seed));
+ let zoom_factor = growth_factor_bigfloat((first_possible_frame, &self.zoom), (last_possible_frame, &other.zoom));
+ let colour_range_step = linear_step( (first_possible_frame, self.colour_range), (last_possible_frame, other.colour_range));
+
+ let mut interpolator = KeyframeInterpolater {
+ frame: Some(self.frame),
+ last_frame: other.frame,
+
+ max_iter_count: self.max_iter_count,
+ centre: self.centre.clone(),
+ seed: self.seed.clone(),
+ zoom: self.zoom.clone(),
+ colour_range: self.colour_range,
+
+ max_iter_count_step,
+ centre_step,
+ seed_step,
+ zoom_factor,
+ colour_range_step,
+ };
+
+ // Skip to the starting frame:
+ for _ in 0x0..self.frame {
+ interpolator.advance_values();
+ }
+
+ log!(value, interpolator);
+ interpolator
+ }
+}
+
+#[must_use]
+fn linear_step<T: Default + From<u32> + Num>((t0, f0): (u32, T), (t1, f1): (u32, T)) -> T {
+ if t1 == t0 || f1 == f0 { return Default::default() }
+
+ // A linear function `f` of time `t` can be defined
+ // as:
+ //
+ // f(t) = at+b
+ //
+ // The starting value `b` is already known. We use
+ // the following expression to get the slope coef-
+ // ficient `a`:
+ //
+ // a = (t1-t0)/(t1-t0)
+ //
+ // wherein f1 and f0 are the last and first results
+ // of `f` - respectively - and t1 and t0 are like-
+ // wise the last and first timepoints.
+
+ (f1 - f0) / (T::from(t1) - T::from(t0))
+}
+
+#[must_use]
+fn linear_step_bigfloat((t0, f0): (u32, &Float), (t1, f1): (u32, &Float)) -> Float {
+ if t1 == t0 || f1 == f0 { return Float::new(PRECISION) }
+
+ let denominator = f64::from(t1) - f64::from(t0);
+
+ let numerator = Float::with_val(PRECISION, f1 - f0);
+ numerator / denominator
+}
+
+#[must_use]
+fn linear_step_complex((t0, f0): (u32, &Complex), (t1, f1): (u32, &Complex)) -> Complex {
+ let real_step = linear_step_bigfloat((t0, &f0.real), (t1, &f1.real));
+ let imag_step = linear_step_bigfloat((t0, &f0.imag), (t1, &f1.imag));
+
+ Complex { real: real_step, imag: imag_step }
+}
+
+#[must_use]
+fn growth_factor_bigfloat((t0, f0): (u32, &Float), (t1, f1): (u32, &Float)) -> Float {
+ if t1 == t0 || f1 == f0 { return Float::with_val(PRECISION, 0x1) }
+
+ // The growth function `f` of time `t` is:
+ //
+ // f(t) = b*a^t
+ //
+ // wherein `b` is the starting value and `a` is the
+ // growth factor.
+ //
+ // To isolate `a` we use:
+ //
+ // a = nroot(t1-t0,f1/f0)
+ //
+ // wherein `t0`, `t1`, `f1`, and `f0` are the first
+ // and last values on the two dimensions (`t` and
+ // `f`), altough in theory arbitrary.
+ //
+ // Because the following is true:
+ //
+ // nroot(n,m) = m^(1/n)
+ //
+ // the expression for `a` is simplified for use
+ // with Rug:
+ //
+ // a = (t1/t0)^(1/(f1-f0))
+
+ let exponent = 1.0 / (f64::from(t1) - f64::from(t0));
+
+ let mut factor = Float::with_val(PRECISION, f1 / f0);
+ factor.pow_assign(exponent);
+
+ factor
+}
diff --git a/benoit-cli/src/keyframe/keyframe/mod.rs b/benoit-cli/src/keyframe/keyframe/mod.rs
new file mode 100644
index 0000000..9a4e84a
--- /dev/null
+++ b/benoit-cli/src/keyframe/keyframe/mod.rs
@@ -0,0 +1,99 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+mod interpolate_between;
+
+use crate::error::Error;
+
+use benoit::PRECISION;
+use benoit::complex::Complex;
+use rug::Float;
+
+/// Defines a single keyframe for animating.
+///
+/// Keyframes can be interpolated using the [`interpolate_between`](Keyframe::interpolate_between) method.
+#[derive(Clone, Debug)]
+pub struct Keyframe {
+ pub frame: u32,
+ pub max_iter_count: u64,
+ pub centre: Complex,
+ pub seed: Complex,
+ pub zoom: Float,
+ pub colour_range: f64,
+}
+
+impl Keyframe {
+ /// Validates `self`, wrapping it in a [`Result`].
+ ///
+ /// The following requirements must be upheld:
+ ///
+ /// * The maximum iteration count must be non-zero and less than or equal to `9223372036854775807`;
+ /// * The zoom value must be positive and non-zero;
+ /// * The colour range must be positive and non-zero;
+ ///
+ /// If these are upheld, an [`Ok`] object is returned.
+ ///
+ /// Do note that an "invalid" keyframe does not inherintly result in undefined behaviour if used.
+ ///
+ /// # Errors
+ ///
+ /// Yields an error if the keyframe could not be validated.
+ pub fn validate(&self) -> Result<(), Error> {
+ macro_rules! test {
+ ($assertion:expr, $($message:tt)*) => {{
+ if !($assertion as bool) {
+ return Err(Error::InvalidKeyframe { message: format!($($message)?) })
+ }
+ }};
+ }
+
+ test!(self.max_iter_count != 0x0, "max. iter. count ({}) cannot be zero", self.max_iter_count);
+
+ // This is also tested by Config, but we don't know
+ // if this keyframe even came from a configuration.
+ test!(
+ self.max_iter_count <= u64::try_from(i64::MAX).unwrap(),
+ "max. iter. count ({}) cannot be greater than ({})",
+ self.max_iter_count,
+ i64::MAX,
+ );
+
+ test!(self.zoom > 0x0, "zoom ({}) must be greater than zero", self.zoom);
+
+ test!(self.colour_range > 0.0, "colour range ({}) must be positive and non-zero", self.colour_range);
+
+ Ok(())
+ }
+}
+
+impl Default for Keyframe {
+ fn default() -> Self { Self {
+ frame: 0x0,
+ max_iter_count: 0x100,
+ centre: Complex::new(PRECISION),
+ seed: Complex::new(PRECISION),
+ zoom: Float::with_val(PRECISION, 0x1),
+ colour_range: 256.0,
+ } }
+}
diff --git a/benoit-cli/src/keyframe/keyframe_interpolater/mod.rs b/benoit-cli/src/keyframe/keyframe_interpolater/mod.rs
new file mode 100644
index 0000000..3faa546
--- /dev/null
+++ b/benoit-cli/src/keyframe/keyframe_interpolater/mod.rs
@@ -0,0 +1,95 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::keyframe::Keyframe;
+
+use benoit::complex::Complex;
+use rug::Float;
+
+/// Interpolater between keyframes.
+///
+/// This is done as an iterator over the interpolated values.
+#[derive(Clone, Debug)]
+pub struct KeyframeInterpolater {
+ pub(in super) frame: Option<u32>,
+ pub(in super) last_frame: u32,
+
+ pub(in super) max_iter_count: u64,
+ pub(in super) centre: Complex,
+ pub(in super) seed: Complex,
+ pub(in super) zoom: Float,
+ pub(in super) colour_range: f64,
+
+ pub(in super) max_iter_count_step: i64,
+ pub(in super) centre_step: Complex,
+ pub(in super) seed_step: Complex,
+ pub(in super) zoom_factor: Float,
+ pub(in super) colour_range_step: f64,
+}
+
+impl KeyframeInterpolater {
+ /// Advances the contained values to the next step.
+ ///
+ /// # Panics
+ ///
+ /// Panics if overflow occurs when calculating the new maximum iteration count.
+ /// This is guaranteed to not happen as long as the iterator hasn't been completed.
+ pub(in super) fn advance_values(&mut self) {
+ self.max_iter_count = self.max_iter_count
+ .checked_add_signed(self.max_iter_count_step)
+ .unwrap();
+
+ self.centre.real += &self.centre_step.real;
+ self.centre.imag += &self.centre_step.imag;
+ self.seed.real += &self.seed_step.real;
+ self.seed.imag += &self.seed_step.imag;
+ self.zoom *= &self.zoom_factor;
+ self.colour_range += self.colour_range_step;
+ }
+}
+
+impl Iterator for KeyframeInterpolater {
+ type Item = Keyframe;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ let frame = self.frame?;
+ assert!(frame <= self.last_frame);
+
+ let keyframe = Keyframe {
+ frame,
+ max_iter_count: self.max_iter_count,
+ centre: self.centre.clone(),
+ seed: self.seed.clone(),
+ zoom: self.zoom.clone(),
+ colour_range: self.colour_range,
+ };
+
+ self.frame = (frame != self.last_frame).then(|| {
+ self.advance_values();
+ frame + 0x1
+ });
+
+ Some(keyframe)
+ }
+}
diff --git a/benoit-cli/src/keyframe/mod.rs b/benoit-cli/src/keyframe/mod.rs
new file mode 100644
index 0000000..a4c722a
--- /dev/null
+++ b/benoit-cli/src/keyframe/mod.rs
@@ -0,0 +1,29 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+//! Animation keyframes.
+
+use crate::use_mod;
+use_mod!(pub, keyframe);
+use_mod!(pub, keyframe_interpolater);
diff --git a/benoit-cli/src/main.rs b/benoit-cli/src/main.rs
new file mode 100644
index 0000000..03494bd
--- /dev/null
+++ b/benoit-cli/src/main.rs
@@ -0,0 +1,90 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute 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 ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out 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 Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+macro_rules! use_mod {
+ ($visibility:vis, $name:ident) => {
+ mod $name;
+ $visibility use $name::*;
+ };
+}
+pub(in crate) use use_mod;
+
+pub mod config;
+pub mod error;
+pub mod instance;
+pub mod keyframe;
+
+use benoit::log;
+
+#[cfg(windows)]
+use windows::Win32::System::Console::SetConsoleTitleA;
+
+/// Execute according to the build mode.
+///
+/// Use this as a shorthand for testing `debug_assertions`.
+#[macro_export]
+macro_rules! debug {
+ ($($body:stmt)*) => { if cfg!(debug_assertions) { $($body)? } };
+}
+
+/// Sets the terminal's title.
+#[macro_export]
+macro_rules! set_title {
+ ($($format:tt)*) => {{
+ #[cfg(unix)]
+ let set_title = |title: &str| {
+ eprint!("\u{001B}]0;{title}\u{0007}");
+ };
+
+ #[cfg(windows)]
+ let set_title = |title: &str| {
+ unsafe { SetConsoleTitleA(title) };
+ };
+
+ let message = format!($($format)?);
+ set_title(&message);
+ }};
+}
+
+fn main() -> Result<(), i32> {
+ let config = match config::Config::load() {
+ Ok(config) => config,
+
+ Err(message) => {
+ log!(error, "{message}");
+ return Err(0x2);
+ },
+ };
+
+ log!(value, config);
+
+ let instance: instance::Instance = Default::default();
+
+ if let Err(message) = instance.run(&config) {
+ log!(error, "{message}");
+ return Err(0x1);
+ }
+
+ Ok(())
+}