code:
### GNU AFFERO GENERAL PUBLIC LICENSE

Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.

The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are 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.

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.

Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.

A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.

The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.

An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing
under this license.

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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.

Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your
version supports such interaction) an opportunity to receive the
Corresponding Source of your version by providing access to the
Corresponding Source from a network server at no charge, through some
standard or customary means of facilitating copying of software. This
Corresponding Source shall include the Corresponding Source for any
work covered by version 3 of the GNU General Public License that is
incorporated pursuant to the following paragraph.

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 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 work with which it is combined will remain governed by version
3 of the GNU General Public License.

#### 14. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.

        You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for
the specific requirements.

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 AGPL, see <https://www.gnu.org/licenses/>.


code:
/*
   sspect - A simple spectrogram
   Copyright (C) 2018, 2019  Emily, emily@countermail.com

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero 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 Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

/*
   Based on glSpect (2012) by Alex Barnett, ahb@math.dartmouth.edu,
   and on glScope (2005) by Luke Campagnola, lcampagn@mines.edu. Both
   the above were licensed by

   Distributed under a completely free license; this means you can do
   absolutely anything you want with this code. I'd appreciate if you
   credit me where appropriate, though.
*/

#include <GL/glut.h>
#include <GL/gl.h>
#include <alsa/asoundlib.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <pthread.h>
#include <sys/time.h>
#include <math.h>
#include <fftw3.h>

#define PI              3.14159265358979323846

class audioInput;      // declarations (things needed before defined)
void computespecslice(audioInput *ai);
int chooseTics(float lo, float range, float fac, float *tics);

static int verb;         // global verbosity
struct Param {           // parameters object
  int devicenumber;      // ALSA device number
  int windowtype;        // DFT windowing function type
  int twowinsize;        // power of 2 giving DFT win_size (N) in samples
  float freqline[100];   // at which frequencies to draw a line
  bool drawline = false; // has freqline been used?
  int nfreqlines = 0;    // number of actual frequencies added to freqline
  bool drawcentroid = false; // has freqline been used?
};                       // note trailing ;
Param param;           // global parameters object

const char *notenames[] = { "C","C#","D","Eb","E","F","F#","G","G#","A","Bb","B"};  // 1/17/16

float timeDiff(timeval a, timeval b) {
  return (float)(b.tv_sec - a.tv_sec) + (float)(b.tv_usec - a.tv_usec) * 0.000001F;
}

void drawText(float x, float y, char *string) {
  int len, i;
  glRasterPos2f(x, y);
  len = (int) strlen(string);
  for (i = 0; i < len; i++)
  {
    glutBitmapCharacter(GLUT_BITMAP_HELVETICA_18, string[i]);
  }
}

void smallText(float x, float y, char *string) {
  int len, i;
  glRasterPos2f(x, y);
  len = (int) strlen(string);
  for (i = 0; i < len; i++)
  {
    glutBitmapCharacter(GLUT_BITMAP_HELVETICA_10, string[i]);
  }
}

///////////// AUDIOINPUT class (no references to scn) ////////////////////
class audioInput {
  public:
  char *chunk;
  float *b, *specslice, *bwin, *winf, *sg, *centroids;
  char *sgb;
  int b_ind, b_size, n_f, n_tw, sg_size, win_size;
  float dt, t_memory, Hz_per_pixel;

  bool quit, pause;
  pthread_t capture_thread;
  fftwf_plan fftw_p;

  // Audio device data (modified from ALSA tutorial)
  int bytes_per_frame, frames_per_period, nperiods, channels;
  int req_rate, rate;   /* Requested and actual sample rate */
  int dir;          /* rate == req_rate --> dir = 0 */
                    /* rate < req_rate  --> dir = -1 */
                    /* rate > req_rate  --> dir = 1 */
  snd_pcm_uframes_t period_size;     // Period size (bytes)
  snd_pcm_uframes_t req_size, size;  // requested and actual ALSA buffer size
  snd_pcm_t *pcm_handle;        /* Handle for the PCM device */
  snd_pcm_stream_t stream;     /* Playback stream */
  /* This structure contains information about    */
  /* the hardware and can be used to specify the  */
  /* configuration to be used for the PCM stream. */
  snd_pcm_hw_params_t *hwparams;
  /* Name of the PCM device, like plughw:0,0          */
  /* The first number is the number of the soundcard, */
  /* the second number is the number of the device.   */
  char *pcm_name;

  void setupWindowFunc(float *w, int N) {
    float W;
    int i;
    if (verb) printf("windowtype=%d\n", param.windowtype);
    switch (param.windowtype) {
    case 0:  // no window (crappy frequency spillover)
      for( i=0; i<N; ++i)
	w[i] = 1.0F;
      break;
    case 1:  // Hann window (C^1 cont, so third-order tails)
      W = N/2.0F;
      for( i=0; i<N; ++i)
	w[i] = (1.0F + cos(PI*(i-W)/W))/2;
      break;
    case 2:  // truncated Gaussian window (Gaussian tails + exp small error)
      W = N/5.0F;    // width: keep small truncation but wide to not waste FFT
      for( i=0; i<N; ++i) w[i] = exp(-(i-N/2)*(i-N/2)/(2*W*W));
      break;
    default:
      fprintf(stderr, "unknown windowtype!\n");
    }
  }

  audioInput() {            // nontrivial constructor
    quit = false;
    pause = false;
    channels = 2;       // Had to change to stereo for System76 ! (was mono)
    bytes_per_frame = 2 * channels;      // 16-bit
    req_rate = 44100;         // audio sampling rate in Hz
    frames_per_period = (int)(req_rate/60.0);   // 735 = 44100Hz/60fps assumed
    nperiods = 2;             // >=2, see ALSA manual
    t_memory = 20.0;            // memory of our circular buffer in secs

    period_size = frames_per_period * bytes_per_frame;
    chunk = new char[period_size];   // raw data buffer for PCM read: 1 period
    req_size = frames_per_period * nperiods; // ALSA device buffer size (frames)
    b_ind = 0;                // integer index where to write to in buffer
    if( initDevice() < 0 ) // set up sound card for recording (sets rate, size)
      exit(1);
    dt = 1.0 / (float)rate;   // sampling period
    b_size = (int)(t_memory * rate);   // buffer size
    if (verb) printf("memory buffer size %d samples\n", b_size);
    b = new float[b_size];    // our circular audio buffer

    win_size = 1<<param.twowinsize;     // FFT size
    bwin = new float[win_size];         // windowed recent audio data
    winf = new float[win_size];
    setupWindowFunc(winf, win_size);    // windowing function
     // set up fast in-place single-precision real-to-half-complex DFT:
    fftw_p = fftwf_plan_r2r_1d(win_size, bwin, bwin, FFTW_R2HC, FFTW_MEASURE);
    n_f = 560;  // # freqs   ...spectrogram stuff
    specslice = new float[n_f];
    n_tw = 940; // # time windows: should be multiple of 4 for glDrawPixels
    centroids = new float[n_tw]; // array for storing centroids
    for (int i=0; i<n_tw; ++i)
      centroids[i]=0;
    sg_size = n_f * n_tw;
    sg = new float[sg_size];  // spectrogram array float
    sgb = new char[sg_size];  // spectrogram array 8-bit
    //for( int i=0; i<sg_size; ++i )  // fill with random for now
    //sg[i] = (float)(random()/(float)RAND_MAX);
    //for( int i=0; i<sg_size; ++i )  // fill with random for now
    //sgb[i] = (int)(256.0*random()/(float)RAND_MAX);
    Hz_per_pixel = 1.0F / (win_size*dt);
    if (verb) printf("Hz per pixel = %.3f\n", Hz_per_pixel);

    // Start recording thread... runs independently, writing data into ai->b
    pthread_create(&capture_thread, NULL, audioCapture, (void*)this); // this?
  }
  ~audioInput() {             // destructor
    snd_pcm_close (pcm_handle);
    fftwf_destroy_plan(fftw_p);
  }

