mirror
/
esp32_composite_video_lib
kopia lustrzana https://github.com/aquaticus/esp32_composite_video_lib
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Initial

main
aquaticus 2022-03-20 14:22:58 +01:00
commit ac1f3720fb
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 9E4441F6F3B07930
15 zmienionych plików z 14516 dodań i 0 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

4
.gitignore vendored 100644
Wyświetl plik

@ -0,0 +1,4 @@
build/
.vscode/
.idea/
.settings/

3
CMakeLists.txt 100644
Wyświetl plik

@ -0,0 +1,3 @@
idf_component_register(SRCS "lvgl_driver_video.c" "video.c" "diag.c"
INCLUDE_DIRS "include" )

93
Kconfig 100644
Wyświetl plik

@ -0,0 +1,93 @@
menu "Composite Video Configuration"
config VIDEO_PAL_OFFSET_Y
int "Const top offset for PAL"
default 11
help
The value is added to computed vertical position.
In scanlines. It can be negative.
config VIDEO_NTSC_OFFSET_Y
int "Const top offset for NTSC"
default 7
help
The value is added to computed vertical position.
In scanlines. It can be negative.
config VIDEO_ENABLE_LVGL_SUPPORT
bool "Enable support for LVGL graphics library"
default y
help
LVGL is an open-source graphics library providing GUI
graphical elements and visual effects.
Website https://lvgl.io/
if VIDEO_ENABLE_LVGL_SUPPORT
config LVGL_STATS
bool "Enable LVGL buffer write stats"
default false
help
Displays stats every second.
config LVGL_VSYNC
bool "Synchronize content updates with VSYNC"
default true
help
Smooth animations but update rate may decrease.
Does not work for direct frame buffer access.
config VIDEO_LVGL_INCLUDE_PATH
string "Path to lvgl.h header"
default "../../lvgl/lvgl.h"
help
Relative or absolute path to lvgl.h file from LVGL component
endif
config VIDEO_ENABLE_DIAG_PIN
bool "Enable diagnostic pin"
default n
help
When enabled specified pin is set high at the begining of the scan line or the field.
Use as extranal trigger source for osciloscope or logic analyzer.
It can be also used to measure timings.
if VIDEO_ENABLE_DIAG_PIN
config VIDEO_DIAG_PIN_NUMBER
int "Diagnostic GPIO pin number"
default 4
help
GPIO pin number. You can use any output pin.
choice VIDEO_TRIGGER_MODE
prompt "Trigger mode"
default VIDEO_TRIGGER_MODE_FIELD
help
When diagnostic pin is high and low.
config VIDEO_TRIGGER_MODE_LINE
bool "Line"
config VIDEO_TRIGGER_MODE_FIELD
bool "Field"
config VIDEO_TRIGGER_MODE_ISR
bool "ISR"
config VIDEO_TRIGGER_MODE_CUSTOM
bool "Custom"
endchoice
endif
config VIDEO_DIAG_ENABLE_INTERRUPT_STATS
bool "Enable interrupt time stats"
default n
help
Periodically write interrupt timing stats on the log.
config VIDEO_DIAG_DISPLAY_TEST_FUNC
bool "Enable display_test_image() function"
default n
help
Compiles function to display test patterns including Philips PM5544
endmenu

674
LICENSE 100644
Wyświetl plik

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
<http://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
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

251
README.md 100644
Wyświetl plik

