CreatBot/CreatBotCrowsnest
CreatBot/CreatBotCrowsnest
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial Commit

Browse Source 
Signed-off-by: Stephan Wendel <me@stephanwe.de>
This commit is contained in:
Stephan Wendel 2021-10-27 18:07:39 +02:00
commit b55ff454fc
17 changed files with 2286 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.gitignore vendored Normal file
View File

@ -0,0 +1,12 @@
# Ignore ustreamer static for now.
ustreamer-www/
#Ignore ERRORS.txt
ERRORS.txt
# Ignore leftover
leftover*
#Ignore Test Files
test*

674
LICENSE Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

196
README.md Normal file
View File

@ -0,0 +1,196 @@
# crowsnest
A webcam daemon for Raspi Lite images like mainsailOS
---
It inherited his name from Sail ships Crow's nest.
---
> A crow's nest is a structure in the upper part of the main mast of a ship or a structure that is used as a lookout point.\
See https://en.wikipedia.org/wiki/Crow's_nest
So, this will be the 'lookout point' for your Printer.
### Install on MainsailOS 0.5.0 as update
cd ~
git clone https://github.com/mainsail-crew/crowsnest.git
cd webcamtest
./installer_ms050.sh
An installer for other Distribution than MainsailOS will come.
Give me some time to prepare!
_NOTE: This project has WIP Status! Changes may occure and possibly break things!_
---
---
## Simple Configuration
---
All you need to get your Camera up and running is a small block of code in your _webcam.conf_\
In MainsailOS you can do that in mainsail Web Interface.\
Open the 'config' section, there should be the mentioned file.
By default it look like this:
[webcamd]
log_path: ~/klipper_logs/webcamd.log
debug_log: false
[cam 1]
streamer: mjpg
port: 8080
device: /dev/video0
resolution: 640x480
max_fps: 15
What that basicly means is:
log_path: ~/klipper_logs/webcamd.log
Where crowsnest (webcamd) should store its Logfile.
debug_log: false
You can set this to true or false.\
In case of true you get an more verbose output in the log file.
Useful to DEBUG your setup.
Now the more interessting part.
[cam 1]
streamer: mjpg
port: 8080
device: /dev/video0
resolution: 640x480
max_fps: 15
> _Note: You can name the cam, how you want!_\
_ex.: [cam raspicam]_
---
This section should be pretty much self explantory.
streamer: mjpg
means your choosen streamservice will be mjpg_streamer.\
You can choose:
- mjpg - well known [Jacksonliam's mjpg-streamer-experimental](https://github.com/jacksonliam/mjpg-streamer)
- ustreamer - A streamserver from Pi-KVM Project\
active maintained by [Maxim Devaev](https://github.com/mdevaev)\
[ustreamer on github](https://github.com/pikvm/ustreamer)
- rtsp - v4l2rtspserver with Multiprotocol Support\
active maintained by [Michel Promonet](https://github.com/mpromonet) \
[v4l2rtspserver on github](https://github.com/mpromonet/v4l2rtspserver)
More Services will come in the (hopefully, near) future.
---
port: 8080
The port where the choosen service will listen on\
**_NOTE: If you choose 'rtsp' use Port 8554!_**
**_NOTE: Ports 8080 - 8084 are covered by nginx reverse proxy! \
According to that 8080 will be /webcam, port 8081 will be /webcam1 and so on._**
---
device: /dev/video0
The Videodevice (Camera) what should be used by choosen Streamservice.
device: /dev/v4l/by-id/usb-PixArt_Imaging_Inc._USB2.0_Camera-video-index0
is also valid. Your devices are listed in your log-file on every run.\
So, you can easily copy it from there.
---
resolution: 640x480
max_fps: 15
This last 2 should be pretty obvious :)
---
There are two more existing parameters,
log_method: debug
**This parameter _has_ to reside under [webcamd] section!**
This forces webcamd to spit out more camera informations.\
Like that:
[10/24/21 02:46:00] webcamd: INFO: Detect available Cameras
[10/24/21 02:46:00] webcamd: INFO: Found 1 available Camera(s)
[10/24/21 02:46:00] webcamd: Detected 'Raspicam' Device -> /dev/video0
[10/24/21 02:46:00] webcamd: Supported Formats:
[10/24/21 02:46:00] webcamd: [0]: 'YU12' (Planar YUV 4:2:0)
[10/24/21 02:46:01] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:01] webcamd: [1]: 'YUYV' (YUYV 4:2:2)
[10/24/21 02:46:01] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:01] webcamd: [2]: 'RGB3' (24-bit RGB 8-8-8)
[10/24/21 02:46:01] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:01] webcamd: [3]: 'JPEG' (JFIF JPEG, compressed)
[10/24/21 02:46:01] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:01] webcamd: [4]: 'H264' (H.264, compressed)
[10/24/21 02:46:01] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:02] webcamd: [5]: 'MJPG' (Motion-JPEG, compressed)
[10/24/21 02:46:02] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:02] webcamd: [6]: 'YVYU' (YVYU 4:2:2)
[10/24/21 02:46:02] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:02] webcamd: [7]: 'VYUY' (VYUY 4:2:2)
[10/24/21 02:46:02] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:02] webcamd: [8]: 'UYVY' (UYVY 4:2:2)
[10/24/21 02:46:02] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:02] webcamd: [9]: 'NV12' (Y/CbCr 4:2:0)
[10/24/21 02:46:03] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:03] webcamd: [10]: 'BGR3' (24-bit BGR 8-8-8)
[10/24/21 02:46:03] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:03] webcamd: [11]: 'YV12' (Planar YVU 4:2:0)
[10/24/21 02:46:03] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:03] webcamd: [12]: 'NV21' (Y/CrCb 4:2:0)
[10/24/21 02:46:03] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
[10/24/21 02:46:03] webcamd: [13]: 'RX24' (32-bit XBGR 8-8-8-8)
[10/24/21 02:46:03] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
This is useful to determine what the Hardware Encoder of your Camera is capable of.\
In this case a "cheap" raspicam for about 7€ was used.\
But it has a downside, everytime you restart webcamd, it will delete the Logfile!
So, truly made for Debugging purposes.
---
As the last option and the most tricky one:
custom_flags:
If you enable this in your [cam whatevernameyouset],\
you gain the full control over your choosen streamservice.\
This option is for more Advanced Users.
To setup Services to your need you have to take a closer look to the documentation of the Projects named above.\
As a pointer in the right direction:
- mjpg
- This one is a bit more complex due the fact it depends on your cam type.
- For 'Raspicam' see [Plugin: input_raspicam](https://github.com/jacksonliam/mjpg-streamer/blob/master/mjpg-streamer-experimental/plugins/input_raspicam/README.md)
- For USB Type Cams see [Plugin: input_uvc](https://github.com/jacksonliam/mjpg-streamer/blob/master/mjpg-streamer-experimental/plugins/input_uvc/README.md)
- For the output is ,in this case, only used [Plugin: output_http](https://github.com/jacksonliam/mjpg-streamer/tree/master/mjpg-streamer-experimental/plugins/output_http)
- ustreamer
- For sake of simplicity I converted ustreamers manpage to
[ustreamer's manpage](./ustreamer_manpage.md)
If you use custom_flags, we try to help you out but it is really a feature for Advanced Users and your a kind of on your own.
So, with all that said, get your position seaman! Prepare to get wet feets on your Journey.\
ARRRR yooo rrready to sail?

37
custompios/README.md Normal file
View File

@ -0,0 +1,37 @@
# Crow's Nest
A multiple Cam and Stream Service for mainsailOS
# Developer Documentation
The folder 'crowsnest' is made to add to your existing CustomPIOS Structure.
Please take a closer look to the 'config' File and set it up to your specific needs.
This is pretty much self explantory.
At least you have to configure:
CROWSNEST_DEFAULT_CONF="mainsail_default.conf"
This takes a conf file from the 'sample_configs' called mainsail_default.conf
and put it to
CROWSNEST_DEFAULT_CONF_DIR="/home/${BASE_USER}/klipper_config"
the folder you configured above.\
Please feel free to Pull Request your config!
I will add them.
Last but not least:
CROWSNEST_MOONRAKER_SUPPORT="y"
this will tell the module to add the content of moonraker_update.txt to your
moonraker.conf\
_Please take note, that moonraker.conf has to be in your CROWSNEST_DEFAULT_CONF_DIR !_
Finally add crowsnest to your config!
As example:
export MODULES="base(network,(klipper,moonraker,mainsail,crowsnest))"
Make sure it is barely the last one, because it mangles cmake quiet often
unfortunatly.\
This isn't my fault, more the "pickynese" behavior of
mjpg-streamer and v4l2rtspserver :)

26
custompios/crowsnest/config Normal file
View File

@ -0,0 +1,26 @@
[ -n "$CROWSNEST_CROWSNEST_REPO_SHIP" ] || CROWSNEST_CROWSNEST_REPO_SHIP=https://github.com/mainsail-crew/crowsnest.git
[ -n "$CROWSNEST_CROWSNEST_REPO_BRANCH" ] || CROWSNEST_CROWSNEST_REPO_BRANCH=main
[ -n "$CROWSNEST_CROWSNEST_DEPS" ] || CROWSNEST_DEPS="git crudini"
[ -n "$CROWSNEST_DEFAULT_CONF" ] || CROWSNEST_DEFAULT_CONF="mainsail_default.conf"
[ -n "$CROWSNEST_DEFAULT_CONF_DIR" ] || CROWSNEST_DEFAULT_CONF_DIR="/home/${BASE_USER}/klipper_config"
[ -n "$CROWSNEST_MOONRAKER_SUPPORT" ] || CROWSNEST_MOONRAKER_SUPPORT="y"
# mjpg-streamer
[ -n "$CROWSNEST_MJPG_REPO_SHIP" ] || CROWSNEST_MJPG_REPO_SHIP=https://github.com/jacksonliam/mjpg-streamer.git
[ -n "$CROWSNEST_MJPG_REPO_BRANCH" ] || CROWSNEST_MJPG_REPO_BRANCH=master
[ -n "$CROWSNEST_MJPG_REPO_DEPTH" ] || CROWSNEST_MJPG_REPO_DEPTH=1
[ -n "$CROWSNEST_MJPG_DEPS" ] || CROWSNEST_MJPG_DEPS="git build-essential libv4l-dev imagemagick ffmpeg"
# ustreamer
[ -n "$CROWSNEST_USTREAMER_REPO_SHIP" ] || CROWSNEST_USTREAMER_REPO_SHIP=https://github.com/pikvm/ustreamer.git
[ -n "$CROWSNEST_USTREAMER_REPO_BRANCH" ] || CROWSNEST_USTREAMER_REPO_BRANCH=master
[ -n "$CROWSNEST_USTREAMER_REPO_DEPTH" ] || CROWSNEST_USTREAMER_REPO_DEPTH=1
[ -n "$CROWSNEST_USTREAMER_DEPS" ] || CROWSNEST_USTREAMER_DEPS="git build-essential libevent-dev libjpeg8-dev \
libbsd-dev libraspberrypi-dev libgpiod-dev cmake cmake-data"
[ -n "$CROWSNEST_USTREAMER_WITH_OMX" ] || CROWSNEST_USTREAMER_WITH_OMX="y"
[ -n "$CROWSNEST_USTREAMER_WITH_GPIO" ] || CROWSNEST_USTREAMER_WITH_GPIO="n"
# v4l2rtspserver
[ -n "$CROWSNEST_V4L2RTSP_REPO_SHIP" ] || CROWSNEST_V4L2RTSP_REPO_SHIP=https://github.com/mpromonet/v4l2rtspserver.git
[ -n "$CROWSNEST_V4L2RTSP_REPO_BRANCH" ] || CROWSNEST_V4L2RTSP_REPO_BRANCH=master
[ -n "$CROWSNEST_V4L2RTSP_DEPS" ] || CROWSNEST_V4L2RTSP_DEPS="git build-essential liblivemedia-dev liblog4cpp5-dev"

183
custompios/crowsnest/start_chroot_script Normal file
View File

@ -0,0 +1,183 @@
#!/usr/bin/env bash
# Crow's Nest
# A multiple Cam and Stream Service for mainsailOS
# Written by Stephan Wendel aka KwadFan
# Copyright 2021
# https://github.com/KwadFan/webcamtest.git
# GPL V3
########
# Error handling, leave this in place
# set -x
set -e
source /common.sh
install_cleanup_trap
### Module Specific functions
function copy_config {
echo_green "Copying Default configuration File to ${CROWSNEST_DEFAULT_CONF_DIR}"
sudo -u "${BASE_USER}" cp sample_configs/${CROWSNEST_DEFAULT_CONF} "${CROWSNEST_DEFAULT_CONF_DIR}"/webcam.conf
}
## Check Dependencies, install if not installed
apt_update_skip
check_install_pkgs ${CROWSNEST_DEPS}
# Move to $HOME dir
cd /home/${BASE_USER}
### Install crowsnest
## Clone Repo
gitclone CROWSNEST_CROWSNEST_REPO webcamd
# Check succsessfull clone.
if [ -d "/home/${BASE_USER}/webcamd" ]; then
pushd webcamd > /dev/null
if [ -d "$CROWSNEST_DEFAULT_CONF_DIR" ]; then
copy_config
else
echo_red "${CROWSNEST_DEFAULT_CONF_DIR} does not exist!"
echo_green "Creating ${CROWSNEST_DEFAULT_CONF_DIR}."
sudo -u ${BASE_USER} mkdir -p ${CROWSNEST_DEFAULT_CONF_DIR}
copy_config
fi
# Create symlink to webcamd script in /usr/local/bin
echo_green "Create Sym Link to ${PWD}/webcamd in /usr/local/bin ..."
sudo ln -sf $PWD/webcamd /usr/local/bin/
# Add webcamd to moonraker.conf
if [ "${CROWSNEST_MOONRAKER_SUPPORT}" = "y" ]; then
echo_green "Add webcamd (crowsnest) to Moonraker's Update Manager"
# Make sure moonraker.conf exists
if [ -f "${CROWSNEST_DEFAULT_CONF_DIR}/moonraker.conf" ]; then
echo -e "\n" >> ${CROWSNEST_DEFAULT_CONF_DIR}/moonraker.conf
while read -r line; do
echo -e "${line}" >> ${CROWSNEST_DEFAULT_CONF_DIR}/moonraker.conf
done < "$PWD/file_templates/moonraker_update.txt"
echo -e "\n" >> ${CROWSNEST_DEFAULT_CONF_DIR}/moonraker.conf
else
echo_red "File 'moonraker.conf' does not exist. [SKIPPING]"
fi
else
echo_red "Moonraker's Update Manager Support disabled [SKIPPING]"
fi
### Install Service
echo_green "Copying webcamd.service file \
to '/etc/systemd/system/webcamd.service'.. "
cp -p file_templates/webcamd.service /etc/systemd/system/
## Make sure raspicam become /dev/video0 Workaround
sudo sh -c "echo bcm2835-v4l2 >> /etc/modules"
## Enable systemd service
echo_green "Enable webcamd.service ..."
systemctl_if_exists enable webcamd.service
popd > /dev/null
fi
echo_green "Installing mjpeg-streamer ..."
### Clone and compile mjpg_streamer
## Due the fact that used mjpg_streamer has a weird folder structure
## We need some 'magic' to workaround that.
echo_green "Cloning mjpg-streamer Sources."
gitclone CROWSNEST_MJPG_REPO mjpg_tmp
sudo -u ${BASE_USER} mkdir -p mjpg-streamer
sudo -u ${BASE_USER} mv mjpg_tmp/mjpg-streamer-experimental/* mjpg-streamer/
## This Part is out of the original mjpg-streamer Module
## Credits to: Raymond Himle
## (Adapted from the OctoPi image creation scripts. Thanks Gina and Guysoft!)
echo_green "Installing mjpg-streamer Dependencies."
apt update
check_install_pkgs ${CROWSNEST_MJPG_DEPS}
apt install -y --allow-downgrades cmake=3.13.4-1 cmake-data=3.13.4-1
if [ $( is_in_apt libjpeg62-turbo-dev ) -eq 1 ]; then
apt-get -y --force-yes install libjpeg62-turbo-dev
elif [ $( is_in_apt libjpeg8-dev ) -eq 1 ]; then
apt-get -y --force-yes install libjpeg8-dev
fi
## Compile mjpg_streamer
echo_green "Compiling mjpg-streamer"
pushd mjpg-streamer > /dev/null
MJPG_STREAMER_BUILD_DIR=_build
[ -d ${MJPG_STREAMER_BUILD_DIR} ] || (mkdir ${MJPG_STREAMER_BUILD_DIR} && \
chown ${BASE_USER}:${BASE_USER} ${MJPG_STREAMER_BUILD_DIR})
[ -f ${MJPG_STREAMER_BUILD_DIR}/Makefile ] || (cd ${MJPG_STREAMER_BUILD_DIR} && \
sudo -u ${BASE_USER} cmake -DCMAKE${MJPG_STREAMER_BUILD_DIR}_TYPE=Release ..)
sudo -u ${BASE_USER} make -j $(nproc) -C ${MJPG_STREAMER_BUILD_DIR}
sudo -u ${BASE_USER} cp ${MJPG_STREAMER_BUILD_DIR}/mjpg_streamer .
sudo -u ${BASE_USER} find ${MJPG_STREAMER_BUILD_DIR} -name "*.so" -type f -exec cp {} . \;
popd > /dev/null
## Cleanup
echo_green "Removing temporary Repo Folder."
rm -rf mjpg_tmp
## Due the fact mjpg uses an older version of cmake we have to upgrade it.
apt install cmake cmake-data
## Create sym links
echo_green "Creating sym links..."
sudo ln -sf $PWD/mjpg-streamer/mjpg_streamer /usr/local/bin/
# Finished
echo_green "Successful installed mjpg-streamer."
### Install ustreamer
echo_green "Installing ustreamer ..."
### Clone and compile ustreamer
echo_green "Cloning ustreamer Sources."
gitclone CROWSNEST_USTREAMER_REPO ustreamer
echo_green "Installing ustreamer Dependencies."
apt update
apt --yes install ${CROWSNEST_USTREAMER_DEPS}
## Compile ustreamer
echo_green "Compiling ustreamer"
pushd ustreamer > /dev/null
if [ "${CROWSNEST_USTREAMER_WITH_OMX}" = "y" ] && \
[ "${CROWSNEST_USTREAMER_WITH_GPIO}" = "y" ]; then
echo_green "Compile ustreamer with OMX and GPIO Support..."
WITH_OMX=1 WITH_GPIO=1 make -j $(nproc)
elif [ "${CROWSNEST_USTREAMER_WITH_OMX}" = "y" ] && \
[ "${CROWSNEST_USTREAMER_WITH_GPIO}" = "n" ]; then
echo_green "Compile ustreamer with OMX Support..."
WITH_OMX=1 make -j $(nproc)
else
"Compile ustreamer without OMX and GPIO Support..."
make -j $(nproc)
fi
popd > /dev/null
## Create sym links
echo_green "Creating sym links..."
sudo ln -sf $PWD/ustreamer/ustreamer /usr/local/bin/
# Finished
echo_green "Successful installed ustreamer."
### Install v4l2rtspserver
echo_green "Installing v4l2rtspserver ..."
### Clone and compile ustreamer
echo_green "Cloning v4l2rtspserver Sources."
gitclone CROWSNEST_V4L2RTSP_REPO v4l2rtspserver
echo_green "Installing v4l2rtspserv Dependencies."
apt update
apt --yes install ${CROWSNEST_V4L2RTSP_DEPS}
# It seems v4l2rtspserver has trouble to compile with cmake 3.16
apt install -y --allow-downgrades cmake=3.13.4-1 cmake-data=3.13.4-1
## Compile ustreamer
echo_green "Compiling v4l2rtspserver"
pushd v4l2rtspserver > /dev/null
cmake -j $(nproc) . && make -j $(nproc)
popd > /dev/null
## Create sym links
echo_green "Creating sym links..."
sudo ln -sf $PWD/v4l2rtspserver/v4l2rtspserver /usr/local/bin/
# Finished
echo_green "Successful installed v4l2rtspserver."
### Final Cleanup
apt clean --yes
apt autoclean --yes
apt autoremove --purge --yes

6
file_templates/moonraker_update.txt Normal file
View File

@ -0,0 +1,6 @@
[update_manager webcamd]
type: git_repo
path: ~/webcamd
origin: https://github.com/mainsail-crew/crowsnest.git
primary_branch: master

19
file_templates/webcamd.service Normal file
View File

@ -0,0 +1,19 @@
[UNIT]
Description=webcamd - Multi Webcam/Streamer Control Deamon
After=udev.service network-online.target
Wants=udev.service network-online.target
StartLimitBurst=3
StartLimitIntervalSec=600
[Install]
Alias=crowsnest
WantedBy=multi-user.target
[Service]
Environment=WEBCAMD_CONFIG=/home/pi/klipper_config/webcam.conf
Type=Forking
User=pi
RemainAfterExit=Yes
ExecStart= /usr/local/bin/webcamd -c ${WEBCAMD_CONFIG}
Restart=on-failure
RestartSec=10

115
installer_ms050.sh Executable file
View File

@ -0,0 +1,115 @@
#!/bin/bash
set -e
# set -x
export DEBIAN_FRONTEND=noninteractive
if [ "${UID}" == "0" ]; then
echo -e "\nDO NOT RUN THIS SCRIPT AS 'root' !!!\n"
exit 1
fi
echo -e "Some Commands have to run as 'root' via sudo."
echo -e "You will be asked for password if needed.\n"
# Stoping existing Daemon
echo -e "Stopping existing webcamd...\n"
sudo systemctl stop webcamd
# Remove existing webcamd.
echo -e "Backup existing files...\n"
mkdir -p ${HOME}/webcamd-backup
if [ -e "/etc/systemd/system/webcamd.service" ]; then
cp -p /etc/systemd/system/webcamd.service ${HOME}/webcamd-backup
fi
if [ -e "/usr/local/bin/webcamd" ]; then
cp -p /usr/local/bin/webcamd ${HOME}/webcamd-backup/
fi
if [ -e "/etc/logrotate.d/webcamd" ]; then
cp -p /etc/logrotate.d/webcamd ${HOME}/webcamd-backup/webcamd.logrotate
fi
# Remove existing.
echo -e "Removing existing webcamd...\n"
sudo rm -rf /etc/logrotate.d/webcamd
sudo rm -rf /usr/local/bin/webcamd
sudo rm -rf /etc/systemd/system/webcamd.service
sudo rm -rf ${HOME}/klipper_logs/webcamd.log
sudo rm -rf /var/log/webcamd.log
# Install Dependency
sudo apt update
sudo apt install crudini -y
# Install Project "crowsnest"
echo -e "Installing webcamd and enable Service"
sudo ln -s $PWD/webcamd /usr/local/bin/webcamd
sudo cp -r $PWD/file_templates/webcamd.service /etc/systemd/system/
cp -r $PWD/sample_configs/minimal.conf ${HOME}/klipper_config/webcam.conf
sudo systemctl daemon-reload
sudo systemctl enable webcamd
# Install ustreamer
# Make sure its clean
if [ -d "${HOME}/ustreamer" ]; then
rm -rf ${HOME}/ustreamer/
fi
echo -e "Compiling ustreamer..."
cd ~
git clone https://github.com/pikvm/ustreamer.git
cd ustreamer
if [[ "$(cat /proc/device-tree/model | cut -d ' ' -f1)" = "Raspberry" ]]; then
sudo apt install build-essential libevent-dev libjpeg-dev libbsd-dev \
libraspberrypi-dev libgpiod-dev -y
export WITH_OMX=1
make -j $(nproc) # push limit
echo -e "Create symlink..."
sudo ln -sf ${HOME}/ustreamer/ustreamer /usr/local/bin/
else
sudo apt install build-essential libevent-dev libjpeg-dev libbsd-dev \
libgpiod-dev -y
make -j $(nproc)
echo -e "Create symlink..."
sudo ln -sf ${HOME}/ustreamer/ustreamer /usr/local/bin/
fi
# Install v4l2rtspserver
# Make sure its clean
if [ -d "${HOME}/v4l2rtspserver" ]; then
rm -rf ${HOME}/v4l2rtspserver/
fi
echo -e "Compiling v4l2rtspserver..."
cd ~
git clone https://github.com/mpromonet/v4l2rtspserver.git
cd v4l2rtspserver
sudo apt install cmake liblivemedia-dev liblog4cpp5-dev -y
cmake . && make -j $(nproc) # push limit
echo -e "Create symlink..."
sudo ln -sf ${HOME}/v4l2rtspserver/v4l2rtspserver /usr/local/bin/
# create mjpg_streamer symlink
echo -e "Create mjpg_streamer symlink..."
sudo ln -sf ${HOME}/mjpg-streamer/mjpg_streamer /usr/local/bin/
# Start webcamd
sudo sh -c "echo bcm2835-v4l2 >> /etc/modules"
sudo systemctl start webcamd
# webcamd to moonraker.conf
echo -e "Adding update manager to moonraker.conf"
cat >> ${HOME}/klipper_config/moonraker.conf << EOF
[update_manager webcamd]
type: git_repo
path: ~/webcamtest
origin: https://github.com/mainsail-crew/crowsnest.git
primary_branch: main
EOF
echo -e "Finished Installation..."
echo -e "Please reboot the PI."
exit 0

37
mjpg-www/index.html Normal file
View File

@ -0,0 +1,37 @@
<!DOCTYPE html>
<html lang="en" >
<head>
<meta charset="UTF-8">
<title>Webcam - mjpg_streamer</title>
<link rel="stylesheet" href="./style.css">
</head>
<body>
<!-- partial:index.partial.html -->
<header>
<span>Webcam - mjpg_streamer</span>
</header>
<div class="container">
<div class="panel">
<div class="title">Stream</div>
<img id="streamImg" src="./?action=stream">
</div>
<div class="panel">
<div class="title"><span>Snapshot</span>
<span class="reload" onclick="reloadSnapshot()">
<noscript>Please refresh the page, to get an up to date image.</noscript>
<svg id="reloadSVG" viewBox="0 0 512 512" title="redo-alt">
<path d="M256.455 8c66.269.119 126.437 26.233 170.859 68.685l35.715-35.715C478.149 25.851 504 36.559 504 57.941V192c0 13.255-10.745 24-24 24H345.941c-21.382 0-32.09-25.851-16.971-40.971l41.75-41.75c-30.864-28.899-70.801-44.907-113.23-45.273-92.398-.798-170.283 73.977-169.484 169.442C88.764 348.009 162.184 424 256 424c41.127 0 79.997-14.678 110.629-41.556 4.743-4.161 11.906-3.908 16.368.553l39.662 39.662c4.872 4.872 4.631 12.815-.482 17.433C378.202 479.813 319.926 504 256 504 119.034 504 8.001 392.967 8 256.002 7.999 119.193 119.646 7.755 256.455 8z" />
</svg>
</span>
</div>
<img id="snapshotImg" src="./?action=snapshot">
</div>
</div>
<!-- partial -->
<script src="./script.js"></script>
</body>
</html>

8
mjpg-www/script.js Normal file
View File

@ -0,0 +1,8 @@
document.getElementById("reloadSVG").style.display = "inline";
function reloadSnapshot() {
snapshotUrl =
"./?action=snapshot";
document.getElementById("snapshotImg").src =
snapshotUrl + "?" + new Date().getTime();
}

85
mjpg-www/style.css Normal file
View File

@ -0,0 +1,85 @@
body {
background-color: #121212;
color: #fff;
font-size: 1.5rem;
font-family: Roboto, sans-serif;
margin: 0px;
user-select: none;
}
a {
text-decoration: none;
color: #bbb;
}
header {
background-color: #272727;
height: 48px;
line-height: 48px;
box-shadow: 0 0 5px #000;
}
header a,
header span {
display: inline-block;
height: 100%;
padding: 0 20px;
}
.container {
padding: 20px;
display: flex;
flex-flow: row wrap;
justify-content: center;
gap: 20px 30px;
}
.panel {
background-color: #1e1e1e;
border-radius: 4px;
min-width: 350px;
max-width: 500px;
flex-grow: 4;
box-shadow: 0 10px 20px #000;
}
.title {
background-color: #272727;
height: 48px;
line-height: 48px;
padding-left: 20px;
border-radius: 4px;
display: flex;
font-size: 1.3rem;
}
.panel img {
width: 100%;
}
span:first-of-type {
flex: 1;
}
.reload svg {
display: none;
fill: #ccc;
height: 16px;
margin: 0 20px;
cursor: pointer;
}
.reload svg:hover {
fill: #fff;
}
.reload svg:not(:active) {
transition: transform 0.4s ease-in-out;
transform: rotate(360deg);
}
.reload noscript {
font-size: 0.6rem;
color: #ccc;
}

28
sample_configs/KwadFan_sample.conf Normal file
View File

@ -0,0 +1,28 @@
[webcamd]
log_path: ~/klipper_logs/webcamd.log #klipper_logs!!!
debug_log: true #true or false
[cam 1]
streamer: ustreamer # mjpeg/ustreamer/rtsp
port: 8081 # Port
device: /dev/video0 # See Log for available ...
resolution: 640x480 # widthxheight format
max_fps: 15 # If Hardware Supports this it will be forced, ohterwise ignored/coerced.
#custom_flags: # You can run the Stream Services with custom flags.
[cam 2]
streamer: mjpg
port: 8080
device: /dev/v4l/by-id/usb-PixArt_Imaging_Inc._USB2.0_Camera-video-index0
resolution: 640x480
max_fps: 15
#custom_flags: --encoder=omx --dv-timings
[cam 3]
streamer: rtsp
port: 8554
device: /dev/video1
resolution: 640x480
max_fps: 0
# [cam 4]

17
sample_configs/mainsail_default.conf Normal file
View File

@ -0,0 +1,17 @@
### webcam.conf
### This is mainsail / MainsailOS default config.
### See docs.mainsail.xyz/whatever for Details to configure to your needs.
[webcamd]
log_path: ~/klipper_logs/webcamd.log #klipper_logs!!!
debug_log: true #true or false
log_method: debug
[cam 1]
streamer: mjpg # mjpeg/ustreamer/rtsp
port: 8080 # Port
device: /dev/video0 # See Log for available ...
resolution: 640x480 # widthxheight format
max_fps: 15 # If Hardware Supports this it will be forced, ohterwise ignored/coerced.
#custom_flags: # You can run the Stream Services with custom flags.

12
sample_configs/minimal.conf Normal file
View File

@ -0,0 +1,12 @@
[webcamd]
log_path: ~/klipper_logs/webcamd.log #klipper_logs!!!
debug_log: false #true or false
[cam 1]
streamer: mjpg # mjpeg/ustreamer/rtsp
port: 8080 # Port
device: /dev/video0 # See Log for available ...
resolution: 640x480 # widthxheight format
max_fps: 15 # If Hardware Supports this it will be forced, ohterwise ignored/coerced.
#custom_flags: # You can run the Stream Services with custom flags.

359
ustreamer_manpage.md Normal file
View File

@ -0,0 +1,359 @@
USTREAMER(1) General Commands Manual USTREAMER(1)
NAME\
ustreamer - stream MJPG video from any V4L2 device to the network
SYNOPSIS ustreamer [OPTIONS]
DESCRIPTION\
µStreamer (ustreamer) is a lightweight and very quick server to stream
MJPG video from any V4L2 device to the network.\
All new browsers have native support of this video format, as well as most video players such as mplayer, VLC etc.\
µStreamer is a part of the Pi-KVM project designed to stream VGA and HDMI screencast hardware data with the highest reso‐
lution and FPS possible.
USAGE\
Without arguments, ustreamer will try to open /dev/video0 with 640x480 resolution and start streaming on http://127.0.0.1:8080.\
You can override this behavior using parameters --device, --host and --port. For example, to stream to the world, run: ustreamer --device=/dev/video1 --host=0.0.0.0 --port=80
Please note that since µStreamer v2.0 cross-domain requests were
disabled by default for security reasons.
To enable the old behavior, use the option --allow-origin=\*.
For example, the recommended way of running µStreamer with
Auvidea B101 on a Raspberry Pi is:
ustreamer \
--format=uyvy \ # Device input format
--encoder=omx \ # Hardware encoding with OpenMAX
--workers=3 \ # Maximum workers for OpenMAX
--persistent \ # Don´t re-initialize device on timeout \
(for example when HDMI cable was disconnected)
--dv-timings \ # Use DV-timings
--drop-same-frames=30 # Save the traffic
Please note that to use --drop-same-frames for different browsers you need\
to use some specific URL /stream parameters (see URL / for details).
You can always view the full list of options with ustreamer --help.
Some features may not be available on your platform.
To find out which features are enabled, use ustreamer --features.
OPTIONS
Capturing options
-d /dev/path, --device /dev/path
Path to V4L2 device. Default: /dev/video0.
-i N, --input N
Input channel. Default: 0.
-r WxH, --resolution WxH
Initial image resolution. Default: 640x480.
-m fmt, --format fmt
Image format. Available: YUYV, UYVY, RGB565, RGB24, JPEG;
default: YUYV.
-a std, --tv-standard std
Force TV standard. Available: PAL, NTSC, SECAM;
Default: disabled.
-I method, --io-method method
Set V4L2 IO method (see kernel documentation). Changing of this
parameter may increase the performance. Or not.
Available: MMAP, USERPTR; default: MMAP.
-f N, --desired-fps N
Desired FPS. Default: maximum possible.
-z N, --min-frame-size N
Drop frames smaller then this limit.
Useful if the device produces small-sized garbage frames.
Default: 128 bytes.
-n, --persistent
Don't re-initialize device on timeout.
Default: disabled.
-t, --dv-timings
Enable DV timings querying and events processing to
automatic resolution change.
Default: disabled.
-b N, --buffers N
The number of buffers to receive data from the device. Each buf‐
fer may processed using an independent thread.
Default: 2 (the number of CPU cores (but not more than 4) + 1).
-w N, --workers N
The number of worker threads but not more than buffers. De‐
fault: 1 (the number of CPU cores (but not more than 4)).
-q N, --quality N
Set quality of JPEG encoding from 1 to 100 (best). Default: 80.
Note: If HW encoding is used (JPEG source format selected), this
parameter attempts to configure the camera or capture device
hardware's internal encoder. It does not re-encode MJPG to MJPG
to change the quality level for sources that already output
MJPG.
-c type, --encoder type
Use specified encoder. It may affect the number of workers.
CPU ─ Software MJPG encoding (default).
OMX ─ GPU hardware accelerated MJPG encoding with OpenMax (re‐
quired WITH_OMX feature).
HW ─ Use pre-encoded MJPG frames directly from camera hardware.
NOOP ─ Don't compress MJPG stream (do nothing).
-g WxH,..., --glitched-resolutions WxH,...
It doesn't do anything. Still here for compatibility. Required
WITH_OMX feature.
-k path, --blank path
Path to JPEG file that will be shown when the device is discon‐
nected during the streaming. Default: black screen 640x480 with
'NO SIGNAL'.
-K sec, --last-as-blank sec
Show the last frame received from the camera after it was dis‐
connected, but no more than specified time (or endlessly if 0 is
specified). If the device has not yet been online, display 'NO
SIGNAL' or the image specified by option --blank. Note: cur‐
rently this option has no effect on memory sinks.
Default: disabled.
-l, --slowdown
Slowdown capturing to 1 FPS or less when no stream or sink
clients are connected. Useful to reduce CPU consumption.
Default: disabled.
--device-timeout sec
Timeout for device querying. Default: 1.
--device-error-delay sec
Delay before trying to connect to the device again after an
error (timeout for example). Default: 1.
Image control options
--image-default
Reset all image settings below to default. Default: no change.
--brightness N, auto, default
Set brightness. Default: no change.
--contrast N, default
Set contrast. Default: no change.
--saturation N, default
Set saturation. Default: no change.
--hue N, auto, default
Set hue. Default: no change.
--gamma N, default
Set gamma. Default: no change.
--sharpness N, default
Set sharpness. Default: no change.
--backlight-compensation N, default
Set backlight compensation. Default: no change.
--white-balance N, auto, default
Set white balance. Default: no change.
--gain N, auto, default
Set gain. Default: no change.
--color-effect N, default
Set color effect. Default: no change.
--flip-vertical 1, 0, default
Set vertical flip. Default: no change.
--flip-horizontal 1, 0, default
Set horizontal flip. Default: no change.
HTTP server options
-s address, --host address
Listen on Hostname or IP. Default: 127.0.0.1.
-p N, --port N
Bind to this TCP port. Default: 8080.
-U path, --unix path
Bind to UNIX domain socket. Default: disabled.
-d, --unix-rm
Try to remove old unix socket file before binding. default: dis‐
abled.
-M mode, --unix-mode mode
Set UNIX socket file permissions (like 777). Default: disabled.
--user name
HTTP basic auth user. Default: disabled.
--passwd str
HTTP basic auth passwd. Default: empty.
--static path
Path to dir with static files instead of embedded root index
page. Symlinks are not supported for security reasons. Default:
disabled.
-e N, --drop-same-frames N
Don't send identical frames to clients, but no more than speci‐
fied number. It can significantly reduce the outgoing traffic,
but will increase the CPU loading. Don't use this option with
analog signal sources or webcams, it's useless. Default: dis‐
abled.
-R WxH, --fake-resolution WxH
Override image resolution for the /state. Default: disabled.
--tcp-nodelay
Set TCP_NODELAY flag to the client /stream socket. Ignored for
--unix. Default: disabled.
--allow-origin str
Set Access-Control-Allow-Origin header. Default: disabled.
--server-timeout sec
Timeout for client connections. Default: 10.
JPEG sink options\
With shared memory sink you can write a stream to a file.\
See ustreamer-dump(1) for more info.
--sink name
Use the specified shared memory object to sink JPEG frames. De‐
fault: disabled.
--sink-mode mode
Set JPEG sink permissions (like 777). Default: 660.
--sink-rm
Remove shared memory on stop. Default: disabled.
--sink-client-ttl sec
Client TTL. Default: 10.
--sink-timeout sec
Timeout for lock. Default: 1.
H264 sink options\
Available only if WITH_OMX feature enabled.
--h264-sink name
Use the specified shared memory object to sink H264 frames en‐
coded by MMAL. Default: disabled.
--h264-sink-mode mode
Set H264 sink permissions (like 777). Default: 660.
--h264-sink-rm
Remove shared memory on stop. Default: disabled.
--h264-sink-client-ttl sec
Client TTL. Default: 10.
--h264-sink-timeout sec
Timeout for lock. Default: 1.
--h264-bitrate kbps
H264 bitrate in Kbps. Default: 5000.
--h264-gop N
Intarval between keyframes. Default: 30.
Process options
--exit-on-parent-death
Exit the program if the parent process is dead.
Required HAS_PDEATHSIG feature. Default: disabled.
--process-name-prefix str
Set process name prefix which will be displayed in the process
list like 'str: ustreamer --blah-blah-blah'. Required WITH_SET‐
PROCTITLE feature. Default: disabled.
--notify-parent
Send SIGUSR2 to the parent process when the stream parameters
are changed. Checking changes is performed for the online flag
and image resolution. Required WITH_SETPROCTITLE feature.
GPIO options\
Available only if WITH_GPIO feature enabled.
--gpio-device /dev/path
Path to GPIO character device. Default: /dev/gpiochip0.
--gpio-consumer-prefix str
Consumer prefix for GPIO outputs. Default: ustreamer.
--gpio-prog-running pin
Set 1 on GPIO pin while µStreamer is running. Default: disabled.
--gpio-stream-online pin
Set 1 while streaming. Default: disabled.
--gpio-has-http-clients pin
Set 1 while stream has at least one client. Default: disabled.
Logging options
--log-level N
Verbosity level of messages from 0 (info) to 3 (debug). Enabling
debugging messages can slow down the program. Available levels:
0 (info), 1 (performance), 2 (verbose), 3 (debug). Default: 0.
--perf Enable performance messages (same as --log-level=1). Default:
disabled.
--verbose
Enable verbose messages and lower (same as --log-level=2). De‐
fault: disabled.
--debug
Enable debug messages and lower (same as --log-level=3). De‐
fault: disabled.
--force-log-colors
Force color logging. Default: colored if stderr is a TTY.
--no-log-colors
Disable color logging. Default: ditto.
Help options
-h, --help
Print this text and exit.
-v, --version
Print version and exit.
--features
Print list of supported features.
SEE ALSO
ustreamer-dump(1)
BUGS
Please file any bugs and issues at https://github.com/pikvm/ustreamer/issues
AUTHOR
Maxim Devaev <mdevaev@gmail.com>
HOMEPAGE
https://pikvm.org/
COPYRIGHT
GNU General Public License v3.0
November 2020 version 4.8 USTREAMER(1)

472
webcamd Executable file
View File

@ -0,0 +1,472 @@
#!/bin/bash
#### webcamd - A webcam Service for multiple Cams and Stream Services.
####
#### written by Stephan Wendel aka KwadFan
#### Copyright 2021
#### https://github.com/mainsail-crew/crowsnest
####
#### This File is distributed under GPLv3
### Disable shellcheck Errors
# shellcheck disable=SC2012,SC2206
# Exit upon Errors
set -e
## Functions
## Version of webcamd
function self_version {
pushd $(dirname $(readlink -f "${0}")) &> /dev/null
git describe --always --tags
popd &> /dev/null
}
## Message Helpers
function missing_args_msg {
echo -e "webcamd: Missing Arguments!"
echo -e "\n\tTry: webcamd -h\n"
}
function wrong_args_msg {
echo -e "webcamd: Wrong Arguments!"
echo -e "\n\tTry: webcamd -h\n"
}
function help_msg {
echo -e "webcamd - webcam deamon\nUsage:"
echo -e "\t webcamd [Options]"
echo -e "\n\t\t-h Prints this help."
echo -e "\n\t\t-v Prints Version of webcamd."
echo -e "\n\t\t-c </path/to/configfile>\n\t\t\tPath to your webcam.conf\n"
}
## Logging
function init_log_entry {
log_msg "webcamd - A webcam Service for multiple Cams and Stream Services."
log_msg "Version: $(self_version)"
log_msg "Prepare Startup ..."
}
function log_method {
local method logfile
logfile="$(get_param webcamd log_path | sed "s#^~#$HOME#gi")"
method="$(get_param "webcamd" log_method 2> /dev/null)"
if [ "${method}" = "debug" ]; then
rm -rf "${logfile}"
fi
}
function log_msg {
local msg logfile prefix
msg="${1}"
prefix="$(date +'[%D %T]') webcamd:"
#Workaround sed ~ to BASH VAR $HOME
logfile="$(get_param webcamd log_path | sed "s#^~#$HOME#gi")"
#Workaround: Make Dir if not exist
if [ ! -d "${logfile}" ]; then
mkdir -p "$(dirname "${logfile}")"
fi
echo -e "${prefix} ${msg}" | tr -s ' ' >> "${logfile}" 2>&1
}
#call '| log_output "<prefix>"'
function log_output {
local prefix debug
prefix="DEBUG: ${1}"
debug="$(get_param "webcamd" debug_log 2> /dev/null)"
if [ "${debug}" == "true" ]; then
while read -r line; do
log_msg "${prefix}: ${line}"
done
fi
}
function print_cfg {
local prefix
prefix="\t\t"
log_msg "INFO: Print Configfile: '${WEBCAMD_CFG}'"
while read -r line; do
log_msg "${prefix}${line}"
done < "${WEBCAMD_CFG}"
}
function print_cams {
local count raspicam total debug
debug="$(get_param "webcamd" debug_log 2> /dev/null)"
count="$(find /dev/v4l/by-id/ 2> /dev/null | sed '1d;1~2d' | wc -l)"
total="$((count+$(detect_raspicam)))"
if [ "${total}" -eq 0 ]; then
log_msg "ERROR: No usable Cameras Found. Stopping $(basename "$0")."
exit 1
else
log_msg "INFO: Found ${total} available Camera(s)"
fi
if [ -d "/dev/v4l/by-id/" ]; then
detect_avail_cams
fi
if [ "$(detect_raspicam)" -ne 0 ]; then
raspicam="$(v4l2-ctl --list-devices | grep -A1 -e 'mmal' | \
awk 'NR==2 {print $1}')"
log_msg "Detected 'Raspicam' Device -> ${raspicam}"
if [ "${debug}" == "true" ]; then
list_cam_formats "${raspicam}"
fi
fi
} 2> /dev/null
## Sanity Checks
function initial_check {
log_msg "INFO: Checking Dependencys"
check_dep "crudini"
check_dep "mjpg_streamer"
check_dep "ustreamer"
check_dep "v4l2rtspserver"
log_msg "INFO: Checking Configfile"
if [ -z "$(check_cfg "${WEBCAMD_CFG}")" ]; then
print_cfg
fi
log_msg "INFO: Detect available Cameras"
print_cams
}
function check_cfg {
if [ ! -r "${1}" ]; then
log_msg "ERROR: No Configuration File found. Exiting!"
exit 1
fi
}
function check_section {
local section param must_exist missing
section="cam ${1}"
# Ignore missing custom flags
param="$(crudini --existing=param --get "${WEBCAMD_CFG}" "${section}" \
2> /dev/null | sed '/custom_flags/d')"
must_exist="streamer port device resolution max_fps"
missing="$(echo "${param}" "${must_exist}" | \
tr ' ' '\n' | sort | uniq -u)"
if [ -n "${missing}" ]; then
log_msg "ERROR: Parameter ${missing} not found in \
Section [${section}]. Start skipped!"
exit 1
else
log_msg "INFO: Configuration of Section [${section}] looks good. \
Continue..."
fi
}
function check_dep {
local dep
dep="$(whereis "${1}" | awk '{print $2}')"
if [ -z "${dep}" ]; then
log_msg "Dependency: '${1}' not found. Exiting!"
exit 1
else
log_msg "Dependency: '${1}' found in ${dep}."
fi
}
### Detect Hardware
function detect_avail_cams {
local avail realpath
avail="$(find /dev/v4l/by-id/ 2> /dev/null | sort -n | sed '1d;1~2d')"
if [ -d "/dev/v4l/by-id/" ]; then
echo "${avail}" | while read -r i; do
realpath=$(readlink -e ${i})
log_msg "${i} -> ${realpath}"
if [ "${debug}" == "true" ]; then
list_cam_formats "${i}"
fi
done
else
log_msg "ERROR: No usable Cameras found. Exiting."
exit 1
fi
}
function list_cam_formats {
local device
device="${1}"
formats="$(v4l2-ctl -d "${device}" --list-formats-ext | sed '1,3d')"
log_msg "Supported Formats:"
echo "${formats}" | while read -r i; do
log_msg "\t\t${i}"
done
}
function detect_raspicam {
local avail
if [ "$(cat /proc/device-tree/model | cut -d ' ' -f1)" = "Raspberry" ]; then
avail="$(vcgencmd get_camera | awk -F '=' '{ print $3 }')"
else
avail="0"
fi
echo "${avail}"
}
## Spits out all [cam <nameornumber>] configured sections
function configured_cams {
local cam_count cfg
cfg="${WEBCAMD_CFG}"
cams="$(crudini --existing=file --get "${cfg}" | \
sed '/webcamd/d;s/cam//')"
echo "${cams}"
}
## Start Stream Service
# sleep to prevent cpu cycle spikes
function construct_streamer {
local stream_server cams
cams=($(configured_cams))
log_msg "Try to start configured Cams / Services..."
for (( i=0; i<"${#cams[@]}"; i++ )); do
stream_server="$(get_param "cam ${cams[$i]}" streamer 2> /dev/null)"
if [ "${stream_server}" == "mjpg" ]; then
run_mjpg "${cams[$i]}" &
sleep 8 & sleep_pid="$!"
wait "${sleep_pid}"
elif [ "${stream_server}" == "ustreamer" ]; then
run_ustreamer "${cams[$i]}" &
sleep 8 & sleep_pid="$!"
wait "${sleep_pid}"
elif [ "${stream_server}" == "rtsp" ]; then
run_rtsp "${cams[$i]}" &
sleep 8 & sleep_pid="$!"
wait "${sleep_pid}"
else
log_msg "ERROR: Missing 'streamer' parameter in [cam ${cams[$i]}]. Skipping."
fi
done
log_msg "... Done!"
}
function run_mjpg {
local cam_section mjpg_bin device port resolution fps custom
local raspicam split_res output input wwwroot
cam_section="${1}"
mjpg_bin="$(whereis mjpg_streamer | awk '{print $2}')"
# shellcheck disable=2046
ld_so="$(dirname $(readlink -qe $(whereis mjpg_streamer)))"
device="$(get_param "cam ${cam_section}" device)"
port=$(get_param "cam ${cam_section}" port)
resolution=$(get_param "cam ${cam_section}" resolution)
fps=$(get_param "cam ${cam_section}" max_fps)
custom="$(get_param "cam ${cam_section}" custom_flags 2> /dev/null)"
check_section "${cam_section}"
raspicam="$(v4l2-ctl --list-devices | grep -A1 -e 'mmal' | \
awk 'NR==2 {print $1}')"
output="output_http.so -l 127.0.0.1 -p ${port}"
#construct input raspicam/usb cam
if [ "${device}" == "${raspicam}" ]; then
split_res="$(echo "${resolution}" | \
awk -F 'x' '{print "-x "$1 " -y "$2}')"
input="input_raspicam.so ${split_res} -fps ${fps}"
else
input="input_uvc.so -d ${device} -r ${resolution} -f ${fps}"
fi
wwwroot="$(dirname $(readlink -qe $(whereis webcamd)))/mjpg-www"
log_msg "Starting mjpeg-streamer with Device ${device} ..."
echo "Parameters: -i "${input}" -o "${output}" -n -w ${wwwroot}" | \
log_output "mjpg_streamer [cam ${cam_section}]"
export LD_LIBRARY_PATH="${ld_so}"
# Custom Flag Handling
if [ -n "${custom}" ]; then
"${mjpg_bin}" "${custom}" 2>&1 | \
log_output "mjpg_streamer [cam ${cam_section}]"
else
"${mjpg_bin}" -i "${input}" -o "${output} -n -w ${wwwroot}" 2>&1 | \
log_output "mjpg_streamer [cam ${cam_section}]"
fi
log_msg "ERROR: Start of mjpg_streamer [cam ${cam_section}] failed!"
}
function run_ustreamer {
local cam_section ustreamer_bin device port resolution fps custom
local raspicam start_param wwwroot dev_exist
cam_section="${1}"
ustreamer_bin="$(whereis ustreamer | awk '{print $2}')"
device="$(get_param "cam ${cam_section}" device)"
port=$(get_param "cam ${cam_section}" port)
resolution=$(get_param "cam ${cam_section}" resolution)
fps=$(get_param "cam ${cam_section}" max_fps)
custom="$(get_param "cam ${cam_section}" custom_flags 2> /dev/null)"
raspicam="$(v4l2-ctl --list-devices | grep -A1 -e 'mmal' | \
awk 'NR==2 {print $1}')"
check_section "${cam_section}"
wwwroot="$(dirname $(readlink -qe $(whereis webcamd)))/ustreamer-www"
#Raspicam Workaround
if [ "${device}" == "${raspicam}" ]; then
start_param=(
--host 127.0.0.1 -p "${port}" -m MJPEG --device-timeout=5
--buffers=3 -r "${resolution}" -f "${fps}" --allow-origin=\*
--static "${wwwroot}"
)
else
start_param=(
-d "${device}" -r "${resolution}" -f "${fps}"
--host 127.0.0.1 -p "${port}" --allow-origin=\*
--device-timeout=2 --encoder=omx --static "${wwwroot}"
)
fi
# Custom Flag Handling
if [ -n "${custom}" ]; then
start_param=("${custom}")
fi
log_msg "Starting ustreamer with Device ${device} ..."
echo "Parameters: ${start_param[*]}" | \
log_output "ustreamer [cam ${cam_section}]"
# Ustreamer is designed to run even if the device is not ready or readable.
# I dont like that! ustreamer has to exit if Cam isnt there.
if [ -e "${device}" ]; then
"${ustreamer_bin}" ${start_param[*]} 2>&1 | \
log_output "ustreamer [cam ${cam_section}]"
else
log_msg "ERROR: Start of ustreamer [cam ${cam_section}] failed!"
fi
}
function run_rtsp {
local cam_section rtsp_bin device port resolution fps custom
local raspicam start_param
cam_section="${1}"
rtsp_bin="$(whereis v4l2rtspserver | awk '{print $2}')"
device="$(get_param "cam ${cam_section}" device)"
port=$(get_param "cam ${cam_section}" port)
resolution=$(get_param "cam ${cam_section}" resolution)
fps=$(get_param "cam ${cam_section}" max_fps)
custom="$(get_param "cam ${cam_section}" custom_flags 2> /dev/null)"
check_section "${cam_section}"
split_res="$(echo "${resolution}" | \
awk -F 'x' '{print "-W "$1 " -H "$2}')"
start_param=(
-I 0.0.0.0 -P "${port}" "${split_res}" -F "${fps}" \
"${device}"
)
# Custom Flag Handling
if [ -n "${custom}" ]; then
start_param=("${custom}")
fi
log_msg "Starting v4l2rtspserver with Device ${device} ..."
echo "Parameters: ${start_param[*]}" | \
log_output "v4l2rtspserver [cam ${cam_section}]"
"${rtsp_bin}" ${start_param[*]} 2>&1 | \
log_output "v4l2rtspserver [cam ${cam_section}]"
log_msg "ERROR: Start of v4l2rtspserver [cam ${cam_section}] failed!"
}
## MISC
# Read Configuration File
# call get_param section param
# spits out raw value
function get_param {
local cfg
local section
local param
cfg="${WEBCAMD_CFG}"
section="${1}"
param="${2}"
crudini --get "${cfg}" "${section}" "${param}" | \
sed 's/\#.*//;s/[[:space:]]*$//'
} 2> /dev/null
function err_exit {
if [ "${1}" != "0" ]; then
log_msg "ERROR: Error ${1} occured on line ${2}"
log_msg "ERROR: Stopping $(basename "$0")."
log_msg "Goodbye..."
fi
if [ -n "$(jobs -pr)" ]; then
kill $(jobs -pr)
fi
exit 1
}
function shutdown {
log_msg "Shutdown or Killed by User!"
log_msg "Please come again :)"
if [ -n "$(jobs -pr)" ]; then
kill $(jobs -pr)
fi
log_msg "Goodbye..."
exit 0
}
#### Watchdog Functions and Variables
## Do not reuse previous functions!
function get_cam_count {
local cam_count cfg
cfg="${WEBCAMD_CFG}"
cam_count="$(crudini --existing=file --get "${cfg}" | \
sed '/webcamd/d' | wc -l)"
echo "${cam_count}"
}
function get_cam_avail {
local conf_cam avail missing
for (( i=1; i<="$(get_cam_count)"; i++ )); do
conf_cam="$(get_param "cam $i" device 2> /dev/null)"
avail="$(find ${conf_cam} 2> /dev/null | wc -l)"
if [ "${avail}" -eq 0 ]; then
missing+=("${conf_cam}")
fi
done
echo "${missing[@]}"
}
#### MAIN
## Args given?
if [ "$#" -eq 0 ]; then
missing_args_msg
exit 1
fi
## Parse Args
while getopts ":Vhc:" arg; do
case "${arg}" in
v )
echo -e "\nwebcamd Version: $(self_version)\n"
exit 0
;;
h )
help_msg
exit 0
;;
c )
check_cfg "${OPTARG}"
WEBCAMD_CFG="${OPTARG}"
;;
\?)
wrong_args_msg
exit 1
;;
esac
done
# Init Traps
trap 'shutdown' 1 2 3 15
trap 'err_exit $? $LINENO' ERR
log_method
init_log_entry
initial_check
construct_streamer
## Loop and Watchdog
while true ; do
log_msg "WATCHDOG: Gather Informations"
log_msg "WATCHDOG: Configured Cam(s): $(get_cam_count)"
if [ -n "$(get_cam_avail)" ]; then
log_msg "WATCHDOG: Lost Device(s): $(get_cam_avail)"
else
log_msg "WATCHDOG: All Device(s) present!"
fi
log_msg "WATCHDOG: Next Check in 2 minutes..."
sleep 120 & sleep_pid="$!"
wait "${sleep_pid}"
done