  int initDevice() {  // ........ set up sound card for recording ........
    // ALSA tutorial, taken from http://www.suse.de/~mana/alsa090_howto.html

    stream = SND_PCM_STREAM_CAPTURE;
    /* Init pcm_name. Accepts device numbers up to 10^21-1. */
    char pcm_devnum[21];
    snprintf(pcm_devnum, 21, "%d", param.devicenumber);
    pcm_name = strdup("plughw:");
    strcat(pcm_name, pcm_devnum);
    strcat(pcm_name, ",0");
    /* Allocate the snd_pcm_hw_params_t structure on the stack. */
    snd_pcm_hw_params_alloca(&hwparams);
    /* Open PCM. The last parameter of this function is the mode. */
    /* If this is set to 0, the standard mode is used. Possible   */
    /* other values are SND_PCM_NONBLOCK and SND_PCM_ASYNC.       */
    /* If SND_PCM_NONBLOCK is used, read / write access to the    */
    /* PCM device will return immediately. If SND_PCM_ASYNC is    */
    /* specified, SIGIO will be emitted whenever a period has     */
    /* been completely processed by the soundcard.                */
    if (snd_pcm_open(&pcm_handle, pcm_name, stream, 0) < 0) {
      fprintf(stderr, "Error opening PCM device %s\n", pcm_name);
      return(-1);
    }
    /* Init hwparams with full configuration space */
    if (snd_pcm_hw_params_any(pcm_handle, hwparams) < 0) {
      fprintf(stderr, "Can not configure this PCM device.\n");
      return(-1);
    }
    /* Set access type. This can be either    */
    /* SND_PCM_ACCESS_RW_INTERLEAVED or       */
    /* SND_PCM_ACCESS_RW_NONINTERLEAVED.      */
    /* There are also access types for MMAPed */
    /* access, but this is beyond the scope   */
    /* of this introduction.                  */
    if (snd_pcm_hw_params_set_access(pcm_handle, hwparams, SND_PCM_ACCESS_RW_INTERLEAVED) < 0) {
      fprintf(stderr, "Error setting access.\n");
      return(-1);
    }

    /* Set sample format */
    if (snd_pcm_hw_params_set_format(pcm_handle, hwparams, SND_PCM_FORMAT_S16_LE) < 0) {
      fprintf(stderr, "Error setting format.\n");
      return(-1);
    }

    /* Set sample rate. If the requested rate is not supported */
    /* by the hardware, use nearest possible rate.         */
    rate = req_rate;
    if (snd_pcm_hw_params_set_rate_near(pcm_handle, hwparams, (uint*)&rate, 0) < 0) {
      fprintf(stderr, "Error setting rate.\n");
      return(-1);
    }
    if (rate != req_rate) {
      fprintf(stderr, "The rate %d Hz is not supported by your hardware.\n \
                        ==> Using %d Hz instead.\n", req_rate, rate);
    }

    /* Set number of channels */
    if (snd_pcm_hw_params_set_channels(pcm_handle, hwparams, channels) < 0) {
      fprintf(stderr, "Error setting channels.\n");
      return(-1);
    }

    /* Set number of periods. Periods used to be called fragments. */
    if (snd_pcm_hw_params_set_periods(pcm_handle, hwparams, nperiods, 0) < 0) {
      fprintf(stderr, "Error setting number of periods.\n");
      return(-1);
    }
    /* Set buffer size (in frames). The resulting latency is given by */
    /* latency = period_size * nperiods / (rate * bytes_per_frame)     */
    size = req_size;
    if (snd_pcm_hw_params_set_buffer_size_near(pcm_handle, hwparams, &size) < 0) {
      fprintf(stderr, "Error setting buffersize.\n");
      return(-1);
    }
    if( size != req_size ) {
      fprintf(stderr, "Buffer size %d is not supported, using %d instead.\n", (int)req_size, (int)size);
    }

    /* Apply HW parameter settings to PCM device and prepare device  */
    if (snd_pcm_hw_params(pcm_handle, hwparams) < 0) {
      fprintf(stderr, "Error setting HW params.\n");
      return(-1);
    }
    return 1;
  } // ........................................

  void quitNow() {
    quit = true;
    //      pthread_kill_other_threads_np();
    snd_pcm_close (pcm_handle);
  }

  union byte {                    // used to convert from signed to unsigned
    unsigned char uchar_val;
    char char_val;
  };

  int mod( int i ) {  // true modulo (handles negative) into our buffer b
    // wraps i to lie in [0, (b_size-1)]. rewritten Barnett
    int r = i % b_size;
    if (r<0)
      r += b_size;
    return r;
  }

  static void* audioCapture(void* a) { //-------- capture: thread runs indep --
    // still mostly Luke's code, some names changed. Aims to read 1 "period"
    // (ALSA device setting) into the current write index of our ai->b buffer.
    fprintf(stderr, "audioCapture thread started...\n");
    audioInput* ai = (audioInput*) a;  // shares data with main thread = cool!

    float inv256 = 1.0 / 256.0;
    float inv256_2 = inv256*inv256;

    while( ! ai->quit ) {  // loops around until state of ai kills it
      int n;
      if( ! ai->pause ) {
	// keep trying to get exactly 1 "period" of raw data from sound card...
	while((n = snd_pcm_readi(ai->pcm_handle, ai->chunk, ai->frames_per_period)) < 0 ) {
	  //	  if (n == -EPIPE) fprintf(stderr, "Overrun occurred: %d\n", n); // broken pipe
	  fprintf(stderr, "Error occured while recording: %s\n", snd_strerror(n));

	  //n = snd_pcm_recover(ai->pcm_handle, n, 0); // ahb

	  //fprintf(stderr, "Error occured while recording: %s\n", snd_strerror(n));
	  snd_pcm_prepare(ai->pcm_handle);
	  //fprintf(stderr, "Dropped audio data (frames read n=%d)\n", n);
	}  // n samples were got
	if (verb>1) printf("snd_pcm_readi got n=%d frames\n", n);

	byte by;
	int write_ptr, read_ptr;
	for( int i = 0; i < n; i++ ) { // read chunk into our buffer ai->b ...
	  read_ptr = i * ai->bytes_per_frame;
	  write_ptr = ai->mod(ai->b_ind + i); // wraps around
	  by.char_val = ai->chunk[read_ptr];
	  // compute float in [-1/2,1/2) from 16-bit raw... (LSB unsigned char)
	  ai->b[write_ptr] = (float)ai->chunk[read_ptr+1]*inv256 + (float)by.uchar_val*inv256_2;
	}
	ai->b_ind = ai->mod(ai->b_ind+n);  // update index (in one go)

	computespecslice(ai); // compute spectral slice of recent buffer history
      }
      else {
	usleep(10000);  // wait 0.01 sec if paused (keeps thread CPU usage low)
      }
    }
    fprintf(stderr, "audioCapture thread exiting.\n");
  }                          // ----------------------- end capture thread ----
};

//////////////////////////////////////// SCENE CLASS /////////////////////////
class scene
{
  public:
  float viewport_size[2];  // gl window width, height
  float mouse[3];
  bool pause;
  audioInput* ai;
  float color_scale[2];    // sg image log color mapping params
  bool diagnose;           // medical stuff
  char diagnosis[1000];
  time_t fps_tic;             // FPS time reference
  int frameCount, fps;       // frames per sec and counter
  int scroll_fac, scroll_count, colormode;
  float run_time;
  timeval start_time;
  int freqind;     // toggles frequency readoff line(s), either 0,1,2

  scene() { }        // trivial constructor, to prevent global init fiasco
  ~scene() { }      // destructor

