Compare commits

...

38 Commits
0.2.0 ... main

Author SHA1 Message Date
252776e0a7
version: 0.10.0 2025-01-31 11:53:16 +08:00
2ce726d16c
update: scheduler can now prevent selected tasks from running under high load 2025-01-25 23:25:11 +08:00
96b4cecaec
fix: incorrect logic when removing files 2025-01-21 03:40:40 +08:00
94bd14db52
update: remove maxInterval in scheduler
fix: unlinking a file without handling the case of file not exist
2025-01-21 02:12:17 +08:00
fb0c60a71e
add: blurred background in rewind page when ratio mismatch 2025-01-21 01:37:20 +08:00
3d76a5ece5
add: type for recognition 2025-01-06 23:42:11 +08:00
094f8a0925
add: scheduler 2025-01-06 23:14:42 +08:00
496c00e7e3
update: directory structure for binary files 2025-01-06 21:51:48 +08:00
95fa5b4ac7
update: README.md 2025-01-02 01:02:31 +08:00
ee5dff0d6f
update: README.md 2025-01-02 00:59:46 +08:00
6f4a1c61df
update: README 2025-01-02 00:45:53 +08:00
a0a90f2428
ref: better import for utils
fix: inappropriate ffmpeg path in `immediatelyExtractFrameFromVideo()`
2025-01-02 00:26:50 +08:00
38185cc969
fix: wrong path in builder config 2025-01-02 00:06:25 +08:00
004e1a7eef
version: 0.8.0 2025-01-01 23:37:11 +08:00
497c73725c
update: index.tsx 2025-01-01 18:47:22 +08:00
408778b8b9
feature: remove rewind window from recording 2025-01-01 16:49:32 +08:00
d4f14b97b0
improve: optimize timeline scrolling 2025-01-01 16:09:45 +08:00
f778c4f44b
feature: a usable timeline 2025-01-01 04:46:57 +08:00
a43a563609
ref: utils dir 2025-01-01 02:56:51 +08:00
97dce81297
add: decoding frame in backend server 2025-01-01 02:22:14 +08:00
71d00103dd
fix: correctly handle the situation where the screenshot file does not exist 2024-12-29 23:00:57 +08:00
d2899d4b50
ref: format 2024-12-29 22:35:25 +08:00
bc0483cdc8
improve: better logic for composing FFmpeg command
add: hardware encoding when available
2024-12-29 22:33:31 +08:00
bf7be530a1
update: use untilID as param of /timeline instead of offset 2024-12-29 21:48:56 +08:00
f53616f345
add: endpoint /timeline & /frame/:id in backend server
improve: simplify the migration code
2024-12-29 21:37:36 +08:00
fb70acab00
add: the backend server for the app
it is used for communication between Web & Electron.
2024-12-28 22:12:34 +08:00
8cf17838f4
fix: wrong field type in migrateToV3.ts
improve: use single threaded ffmpeg to reduce peak CPU utilization
update: database-changelog.md & database-structure.md
2024-12-26 18:12:20 +08:00
1cd6d7b639
version: 0.6.0 2024-12-23 02:11:07 +08:00
a8c26ea6de
merge: branch 'main' into dev 2024-12-23 02:09:09 +08:00
09b9cb220e
feature: encoding (compress) screenshots 2024-12-23 02:08:18 +08:00
aa4376c9ab
Merge pull request #6 from alikia2x/dev
update: README & LICENSE
2024-12-10 00:38:25 +08:00
04cf5a8ab8
fix: small mistake in migration script 2024-12-09 00:34:12 +08:00
1f9b8ea124
update: function to add frames into encoding queue
add: scripts to migrate to V3 schema
TODO: fix processEncodingTasks() in `encoding.ts`
TODO: write docs for V3 schema
2024-12-09 00:23:05 +08:00
37e0fbfc89
add: functions to migrate database to V2 schema
add: doc for database schema
2024-12-08 17:31:17 +08:00
95f982f245 improve: compatibility for windows 2024-12-08 00:43:56 +08:00
7dac731479
feature: background recording 2024-12-07 19:01:32 +08:00
d5b333d595
update: README & LICENSE 2024-12-06 00:56:54 +08:00
bb07963381
fix: app won't quit 2024-12-02 02:06:55 +08:00
73 changed files with 3696 additions and 7921 deletions

View File

@ -1,8 +1,8 @@
{
"useTabs": true,
"tabWidth": 4,
"trailingComma": "none",
"singleQuote": false,
"printWidth": 100,
"endOfLine": "lf"
"useTabs": true,
"tabWidth": 4,
"trailingComma": "none",
"singleQuote": false,
"printWidth": 100,
"endOfLine": "lf"
}

160
.tokeignore Normal file
View File

@ -0,0 +1,160 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# Snowpack dependency directory (https://snowpack.dev/)
web_modules/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional stylelint cache
.stylelintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache
# Next.js build output
.next
out
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# vuepress v2.x temp and cache directory
.temp
.cache
# Docusaurus cache and generated files
.docusaurus
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
node_modules
dist
dist-ssr
*.local
# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
bin
*.yaml
*.json
*.md

674
LICENSE Normal file
View File

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

View File