@ -0,0 +1,251 @@
![Demo Slides](doc/esp32_composite_video_demo.gif)
# Introduction
*ESP32 Composite Video Library* is a library that provides functions to generate
composite video signal without any external hardware on ESP32 chips.
For now, color is not supported.
## Features
* No external components required
* Supports **PAL**, **SECAM** and **NTSC**
* Multiple resolutions
* 6 pixel clocks:
* 14.75 MHz and 7.357 MHz – PAL square pixels
* 12.273 MHz and 8.136 MHz – NTSC square pixels
* 13.5 MHz and 6.75 MHz – PAL and NTSC BT.601 DV/DVD formats
* Different framebuffer formats:
* RGB565
* RGB332
* Grey 8 bits/pixel
* Grey 4 bits/pixel
* Monochrome 1 bit/pixel
* LVGL monochrome 1 byte/pixel
* Supports [LVGL](https://lvgl.io) graphics library
## Applications
* infotainment systems
* emulators
* 8 bit style game consoles
* video diagnostic
## License
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.
# Requirements
The library should work on any ESP32 board with Tensilica core and free GPIO25 pin. The test environment was as follows:
| Name | Value |
|------|--------|
|Chip |ESP32 |
|Cores |2 |
|RAM |520 KiB |
|FLASH |4 MiB |
|Clock |240 MHz |
No external elements are required. Composite signal is generated on **GPIO25** pin, and it can be directly connected to composite input.
It requires ESP32-IDF development environment. Version 4.4 was used.
>:information_source: Compiler optimization level must be set to **performance** (`-O2`).
# Composite video
Composite video is an analog video signal. It was commonly used before the digital era.
There are three variants of composite video: NTSC, PAL, and SECAM. NTSC generates 30 frames per second using 525 lines. PAL and SECAM generates 25 frames per seconds in 625 lines.
## Connection
Connect **GPIO25** to composite video input and board **GND** to input GND.
If you use a CINCH (RCA) cable, the video signal goes to the pin in the middle, and GND to the outside metal part.
![CINCH connection](doc/esp32_board_cinch.png)
## Modes
The library can generate any resolution in non-interlaced mode.
Here is a list of predefined commonly used resolutions:
|Resolution | System | Pixel clock | Description |
------------|---------|-------------|------------------------------------------|
384×288 |PAL/SECAM|7.357 MHz |Overscan non-interlaced
320×256 |PAL/SECAM|7.357 MHz |Amiga PAL low res non-interlaced
320×200 |PAL/SECAM|7.357 MHz |Commodore 64 hi res mode
320×192 |PAL/SECAM|7.357 MHz |Atari 8 bit "Graphics 8"
256×192 |PAL/SECAM|7.357 MHz |ZX Spectrum, MSX
640×200 |PAL/SECAM|14.75 MHz |Amstrad CPC hi res
640×256 |PAL/SECAM|14.75 MHz |Amiga PAL hi res non-interlaced
512×192 |PAL/SECAM|14.75 MHz |Timex, Sinclair QL, MSX2
768×288 |PAL/SECAM|7.357 MHz |Overscan hi res non-interlaced
360×288 |PAL/SECAM|6.75 MHz |BT.601 DV/DVD non-interlaced
720×288 |PAL/SECAM|13.5 MHz |BT.601 DV/DVD hi res non-interlaced
256×192 |NTSC |6.136 MHz |ZX Spectrum, MSX
320×192 |NTSC |6.136 MHz |Atari 8 bit "Graphics 8"
320×200 |NTSC |6.136 MHz |Commodore 64 hi res mode
640×200 |NTSC |13.5 MHz |Amiga NTSC hi res non-interlaced
320×240 |NTSC |6.136 MHz |NTSC Overscan square pixels
640×240 |NTSC |13.5 MHz |NTSC Overscan, non-interlaced
360×240 |NTSC |13.5 MHz |BT.601 DV/DVD hi-res non-interlaced
720×240 |NTSC |13.5 MHz |BT.601 DV/DVD hi-res non-interlaced
# How to use
Add the library as a new component to your project.
```bash
git submodule add https://github.com/aquaticus/esp32_composite_video_lib.git components/esp32_composite_video_lib
```
The above command will clone the library into the `components` directory.
You can optionally launch the configuration menu with `idf.py menuconfig` on your project root directory. Go to Component config and then `Composite Video Configuration`.
To use LVGL library along composite video library add one more submodule:
```bash
git clone add https://github.com/lvgl/lvgl.git components/lvgl
```
# Sample program
To see something on your screen, create the simplest program.
```C
#include "video.h"
void app_main(void)
{
video_test_pal(VIDEO_TEST_PM5544);
}
```
The above program will display Philips PM5544 pattern in PAL 384x288 resolution. For NTSC, replace function to `video_test_ntsc()`.
## Demo
Demo program is available on separate repository: https://github.com/aquaticus/esp32_composite_video_demo
Clone the repository:
```bash
git clone --recurse-submodules https://github.com/aquaticus/esp32_composite_video_demo
```
Build
```bash
cd esp32_composite_video_demo
idf.py build
```
and upload to the board
```bash
idf.py flash
```
# API
The library provides functions to setup image generation but not functions to draw lines or other graphics primitives.
To create graphical elements and visual effects, see the next chapter about integration with LVGL library.
#### `void video_graphics(GRAPHICS_MODE mode, FRAME_BUFFER_FORMAT fb_format)`
This is the top level function to start generating graphics. You can use one of the predefined resolutions and clock modes.
The second argument is framebuffer format. It basically defines the number of available colors or gray shadows on the screen.
#### `void video_init(uint16_t width, uint16_t height, FRAME_BUFFER_FORMAT fb_format, VIDEO_MODE mode, bool hires_pixel_width)`
This is more advanced function than `video_graphics()`. It allows using custom resolutions.
#### `uint8_t* video_get_frame_buffer_address(void)`
Gets the address of the framebuffer.
#### `uint8_t* video_get_frame_buffer_size(void)`
Gets the size of framebuffer.
#### `uint16_t video_get_width(void)`
Gets horizontal resolution.
#### `uint16_t video_get_height(void)`
Gets vertical resolution.
#### `void video_wait_frame(void)`
Waits for one frame to be displayed. Use this function to synchronize graphics with frame refresh.
#### `void video_get_mode_description(char* buffer, size_t buffer_size)`
Returns text description of the current video mode and resolution, e.g. `PAL 320x200`.
#### `void video_stop(void)`
Stops video generation and free resources.
#### `void video_show_stats(void)`
Writes statistics to the log. Available only if defined `CONFIG_VIDEO_DIAG_ENABLE_INTERRUPT_STATS`.
# LVGL
The library provides integration with LVGL graphics library. **Version 8.3** was tested.
To initialize library with LVGL include `lvgl_driver_video.h` file and call `lv_video_disp_init()` or `lv_video_disp_init_buf()`.
## Color depth
This is LVGL configuration setting. It defines the number of colors on the screen. Use `idf.py menuconfig` to set.
There are 3 color depths supported:
* **1 byte per pixel** – monochromatic mode
* **RGB232** – color mode 1 byte per pixel
* **RGB565** – color mode 2 bytes per pixel
*ARGB8888* mode is not supported.
## Framebuffer access mode
The library provides two methods of framebuffer update.
### Direct framebuffer access
In this mode, LVGL access directly framebuffer. No additional buffer is allocated.
You may notice parts of the screen are blinking if redrawing takes a couple of milliseconds (even if VSYNC is enabled).
Use this mode as a default one, especially if there are no time-consuming effects on the screen.
Use`lv_video_disp_init()`.
### Buffered framebuffer access
In this mode, additional buffer is used. This force LVGL to update the screen in pieces.
This results in smoother animations but consumes additional amount of memory.
The size of the buffer is an argument for `lv_video_disp_init()`. It is the number of pixels to reserve.
For example, to define 320×100 pixels buffer pass 320×100=**32000**.
Note that defining small buffer and enabling synchronization with VSYNC will result in low animation frame rate.
Use`lv_video_disp_init_buf()` and specify pointer to pixel buffer.
For `1 byte per pixel` color depth, the library uses more memory effective framebuffer mode. It stores 8 pixels in one byte.
For monochrome mode it is better to use buffered access as it saves memory. Unfortunately, additional buffer still uses 1 pixel per byte, so keep it as small as possible.
### Animations
To see smooth animations, you should enable synchronization with VSYNC. This allows the rendering to update at the same time as when your monitor updates during vertical refresh. However, you may notice tearing effect when LVGL redraw takes more time than one frame (>15–20ms) in direct framebuffer access mode. That happens for complicated content or visual effects.
To eliminate tearing effect, you may use buffered mode. But this may decrease frame rate in specific situations.
If the buffer is small and update area is big, LVGL updates the image several times one piece in a time. If update is synchronized with
VSYNC, one operation is every 20ms for PAL or 16ms for NTSC. For example, for 5 updates it always takes 100ms (PAL)
regardless of actual update time. This in effect gives maximum 10 frames per second.

192
diag.c 100644
Wyświetl plik

@ -0,0 +1,192 @@
/*
ESP32 Composite Video Library
Copyright (C) 2022 aquaticus
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 <http://www.gnu.org/licenses/>.
*/
#include "sdkconfig.h"
#if CONFIG_VIDEO_DIAG_DISPLAY_TEST_FUNC
#include <esp_log.h>
#include "esp_system.h"
#include <assert.h>
#include <string.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "video.h"
static const char* TAG = "VIDEO";
#define HEADER_PIXEL(data,pixel) {\
pixel[0] = (((data[0] - 33) << 2) | ((data[1] - 33) >> 4)); \
pixel[1] = ((((data[1] - 33) & 0xF) << 4) | ((data[2] - 33) >> 2)); \
pixel[2] = ((((data[2] - 33) & 0x3) << 6) | ((data[3] - 33))); \
data += 4; \
}
#include "Philips_PM5544_384x288.h"
#include "Philips_PM5544_320x240.h"
static void display_pm554(bool pal_resolution)
{
uint8_t pixel[3];
uint8_t grey1,grey2;
uint8_t mask;
const char* p= pal_resolution ? pm5544_384x288_data : pm5544_320x240_data;
const size_t ratio = 8/g_video_signal.bits_per_pixel;
for(unsigned int y=0; y<g_video_signal.height_pixels; y++)
{
for(unsigned int x=0;x<g_video_signal.width_pixels/ratio; x++)
{
HEADER_PIXEL(p, pixel);
grey1 = 0.30*pixel[0] + 0.59*pixel[1] + 0.11*pixel[2];
if( g_video_signal.bits_per_pixel == 4 )
{
HEADER_PIXEL(p, pixel);
grey2 = 0.30*pixel[0] + 0.59*pixel[1] + 0.11*pixel[2];
g_video_signal.frame_buffer[y*g_video_signal.width_pixels/ratio+x] = (grey2/16) << 4 | (grey1/16);
}
else if(g_video_signal.bits_per_pixel == 8)
{
g_video_signal.frame_buffer[y*g_video_signal.width_pixels+x] = grey1;
}
else if(g_video_signal.bits_per_pixel == 1)
{
const uint8_t WHITE_LEVEL = 128;
mask = 0;
int i=8;
while(i--)
{
// 8 pixels
HEADER_PIXEL(p, pixel);
grey1 = 0.30*pixel[0] + 0.59*pixel[1] + 0.11*pixel[2];
if( grey1 >= WHITE_LEVEL )
{
mask |= 1U<<i;
}
}
g_video_signal.frame_buffer[y*g_video_signal.width_pixels/ratio+x] = mask;
}
else
{
assert(false);
}
}
}
}
static void display_test_image_checkers(void)
{
memset(g_video_signal.frame_buffer, 0, g_video_signal.frame_buffer_size_bytes);
for (uint8_t* it = g_video_signal.frame_buffer; it < g_video_signal.frame_buffer + g_video_signal.frame_buffer_size_bytes; it += 20)
{
memset(it, 0xFF, 20);
if (((it - g_video_signal.frame_buffer) + 40) % (20 * 400) == 0)
{
it += 40;
}
else if (((it - g_video_signal.frame_buffer) + 20) % (20 * 400) != 0)
{
it += 20;
}
}
}
static void display_test_image_white(void)
{
memset(g_video_signal.frame_buffer, 0xFF, g_video_signal.frame_buffer_size_bytes);
}
#if CONFIG_VIDEO_DIAG_ENABLE_INTERRUPT_STATS
static void stat_loop(void)
{
ESP_LOGI(TAG, "Stats Loop");
int n = 5;
while(n--)
{
vTaskDelay(5*1000/portTICK_PERIOD_MS); //5s
video_show_stats();
}
}
#endif
void video_test_pal(VIDEO_TEST_TYPE test)
{
switch (test)
{
case VIDEO_TEST_CHECKERS:
ESP_LOGI(TAG, "PAL Display test checkers");
video_init(320, 200, FB_FORMAT_GREY_8BPP, VIDEO_MODE_PAL, false);
display_test_image_checkers();
break;
case VIDEO_TEST_PM5544:
ESP_LOGI(TAG, "PAL Display test PM5544");
video_init(384, 288, FB_FORMAT_GREY_8BPP, VIDEO_MODE_PAL, false);
display_pm554(true);
break;
default:
case VIDEO_TEST_WHITE:
ESP_LOGI(TAG, "PAL Display test white");
video_init(384, 288, FB_FORMAT_GREY_8BPP, VIDEO_MODE_PAL, false);
display_test_image_white();
break;
}
#if CONFIG_VIDEO_DIAG_ENABLE_INTERRUPT_STATS
stat_loop();
#endif
}
void video_test_ntsc(VIDEO_TEST_TYPE test)
{
switch (test)
{
case VIDEO_TEST_CHECKERS:
ESP_LOGI(TAG, "NTSC Display test checkers");
video_init(320, 240, FB_FORMAT_GREY_8BPP, VIDEO_MODE_NTSC, false);
display_test_image_checkers();
break;
case VIDEO_TEST_PM5544:
ESP_LOGI(TAG, "NTSC Display test PM5544");
video_init(320, 240, FB_FORMAT_GREY_8BPP, VIDEO_MODE_PAL, false);
display_pm554(false);
break;
case VIDEO_TEST_WHITE:
ESP_LOGI(TAG, "NTSC Display test white");
video_init(320, 240, FB_FORMAT_GREY_8BPP, VIDEO_MODE_NTSC, false);
display_test_image_white();
break;
}
#if CONFIG_VIDEO_DIAG_ENABLE_INTERRUPT_STATS
stat_loop();
#endif
}
#endif