  void init() {       // meaningful constructor - could move some to main to
                      // parse cmd line
    pause = false;
    color_scale[0] = 100.0+40;     // 8-bit intensity offset
    color_scale[1] = 255/120.0/1.5;     // 8-bit intensity slope (per dB units)
    ai = new audioInput();
    fps_tic = time(NULL); frameCount = fps = 0;
    colormode = 2;
    scroll_count = 0;
    gettimeofday(&start_time, NULL);
    run_time = 0.0;
    freqind = 0;
    diagnose = 0;                         // initialize Medical stuff
    strcpy(diagnosis, "no diagnosis ...");
  }

  void graph() // simple graph of ai->float_data ............................
  {
    float tshow = 0.1;    // only show the most recent tshow secs of samples
    glDisable(GL_DEPTH_TEST); glDisable(GL_BLEND);
    glDisable(GL_LINE_SMOOTH); glLineWidth(2);
    glMatrixMode(GL_MODELVIEW);
    glPushMatrix(); // use modelview matrix to xform [-tshow,0]x[-1,1] somewhere
    glTranslatef(0.97,0.1,0);
    glScalef(4.0,1.0,1.0);  // x-scale for time-units, y-scale is 1
    char xlab[] = "t(s)", ylab[] = "";   // axis labels
    //drawAxes(-tshow, 0, -0.1, 0.1, 1, 1, 0, 0, xlab, ylab);   // not needed?
    glColor4f(0.4, 1.0, 0.6, 1);
    glBegin(GL_LINE_STRIP);
    float x = -tshow;
    int ilo = ai->b_ind-(int)(tshow*ai->rate);
    int ihi = ai->b_ind; // NB get now since capture thread may change it!
    for( int i=ilo; i<ihi; i++ ) {   // graph the most recent piece of buffer
      glVertex2f(x, ai->b[ai->mod(i)]);
      x += ai->dt;   // x time increment
    }
    glEnd();
    glPopMatrix();
  }           // ............................................................

  void slice() // simple graph of spectral slice with log power scale
  {
    glMatrixMode(GL_MODELVIEW);
    glPushMatrix(); // use modelview matrix to xform [-tshow,0]x[-1,1] somewhere
    glTranslatef(0.15,0.11,0);   // decide the location of 0,0 of the graph
    float max_Hz = ai->Hz_per_pixel*ai->n_f;
    glScalef(0.3/max_Hz,0.0015,1.0);  // x-scale for freq-units, y-scale for dB
    glLineWidth(1);
    glColor4f(0.5, 0.4, 0.2, 1);    // lines showing spectrogram color range
    glBegin(GL_LINES);
    float dB_min = -color_scale[0]/color_scale[1];
    float dB_max = (255.0-color_scale[0])/color_scale[1];
    glVertex2f(0,dB_min);glVertex2f(max_Hz,dB_min);
    glVertex2f(0,dB_max);glVertex2f(max_Hz,dB_max);
    glEnd();
    glColor4f(1.0, 0.8, 0.3, 1);   // the graph
    glBegin(GL_LINE_STRIP);
    for( int i=0; i<ai->n_f; i++ )
      glVertex2f(i*ai->Hz_per_pixel, 20*log10(ai->specslice[i]));
    glEnd();
    char xlab[] = "f(Hz)", ylab[] = "I(dB)";   // axis labels
    drawAxes(0-1e-7, max_Hz, -50, 50, 1.0, 1.0, 1, 0, xlab, ylab);
    glPopMatrix();
  }

  void drawAxes(float x0, float x1, float y0, float y1, float xf, float yf, bool box, bool grid, char* xlab, char* ylab)  // draws axes in [x0,x1]x[y0,y1]
  // box: 0 coord axes no box, 1 left-bottom axes no box, 2 box no axes
  // xf, yf are density factors, roughly given by screen size of object.
  // xlab, ylab are labels
  {
    int n_tics, i, len;
    char label[20];
    float tics[100];
    float x_pix_size = 2.0*(x1-x0)/(viewport_size[0]*xf); // fudge fac
    float y_pix_size = 2.0*(y1-y0)/(viewport_size[1]*yf);

    glColor4f(0.7, 1.0, 1.0, 1);
    glDisable(GL_LINE_SMOOTH); glLineWidth(1);
    if (box) { glBegin(GL_LINE_STRIP);  // box and LB axes variants
      glVertex2f(x0,y1); glVertex2f(x0,y0); glVertex2f(x1,y0);
      if (box>1) { glVertex2f(x1,y1); glVertex2f(x0,y1); }
    glEnd();
    } else { glBegin(GL_LINES); // coord axes lines
    glVertex2f(0,y0); glVertex2f(0,y1); glVertex2f(x0,0); glVertex2f(x1,0);
    glEnd(); }
    smallText(x1+8*x_pix_size,y0-8*y_pix_size,xlab); // axes labels
    smallText(x0-8*x_pix_size,y1+8*y_pix_size,ylab);

    n_tics = chooseTics(x0,x1-x0,xf,tics);  // x-axis tics
    float xtic_top = (box==0) ? 0.0 : y0;
    float xtic_bot = xtic_top - 0.02*(y1-y0)/yf;
    glBegin(GL_LINES);
    for (i=0;i<n_tics;++i) {
      glVertex2d(tics[i], xtic_bot); glVertex2d(tics[i], xtic_top);
    }
    glEnd();
    for (i=0;i<n_tics;++i) {
      sprintf(label,"%.6g",tics[i]);
      smallText((float)(tics[i] - 4*strlen(label)*x_pix_size), \
	     (float)(xtic_bot - 12*y_pix_size), label);
    }

    n_tics = chooseTics(y0,y1-y0,yf,tics);  // y-axis tics
    float ytic_top = (box==0) ? 0.0 : x0;
    float ytic_bot = ytic_top - 0.02*(x1-x0)/xf;
    glBegin(GL_LINES);
    for (i=0;i<n_tics;++i) {
      glVertex2d(ytic_bot, tics[i]); glVertex2d(ytic_top, tics[i]);
    }
    glEnd();
    for (i=0;i<n_tics;++i) {
      sprintf(label,"%.6g",tics[i]);
      smallText((float)(ytic_bot - 8*strlen(label)*x_pix_size), \
	     (float)(tics[i] - 4*y_pix_size), label);
    }
  }

  void drawLines(float x0, float x1)  // draws lines in [x0,x1]x{param.freqlines}
  {
    glColor4f(0.7, 1.0, 1.0, 1);
    glDisable(GL_LINE_SMOOTH); glLineWidth(1);
    glBegin(GL_LINES);
    if(param.drawline) {
      for (int n=0; n<param.nfreqlines; ++n) {
	glVertex2d(x0,param.freqline[n]); glVertex2d(x1,param.freqline[n]); // draw line at frequency freqline[n]
      }
    }
    glEnd();
  }

  void drawCentroids(float x0, float x1)  // draws lines in [x0,x1]x{param.freqlines}
  {
    glColor4f(0.7, 1.0, 1.0, 1);
    glDisable(GL_LINE_SMOOTH); glLineWidth(1);
    glBegin(GL_LINES);
    float dt = (x1-x0)/ai->n_tw;
    for (int i=0; i < ai->n_tw; ++i) {
      glVertex2d(x0+i*dt, ai->centroids[i]);
      glVertex2d(x0+(i+1)*dt, ai->centroids[i+1]);
    }
    glEnd();
  }

