2
.gitignore
vendored
2
.gitignore
vendored
@@ -3,4 +3,6 @@ bfl
|
||||
.cache
|
||||
.direnv
|
||||
compile_commands.json
|
||||
*.png
|
||||
*.bfl
|
||||
|
||||
|
19
CMakeLists.txt
Normal file
19
CMakeLists.txt
Normal file
@@ -0,0 +1,19 @@
|
||||
cmake_minimum_required(VERSION 3.20)
|
||||
|
||||
project(bfl LANGUAGES CXX)
|
||||
|
||||
option(BUILD_EXAMPLE "Build the example CLI" ON)
|
||||
|
||||
add_library(bfl INTERFACE)
|
||||
target_include_directories(bfl
|
||||
INTERFACE
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/include
|
||||
)
|
||||
target_compile_features(bfl INTERFACE cxx_std_20)
|
||||
|
||||
if(BUILD_EXAMPLE)
|
||||
add_executable(bfl_example src/bfl.cpp)
|
||||
set_target_properties(bfl_example PROPERTIES OUTPUT_NAME bfl)
|
||||
target_link_libraries(bfl_example PRIVATE bfl)
|
||||
target_compile_features(bfl_example PRIVATE cxx_std_23)
|
||||
endif()
|
702
LICENSE.rst
Normal file
702
LICENSE.rst
Normal file
@@ -0,0 +1,702 @@
|
||||
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.
|
24
README.md
Normal file
24
README.md
Normal file
@@ -0,0 +1,24 @@
|
||||
BitFLip image format
|
||||
====================
|
||||
|
||||
BFL is an image format for storing compressed or uncompressed 1 bit per pixel
|
||||
images.
|
||||
|
||||
Format features:
|
||||
- Transparency support
|
||||
- Relatively simple to implement, compression can be omitted completely
|
||||
- Lossless compression
|
||||
- Usually smaller than PNG
|
||||
|
||||
Library features:
|
||||
- No external dependencies
|
||||
- Written in C++20
|
||||
- Full compression support
|
||||
- Compression on encoding can be disabled
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
This software is licensed under the GNU GPLv3 license. Check
|
||||
[LICENSE](LICENSE.rst) for more information.
|
||||
|
39
bfl.cpp
39
bfl.cpp
@@ -1,39 +0,0 @@
|
||||
#include <filesystem>
|
||||
#include <fstream>
|
||||
#include <print>
|
||||
#include <vector>
|
||||
|
||||
#define STB_IMAGE_IMPLEMENTATION
|
||||
#include "stb_image.h"
|
||||
|
||||
struct Bitmap {
|
||||
int width, height;
|
||||
bool compressed{};
|
||||
std::vector<bool> image_data;
|
||||
std::vector<bool> transparency_data;
|
||||
};
|
||||
|
||||
auto read_entire_file(std::filesystem::path const &path)
|
||||
-> std::vector<uint8_t> {
|
||||
std::ifstream stream(path, std::ios::in | std::ios::binary);
|
||||
std::vector<uint8_t> const contents((std::istreambuf_iterator<char>(stream)),
|
||||
std::istreambuf_iterator<char>());
|
||||
return contents;
|
||||
}
|
||||
|
||||
auto write_entire_file(std::filesystem::path const &path,
|
||||
std::span<uint8_t> const &data) -> void {
|
||||
std::ofstream stream(path, std::ios::out | std::ios::binary);
|
||||
stream.write(reinterpret_cast<char *>(data.data()), data.size());
|
||||
}
|
||||
|
||||
auto main(int const argc, char const *argv[]) -> int {
|
||||
if (argc != 2) {
|
||||
std::println(stderr, "Usage: {} <file>", argv[0]);
|
||||
return 1;
|
||||
}
|
||||
|
||||
std::filesystem::path filepath{argv[1]};
|
||||
if (filepath.extension() == ".bfl") {
|
||||
}
|
||||
}
|
452
include/bfl.hpp
Normal file
452
include/bfl.hpp
Normal file
@@ -0,0 +1,452 @@
|
||||
/*
|
||||
* bfl - BitFLip image format
|
||||
* Copyright (C) 2025 Slendi <slendi@socopon.com>
|
||||
|
||||
* 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/>.
|
||||
*
|
||||
* Include the following in a source file before using the library:
|
||||
* #define BFL_IMPLEMENTATION
|
||||
* to create the implementation.
|
||||
*
|
||||
* Build flags:
|
||||
* - BFL_NO_LZSS: disable LZSS on encode.
|
||||
* - BFL_NO_COINFLIP: disable coinflip on encode.
|
||||
* - BFL_NO_COMPRESS: disable all compression on encode.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <cassert>
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <optional>
|
||||
#include <span>
|
||||
#include <vector>
|
||||
|
||||
namespace bfl {
|
||||
|
||||
enum : uint8_t {
|
||||
FLAG_HAS_ALPHA = 0x01,
|
||||
FLAG_IMG_RAW = 0x02,
|
||||
FLAG_TRA_RAW = 0x04,
|
||||
FLAG_IMG_NOLZ = 0x08,
|
||||
FLAG_TRA_NOLZ = 0x10,
|
||||
};
|
||||
|
||||
struct Header {
|
||||
uint16_t w{}, h{};
|
||||
uint8_t flags{};
|
||||
uint32_t img_len{}, tra_len{};
|
||||
};
|
||||
|
||||
struct View {
|
||||
Header hdr{};
|
||||
std::span<uint8_t const> img_c{};
|
||||
std::span<uint8_t const> tra_c{};
|
||||
};
|
||||
|
||||
auto parse_bfl(std::span<uint8_t const> data) -> std::optional<View>;
|
||||
|
||||
struct Bitmap {
|
||||
uint16_t width{}, height{};
|
||||
std::vector<bool> image_data;
|
||||
std::optional<std::vector<bool>> transparency_data;
|
||||
|
||||
[[nodiscard]] static auto from_rgba(std::span<uint32_t const> data, int w,
|
||||
int h) -> Bitmap;
|
||||
[[nodiscard]] static auto decode(std::span<uint8_t const> data) -> Bitmap;
|
||||
|
||||
[[nodiscard]] auto to_rgba() const -> std::vector<uint32_t>;
|
||||
[[nodiscard]] auto encode() const -> std::vector<uint8_t>;
|
||||
};
|
||||
|
||||
} // namespace bfl
|
||||
|
||||
#ifdef BFL_IMPLEMENTATION
|
||||
|
||||
#ifdef BFL_NO_COMPRESS
|
||||
#ifndef BFL_NO_LZSS
|
||||
#define BFL_NO_LZSS
|
||||
#endif // BFL_NO_LZSS
|
||||
#ifndef BFL_NO_COINFLIP
|
||||
#define BFL_NO_COINFLIP
|
||||
#endif // BFL_NO_COINFLIP
|
||||
#endif // BFL_NO_COMPRESS
|
||||
|
||||
#include <algorithm>
|
||||
#include <type_traits>
|
||||
#include <utility>
|
||||
|
||||
namespace bfl {
|
||||
|
||||
template <class T> inline void put_le(std::vector<uint8_t> &buf, T v) noexcept {
|
||||
static_assert(std::is_unsigned_v<T>);
|
||||
for (size_t i{}; i < sizeof(T); i++)
|
||||
buf.push_back(static_cast<uint8_t>((v >> (i * 8)) & 0xFF));
|
||||
}
|
||||
|
||||
template <class T>
|
||||
inline T get_le(std::span<uint8_t const> s, size_t off) noexcept {
|
||||
static_assert(std::is_unsigned_v<T>);
|
||||
T v = 0;
|
||||
for (size_t i{}; i < sizeof(T); i++)
|
||||
v |= (static_cast<T>(s[off + i]) << (i * 8));
|
||||
return v;
|
||||
}
|
||||
|
||||
#ifndef BFL_NO_LZSS
|
||||
std::vector<uint8_t> lzss_compress(std::span<uint8_t const> in) {
|
||||
int const W{4096}, LA{18}, MIN{3};
|
||||
std::vector<uint8_t> out;
|
||||
out.reserve(in.size() / 8 + 16);
|
||||
size_t i{};
|
||||
while (i < in.size()) {
|
||||
uint8_t flag{};
|
||||
size_t flag_pos{out.size()};
|
||||
out.push_back(0);
|
||||
for (int bit{}; bit < 8 && i < in.size(); bit++) {
|
||||
size_t best_len{}, best_off{};
|
||||
size_t wnd_start{(i > (size_t)W) ? i - W : 0};
|
||||
size_t max_len{std::min((size_t)LA, in.size() - i)};
|
||||
for (size_t p{i}; p-- > wnd_start;) {
|
||||
size_t l{};
|
||||
while (l < max_len && in[p + l] == in[i + l])
|
||||
l++;
|
||||
if (l >= (size_t)MIN && l > best_len) {
|
||||
best_len = l;
|
||||
best_off = i - p;
|
||||
if (best_len == (size_t)LA)
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (best_len >= (size_t)MIN && best_off >= 1 && best_off <= 4095) {
|
||||
uint8_t b0 =
|
||||
static_cast<uint8_t>(((best_len - 3) << 4) | (best_off >> 8));
|
||||
uint8_t b1{static_cast<uint8_t>(best_off & 0xFF)};
|
||||
out.push_back(b0);
|
||||
out.push_back(b1);
|
||||
i += best_len;
|
||||
} else {
|
||||
flag |= (1u << bit);
|
||||
out.push_back(in[i++]);
|
||||
}
|
||||
}
|
||||
out[flag_pos] = flag;
|
||||
}
|
||||
return out;
|
||||
}
|
||||
#endif // BFL_NO_LZSS
|
||||
|
||||
std::vector<uint8_t> lzss_decompress(std::span<uint8_t const> in) {
|
||||
std::vector<uint8_t> out;
|
||||
out.reserve(in.size() * 2);
|
||||
size_t i{};
|
||||
while (i < in.size()) {
|
||||
uint8_t flag{in[i++]};
|
||||
for (int bit{}; bit < 8 && i < in.size(); bit++) {
|
||||
if ((flag >> bit) & 1) {
|
||||
out.push_back(in[i++]);
|
||||
} else {
|
||||
if (i + 1 >= in.size())
|
||||
return out;
|
||||
uint8_t b0{in[i++]}, b1{in[i++]};
|
||||
size_t len{static_cast<size_t>((b0 >> 4) + 3)};
|
||||
size_t off{static_cast<size_t>(((b0 & 0x0F) << 8) | b1)};
|
||||
if (off == 0 || off > out.size())
|
||||
return out;
|
||||
size_t src{out.size() - off};
|
||||
for (size_t k{}; k < len; k++)
|
||||
out.push_back(out[src + k]);
|
||||
}
|
||||
}
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
std::vector<uint8_t> bits_to_bytes(std::vector<bool> const &data) noexcept {
|
||||
std::vector<uint8_t> bytes((data.size() + 7) / 8, 0);
|
||||
for (size_t i{}; i < data.size(); i++)
|
||||
if (data[i])
|
||||
bytes[i / 8] |= (1u << (i % 8));
|
||||
return bytes;
|
||||
}
|
||||
|
||||
std::vector<bool> decode_raw(std::span<uint8_t const> in, size_t total_bits) {
|
||||
std::vector<bool> out(total_bits, false);
|
||||
for (size_t i{}; i < total_bits; i++) {
|
||||
uint8_t byte = (i / 8 < in.size()) ? in[i / 8] : 0;
|
||||
out[i] = ((byte >> (i % 8)) & 1) != 0;
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
#ifndef BFL_NO_COINFLIP
|
||||
std::vector<uint8_t> coinflip_encode(std::vector<bool> const &data,
|
||||
bool initial,
|
||||
std::vector<bool> const *transparency,
|
||||
bool allow_trick) {
|
||||
std::vector<uint8_t> out;
|
||||
out.reserve(data.size() / 4 + 8);
|
||||
out.push_back(static_cast<uint8_t>(initial));
|
||||
|
||||
bool state{initial};
|
||||
size_t count{}, i{};
|
||||
|
||||
auto flush{[&](uint8_t n) { out.push_back(n); }};
|
||||
|
||||
while (i < data.size()) {
|
||||
bool is_transparent{transparency && (*transparency)[i]};
|
||||
|
||||
if (allow_trick && is_transparent) {
|
||||
while (i < data.size() && (*transparency)[i]) {
|
||||
if (count == 255) {
|
||||
flush(255);
|
||||
state = !state;
|
||||
count = 0;
|
||||
}
|
||||
count++;
|
||||
i++;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
bool bit{data[i]};
|
||||
if (bit == state) {
|
||||
count++;
|
||||
i++;
|
||||
if (count == 255 && i < data.size()) {
|
||||
flush(255);
|
||||
out.push_back(0);
|
||||
count = 0;
|
||||
}
|
||||
} else {
|
||||
flush(static_cast<uint8_t>(count));
|
||||
state = !state;
|
||||
count = 1;
|
||||
i++;
|
||||
}
|
||||
}
|
||||
if (count)
|
||||
flush(static_cast<uint8_t>(count));
|
||||
return out;
|
||||
}
|
||||
#endif // BFL_NO_COINFLIP
|
||||
|
||||
std::vector<bool> rle_decode(std::span<uint8_t const> in, size_t total_bits) {
|
||||
std::vector<bool> out(total_bits, false);
|
||||
if (in.size() < 2)
|
||||
return out;
|
||||
|
||||
bool state{in[0] != 0};
|
||||
size_t produced{0}, j{1};
|
||||
|
||||
while (produced < total_bits && j < in.size()) {
|
||||
uint8_t n{in[j++]};
|
||||
if (n == 0)
|
||||
continue;
|
||||
size_t emit{std::min<size_t>(n, total_bits - produced)};
|
||||
for (size_t k{}; k < emit; k++)
|
||||
out[produced + k] = state;
|
||||
produced += emit;
|
||||
if (j < in.size() && in[j] == 0)
|
||||
j++;
|
||||
else
|
||||
state = !state;
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
auto parse_bfl(std::span<uint8_t const> data) -> std::optional<View> {
|
||||
if (data.size() < 3 + 2 + 2 + 1 + 4 + 4)
|
||||
return std::nullopt;
|
||||
if (!(data[0] == 'B' && data[1] == 'F' && data[2] == 'L'))
|
||||
return std::nullopt;
|
||||
|
||||
size_t off{3};
|
||||
View v;
|
||||
v.hdr.w = get_le<uint16_t>(data, off);
|
||||
off += 2;
|
||||
v.hdr.h = get_le<uint16_t>(data, off);
|
||||
off += 2;
|
||||
v.hdr.flags = data[off++];
|
||||
v.hdr.img_len = get_le<uint32_t>(data, off);
|
||||
off += 4;
|
||||
v.hdr.tra_len = get_le<uint32_t>(data, off);
|
||||
off += 4;
|
||||
|
||||
if (off + v.hdr.img_len > data.size())
|
||||
return std::nullopt;
|
||||
if (off + v.hdr.img_len + v.hdr.tra_len > data.size())
|
||||
return std::nullopt;
|
||||
|
||||
v.img_c = data.subspan(off, v.hdr.img_len);
|
||||
off += v.hdr.img_len;
|
||||
v.tra_c = data.subspan(off, v.hdr.tra_len);
|
||||
return v;
|
||||
}
|
||||
|
||||
auto Bitmap::to_rgba() const -> std::vector<uint32_t> {
|
||||
auto mk{[](uint8_t r, uint8_t g, uint8_t b, uint8_t a) -> uint32_t {
|
||||
return (uint32_t)r | ((uint32_t)g << 8) | ((uint32_t)b << 16) |
|
||||
((uint32_t)a << 24);
|
||||
}};
|
||||
size_t n{(size_t)width * (size_t)height};
|
||||
std::vector<uint32_t> out(n, 0);
|
||||
for (size_t i{}; i < n; i++) {
|
||||
bool tr{transparency_data && i < transparency_data->size() &&
|
||||
(*transparency_data)[i]};
|
||||
bool wh{i < image_data.size() && image_data[i]};
|
||||
out[i] =
|
||||
tr ? mk(0, 0, 0, 0) : (wh ? mk(255, 255, 255, 255) : mk(0, 0, 0, 255));
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
auto Bitmap::encode() const -> std::vector<uint8_t> {
|
||||
auto choose_rle_or_raw{
|
||||
[&](std::vector<bool> const &bits, bool &raw_flag, bool allow_trick) {
|
||||
#ifdef BFL_NO_COINFLIP
|
||||
(void)allow_trick;
|
||||
raw_flag = true;
|
||||
return bits_to_bytes(bits);
|
||||
#else
|
||||
std::vector<bool> const *mask{transparency_data ? &(*transparency_data)
|
||||
: nullptr};
|
||||
auto a{coinflip_encode(bits, false, mask, allow_trick)};
|
||||
auto b{coinflip_encode(bits, true, mask, allow_trick)};
|
||||
std::vector<uint8_t> best{(a.size() <= b.size()) ? std::move(a)
|
||||
: std::move(b)};
|
||||
if (best.size() * 8 > bits.size()) {
|
||||
best = bits_to_bytes(bits);
|
||||
raw_flag = true;
|
||||
}
|
||||
return best;
|
||||
#endif
|
||||
}};
|
||||
|
||||
std::vector<uint8_t> out;
|
||||
out.push_back('B');
|
||||
out.push_back('F');
|
||||
out.push_back('L');
|
||||
put_le<uint16_t>(out, width);
|
||||
put_le<uint16_t>(out, height);
|
||||
|
||||
bool img_raw{}, tra_raw{};
|
||||
auto img_bytes =
|
||||
choose_rle_or_raw(image_data, img_raw, transparency_data.has_value());
|
||||
std::vector<uint8_t> tra_bytes;
|
||||
if (transparency_data)
|
||||
tra_bytes = choose_rle_or_raw(*transparency_data, tra_raw, false);
|
||||
|
||||
auto maybe_lz{[](std::vector<uint8_t> v, bool &no_lz) {
|
||||
#ifndef BFL_NO_LZSS
|
||||
auto c{lzss_compress(v)};
|
||||
if (c.size() < v.size())
|
||||
return c;
|
||||
#endif // BFL_NO_LZSS
|
||||
no_lz = true;
|
||||
return v;
|
||||
}};
|
||||
bool img_no_lz{}, tra_no_lz{};
|
||||
auto img_stream{maybe_lz(std::move(img_bytes), img_no_lz)};
|
||||
std::vector<uint8_t> tra_stream;
|
||||
if (!tra_bytes.empty())
|
||||
tra_stream = maybe_lz(std::move(tra_bytes), tra_no_lz);
|
||||
|
||||
uint8_t flags{};
|
||||
if (transparency_data)
|
||||
flags |= FLAG_HAS_ALPHA;
|
||||
if (img_raw)
|
||||
flags |= FLAG_IMG_RAW;
|
||||
if (tra_raw)
|
||||
flags |= FLAG_TRA_RAW;
|
||||
if (img_no_lz)
|
||||
flags |= FLAG_IMG_NOLZ;
|
||||
if (tra_no_lz)
|
||||
flags |= FLAG_TRA_NOLZ;
|
||||
|
||||
out.push_back(flags);
|
||||
put_le<uint32_t>(out, static_cast<uint32_t>(img_stream.size()));
|
||||
put_le<uint32_t>(out, static_cast<uint32_t>(tra_stream.size()));
|
||||
out.insert(out.end(), img_stream.begin(), img_stream.end());
|
||||
out.insert(out.end(), tra_stream.begin(), tra_stream.end());
|
||||
return out;
|
||||
}
|
||||
|
||||
auto Bitmap::from_rgba(std::span<uint32_t const> data, int w, int h) -> Bitmap {
|
||||
assert(w > 0 && h > 0);
|
||||
assert(static_cast<int>(data.size()) == w * h);
|
||||
|
||||
Bitmap bm;
|
||||
bm.width = (uint16_t)w;
|
||||
bm.height = (uint16_t)h;
|
||||
size_t n{(size_t)w * (size_t)h};
|
||||
bm.image_data.resize(n);
|
||||
bm.transparency_data.emplace();
|
||||
bm.transparency_data->resize(n);
|
||||
|
||||
for (size_t i{}; i < n; i++) {
|
||||
uint32_t px{data[i]};
|
||||
uint8_t r = (px >> 0) & 0xFF, g = (px >> 8) & 0xFF, b = (px >> 16) & 0xFF,
|
||||
a = (px >> 24) & 0xFF;
|
||||
bool white{(r == 255 && g == 255 && b == 255 && a != 0)};
|
||||
bool black{(r == 0 && g == 0 && b == 0 && a != 0)};
|
||||
bool tr{(!white && !black) || (a == 0)};
|
||||
(*bm.transparency_data)[i] = tr;
|
||||
bm.image_data[i] = white;
|
||||
}
|
||||
return bm;
|
||||
}
|
||||
|
||||
auto Bitmap::decode(std::span<uint8_t const> data) -> Bitmap {
|
||||
Bitmap bm{};
|
||||
auto view{parse_bfl(data)};
|
||||
if (!view)
|
||||
return bm;
|
||||
|
||||
auto &h{view->hdr};
|
||||
bool has_alpha{(h.flags & FLAG_HAS_ALPHA) != 0};
|
||||
bool img_was_raw{(h.flags & FLAG_IMG_RAW) != 0};
|
||||
bool tra_was_raw{(h.flags & FLAG_TRA_RAW) != 0};
|
||||
bool img_no_lz{(h.flags & FLAG_IMG_NOLZ) != 0};
|
||||
bool tra_no_lz{(h.flags & FLAG_TRA_NOLZ) != 0};
|
||||
|
||||
std::vector<uint8_t> img_stream =
|
||||
img_no_lz ? std::vector<uint8_t>(view->img_c.begin(), view->img_c.end())
|
||||
: lzss_decompress(view->img_c);
|
||||
std::vector<uint8_t> tra_stream =
|
||||
has_alpha
|
||||
? (tra_no_lz
|
||||
? std::vector<uint8_t>(view->tra_c.begin(), view->tra_c.end())
|
||||
: lzss_decompress(view->tra_c))
|
||||
: std::vector<uint8_t>{};
|
||||
|
||||
size_t total_bits{(size_t)h.w * (size_t)h.h};
|
||||
auto img_bits{img_was_raw ? decode_raw(img_stream, total_bits)
|
||||
: rle_decode(img_stream, total_bits)};
|
||||
std::optional<std::vector<bool>> tra_bits;
|
||||
if (has_alpha)
|
||||
tra_bits = tra_was_raw ? decode_raw(tra_stream, total_bits)
|
||||
: rle_decode(tra_stream, total_bits);
|
||||
|
||||
bm.width = h.w;
|
||||
bm.height = h.h;
|
||||
bm.image_data = std::move(img_bits);
|
||||
bm.transparency_data = std::move(tra_bits);
|
||||
return bm;
|
||||
}
|
||||
|
||||
} // namespace bfl
|
||||
|
||||
#endif // BFL_IMPLEMENTATION
|
121
src/bfl.cpp
Normal file
121
src/bfl.cpp
Normal file
@@ -0,0 +1,121 @@
|
||||
/*
|
||||
* bfl - BitFLip image format
|
||||
* Copyright (C) 2025 Slendi <slendi@socopon.com>
|
||||
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
#include <cassert>
|
||||
#include <cstdint>
|
||||
#include <filesystem>
|
||||
#include <fstream>
|
||||
#include <print>
|
||||
#include <span>
|
||||
#include <string_view>
|
||||
|
||||
#define BFL_IMPLEMENTATION
|
||||
#include <bfl.hpp>
|
||||
|
||||
#define STB_IMAGE_IMPLEMENTATION
|
||||
#include "stb_image.h"
|
||||
#define STB_IMAGE_WRITE_IMPLEMENTATION
|
||||
#include "stb_image_write.h"
|
||||
|
||||
static void print_bfl_header(bfl::Header const &h) {
|
||||
auto const bool_prt = [](bool v) -> char const * { return v ? "yes" : "no"; };
|
||||
|
||||
std::println("BFL header:");
|
||||
std::println(" width : {}", h.w);
|
||||
std::println(" height : {}", h.h);
|
||||
std::println(" flags (hex) : 0x{:02X}", h.flags);
|
||||
std::println(" has_alpha : {}", bool_prt(h.flags & bfl::FLAG_HAS_ALPHA));
|
||||
std::println(" img_raw : {}", bool_prt(h.flags & bfl::FLAG_IMG_RAW));
|
||||
std::println(" tra_raw : {}", bool_prt(h.flags & bfl::FLAG_TRA_RAW));
|
||||
std::println(" img_no_lz : {}", bool_prt(h.flags & bfl::FLAG_IMG_NOLZ));
|
||||
std::println(" tra_no_lz : {}", bool_prt(h.flags & bfl::FLAG_TRA_NOLZ));
|
||||
std::println(" image bytes : {}", h.img_len);
|
||||
std::println(" alpha bytes : {}", h.tra_len);
|
||||
}
|
||||
|
||||
inline std::vector<uint8_t> read_file(std::filesystem::path const &p) {
|
||||
std::ifstream f(p, std::ios::binary);
|
||||
return std::vector<uint8_t>((std::istreambuf_iterator<char>(f)),
|
||||
std::istreambuf_iterator<char>());
|
||||
}
|
||||
|
||||
inline void write_file(std::filesystem::path const &p,
|
||||
std::span<uint8_t const> d) {
|
||||
std::ofstream f(p, std::ios::binary);
|
||||
f.write(reinterpret_cast<char const *>(d.data()),
|
||||
static_cast<std::streamsize>(d.size()));
|
||||
}
|
||||
|
||||
int main(int argc, char const *argv[]) {
|
||||
if (argc < 2) {
|
||||
std::println(stderr,
|
||||
"Usage:\n"
|
||||
" {} <input> <output>\n"
|
||||
" {} header <file.bfl>",
|
||||
argv[0], argv[0]);
|
||||
return 1;
|
||||
}
|
||||
|
||||
if (argc == 3 && std::string_view(argv[1]) == "header") {
|
||||
auto bytes{read_file(argv[2])};
|
||||
auto v{bfl::parse_bfl(bytes)};
|
||||
if (!v) {
|
||||
std::println(stderr, "Invalid or truncated BFL: {}", argv[2]);
|
||||
return 2;
|
||||
}
|
||||
print_bfl_header(v->hdr);
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (argc != 3) {
|
||||
std::println(stderr,
|
||||
"Usage:\n"
|
||||
" {} <input> <output>\n"
|
||||
" {} header <file.bfl>",
|
||||
argv[0], argv[0]);
|
||||
return 1;
|
||||
}
|
||||
|
||||
std::filesystem::path in{argv[1]}, outp{argv[2]};
|
||||
bfl::Bitmap bmp;
|
||||
|
||||
if (in.extension() == ".bfl") {
|
||||
bmp = bfl::Bitmap::decode(read_file(in));
|
||||
} else {
|
||||
int w, h, comp;
|
||||
unsigned char *raw{stbi_load(in.string().c_str(), &w, &h, &comp, 4)};
|
||||
if (!raw) {
|
||||
std::println(stderr, "stbi_load failed on {}", in.string());
|
||||
return 1;
|
||||
}
|
||||
std::span<uint32_t const> px{reinterpret_cast<uint32_t const *>(raw),
|
||||
(size_t)w * (size_t)h};
|
||||
bmp = bfl::Bitmap::from_rgba(px, w, h);
|
||||
stbi_image_free(raw);
|
||||
}
|
||||
|
||||
if (outp.extension() == ".bfl") {
|
||||
auto bin{bmp.encode()};
|
||||
write_file(outp, std::span<uint8_t const>(bin.data(), bin.size()));
|
||||
} else {
|
||||
auto rgba{bmp.to_rgba()};
|
||||
stbi_write_png(outp.string().c_str(), bmp.width, bmp.height, 4, rgba.data(),
|
||||
bmp.width * 4);
|
||||
}
|
||||
return 0;
|
||||
}
|
1724
src/stb_image_write.h
Normal file
1724
src/stb_image_write.h
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user