BIN
doc/esp32_board_cinch.png 100644
Wyświetl plik

Plik binarny nie jest wyświetlany.
Side by Side

Po

Szerokość:  |  Wysokość:  |  Rozmiar: 64 KiB

BIN
doc/esp32_composite_video_demo.gif 100644
Wyświetl plik

Plik binarny nie jest wyświetlany.
Side by Side

Po

Szerokość:  |  Wysokość:  |  Rozmiar: 1.4 MiB

3
idf_component.yml 100644
Wyświetl plik

@ -0,0 +1,3 @@
version: "1.0.0"
description: ESP32 Composite Video library. Display images on TV or monitor with composite input.
url: https://github.com/aquaticus/esp32_composite_video_lib

4810
include/Philips_PM5544_320x240.h 100644
Wyświetl plik

Plik diff jest za duży Load Diff

6922
include/Philips_PM5544_384x288.h 100644
Wyświetl plik

Plik diff jest za duży Load Diff

30
include/lvgl_driver_video.h 100644
Wyświetl plik

@ -0,0 +1,30 @@
/*
ESP32 Composite Video Library
Copyright (C) 2022 aquaticus
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 <http://www.gnu.org/licenses/>.
*/
#if CONFIG_VIDEO_ENABLE_LVGL_SUPPORT
#pragma once
#include "video.h"
#include CONFIG_VIDEO_LVGL_INCLUDE_PATH
void lv_video_disp_init(GRAPHICS_MODE mode);
void lv_video_disp_init_buf(GRAPHICS_MODE mode, lv_color_t* pixel_buffer, uint32_t buffer_pixel_count);
#endif