  void spectrogram() // show spectrogram as 2D pixel array, w/ axes............
  {
    float x0=0.05, y0=0.22;    // bot-left location in viewport (as unit square)
    float currfreq, linefreq;  char str[50];  // for freqind
    int nummults, i, notenum, octave;   // for freqind
    glRasterPos2f(x0,y0);
    glDisable(GL_DEPTH_TEST); glDisable(GL_BLEND);
    //glPixelZoom(1.f,1.f); // zoom: non-integers are quite a bit slower (ie twice), and seems to have permanently worsened the DrawPixels speed by factor 2!
    //glPixelZoom(1.F,2.F);
    //float z; glGetFloatv(GL_ZOOM_Y, &z); printf("%f\n",z); // read a zoom
    if (colormode<2)   // b/w
      glDrawPixels(ai->n_tw, ai->n_f, GL_LUMINANCE, GL_UNSIGNED_BYTE, ai->sgb);
    else
      glDrawPixels(ai->n_tw, ai->n_f, GL_RGB, GL_UNSIGNED_BYTE_3_3_2, ai->sgb);

    //glDrawPixels(ai->n_tw, ai->n_f, GL_RED, GL_UNSIGNED_BYTE, ai->sgb); //test

    // from: http://www.gamedev.net/topic/510914-glcolortable-with-textures/
    //float c[256][3];
    //for (int i=0;i<256;i++) {
    //  c[i][0] = ((float)i)/256;
    //  c[i][1] = 1.0f - ((float)i)/256;
    //  c[i][2] = ((float)i)/256;
    //}
    //glColorTable(GL_COLOR_TABLE, GL_RGB, 256, GL_RGB, GL_FLOAT, c);
    //glEnable(GL_COLOR_TABLE);
    //glDrawPixels(ai->n_tw, ai->n_f, GL_BITMAP,GL_COLOR_INDEX, ai->sgb);
    // fails!

    glMatrixMode(GL_MODELVIEW); glPushMatrix(); // xform axes into right place
    float secs_per_pixel = scroll_fac / 60.0; // (float)fps, or longer FPS mean?
    float max_Hz = ai->Hz_per_pixel*ai->n_f;
    float max_t = secs_per_pixel*ai->n_tw;
    glTranslatef(x0 + (ai->n_tw-run_time/secs_per_pixel)/(float)viewport_size[0], y0, 0);
    glScalef(1.0F/(viewport_size[0]*secs_per_pixel),1.0F/(viewport_size[1]*ai->Hz_per_pixel),1); // makes units match the spectrogram t (scrolling) & freq axes
    // plots now occur in physical t (s) and f (Hz) units, relative to start_t..
    char xlab[] = "t(s)", ylab[] = "f(Hz)";
    drawAxes(run_time-max_t, run_time, 0 - 1e-7, max_Hz, 2.0, 2.0, 2, 0, xlab, ylab);
    drawLines(run_time-max_t, run_time);
    if(param.drawcentroid)
      drawCentroids(run_time-max_t, run_time);
    // 1e-7 is hack to show 0 Hz
    if (freqind) {        // horiz freq readout line, in Hz/sec coords, 1/17/16
      // reverse-engineer the freq from current mouse y in pixels (yuk)...
      currfreq = ai->Hz_per_pixel*(viewport_size[1]*(1-y0)-mouse[1]);
      if (currfreq>0.0) {       // only show if meaningful freq
	nummults = (freqind>1) ? 10 : 1;
	for (i=1;i<=nummults;++i) {      // do either one or many lines
	  linefreq = i*currfreq;
	  if (i==1)
	    glColor4f(0.8, 0.5, 0.0, 1); // orange
	  else
	    glColor4f(0.8, 0.5, 0.0, 1); // darker orange
	  glDisable(GL_LINE_SMOOTH); glLineWidth(1);
	  glBegin(GL_LINES);
	  glVertex2f(run_time-max_t, linefreq);
	  glVertex2f(run_time, linefreq);
	  glEnd();
	  glEnable(GL_BLEND); // text label: overwrite entirely
	  glBlendFunc(GL_ONE, GL_ONE_MINUS_SRC_ALPHA);
	  notenum = (int)roundf(12 * logf(linefreq/261.626)/logf(2.0));
	  octave = 4 + notenum/12; // relies on int division
	  if (octave<0) octave = (int)NAN;
	  sprintf(str, "  %.d   %s%d",(int)roundf(linefreq),notenames[(notenum+1200) % 12],octave);  // use global lookup table of note names
	  smallText(run_time-max_t,linefreq+3.0*ai->Hz_per_pixel,str);
	}
      }
    }
    glPopMatrix();
  }               // .......................................................

  char color_byte(float x)  // convert spectrogram entry to 8bit color char
  // barnett 1/25/15
  {
    float fac = 20.0 * color_scale[1]; // color_scale[1] units: intensity/dB
    int k = (int)(color_scale[0] + fac*log10(x));
    if (k>255) k=255; else if (k<0) k=0;
    if (colormode==0)           // b/w
      return (char)k;
    else if (colormode==1)      // inverse b/w
      return (char)(255-k);
    else if (colormode==2) {    // color (pack into 3_3_2 RGB format) .. SLOW?
      float a = k/255.0f;       // 0<a<1. now map from [0,1] to rgb in [0,1]
      float r = 5*(a-0.2); if (r<0) r=0.0; else if (r>=1) r=.955; // clip
      float g = 5*(a-0.6); if (g<0) g=0.0; else if (g>=1) g=.995;
      float b = 5*a;
      if (a>0.8) b = 5*(a-0.8); else if (a>0.4) b = 5*(0.6-a);
      if (b<0) b=0.0; else if (b>=1) b=.995;
      return (char)(b*4 + 4*((int)(g*8)) + 32*((int)(r*8)));  // pack to 8bits
    }
  }

  void regen_sgb()   // recompute 8bit spectrogram from float spectrogram
  // can only be done at a few FPS, so only do it when color scale changes
  {
    int i, j, n = ai->n_tw;
    for ( i=0; i<n; ++i)  // loop over whole sg array
      for ( j=0; j<ai->n_f; ++j)
	ai->sgb[j*n + i] = color_byte(ai->sg[j*n + i]);
  }

}; //////////////////////////////////////////// END SCENE CLASS ////////////////

static scene scn;    // global scene which contains everything (eg via scn.ai)

int chooseTics(float lo, float range, float fac, float *tics)
/* returns the number of tics, and their locations in zero-indexed tics[].
 * Barnett 99/10/20, single-prec version of ~visu/viewer/viewer.c
 * But, has density fudge factor fac (if 0, chooses default value).
 */
{
    int i, n_tics, tic_start;
    float exponent, logr, spacing;
    if (fac==0.0) fac = 1.0;

    /* adjust the range multiplier here to give good tic density... */
    logr = log10(range * 0.4 / fac);
    exponent = floor(logr);
    spacing = pow(10.0, exponent);
    if (logr-exponent > log10(5.0))
        spacing *= 5.0;
    else if (logr-exponent > log10(2.0))
        spacing *= 2.0;

    /* (int) and copysign trick is to convert the floor val to an int... */
    tic_start = (int)(copysign(0.5,lo) + 1.0 + floor(lo / spacing));

    n_tics = (int)(1.0 + (lo + range - tic_start*spacing)/spacing);
    for (i=0;i<n_tics;++i) {
        tics[i] = spacing * (tic_start + i);
    }
    return n_tics;
}

