├── .gitignore
├── .vscode
└── settings.json
├── LICENSE
├── Pipfile
├── Pipfile.lock
├── README.md
├── _config.yml
├── flask_opencv_streamer
├── __init__.py
├── login_manager.py
└── streamer.py
├── setup.py
├── templates
├── fail.html
├── form.html
└── pass.html
└── upload.sh
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | *.egg-info/
24 | .installed.cfg
25 | *.egg
26 | MANIFEST
27 |
28 | # PyInstaller
29 | # Usually these files are written by a python script from a template
30 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
31 | *.manifest
32 | *.spec
33 |
34 | # Installer logs
35 | pip-log.txt
36 | pip-delete-this-directory.txt
37 |
38 | # Unit test / coverage reports
39 | htmlcov/
40 | .tox/
41 | .coverage
42 | .coverage.*
43 | .cache
44 | nosetests.xml
45 | coverage.xml
46 | *.cover
47 | .hypothesis/
48 | .pytest_cache/
49 |
50 | # Translations
51 | *.mo
52 | *.pot
53 |
54 | # Django stuff:
55 | *.log
56 | local_settings.py
57 | db.sqlite3
58 |
59 | # Flask stuff:
60 | instance/
61 | .webassets-cache
62 |
63 | # Scrapy stuff:
64 | .scrapy
65 |
66 | # Sphinx documentation
67 | docs/_build/
68 |
69 | # PyBuilder
70 | target/
71 |
72 | # Jupyter Notebook
73 | .ipynb_checkpoints
74 |
75 | # pyenv
76 | .python-version
77 |
78 | # celery beat schedule file
79 | celerybeat-schedule
80 |
81 | # SageMath parsed files
82 | *.sage.py
83 |
84 | # Environments
85 | .env
86 | .venv
87 | env/
88 | venv/
89 | ENV/
90 | env.bak/
91 | venv.bak/
92 |
93 | # Spyder project settings
94 | .spyderproject
95 | .spyproject
96 |
97 | # Rope project settings
98 | .ropeproject
99 |
100 | # mkdocs documentation
101 | /site
102 |
103 | # mypy
104 | .mypy_cache/
105 | **/.DS_Store
106 | .login
107 | logins
108 | .vscode/
--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "python.linting.pylintEnabled": true,
3 | "python.pythonPath": "/Users/jose/.local/share/virtualenvs/Flask-OpenCV-Streamer--9iRQ23d/bin/python"
4 | }
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/Pipfile:
--------------------------------------------------------------------------------
1 | [[source]]
2 | url = "https://pypi.python.org/simple"
3 | verify_ssl = true
4 | name = "pypi"
5 |
6 | [packages]
7 | twine = "*"
8 |
9 | [dev-packages]
10 |
11 | [requires]
12 | python_version = "3.6"
13 |
--------------------------------------------------------------------------------
/Pipfile.lock:
--------------------------------------------------------------------------------
1 | {
2 | "_meta": {
3 | "hash": {
4 | "sha256": "178b336d8960d38274982f0c0f3e8aa1840b3d36fe6839e7643ceb836db53a54"
5 | },
6 | "pipfile-spec": 6,
7 | "requires": {
8 | "python_version": "3.6"
9 | },
10 | "sources": [
11 | {
12 | "name": "pypi",
13 | "url": "https://pypi.python.org/simple",
14 | "verify_ssl": true
15 | }
16 | ]
17 | },
18 | "default": {
19 | "bleach": {
20 | "hashes": [
21 | "sha256:6123ddc1052673e52bab52cdc955bcb57a015264a1c57d37bea2f6b817af0125",
22 | "sha256:98b3170739e5e83dd9dc19633f074727ad848cbedb6026708c8ac2d3b697a433"
23 | ],
24 | "version": "==3.3.0"
25 | },
26 | "certifi": {
27 | "hashes": [
28 | "sha256:2bbf76fd432960138b3ef6dda3dde0544f27cbf8546c458e60baf371917ba9ee",
29 | "sha256:50b1e4f8446b06f41be7dd6338db18e0990601dce795c2b1686458aa7e8fa7d8"
30 | ],
31 | "version": "==2021.5.30"
32 | },
33 | "chardet": {
34 | "hashes": [
35 | "sha256:0d6f53a15db4120f2b08c94f11e7d93d2c911ee118b6b30a04ec3ee8310179fa",
36 | "sha256:f864054d66fd9118f2e67044ac8981a54775ec5b67aed0441892edb553d21da5"
37 | ],
38 | "version": "==4.0.0"
39 | },
40 | "docutils": {
41 | "hashes": [
42 | "sha256:686577d2e4c32380bb50cbb22f575ed742d58168cee37e99117a854bcd88f125",
43 | "sha256:cf316c8370a737a022b72b56874f6602acf974a37a9fba42ec2876387549fc61"
44 | ],
45 | "version": "==0.17.1"
46 | },
47 | "idna": {
48 | "hashes": [
49 | "sha256:b307872f855b18632ce0c21c5e45be78c0ea7ae4c15c828c20788b26921eb3f6",
50 | "sha256:b97d804b1e9b523befed77c48dacec60e6dcb0b5391d57af6a65a312a90648c0"
51 | ],
52 | "version": "==2.10"
53 | },
54 | "packaging": {
55 | "hashes": [
56 | "sha256:5b327ac1320dc863dca72f4514ecc086f31186744b84a230374cc1fd776feae5",
57 | "sha256:67714da7f7bc052e064859c05c595155bd1ee9f69f76557e21f051443c20947a"
58 | ],
59 | "version": "==20.9"
60 | },
61 | "pkginfo": {
62 | "hashes": [
63 | "sha256:029a70cb45c6171c329dfc890cde0879f8c52d6f3922794796e06f577bb03db4",
64 | "sha256:9fdbea6495622e022cc72c2e5e1b735218e4ffb2a2a69cde2694a6c1f16afb75"
65 | ],
66 | "version": "==1.7.0"
67 | },
68 | "pygments": {
69 | "hashes": [
70 | "sha256:a18f47b506a429f6f4b9df81bb02beab9ca21d0a5fee38ed15aef65f0545519f",
71 | "sha256:d66e804411278594d764fc69ec36ec13d9ae9147193a1740cd34d272ca383b8e"
72 | ],
73 | "version": "==2.9.0"
74 | },
75 | "pyparsing": {
76 | "hashes": [
77 | "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1",
78 | "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b"
79 | ],
80 | "version": "==2.4.7"
81 | },
82 | "readme-renderer": {
83 | "hashes": [
84 | "sha256:63b4075c6698fcfa78e584930f07f39e05d46f3ec97f65006e430b595ca6348c",
85 | "sha256:92fd5ac2bf8677f310f3303aa4bce5b9d5f9f2094ab98c29f13791d7b805a3db"
86 | ],
87 | "version": "==29.0"
88 | },
89 | "requests": {
90 | "hashes": [
91 | "sha256:27973dd4a904a4f13b263a19c866c13b92a39ed1c964655f025f3f8d3d75b804",
92 | "sha256:c210084e36a42ae6b9219e00e48287def368a26d03a048ddad7bfee44f75871e"
93 | ],
94 | "version": "==2.25.1"
95 | },
96 | "requests-toolbelt": {
97 | "hashes": [
98 | "sha256:380606e1d10dc85c3bd47bf5a6095f815ec007be7a8b69c878507068df059e6f",
99 | "sha256:968089d4584ad4ad7c171454f0a5c6dac23971e9472521ea3b6d49d610aa6fc0"
100 | ],
101 | "version": "==0.9.1"
102 | },
103 | "six": {
104 | "hashes": [
105 | "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926",
106 | "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"
107 | ],
108 | "version": "==1.16.0"
109 | },
110 | "tqdm": {
111 | "hashes": [
112 | "sha256:736524215c690621b06fc89d0310a49822d75e599fcd0feb7cc742b98d692493",
113 | "sha256:cd5791b5d7c3f2f1819efc81d36eb719a38e0906a7380365c556779f585ea042"
114 | ],
115 | "version": "==4.61.0"
116 | },
117 | "twine": {
118 | "hashes": [
119 | "sha256:0fb0bfa3df4f62076cab5def36b1a71a2e4acb4d1fa5c97475b048117b1a6446",
120 | "sha256:d6c29c933ecfc74e9b1d9fa13aa1f87c5d5770e119f5a4ce032092f0ff5b14dc"
121 | ],
122 | "index": "pypi",
123 | "version": "==1.13.0"
124 | },
125 | "urllib3": {
126 | "hashes": [
127 | "sha256:753a0374df26658f99d826cfe40394a686d05985786d946fbe4165b5148f5a7c",
128 | "sha256:a7acd0977125325f516bda9735fa7142b909a8d01e8b2e4c8108d0984e6e0098"
129 | ],
130 | "index": "pypi",
131 | "version": "==1.26.5"
132 | },
133 | "webencodings": {
134 | "hashes": [
135 | "sha256:a0af1213f3c2226497a97e2b3aa01a7e4bee4f403f95be16fc9acd2947514a78",
136 | "sha256:b36a1c245f2d304965eb4e0a82848379241dc04b865afcc4aab16748587e1923"
137 | ],
138 | "version": "==0.5.1"
139 | }
140 | },
141 | "develop": {}
142 | }
143 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Flask-OpenCV-Streamer
2 | A Python package for easily streaming OpenCV footage, even with authentication
3 |
4 | ## Installation
5 |
6 | Install via PyPi using Pip / PipEnv:
7 |
8 | `pip install flask_opencv_streamer`
9 |
10 | ## Usage
11 |
12 | Usage is quite straight forward. After importing, you can create as many streamer objects as you wish.
13 |
14 |
15 | ## Example Code:
16 |
17 | ### Without authentication (no login required to view page)
18 |
19 |
20 | ```python
21 | from flask_opencv_streamer.streamer import Streamer
22 | import cv2
23 |
24 | port = 3030
25 | require_login = False
26 | streamer = Streamer(port, require_login)
27 |
28 | # Open video device 0
29 | video_capture = cv2.VideoCapture(0)
30 |
31 | while True:
32 | _, frame = video_capture.read()
33 |
34 | streamer.update_frame(frame)
35 |
36 | if not streamer.is_streaming:
37 | streamer.start_streaming()
38 |
39 | cv2.waitKey(30)
40 | ```
41 |
42 | ### With authentication (A password will be generated for you, expiring every 24 hrs)
43 |
44 | ```python
45 | from flask_opencv_streamer.streamer import Streamer
46 | import cv2
47 |
48 | port = 3030
49 | require_login = True
50 | login_file = "logins.txt"
51 | login_key = "loginkey.txt
52 | streamer = Streamer(port, require_login, login_file=login_file, login_key=login_key)
53 |
54 | # Open video device 0
55 | video_capture = cv2.VideoCapture(0)
56 |
57 | while True:
58 | _, frame = video_capture.read()
59 |
60 | streamer.update_frame(frame)
61 |
62 | if not streamer.is_streaming:
63 | streamer.start_streaming()
64 |
65 | cv2.waitKey(30)
66 | ```
67 |
68 | **If there is no logins file or key found at the path given, it will create one for you**. Logins will be stored in a `.txt` file `logins.txt` but will be **encrypted**. Therefore, unless someone has the key (in this example, `loginkey.txt`) the `logins.txt` file will be able to show logins or passwords. It is very unsafe to keep the login key somewhere publicly accessible; it's suggested you hide it well and do not upload it anywhere.
69 |
70 | ### Adding or removing your own logins
71 |
72 | In your **root project directory**, you can include a `templates` folder which can be used for password change templates. Your file names must be:
73 |
74 | - `form.html`: Contains the HTML form for the password change.
75 | - `pass.html`: Contains the HTML for a pass event
76 | - `fail.html`: Contains the HTML for a fail event
77 |
78 | Samples are included here in this repository
79 |
--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-slate
--------------------------------------------------------------------------------
/flask_opencv_streamer/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oitsjustjose/Flask-OpenCV-Streamer/c22b24f2c89797b4a431fc0ddc486d56a7976a23/flask_opencv_streamer/__init__.py
--------------------------------------------------------------------------------
/flask_opencv_streamer/login_manager.py:
--------------------------------------------------------------------------------
1 | """Handles logins from a file, and encryption of said file"""
2 | import os
3 |
4 | from cryptography.fernet import Fernet
5 |
6 |
7 | class LoginManager:
8 | """A class to handle auth storage, using encryption"""
9 |
10 | def __init__(self, path_to_login_file, keyname):
11 | self.path = path_to_login_file
12 | self.keyname = keyname
13 | self.key = self.load_key()
14 | self.fernet = Fernet(self.key)
15 | self.logins = self.load_logins()
16 |
17 | def __getstate__(self):
18 | """An override for loading this object's state from pickle"""
19 | ret = {"path": self.path, "keyname": self.keyname}
20 | return ret
21 |
22 | def __setstate__(self, dict_in):
23 | """An override for pickling this object's state"""
24 | self.path = dict_in["path"]
25 | self.keyname = dict_in["keyname"]
26 | self.key = self.load_key()
27 | self.fernet = Fernet(self.key)
28 | self.logins = self.load_logins()
29 |
30 | def load_logins(self):
31 | """Loads logins from a file, returning them as a dict"""
32 | logins = {}
33 | if os.path.exists(self.path):
34 | with open(self.path, "r") as file:
35 | lines = file.readlines()
36 | for line in lines:
37 | decrypted_line = self.fernet.decrypt(bytes(line.encode()))
38 | decrypted_line = decrypted_line.decode()
39 | username, password = (
40 | decrypted_line.replace(" ", "")
41 | .replace("\n", "")
42 | .replace("\t", "")
43 | .split(",")
44 | )
45 | logins[username] = password
46 | return logins
47 |
48 | def write_logins(self):
49 | """Writes the logins to an encryptedfile"""
50 | if os.path.exists(self.path):
51 | os.remove(self.path)
52 | with open(self.path, "w") as file:
53 | for username in self.logins:
54 | file.write(self.encrypt_line(username) + "\n")
55 |
56 | def add_login(self, username, password):
57 | """Adds a new username and password, writing changes afterward"""
58 | if username in list(self.logins.keys()):
59 | print("Login pair not added; login {} already exists".format(username))
60 | else:
61 | self.logins[username] = password
62 | self.write_logins()
63 |
64 | def remove_login(self, username):
65 | """Removes a username and password, writing changes afterward"""
66 | if not username in list(self.logins.keys()):
67 | print("Login not found - no deletion was made")
68 | else:
69 | del self.logins[username]
70 | self.write_logins()
71 |
72 | def encrypt_line(self, username):
73 | """Encrypts a username/password line for the txt file and converts to str"""
74 | ret = "{}, {}".format(username, self.logins[username]).encode()
75 | ret = bytes(ret)
76 | ret = self.fernet.encrypt(ret)
77 | return str(ret.decode("utf-8"))
78 |
79 | def load_key(self):
80 | """Loads the key from a hidden location"""
81 | token = ""
82 | if os.path.exists(self.keyname):
83 | with open(self.keyname, "r") as file:
84 | lines = file.readlines()
85 | for line in lines:
86 | token = line.replace("\n", "")
87 | break
88 | else:
89 | token = Fernet.generate_key()
90 | with open(self.keyname, "w+") as file:
91 | file.write(token.decode("utf-8"))
92 | if isinstance(token, bytes):
93 | return bytes(token)
94 | return bytes(token.encode())
95 |
--------------------------------------------------------------------------------
/flask_opencv_streamer/streamer.py:
--------------------------------------------------------------------------------
1 | """Stores a Streamer class"""
2 | import time
3 | from datetime import datetime
4 | from functools import wraps
5 | from threading import Thread
6 |
7 | import cv2
8 | from cryptography.fernet import Fernet
9 | from flask import Flask, Response, render_template, request
10 |
11 | from .login_manager import LoginManager
12 |
13 |
14 | class Streamer:
15 | """A clean wrapper class for a Flask OpenCV Video Streamer"""
16 |
17 | def __init__(
18 | self,
19 | port,
20 | requires_auth,
21 | stream_res=(1280, 720),
22 | frame_rate=30,
23 | login_file="logins",
24 | login_key=".login",
25 | ):
26 | self.flask_name = "{}_{}".format(__name__, port)
27 | self.login_file = login_file
28 | self.login_key = login_key
29 | self.flask = Flask(self.flask_name)
30 | self.frame_to_stream = None
31 | self.guest_password = None
32 | self.password_create_time = None
33 | self.thread = None
34 | self.is_streaming = False
35 | self.port = port
36 | self.req_auth = requires_auth
37 | self.stream_res = stream_res
38 | self.frame_rate = frame_rate
39 | if requires_auth:
40 | self.generate_guest_password()
41 | self.login_manager = LoginManager(login_file, login_key)
42 |
43 | def __getstate__(self):
44 | """An override for loading this object's state from pickle"""
45 | ret = {
46 | "flask_name": self.flask_name,
47 | "port": self.port,
48 | "req_auth": self.req_auth,
49 | "stream_res": self.stream_res,
50 | "login_file": self.login_file,
51 | "login_key": self.login_key,
52 | }
53 | return ret
54 |
55 | def __setstate__(self, dict_in):
56 | """An override for pickling this object's state"""
57 | self.flask_name = dict_in["flask_name"]
58 | self.flask = Flask(self.flask_name)
59 | self.frame_to_stream = None
60 | self.guest_password = None
61 | self.password_create_time = None
62 | self.thread = None
63 | self.is_streaming = False
64 | self.port = dict_in["port"]
65 | self.req_auth = dict_in["req_auth"]
66 | self.stream_res = dict_in["stream_res"]
67 | if self.req_auth:
68 | self.generate_guest_password()
69 | self.login_manager = LoginManager(
70 | dict_in["login_file"], dict_in["login_key"]
71 | )
72 |
73 | def start_streaming(self):
74 | """Starts the video stream hosting process"""
75 | gen_function = self.gen
76 |
77 | @self.flask.route("/video_feed")
78 | @self.requires_auth
79 | def video_feed():
80 | """Route which renders solely the video"""
81 | return Response(
82 | gen_function(), mimetype="multipart/x-mixed-replace; boundary=jpgboundary"
83 | )
84 |
85 | @self.flask.route("/")
86 | @self.requires_auth
87 | def index():
88 | """Route which renders the video within an HTML template"""
89 | return render_template("index.html")
90 |
91 | @self.flask.route("/guest")
92 | @self.requires_auth
93 | def guest():
94 | """Route which shows a logged in user the current guest password and how long it'll work"""
95 | if self.req_auth:
96 | return "The current guest password is:
{}
Password will expire {}".format(
97 | self.guest_password,
98 | str(datetime.fromtimestamp(self.password_create_time + 86400)),
99 | )
100 | else:
101 | return "Auth not required, this page is not needed"
102 |
103 | @self.flask.route("/change password")
104 | def change_password():
105 | """Route which allows an authenticated user to chagne their password"""
106 | if self.req_auth:
107 | return render_template("form.html")
108 | else:
109 | return "Auth not required, this page is not needed"
110 |
111 | @self.flask.route("/change password result", methods=["POST", "GET"])
112 | def result():
113 | """Route which responds to a change_password input"""
114 | if request.method == "POST":
115 | result = request.form
116 |
117 | # Confirmation password didn't match
118 | if result["pw"] != result["pw_conf"]:
119 | return render_template(
120 | "fail.html", reason="New passwords did not match"
121 | )
122 | # No username exists
123 | if result["username"] not in list(self.login_manager.logins.keys()):
124 | return render_template("fail.html", reason="Username doesn't exist")
125 | # Old password wrong
126 | if result["old_pw"] != self.login_manager.logins[result["username"]]:
127 | return render_template(
128 | "fail.html", reason="Old password was incorrect"
129 | )
130 |
131 | self.login_manager.remove_login(result["username"])
132 | self.login_manager.add_login(result["username"], result["pw"])
133 | return render_template("pass.html")
134 |
135 | self.thread = Thread(
136 | daemon=True,
137 | target=self.flask.run,
138 | kwargs={
139 | "host": "0.0.0.0",
140 | "port": self.port,
141 | "debug": False,
142 | "threaded": True,
143 | },
144 | )
145 | self.thread.start()
146 | self.is_streaming = True
147 |
148 | def update_frame(self, frame):
149 | """Updates the frame for streaming"""
150 | self.frame_to_stream = self.get_frame(frame)
151 |
152 | def get_frame(self, frame):
153 | """Encodes the OpenCV image to a 1280x720 image"""
154 | _, jpeg = cv2.imencode(
155 | ".jpg",
156 | cv2.resize(frame, self.stream_res),
157 | params=(cv2.IMWRITE_JPEG_QUALITY, 70),
158 | )
159 | return jpeg.tobytes()
160 |
161 | def gen(self):
162 | """A generator for the image."""
163 | header = "--jpgboundary\r\nContent-Type: image/jpeg\r\n"
164 | prefix = ""
165 | while True:
166 | # frame = self.frame_to_stream
167 | msg = (
168 | prefix
169 | + header
170 | + "Content-Length: {}\r\n\r\n".format(len(self.frame_to_stream))
171 | )
172 |
173 | yield (msg.encode("utf-8") + self.frame_to_stream)
174 | prefix = "\r\n"
175 | time.sleep(1 / self.frame_rate)
176 |
177 | def check_auth(self, username, password):
178 | """Dummy thing to check password"""
179 | # Generate a password if there is no password OR the one given is older than 24hrs
180 | if (
181 | self.guest_password is None
182 | or (time.time() - self.password_create_time) > 86400
183 | ) and self.req_auth:
184 | self.generate_guest_password()
185 | # Refresh the login manager's logins from the disk, in case a new login has been generated
186 | self.login_manager.logins = self.login_manager.load_logins()
187 | # Check the login manager for a match first
188 | if username in list(self.login_manager.logins.keys()):
189 | return password == self.login_manager.logins[username]
190 |
191 | # Otherwise check if it's the guest acct
192 | return username == "guest" and password == self.guest_password
193 |
194 | def authenticate(self):
195 | """Sends a 401 response that enables basic auth"""
196 | return Response(
197 | "Authentication Failed. Please reload to log in with proper credentials",
198 | 401,
199 | {"WWW-Authenticate": 'Basic realm="Login Required"'},
200 | )
201 |
202 | def requires_auth(self, func):
203 | """A custom decorator for Flask streams"""
204 |
205 | @wraps(func)
206 | def decorated(*args, **kwargs):
207 | if self.req_auth:
208 | auth = request.authorization
209 | if not auth or not self.check_auth(auth.username, auth.password):
210 | return self.authenticate()
211 | return func(*args, **kwargs)
212 | else:
213 | return func(*args, **kwargs)
214 |
215 | return decorated
216 |
217 | def generate_guest_password(self):
218 | """Generates and prints a random password on creation"""
219 | print("Generating Flask password")
220 | self.guest_password = str(Fernet.generate_key().decode())
221 | self.password_create_time = time.time()
222 | print(
223 | "Password for stream on Port: {} is\n {}".format(
224 | self.port, self.guest_password
225 | )
226 | )
227 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | """Main setup for submitting to PyPi"""
2 | import setuptools
3 |
4 |
5 | def main():
6 | """Main setup for submitting to PyPi"""
7 | with open("README.md", "r") as fh:
8 | long_description = fh.read()
9 |
10 | setuptools.setup(
11 | name="flask_opencv_streamer",
12 | version="1.4",
13 | url="https://github.com/oitsjustjose/Flask-OpenCV-Streamer",
14 | author="Jose Stovall",
15 | author_email="stovallj1995@gmail.com",
16 | description="A Python package for easily streaming OpenCV footage, even with authentication",
17 | long_description=long_description,
18 | long_description_content_type="text/markdown",
19 | license="GNU General Public License 3",
20 | packages=setuptools.find_packages(),
21 | install_requires=["cryptography", "flask", "opencv-python"],
22 | )
23 |
24 |
25 | if __name__ == "__main__":
26 | main()
27 |
--------------------------------------------------------------------------------
/templates/fail.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | {{reason}}
7 |
8 |
9 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/templates/form.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
30 |
31 |
32 |
33 |
--------------------------------------------------------------------------------
/templates/pass.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
9 |
10 |
11 | {{reason}}
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/upload.sh:
--------------------------------------------------------------------------------
1 | #/bin/bash
2 |
3 | pipenv run python setup.py sdist bdist_wheel
4 | python3 -m twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
--------------------------------------------------------------------------------