167
include/video.h 100644
Wyświetl plik

@ -0,0 +1,167 @@
/*
ESP32 Composite Video Library
Copyright (C) 2022 aquaticus
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 <http://www.gnu.org/licenses/>.
*/
#pragma once
#include "sdkconfig.h"
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#define COMPOSITE_EVENT_FRAME_END_BIT (1<<0)
#define COMPOSITE_EVENT_FRAME_VISIBLE_END_BIT (1<<1)
#define COMPOSITE_EVENT_LINE_STARTS_BIT (1<<2)
/**
* @brief Video modes.
*
*/
typedef enum _VIDEO_MODE
{
VIDEO_MODE_PAL, ///< PAL, typically Europe 50 frames/second, max 625 scan lines. 14.75MHz or 7.375 MHz.
VIDEO_MODE_NTSC, ///< NTSC, typically USA and Japan, 60 frames/second, max 525 scan lines. 12.273 or or 6.136 MHz.
VIDEO_MODE_PAL_BT601, ///< As \c VIDEO_MODE_PAL but using 13.5 or 6.75 MHz.
VIDEO_MODE_NTSC_BT601, ///< As \c VIDEO_MODE_NTSC but using 13.5 or 6.75 MHz.
} VIDEO_MODE;
/**
* @brief Predefined video_graphics modes.
*
* The list includes modes for PAL and NTSC.
*
*/
typedef enum _GRAPHICS_MODE
{
PAL_384x288, ///< PAL Overscan low res
PAL_320x256, ///< PAL Amiga low res non-interlaced
PAL_320x200, ///< PAL Commodore 64 and others
PAL_320x192, ///< PAL Atari 8 bit "Graphics 8"
PAL_256x192, ///< PAL ZX Spectrum, MSX
PAL_640x200, ///< PAL Hi res video_graphics, e.g. Amstrad CPC
PAL_640x256, ///< PAL Amiga hi res non-interlaced
PAL_512x192, ///< Timex, Sinclair QL, MSX2
PAL_768x288, ///< PAL Overscan hi res;
PAL_360x288, ///< PAL Overscan DV/BT.601 (6.75 MHz)
PAL_720x288, ///< PAL Overscan DV/BT.601 (13.5 MHz), non-interlaced
NTSC_256x192, ///< NTSC ZX Spectrum, MSX
NTSC_320x192, ///< NTSC Atari 8 bit "Graphics 8"
NTSC_320x200, ///< NTSC Commodore 64 and others
NTSC_640x200, ///< NTSC Hi res video_graphics, e.g. Amstrad CPC
NTSC_320x240, ///< NTSC Overscan square pixels
NTSC_640x240, ///< NTSC Overscan, non-interlaced
NTSC_360x240, ///< NTSC Overscan DV/BT.601 (6.75 MHz)
NTSC_720x240, ///< NTSC Overscan DV/BT.601 (13.5 MHz), non-interlaced
} GRAPHICS_MODE;
typedef enum _VSYNC_PULSE_LENGTH
{
VSYNC_PULSE_SHORT,
VSYNC_PULSE_LONG
} VSYNC_PULSE_LENGTH;
typedef enum _DAC_FREQUENCY
{
DAC_FREQ_PAL_14_75MHz=14750004, // 14.75 MHz PAL square pixels 640 horizontal
DAC_FREQ_PAL_7_357MHz=7375002, // 7.375 MHz PAL square pixels 320 horizontal
DAC_FREQ_NTSC_12_273MHz=12272720, //12.273 MHz NTSC 640 pixels
DAC_FREQ_NTSC_6_136MHz=6136360, // 6.136 MHz NTSC 320 pixels
DAC_FREQ_PAL_NTSC_13_5MHz=13500001, // 13.5 MHz BT.601 640 pixels
DAC_FREQ_PAL_NTSC_6_75MHz=6750000 // 6.75 MHz BT.601 320 pixels
} DAC_FREQUENCY;
/**
* @brief Frame buffer format.
*
* This directly affects the number of colors on the screen.
*
*/
typedef enum _FRAME_BUFFER_FORMAT
{
FB_FORMAT_GREY_1BPP, ///< black and white only
FB_FORMAT_GREY_4BPP, ///< 16 shadows
FB_FORMAT_GREY_8BPP, ///< in theory 256 shadows, in practice 77-23=54 when no voltage divider used for DAC output, or 180 with voltage divider.
FB_FORMAT_RGB_8BPP, ///< 3-3-2 color
FB_FORMAT_RGB_16BPP, ///< 5-6-5 color
#if CONFIG_VIDEO_ENABLE_LVGL_SUPPORT
FB_FORMAT_LVGL_1BPP, //< 1 bit color, pixel stored in one byte. LVGL video_graphics library compatible.
#endif
} FRAME_BUFFER_FORMAT;
typedef void (*p_pixel_render_func)(void);
typedef struct _VIDEO_SIGNAL_PARAMS
{
VIDEO_MODE video_mode;
uint16_t width_pixels;
uint16_t height_pixels;
uint16_t offset_x_samples;
uint16_t offset_y_lines;
uint16_t hsync_samples;
uint16_t vsync_long_samples;
uint16_t vsync_short_samples;
uint16_t samples_per_line;
uint16_t front_porch_samples;
uint16_t back_porch_samples;
uint16_t line_duration_us; ///< One scanline duration in microseconds
uint16_t number_of_lines; ///< number of scanlines; different for PAL and NTSC
uint32_t dac_frequency; ///< DAC frequency in Hz
uint8_t* frame_buffer;
uint8_t bits_per_pixel;
uint32_t frame_buffer_size_bytes;
void (*pixel_render_func)(void);
} VIDEO_SIGNAL_PARAMS;
#if CONFIG_VIDEO_DIAG_DISPLAY_TEST_FUNC
typedef enum _TEST_VIDEO_TYPE
{
VIDEO_TEST_WHITE,
VIDEO_TEST_CHECKERS,
VIDEO_TEST_PM5544
} VIDEO_TEST_TYPE;
void video_test_pal(VIDEO_TEST_TYPE test);
void video_test_ntsc(VIDEO_TEST_TYPE test);
#endif
extern volatile VIDEO_SIGNAL_PARAMS g_video_signal;
void video_init(uint16_t width, uint16_t height, FRAME_BUFFER_FORMAT fb_format, VIDEO_MODE mode, bool hires_pixel_width);
uint8_t* video_get_frame_buffer_address(void);
uint8_t* video_get_frame_buffer_size(void);
uint16_t video_get_width(void);
uint16_t video_get_height(void);
void video_graphics(GRAPHICS_MODE mode, FRAME_BUFFER_FORMAT fb_format);
void video_wait_frame(void);
void video_get_mode_description(char* buffer, size_t buffer_size);
void video_stop(void);
#if CONFIG_VIDEO_DIAG_ENABLE_INTERRUPT_STATS
void video_show_stats(void);
#endif