void drawText()       // Medical text and other text overlays................
{
  glEnable (GL_BLEND); // glBlendFunc (GL_ONE,GL_ZERO); // overwrite entirely
  glBlendFunc(GL_ONE, GL_ONE_MINUS_SRC_ALPHA);

  glColor4f(1, .4, .4, 1.0); // write FPS, other params... coords in unit square
  char str[50]; sprintf(str, "%d FPS",scn.fps); smallText(0.92,0.96,str);
  sprintf(str, "gain offset %.0f dB",scn.color_scale[0]);
  smallText(0.02,0.04,str);
  sprintf(str, "dyn range  %.1f dB",255.0/scn.color_scale[1]);
  smallText(0.02,0.02,str);

  if (scn.diagnose) {  // show diagnosis
    glColor4f(.2, .2, .2, 0.8);  // transparent box
    glMatrixMode(GL_MODELVIEW);
    glPushMatrix(); // use modelview matrix to xform unit square to text box
      glTranslatef(0.5,0.5,0); glScalef(0.5,0.4,1); glTranslatef(-0.5,-0.5,0);
      glBegin(GL_POLYGON);
      glVertex2f(0,0); glVertex2f(1,0); glVertex2f(1,1); glVertex2f(0,1); glVertex2f(0,0); // unit square
      glEnd();
      glColor4f(1, 1, 1, 1);                  // text
      drawText(0.2, 0.5, scn.diagnosis); // coords relative to box as unit sq
    glPopMatrix();
  }
}

void display()  //  GLUT's display routine: 2D layering by write order
{
  glClear(GL_COLOR_BUFFER_BIT); // no depth buffer

  glMatrixMode(GL_PROJECTION);
  glLoadIdentity();
  glOrtho(0, 1, 0, 1, -1, 1);  // l r b t n f
  glMatrixMode(GL_MODELVIEW);
  glLoadIdentity();
  scn.graph();      // simple graph of signal
  scn.slice();   // spectral slice
  scn.spectrogram();   // note, overlays the signal and spectrum graphs
  drawText();    // overlaid
  // glFinish();   // wait for all gl commands to complete

  glutSwapBuffers(); // for this to WAIT for vSync, need enable in NVIDIA OpenGL
}

void computespecslice(audioInput *ai)   // windowed spectral slice!
  {
    int N = ai->win_size;             // transform length
    int nf = ai->n_f;              // # freqs to fill in powerspec

    if (0)
      for ( int i=0; i<nf; ++i )     // dummy just copy last n_f samples
	ai->specslice[i] = 100.0 * ai->b[ai->mod(ai->b_ind - nf + i)];

    else {                      // actual windowed power spectrum
      for ( int i=0; i<N; ++i )     // copy last N samples & mult by window func
	ai->bwin[i] = ai->winf[i] * ai->b[ai->mod(ai->b_ind - N + i)];

      fftwf_execute(ai->fftw_p); // do the already-planned fft

      if (nf>N/2) {fprintf(stderr,"window too short cf n_f!\n"); return;}
      ai->specslice[0] = ai->bwin[0]*ai->bwin[0];  // zero-freq has no imag
      for ( int i=1; i<nf; ++i )     // compute power spectrum from hc dft
	ai->specslice[i] = ai->bwin[i]*ai->bwin[i] + ai->bwin[N-i]*ai->bwin[N-i];
    }
  }

void scroll_sg(audioInput *ai, float *newcol, float *centroids)
// Scroll spectrogram data 1 pixel in t direction, add new col & make 8bit
{
  int i, j, n = ai->n_tw;

  for ( i=0; i<n; ++i)    // float: NB x (ie t) is the fast storage direc
    for ( j=0; j<ai->n_f; ++j)
      ai->sg[j*n + i] = ai->sg[j*n + i + 1];

  for ( i=0; i<n; ++i)    // scroll the 8bit char data too
    for ( j=0; j<ai->n_f; ++j)
      ai->sgb[j*n + i] = ai->sgb[j*n + i + 1];

  for ( i=0; i<n; ++i)
    centroids[i] = centroids[i+1];

  // Calculate the new centroid
  float num = 0;
  float denom = 0;
  float curr_freq;
  for (j=0; j<ai->n_f; ++j) {
    curr_freq = ai->Hz_per_pixel * j; // frequency whose amplitude is newcol[j]
    denom += newcol[j];
    num += newcol[j] * curr_freq;
  }
  float centroid = num / denom;
  centroids[n] = centroid;

  for ( j=0; j<ai->n_f; ++j) {   // set the last col of float data
    ai->sg[j*n + n - 1] = newcol[j];
  }

  for ( j=0; j<ai->n_f; ++j) {        // color xform for last col of 8bit data
    ai->sgb[j*n + n - 1] = scn.color_byte(newcol[j]);
  }
}

// --------------------------- IDLE FUNC ------------------------------------
void idle(void)   //    put numerical intensive part here? only scrolling
{
  ++scn.frameCount;        // compute FPS...
  time_t now = time(NULL);     // integer in seconds
  if (now>scn.fps_tic) {    // advanced by at least 1 sec?
    scn.fps = scn.frameCount;
    scn.frameCount = 0;
    scn.fps_tic = now;
  }

  if (!scn.ai->pause) {  // scroll every scroll_fac vSyncs, if not paused:
    timeval nowe;  // update runtime
    gettimeofday(&nowe, NULL);
    //scn.run_time = timeDiff(scn.start_time, nowe);  // update run_time data
    scn.run_time += 1/60.0;        // is less jittery, approx true
    scn.run_time = fmod(scn.run_time, 100.0);    // wrap time label after 100 secs

    ++scn.scroll_count;
    if (scn.scroll_count==scn.scroll_fac) {
      scroll_sg(scn.ai, scn.ai->specslice, scn.ai->centroids);   // add spec slice to sg & scroll
      scn.scroll_count = 0;
    }
  }

  glutPostRedisplay();  // trigger GLUT display func
}

void keyboard(unsigned char key, int xPos, int yPos)
{
  if( key == 27 || key == 'q') {  // esc or q to quit
    scn.ai->quitNow();
    exit(0);
  } else if( key == ' ' ) {
    scn.pause = ! scn.pause;
    scn.ai->pause = ! scn.ai->pause;
  } else if( key == 'd' ) {
    scn.diagnose = ! scn.diagnose;         // toggle text overlay
  } else if( key == ']' ) {               // speed up scroll rate
    if (scn.scroll_fac>1) {scn.scroll_fac--; scn.scroll_count=0; }
  } else if( key == '[' ) {
    if (scn.scroll_fac<50) scn.scroll_fac++;
  } else if( key == 'i' ) {
    scn.colormode = (scn.colormode + 1) % 3;     // spectrogram color scheme
    scn.regen_sgb();
  } else {
    fprintf(stderr, "pressed key %d\n", (int)key);
  }
}

void special(int key, int xPos, int yPos) {  // special key handling
  if( key == 102 ) { // rt
    scn.color_scale[1] *= 1.5; scn.regen_sgb(); // contrast
  } else if( key == 100 ) { // lt
    scn.color_scale[1] /= 1.5; scn.regen_sgb(); // contrast
  } else if( key == 103 ) { // dn
    scn.color_scale[0] -= 20; scn.regen_sgb();  // brightness
  } else if( key == 101 ) { // up
    scn.color_scale[0] += 20; scn.regen_sgb();  // brightness
  } else {
    fprintf(stderr, "pressed special key %d\n", key);
  }
}

void reshape(int w, int h) // obsolete in game mode
{
  scn.viewport_size[0] = w;
  scn.viewport_size[1] = h;
  if (verb) fprintf(stderr, "Setting w=%d, h=%d\n", w, h);
  glViewport(0, 0, w, h);
}

void mouse(int button, int state, int x, int y)
{
  scn.mouse[0] = x;  // this seems to be needed for correct panning
  scn.mouse[1] = y;
  scn.mouse[2] = button;
  if (verb) printf("Mouse event: button: %d  state: %d  pos: %d, %d\n", button, state, x, y);
  if (button==GLUT_LEFT_BUTTON && state==GLUT_DOWN) scn.freqind = 1; // toggle
  if (button==GLUT_LEFT_BUTTON && state==GLUT_UP) scn.freqind = 0;
  if (button==GLUT_RIGHT_BUTTON && state==GLUT_DOWN) scn.freqind = 2; // toggle w/ freq multiples shown
  if (button==GLUT_RIGHT_BUTTON && state==GLUT_UP) scn.freqind = 0;
  if (button==GLUT_MIDDLE_BUTTON && state==GLUT_UP) scn.regen_sgb();
}