@ -2,36 +2,39 @@
OpenRewind is an open-source alternative to [rewind.ai](https://rewind.ai), forked from [OpenRecall](https://github.com/openrecall/openrecall).
As this project is still in its early stages, you might not see significant progress just yet.
We want to create an open source app that provides similar core functionality
to rewind.ai, and that app is **OpenRewind**.
## Alpha Release: 0.8.0
Latest works: There is an Alpha version available! We currently only support Apple Silicon Macs.
(Of course, thanks to building on Electron, there will definitely be support for multiple platforms in the beta/stable release)
### ✨ Features
- GUI app. No terminal windows, no need to install any dependencies
- Take a screenshot of your screen every 2 seconds
- Encode screenshots to video at regular intervals
- A full screen "rewind" page similar to Rewind, with scrolling to view captured screenshots
- Screenshots can be taken excluding the "rewind" window
## To-dos
### Update the OCR Engine
### OCR optimized for the specific platform
OpenRecall currently uses docTR as its OCR engine, but it performs inadequately. On my MacBook Air M2 (2022), processing a screenshot takes around 20 seconds, with CPU usage peaking at over 400%. During this time, screenshots cannot be captured, and the engine appears to recognize only Latin characters.
We will use the OCR API provided by the OS for macOS and Windows.
To address this, we plan to replace the OCR engine with a more efficient alternative that supports multiple writing systems. We are considering [Tesseract](https://github.com/tesseract-ocr/tesseract), which supports multiple languages and is faster, though it still falls short of our desired results. (As reference, rewind.ai runs on same machine with avearge CPU usage of 40%)
Reference projects:
- [ocrit](https://github.com/insidegui/ocrit/)
> We [forked](https://github.com/alikia2x/ocrit) this project to suit our needs
- [Windows.Media.Ocr.Cli](https://github.com/zh-h/Windows.Media.Ocr.Cli)
### Implement a Task Queue/Scheduler
### Big-little architecture optimizations for Apple Silicon
Currently, OpenRecall's OCR recognition and database operations are synchronous (blocking). This results in increased screenshot frequency, as described in the previous section.
We wrote a small Swift program that allows a given program to run at a selected QoS class. On ARM Mac, this means we can put some work (such as video encoding) to Efficient cores, reducing peak CPU usage and power consumption.
Our next goal is to introduce a task queue to handle high-load tasks (such as OCR, indexing, and archiving) asynchronously. This will ensure that time-sensitive tasks (like capturing screenshots) are prioritized.
### Improve the Frontend
The current frontend of OpenRecall is quite basic. Given my expertise in web development, I will build a more robust frontend from scratch, using Python solely as a daemon/backend server.
We are also considering using Electron to deliver a near-native experience, aiming to match the functionality of [rewind.ai](https://rewind.ai).
> See: [Prioritize Work with Quality of Service Classes](https://developer.apple.com/library/archive/documentation/Performance/Conceptual/EnergyGuide-iOS/PrioritizeWorkWithQoS.html)
### Add More Features
We will be implementing the [feature list](https://github.com/openrecall/openrecall/discussions/9) proposed in the OpenRecall repository. Stay tuned for updates.
### THE FURTHER FUTURE: Deployment & Refactoring
We are exploring ways to simplify the download, installation, and usage of this Python-based program, especially as we introduce new technologies (such as web dev / Electron).
Initially, we are considering Docker as a deployment solution. [Docker Desktop](https://www.docker.com/products/docker-desktop/) is available for macOS and Windows users and offers a more user-friendly experience compared to command-line Python installations and dependency management.
However, Docker is a temporary solution. In the future, we plan to transition OpenRewind to the [Electron](https://www.electronjs.org/) technology stack and gradually migrate Python components to Node.js.

BIN
bun.lockb Executable file

Binary file not shown.

2
bunfig.toml Normal file
View File

@ -0,0 +1,2 @@
[install.scopes]
"@jsr" = "https://npm.jsr.io"

View File

@ -7,14 +7,22 @@ export default function IconWithText() {
const { t } = useTranslation();
return (
<div className="flex">
<img src={imgUrl} className="h-20 w-20 mr-2" alt="OpenRewind icon"/>
<img src={imgUrl} className="h-20 w-20 mr-2" alt="OpenRewind icon" />
<div className="flex flex-col justify-start w-auto h-[4.2rem] overflow-hidden mt-1">
<span className="text-2xl font-semibold">OpenRewind</span>
<span className="text-sm text-gray-700 dark:text-gray-200
font-medium ml-0.5">{t("settings.version", { version: pjson.version })}</span>
<span className="text-xs text-gray-700 dark:text-gray-200
font-medium ml-0.5">{t("settings.copyright")}</span>
<span
className="text-sm text-gray-700 dark:text-gray-200
font-medium ml-0.5"
>
{t("settings.version", { version: pjson.version })}
</span>
<span
className="text-xs text-gray-700 dark:text-gray-200
font-medium ml-0.5"
>
{t("settings.copyright")}
</span>
</div>
</div>
);
}
}

View File

@ -1,10 +1,14 @@
import { MouseEventHandler } from "react";
import { Icon } from "@iconify-icon/react";
const MenuItem = ({ icon, text, onClick }: {
icon: string,
text: string,
onClick: MouseEventHandler<HTMLDivElement>
const MenuItem = ({
icon,
text,
onClick
}: {
icon: string;
text: string;
onClick: MouseEventHandler<HTMLDivElement>;
}) => {
return (
<div
@ -20,4 +24,4 @@ const MenuItem = ({ icon, text, onClick }: {
);
};
export default MenuItem;
export default MenuItem;

View File

@ -5,12 +5,10 @@ export default function OpenSourceNote() {
<p id="settings-note" className="text-sm text-weaken mt-3">
<Trans i18nKey="settings.note">
OpenRewind is open source software licensed under
<a href="https://www.gnu.org/licenses/agpl-3.0.html">AGPL 3.0</a>.<br />
<a href="https://www.gnu.org/licenses/gpl-3.0.html">GPL 3.0</a>.<br />
Source code is avaliable at
<a href="https://github.com/alikia2x/openrewind">
GitHub
</a>.
<a href="https://github.com/alikia2x/openrewind">GitHub</a>.
</Trans>
</p>
)
}
);
}

View File

@ -1,9 +1,15 @@
import * as React from "react";
import { useRef } from "react";
const SettingsGroup = (
{ children, groupName, addGroupRef }:
{ children: React.ReactNode, groupName: string, addGroupRef: Function }) => {
const SettingsGroup = ({
children,
groupName,
addGroupRef
}: {
children: React.ReactNode;
groupName: string;
addGroupRef: Function;
}) => {
const groupRef = useRef(null);
React.useEffect(() => {
@ -17,4 +23,4 @@ const SettingsGroup = (
);
};
export default SettingsGroup;
export default SettingsGroup;

View File

@ -2,9 +2,7 @@ import { useTranslation } from "react-i18next";
const Title = ({ i18nKey }: { i18nKey: string }) => {
const { t } = useTranslation();
return (
<h1 className="text-3xl font-bold leading-[3rem]">{t(i18nKey)}</h1>
);
}
return <h1 className="text-3xl font-bold leading-[3rem]">{t(i18nKey)}</h1>;
};
export default Title;
export default Title;

View File

@ -0,0 +1,16 @@
# Build Instructions
## Binaries & Libraries
### Simple
Simple is a SQLite3 FTS extension for indexing Chinese, OpenRewind use it to improve searching experience for Chinese users.
Before building, you need to download latest release of Simple at their [GitHub Release](https://github.com/wangfenjin/simple/releases),
decompress all files in the zip into `[PROJECT_ROOT]/bin/[PLATFORM]/libsimple/`, in which:
- [PROJECT_ROOT] is the root directory of OpenRewind you pulled.
- [PLATFORM] refers to the specific platform you are targeting:
- win32: Windows
- darwin: macOS
- linux: Linux

305
docs/database-changelog.md Normal file
View File

@ -0,0 +1,305 @@
# Database Schema Changelog
This document outlines the changes made across different versions of
database structure used in the OpenRewind, including tables and fields.
## Version 3 Schema Changes
Corresponding version: Since 0.5.0
### Update `encoding_task` Table
#### Change `createAt` to `createdAt`
The column `createAt` was renamed to `createdAt` for consistency.
```sql
ALTER TABLE encoding_task RENAME COLUMN createAt TO createdAt;
```
#### Convert `createdAt` to Unix Timestamp
The `createdAt` column was updated to store Unix timestamps instead of formatted timestamps.
```typescript
const rows = db.prepare(`SELECT id, createdAt FROM encoding_task`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStmt = db.prepare(`UPDATE encoding_task SET createdAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
const unixTimestamp = convertTimestampToUnix(row.createdAt as string);
updateStmt.run(unixTimestamp, row.id);
});
```
### Update `frame` Table
#### Change `createAt` to `createdAt`
The column `createAt` was renamed to `createdAt` for consistency.
```sql
ALTER TABLE frame RENAME COLUMN createAt TO createdAt;
```
#### Convert `createdAt` to Unix Timestamp
The `createdAt` column was updated to store Unix timestamps instead of formatted timestamps.
```typescript
const rows = db.prepare(`SELECT id, createdAt FROM frame`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStmt = db.prepare(`UPDATE frame SET createdAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
const unixTimestamp = convertTimestampToUnix(row.createdAt as string);
updateStmt.run(unixTimestamp, row.id);
});
```
### Update `segments` Table
#### Rename Columns for Consistency
The columns `startAt` and `endAt` were renamed to `startedAt` and `endedAt` respectively.
```sql
ALTER TABLE segments RENAME COLUMN startAt TO startedAt;
ALTER TABLE segments RENAME COLUMN endAt TO endedAt;
```
#### Convert `startedAt` and `endedAt` to Unix Timestamps
The `startedAt` and `endedAt` columns were updated to store Unix timestamps instead of formatted timestamps.
```typescript
const rows = db.prepare(`SELECT id, startedAt, endedAt FROM segments`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStart = db.prepare(`UPDATE segments SET startedAt_new = ? WHERE id = ?`);
const updateEnd = db.prepare(`UPDATE segments SET endedAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
updateStart.run(convertTimestampToUnix(row.startedAt as string), row.id);
updateEnd.run(convertTimestampToUnix(row.endedAt as string), row.id);
});
```
### Drop Deprecated `encoded` Column
The deprecated `encoded` column was removed from the `frame` table.
```sql
ALTER TABLE frame DROP COLUMN encoded;
```
### Summary of Changes
- **Update `encoding_task` Table:**
- Renamed `createAt` to `createdAt`.
- Converted `createdAt` to store Unix timestamps.
- **Update `frame` Table:**
- Renamed `createAt` to `createdAt`.
- Converted `createdAt` to store Unix timestamps.
- Dropped the deprecated `encoded` column.
- **Update `segments` Table:**
- Renamed `startAt` and `endAt` to `startedAt` and `endedAt` respectively.
- Converted `startedAt` and `endedAt` to store Unix timestamps.
## Version 2 Schema
Corresponding version: 0.4.0
### New Table: `config`
Stores configuration data, including the database version.
| Column Name | Data Type | Constraints/Default | Description |
| ----------- | --------- | ------------------- | -------------------------------------- |
| `key` | TEXT | PRIMARY KEY | Unique key for configuration settings. |
| `value` | TEXT | | Value associated with the key. |
#### Insert Default Version
```sql
INSERT INTO config (key, value) VALUES ('version', '2');
```
### New Table: `encoding_task`
Stores encoding tasks that are queued for processing.
| Column Name | Data Type | Constraints/Default | Description |
| ----------- | --------- | -------------------------- | ------------------------------------ |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique ID for the task. |
| `createAt` | TIMESTAMP | DEFAULT CURRENT_TIMESTAMP | Timestamp when the task was created. |
| `status` | INTEGER | DEFAULT 0 | Indicates the status of the task. |
### Task status
- `0`: Pending
- `1`: In Progress
- `2`: Completed
- Once the task was set to this status, it will be imminently deleted by a trigger mentioned below.
### New Trigger: `delete_encoding_task`
Triggered after updating the `status` of an encoding task to `2` (Completed).
```sql
CREATE TRIGGER delete_encoding_task
AFTER UPDATE OF status
ON encoding_task
BEGIN
DELETE FROM encoding_task_data
WHERE encodingTaskID = OLD.id AND NEW.status = 2;
DELETE FROM encoding_task
WHERE id = OLD.id AND NEW.status = 2;
END;
```
### New Table: `encoding_task_data`
Stores the frames that need to be encoded for the encoding task
| Column Name | Data Type | Constraints/Default | Description |
| ---------------- | --------- | ----------------------------------- | ---------------------------------------------------- |
| `frame` | INTEGER | PRIMARY KEY, FOREIGN KEY (frame.id) | ID for the frame associated with the encoding task. |
| `encodingTaskID` | TIMESTAMP | FOREIGN KEY (encoding_task.id) | ID for the encoding task associated with this frame. |
### Update `frame` Table
#### Simplify `imgFilename`
The `imgFilename` column was updated to store only the filename without the full path.
```typescript
const rows = db.prepare("SELECT id, imgFilename FROM frame").all() as OldFrame[];
rows.forEach((row) => {
const filename = row.imgFilename.match(/[^\\/]+$/)?.[0];
if (filename) {
db.prepare("UPDATE frame SET imgFilename = ? WHERE id = ?").run(filename, row.id);
}
});
```
#### Add `encodeStatus` Column
A new column `encodeStatus` was added to replace the deprecated `encoded` column.
```sql
ALTER TABLE frame ADD encodeStatus INT;
UPDATE frame SET encodeStatus = CASE WHEN encoded THEN 2 ELSE 0 END;
```
### Summary of Changes
- **New Table:** `config` to store configuration data.
- **Update `frame` Table:**
- Simplified `imgFilename` to store only the filename.
- Added `encodeStatus` column to replace the deprecated `encoded` column.
- **Deprecated `encoded` column.**
- The `encoded` column is no longer used and is retained due to SQLite's inability to drop columns.
Creating a new table without this column and copying data to the new table could be time-consuming.
## Version 1 Schema
Corresponding version: 0.3.x
### Table: `frame`
Stores information about individual frames.
| Column Name | Data Type | Constraints/Default | Description |
| ----------------- | --------- | ------------------------------- | ----------------------------------------------------------------------- |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each frame. |
| `createAt` | TIMESTAMP | DEFAULT CURRENT_TIMESTAMP | Timestamp when the frame was created. |
| `imgFilename` | TEXT | | Filename of the image associated with the frame. |
| `segmentID` | INTEGER | NULL, FOREIGN KEY (segments.id) | ID of the segment to which the frame belongs. |
| `videoPath` | TEXT | NULL | Path to the video file if the frame is part of a video. |
| `videoFrameIndex` | INTEGER | NULL | Index of the frame within the video. |
| `collectionID` | INTEGER | NULL | ID of the collection to which the frame belongs. |
| `encoded` | BOOLEAN | DEFAULT 0 | Indicates whether the frame has been encoded (0 for false, 1 for true). |
### Table: `recognition_data`
Stores recognition data associated with frames.
| Column Name | Data Type | Constraints/Default | Desc[database-structure.md](database-structure.md)ription |
| ----------- | --------- | -------------------------- | --------------------------------------------------------- |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each recognition data entry. |
| `frameID` | INTEGER | FOREIGN KEY (frame.id) | ID of the frame to which the recognition data belongs. |
| `data` | TEXT | | Raw recognition data. |
| `text` | TEXT | | Recognized text. |
### Table: `segments`
A segment is a period of time when a user uses an application.
While capturing the screen, OpenRewind retrieves the currently active window.
When it finds that the currently active window has changed to another application, a new segment will start.
| Column Name | Data Type | Constraints/Default | Description |
| ------------- | --------- | -------------------------- | ---------------------------------------------------- |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each segment. |
| `startAt` | TIMESTAMP | | Timestamp when the segment starts. |
| `endAt` | TIMESTAMP | | Timestamp when the segment ends. |
| `title` | TEXT | | Title of the segment. |
| `appName` | TEXT | | Name of the application associated with the segment. |
| `appPath` | TEXT | | Path to the application. |
| `text` | TEXT | | Text content of the segment. |
| `type` | TEXT | | Type of the segment. |
| `appBundleID` | TEXT | NULL | Bundle ID of the application. |
| `url` | TEXT | NULL | URL associated with the segment. |
### Virtual Table: `text_search`
Used for full-text search on recognition data.
| Column Name | Data Type | Constraints/Default | Description |
| ----------- | --------- | ------------------- | ------------------------------------------------------ |
| `id` | INTEGER | UNINDEXED | ID of the recognition data entry. |
| `frameID` | INTEGER | UNINDEXED | ID of the frame to which the recognition data belongs. |
| `data` | TEXT | | Raw recognition data. |
| `text` | TEXT | | Recognized text. |
### Triggers
#### `recognition_data_after_insert`
Triggered after inserting a new row into `recognition_data`.
```sql
CREATE TRIGGER IF NOT EXISTS recognition_data_after_insert AFTER INSERT ON recognition_data
BEGIN
INSERT INTO text_search (id, frameID, data, text)
VALUES (NEW.id, NEW.frameID, NEW.data, NEW.text);
END;
```
#### `recognition_data_after_update`
Triggered after updating a row in `recognition_data`.
```sql
CREATE TRIGGER IF NOT EXISTS recognition_data_after_update AFTER UPDATE ON recognition_data
BEGIN
UPDATE text_search
SET frameID = NEW.frameID, data = NEW.data, text = NEW.text
WHERE id = NEW.id;
END;
```
#### `recognition_data_after_delete`
Triggered after deleting a row from `recognition_data`.
```sql
CREATE TRIGGER IF NOT EXISTS recognition_data_after_delete AFTER DELETE ON recognition_data
BEGIN
DELETE FROM text_search WHERE id = OLD.id;
END;
```

157
docs/database-structure.md Normal file
View File

@ -0,0 +1,157 @@
# Database Schema Documentation (Version 3)
This document outlines the current structure of the database schema used in the application. It includes tables, fields, and their descriptions.
## Table: `config`
Stores configuration data.
| Column Name | Data Type | Constraints/Default | Description |
| ----------- | --------- | ------------------- | -------------------------------------- |
| `key` | TEXT | PRIMARY KEY | Unique key for configuration settings. |
| `value` | TEXT | | Value associated with the key. |
### Key: version
The current database schema version, represented as an integer. Since the `config` table does not exist in V1, the version must be at least 2.
## Table: `frame`
Stores information about individual frames.
| Column Name | Data Type | Constraints/Default | Description |
| ----------------- | --------- | ------------------------------- | --------------------------------------------------------- |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each frame. |
| `createdAt` | REAL | | Timestamp when the frame was created. |
| `imgFilename` | TEXT | | Filename of the image associated with the frame. |
| `segmentID` | INTEGER | NULL, FOREIGN KEY (segments.id) | ID of the segment to which the frame belongs. |
| `videoPath` | TEXT | NULL | Relative path to the video file if the frame was encoded. |
| `videoFrameIndex` | INTEGER | NULL | Index of the frame within the encoded video. |
| `collectionID` | INTEGER | NULL | ID of the collection to which the frame belongs. |
| `encodeStatus` | INTEGER | DEFAULT 0 | Indicates the encoding status of the frame. |
### Status Description
- `0`: The frame is not encoded.
- `1`: The frame is scheduled for encoding. It will appear in the `encoding_task` table.
- `2`: The frame is already encoded.
## Table: `recognition_data`
Stores recognition data associated with frames.
| Column Name | Data Type | Constraints/Default | Description |
| ----------- | --------- | -------------------------- | ------------------------------------------------------ |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each recognition data entry. |
| `frameID` | INTEGER | FOREIGN KEY (frame.id) | ID of the frame to which the recognition data belongs. |
| `data` | TEXT | | Raw recognition data. |
| `text` | TEXT | | Recognized text. |
## Table: `segments`
A segment is a period of time when a user uses a particular application. While capturing the screen, OpenRewind detects the currently active window. When it finds that the currently active window has changed to another application, a new segment will start.
| Column Name | Data Type | Constraints/Default | Description |
| ------------- | --------- | -------------------------- | ---------------------------------------------------- |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each segment. |
| `startedAt` | REAL | | Timestamp when the segment starts. |
| `endedAt` | REAL | | Timestamp when the segment ends. |
| `title` | TEXT | | Title of the segment. |
| `appName` | TEXT | | Name of the application associated with the segment. |
| `appPath` | TEXT | | Path to the application. |
| `text` | TEXT | | Text content of the segment. |
| `type` | TEXT | | Type of the segment. |
| `appBundleID` | TEXT | NULL | Bundle ID of the application. |
| `url` | TEXT | NULL | URL associated with the segment. |
## Table: `encoding_task`
Stores encoding tasks that are queued for processing.
| Column Name | Data Type | Constraints/Default | Description |
| ----------- | --------- | -------------------------- | ------------------------------------ |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique ID for the task. |
| `createdAt` | REAL | | Timestamp when the task was created. |
| `status` | INTEGER | DEFAULT 0 | Indicates the status of the task. |
### Task status Description
- `0`: Pending
- `1`: In Progress
- `2`: Completed
- Once the task was set to this status, it will be imminently deleted by a trigger mentioned below.
## Table: `encoding_task_data`
Stores the frames that need to be encoded for the encoding task.
| Column Name | Data Type | Constraints/Default | Description |
| ---------------- | --------- | ----------------------------------- | ---------------------------------------------------- |
| `encodingTaskID` | INTEGER | FOREIGN KEY (encoding_task.id) | ID for the encoding task associated with this frame. |
| `frame` | INTEGER | PRIMARY KEY, FOREIGN KEY (frame.id) | ID for the frame associated with the encoding task. |
## Virtual Table: `text_search`
Used for full-text search on recognition data.
| Column Name | Data Type | Constraints/Default | Description |
| ----------- | --------- | ------------------- | ------------------------------------------------------ |
| `id` | INTEGER | UNINDEXED | ID of the recognition data entry. |
| `frameID` | INTEGER | UNINDEXED | ID of the frame to which the recognition data belongs. |
| `data` | TEXT | | Raw recognition data. |
| `text` | TEXT | | Recognized text. |
## Triggers
### `recognition_data_after_insert`
Triggered after inserting a new row into `recognition_data`. Inserts a new row into `text_search` with the same data.
```sql
CREATE TRIGGER IF NOT EXISTS recognition_data_after_insert AFTER INSERT ON recognition_data
BEGIN
INSERT INTO text_search (id, frameID, data, text)
VALUES (NEW.id, NEW.frameID, NEW.data, NEW.text);
END;
```
### `recognition_data_after_update`
Triggered after updating a row in `recognition_data`. Updates the associated `text_search` row.
```sql
CREATE TRIGGER IF NOT EXISTS recognition_data_after_update AFTER UPDATE ON recognition_data
BEGIN
UPDATE text_search
SET frameID = NEW.frameID, data = NEW.data, text = NEW.text
WHERE id = NEW.id;
END;
```
### `recognition_data_after_delete`
Triggered after deleting a row from `recognition_data`. Deletes the associated `text_search` row.
```sql
CREATE TRIGGER IF NOT EXISTS recognition_data_after_delete AFTER DELETE ON recognition_data
BEGIN
DELETE FROM text_search WHERE id = OLD.id;
END;
```
### `delete_encoding_task`
Triggered after updating the `status` of an encoding task to `2` (Completed). Deletes the associated `encoding_task_data` and `encoding_task` rows.
```sql
CREATE TRIGGER IF NOT EXISTS delete_encoding_task
AFTER UPDATE OF status
ON encoding_task
BEGIN
DELETE FROM encoding_task_data
WHERE encodingTaskID = OLD.id AND NEW.status = 2;
DELETE FROM encoding_task
WHERE id = OLD.id AND NEW.status = 2;
END;
```

View File

@ -1,29 +1,27 @@
{
"appId": "com.alikia2x.openrewind",
"mac": {
"category": "public.app-category.productivity",
"target": "dmg",
"files": [
"bin/macos"
]
},
"productName": "OpenRewind",
"directories": {
"output": "dist/release"
},
"files": [
"dist/dev/**/*",
"dist/dev/assets/*",
"dist/dev/i18n/*",
"dist/renderer/**/*",
"dist/renderer/assets/*"
],
"win": {
"target": "nsis"
},
"linux": {
"target": "AppImage"
},
"copyright": "Copyright © 2024 alikia2x",
"asar": false
}
"appId": "com.alikia2x.openrewind",
"mac": {
"category": "public.app-category.productivity",
"target": "dmg"
},
"productName": "OpenRewind",
"directories": {
"output": "dist/release"
},
"files": [
"dist/electron/**/*",
"dist/electron/assets/*",
"dist/electron/i18n/*",
"dist/renderer/**/*",
"dist/renderer/assets/*"
],
"win": {
"target": "nsis",
"files": ["bin/win32"]
},
"linux": {
"target": "AppImage"
},
"copyright": "Copyright © 2024 alikia2x",
"asar": false
}

View File

@ -1,28 +1,37 @@
import js from '@eslint/js'
import globals from 'globals'
import reactHooks from 'eslint-plugin-react-hooks'
import reactRefresh from 'eslint-plugin-react-refresh'
import tseslint from 'typescript-eslint'
import js from "@eslint/js";
import globals from "globals";
import reactHooks from "eslint-plugin-react-hooks";
import reactRefresh from "eslint-plugin-react-refresh";
import tseslint from "typescript-eslint";
export default tseslint.config(
{ ignores: ['dist'] },
{
extends: [js.configs.recommended, ...tseslint.configs.recommended],
files: ['**/*.{ts,tsx}'],
languageOptions: {
ecmaVersion: 2020,
globals: globals.browser,
},
plugins: {
'react-hooks': reactHooks,
'react-refresh': reactRefresh,
},
rules: {
...reactHooks.configs.recommended.rules,
'react-refresh/only-export-components': [
'warn',
{ allowConstantExport: true },
],
},
},
)
{ ignores: ["dist"] },
{
extends: [js.configs.recommended, ...tseslint.configs.recommended],
files: ["**/*.{ts,tsx}"],
languageOptions: {
ecmaVersion: 2020,
globals: globals.browser
},
plugins: {
"react-hooks": reactHooks,
"react-refresh": reactRefresh
},
rules: {
...reactHooks.configs.recommended.rules,
"react-refresh/only-export-components": ["warn", { allowConstantExport: true }],
"@typescript-eslint/no-unused-vars": [
"error",
{
args: "all",
argsIgnorePattern: "^_",
caughtErrors: "all",
caughtErrorsIgnorePattern: "^_",
destructuredArrayIgnorePattern: "^_",
varsIgnorePattern: "^_",
ignoreRestSiblings: true
}
]
}
}
);

View File

@ -1,45 +1,39 @@
import gulp from "gulp";
import ts from "gulp-typescript";
// @ts-ignore
import clean from "gulp-clean";
import fs from "fs";
const tsProject = ts.createProject('tsconfig.json');
const tsProject = ts.createProject("tsconfig.json");
gulp.task('clean', function () {
return gulp.src('dist/dev', {read: false, allowEmpty: true})
.pipe(clean());
gulp.task("clean", function () {
return gulp.src("dist/electron", { read: false, allowEmpty: true }).pipe(clean());
});
gulp.task('scripts', () => {
if (!fs.existsSync("dist/dev")) {
fs.mkdirSync("dist/dev", { recursive: true });
gulp.task("scripts", () => {
if (!fs.existsSync("dist/electron")) {
fs.mkdirSync("dist/electron", { recursive: true });
}
const tsResult = tsProject.src()
.pipe(tsProject());
const tsResult = tsProject.src().pipe(tsProject());
const jsFiles = gulp.src(['src/electron/**/*.js', 'src/electron/**/*.cjs']);
const jsFiles = gulp.src(["src/electron/**/*.js", "src/electron/**/*.cjs"]);
return tsResult.js
.pipe(gulp.dest('dist/dev'))
.on('end', () => {
jsFiles.pipe(gulp.dest('dist/dev'));
});
return tsResult.js.pipe(gulp.dest("dist/electron")).on("end", () => {
jsFiles.pipe(gulp.dest("dist/electron"));
});
});
gulp.task('assets', () => {
return gulp.src('src/electron/assets/**/*', { encoding: false })
.pipe(gulp.dest('dist/dev/assets'));
gulp.task("assets", () => {
return gulp
.src("src/electron/assets/**/*", { encoding: false })
.pipe(gulp.dest("dist/electron/assets"));
});
gulp.task('binary', () => {
return gulp.src('bin/**/*', { encoding: false })
.pipe(gulp.dest('dist/dev/bin'));
gulp.task("binary", () => {
return gulp.src(`bin/${process.platform}-${process.arch}/**/*`, { encoding: false }).pipe(gulp.dest("dist/electron/bin"));
});
gulp.task("locales", () => {
return gulp.src('i18n/**/*')
.pipe(gulp.dest('dist/dev/i18n'));
})
return gulp.src("i18n/**/*").pipe(gulp.dest("dist/electron/i18n"));
});
gulp.task('build', gulp.series('clean', 'scripts', 'assets', 'binary', 'locales'));
gulp.task("build", gulp.series("clean", "scripts", "assets", "binary", "locales"));

View File

@ -1,8 +1,8 @@
{
"settings": "إعدادات",
"tray": {
"quit": "يترك",
"showMainWindow": "يبحث",
"showSettingsWindow": "إعدادات"
}
"settings": "إعدادات",
"tray": {
"quit": "يترك",
"showMainWindow": "يبحث",
"showSettingsWindow": "إعدادات"
}
}

View File

@ -1,8 +1,8 @@
{
"settings": "Einstellungen",
"tray": {
"quit": "Aufhören",
"showMainWindow": "Suchen",
"showSettingsWindow": "Einstellungen"
}
"settings": "Einstellungen",
"tray": {
"quit": "Aufhören",
"showMainWindow": "Suchen",
"showSettingsWindow": "Einstellungen"
}
}

View File

@ -1,22 +1,22 @@
{
"settings": {
"title": "Settings",
"about": "About",
"screen": "Screen",
"screen-recording": "Screen Recording",
"version": "Version {version}",
"copyright": "Copyright © 2024 alikia2x",
"note": "OpenRewind is an open source software licensed under <1>AGPL 3.0</1>, <3></3>and its source code is avaliable at <5>GitHub</5>.",
"environment-details": "Environment Info",
"node-version": "Node.js Version",
"electron-version": "Electron Version",
"chrome-version": "Chrome Version",
"os-version": "OS Version",
"os": "Operating System"
},
"tray": {
"showMainWindow": "Search",
"showSettingsWindow": "Settings",
"quit": "Quit"
}
"settings": {
"title": "Settings",
"about": "About",
"screen": "Screen",
"screen-recording": "Screen Recording",
"version": "Version {version}",
"copyright": "Copyright © 2024 alikia2x",
"note": "OpenRewind is an open source software licensed under <1>GPL 3.0</1>, <3></3>and its source code is avaliable at <5>GitHub</5>.",
"environment-details": "Environment Info",
"node-version": "Node.js Version",
"electron-version": "Electron Version",
"chrome-version": "Chrome Version",
"os-version": "OS Version",
"os": "Operating System"
},
"tray": {
"showMainWindow": "Search",
"showSettingsWindow": "Settings",
"quit": "Quit"
}
}

View File

@ -1,8 +1,8 @@
{
"settings": "Ajustes",
"tray": {
"quit": "Abandonar",
"showMainWindow": "Buscar",
"showSettingsWindow": "Ajustes"
}
"settings": "Ajustes",
"tray": {
"quit": "Abandonar",
"showMainWindow": "Buscar",
"showSettingsWindow": "Ajustes"
}
}

View File

@ -1,8 +1,8 @@
{
"settings": "Paramètres",
"tray": {
"quit": "Quitter",
"showMainWindow": "Recherche",
"showSettingsWindow": "Paramètres"
}
"settings": "Paramètres",
"tray": {
"quit": "Quitter",
"showMainWindow": "Recherche",
"showSettingsWindow": "Paramètres"
}
}

View File

@ -1,8 +1,8 @@
{
"settings": "Impostazioni",
"tray": {
"quit": "Esentato",
"showMainWindow": "Ricerca",
"showSettingsWindow": "Impostazioni"
}
"settings": "Impostazioni",
"tray": {
"quit": "Esentato",
"showMainWindow": "Ricerca",
"showSettingsWindow": "Impostazioni"
}
}

View File

@ -1,8 +1,8 @@
{
"settings": "設定",
"tray": {
"quit": "やめる",
"showMainWindow": "検索",
"showSettingsWindow": "設定"
}
"settings": "設定",
"tray": {
"quit": "やめる",
"showMainWindow": "検索",
"showSettingsWindow": "設定"
}
}

View File

@ -1,8 +1,8 @@
{
"settings": "설정",
"tray": {
"quit": "그만두다",
"showMainWindow": "찾다",
"showSettingsWindow": "설정"
}
"settings": "설정",
"tray": {
"quit": "그만두다",
"showMainWindow": "찾다",
"showSettingsWindow": "설정"
}
}

View File

@ -1,22 +1,22 @@
{
"settings": {
"title": "设置",
"about": "关于",
"screen": "屏幕",
"screen-recording": "屏幕录制",
"version": "版本 {version}",
"copyright": "版权所有 © 2024 alikia2x",
"note": "OpenRewind 是基于<1>AGPL 3.0</1>授权的开源软件, <3></3>其源代码托管在<5>GitHub</5>上。",
"environment-details": "运行环境",
"node-version": "Node.js 版本",
"electron-version": "Electron 版本",
"chrome-version": "Chrome 版本",
"os-version": "系统版本",
"os": "操作系统"
},
"tray": {
"showMainWindow": "搜索…",
"showSettingsWindow": "应用设置",
"quit": "退出 OpenRewind"
}
"settings": {
"title": "设置",
"about": "关于",
"screen": "屏幕",
"screen-recording": "屏幕录制",
"version": "版本 {version}",
"copyright": "版权所有 © 2024 alikia2x",
"note": "OpenRewind 是基于<1>GPL 3.0</1>授权的开源软件, <3></3>其源代码托管在<5>GitHub</5>上。",
"environment-details": "运行环境",
"node-version": "Node.js 版本",
"electron-version": "Electron 版本",
"chrome-version": "Chrome 版本",
"os-version": "系统版本",
"os": "操作系统"
},
"tray": {
"showMainWindow": "搜索…",
"showSettingsWindow": "应用设置",
"quit": "退出 OpenRewind"
}
}

View File

@ -1,24 +1,31 @@
{
"name": "openrewind",
"version": "0.2.0",
"version": "0.10.0",
"type": "module",
"description": "Your second brain, superpowered.",
"main": "dist/dev/index.js",
"main": "dist/electron/index.js",
"scripts": {
"dev": "cross-env NODE_ENV=dev bun run dev:all",
"dev:all": "concurrently -n=react,electron -c='#ff3e00',blue \"bun run dev:react\" \"bun run dev:electron\"",
"dev:react": "vite dev",
"dev:electron": "bunx gulp build && electron dist/dev/index.js",
"dev:electron": "bunx gulp build && electron dist/electron/index.js",
"build:react": "vite build",
"build:app": "bunx gulp build",
"build:electron": "electron-builder",
"start": "cross-env NODE_ENV=production bun run start:all"
"format": "bunx prettier --write ."
},
"keywords": [],
"author": "",
"license": "MIT",
"dependencies": {
"@alikia/random-key": "npm:@jsr/alikia__random-key",
"@electron/remote": "^2.1.2",
"@hono/node-server": "^1.13.7",
"@types/node-os-utils": "^1.3.4",
"@unly/universal-language-detector": "^2.0.3",
"better-sqlite3": "^11.6.0",
"dayjs": "^1.11.13",
"detect-port": "^2.1.0",
"electron-context-menu": "^4.0.4",
"electron-reloader": "^1.2.3",
"electron-screencapture": "^1.1.0",
@ -26,33 +33,45 @@
"electron-store": "^10.0.0",
"electron-window-state": "^5.0.3",
"execa": "^9.5.1",
"ffmpeg-static": "^5.2.0",
"fluent-ffmpeg": "^2.1.3",
"hono": "^4.6.15",
"i18next": "^24.0.2",
"i18next-browser-languagedetector": "^8.0.0",
"i18next-electron-fs-backend": "^3.0.2",
"i18next-fs-backend": "^2.6.0",
"i18next-icu": "^2.3.0",
"image-size": "^1.1.1",
"jotai": "^2.11.0",
"memory-cache": "^0.2.0",
"node-os-utils": "^1.3.7",
"pino": "^9.6.0",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"react-i18next": "^15.1.2",
"react-router": "^7.0.1",
"react-router-dom": "^7.0.1",
"screenshot-desktop": "^1.15.0",
"sqlite3": "^5.1.7",
"sqlstring": "^2.3.3",
"vite-tsconfig-paths": "^5.1.3"
},
"devDependencies": {
"@electron/rebuild": "^3.7.1",
"@eslint/js": "^9.13.0",
"@iconify-icon/react": "^2.1.0",
"@types/fluent-ffmpeg": "^2.1.27",
"@types/better-sqlite3": "^7.6.12",
"@types/gulp": "^4.0.17",
"@types/memory-cache": "^0.2.6",
"@types/react": "^18.3.12",
"@types/react-dom": "^18.3.1",
"@types/screenshot-desktop": "^1.12.3",
"@types/sqlstring": "^2.3.2",
"@vitejs/plugin-react": "^4.3.3",
"autoprefixer": "^10.4.19",
"concurrently": "^9.0.1",
"cross-env": "^7.0.3",
"del": "^8.0.0",
"electron": "^33.2.0",
"electron-build": "^0.0.3",
"electron-builder": "^25.1.8",
"eslint": "^9.13.0",
"eslint-plugin-react-hooks": "^5.0.0",

View File

@ -1,3 +1,3 @@
body {
margin: 0;
}
margin: 0;
}

View File

@ -1,42 +1,251 @@
import { useState } from "react";
import "./index.css";
import { useCallback, useEffect, useRef, useState } from "react";
import type { Frame } from "../../src/electron/backend/schema.d.ts";
import dayjs from "dayjs";
import relativeTime from "dayjs/plugin/relativeTime";
import localizedFormat from "dayjs/plugin/localizedFormat";
import updateLocale from "dayjs/plugin/updateLocale";
import { useAtomValue } from "jotai";
import { apiInfoAtom } from "src/renderer/state/apiInfo.ts";
export default function RewindPage() {
const [currentScreenShotBase64, setScreenShotData] = useState<string | null>(null);
window.api.receive("fromMain", (message: string) => {
setScreenShotData(message);
});
dayjs.extend(relativeTime);
dayjs.extend(localizedFormat);
dayjs.extend(updateLocale);
dayjs.updateLocale("en", {
relativeTime: {
future: "in %s",
past: "%s ago",
s: "%d seconds",
m: "1 minute",
mm: "%d minutes",
h: "1 hour",
hh: "%d hours",
d: "1 day",
dd: "%d days",
M: "1 month",
MM: "%d months",
y: "1 year",
yy: "%d years"
}
});
function Image({ src }: { src: string }) {
return (
<>
<div className="w-screen h-screen relative dark:text-white">
{currentScreenShotBase64 && (
<img
className="absolute top-0 left-0 z-10 w-full h-full"
src={"data:image/png;base64," + currentScreenShotBase64}
alt=""
/>
)}
{currentScreenShotBase64 ? (
<div
className="rounded-xl bottom-12 left-6 fixed z-30 w-auto h-auto px-4 py-3
bg-white bg-opacity-50 backdrop-blur-lg text-gray-800"
>
Here's a screenshot captured just now.
<br />
The relavant features has not been implemented, and you han hit Esc to quit
this window.
<br />
Meow! (=^ω^=)丿
</div>
) : (
<div
className="rounded-xl bottom-12 left-6 fixed z-30 w-auto h-auto px-4 py-3
bg-white bg-opacity-50 backdrop-blur-lg text-gray-800"
>
Now capturing a screenshot for your screen...( ̀_́)
</div>
)}
</div>
</>
<img
src={src}
alt="Current frame"
className="w-full h-full object-contain absolute inset-0"
/>
);
}
// TODO: Memory optimization
export default function RewindPage() {
const { port, apiKey } = useAtomValue(apiInfoAtom);
const [timeline, setTimeline] = useState<Frame[]>([]);
const [currentFrameId, setCurrentFrameId] = useState<number | null>(null);
const [images, setImages] = useState<Record<number, string>>({});
const [isLoadingMore, setIsLoadingMore] = useState(false);
const containerRef = useRef<HTMLDivElement>(null);
const lastAvaliableFrameId = useRef<number | null>(null);
const timeoutRef = useRef<NodeJS.Timeout | null>(null);
const updatedTimes = useRef<number>(0);
const loadingQueue = useRef<number[]>([]);
const isProcessingQueue = useRef(false);
const processQueue = useCallback(async () => {
if (!port || isProcessingQueue.current || loadingQueue.current.length === 0) return;
isProcessingQueue.current = true;
const frameId = loadingQueue.current.shift()!;
try {
const startUpdateTimes = updatedTimes.current;
const response = await fetch(`http://localhost:${port}/frame/${frameId}`, {
headers: {
"x-api-key": apiKey
}
});
const blob = await response.blob();
const url = URL.createObjectURL(blob);
setImages((prev) => {
const newImages = { ...prev, [frameId]: url };
if (updatedTimes.current <= startUpdateTimes) {
lastAvaliableFrameId.current = frameId;
updatedTimes.current++;
}
return newImages;
});
} catch (error) {
console.error(error);
} finally {
isProcessingQueue.current = false;
setTimeout(() => {
processQueue();
}, 500);
}
}, [apiKey, port]);
const loadImage = useCallback(
(frameId: number) => {
if (!port || images[frameId]) return;
// Add to queue if not already in it
if (!loadingQueue.current.includes(frameId)) {
loadingQueue.current.push(frameId);
// preserve up to 5 tasks in the queue
loadingQueue.current = loadingQueue.current.slice(-5);
}
// Start processing if not already running
if (!isProcessingQueue.current) {
processQueue();
}
},
[images, port, processQueue]
);
// Load current frame after 400ms of inactivity
useEffect(() => {
if (timeoutRef.current) {
clearTimeout(timeoutRef.current);
}
if (currentFrameId) {
timeoutRef.current = setTimeout(() => {
loadImage(currentFrameId);
}, 400);
}
return () => {
if (timeoutRef.current) {
clearTimeout(timeoutRef.current);
}
};
}, [currentFrameId, loadImage]);
// Fetch timeline data
const fetchTimeline = useCallback(
async (untilID?: number) => {
if (!port) return;
try {
const url = new URL(`http://localhost:${port}/timeline`);
if (untilID) {
url.searchParams.set("untilID", untilID.toString());
}
const response = await fetch(url.toString(), {
headers: {
"x-api-key": apiKey
}
});
const data = await response.json();
setTimeline((prev) => (untilID ? [...prev, ...data] : data));
} catch (error) {
console.error(error);
}
},
[port, apiKey]
);
useEffect(() => {
fetchTimeline();
}, [fetchTimeline]);
// Load initial images
useEffect(() => {
if (timeline.length > 0 && !currentFrameId) {
setCurrentFrameId(timeline[0].id);
loadImage(timeline[0].id);
if (timeline.length > 1) {
loadImage(timeline[1].id);
}
}
}, [timeline, currentFrameId, loadImage]);
const lastScrollTime = useRef(Date.now());
const handleScroll = (e: React.WheelEvent) => {
if (!containerRef.current || !currentFrameId) return;
// Only allow scroll changes every 30ms
const now = Date.now();
if (now - lastScrollTime.current < 30) return;
lastScrollTime.current = now;
const delta = Math.sign(e.deltaY);
const currentIndex = timeline.findIndex((frame) => frame.id === currentFrameId);
if (currentIndex === -1) return;
const newIndex = Math.min(Math.max(currentIndex - delta, 0), timeline.length - 1);
const newFrameId = timeline[newIndex].id;
if (newFrameId !== currentFrameId) {
setCurrentFrameId(newFrameId);
// Preload adjacent images
if (newIndex > 0) loadImage(timeline[newIndex - 1].id);
if (newIndex < timeline.length - 1) loadImage(timeline[newIndex + 1].id);
// Load more timeline data when we're near the end
if (newIndex > timeline.length - 10 && !isLoadingMore) {
setIsLoadingMore(true);
const lastID = timeline[timeline.length - 1].id;
fetchTimeline(lastID).finally(() => setIsLoadingMore(false));
}
}
};
function displayTime(time: number) {
// if diff < 1h, fromNow()
// else use localized format
const diff = dayjs().diff(dayjs.unix(time), "second");
if (diff < 3600) {
return dayjs.unix(time).fromNow();
} else {
return dayjs.unix(time).format("llll");
}
}
return (
<div
ref={containerRef}
className="w-screen h-screen relative dark:text-white overflow-hidden bg-black"
onWheel={handleScroll}
>
<img
src={currentFrameId
? images[currentFrameId] ||
(lastAvaliableFrameId.current ? images[lastAvaliableFrameId.current] : "")
: ""}
alt="background"
className="w-full h-full object-cover absolute inset-0 blur-lg"
/>
{/* Current image */}
<Image
src={
currentFrameId
? images[currentFrameId] ||
(lastAvaliableFrameId.current ? images[lastAvaliableFrameId.current] : "")
: ""
}
/>
{/* Time capsule */}
<div
className="absolute bottom-8 left-8 bg-zinc-800 text-white bg-opacity-80 backdrop-blur-lg
rounded-full px-4 py-2 text-xl"
>
{currentFrameId
? displayTime(
timeline.find((frame) => frame.id === currentFrameId)!.createdAt
) || "Loading..."
: "Loading..."}
</div>
</div>
);
}

View File

@ -1,19 +1,19 @@
#root {
overflow: hidden;
user-select: none;
overflow: hidden;
user-select: none;
}
#settings-note a {
@apply text-blue-700 dark:text-[#66ccff]
@apply text-blue-700 dark:text-[#66ccff];
}
.text-weaken {
@apply text-gray-700 dark:text-gray-300;
@apply text-gray-700 dark:text-gray-300;
}
#settings-scroll-container::-webkit-scrollbar {
display: none;
display: none;
}
#settings-scroll-container {
scrollbar-width: none;
}
scrollbar-width: none;
}

View File

@ -8,10 +8,59 @@ import Title from "components/settings/Title.tsx";
import OpenSourceNote from "components/settings/OpenSourceNote.tsx";
import EnvironmentDetails from "components/settings/EnvironmentDetails.tsx";
function showFrame() {
return navigator.userAgent.includes("Mac");
}
interface SettingsGroupRefs {
[key: string]: HTMLDivElement;
}
function TitleBar() {
const { t } = useTranslation();
if (showFrame()) {
return (
<div className="w-full flex items-center justify-center h-9" id="title-bar">
{t("settings.title")}
</div>
);
} else {
return (
<div className="w-full h-9">
<div
className="w-[calc(100%-44px)] h-9 absolute left-[22px] flex justify-center"
id="title-bar"
>
<span className="self-center">{t("settings.title")}</span>
</div>
<div
className="z-50 absolute right-2.5 top-2.5 bg-red-500 hover:bg-rose-400 h-3 w-3 rounded-full"
onClick={() => {
console.log(window.settingsWindow);
window.settingsWindow.close();
}}
>
<svg
className="hover:opacity-100 opacity-0"
xmlns="http://www.w3.org/2000/svg"
width="12"
height="12"
viewBox="0 0 24 24"
>
<path
fill="none"
stroke="currentColor"
strokeLinecap="round"
strokeWidth="2"
d="m8.464 15.535l7.072-7.07m-7.072 0l7.072 7.07"
/>
</svg>
</div>
</div>
);
}
}
export default function SettingsPage() {
const { t } = useTranslation();
const [groupRefs, setGroupRefs] = useState<SettingsGroupRefs>({});
@ -29,18 +78,20 @@ export default function SettingsPage() {
const key = groupName as keyof typeof groupRefs;
console.log(groupRefs[key]);
if (!groupRefs[key]) return;
containerRef.current!.scrollTop = groupRefs[key].getBoundingClientRect().top -
containerRef.current!.scrollTop =
groupRefs[key].getBoundingClientRect().top -
titleBarRef.current!.getBoundingClientRect().height;
}
return (
<>
<title>{t("settings.title")}</title>
<div className="w-full h-auto bg-white dark:bg-gray-800 !bg-opacity-80 flex flex-col
dark:text-white font-semibold fixed z-10 backdrop-blur-lg text-[.9rem]" ref={titleBarRef}>
<div className="w-full flex items-center justify-center h-9" id="title-bar">
{t("settings.title")}
</div>
<div
className="w-full h-auto bg-white dark:bg-gray-800 !bg-opacity-80 flex flex-col
dark:text-white font-semibold fixed z-10 backdrop-blur-lg text-[.9rem]"
ref={titleBarRef}
>
<TitleBar />
<div className="h-[4.5rem] pt-0 pb-2">
<div className="w-full h-full px-20 flex items-center justify-center gap-2">
<MenuItem
@ -56,19 +107,23 @@ export default function SettingsPage() {
</div>
</div>
</div>
<div className="h-full bg-slate-100 dark:bg-gray-900 w-full scroll-smooth
relative dark:text-white pt-28 pb-12 px-10 overflow-auto" ref={containerRef} id="settings-scroll-container">
<div
className="h-full bg-slate-100 dark:bg-gray-900 w-full scroll-smooth
relative dark:text-white pt-28 pb-12 px-10 overflow-auto"
ref={containerRef}
id="settings-scroll-container"
>
<SettingsGroup groupName="screen" addGroupRef={addGroupRef}>
<Title i18nKey="settings.screen-recording"/>
<Title i18nKey="settings.screen-recording" />
<div className="flex">
<p>Nothing yet.</p>
</div>
</SettingsGroup>
<SettingsGroup groupName="about" addGroupRef={addGroupRef}>
<Title i18nKey={"settings.about"}/>
<IconWithText/>
<OpenSourceNote/>
<EnvironmentDetails/>
<Title i18nKey={"settings.about"} />
<IconWithText />
<OpenSourceNote />
<EnvironmentDetails />
</SettingsGroup>
</div>
</>

File diff suppressed because it is too large Load Diff

Binary file not shown.

After

Width:  |  Height:  |  Size: 449 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 454 KiB

View File

@ -0,0 +1,3 @@
export const RECORD_FRAME_RATE = 0.5;
export const ENCODING_FRAME_RATE = 30;
export const ENCODING_FRAME_INTERVAL = 1 / ENCODING_FRAME_RATE;

View File

@ -0,0 +1,237 @@
import { exec } from "child_process";
import fs from "fs";
import path, { join } from "path";
import type { EncodingTask, Frame } from "./schema";
import sizeOf from "image-size";
import { getEncodeCommand } from "../utils/index.js";
import { getRecordingsDir, getEncodingTempDir, getScreenshotsDir } from "../utils/index.js";
import cache from "memory-cache";
import { ENCODING_FRAME_INTERVAL, RECORD_FRAME_RATE as FRAME_RATE } from "./consts.js";
import { getDatabase } from "../utils/index.js";
const THREE_MINUTES = 180;
const MIN_FRAMES_TO_ENCODE = THREE_MINUTES * FRAME_RATE;
const CONCURRENCY = 1;
// Detect and insert encoding tasks
export function checkFramesForEncoding() {
const db = getDatabase();
const stmt = db.prepare(`
SELECT id, imgFilename, createdAt
FROM frame
WHERE encodeStatus = 0
AND imgFilename IS NOT NULL
ORDER BY createdAt;
`);
const frames = stmt.all() as Frame[];
const buffer: Frame[] = [];
for (let i = 1; i < frames.length; i++) {
const frame = frames[i];
const lastFrame = frames[i - 1];
const framePath = join(getScreenshotsDir(), frame.imgFilename!);
const lastFramePath = join(getScreenshotsDir(), lastFrame.imgFilename!);
if (!fs.existsSync(framePath)) {
console.warn("File not exist:", frame.imgFilename);
deleteFrameFromDB(frame.id);
continue;
}
if (!fs.existsSync(lastFramePath)) {
console.warn("File not exist:", lastFrame.imgFilename);
deleteFrameFromDB(lastFrame.id);
continue;
}
const currentFrameSize = sizeOf(framePath);
const lastFrameSize = sizeOf(lastFramePath);
const twoFramesHaveSameSize =
currentFrameSize.width === lastFrameSize.width &&
currentFrameSize.height === lastFrameSize.height;
const bufferIsBigEnough = buffer.length >= MIN_FRAMES_TO_ENCODE;
const chunkConditionSatisfied = !twoFramesHaveSameSize || bufferIsBigEnough;
buffer.push(lastFrame);
if (chunkConditionSatisfied) {
// Create new encoding task
const taskStmt = db.prepare(`
INSERT INTO encoding_task (status)
VALUES (0);
`);
const taskId = taskStmt.run().lastInsertRowid;
// Insert frames into encoding_task_data
const insertStmt = db.prepare(`
INSERT INTO encoding_task_data (encodingTaskID, frame)
VALUES (?, ?);
`);
for (const frame of buffer) {
insertStmt.run(taskId, frame.id);
db.prepare(
`
UPDATE frame
SET encodeStatus = 1
WHERE id = ?;
`
).run(frame.id);
}
console.log(`Created encoding task ${taskId} with ${buffer.length} frames`);
buffer.length = 0;
}
}
}
function deleteEncodedScreenshots() {
const db = getDatabase();
// TODO: double-check that the frame was really encoded into the video
const stmt = db.prepare(`
SELECT *
FROM frame
WHERE encodeStatus = 2
AND imgFilename IS NOT NULL;
`);
const frames = stmt.all() as Frame[];
for (const frame of frames) {
const imgPath = path.join(getScreenshotsDir(), frame.imgFilename!);
if (fs.existsSync(imgPath)) {
fs.unlinkSync(imgPath);
}
const updateStmt = db.prepare(`
UPDATE frame
SET imgFilename = NULL
WHERE id = ?;
`);
updateStmt.run(frame.id);
}
}
function _deleteNonExistentScreenshots() {
const db = getDatabase();
const screenshotDir = getScreenshotsDir();
const filesInDir = new Set(fs.readdirSync(screenshotDir));
const dbStmt = db.prepare(`
SELECT imgFilename
FROM frame
WHERE imgFilename IS NOT NULL;
`);
const dbFiles = dbStmt.all() as { imgFilename: string }[];
const dbFileSet = new Set(dbFiles.map((f) => f.imgFilename));
for (const filename of filesInDir) {
if (!dbFileSet.has(filename)) {
//fs.unlinkSync(path.join(screenshotDir, filename));
console.log("[dry-run] delete:", filename);
}
}
}
export async function deleteUnnecessaryScreenshots() {
deleteEncodedScreenshots();
//deleteNonExistentScreenshots();
}
export function deleteFrameFromDB(id: number) {
const db = getDatabase();
const deleteStmt = db.prepare(`
DELETE
FROM frame
WHERE id = ?;
`);
deleteStmt.run(id);
console.log(`Deleted frame ${id} from database`);
}
function getTasksPerforming() {
return (cache.get("backend:encodingTasksPerforming") as string[]) || [];
}
function createMetaFile(frames: Frame[]) {
return frames
.map((frame) => {
if (!frame.imgFilename) return "";
const framePath = join(getScreenshotsDir(), frame.imgFilename);
const duration = ENCODING_FRAME_INTERVAL.toFixed(5);
return `file '${framePath}'\nduration ${duration}`;
})
.join("\n");
}
// Check and process encoding task
export function processEncodingTasks() {
const db = getDatabase();
let tasksPerforming = getTasksPerforming();
if (tasksPerforming.length >= CONCURRENCY) return;
const stmt = db.prepare(`
SELECT id, status
FROM encoding_task
WHERE status = 0 LIMIT ?
`);
const tasks = stmt.all(CONCURRENCY - tasksPerforming.length) as EncodingTask[];
for (const task of tasks) {
const taskId = task.id;
// Create transaction
db.prepare(`BEGIN TRANSACTION;`).run();
// Update task status as processing (1)
const updateStmt = db.prepare(`
UPDATE encoding_task
SET status = 1
WHERE id = ?
`);
updateStmt.run(taskId);
const framesStmt = db.prepare(`
SELECT frame.imgFilename, frame.id
FROM encoding_task_data
JOIN frame ON encoding_task_data.frame = frame.id
WHERE encoding_task_data.encodingTaskID = ?
ORDER BY frame.createdAt
`);
const frames = framesStmt.all(taskId) as Frame[];
const metaFilePath = path.join(getEncodingTempDir(), `${taskId}_meta.txt`);
const metaContent = createMetaFile(frames);
fs.writeFileSync(metaFilePath, metaContent);
cache.put("backend:encodingTasksPerforming", [...tasksPerforming, taskId.toString()]);
const videoPath = path.join(getRecordingsDir(), `${taskId}.mp4`);
const ffmpegCommand = getEncodeCommand(metaFilePath, videoPath);
console.log("FFMPEG", ffmpegCommand);
exec(ffmpegCommand, (error, _stdout, _stderr) => {
if (error) {
console.error(`FFmpeg error: ${error.message}`);
// Roll back transaction
db.prepare(`ROLLBACK;`).run();
} else {
console.log(`Video ${videoPath} created successfully`);
// Update task status to complete (2)
const completeStmt = db.prepare(`
UPDATE encoding_task
SET status = 2
WHERE id = ?
`);
completeStmt.run(taskId);
for (let frameIndex = 0; frameIndex < frames.length; frameIndex++) {
const frame = frames[frameIndex];
const updateFrameStmt = db.prepare(`
UPDATE frame
SET videoPath = ?,
videoFrameIndex = ?,
encodeStatus = 2
WHERE id = ?
`);
updateFrameStmt.run(`${taskId}.mp4`, frameIndex, frame.id);
}
db.prepare(`COMMIT;`).run();
}
tasksPerforming = getTasksPerforming();
cache.put(
"backend:encodingTasksPerforming",
tasksPerforming.filter((id) => id !== taskId.toString())
);
fs.unlinkSync(metaFilePath);
});
}
}

View File

@ -0,0 +1,159 @@
import * as path from "path";
import { Database } from "better-sqlite3";
import DB from "better-sqlite3";
import { __dirname } from "../dirname.js";
import { getBinDir, getDatabaseDir } from "../utils/index.js";
import { migrate } from "./migrate/index.js";
function getLibSimpleExtensionPath() {
switch (process.platform) {
case "win32":
return path.join(getBinDir(), "libsimple", "simple.dll");
case "darwin":
return path.join(getBinDir(), "libsimple", "libsimple.dylib");
case "linux":
return path.join(getBinDir(), "libsimple", "libsimple.so");
default:
throw new Error("Unsupported platform");
}
}
function databaseInitialized(db: Database) {
return (
db.prepare(`SELECT name FROM sqlite_master WHERE type='table' AND name='frame';`).get() !==
undefined
);
}
function init(db: Database) {
db.exec(`
CREATE TABLE IF NOT EXISTS frame (
id INTEGER PRIMARY KEY AUTOINCREMENT,
createdAt REAL,
imgFilename TEXT,
segmentID INTEGER NULL,
videoPath TEXT NULL,
videoFrameIndex INTEGER NULL,
collectionID INTEGER NULL,
encodeStatus INTEGER DEFAULT 0,
FOREIGN KEY (segmentID) REFERENCES segments (id)
);
`);
db.exec(`
CREATE TABLE IF NOT EXISTS recognition_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
frameID INTEGER,
data TEXT,
text TEXT,
FOREIGN KEY (frameID) REFERENCES frame (id)
);
`);
db.exec(`
CREATE TABLE IF NOT EXISTS segments(
id INTEGER PRIMARY KEY AUTOINCREMENT,
startedAt REAL,
endedAt REAL,
title TEXT,
appName TEXT,
appPath TEXT,
text TEXT,
type TEXT,
appBundleID TEXT NULL,
url TEXT NULL
);
`);
db.exec(`
CREATE VIRTUAL TABLE IF NOT EXISTS text_search USING fts5(
id UNINDEXED,
frameID UNINDEXED,
data,
text
);
`);
db.exec(`
CREATE TRIGGER IF NOT EXISTS recognition_data_after_insert AFTER INSERT ON recognition_data
BEGIN
INSERT INTO text_search (id, frameID, data, text)
VALUES (NEW.id, NEW.frameID, NEW.data, NEW.text);
END;
`);
db.exec(`
CREATE TRIGGER IF NOT EXISTS recognition_data_after_update AFTER UPDATE ON recognition_data
BEGIN
UPDATE text_search
SET frameID = NEW.frameID, data = NEW.data, text = NEW.text
WHERE id = NEW.id;
END;
`);
db.exec(`
CREATE TRIGGER IF NOT EXISTS recognition_data_after_delete AFTER DELETE ON recognition_data
BEGIN
DELETE FROM text_search WHERE id = OLD.id;
END;
`);
db.exec(`
CREATE TABLE config (
key TEXT PRIMARY KEY,
value TEXT
);
`);
db.exec(`
CREATE TABLE IF NOT EXISTS encoding_task (
id INTEGER PRIMARY KEY AUTOINCREMENT,
createdAt REAL,
status INT DEFAULT 0
);
`);
db.exec(`
CREATE TABLE IF NOT EXISTS encoding_task_data (
encodingTaskID INTEGER,
frame ID INTEGER PRIMARY KEY,
FOREIGN KEY (encodingTaskID) REFERENCES encoding_task(id),
FOREIGN KEY (frame) REFERENCES frame(id)
);
`);
db.exec(`
CREATE TRIGGER IF NOT EXISTS delete_encoding_task
AFTER UPDATE OF status
ON encoding_task
BEGIN
DELETE FROM encoding_task_data
WHERE encodingTaskID = OLD.id AND NEW.status = 2;
DELETE FROM encoding_task
WHERE id = OLD.id AND NEW.status = 2;
END;
`);
db.exec(`
INSERT INTO config (key, value) VALUES ('version', '3');
`);
}
export async function initDatabase() {
const dbPath = getDatabaseDir();
const db = new DB(dbPath);
const libSimpleExtensionPath = getLibSimpleExtensionPath();
db.loadExtension(libSimpleExtensionPath);
if (!databaseInitialized(db)) {
init(db);
} else {
migrate(db);
}
db.exec("PRAGMA journal_mode=WAL;");
return db;
}

View File

@ -0,0 +1,34 @@
import { Database } from "better-sqlite3";
import { migrateToV2 } from "./migrateToV2.js";
import { migrateToV3 } from "./migrateToV3.js";
const CURRENT_VERSION = 3;
function migrateTo(version: number, db: Database) {
switch (version) {
case 2:
migrateToV3(db);
break;
}
}
function getVersion(db: Database): number {
const stmt = db.prepare(`SELECT value FROM config WHERE key = 'version';`);
const data = stmt.get() as { value: string };
const version = data.value;
return parseInt(version);
}
export function migrate(db: Database) {
const configTableExists =
db.prepare(`SELECT name FROM sqlite_master WHERE type='table' AND name='config';`).get() !==
undefined;
if (!configTableExists) {
migrateToV2(db);
}
let databaseVersion = getVersion(db);
while (databaseVersion < CURRENT_VERSION) {
migrateTo(databaseVersion, db);
databaseVersion = getVersion(db);
}
}

View File

@ -0,0 +1,80 @@
import { Database } from "better-sqlite3";
interface OldFrame {
id: number;
createAt: string;
imgFilename: string;
segmentID: number | null;
videoPath: string | null;
videoFrameIndex: number | null;
collectionID: number | null;
encoded: number;
}
function initSchemaInV2(db: Database) {
db.exec(`
CREATE TABLE config (
key TEXT PRIMARY KEY,
value TEXT
);
`);
db.exec(`
CREATE TABLE IF NOT EXISTS encoding_task (
id INTEGER PRIMARY KEY AUTOINCREMENT,
createAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
status INT DEFAULT 0
);
`);
db.exec(`
CREATE TABLE IF NOT EXISTS encoding_task_data (
encodingTaskID INTEGER,
frame ID INTEGER PRIMARY KEY,
FOREIGN KEY (encodingTaskID) REFERENCES encoding_task(id),
FOREIGN KEY (frame) REFERENCES frame(id)
);
`);
db.exec(`
CREATE TRIGGER IF NOT EXISTS delete_encoding_task
AFTER UPDATE OF status
ON encoding_task
BEGIN
DELETE FROM encoding_task_data
WHERE encodingTaskID = OLD.id AND NEW.status = 2;
DELETE FROM encoding_task
WHERE id = OLD.id AND NEW.status = 2;
END;
`);
db.exec(`
INSERT INTO config (key, value) VALUES ('version', '2');
`);
}
/*
* This function assumes that the database does not contain the "config" table,
* and thus needs to be migrated to Version 2.
* */
export function migrateToV2(db: Database) {
initSchemaInV2(db);
// Oh we saved tens of millions of bytes for user!
// Before: /Users/username/Library/Application Support/OpenRewind/Record Data/temp/screenshots/1733568609960.jpg
// After: 1733568609960.jpg
const rows = db.prepare("SELECT id, imgFilename FROM frame").all() as OldFrame[];
rows.forEach((row) => {
const filename = row.imgFilename.match(/[^\\/]+$/)?.[0];
if (filename) {
db.prepare("UPDATE frame SET imgFilename = ? WHERE id = ?").run(filename, row.id);
}
});
db.exec(`
ALTER TABLE frame ADD encodeStatus INT DEFAULT 0;
UPDATE frame SET encodeStatus = CASE WHEN encoded THEN 2 ELSE 0 END;
`);
}

View File

@ -0,0 +1,209 @@
import { Database } from "better-sqlite3";
function convertTimestampToUnix(timestamp: string): number {
const date = new Date(timestamp);
const now = new Date();
const offsetInMinutes = now.getTimezoneOffset();
const offsetInSeconds = offsetInMinutes * 60;
return date.getTime() / 1000 - offsetInSeconds;
}
function transformEncodingTask(db: Database) {
const createTableSql = `
CREATE TABLE IF NOT EXISTS encoding_task_new (
id INTEGER PRIMARY KEY AUTOINCREMENT,
createdAt REAL,
status INT DEFAULT 0
);
INSERT INTO encoding_task_new (id, createdAt, status)
SELECT id, createdAt, status FROM encoding_task;
DROP TABLE encoding_task;
ALTER TABLE encoding_task_new RENAME TO encoding_task;
ALTER TABLE encoding_task ADD COLUMN createdAt_new REAL;
`;
db.exec(createTableSql);
const rows = db.prepare(`SELECT id, createdAt FROM encoding_task`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStmt = db.prepare(`UPDATE encoding_task SET createdAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
const unixTimestamp = convertTimestampToUnix(row.createdAt as string);
updateStmt.run(unixTimestamp, row.id);
});
db.exec(`
ALTER TABLE encoding_task DROP COLUMN createdAt;
ALTER TABLE encoding_task RENAME COLUMN createdAt_new TO createdAt;
`);
}
function transformFrame(db: Database) {
const createTableSql = `
CREATE TABLE frame_new(
id INTEGER PRIMARY KEY AUTOINCREMENT,
createdAt REAL,
imgFilename TEXT,
segmentID INTEGER NULL,
videoPath TEXT NULL,
videoFrameIndex INTEGER NULL,
collectionID INTEGER NULL,
encodeStatus INT DEFAULT 0,
FOREIGN KEY (segmentID) REFERENCES segments (id)
);
INSERT INTO frame_new (id, createdAt, imgFilename, segmentID, videoPath, videoFrameIndex, collectionID, encodeStatus)
SELECT id, createdAt, imgFilename, segmentID, videoPath, videoFrameIndex, collectionID, encodeStatus FROM frame;
DROP TABLE frame;
ALTER TABLE frame_new RENAME TO frame;
ALTER TABLE frame ADD COLUMN createdAt_new REAL;
`;
db.exec(createTableSql);
const rows = db.prepare(`SELECT id, createdAt FROM frame`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStmt = db.prepare(`UPDATE frame SET createdAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
const unixTimestamp = convertTimestampToUnix(row.createdAt as string);
updateStmt.run(unixTimestamp, row.id);
});
db.exec(`
ALTER TABLE frame DROP COLUMN createdAt;
ALTER TABLE frame RENAME COLUMN createdAt_new TO createdAt;
`);
}
function transformSegments(db: Database) {
db.exec(`
CREATE TABLE IF NOT EXISTS segments_new(
id INTEGER PRIMARY KEY AUTOINCREMENT,
startedAt REAL,
endedAt REAL,
title TEXT,
appName TEXT,
appPath TEXT,
text TEXT,
type TEXT,
appBundleID TEXT NULL,
url TEXT NULL
);
INSERT INTO segments_new (id, startedAt, endedAt, title, appName, appPath, text, type, appBundleID, url)
SELECT id, startedAt, endedAt, title, appName, appPath, text, type, appBundleID, url FROM segments;
DROP TABLE segments;
ALTER TABLE segments_new RENAME TO segments;
ALTER TABLE segments ADD COLUMN startedAt_new REAL;
ALTER TABLE segments ADD COLUMN endedAt_new REAL;
`);
const rows = db.prepare(`SELECT id, startedAt, endedAt FROM segments`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStart = db.prepare(`UPDATE segments SET startedAt_new = ? WHERE id = ?`);
const updateEnd = db.prepare(`UPDATE segments SET endedAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
updateStart.run(convertTimestampToUnix(row.startedAt as string), row.id);
updateEnd.run(convertTimestampToUnix(row.endedAt as string), row.id);
});
db.exec(`
ALTER TABLE segments DROP COLUMN startedAt;
ALTER TABLE segments DROP COLUMN endedAt;
ALTER TABLE segments RENAME COLUMN startedAt_new TO startedAt;
ALTER TABLE segments RENAME COLUMN endedAt_new TO endedAt;
`);
}
function renameColumn(
tableName: string,
oldColumnName: string,
newColumnName: string,
db: Database
) {
if (
db
.prepare(`SELECT 1 FROM pragma_table_info(?) WHERE name=?`)
.get([tableName, oldColumnName])
) {
db.exec(`ALTER TABLE ${tableName} RENAME COLUMN ${oldColumnName} TO ${newColumnName};`);
}
}
export function migrateToV3(db: Database) {
db.prepare(`ALTER TABLE segements RENAME TO segments`).run();
db.exec(`
PRAGMA foreign_keys = OFF;
CREATE TABLE frame_new(
id INTEGER PRIMARY KEY AUTOINCREMENT,
createAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
imgFilename TEXT,
segmentID INTEGER NULL,
videoPath TEXT NULL,
videoFrameIndex INTEGER NULL,
collectionID INTEGER NULL,
encodeStatus INT DEFAULT 0,
FOREIGN KEY (segmentID) REFERENCES segments (id)
);
INSERT INTO frame_new (id, createAt, imgFilename, segmentID, videoPath, videoFrameIndex, collectionID, encodeStatus)
SELECT id, createAt, imgFilename, segmentID, videoPath, videoFrameIndex, collectionID, encodeStatus FROM frame;
DROP TABLE frame;
ALTER TABLE frame_new RENAME TO frame;
CREATE TABLE encoding_task_data_new (
encodingTaskID INTEGER,
frame ID INTEGER PRIMARY KEY,
FOREIGN KEY (encodingTaskID) REFERENCES encoding_task(id),
FOREIGN KEY (frame) REFERENCES frame(id)
);
INSERT INTO encoding_task_data SELECT * FROM encoding_task_data_new;
DROP TRIGGER delete_encoding_task;
DROP TABLE encoding_task_data;
ALTER TABLE encoding_task_data_new RENAME TO encoding_task_data;
CREATE TRIGGER IF NOT EXISTS delete_encoding_task
AFTER UPDATE OF status
ON encoding_task
BEGIN
DELETE FROM encoding_task_data
WHERE encodingTaskID = OLD.id AND NEW.status = 2;
DELETE FROM encoding_task
WHERE id = OLD.id AND NEW.status = 2;
END;
CREATE TABLE recognition_data_new (
id INTEGER PRIMARY KEY AUTOINCREMENT,
frameID INTEGER,
data TEXT,
text TEXT,
FOREIGN KEY (frameID) REFERENCES frame (id)
);
INSERT INTO recognition_data SELECT * FROM recognition_data_new;
DROP TABLE recognition_data;
ALTER TABLE recognition_data_new RENAME TO recognition_data;
PRAGMA foreign_keys = ON;
`);
renameColumn("encoding_task", "createAt", "createdAt", db);
renameColumn("frame", "createAt", "createdAt", db);
renameColumn("segments", "startAt", "startedAt", db);
renameColumn("segments", "endAt", "endedAt", db);
if (db.prepare(`SELECT 1 FROM pragma_table_info('frame') WHERE name='encoded'`).get()) {
db.prepare(`ALTER TABLE frame DROP COLUMN encoded`).run();
}
transformSegments(db);
transformFrame(db);
transformEncodingTask(db);
db.exec(`
UPDATE config SET value = '3' WHERE key = 'version';
`);
}

View File

@ -0,0 +1,13 @@
type RecognitionResult = RecognitionLine[];
type Pixels = number;
type OriginX = Pixels;
type OriginY = Pixels;
type Width = Pixels;
type Height = Pixels;
type Coordinates = [OriginX, OriginY, Width, Height];
interface RecognitionLine {
text: string;
confidence?: number | number[];
position?: Coordinates;
}

View File

@ -0,0 +1,253 @@
import osu from "node-os-utils";
type TaskId = string;
type TaskFunction = () => void;
interface Task {
id: TaskId;
func: TaskFunction;
interval?: number;
lastRun?: number;
nextRun?: number;
isPaused: boolean;
delayUntil?: number;
requiredSystemState: SystemState;
}
export interface TaskStatus {
status: "NOT_FOUND" | "PAUSED" | "DELAYED" | "SCHEDULED" | "IDLE";
until?: string;
nextRun?: string;
}
type SystemState = "ANY" | "LOW_POWER" | "IDLE";
export class Scheduler {
private tasks: Map<TaskId, Task> = new Map();
private timer: NodeJS.Timeout | null = null;
private monitorTimer: NodeJS.Timeout | null = null;
private cpuUsage: number = 0;
constructor(private readonly minTickInterval: number = 500) {
this.start();
}
private start(): void {
this.scheduleNextTick();
this.monitorTimer = setInterval(() => this.monitor(), 1000);
}
private monitor(): void {
osu.cpu.usage().then((cpuPercentage) => {
this.cpuUsage = cpuPercentage / 100;
})
}
private scheduleNextTick(): void {
if (this.timer) {
clearTimeout(this.timer);
}
const now = Date.now();
let nextTick = now + this.minTickInterval;
for (const task of this.tasks.values()) {
const isTaskPaused = task.isPaused;
const isTaskDelayed = task.delayUntil && now < task.delayUntil;
if (isTaskPaused || isTaskDelayed) {
continue;
}
const nextTaskEarlierThanNextTick = task.nextRun && task.nextRun < nextTick;
if (nextTaskEarlierThanNextTick) {
nextTick = task.nextRun!;
}
}
const delay = Math.max(0, nextTick - now);
this.timer = setTimeout(() => this.tick(), delay);
}
private tickSingleTask(
task: Task,
getNextTick: () => number,
updateNextTick: (nextTick: number) => void
): void {
const now = Date.now();
const isTaskPaused = task.isPaused;
const isTaskDelayed = task.delayUntil && now < task.delayUntil;
if (isTaskPaused || isTaskDelayed) {
return;
}
const taskRequiredLowPower = task.requiredSystemState === "LOW_POWER";
const cpuUsage = this.cpuUsage;
const isSystemLowPower = cpuUsage < 0.75;
const isTaskReadyForLowPowerRun = taskRequiredLowPower ? isSystemLowPower : true;
const reachedTaskNextRun = task.interval && task.nextRun && now >= task.nextRun;
const isTaskReadyForIntervalRun = reachedTaskNextRun && isTaskReadyForLowPowerRun;
if (!isTaskReadyForLowPowerRun) {
this.delayTask(task.id, 1000)
}
if (isTaskReadyForIntervalRun) {
task.func();
task.lastRun = now;
task.nextRun = now + task.interval!;
}
const isTaskNextRunEarlierThanNextTick = task.nextRun && task.nextRun < getNextTick();
if (isTaskNextRunEarlierThanNextTick) {
updateNextTick(task.nextRun!);
}
}
private tick(): void {
const now = Date.now();
let nextTick = now + this.minTickInterval;
for (const task of this.tasks.values()) {
this.tickSingleTask(
task,
() => nextTick,
(v) => (nextTick = v)
);
}
this.scheduleNextTick();
}
/**
* Add a new task to the scheduler.
*
* @param id A unique string identifier for the task.
* @param func The function to be executed by the task.
* @param interval The interval (in milliseconds) between task executions.
* @param requiredSystemState The required system state for the task to run.
*/
addTask(id: TaskId, func: TaskFunction, interval?: number, requiredSystemState: SystemState = "ANY"): void {
this.tasks.set(id, {
id,
func,
interval,
isPaused: false,
lastRun: undefined,
nextRun: interval ? Date.now() + interval : undefined,
requiredSystemState: requiredSystemState,
});
this.scheduleNextTick();
}
/**
* Trigger a task to execute immediately, regardless of its current state.
*
* If the task is paused or delayed, it will not be executed.
*
* @param id The unique string identifier for the task.
*/
triggerTask(id: TaskId): void {
const task = this.tasks.get(id);
if (task && !task.isPaused && (!task.delayUntil || Date.now() >= task.delayUntil)) {
task.func();
task.lastRun = Date.now();
if (task.interval) {
task.nextRun = Date.now() + task.interval;
}
}
this.scheduleNextTick();
}
/**
* Pause a task, so that it will not be executed until it is resumed.
*
* @param id The unique string identifier for the task.
*/
pauseTask(id: TaskId): void {
const task = this.tasks.get(id);
if (task) {
task.isPaused = true;
}
this.scheduleNextTick();
}
/**
* Resume a paused task, so that it can be executed according to its interval.
*
* @param id The unique string identifier for the task.
*/
resumeTask(id: TaskId): void {
const task = this.tasks.get(id);
if (task) {
task.isPaused = false;
}
this.scheduleNextTick();
}
/**
* Delay a task from being executed for a specified amount of time.
*
* @param id The unique string identifier for the task.
* @param delayMs The amount of time in milliseconds to delay the task's execution.
*/
delayTask(id: TaskId, delayMs: number): void {
const task = this.tasks.get(id);
if (task) {
task.delayUntil = Date.now() + delayMs;
if (task.nextRun) {
task.nextRun += delayMs;
}
}
this.scheduleNextTick();
}
setTaskInterval(id: TaskId, interval: number): void {
const task = this.tasks.get(id);
if (task) {
task.interval = interval;
task.nextRun = Date.now() + interval;
}
this.scheduleNextTick();
}
getTaskStatus(id: TaskId): TaskStatus {
const task = this.tasks.get(id);
if (!task) {
return { status: "NOT_FOUND" };
}
if (task.isPaused) {
return { status: "PAUSED" };
}
if (task.delayUntil && Date.now() < task.delayUntil) {
return {
status: "DELAYED",
until: new Date(task.delayUntil).toLocaleString()
};
}
if (task.nextRun) {
return {
status: "SCHEDULED",
nextRun: new Date(task.nextRun).toLocaleString()
};
}
return { status: "IDLE" };
}
stop(): void {
if (this.timer) {
clearTimeout(this.timer);
this.timer = null;
}
if (this.monitorTimer) {
clearTimeout(this.monitorTimer);
this.monitorTimer = null;
}
}
}

21
src/electron/backend/schema.d.ts vendored Normal file
View File

@ -0,0 +1,21 @@
export interface Frame {
id: number;
createdAt: number;
imgFilename: string | null;
segmentID: number | null;
videoPath: string | null;
videoFrameIndex: number | null;
collectionID: number | null;
encodeStatus: number;
}
export interface EncodingTask {
id: number;
createdAt: number;
status: number;
}
export interface EncodingTaskData {
encodingTaskID: number;
frame: number;
}

View File

@ -0,0 +1,23 @@
import screenshot from "screenshot-desktop";
import { getDatabase, getScreenshotsDir } from "../utils/index.js";
import { join } from "path";
import SqlString from "sqlstring";
export function takeScreenshot() {
const db = getDatabase();
const timestamp = new Date().getTime();
const screenshotDir = getScreenshotsDir();
const filename = `${timestamp}.png`;
const screenshotPath = join(screenshotDir, filename);
screenshot({ filename: screenshotPath, format: "png" })
.then(() => {
const SQL = SqlString.format(
"INSERT INTO frame (imgFilename, createdAt) VALUES (?, ?)",
[filename, new Date().getTime() / 1000]
);
db.exec(SQL);
})
.catch((err) => {
console.error(err);
});
}

View File

@ -1,7 +1,8 @@
import { app, BrowserWindow, screen } from "electron";
import { join } from "path";
import { __dirname } from "./utils.js";
import { __dirname } from "./dirname.js";
import windowStateManager from "electron-window-state";
import { hideDock, showDock } from "./utils/index.js";
function loadURL(window: BrowserWindow, path = "", vitePort: string) {
const dev = !app.isPackaged;
@ -9,50 +10,70 @@ function loadURL(window: BrowserWindow, path = "", vitePort: string) {
window.loadURL(`http://localhost:${vitePort}/#${path}`).catch((e) => {
console.log("Error loading URL:", e);
});
}
else {
window.loadFile(join(__dirname, "../renderer/index.html"), {
hash: path,
}).catch((e) => {
console.log("Error loading URL:", e);
});
} else {
window
.loadFile(join(__dirname, "../renderer/index.html"), {
hash: path
})
.catch((e) => {
console.log("Error loading URL:", e);
});
}
}
export function createSettingsWindow(vitePort: string, closeCallBack: Function) {
export function createSettingsWindow(vitePort: string, closeCallBack: () => void) {
const windowState = windowStateManager({
defaultWidth: 650,
defaultHeight: 550
});
const enableFrame = process.platform === "darwin";
let icon;
switch (process.platform) {
case "darwin":
icon = undefined;
break;
case "win32":
icon = join(__dirname, "assets/icon.ico");
break;
case "linux":
icon = join(__dirname, "assets/icon.png");
break;
default:
icon = undefined;
}
const window = new BrowserWindow({
width: 650,
height: 550,
webPreferences: {
nodeIntegration: true,
contextIsolation: true,
preload: join(__dirname, 'preload/settings.cjs')
preload: join(__dirname, "preload/settings.cjs")
},
titleBarStyle: "hiddenInset",
resizable: false,
show: false,
frame: enableFrame,
icon: icon
});
windowState.manage(window);
window.once("ready-to-show", () => {
window.show();
window.focus();
window.on("show", () => {
showDock();
});
window.on("close", (e) => {
window.hide();
windowState.saveState(window);
e.preventDefault();
closeCallBack();
});
window.once("close", () => {
window.hide()
window.hide();
hideDock();
});
loadURL(window, "settings", vitePort);
return window;
}
export function createMainWindow(vitePort: string, closeCallBack: Function) {
export function createMainWindow(vitePort: string, closeCallBack: () => void) {
const display = screen.getPrimaryDisplay();
const { width, height } = display.bounds;
const windowState = windowStateManager({
@ -73,23 +94,22 @@ export function createMainWindow(vitePort: string, closeCallBack: Function) {
webPreferences: {
nodeIntegration: true,
contextIsolation: true,
preload: join(__dirname, 'preload/rewind.cjs')
preload: join(__dirname, "preload/rewind.cjs")
},
roundedCorners: false,
transparent: true,
show: false,
title: "OpenRewind Rewind Page"
});
// Exclude the window from the recording
window.setContentProtection(true);
windowState.manage(window);
window.once("ready-to-show", () => {
window.show();
window.setAlwaysOnTop(true, "screen-saver");
window.setBounds({ x: 0, y: 0, width, height });
window.focus();
});
window.on("close", () => {
windowState.saveState(window);
closeCallBack();
});
window.once("close", () => {
closeCallBack();

4
src/electron/dirname.ts Normal file
View File

@ -0,0 +1,4 @@
import path from "path";
import { fileURLToPath } from "url";
export const __dirname = path.dirname(fileURLToPath(import.meta.url));

View File

@ -2,8 +2,7 @@ import { join } from "path";
import i18n from "i18next";
import fs from "fs";
import { app } from "electron";
import { __dirname } from "./utils.js";
import { __dirname } from "./dirname.js";
/**
* Selects the appropriate language based on system preferences and available languages
@ -21,7 +20,7 @@ export function detectLanguage(langs: string[], fallback: string): string {
const normalizedLang = systemLanguage.toLowerCase().split("-")[0];
// Find a matching language
const matchedLanguage = langs.find(lang => {
const matchedLanguage = langs.find((lang) => {
if (lang.indexOf(normalizedLang) !== -1) {
return lang;
}
@ -53,4 +52,3 @@ export default function initI18n() {
});
return i18n;
}

View File

@ -1,30 +1,46 @@
import { app, BrowserWindow, globalShortcut, Menu, nativeImage, Tray } from "electron";
import {
app,
BrowserWindow,
globalShortcut,
ipcMain,
Menu,
nativeImage,
screen,
Tray
} from "electron";
import contextMenu from "electron-context-menu";
import { join } from "path";
import initI18n from "./i18n.js";
import { createMainWindow, createSettingsWindow } from "./createWindow.js";
import { __dirname, captureScreen, getFirstCaptureScreenDeviceId } from "./utils.js";
import * as fs from "fs";
import { initDatabase } from "./backend/init.js";
import { Database } from "better-sqlite3";
import { takeScreenshot } from "./backend/screenshot.js";
import { __dirname } from "./dirname.js";
import { hideDock } from "./utils/index.js";
import {
checkFramesForEncoding,
deleteUnnecessaryScreenshots,
processEncodingTasks
} from "./backend/encoding.js";
import honoApp from "./server/index.js";
import { serve } from "@hono/node-server";
import { findAvailablePort } from "./utils/index.js";
import cache from "memory-cache";
import { generate as generateAPIKey } from "@alikia/random-key";
import { Scheduler } from "./backend/scheduler.js";
const i18n = initI18n();
const t = i18n.t.bind(i18n);
const port = process.env.PORT || "5173";
const dev = !app.isPackaged;
const scheduler = new Scheduler();
let tray = null;
let tray: null | Tray = null;
let dbConnection: null | Database = null;
async function c() {
const screenshotpath = join(__dirname, "screenshot.png");
const ffmpegPath = join(__dirname, dev ? "bin/macos/ffmpeg" : "../../bin/macos/ffmpeg");
const deviceID = await getFirstCaptureScreenDeviceId(ffmpegPath);
if (deviceID) {
await captureScreen(ffmpegPath, deviceID, screenshotpath);
const screenshotData = fs.readFileSync(screenshotpath, "base64");
return screenshotData;
}
return null;
}
let mainWindow: BrowserWindow | null;
let settingsWindow: BrowserWindow | null;
function createTray() {
const pathRoot: string = dev ? "./src/electron/assets/" : join(__dirname, "./assets/");
@ -36,26 +52,18 @@ function createTray() {
const contextMenu = Menu.buildFromTemplate([
{
label: t("tray.showMainWindow"),
click: async () => {
if (!mainWindow) mainWindow = createMainWindow(port, () => (mainWindow = null));
mainWindow!.webContents.send("fromMain", null);
mainWindow!.setIgnoreMouseEvents(true);
click: () => {
const display = screen.getPrimaryDisplay();
const { width, height } = display.bounds;
mainWindow!.show();
c()
.then((data) => {
mainWindow!.webContents.send("fromMain", data);
mainWindow!.setIgnoreMouseEvents(false);
})
.catch((err) => {
console.error(err);
});
mainWindow!.setAlwaysOnTop(true, "screen-saver");
mainWindow!.setBounds({ x: 0, y: 0, width, height });
mainWindow!.focus();
}
},
{
label: t("tray.showSettingsWindow"),
click: () => {
if (!settingsWindow)
settingsWindow = createSettingsWindow(port, () => (settingsWindow = null));
settingsWindow!.show();
}
},
@ -63,7 +71,7 @@ function createTray() {
{
label: t("tray.quit"),
click: () => {
app.quit();
app.exit();
}
}
]);
@ -72,9 +80,6 @@ function createTray() {
tray.setToolTip("OpenRewind");
}
let mainWindow: BrowserWindow | null;
let settingsWindow: BrowserWindow | null;
contextMenu({
showLookUpSelection: true,
showSearchWithGoogle: true,
@ -82,17 +87,56 @@ contextMenu({
});
app.once("ready", () => {
app.dock.hide();
hideDock();
});
app.on("activate", () => {});
app.on("ready", () => {
createTray();
findAvailablePort(12412).then((port) => {
generateAPIKey().then((key) => {
cache.put("server:port", port);
if (!dev) {
cache.put("server:APIKey", key);
}
serve({ fetch: honoApp.fetch, port: port });
// Send API info to renderer
settingsWindow?.webContents.send("api-info", {
port,
apiKey: key
});
console.log(`App server running on port ${port}`);
});
});
initDatabase().then((db) => {
scheduler.addTask("screenshot", takeScreenshot, 2000);
scheduler.addTask("check-encoding", checkFramesForEncoding, 5000);
scheduler.addTask("process-encoding", processEncodingTasks, 10000, "LOW_POWER");
scheduler.addTask("delete-screenshots", deleteUnnecessaryScreenshots, 20000);
dbConnection = db;
cache.put("server:dbConnection", dbConnection);
});
mainWindow = createMainWindow(port, () => (mainWindow = null));
settingsWindow = createSettingsWindow(port, () => (settingsWindow = null));
globalShortcut.register("Escape", () => {
if (!mainWindow) return;
if (!mainWindow || !mainWindow.isVisible()) return;
mainWindow.hide();
});
});
app.on("window-all-closed", () => {
if (process.platform !== "darwin") app.quit();
app.on("will-quit", () => {
dbConnection?.close();
scheduler.stop();
});
ipcMain.on("close-settings", () => {
settingsWindow?.hide();
});
ipcMain.handle("request-api-info", () => {
return {
port: cache.get("server:port"),
apiKey: cache.get("server:APIKey")
};
});

View File

@ -1,52 +1,52 @@
const os = require('node:os');
const os = require("node:os");
const nameMap = new Map([
[24, ['Sequoia', '15']],
[23, ['Sonoma', '14']],
[22, ['Ventura', '13']],
[21, ['Monterey', '12']],
[20, ['Big Sur', '11']],
[19, ['Catalina', '10.15']],
[18, ['Mojave', '10.14']],
[17, ['High Sierra', '10.13']],
[16, ['Sierra', '10.12']],
[15, ['El Capitan', '10.11']],
[14, ['Yosemite', '10.10']],
[13, ['Mavericks', '10.9']],
[12, ['Mountain Lion', '10.8']],
[11, ['Lion', '10.7']],
[10, ['Snow Leopard', '10.6']],
[9, ['Leopard', '10.5']],
[8, ['Tiger', '10.4']],
[7, ['Panther', '10.3']],
[6, ['Jaguar', '10.2']],
[5, ['Puma', '10.1']],
[24, ["Sequoia", "15"]],
[23, ["Sonoma", "14"]],
[22, ["Ventura", "13"]],
[21, ["Monterey", "12"]],
[20, ["Big Sur", "11"]],
[19, ["Catalina", "10.15"]],
[18, ["Mojave", "10.14"]],
[17, ["High Sierra", "10.13"]],
[16, ["Sierra", "10.12"]],
[15, ["El Capitan", "10.11"]],
[14, ["Yosemite", "10.10"]],
[13, ["Mavericks", "10.9"]],
[12, ["Mountain Lion", "10.8"]],
[11, ["Lion", "10.7"]],
[10, ["Snow Leopard", "10.6"]],
[9, ["Leopard", "10.5"]],
[8, ["Tiger", "10.4"]],
[7, ["Panther", "10.3"]],
[6, ["Jaguar", "10.2"]],
[5, ["Puma", "10.1"]]
]);
const names = new Map([
['10.0.2', '11'], // It's unclear whether future Windows 11 versions will use this version scheme: https://github.com/sindresorhus/windows-release/pull/26/files#r744945281
['10.0', '10'],
['6.3', '8.1'],
['6.2', '8'],
['6.1', '7'],
['6.0', 'Vista'],
['5.2', 'Server 2003'],
['5.1', 'XP'],
['5.0', '2000'],
['4.90', 'ME'],
['4.10', '98'],
['4.03', '95'],
['4.00', '95'],
["10.0.2", "11"], // It's unclear whether future Windows 11 versions will use this version scheme: https://github.com/sindresorhus/windows-release/pull/26/files#r744945281
["10.0", "10"],
["6.3", "8.1"],
["6.2", "8"],
["6.1", "7"],
["6.0", "Vista"],
["5.2", "Server 2003"],
["5.1", "XP"],
["5.0", "2000"],
["4.90", "ME"],
["4.10", "98"],
["4.03", "95"],
["4.00", "95"]
]);
function macosRelease(release) {
release = Number((release || os.release()).split('.')[0]);
release = Number((release || os.release()).split(".")[0]);
const [name, version] = nameMap.get(release) || ['Unknown', ''];
const [name, version] = nameMap.get(release) || ["Unknown", ""];
return {
name,
version,
version
};
}
@ -54,14 +54,14 @@ function windowsRelease(release) {
const version = /(\d+\.\d+)(?:\.(\d+))?/.exec(release || os.release());
if (release && !version) {
throw new Error('`release` argument doesn\'t match `n.n`');
throw new Error("`release` argument doesn't match `n.n`");
}
let ver = version[1] || '';
const build = version[2] || '';
let ver = version[1] || "";
const build = version[2] || "";
if (ver === '10.0' && build.startsWith('2')) {
ver = '10.0.2';
if (ver === "10.0" && build.startsWith("2")) {
ver = "10.0.2";
}
return names.get(ver);
@ -69,47 +69,47 @@ function windowsRelease(release) {
function osName(platform, release) {
if (!platform && release) {
throw new Error('You can\'t specify a `release` without specifying `platform`');
throw new Error("You can't specify a `release` without specifying `platform`");
}
platform = platform ?? os.platform();
let id;
if (platform === 'darwin') {
if (!release && os.platform() === 'darwin') {
if (platform === "darwin") {
if (!release && os.platform() === "darwin") {
release = os.release();
}
const prefix = release ? (Number(release.split('.')[0]) > 15 ? 'macOS' : 'OS X') : 'macOS';
const prefix = release ? (Number(release.split(".")[0]) > 15 ? "macOS" : "OS X") : "macOS";
try {
id = release ? macosRelease(release).name : '';
id = release ? macosRelease(release).name : "";
if (id === 'Unknown') {
if (id === "Unknown") {
return prefix;
}
} catch {}
return prefix + (id ? ' ' + id : '');
return prefix + (id ? " " + id : "");
}
if (platform === 'linux') {
if (!release && os.platform() === 'linux') {
if (platform === "linux") {
if (!release && os.platform() === "linux") {
release = os.release();
}
id = release ? release.replace(/^(\d+\.\d+).*/, '$1') : '';
return 'Linux' + (id ? ' ' + id : '');
id = release ? release.replace(/^(\d+\.\d+).*/, "$1") : "";
return "Linux" + (id ? " " + id : "");
}
if (platform === 'win32') {
if (!release && os.platform() === 'win32') {
if (platform === "win32") {
if (!release && os.platform() === "win32") {
release = os.release();
}
id = release ? windowsRelease(release) : '';
return 'Windows' + (id ? ' ' + id : '');
id = release ? windowsRelease(release) : "";
return "Windows" + (id ? " " + id : "");
}
return platform;

View File

@ -1,20 +1,5 @@
const { contextBridge, ipcRenderer } = require("electron");
// Expose protected methods that allow the renderer process to use
// the ipcRenderer without exposing the entire object
contextBridge.exposeInMainWorld("api", {
send: (channel, data) => {
// whitelist channels
let validChannels = ["toMain"];
if (validChannels.includes(channel)) {
ipcRenderer.send(channel, data);
}
},
receive: (channel, func) => {
let validChannels = ["fromMain"];
if (validChannels.includes(channel)) {
// Deliberately strip event as it includes `sender`
ipcRenderer.on(channel, (event, ...args) => func(...args));
}
}
contextBridge.exposeInMainWorld("appGlobal", {
requestApiInfo: () => ipcRenderer.invoke("request-api-info")
});

View File

@ -1,8 +1,8 @@
const { contextBridge } = require('electron')
const os = require('os');
const osName = require('./os-name.cjs');
const { contextBridge, ipcRenderer } = require("electron");
const os = require("os");
const osName = require("./os-name.cjs");
contextBridge.exposeInMainWorld('versions', {
contextBridge.exposeInMainWorld("versions", {
node: () => process.versions.node,
chrome: () => process.versions.chrome,
electron: () => process.versions.electron,
@ -10,4 +10,14 @@ contextBridge.exposeInMainWorld('versions', {
return `${os.platform()} ${os.release()}`;
},
osDisplay: osName
})
});
contextBridge.exposeInMainWorld("settingsWindow", {
close: () => {
ipcRenderer.send("close-settings", {});
}
});
contextBridge.exposeInMainWorld("appGlobal", {
requestApiInfo: () => ipcRenderer.invoke("request-api-info")
});

View File

@ -0,0 +1,147 @@
import { Hono } from "hono";
import { cors } from "hono/cors";
import cache from "memory-cache";
import { join } from "path";
import fs from "fs";
import { Database } from "better-sqlite3";
import type { Frame } from "../backend/schema";
import {
getDecodingTempDir,
getRecordingsDir,
getScreenshotsDir,
waitForFileExists
} from "../utils/index.js";
import { immediatelyExtractFrameFromVideo } from "../utils/index.js";
import { existsSync } from "fs";
const app = new Hono();
app.use("*", cors());
app.use(async (c, next) => {
const key = cache.get("server:APIKey");
if (key && c.req.header("x-api-key") !== key) {
c.res = undefined;
c.res = c.json({ error: "Invalid API key" }, 401);
}
await next();
});
app.get("/ping", (c) => c.text("pong"));
function getLatestFrames(db: Database, limit = 50): Frame[] {
return db
.prepare(
`
SELECT id, createdAt, imgFilename, videoPath, videoFrameIndex
FROM frame
ORDER BY createdAt DESC
LIMIT ?
`
)
.all(limit) as Frame[];
}
function getFramesUntilID(db: Database, untilID: number, limit = 50): Frame[] {
return db
.prepare(
`
SELECT id, createdAt, imgFilename, videoPath, videoFrameIndex
FROM frame
WHERE id < ?
ORDER BY createdAt DESC
LIMIT ?
`
)
.all(untilID, limit) as Frame[];
}
app.get("/timeline", async (c) => {
const query = c.req.query();
const limit = parseInt(query.limit) || undefined;
const db = cache.get("server:dbConnection");
if (query.untilID) {
return c.json(getFramesUntilID(db, parseInt(query.untilID), limit));
} else {
return c.json(getLatestFrames(db, limit));
}
});
app.get("/frame/:id", async (c) => {
const { id } = c.req.param();
const db: Database = cache.get("server:dbConnection");
const frame = db
.prepare(
`
SELECT imgFilename, videoPath, videoFrameIndex, createdAt
FROM frame
WHERE id = ?
`
)
.get(id) as Frame | undefined;
if (!frame) return c.json({ error: "Frame not found" }, 404);
const decodingTempDir = getDecodingTempDir();
const screenshotsDir = getScreenshotsDir();
const videoFilename = frame.videoPath;
const frameIndex = frame.videoFrameIndex;
const imageFilename = frame.imgFilename;
const bareVideoFilename = videoFilename?.replace(".mp4", "") || null;
const decodedImage = frameIndex
? `${bareVideoFilename}_${frameIndex.toString().padStart(4, "0")}.bmp`
: null;
let returnImagePath = "";
let needToBeDecoded = videoFilename !== null && frameIndex !== null && !frame.imgFilename;
if (decodedImage && fs.existsSync(join(getDecodingTempDir(), decodedImage))) {
needToBeDecoded = false;
returnImagePath = join(decodingTempDir, decodedImage);
} else if (imageFilename && fs.existsSync(join(screenshotsDir, imageFilename))) {
returnImagePath = join(screenshotsDir, imageFilename);
}
if (needToBeDecoded) {
const videoExists = fs.existsSync(join(getRecordingsDir(), videoFilename!));
if (!videoExists) {
return c.json({ error: "Video not found" }, { status: 404 });
}
const decodedFilename = immediatelyExtractFrameFromVideo(
videoFilename!,
frameIndex!,
decodingTempDir
);
const decodedPath = join(decodingTempDir, decodedFilename);
await waitForFileExists(decodedPath);
if (existsSync(decodedPath)) {
const imageBuffer = fs.readFileSync(decodedPath);
setTimeout(() => {
fs.unlinkSync(decodedPath);
}, 1000);
return new Response(imageBuffer, {
status: 200,
headers: {
"Content-Type": "image/bmp"
}
});
} else {
return c.json({ error: "Frame cannot be decoded" }, { status: 500 });
}
} else {
const imageBuffer = fs.readFileSync(returnImagePath);
const imageMimeType = imageFilename?.endsWith(".png") ? "image/png" : "image/jpeg";
return new Response(imageBuffer, {
status: 200,
headers: {
"Content-Type": imageMimeType
}
});
}
});
export default app;

View File

@ -1,35 +0,0 @@
import path from "path";
import { fileURLToPath } from "url";
import { exec } from "child_process";
export const __dirname = path.dirname(fileURLToPath(import.meta.url));
export function getFirstCaptureScreenDeviceId(ffmpegPath: string): Promise<string | null> {
return new Promise((resolve, reject) => {
exec(`${ffmpegPath} -f avfoundation -list_devices true -i ""`, (error, stdout, stderr) => {
// stderr contains the output we need to parse
const output = stderr;
const captureScreenRegex = /\[(\d+)]\s+Capture screen \d+/g;
const match = captureScreenRegex.exec(output);
if (match) {
resolve(match[1]);
} else {
resolve(null);
}
});
});
}
export function captureScreen(ffmpegPath: string ,deviceId: string, outputPath: string): Promise<void> {
return new Promise((resolve, reject) => {
exec(`${ffmpegPath} -f avfoundation -pixel_format uyvy422 -i ${deviceId} -y -frames:v 1 ${outputPath}`,
(error, _stdout, _stderr) => {
if (error) {
reject(error);
} else {
resolve();
}
});
});
}

View File

@ -0,0 +1,6 @@
import { Database } from "better-sqlite3";
import cache from "memory-cache";
export function getDatabase(): Database {
return cache.get("server:dbConnection");
}

View File

@ -0,0 +1,111 @@
import path from "path";
import fs from "fs";
import { getUserDataDir } from "../platform/index.js";
import { __dirname } from "../../dirname.js";
export function createDataDir() {
const dataDir = getUserDataDir();
if (!fs.existsSync(dataDir)) {
fs.mkdirSync(dataDir, { recursive: true });
}
return dataDir;
}
export function createTempDir() {
const tempDir = path.join(getUserDataDir(), "temp");
if (!fs.existsSync(tempDir)) {
fs.mkdirSync(tempDir, { recursive: true });
}
return tempDir;
}
export function getDatabaseDir() {
const dataDir = createDataDir();
return path.join(dataDir, "main.db");
}
export function getScreenshotsDir() {
const tempDir = createTempDir();
const screenshotsDir = path.join(tempDir, "screenshots");
if (!fs.existsSync(screenshotsDir)) {
fs.mkdirSync(screenshotsDir, { recursive: true });
}
return screenshotsDir;
}
export function getRecordingsDir() {
const dataDir = createDataDir();
const recordingsDir = path.join(dataDir, "recordings");
if (!fs.existsSync(recordingsDir)) {
fs.mkdirSync(recordingsDir, { recursive: true });
}
return path.join(dataDir, "recordings");
}
export function getEncodingTempDir() {
const tempDir = createTempDir();
const encodingTempDir = path.join(tempDir, "encoding");
if (!fs.existsSync(encodingTempDir)) {
fs.mkdirSync(encodingTempDir, { recursive: true });
}
return encodingTempDir;
}
export function getDecodingTempDir() {
const tempDir = createTempDir();
const decodingTempDir = path.join(tempDir, "decoding");
if (!fs.existsSync(decodingTempDir)) {
fs.mkdirSync(decodingTempDir, { recursive: true });
}
return decodingTempDir;
}
export function getLogDir() {
const dataDir = createDataDir();
const logDir = path.join(dataDir, "logs");
if (!fs.existsSync(logDir)) {
fs.mkdirSync(logDir, { recursive: true });
}
return logDir;
}
export function getBinDir() {
return path.join(__dirname, "bin");
}
export async function waitForFileExists(filePath: string, timeout: number = 10000): Promise<void> {
return new Promise((resolve, reject) => {
fs.access(filePath, fs.constants.F_OK, (err) => {
if (!err) {
resolve();
return;
}
const dir = path.dirname(filePath);
const filename = path.basename(filePath);
const watcher = fs.watch(dir, (eventType, watchedFilename) => {
if (eventType === "rename" && watchedFilename === filename) {
fs.access(filePath, fs.constants.F_OK, (err) => {
if (!err) {
clearTimeout(timeoutId);
watcher.close();
resolve();
}
});
}
});
watcher.on("error", (err) => {
clearTimeout(timeoutId);
watcher.close();
reject(err);
});
const timeoutId = setTimeout(() => {
watcher.close();
reject(new Error(`Timeout: File ${filePath} did not exist within ${timeout}ms`));
}, timeout);
});
});
}

View File

@ -0,0 +1,6 @@
export * from "./fs/index.js";
export * from "./platform/index.js";
export * from "./video/index.js";
export * from "./network/index.js";
export * from "./logging/index.js";
export * from "./backend/index.js";

View File

@ -0,0 +1,10 @@
import pino from "pino";
import { join } from "path";
import { getLogDir } from "../fs/index.js";
const logPath = join(getLogDir(), "log.json");
const dest = pino.destination(logPath);
const logger = pino(dest);
export { logger };

View File

@ -0,0 +1,17 @@
import { detect } from "detect-port";
/**
* Finds an available port starting from a given port.
* @param startingFrom - The port number to start searching from.
* @returns A Promise that resolves to the first available port number.
*/
export async function findAvailablePort(startingFrom: number): Promise<number> {
return detect(startingFrom)
.then((realPort) => {
return realPort; // Return the available port
})
.catch((err) => {
console.error(`Error detecting port: ${err.message}`);
throw err; // Rethrow the error for further handling if needed
});
}

View File

@ -0,0 +1,60 @@
import { join } from "path";
import os from "os";
import { app } from "electron";
import { getBinDir, logger } from "../index.js";
export function getUserDataDir() {
switch (process.platform) {
case "win32":
return join(process.env.APPDATA!, "OpenRewind", "Record Data");
case "darwin":
return join(
os.homedir(),
"Library",
"Application Support",
"OpenRewind",
"Record Data"
);
case "linux":
return join(os.homedir(), ".config", "OpenRewind", "Record Data");
default:
throw new Error("Unsupported platform");
}
}
export function hideDock() {
if (process.platform === "darwin") {
// Hide the dock icon on macOS
app.dock.hide();
}
}
export function showDock() {
if (process.platform === "darwin") {
// Show the dock icon on macOS
app.dock.show();
}
}
export function getFFmpegPath() {
let path = "";
switch (process.platform) {
case "win32":
path = join(getBinDir(), "ffmpeg.exe");
break;
case "darwin":
path = join(getBinDir(), "ffmpeg");
break;
case "linux":
path = join(getBinDir(), "ffmpeg");
break;
default:
throw new Error("Unsupported platform");
}
logger.info("FFmpeg path: %s", path);
return path;
}
export function getOCRitPath() {
const path = join(getBinDir(), "ocrit");
}

View File

@ -0,0 +1,81 @@
import { join } from "path";
import { spawn, execSync } from "child_process";
import { getRecordingsDir } from "../fs/index.js";
import { getFFmpegPath } from "../platform/index.js";
import { ENCODING_FRAME_RATE } from "../../backend/consts.js";
import cache from "memory-cache";
function getBestCodec() {
const cachedCodec = cache.get("backend:bestCodec");
if (cachedCodec) {
return cachedCodec;
}
const codecs = execSync(`${getFFmpegPath()} -codecs`).toString("utf-8");
let codec = "";
if (codecs.includes("h264_videotoolbox")) {
codec = "h264_videotoolbox";
} else {
codec = "libx264";
}
cache.put("backend:bestCodec", codec);
return codec;
}
export function getEncodeCommand(metaFilePath: string, videoPath: string) {
const codec = getBestCodec();
return `${getFFmpegPath()} -f concat -safe 0 -i "${metaFilePath}" -c:v ${codec} -r ${ENCODING_FRAME_RATE} -y -threads 1 "${videoPath}"`;
}
export function immediatelyExtractFrameFromVideo(
videoFilename: string,
frameIndex: number,
outputPath = "."
) {
const bareVideoFilename = videoFilename.split(".").slice(0, -1).join(".");
const fullVideoPath = join(getRecordingsDir(), videoFilename);
const outputFilename = `${bareVideoFilename}_${frameIndex.toString().padStart(4, "0")}.bmp`;
const outputPathArg = join(outputPath, outputFilename);
const args = [
"-ss",
`${formatTime(frameIndex / ENCODING_FRAME_RATE)}`,
"-i",
`${fullVideoPath}`,
"-vframes",
"1",
`${outputPathArg}`
];
const ffmpeg = spawn(getFFmpegPath(), args);
ffmpeg.stdout.on("data", (data) => {
console.log(data.toString());
});
ffmpeg.stderr.on("data", (data) => {
console.log(data.toString());
});
ffmpeg.on("exit", (code) => {
if (code !== 0) {
console.error("Error extracting frame:", code);
}
});
return outputFilename;
}
function formatTime(seconds: number): string {
// Calculate hours, minutes, seconds, and milliseconds
const hours = Math.floor(seconds / 3600);
const minutes = Math.floor((seconds % 3600) / 60);
const secs = Math.floor(seconds % 60);
const milliseconds = Math.round((seconds % 1) * 1000);
// Format the output with leading zeros
const formattedTime =
[
String(hours).padStart(2, "0"),
String(minutes).padStart(2, "0"),
String(secs).padStart(2, "0")
].join(":") +
"." +
String(milliseconds).padStart(3, "0");
return formattedTime;
}

13
src/global.d.ts vendored
View File

@ -7,10 +7,9 @@ interface Window {
osDisplay: () => string;
};
electron: {
getScreenshot: () => Promise<string>;
}
api: {
send: (channel: any, data: any) => void,
receive: (channel: any, func: any) => void
}
}
getScreenshot: () => Promise<string>;
};
settingsWindow: {
close: () => void;
};
}

View File

@ -1,3 +1,3 @@
#title-bar {
-webkit-app-region: drag;
}
-webkit-app-region: drag;
}

View File

@ -2,9 +2,39 @@ import { HashRouter, Routes, Route } from "react-router-dom";
import SettingsPage from "pages/settings";
import "./i18n.ts";
import RewindPage from "pages/rewind";
import './app.css';
import "./app.css";
import { useEffect } from "react";
import { useAtom } from "jotai";
import { apiInfoAtom } from "./state/apiInfo.ts";
declare global {
interface Window {
appGlobal: {
requestApiInfo: () => Promise<{ port: number; apiKey: string }>;
};
}
}
export function App() {
const [apiInfo, setApiInfo] = useAtom(apiInfoAtom);
useEffect(() => {
const fetchApiInfo = async () => {
try {
const info = await window.appGlobal.requestApiInfo();
setApiInfo(info);
} catch (error) {
console.error("Failed to fetch API info:", error);
}
};
fetchApiInfo();
}, [setApiInfo]);
if (!apiInfo) {
return null;
}
return (
<div className="w-screen h-screen">
<HashRouter>

View File

@ -38,7 +38,7 @@ i18n.use(initReactI18next) // passes i18n down to react-i18next
},
ko: {
translation: ko
},
}
},
fallbackLng: "en",

View File

@ -3,5 +3,5 @@
@tailwind utilities;
body {
@apply bg-transparent;
}
@apply bg-transparent;
}

View File

@ -1,11 +1,11 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<div id="root"></div>
<script type="module" src="./main.tsx"></script>
</body>
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<div id="root"></div>
<script type="module" src="./main.tsx"></script>
</body>
</html>

View File

@ -6,7 +6,7 @@ import "./index.css";
const app = createRoot(document.getElementById("root")!);
app.render(
<StrictMode>
<App />
</StrictMode>
<StrictMode>
<App />
</StrictMode>
);

View File

@ -0,0 +1,6 @@
import { atom } from 'jotai'
export const apiInfoAtom = atom({
port: -1,
apiKey: ''
})

View File

@ -4,7 +4,7 @@ const config: Config = {
content: [
"./pages/**/*.{js,ts,jsx,tsx,mdx}",
"./components/**/*.{js,ts,jsx,tsx,mdx}",
"./src/**/*.{js,ts,jsx,tsx,mdx}",
"./src/**/*.{js,ts,jsx,tsx,mdx}"
],
theme: {
extend: {

View File

@ -1,35 +1,35 @@
{
"compilerOptions": {
"baseUrl": ".",
"composite": true,
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
"target": "ES2020",
"useDefineForClassFields": true,
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"module": "ESNext",
"skipLibCheck": true,
"compilerOptions": {
"baseUrl": ".",
"composite": true,
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
"target": "ES2020",
"useDefineForClassFields": true,
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"module": "ESNext",
"skipLibCheck": true,
/* Bundler mode */
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"emitDeclarationOnly": true,
"resolveJsonModule": true,
"isolatedModules": true,
"moduleDetection": "force",
"jsx": "react-jsx",
/* Bundler mode */
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"emitDeclarationOnly": true,
"resolveJsonModule": true,
"isolatedModules": true,
"moduleDetection": "force",
"jsx": "react-jsx",
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true
},
"include": [
"src/renderer",
"src/renderer/**/*.ts",
"src/renderer/**/*.tsx",
"src/global.d.ts",
"pages/**/*.tsx",
"components/**/*.tsx"
],
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true
},
"include": [
"src/renderer",
"src/renderer/**/*.ts",
"src/renderer/**/*.tsx",
"src/global.d.ts",
"pages/**/*.tsx",
"components/**/*.tsx"
]
}

View File

@ -1,18 +1,15 @@
{
"compilerOptions": {
"target": "ESNext",
"module": "ESNext",
"moduleResolution": "node",
"outDir": "./dist/dev",
"rootDir": "./src/electron",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
},
"include": ["src/electron"],
"references": [
{ "path": "./tsconfig.app.json"},
{ "path": "./tsconfig.node.json"}
]
"compilerOptions": {
"target": "ESNext",
"module": "ESNext",
"moduleResolution": "bundler",
"outDir": "./dist/electron",
"rootDir": "./src/electron",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
},
"include": ["src/electron"],
"references": [{ "path": "./tsconfig.app.json" }, { "path": "./tsconfig.node.json" }]
}

View File

@ -1,25 +1,23 @@
{
"compilerOptions": {
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
"target": "ES2022",
"lib": ["ES2023"],
"module": "ESNext",
"skipLibCheck": true,
"composite": true,
"compilerOptions": {
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
"target": "ES2022",
"lib": ["ES2023"],
"module": "ESNext",
"skipLibCheck": true,
"composite": true,
/* Bundler mode */
"moduleResolution": "Bundler",
"isolatedModules": true,
"moduleDetection": "force",
/* Bundler mode */
"moduleResolution": "Bundler",
"isolatedModules": true,
"moduleDetection": "force",
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true,
"noUncheckedSideEffectImports": true
},
"include": [
"vite.config.ts"
]
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true,
"noUncheckedSideEffectImports": true
},
"include": ["vite.config.ts"]
}

View File

@ -19,10 +19,10 @@ export default defineConfig({
customChunk: (args) => {
// files into pages directory is export in single files
const { id } = args;
if (id.includes('node_modules')) {
return 'vendor';
if (id.includes("node_modules")) {
return "vendor";
} else {
return 'main';
return "main";
}
}
})