303
lvgl_driver_video.c 100644
Wyświetl plik

@ -0,0 +1,303 @@
/*
ESP32 Composite Video Library
Copyright (C) 2022 aquaticus
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 <http://www.gnu.org/licenses/>.
*/
/// @file
#include "sdkconfig.h"
#if CONFIG_VIDEO_ENABLE_LVGL_SUPPORT
#include "esp_log.h"
#include "lvgl_driver_video.h"
#include "video.h"
#include "esp_timer.h"
#include "esp_heap_caps.h"
#define LV_TICK_PERIOD_MS 1
static const char* TAG="VIDEO";
static lv_disp_draw_buf_t disp_buf;
static lv_disp_drv_t disp_drv;
static lv_color_t* g_lvgl_aux_buf=NULL;
/**
* @brief Rounds to 32 bit boundary.
*
* \a composite_buffer_flush_cb() is more effective operating on 32 bits.
*/
void composite_rounder_cb(lv_disp_drv_t * disp_drv, lv_area_t * area)
{
#if LV_COLOR_DEPTH==1
if(NULL == g_lvgl_aux_buf)
{
// 4 pixels/32 bits
area->x1 &= ~0b11;
area->x2 |= 0b11;
}
else
{
// 32 pixels/32 bits
area->x1 &= ~0b11111;
area->x2 |= 0b11111;
}
#elif LV_COLOR_DEPTH==8
// 4 pixels/32 bits
area->x1 &= ~0b11;
area->x2 |= 0b11;
#elif LV_COLOR_DEPTH==16
// 2 pixels/32 bits
area->x1 &= ~1;
area->x2 |= 1;
#else
#pragma GCC error "Not supported LVGL color depth"
#endif
}
static void composite_dummy_flush_cb(lv_disp_drv_t * disp_drv, const lv_area_t * area, lv_color_t * color_p)
{
ESP_LOGD(TAG, "LVGL Updating area (%u,%u)-(%u,%u)", area->x1, area->y1, area->x2, area->y2 );
#if CONFIG_LVGL_VSYNC
video_wait_frame();
#endif
lv_disp_flush_ready(disp_drv);
}
static void composite_buffer_flush_cb(lv_disp_drv_t * disp_drv, const lv_area_t * area, lv_color_t * color_p)
{
ESP_LOGD(TAG, "LVGL Updating area (%u,%u)-(%u,%u)", area->x1, area->y1, area->x2, area->y2 );
#if CONFIG_LVGL_VSYNC
video_wait_frame();
#endif
register uint32_t pixel_data;
for(int y=area->y1; y<=area->y2; y++)
{
#if LV_COLOR_DEPTH==1
if(NULL==g_lvgl_aux_buf)
{
// Framebuffer is compatible with LVGL
// 4 pixels/uint32_t
uint32_t* dest = (uint32_t*)(video_get_frame_buffer_address()+y*video_get_width()+area->x1);
for(int x = area->x1; x <= area->x2; x+=4)
{
pixel_data = *((uint8_t*)color_p);
color_p++;
pixel_data |= *((uint8_t*)color_p) << 8;
color_p++;
pixel_data |= *((uint8_t*)color_p) << 16;
color_p++;
pixel_data |= *((uint8_t*)color_p) << 24;
color_p++;
*dest = pixel_data;
dest++;
}
}
else
{
// framebuffer 1 pixel/bit
uint32_t* dest = (uint32_t*)(video_get_frame_buffer_address()+y*video_get_width()/8+area->x1/8);
for(int x = area->x1; x <= area->x2; x+=32)
{
pixel_data=0;
for(int p=31;p>=0;p--)
{
if( color_p->full )
{
pixel_data |= (1<<p);
}
color_p++;
}
*dest = pixel_data;
dest++;
}
}
#elif LV_COLOR_DEPTH==8
// 4 pixels/uint32_t
uint32_t* dest = (uint32_t*)(video_get_frame_buffer_address()+y*video_get_width()+area->x1);
for(int x = area->x1; x <= area->x2; x+=4)
{
pixel_data = *((uint8_t*)color_p);
color_p++;
pixel_data |= *((uint8_t*)color_p) << 8;
color_p++;
pixel_data |= *((uint8_t*)color_p) << 16;
color_p++;
pixel_data |= *((uint8_t*)color_p) << 24;
color_p++;
*dest = pixel_data;
dest++;
}
#elif LV_COLOR_DEPTH==16
uint32_t* dest = (uint32_t*)(video_get_frame_buffer_address()+y*video_get_width()*2+area->x1*2);
for(int x = area->x1; x <= area->x2; x+=2)
{
pixel_data = *((uint16_t*)color_p);
color_p++;
pixel_data |= *((uint16_t*)color_p) << 16;
color_p++;
*dest = pixel_data;
dest++;
}
#endif
}
lv_disp_flush_ready(disp_drv);
}
#if CONFIG_LVGL_STATS
void composite_monitor_cb(lv_disp_drv_t * disp_drv, uint32_t time, uint32_t px)
{
static uint32_t min=0xFFFFFFFF, max, count, avg;
if( time < min ) min = time;
if( time > max ) max = time;
avg += time;
count++;
const int64_t period = 1000*1000; //us
static int64_t prev = 0;
int64_t now = esp_timer_get_time();
if( now - prev > period )
{
prev = now;
ESP_LOGD(TAG, "LVGL AVG: %u, MIN: %u, MAX: %u [ms]", avg/count, min, max);
count = avg = max = 0;
min = 0xFFFFFFFF;
}
}
#endif
static void lv_tick_task(void* arg)
{
lv_tick_inc(LV_TICK_PERIOD_MS);
}
/**
* @brief Initializes LVGL to work directly with framebuffer.
* This mode does not use an extra memory for buffer but may degrade animations.
* Tearing effect may be visible.
*
* @param mode graphics mode, resolution and TV system PAL or NTSC.
*
* @note This function calls \a lv_video_disp_init_buf()
*
* @sa lv_video_disp_init_buf()
*/
void lv_video_disp_init(GRAPHICS_MODE mode)
{
lv_video_disp_init_buf(mode, NULL, 0);
}
/**
* @brief Initialize LVGL to use auxilary buffer.
* Using additional buffer improves quality of animations.
* If \a pixel_buffer is NULL LVGL will access framebuffer directly.
*
* @param mode graphics mode, resolution and TV system PAL or NTSC.
* @param pixel_buffer pointer to auxilary buffer. LVGL uses it to refresh a screen. If set to NULL LVGL access directly framebuffer.
* @param buffer_pixel_count size of \a pixel_buffer for in pixels.
*
* @sa lv_video_disp_init()
*/
void lv_video_disp_init_buf(GRAPHICS_MODE mode, lv_color_t* pixel_buffer, uint32_t buffer_pixel_count)
{
ESP_LOGI(TAG, "LVGL Init. Color depth %d", LV_COLOR_DEPTH);
FRAME_BUFFER_FORMAT fb_format;
#if LV_COLOR_DEPTH==1
if( NULL == g_lvgl_aux_buf )
{
// Framebuffer compatible with LVGL 1 pixel/byte
fb_format = FB_FORMAT_LVGL_1BPP;
}
else
{
// More memory efficient format 8 pixels/byte but needs buffers
fb_format = FB_FORMAT_GREY_1BPP;
}
#elif LV_COLOR_DEPTH==8
fb_format = FB_FORMAT_RGB_8BPP;
#elif LV_COLOR_DEPTH==16
fb_format = FB_FORMAT_RGB_16BPP;
#else
#pragma GCC error "Not supported LVGL color depth"
#endif
video_graphics(mode, fb_format);
lv_init();
lv_disp_drv_init(&disp_drv);
if( NULL == pixel_buffer)
{
ESP_LOGD(TAG, "LVGL updates framebuffer directly");
lv_disp_draw_buf_init(&disp_buf, video_get_frame_buffer_address(), NULL, video_get_width()*video_get_height());
disp_drv.direct_mode = 1; // Draw directly to framebuffer
disp_drv.flush_cb = composite_dummy_flush_cb;
g_lvgl_aux_buf = NULL;
}
else
{
ESP_LOGD(TAG, "LVGL updates using buffer");
lv_disp_draw_buf_init(&disp_buf, pixel_buffer, NULL, buffer_pixel_count);
disp_drv.flush_cb = composite_buffer_flush_cb;
disp_drv.rounder_cb = composite_rounder_cb;
g_lvgl_aux_buf = pixel_buffer;
}
disp_drv.draw_buf = &disp_buf;
assert(disp_drv.draw_buf);
disp_drv.draw_buf = &disp_buf;
disp_drv.hor_res = video_get_width();
disp_drv.ver_res = video_get_height();
#if CONFIG_LVGL_STATS
disp_drv.monitor_cb = composite_monitor_cb;
#endif
lv_disp_drv_register(&disp_drv);
const esp_timer_create_args_t periodic_timer_args =
{
.callback = &lv_tick_task,
.name = "lvgl_gui"
};
esp_timer_handle_t periodic_timer;
ESP_ERROR_CHECK(esp_timer_create(&periodic_timer_args, &periodic_timer));
ESP_ERROR_CHECK(esp_timer_start_periodic(periodic_timer, LV_TICK_PERIOD_MS * 1000));
}
#endif

1064
video.c 100644
Wyświetl plik

Plik diff jest za duży Load Diff