void motion(int x, int y) // handles mouse drag effects
{
  int dx = (int)(x-scn.mouse[0]);
  int dy = (int)(y-scn.mouse[1]);
  if( scn.mouse[2] == GLUT_MIDDLE_BUTTON ) {   // controls color scale
    scn.color_scale[0] += dx/5.0;  // brightness
    scn.color_scale[1] *= exp(-dy/200.0); // contrast
  }
  scn.mouse[0] = x;
  scn.mouse[1] = y;
}

const char *helptext[] = {
  " Simple Spectrogram: real-time OpenGL spectrogram.\n",
  "                                         (based on Alex Barnett glSpect, Dec 2010 and Luke Campagnola glScope)\n\n",
  "Usage: sspect  [-f] [-v] [-d <device_number>] [-sf <scroll_factor>] [-w <windowtype>] [-t twowinsize] [-fl freqline] [-c]\n\n",
  "Command line arguments:\n",
  "-f fullscreen\n",
  "-v verbose mode\n",
  "device_number = 0,1,... the ALSA input device number (default 0)\n",
  "windowtype = \t0 (no window)\n\t\t1 (Hann)\n\t\t2 (Gaussian trunc at +-4sigma) (default)\n",
  "scroll_factor = 1,2,... # vSyncs (60Hz) to wait per scroll pixel (default 1)\n",
  "twowinsize = 11,12,...,16 is power of 2 giving FFT win_size N (default 12)\n\t(Note: this controls the vertical frequency resolution and range)\n",
  "freqline   draws at line at frequency freqline. Several -fl options can be used to draw several lines\n",
  "-c draws the centroid line\n\n",
  "Keys & mouse: \tarrows or middle button drag - brightness/contrast\n",
  "\t\tleft button shows horizontal frequency readoff line\n",
  "\t\tright button shows horizontal frequency readoff with multiples\n",
  "\t\ti - cycles through color maps (B/W, inverse B/W, color)\n",
  "\t\tq or Esc - quit\n",
  "\t\t[ and ] - control horizontal scroll factor (rate)\n",
  NULL };

// ===========================================================================
int main(int argc, char** argv)
{
  int scrnmode = 0;  // 0 for window, 1 fullscreen       **Defaults go here**
  verb = 0;          // 0 silent, 1 debug, etc
  scn.scroll_fac = 2;    // how many vSyncs to wait before scrolling sg
  param.devicenumber = 0; // ALSA input device number
  param.windowtype = 2;  // Gaussian
  param.twowinsize = 12; // 4096 samples
  param.drawcentroid = false;

  for (int i=1; i<argc; ++i) {  // .....Parse cmd line options....
    if (!strcmp(argv[i], "-f"))  // option -f makes full screen
      scrnmode = 1;
    else if (!strcmp(argv[i], "-v"))  // option -v makes verbose
      verb = 1;
    else if (!strcmp(argv[i], "-sf")) {
      sscanf(argv[++i], "%d", &scn.scroll_fac);  // read in scroll factor
      if (scn.scroll_fac<1) scn.scroll_fac=1; // sanitize it
    } else if (!strcmp(argv[i], "-t")) {
      sscanf(argv[++i], "%d", &param.twowinsize);
      if (param.twowinsize<10) param.twowinsize=10; // sanitize it
      if (param.twowinsize>18) param.twowinsize=18;
    } else if (!strcmp(argv[i], "-w")) {
      sscanf(argv[++i], "%d", &param.windowtype);  // read in windowtype
      if (param.windowtype<0) param.windowtype=0; // sanitize it
    } else if (!strcmp(argv[i], "-d")) {
      sscanf(argv[++i], "%d", &param.devicenumber);  // read in devicenumber
      if (param.devicenumber<0) param.devicenumber=0; // sanitize it
    } else if (!strcmp(argv[i], "-fl")) {
      sscanf(argv[++i], "%f", &param.freqline[param.nfreqlines]);  // read in at which frequency to draw a line
      param.drawline = true;
      param.nfreqlines++;
    } else if (!strcmp(argv[i], "-c")) {
      param.drawcentroid = true;
    } else {            // misuse (or -h): print out usage text...
      fprintf(stderr, "bad command line option %s\n\n", argv[i]);
      for (int i=0; helptext[i]; i++) fprintf(stderr, "%s", helptext[i]);
      exit(1);
    }
  }
  scn.init();       // true constructor for global scn object

  glutInit(&argc, argv);
  glutInitDisplayMode(GLUT_DOUBLE | GLUT_RGBA);
  if (scrnmode==1) {  // implement desired screen mode
    //glutGameModeString( "1680x1050:24@60" ); // res, pixel depth, refresh
    glutGameModeString( "1024x768:24@60" ); // for XGA projector
    glutEnterGameMode();                     // start fullscreen game mode
  } else {
    glutInitWindowSize(1024, 768);  // window same size as XGA
    int mainWindow = glutCreateWindow("sspect");
    //  glutFullScreen();    // maximizes window, but is not game mode
  }

  glutDisplayFunc(display);
  glutReshapeFunc(reshape);
  glutKeyboardFunc(keyboard);
  glutSpecialFunc(special);
  glutMouseFunc(mouse);
  glutMotionFunc(motion);
  glutIdleFunc(idle);

  glutMainLoop();        // pass control to GLUT
  return 0;
}

repo_name: emily/sspect

license: unknown


code:
#!/bin/sh

#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

##############################################################################
#
#   Gradle start up script for POSIX generated by Gradle.
#
#   Important for running:
#
#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
#       noncompliant, but you have some other compliant shell such as ksh or
#       bash, then to run this script, type that shell name before the whole
#       command line, like:
#
#           ksh Gradle
#
#       Busybox and similar reduced shells will NOT work, because this script
#       requires all of these POSIX shell features:
#         * functions;
#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
#         * compound commands having a testable exit status, especially «case»;
#         * various built-in commands including «command», «set», and «ulimit».
#
#   Important for patching:
#
#   (2) This script targets any POSIX shell, so it avoids extensions provided
#       by Bash, Ksh, etc; in particular arrays are avoided.
#
#       The "traditional" practice of packing multiple parameters into a
#       space-separated string is a well documented source of bugs and security
#       problems, so this is (mostly) avoided, by progressively accumulating
#       options in "$@", and eventually passing that to Java.
#
#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
#       see the in-line comments for details.
#
#       There are tweaks for specific operating systems such as AIX, CygWin,
#       Darwin, MinGW, and NonStop.
#
#   (3) This script is generated from the Groovy template
#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
#       within the Gradle project.
#
#       You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################

# Attempt to set APP_HOME

# Resolve links: $0 may be a link
app_path=$0

# Need this for daisy-chained symlinks.
while
    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
    [ -h "$app_path" ]
