├── LICENSE
├── README.md
├── media_converter
├── __init__.py
├── bulkconvert.py
├── common.py
├── config.json
├── config.md
├── config.py
├── consts.py
├── dialogs
│ ├── __init__.py
│ ├── bulk_convert_dialog.py
│ ├── bulk_convert_result_dialog.py
│ ├── main_settings_dialog.py
│ ├── paste_image_dialog.py
│ └── settings_dialog_base.py
├── events.py
├── file_converters
│ ├── __init__.py
│ ├── audio_converter.py
│ ├── common.py
│ ├── convert_result.py
│ ├── file_converter.py
│ ├── image_converter.py
│ ├── internal_file_converter.py
│ ├── on_add_note_converter.py
│ └── on_paste_converter.py
├── icons
│ ├── edit.svg
│ └── webp.png
├── media_rename.py
├── menus.py
├── support
│ └── .ensure_dir
├── utils
│ ├── __init__.py
│ ├── converter_interfaces.py
│ ├── file_paths_factory.py
│ ├── mime_helper.py
│ ├── show_options.py
│ └── temp_file.py
└── widgets
│ ├── __init__.py
│ ├── audio_settings_widget.py
│ ├── audio_slider_box.py
│ ├── behavior_settings_widget.py
│ ├── bulk_convert_settings_widget.py
│ ├── image_settings_widget.py
│ ├── image_slider_box.py
│ ├── presets_editor.py
│ ├── rich_slider.py
│ └── scale_settings_widget.py
├── playground
├── no_anki_config.py
├── run_bulk_convert_dialog.py
├── run_bulk_convert_result.py
├── run_main_settings_dialog.py
└── run_paste_image_dialog.py
├── pyproject.toml
└── scripts
├── format.sh
├── libwebp-dl.sh
└── package.sh
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # AJT Media Converter
2 |
3 | [](https://ankiweb.net/shared/info/1151815987)
4 | 
5 | [](https://www.patreon.com/tatsumoto_ren)
6 | [](https://tatsumoto-ren.github.io/blog/join-our-community.html)
7 |
8 | > An Anki add-on that makes your images small.
9 |
10 |
11 |
12 |
13 |
14 | We all know that people who don't store their images in
15 | [WebP](https://developers.google.com/speed/webp)
16 | or [AVIF](https://aomediacodec.github.io/av1-avif/)
17 | are wasting a lot of disk space.
18 | Not only on their hard drives, but on AnkiWeb as well.
19 | Unfortunately, Anki doesn't convert images to WebP when you paste them from elsewhere,
20 | and it takes time to convert and resize images manually.
21 |
22 | For the longest time I used a bash script
23 | to automatically convert images in my Anki collection to WebP
24 | until I decided that we simply need an add-on for this.
25 |
26 | > WebP lossy images are 25-34% smaller than comparable JPEG images at equivalent SSIM quality index.
27 |
28 | Storing images in WebP is a great way to reduce the size of your Anki collection.
29 |
30 | ## Installation
31 |
32 | Install from [AnkiWeb](https://ankiweb.net/shared/info/1151815987), or manually with `git`:
33 |
34 | ```
35 | $ git clone 'https://github.com/Ajatt-Tools/PasteImagesAsWebP.git' ~/.local/share/Anki2/addons21/PasteImagesAsWebP
36 | ```
37 |
38 | Don't forget to initialize `git` submodules.
39 |
40 | ### WebP images
41 |
42 | The add-on expects `cwebp` executable to be added to PATH.
43 | On Arch Linux, `cwebp` is a part of `libwebp`.
44 |
45 | ```
46 | $ sudo pacman -S libwebp
47 | ```
48 |
49 | On Debian/Ubuntu:
50 |
51 | ```
52 | $ sudo apt install webp
53 | ```
54 |
55 | On macOS:
56 | ```
57 | $ brew install webp
58 | ```
59 |
60 | Or download it from [google.com](https://developers.google.com/speed/webp/download)
61 | and save the `cwebp` executable in `~/.local/share/Anki2/addons21/PasteImagesAsWebP/support/`.
62 | `cwebp` comes included in the AnkiWeb package.
63 |
64 | ### AVIF images
65 |
66 | To convert images to [AVIF](https://aomediacodec.github.io/av1-avif/),
67 | The add-on expects [FFmpeg](https://wiki.archlinux.org/title/FFmpeg) executable to be added to PATH.
68 | On Arch Linux, Install the `ffmpeg` package.
69 |
70 | ```
71 | sudo pacman -S ffmpeg
72 | ```
73 |
74 | ## Configuration
75 |
76 | To configure the add-on select "AJT" > "WebP settings" from the top menu bar.
77 | To view hidden settings open the Anki Add-on Menu
78 | via "Tools" > "Add-ons" and select "AJT Media Converter".
79 | Then click the Config button on the right-side of the screen.
80 |
81 | ## Usage
82 |
83 | Watch video demonstration:
84 |
85 |
86 |
87 | After installation images will be automatically converted to `WebP` and resized on pasting or drag-and-dropping.
88 | There's also a button in the Editor toolbar that lets you do the same.
89 |
90 | To bulk-convert existing images in your collection, select `Edit` > `Bulk-convert to WebP` in the card browser.
91 |
92 | To rename media files on a particular note,
93 | open the Anki Browser, select the note and click on the pencil icon on the toolbar.
94 | A dialog will pop up asking you to enter new filenames.
95 |
96 | ## Contributions
97 |
98 | If you've found a bug or want to extend the add-on, please let us know in the
99 | [Matrix chat](https://tatsumoto-ren.github.io/blog/join-our-community.html).
100 | I'm open to suggestions and pull requests.
101 |
102 | My special thanks to all my
103 | [Patreon](https://www.patreon.com/tatsumoto_ren)
104 | supporters for making this project possible.
105 |
--------------------------------------------------------------------------------
/media_converter/__init__.py:
--------------------------------------------------------------------------------
1 | # Copyright: Ajatt-Tools and contributors; https://github.com/Ajatt-Tools
2 | # License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
3 |
4 | import sys
5 |
6 | from aqt import mw
7 |
8 |
9 | def start_addon() -> None:
10 | from . import bulkconvert, events, media_rename, menus
11 |
12 | bulkconvert.init()
13 | menus.init()
14 | events.init()
15 | media_rename.init()
16 |
17 |
18 | if mw and "pytest" not in sys.modules:
19 | start_addon()
20 |
--------------------------------------------------------------------------------
/media_converter/bulkconvert.py:
--------------------------------------------------------------------------------
1 | # Copyright: Ajatt-Tools and contributors; https://github.com/Ajatt-Tools
2 | # License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
3 |
4 | import collections
5 | import functools
6 | from collections.abc import Iterable, Sequence
7 | from typing import cast
8 |
9 | from anki.collection import Collection
10 | from anki.notes import Note, NoteId
11 | from anki.utils import join_fields
12 | from aqt import gui_hooks, mw
13 | from aqt.browser import Browser
14 | from aqt.operations import CollectionOp, ResultWithChanges
15 | from aqt.qt import *
16 |
17 | from .common import find_convertible_audio, find_convertible_images, tooltip
18 | from .config import config
19 | from .consts import ADDON_FULL_NAME, ADDON_NAME_SNAKE
20 | from .dialogs.bulk_convert_dialog import AnkiBulkConvertDialog
21 | from .dialogs.bulk_convert_result_dialog import BulkConvertResultDialog
22 | from .dialogs.settings_dialog_base import AnkiSaveAndRestoreGeomDialog
23 | from .file_converters.common import LocalFile
24 | from .file_converters.convert_result import ConvertResult
25 | from .file_converters.internal_file_converter import InternalFileConverter
26 |
27 | ACTION_NAME = f"{ADDON_FULL_NAME}: Bulk-convert"
28 |
29 |
30 | class ConvertTask:
31 | _browser: Browser
32 | _selected_fields: list[str]
33 | _result: ConvertResult
34 | _to_convert: dict[LocalFile, dict[NoteId, Note]]
35 |
36 | def __init__(self, browser: Browser, note_ids: Sequence[NoteId], selected_fields: list[str]):
37 | self._browser = browser
38 | self._selected_fields = selected_fields
39 | self._result = ConvertResult()
40 | self._to_convert = self._find_files_to_convert_and_notes(note_ids)
41 |
42 | @property
43 | def size(self) -> int:
44 | return len(self._to_convert)
45 |
46 | def __call__(self):
47 | if self._result.is_dirty():
48 | raise RuntimeError("Already converted.")
49 | for progress_idx, file in enumerate(self._to_convert):
50 | yield progress_idx
51 | try:
52 | converted_filename = self._convert_stored_file(file)
53 | except (OSError, RuntimeError, FileNotFoundError) as ex:
54 | self._result.add_failed(file, exception=ex)
55 | else:
56 | self._result.add_converted(file, converted_filename)
57 |
58 | def update_notes(self):
59 | def show_report_message() -> int:
60 | dialog = BulkConvertResultDialog(self._browser)
61 | dialog.set_result(self._result)
62 | return dialog.exec()
63 |
64 | def on_finish() -> None:
65 | assert self._browser.editor
66 | show_report_message()
67 | self._browser.editor.loadNoteKeepingFocus()
68 |
69 | if self._result.is_dirty():
70 | if not self._result.converted:
71 | return show_report_message()
72 | CollectionOp(parent=self._browser, op=lambda col: self._update_notes_op(col)).success(
73 | lambda out: on_finish()
74 | ).run_in_background()
75 |
76 | def _first_referenced(self, file: LocalFile) -> Note:
77 | return next(note for note in self._to_convert[file].values())
78 |
79 | def _keys_to_update(self, note: Note) -> Iterable[str]:
80 | if not self._selected_fields:
81 | return note.keys()
82 | else:
83 | return set(note.keys()).intersection(self._selected_fields)
84 |
85 | def _find_files_to_convert_and_notes(self, note_ids: Sequence[NoteId]) -> dict[LocalFile, dict[NoteId, Note]]:
86 | """
87 | Maps each filename to a set of note ids that reference the filename.
88 | """
89 | assert mw
90 | to_convert: dict[LocalFile, dict[NoteId, Note]] = collections.defaultdict(dict)
91 |
92 | for note in map(mw.col.get_note, note_ids):
93 | note_content = join_fields([note[field] for field in self._keys_to_update(note)])
94 | if " str:
106 | conv = InternalFileConverter(self._browser.editor, file, self._first_referenced(file))
107 | conv.convert_internal()
108 | return conv.new_filename
109 |
110 | def _update_notes_op(self, col: Collection) -> ResultWithChanges:
111 | pos = col.add_custom_undo_entry(f"Convert {len(self._result.converted)} images to WebP")
112 | to_update: dict[NoteId, Note] = {}
113 |
114 | for old_file, converted_filename in self._result.converted.items():
115 | for note in self._to_convert[old_file].values():
116 | for field_name in self._keys_to_update(note):
117 | note[field_name] = note[field_name].replace(old_file.file_name, converted_filename)
118 | to_update[note.id] = note
119 |
120 | col.update_notes(list(to_update.values()))
121 | return col.merge_undo_entries(pos)
122 |
123 |
124 | class ConvertSignals(QObject):
125 | canceled = pyqtSignal()
126 | task_done = pyqtSignal()
127 | update_progress = pyqtSignal(int)
128 |
129 |
130 | class ConvertRunnable(QRunnable):
131 | canceled: bool
132 |
133 | def __init__(self, task: ConvertTask, signals: ConvertSignals):
134 | super().__init__()
135 | self.canceled = False
136 | self.task = task
137 | self.signals = signals
138 | qconnect(self.signals.canceled, self.set_canceled)
139 |
140 | def set_canceled(self):
141 | self.canceled = True
142 |
143 | def run(self):
144 | for progress_value in self.task():
145 | if self.canceled:
146 | break
147 | self.signals.update_progress.emit(progress_value) # type: ignore
148 | self.signals.task_done.emit() # type: ignore
149 |
150 |
151 | class ProgressBar(AnkiSaveAndRestoreGeomDialog):
152 | name: str = f"ajt__{ADDON_NAME_SNAKE}_convert_progress_bar"
153 | task: ConvertTask
154 |
155 | def __init__(self, task: ConvertTask, parent=None) -> None:
156 | super().__init__(parent)
157 | self.bar = QProgressBar()
158 | self.cancel_button = QPushButton("Cancel")
159 | self.setLayout(self.setup_layout())
160 | self.task = task
161 | self.signals = ConvertSignals()
162 | self.pool = QThreadPool.globalInstance()
163 | cast(QDialog, self).setWindowTitle("Converting...")
164 | self.setMinimumSize(320, 24)
165 | self.move(100, 100)
166 | self.set_range(0, task.size)
167 | qconnect(self.cancel_button.clicked, self.set_canceled)
168 | qconnect(self.signals.task_done, self.accept)
169 | qconnect(self.signals.update_progress, self.bar.setValue)
170 |
171 | def start_task(self) -> int:
172 | runnable = ConvertRunnable(self.task, self.signals)
173 | self.pool.start(runnable)
174 | return self.exec()
175 |
176 | def set_canceled(self):
177 | self.signals.canceled.emit() # type: ignore
178 |
179 | def setup_layout(self) -> QLayout:
180 | layout = QVBoxLayout()
181 | layout.addWidget(self.bar)
182 | layout.addLayout(self.setup_cancel_button_layout())
183 | return layout
184 |
185 | def setup_cancel_button_layout(self) -> QLayout:
186 | layout = QHBoxLayout()
187 | layout.addStretch()
188 | layout.addWidget(self.cancel_button)
189 | return layout
190 |
191 | def set_range(self, min_val: int, max_val: int) -> None:
192 | return self.bar.setRange(min_val, max_val)
193 |
194 |
195 | def reload_note(func: Callable[[Browser, Sequence[NoteId], list[str]], None]):
196 | @functools.wraps(func)
197 | def decorator(browser: Browser, note_ids: Sequence[NoteId], selected_fields: list[str]) -> None:
198 | assert browser.editor
199 | note = browser.editor.note
200 | if note:
201 | browser.editor.currentField = None
202 | browser.editor.set_note(None)
203 | func(browser, note_ids, selected_fields)
204 | if note:
205 | browser.editor.set_note(note)
206 |
207 | return decorator
208 |
209 |
210 | @reload_note
211 | def bulk_convert(browser: Browser, note_ids: Sequence[NoteId], selected_fields: list[str]) -> None:
212 | progress_bar = ProgressBar(task=ConvertTask(browser, note_ids, selected_fields))
213 | progress_bar.start_task() # blocks
214 | progress_bar.task.update_notes()
215 |
216 |
217 | def on_bulk_convert(browser: Browser):
218 | selected_nids = browser.selectedNotes()
219 | if selected_nids:
220 | dialog = AnkiBulkConvertDialog(parent=browser, config=config)
221 | if dialog.exec():
222 | if len(selected_nids) == 1:
223 | browser.table.clear_selection()
224 | bulk_convert(browser, selected_nids, dialog.selected_fields())
225 | else:
226 | tooltip("No cards selected.", parent=browser)
227 |
228 |
229 | def setup_menu(browser: Browser):
230 | a = QAction(ACTION_NAME, browser)
231 | qconnect(a.triggered, lambda: on_bulk_convert(browser))
232 | browser.form.menuEdit.addAction(a)
233 |
234 |
235 | def init() -> None:
236 | gui_hooks.browser_menus_did_init.append(setup_menu)
237 |
--------------------------------------------------------------------------------
/media_converter/common.py:
--------------------------------------------------------------------------------
1 | # Copyright: Ajatt-Tools and contributors; https://github.com/Ajatt-Tools
2 | # License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
3 |
4 | import re
5 | from collections.abc import Iterable
6 | from typing import Optional
7 |
8 | from aqt.editor import Editor
9 | from aqt.qt import *
10 |
11 | from .dialogs.paste_image_dialog import AnkiPasteImageDialog
12 | from .utils.show_options import ImageDimensions, ShowOptions
13 |
14 | RE_IMAGE_HTML_TAG = re.compile(r']*src="([^"]+)"[^<>]*>', flags=re.IGNORECASE)
15 | RE_AUDIO_HTML_TAG = re.compile(r"\[sound:([^\]]+)\]", flags=re.IGNORECASE)
16 |
17 |
18 | def get_file_extension(file_path: str) -> str:
19 | return os.path.splitext(file_path)[1].lower()
20 |
21 |
22 | def is_excluded_image_extension(filename: str, include_converted: bool = False) -> bool:
23 | """
24 | Return true if the image file with this filename should not be converted.
25 |
26 | :param filename: Name of the file.
27 | :param include_converted: Allow reconversion. The target extension (webp, avif) will not be excluded.
28 | """
29 | from .config import config
30 |
31 | return get_file_extension(filename) in config.get_excluded_image_extensions(include_converted)
32 |
33 |
34 | def is_excluded_audio_extension(filename: str, include_converted: bool = False) -> bool:
35 | """
36 | Return true if the audio file with this filename should not be converted.
37 |
38 | :param filename: Name of the file.
39 | :param include_converted: Allow reconversion. The target extension (webp, avif) will not be excluded.
40 | """
41 | from .config import config
42 |
43 | return get_file_extension(filename) in config.get_excluded_audio_extensions(include_converted)
44 |
45 |
46 | def find_convertible_images(html: str, include_converted: bool = False) -> Iterable[str]:
47 | """
48 | Find image files referenced by a note.
49 | :param html: Note content (joined fields).
50 | :param include_converted: Reconvert files even if they already have been converted to the target format. E.g. to reduce size.
51 | :return: Filenames
52 | """
53 | if " Iterable[str]:
63 | """
64 | Find audio files referenced by a note.
65 | :param html: Note content (joined fields).
66 | :param include_converted: Reconvert files even if they already have been converted to the target format. E.g. to reduce size.
67 | :return: Filenames
68 | """
69 | if "[sound:" not in html:
70 | return
71 | filename: str
72 | for filename in re.findall(RE_AUDIO_HTML_TAG, html):
73 | # Check if the filename ends with any of the excluded extensions
74 | if not is_excluded_audio_extension(filename, include_converted):
75 | yield filename
76 |
77 |
78 | def tooltip(msg: str, parent: Optional[QWidget] = None) -> None:
79 | from aqt.utils import tooltip as _tooltip
80 | from .config import config
81 |
82 | return _tooltip(msg=msg, period=config.tooltip_duration_seconds * 1000, parent=parent)
83 |
84 |
85 | def filesize_kib(filepath: str) -> float:
86 | return os.stat(filepath).st_size / 1024.0
87 |
88 |
89 | def image_html(image_filename: str) -> str:
90 | from .config import config
91 |
92 | return f''
93 |
94 |
95 | def insert_image_html(editor: Editor, image_filename: str):
96 | editor.doPaste(html=image_html(image_filename), internal=True)
97 |
98 |
99 | def has_local_file(mime: QMimeData) -> bool:
100 | for url in mime.urls():
101 | if url.isLocalFile():
102 | return True
103 | return False
104 |
105 |
106 | def key_to_str(shortcut: str) -> str:
107 | return QKeySequence(shortcut).toString(QKeySequence.SequenceFormat.NativeText)
108 |
109 |
110 | def maybe_show_settings(dimensions: ImageDimensions, parent: Optional[QWidget], action: ShowOptions) -> int:
111 | from .config import config
112 |
113 | if config.should_show_settings(action):
114 | dlg = AnkiPasteImageDialog(config=config, dimensions=dimensions, parent=parent)
115 | return dlg.exec()
116 | return QDialog.DialogCode.Accepted
117 |
--------------------------------------------------------------------------------
/media_converter/config.json:
--------------------------------------------------------------------------------
1 | {
2 | "avoid_upscaling": true,
3 | "show_context_menu_entry": false,
4 | "show_editor_button": true,
5 | "convert_on_note_add": true,
6 | "delete_original_file_on_convert": false,
7 | "shortcut": "Ctrl+Meta+v",
8 | "image_width": 0,
9 | "image_height": 250,
10 | "max_image_width": 1000,
11 | "max_image_height": 1000,
12 | "image_format": "webp",
13 | "audio_container": "ogg",
14 | "excluded_image_containers": "svg,webp,avif",
15 | "excluded_audio_containers": "mid,aac,opus,ogg",
16 | "image_quality": 20,
17 | "show_settings": "toolbar",
18 | "drag_and_drop": true,
19 | "copy_paste": false,
20 | "cwebp_args": [
21 | "-short",
22 | "-mt",
23 | "-pass",
24 | "10",
25 | "-af",
26 | "-blend_alpha",
27 | "0xffffff",
28 | "-m",
29 | "6"
30 | ],
31 | "ffmpeg_args": [
32 | "-threads",
33 | "0",
34 | "-map_metadata",
35 | "-1",
36 | "-cpu-used",
37 | "6"
38 | ],
39 | "filename_pattern_num": 0,
40 | "tooltip_duration_seconds": 5,
41 | "preserve_original_filenames": true,
42 | "bulk_convert_fields": [],
43 | "bulk_reconvert": false,
44 | "custom_name_field": "VocabKanji",
45 | "saved_presets": [],
46 | "enable_image_conversion": true,
47 | "enable_audio_conversion": false,
48 | "ffmpeg_audio_args": [
49 | ],
50 | "ffmpeg_audio_bitrate": 32
51 | }
52 |
--------------------------------------------------------------------------------
/media_converter/config.md:
--------------------------------------------------------------------------------
1 | ## AJT Media Converter — edit config
2 |
3 | Here you can edit the config file.
4 | You must know what you're doing.
5 | Anki needs to be restarted for changes to be applied.
6 | To restore default settings, click the **"Restore Defaults"** button.
7 |
8 | If you have any questions,
9 | ask other users in the [user group](https://tatsumoto.neocities.org/blog/join-our-community.html).
10 |
11 | ****
12 |
13 | * `avoid_upscaling` - Don't resize an image when its original size is less than requested.
14 | * `bulk_convert_fields` - List of fields where the add-on looks for images when bulk-converting.
15 | * `bulk_reconvert` - When bulk-converting, reconvert images that are already in the desired format.
16 | * `copy_paste` - Convert images when you copy-paste them.
17 | * `cwebp_args` - Extra [cwebp arguments](https://www.unix.com/man-page/debian/1/cwebp/).
18 | They are applied on each call to `cwebp`.
19 | * `ffmpeg_args` - Extra [ffmpeg arguments](https://ffmpeg.org/ffmpeg.html).
20 | They are applied on each call to `ffmpeg`.
21 | * `drag_and_drop` - Convert images on drag and drop.
22 | * `image_height` - Desired height.
23 | * `image_width` - Desired width.
24 | * `image_format` - Desired format ("avif" or "webp").
25 | * `excluded_image_containers` - A comma-separated list of file formats (extensions without the dot)
26 | to skip from image conversion.
27 | * `excluded_audio_containers` - A comma-separated list of file formats (extensions without the dot)
28 | to skip from audio conversion.
29 | * `image_quality` - Compression factor between `0` and `100`.
30 | `0` produces the worst quality but the smallest file size.
31 | * `max_image_height` - Limit for the height slider.
32 | * `max_image_width` - Limit for the width slider.
33 | * `shortcut` - Define a keyboard shortcut for pasting images in the configured `image_format`.
34 | * `show_context_menu_entry` - Add an entry to the editor context menu.
35 | * `show_editor_button` - Add a button to the editor toolbar.
36 | * `show_settings` - When to show the settings dialog.
37 | * `always` - Every time you try to insert a converted image.
38 | * `toolbar` - When the toolbar button is clicked.
39 | * `paste` - When you paste an image.
40 | * `drag_and_drop` - On drag-and-drop (if enabled).
41 | * `never` - Only when you press `Tools > WebP settings`.
42 | * `filename_pattern_num` - Used internally.
43 | * `tooltip_duration_seconds` - Duration of tooltips.
44 | * `preserve_original_filenames` - If an image is already named, reuse that name.
45 | Works when dragging an image from a GUI file manager, e.g. [Thunar](https://wiki.archlinux.org/title/Thunar).
46 | * `enable_audio_conversion` - Enable/disable conversion of audio files to `opus`.
47 | * `enable_image_conversion` - Enable/disable conversion of audio files to `webp` or `avif`
48 | based on the selected image format.
49 | * `ffmpeg_audio_args` - Extra [ffmpeg arguments](https://ffmpeg.org/ffmpeg.html) for audio.
50 | * `-b:a` - Audio bitrate. Default "64k".
51 | [About opus bitrates](https://wiki.xiph.org/Opus_Recommended_Settings).
52 | * `audio_container` - Container (file extension name) for opus files ("opus" or "ogg").
53 |
54 | If one of the dimensions is set to `0`, images will be resized
55 | preserving the aspect ratio.
56 | If both `width` and `height` are `0`, no resizing is performed (not recommended).
57 |
58 | ****
59 |
60 | If you enjoy this add-on, please consider supporting my work by
61 | **[making a donation](https://tatsumoto.neocities.org/blog/donating-to-tatsumoto.html)**.
62 | Thank you so much!
63 |
--------------------------------------------------------------------------------
/media_converter/config.py:
--------------------------------------------------------------------------------
1 | # Copyright: Ajatt-Tools and contributors; https://github.com/Ajatt-Tools
2 | # License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
3 |
4 | import enum
5 | from collections.abc import Iterable, Sequence
6 | from typing import Union
7 |
8 | from aqt import mw
9 |
10 | from .ajt_common.addon_config import AddonConfigManager, set_config_update_action
11 | from .ajt_common.utils import clamp
12 | from .utils.show_options import ShowOptions
13 | from .widgets.audio_slider_box import MAX_AUDIO_BITRATE_K, MIN_AUDIO_BITRATE_K
14 |
15 |
16 | @enum.unique
17 | class ImageFormat(enum.Enum):
18 | webp = enum.auto()
19 | avif = enum.auto()
20 |
21 |
22 | @enum.unique
23 | class AudioContainer(enum.Enum):
24 | opus = "opus"
25 | ogg = "ogg"
26 |
27 | @classmethod
28 | def _missing_(cls, _value):
29 | return cls.ogg
30 |
31 |
32 | def cfg_comma_sep_str_to_file_ext_set(cfg_str: str) -> set[str]:
33 | """
34 | Take a string containing a comma-separated list of file formats
35 | and convert it into a set of file extensions
36 | """
37 | return {f".{ext}".lower().strip() for ext in cfg_str.split(",")}
38 |
39 |
40 | class MediaConverterConfig(AddonConfigManager):
41 |
42 | def __init__(self, default: bool = False) -> None:
43 | super().__init__(default)
44 |
45 | def show_settings(self) -> Sequence[ShowOptions]:
46 | instances = []
47 | for name in self["show_settings"].split(","):
48 | try:
49 | instances.append(ShowOptions[name])
50 | except KeyError:
51 | continue
52 | return instances
53 |
54 | def set_show_options(self, options: Iterable[ShowOptions]):
55 | self["show_settings"] = ",".join(option.name for option in options)
56 |
57 | @property
58 | def image_format(self) -> ImageFormat:
59 | return ImageFormat[self["image_format"].lower()]
60 |
61 | @property
62 | def audio_container(self) -> AudioContainer:
63 | return AudioContainer(self["audio_container"].lower())
64 |
65 | @property
66 | def image_extension(self) -> str:
67 | return f".{self.image_format.name}".lower()
68 |
69 | @property
70 | def audio_extension(self) -> str:
71 | return f".{self.audio_container.name}".lower()
72 |
73 | @property
74 | def bulk_reconvert(self) -> bool:
75 | return self["bulk_reconvert"]
76 |
77 | @bulk_reconvert.setter
78 | def bulk_reconvert(self, value: bool) -> None:
79 | self["bulk_reconvert"] = value
80 |
81 | @property
82 | def image_quality(self) -> int:
83 | return clamp(min_val=0, val=self["image_quality"], max_val=100)
84 |
85 | @property
86 | def image_width(self) -> int:
87 | return clamp(min_val=0, val=self["image_width"], max_val=99_999)
88 |
89 | @property
90 | def image_height(self) -> int:
91 | return clamp(min_val=0, val=self["image_height"], max_val=99_999)
92 |
93 | @property
94 | def preserve_original_filenames(self) -> bool:
95 | return self["preserve_original_filenames"]
96 |
97 | @property
98 | def convert_on_note_add(self) -> bool:
99 | return bool(self["convert_on_note_add"])
100 |
101 | @property
102 | def show_editor_button(self) -> bool:
103 | return bool(self["show_editor_button"])
104 |
105 | @property
106 | def delete_original_file_on_convert(self) -> bool:
107 | return self["delete_original_file_on_convert"]
108 |
109 | @property
110 | def filename_pattern_num(self) -> int:
111 | """
112 | Index in list FileNamePatterns
113 | """
114 | return int(self["filename_pattern_num"])
115 |
116 | def get_excluded_image_extensions(self, include_converted: bool) -> frozenset[str]:
117 | """
118 | Return excluded formats and prepend a dot to each format.
119 | If the "reconvert" option is enabled when using bulk-convert,
120 | the target extension (.avif or .webp) is not excluded.
121 |
122 | :param include_converted: The current image extension will not be in the list,
123 | thus webp/avif files will be reconverted.
124 | :return: Image extensions.
125 | """
126 | excluded_extensions = cfg_comma_sep_str_to_file_ext_set(self.excluded_image_containers)
127 | if include_converted:
128 | excluded_extensions.discard(self.image_extension)
129 | else:
130 | excluded_extensions.add(self.image_extension)
131 | return frozenset(excluded_extensions)
132 |
133 | def get_excluded_audio_extensions(self, include_converted: bool) -> frozenset[str]:
134 | """
135 | Return excluded formats and prepend a dot to each format.
136 | If the "reconvert" option is enabled when using bulk-convert,
137 | the target extension (.opus or .ogg) is not excluded.
138 |
139 | :param include_converted: The current audio extension will not be in the list,
140 | thus ogg/opus files will be reconverted.
141 | :return: Audio extensions.
142 | """
143 | excluded_extensions = cfg_comma_sep_str_to_file_ext_set(self["excluded_audio_containers"])
144 | if include_converted:
145 | excluded_extensions.discard(self.audio_extension)
146 | else:
147 | excluded_extensions.add(self.audio_extension)
148 | return frozenset(excluded_extensions)
149 |
150 | @property
151 | def enable_image_conversion(self) -> bool:
152 | return bool(self["enable_image_conversion"])
153 |
154 | @property
155 | def enable_audio_conversion(self) -> bool:
156 | return bool(self["enable_audio_conversion"])
157 |
158 | @property
159 | def cwebp_args(self) -> list[Union[str, int]]:
160 | return self["cwebp_args"]
161 |
162 | @property
163 | def ffmpeg_args(self) -> list[Union[str, int]]:
164 | return self["ffmpeg_args"]
165 |
166 | @property
167 | def ffmpeg_audio_args(self) -> list[Union[str, int]]:
168 | return self["ffmpeg_audio_args"]
169 |
170 | @property
171 | def audio_bitrate_k(self) -> int:
172 | return clamp(MIN_AUDIO_BITRATE_K, self["ffmpeg_audio_bitrate"], MAX_AUDIO_BITRATE_K)
173 |
174 | @audio_bitrate_k.setter
175 | def audio_bitrate_k(self, kbit_s: int) -> None:
176 | self["ffmpeg_audio_bitrate"] = kbit_s
177 |
178 | @property
179 | def tooltip_duration_seconds(self) -> int:
180 | return int(self["tooltip_duration_seconds"])
181 |
182 | @property
183 | def drag_and_drop(self) -> bool:
184 | return bool(self["drag_and_drop"])
185 |
186 | @property
187 | def copy_paste(self) -> bool:
188 | return bool(self["copy_paste"])
189 |
190 | @property
191 | def excluded_image_containers(self) -> str:
192 | return self["excluded_image_containers"]
193 |
194 | @excluded_image_containers.setter
195 | def excluded_image_containers(self, value: str) -> None:
196 | self["excluded_image_containers"] = value
197 |
198 | @property
199 | def shortcut(self) -> str:
200 | return self["shortcut"]
201 |
202 | @property
203 | def custom_name_field(self) -> str:
204 | return self["custom_name_field"]
205 |
206 | @property
207 | def avoid_upscaling(self) -> bool:
208 | return bool(self["avoid_upscaling"])
209 |
210 | def should_show_settings(self, action: ShowOptions) -> bool:
211 | return bool(action in self.show_settings())
212 |
213 |
214 | def get_global_config() -> MediaConverterConfig:
215 | assert mw, "anki must be running"
216 | return config
217 |
218 |
219 | if mw:
220 | config = MediaConverterConfig()
221 | set_config_update_action(config.update_from_addon_manager)
222 |
--------------------------------------------------------------------------------
/media_converter/consts.py:
--------------------------------------------------------------------------------
1 | # Copyright: Ajatt-Tools and contributors; https://github.com/Ajatt-Tools
2 | # License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
3 |
4 | import os
5 |
6 | from .ajt_common.consts import ADDON_SERIES
7 |
8 | ADDON_PATH = os.path.dirname(os.path.abspath(__file__))
9 | ADDON_NAME = "Media Converter"
10 | ADDON_FULL_NAME = f"{ADDON_SERIES} {ADDON_NAME}"
11 | ADDON_NAME_SNAKE = ADDON_NAME.lower().replace(" ", "_")
12 | THIS_ADDON_MODULE = __name__.split(".")[0]
13 | SUPPORT_DIR = os.path.join(ADDON_PATH, "support")
14 |
15 | WINDOW_MIN_WIDTH = 400
16 |
17 | REQUEST_HEADERS = {"User-Agent": "Mozilla/5.0 (compatible; Anki)"}
18 | REQUEST_TIMEOUTS = (3.05, 12.05)
19 |
20 | assert os.path.isdir(SUPPORT_DIR), "support dir must exist."
21 |
--------------------------------------------------------------------------------
/media_converter/dialogs/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Ajatt-Tools/PasteImagesAsWebP/4521052e0c4764bafb56342b041f4261745f7a15/media_converter/dialogs/__init__.py
--------------------------------------------------------------------------------
/media_converter/dialogs/bulk_convert_dialog.py:
--------------------------------------------------------------------------------
1 | # Copyright: Ajatt-Tools and contributors; https://github.com/Ajatt-Tools
2 | # License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
3 | import itertools
4 | from collections.abc import Iterable
5 |
6 | from anki.notes import Note
7 | from aqt import mw
8 | from aqt.browser import Browser
9 | from aqt.utils import showInfo
10 |
11 | from ..config import MediaConverterConfig
12 | from ..consts import ADDON_NAME_SNAKE
13 | from ..widgets.audio_settings_widget import AudioSettings
14 | from ..widgets.bulk_convert_settings_widget import BulkConvertSettings
15 | from ..widgets.image_settings_widget import ImageSettings
16 | from .settings_dialog_base import (
17 | AnkiSaveAndRestoreGeomDialog,
18 | SettingsDialogBase,
19 | SettingsTabs,
20 | )
21 |
22 |
23 | def get_all_keys(notes: Iterable[Note]) -> list[str]:
24 | """
25 | Returns a list of field names present in passed notes, without duplicates.
26 | """
27 | return sorted(frozenset(itertools.chain(*(note.keys() for note in notes))))
28 |
29 |
30 | class BulkConvertDialog(SettingsDialogBase):
31 | """Dialog shown on bulk-convert."""
32 |
33 | name: str = f"ajt__{ADDON_NAME_SNAKE}_bulk_convert_dialog"
34 | _tabs: SettingsTabs
35 | _image_settings: ImageSettings
36 | _audio_settings: AudioSettings
37 | _bulk_convert_settings: BulkConvertSettings
38 |
39 | def __init__(self, config: MediaConverterConfig, parent=None) -> None:
40 | super().__init__(config, parent)
41 | self._image_settings = ImageSettings(config=self.config)
42 | self._audio_settings = AudioSettings(config=self.config)
43 | self._bulk_convert_settings = BulkConvertSettings(config=self.config)
44 | self._tabs = SettingsTabs(self.config, self._image_settings, self._audio_settings, self._bulk_convert_settings)
45 | self._setup_ui()
46 | self.setup_bottom_button_box()
47 | self.set_initial_values()
48 |
49 | def _setup_ui(self) -> None:
50 | self.main_vbox.addWidget(self._tabs)
51 | self.main_vbox.addStretch()
52 | self.main_vbox.addWidget(self.button_box)
53 |
54 | def set_initial_values(self) -> None:
55 | self._image_settings.set_initial_values()
56 | self._audio_settings.set_initial_values()
57 | self._bulk_convert_settings.set_initial_values(all_field_names=self.selected_notes_fields())
58 |
59 | def selected_fields(self) -> list[str]:
60 | return self._bulk_convert_settings.field_selector.checked_texts()
61 |
62 | def selected_notes_fields(self) -> list[str]:
63 | """
64 | A dummy used when Anki isn't running.
65 | """
66 | assert mw is None
67 | return ["A", "B", "C"]
68 |
69 | def accept(self) -> None:
70 | if not self._bulk_convert_settings.field_selector.has_valid_selection():
71 | showInfo(title="Can't accept settings", text="No fields selected. Nothing to convert.")
72 | return
73 | self._image_settings.pass_settings_to_config()
74 | self._audio_settings.pass_settings_to_config()
75 | self._bulk_convert_settings.pass_settings_to_config()
76 | self.config.write_config()
77 | return super().accept()
78 |
79 |
80 | class AnkiBulkConvertDialog(BulkConvertDialog, AnkiSaveAndRestoreGeomDialog):
81 | """
82 | Adds methods that work only when Anki is running.
83 | """
84 |
85 | def __init__(self, config: MediaConverterConfig, parent=None) -> None:
86 | super().__init__(config, parent)
87 |
88 | def selected_notes_fields(self) -> list[str]:
89 | """
90 | Return a list of field names where each field name is present in at least one selected note.
91 | """
92 | browser = self.parent()
93 | assert mw
94 | assert isinstance(browser, Browser)
95 | return get_all_keys(mw.col.get_note(nid) for nid in browser.selectedNotes())
96 |
--------------------------------------------------------------------------------
/media_converter/dialogs/bulk_convert_result_dialog.py:
--------------------------------------------------------------------------------
1 | # Copyright: Ajatt-Tools and contributors; https://github.com/Ajatt-Tools
2 | # License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
3 | import io
4 | from typing import Optional
5 |
6 | import aqt
7 | from aqt.qt import *
8 |
9 | from ..ajt_common.about_menu import tweak_window
10 | from ..consts import ADDON_FULL_NAME
11 | from ..file_converters.convert_result import ConvertResult
12 |
13 |
14 | def fallback_parent(parent) -> Optional[QWidget]:
15 | if parent is None:
16 | try:
17 | return aqt.mw.app.activeWindow() or aqt.mw
18 | except AttributeError:
19 | assert aqt.mw is None
20 | pass
21 | return parent
22 |
23 |
24 | def form_report_message(result: ConvertResult) -> str:
25 | buffer = io.StringIO()
26 | buffer.write(f"
Converted {len(result.converted)} files.
")
27 | if result.failed:
28 | buffer.write(f"
Failed {len(result.failed)} files.
")
29 | buffer.write("")
30 | for file, reason in result.failed.items():
31 | buffer.write(f"