do
    ls=$( ls -ld "$app_path" )
    link=${ls#*' -> '}
    case $link in             #(
      /*)   app_path=$link ;; #(
      *)    app_path=$APP_HOME$link ;;
    esac
done

# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum

warn () {
    echo "$*"
} >&2

die () {
    echo
    echo "$*"
    echo
    exit 1
} >&2

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in                #(
  CYGWIN* )         cygwin=true  ;; #(
  Darwin* )         darwin=true  ;; #(
  MSYS* | MINGW* )  msys=true    ;; #(
  NONSTOP* )        nonstop=true ;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar

# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
        # IBM's JDK on AIX uses strange locations for the executables
        JAVACMD=$JAVA_HOME/jre/sh/java
    else
        JAVACMD=$JAVA_HOME/bin/java
    fi
    if [ ! -x "$JAVACMD" ] ; then
        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME

Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
    fi
else
    JAVACMD=java
    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.

Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
    case $MAX_FD in #(
      max*)
        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
        # shellcheck disable=SC3045
        MAX_FD=$( ulimit -H -n ) ||
            warn "Could not query maximum file descriptor limit"
    esac
    case $MAX_FD in  #(
      '' | soft) :;; #(
      *)
        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
        # shellcheck disable=SC3045
        ulimit -n "$MAX_FD" ||
            warn "Could not set maximum file descriptor limit to $MAX_FD"
    esac
fi

# Collect all arguments for the java command, stacking in reverse order:
#   * args from the command line
#   * the main class name
#   * -classpath
#   * -D...appname settings
#   * --module-path (only if needed)
#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.

# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )

    JAVACMD=$( cygpath --unix "$JAVACMD" )

    # Now convert the arguments - kludge to limit ourselves to /bin/sh
    for arg do
        if
            case $arg in                                #(
              -*)   false ;;                            # don't mess with options #(
              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
                    [ -e "$t" ] ;;                      #(
              *)    false ;;
            esac
        then
            arg=$( cygpath --path --ignore --mixed "$arg" )
        fi
        # Roll the args list around exactly as many times as the number of
        # args, so each arg winds up back in the position where it started, but
        # possibly modified.
        #
        # NB: a `for` loop captures its iteration list before it begins, so
        # changing the positional parameters here affects neither the number of
        # iterations, nor the values presented in `arg`.
        shift                   # remove old arg
        set -- "$@" "$arg"      # push replacement arg
    done
fi

# Collect all arguments for the java command;
#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
#     shell script including quotes and variable substitutions, so put them in
#     double quotes to make sure that they get re-expanded; and
#   * put everything else in single quotes, so that it's not re-expanded.

set -- \
        "-Dorg.gradle.appname=$APP_BASE_NAME" \
        -classpath "$CLASSPATH" \
        org.gradle.wrapper.GradleWrapperMain \
        "$@"

# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
    die "xargs is not available"
fi

# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
#   set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#

eval "set -- $(
        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
        xargs -n1 |
        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
        tr '\n' ' '
    )" '"$@"'

exec "$JAVACMD" "$@"

path: gradlew


code:
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem      https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem

@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem  Gradle startup script for Windows
@rem
@rem ##########################################################################

@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal

set DIRNAME=%~dp0
if "%DIRNAME%"=="" set DIRNAME=.
@rem This is normally unused
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%

@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi

@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"

@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome

set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if %ERRORLEVEL% equ 0 goto execute

echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.

goto fail

:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe

if exist "%JAVA_EXE%" goto execute

echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.

goto fail

:execute
@rem Setup the command line

set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar

@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*

:end
@rem End local scope for the variables with windows NT shell
if %ERRORLEVEL% equ 0 goto mainEnd

:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
set EXIT_CODE=%ERRORLEVEL%
if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%

:mainEnd
if "%OS%"=="Windows_NT" endlocal

:omega


code:
plugins {
    id("org.jetbrains.kotlin.jvm") version "1.8.10"
    id("maven-publish")
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")

    testImplementation("org.junit.jupiter:junit-jupiter-engine:5.9.1")

    api("org.apache.commons:commons-math3:3.6.1")

    implementation("com.google.guava:guava:31.1-jre")
}

tasks.named<Test>("test") {
    useJUnitPlatform()
}

group = "org.example"
version = "1.0"

publishing {
    publications {
        create<MavenPublication>("myLibrary") {
            from(components["java"])
        }
    }

    repositories {
        maven {
            name = "myRepo"
            url = uri(layout.buildDirectory.dir("repo"))
        }
    }
}


code:
/*
 * This Kotlin source file was generated by the Gradle 'init' task.
 */
package reverso.context

class LibraryClass {
    fun someLibraryMethod(): Boolean {
        return true
    }
    fun test(): Int{
        return 42
    }
}


code:
/*
 * This Kotlin source file was generated by the Gradle 'init' task.
 */
package reverso.context

import kotlin.test.Test
import kotlin.test.assertTrue

class LibraryTest {
    @Test fun someLibraryMethodReturnsTrue() {
        val classUnderTest = LibraryClass()
        assertTrue(classUnderTest.someLibraryMethod(), "someLibraryMethod should return 'true'")
    }
}


code:
/*
 * This file was generated by the Gradle 'init' task.
 *
 * The settings file is used to specify which projects to include in your build.
 *
 * Detailed information about configuring a multi-project build in Gradle can be found
 * in the user manual at https://docs.gradle.org/8.0/userguide/multi_project_builds.html
 * This project uses @Incubating APIs which are subject to change.
 */

rootProject.name = "reverso-context"
include("lib")


code:
# biu

#### Description
{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**}

#### Software Architecture
Software architecture description

#### Installation

1.  xxxx
2.  xxxx
3.  xxxx

#### Instructions

1.  xxxx
2.  xxxx
3.  xxxx

#### Contribution

1.  Fork the repository
2.  Create Feat_xxx branch
3.  Commit your code
4.  Create Pull Request

#### Gitee Feature

1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
4.  The most valuable open source project [GVP](https://gitee.com/gvp)
5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)


code:
# biu

#### 介绍
{**以下是 Gitee 平台说明，您可以替换此简介**
Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台
无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}

#### 软件架构
软件架构说明

#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

1.  xxxx
2.  xxxx
3.  xxxx

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request

#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)


自定义LIBVIO接口

jiequqian: 空

jiequhou: 空

jiequshuzuqian: data

tupianqian: original="

biaotiqian: title="

lianjieqian: href="

sousuohouzhui: /detail/

jspic: pic

jsname: name

jsid: id

ssjiequqian: 空

ssjiequhou: 空

ssjiequshuzuqian: 空

ssjiequshuzuhou: 空

sstupianqian: 空

sstupianhou: 空

ssbiaotiqian: 空

ssbiaotihou: 空

sslianjieqian: 空

sslianjiehou: 空

bfjiequqian: 空

bfjiequhou: 空

zhuangtaiqian: class="data">总集数：

daoyanqian: class="data">类型：

zhuyanqian: class="data">主演：

juqingqian: class="detail-content"

juqinghou: </span>

bfyjiequqian: 空

bfyjiequhou: 空

bfyjiequshuzuqian: <a

bflianjieqian: href="


wuqu: 空

xiqu: 空

bizhi: 空

qupu: 空

porn

[User] 空

jiequshuzuqian: class="module-item">

jiequshuzuhou: </div>

sousuohouzhui: /voddetail/

bfjiequshuzuqian: class="video-holder"

bfjiequshuzuhou: </div>

zhuangtaiqian: 状态：</span>

daoyanqian: 导演：</span>

zhuyanqian: 演员：</span>

juqingqian: class="sp2 title"


yjzd

houzhui: .html

jiequshuzuqian: class="stui-vodlist__thumb lazyload"

juqingqian: <p> 更新：


自定义LIBVIO接口

tupianqian: data-original="


自定义555资源

jiequqian: <ul class="myui-vodlist

jiequshuzuqian: lazyload

jiequshuzuhou: </span>

bfjiequshuzuqian: id="playlist

zhuangtaiqian: 更新：</span>

zhuyanqian: 主演：</span>

juqingqian: class="data" style="display: none;">


自定义mozhatu资源

jiequshuzuqian: class="pic"

tupianqian: lay-src="

biaotiqian: class="name"

biaotihou: </div>

bfjiequshuzuqian: id="zu

juqingqian: 简介：</span>

juqinghou: </div>


pianba

bfjiequshuzuqian: class="play-btn hidden-xs"

juqingqian: style="display: none;">


十里桃花

jiequshuzuqian: <div class="item">

jiequshuzuhou: </strong>

tupianqian: src="

biaotiqian: alt="

bfjiequshuzuqian: <div class="video-holder">

zhuangtaiqian: <p>類型：


code:
*.sw[op]
key_*.pem
data/*
config/*
static/media/*

.mypy_cache/
__pycache__/

repo_name: nipos/nikisoftblog

path: .gitignore

license: mit


code:
[submodule "poussetaches"]
	path = poussetaches
	url = https://github.com/tsileo/poussetaches

path: .gitmodules


code:
.SILENT: install pt-install services config password
PYTHON=python

install:
	echo "Setting up Python Virtualenv..."
	virtualenv env
	$$(source env/bin/activate)
	echo "Installing dependencies..."
	pip install -r requirements.txt
	echo "done"

pt-install:
	printf "Installing poussetaches..."
	cp -R poussetaches /usr/bin/poussetaches
	echo "done"

services:
	./mkservices.sh

config:
	./mkconfig.sh

password:
	$(PYTHON) -c "import bcrypt; from getpass import getpass; print(bcrypt.hashpw(getpass().encode('utf-8'), bcrypt.gensalt()).decode('utf-8'))"
	echo "Please copy this code into the 'pass' variable in config/me.yml"

path: Makefile


code:
# microblog.pub - Nikisoft edition

A self-hosted, single-user, ActivityPub powered microblog.

**Quite early state but already stable enough for hosting your blog**
## Features

 - Implements a basic [ActivityPub](https://activitypub.rocks/) server (with federation)
   - Compatible with [Mastodon](https://github.com/tootsuite/mastodon) and others (Pleroma, Hubzilla...)
   - Also implements a remote follow compatible with Mastodon instances
 - Exposes your outbox as a basic microblog
 - Implements [IndieAuth](https://indieauth.spec.indieweb.org/) endpoints (authorization and token endpoint)
   - U2F support
   - You can use your ActivityPub identity to login to other websites/app
 - Comes with an admin UI with notifications and the stream of people you follow
 - Allows you to attach files to your notes
   - Privacy-aware image upload endpoint that strip EXIF meta data before storing the file
 - Microformats aware (exports `h-feed`, `h-entry`, `h-cards`, ...)
 - Exports RSS/Atom/[JSON](https://jsonfeed.org/) feeds
    - You stream/timeline is also available in an (authenticated) JSON feed
 - Comes with a tiny HTTP API to help posting new content and and read your inbox/notifications
 - Easy to "cache" (the external/public-facing microblog part)
   - With a good setup, cached content can be served most of the time
   - You can setup a "purge" hook to let you invalidate cache when the microblog was updated
 - Deployable with Docker (Docker compose for everything: dev, test and deployment)

## ActivityPub

microblog.pub implements an [ActivityPub](http://activitypub.rocks/) server, it implements both the client to server API and the federated server to server API.

Activities are verified using HTTP Signatures or by fetching the content on the remote server directly.

## Running your instance

### Dependencies

Please make sure that you have the following software installed when starting the installation:
- Python 3
- Python 3 Virtualenv
- Go
- MongoDB

### Installation

```shell
$ git clone https://notabug.org/nipos/nikisoftblog
$ cd nikisoftblog
$ make install
$ sudo make pt-install
$ make config
$ make password
$ sudo make services
$ sudo systemctl enable poussetaches
$ sudo systemctl start poussetaches
$ sudo systemctl enable microblog
$ sudo systemctl start microblog
```

### Configuration

```shell
$ make password
Password: <enter a password; nothing will show on screen>
$2b$12$iW497g...
```

Edit `config/me.yml` to add the above-generated password, like so:

```
username: 'username'
name: 'Your Name'
icon_url: 'https://you-avatar-url'
domain: 'your-domain.tld'
summary: 'your summary'
https: true
pass: $2b$12$iW497g...
```

## API

Your admin API key can be found at `config/admin_api_key.key`.

## ActivityPub API

### GET /

Returns the actor profile, with links to all the "standard" collections.

### GET /tags/:tag

Special collection that reference notes with the given tag.

### GET /stream

Special collection that returns the stream/inbox as displayed in the UI.

## User API

The user API is used by the admin UI (and requires a CSRF token when used with a regular user session), but it can also be accessed with an API key.

All the examples are using [HTTPie](https://httpie.org/).

### POST /api/note/delete{?id}

Deletes the given note `id` (the note must from the instance outbox).

Answers a **201** (Created) status code.

You can pass the `id` via JSON, form data or query argument.

#### Example

```shell
$ http POST https://microblog.pub/api/note/delete Authorization:'Bearer <token>' id=http://microblob.pub/outbox/<note_id>/activity
```

#### Response

```json
{
    "activity": "https://microblog.pub/outbox/<delete_id>"
}
```

### POST /api/note/pin{?id}

Adds the given note `id` (the note must from the instance outbox) to the featured collection (and pins it on the homepage).

Answers a **201** (Created) status code.

You can pass the `id` via JSON, form data or query argument.

#### Example

```shell
$ http POST https://microblog.pub/api/note/pin Authorization:'Bearer <token>' id=http://microblob.pub/outbox/<note_id>/activity
```

#### Response

```json
{
    "pinned": true
}
```

### POST /api/note/unpin{?id}

Removes the given note `id` (the note must from the instance outbox) from the featured collection (and un-pins it).

Answers a **201** (Created) status code.

You can pass the `id` via JSON, form data or query argument.

#### Example

```shell
$ http POST https://microblog.pub/api/note/unpin Authorization:'Bearer <token>' id=http://microblob.pub/outbox/<note_id>/activity
```

#### Response

```json
{
    "pinned": false
}
```

### POST /api/like{?id}

Likes the given activity.

Answers a **201** (Created) status code.

You can pass the `id` via JSON, form data or query argument.

#### Example

```shell
$ http POST https://microblog.pub/api/like Authorization:'Bearer <token>' id=http://activity-iri.tld
```

#### Response

```json
{
    "activity": "https://microblog.pub/outbox/<like_id>"
}
```

### POST /api/boost{?id}

Boosts/Announces the given activity.

Answers a **201** (Created) status code.

You can pass the `id` via JSON, form data or query argument.

#### Example

```shell
$ http POST https://microblog.pub/api/boost Authorization:'Bearer <token>' id=http://activity-iri.tld
```

#### Response

```json
{
    "activity": "https://microblog.pub/outbox/<announce_id>"
}
```

### POST /api/block{?actor}

Blocks the given actor, all activities from this actor will be dropped after that.

Answers a **201** (Created) status code.

You can pass the `id` via JSON, form data or query argument.

#### Example

```shell
$ http POST https://microblog.pub/api/block Authorization:'Bearer <token>' actor=http://actor-iri.tld/
```

#### Response

```json
{
    "activity": "https://microblog.pub/outbox/<block_id>"
}
```

### POST /api/follow{?actor}

Follows the given actor.

Answers a **201** (Created) status code.

You can pass the `id` via JSON, form data or query argument.

#### Example

```shell
$ http POST https://microblog.pub/api/follow Authorization:'Bearer <token>' actor=http://actor-iri.tld/
```

#### Response

```json
{
    "activity": "https://microblog.pub/outbox/<follow_id>"
}
```

### POST /api/new_note{?content,reply}

Creates a new note. `reply` is the IRI of the "replied" note if any.

Answers a **201** (Created) status code.

You can pass the `content` and `reply` via JSON, form data or query argument.

#### Example

```shell
$ http POST https://microblog.pub/api/new_note Authorization:'Bearer <token>' content=hello
```

#### Response

```json
{
    "activity": "https://microblog.pub/outbox/<create_id>"
}
```

### GET /api/stream

#### Example

```shell
$ http GET https://microblog.pub/api/stream Authorization:'Bearer <token>'
```

#### Response

```json
```