diff --git a/LICENSE/LICENSE_OPENMOJI b/LICENSE/LICENSE_OPENMOJI new file mode 100644 index 000000000000..cc3e2459dc5c --- /dev/null +++ b/LICENSE/LICENSE_OPENMOJI @@ -0,0 +1,427 @@ +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + + including for purposes of Section 3(b); and + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/doc/project/license.rst b/doc/project/license.rst index 6a34eff4637d..5242062d36d5 100644 --- a/doc/project/license.rst +++ b/doc/project/license.rst @@ -169,6 +169,12 @@ Fonts .. literalinclude:: ../../LICENSE/LICENSE_LAST_RESORT_FONT :language: none +.. dropdown:: OpenMoji Color (subset) + :class-container: sdd + + .. literalinclude:: ../../LICENSE/LICENSE_OPENMOJI + :language: none + .. dropdown:: STIX :class-container: sdd diff --git a/doc/release/next_whats_new/colour_font.rst b/doc/release/next_whats_new/colour_font.rst new file mode 100644 index 000000000000..1e5e16716310 --- /dev/null +++ b/doc/release/next_whats_new/colour_font.rst @@ -0,0 +1,33 @@ +Support for (some) colour fonts +------------------------------- + +Various colour fonts (e.g., emoji fonts) are now supported. Note, that certain +newer, more complex fonts are `not yet supported +`__. + + +.. plot:: + + from pathlib import Path + from matplotlib.font_manager import FontProperties + + zwj = '\U0000200D' + adult = '\U0001F9D1' + man = '\U0001F468' + woman = '\U0001F469' + science = '\U0001F52C' + technology = '\U0001F4BB' + skin_tones = ['', *(chr(0x1F3FB + i) for i in range(5))] + + text = '\n'.join([ + ''.join(person + tone + zwj + occupation for tone in skin_tones) + for person in [adult, man, woman] + for occupation in [science, technology] + ]) + + path = Path(plt.__file__).parent / 'tests/data/OpenMoji-color-glyf_colr_0-subset.ttf' + + fig = plt.figure(figsize=(6.4, 4.8)) + fig.text(0.5, 0.5, text, + font=FontProperties(fname=path), fontsize=48, linespacing=0.9, + horizontalalignment='center', verticalalignment='center') diff --git a/lib/matplotlib/backends/backend_agg.py b/lib/matplotlib/backends/backend_agg.py index f0006a2d7dbe..cc9e03f44c87 100644 --- a/lib/matplotlib/backends/backend_agg.py +++ b/lib/matplotlib/backends/backend_agg.py @@ -56,6 +56,10 @@ def get_hinting_flag(): return mapping[mpl.rcParams['text.hinting']] +def _get_load_flags(): + return get_hinting_flag() | LoadFlags.COLOR | LoadFlags.NO_SVG + + class RendererAgg(RendererBase): """ The renderer handles all the drawing primitives using a graphics @@ -176,7 +180,7 @@ def _draw_text_glyphs_and_boxes(self, gc, x, y, angle, glyphs, boxes): # y is downwards. cos = math.cos(math.radians(angle)) sin = math.sin(math.radians(angle)) - load_flags = get_hinting_flag() + load_flags = _get_load_flags() for font, size, glyph_index, slant, extend, dx, dy in glyphs: # dy is upwards. font.set_size(size, self.dpi) hf = font._hinting_factor @@ -192,13 +196,19 @@ def _draw_text_glyphs_and_boxes(self, gc, x, y, angle, glyphs, boxes): glyph_index, load_flags, RenderMode.NORMAL if gc.get_antialiased() else RenderMode.MONO) buffer = bitmap.buffer - if not gc.get_antialiased(): - buffer *= 0xff - # draw_text_image's y is downwards & the bitmap bottom side. - self._renderer.draw_text_image( - buffer, - bitmap.left, int(self.height) - bitmap.top + buffer.shape[0], - 0, gc) + if buffer.ndim == 3: + self._renderer.draw_text_bgra_image( + gc, + bitmap.left, bitmap.top - buffer.shape[0], + buffer) + else: + if not gc.get_antialiased(): + buffer *= 0xff + # draw_text_image's y is downwards & the bitmap bottom side. + self._renderer.draw_text_image( + buffer, + bitmap.left, int(self.height) - bitmap.top + buffer.shape[0], + 0, gc) rgba = gc.get_rgb() if len(rgba) == 3 or gc.get_forced_alpha(): @@ -240,7 +250,7 @@ def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None): return self.draw_mathtext(gc, x, y, s, prop, angle) font = self._prepare_font(prop) items = font._layout( - s, flags=get_hinting_flag(), + s, flags=_get_load_flags(), features=mtext.get_fontfeatures() if mtext is not None else None, language=mtext.get_language() if mtext is not None else None) size = prop.get_size_in_points() @@ -262,7 +272,7 @@ def get_text_width_height_descent(self, s, prop, ismath): return parse.width, parse.height, parse.depth font = self._prepare_font(prop) - font.set_text(s, 0.0, flags=get_hinting_flag()) + font.set_text(s, 0.0, flags=_get_load_flags()) w, h = font.get_width_height() # width and height of unrotated string d = font.get_descent() w /= 64.0 # convert from subpixels diff --git a/lib/matplotlib/testing/__init__.py b/lib/matplotlib/testing/__init__.py index 9fcdb6aeee03..0a2fc95e7751 100644 --- a/lib/matplotlib/testing/__init__.py +++ b/lib/matplotlib/testing/__init__.py @@ -320,3 +320,93 @@ def _gen_multi_font_text(): # The resulting string contains 491 unique characters. Some file formats use 8-bit # tables, which the large number of characters exercises twice over. return fonts, test_str + + +def _add_family_suffix(font, suffix): + """ + Add a suffix to all names in a font. + + This code comes from a fontTools snippet: + https://github.com/fonttools/fonttools/blob/main/Snippets/rename-fonts.py + """ + WINDOWS_ENGLISH_IDS = 3, 1, 0x409 + MAC_ROMAN_IDS = 1, 0, 0 + + FAMILY_RELATED_IDS = dict(LEGACY_FAMILY=1, TRUETYPE_UNIQUE_ID=3, FULL_NAME=4, + POSTSCRIPT_NAME=6, PREFERRED_FAMILY=16, WWS_FAMILY=21) + + def get_current_family_name(table): + family_name_rec = None + for plat_id, enc_id, lang_id in (WINDOWS_ENGLISH_IDS, MAC_ROMAN_IDS): + for name_id in (FAMILY_RELATED_IDS['PREFERRED_FAMILY'], + FAMILY_RELATED_IDS['LEGACY_FAMILY']): + family_name_rec = table.getName(nameID=name_id, platformID=plat_id, + platEncID=enc_id, langID=lang_id) + if family_name_rec is not None: + return family_name_rec.toUnicode() + raise ValueError("family name not found; can't add suffix") + + def insert_suffix(string, family_name, suffix): + # check whether family_name is a substring + start = string.find(family_name) + if start != -1: + # insert suffix after the family_name substring + end = start + len(family_name) + return string[:end] + suffix + string[end:] + else: + # it's not, we just append the suffix at the end + return string + suffix + + def rename_record(name_record, family_name, suffix): + string = name_record.toUnicode() + new_string = insert_suffix(string, family_name, suffix) + name_record.string = new_string + return string, new_string + + table = font['name'] + family_name = get_current_family_name(table) + ps_family_name = family_name.replace(' ', '') + ps_suffix = suffix.replace(' ', '') + for rec in table.names: + name_id = rec.nameID + if name_id not in FAMILY_RELATED_IDS.values(): + continue + if name_id == FAMILY_RELATED_IDS['POSTSCRIPT_NAME']: + old, new = rename_record(rec, ps_family_name, ps_suffix) + elif name_id == FAMILY_RELATED_IDS['TRUETYPE_UNIQUE_ID']: + # The Truetype Unique ID rec may contain either the PostScript + # Name or the Full Name string, so we try both + if ps_family_name in rec.toUnicode(): + old, new = rename_record(rec, ps_family_name, ps_suffix) + else: + old, new = rename_record(rec, family_name, suffix) + else: + old, new = rename_record(rec, family_name, suffix) + + return family_name + + +def _generate_font_subset(path, text): + """ + Generate a subset of a font for testing purposes. + + The font name will be suffixed with ' MplSubset'. + + Parameters + ---------- + path : str or bytes or os.PathLike + The path to the font to be subset. The new file will be saved in the same + location with a ``-subset`` suffix. + text : str + The text from which characters to be subset will be derived. Usually fonts do + not have a newline character, so any appearing in this text will be stripped + before subsetting. + """ + from fontTools import subset + options = subset.Options() + font = subset.load_font(path, options) + subsetter = subset.Subsetter(options=options) + subsetter.populate(text=text.replace('\n', '')) + subsetter.subset(font) + _add_family_suffix(font, ' MplSubset') + subset.save_font(font, path.with_stem(path.stem + '-subset'), options) diff --git a/lib/matplotlib/testing/__init__.pyi b/lib/matplotlib/testing/__init__.pyi index accf973615fa..2d409de9ee0d 100644 --- a/lib/matplotlib/testing/__init__.pyi +++ b/lib/matplotlib/testing/__init__.pyi @@ -1,6 +1,8 @@ from collections.abc import Callable +import os import subprocess from typing import Any, IO, Literal, overload +from fontTools.ttLib import TTFont def set_font_settings_for_testing() -> None: ... def set_reproducibility_for_testing() -> None: ... @@ -56,3 +58,5 @@ def ipython_in_subprocess( ) -> None: ... def is_ci_environment() -> bool: ... def _gen_multi_font_text() -> tuple[list[str], str]: ... +def _add_family_suffix(font: TTFont, suffix: str) -> None: ... +def _generate_font_subset(path: str | bytes | os.PathLike, text: str) -> None: ... diff --git a/lib/matplotlib/testing/conftest.py b/lib/matplotlib/testing/conftest.py index c60a38254aad..890e922a65fd 100644 --- a/lib/matplotlib/testing/conftest.py +++ b/lib/matplotlib/testing/conftest.py @@ -24,6 +24,8 @@ def pytest_configure(config): ("filterwarnings", r"ignore:DynamicImporter.find_spec\(\) not found; " r"falling back to find_module\(\):ImportWarning"), + ("filterwarnings", + r"ignore:Glyph .* \([lp]\) missing from font\(s\) OpenMoji MplSubset\."), ]: config.addinivalue_line(key, value) diff --git a/lib/matplotlib/tests/baseline_images/test_text/colour.png b/lib/matplotlib/tests/baseline_images/test_text/colour.png new file mode 100644 index 000000000000..7e599d0ebd89 Binary files /dev/null and b/lib/matplotlib/tests/baseline_images/test_text/colour.png differ diff --git a/lib/matplotlib/tests/data/OpenMoji-color-glyf_colr_0-subset.ttf b/lib/matplotlib/tests/data/OpenMoji-color-glyf_colr_0-subset.ttf new file mode 100644 index 000000000000..0549ce7a1c48 Binary files /dev/null and b/lib/matplotlib/tests/data/OpenMoji-color-glyf_colr_0-subset.ttf differ diff --git a/lib/matplotlib/tests/test_text.py b/lib/matplotlib/tests/test_text.py index dad82f6af4fb..13bb8333633a 100644 --- a/lib/matplotlib/tests/test_text.py +++ b/lib/matplotlib/tests/test_text.py @@ -2,6 +2,7 @@ import gc import inspect import io +from pathlib import Path import warnings import numpy as np @@ -1331,3 +1332,37 @@ def test_draw_text_as_path_fallback(monkeypatch): _test_complex_shaping(subfig[0]) _test_text_features(subfig[1]) _test_text_language(subfig[2]) + + +@image_comparison(['colour.png'], remove_text=False, style='mpl20') +def test_colour_fonts(): + zwj = '\U0000200D' + adult = '\U0001F9D1' + man = '\U0001F468' + woman = '\U0001F469' + science = '\U0001F52C' + technology = '\U0001F4BB' + skin_tones = ['', *(chr(0x1F3FB + i) for i in range(5))] + + text = '\n'.join([ + ''.join(person + tone + zwj + occupation for tone in skin_tones) + for person in [adult, man, woman] + for occupation in [science, technology] + ]) + + # To generate the subsetted test file, save the latest + # OpenMoji-color-glyf_colr_0.ttf from + # https://github.com/hfg-gmuend/openmoji/tree/master/font to the data directory, + # set this condition to True, and run the test. + path = Path(__file__).parent / 'data/OpenMoji-color-glyf_colr_0.ttf' + if False: + from matplotlib.testing import _generate_font_subset + _generate_font_subset(path, text) + path = path.with_stem(path.stem + '-subset') + if not path.exists(): + pytest.xfail(f'Test font {path} is not available') + + fig = plt.figure() + fig.text(0.5, 0.5, text, + font=FontProperties(fname=path), fontsize=48, linespacing=0.9, + horizontalalignment='center', verticalalignment='center') diff --git a/src/_backend_agg.h b/src/_backend_agg.h index a4e2aa10040d..4e4850f81ad9 100644 --- a/src/_backend_agg.h +++ b/src/_backend_agg.h @@ -12,6 +12,7 @@ #include #include #include +#include #include #include "agg_alpha_mask_u8.h" @@ -152,11 +153,18 @@ class RendererAgg template void draw_text_image(GCAgg &gc, ImageArray &image, int x, int y, double angle); - template + template void draw_image(GCAgg &gc, double x, double y, - ImageArray &image); + ImageArray &image, + bool flip_image = false); template +template inline void RendererAgg::draw_image(GCAgg &gc, double x, double y, - ImageArray &image) + ImageArray &image, + bool flip_image) { double alpha = gc.alpha; @@ -787,8 +796,9 @@ inline void RendererAgg::draw_image(GCAgg &gc, agg::rendering_buffer buffer; buffer.attach(image.mutable_data(0, 0, 0), (unsigned)image.shape(1), (unsigned)image.shape(0), - -(int)image.shape(1) * 4); - pixfmt pixf(buffer); + (flip_image ? 4 : -4) * image.shape(1)); + // NOTE: this pixel format only describes the pixel order, not the colour state. + ImagePixelFormat pixf(buffer); if (has_clippath) { agg::trans_affine mtx; @@ -823,10 +833,21 @@ inline void RendererAgg::draw_image(GCAgg &gc, theRasterizer.add_path(rect2); agg::render_scanlines(theRasterizer, scanlineAlphaMask, ri); + } else if constexpr(!std::is_same_v) { + static_assert(std::is_same_v, + "Blender order must be RGBA"); + auto imgFmt = Blender{renderingBuffer}; + auto rendererImage = agg::renderer_base{imgFmt}; + rendererImage.reset_clipping(true); + set_clipbox(gc.cliprect, rendererImage); + rendererImage.blend_from( + pixf, nullptr, (int)x, (int)(height - (y + image.shape(0))), + (agg::int8u)(alpha * 255)); } else { set_clipbox(gc.cliprect, rendererBase); rendererBase.blend_from( - pixf, nullptr, (int)x, (int)(height - (y + image.shape(0))), (agg::int8u)(alpha * 255)); + pixf, nullptr, (int)x, (int)(height - (y + image.shape(0))), + (agg::int8u)(alpha * 255)); } rendererBase.reset_clipping(true); diff --git a/src/_backend_agg_wrapper.cpp b/src/_backend_agg_wrapper.cpp index 11d45773d186..61b0c6f42e13 100644 --- a/src/_backend_agg_wrapper.cpp +++ b/src/_backend_agg_wrapper.cpp @@ -131,6 +131,66 @@ PyRendererAgg_draw_image(RendererAgg *self, self->draw_image(gc, x, y, image); } +//========================================================blender_rgba_pre_plain +// Blends premultiplied colors into a plain (non-premultiplied) buffer. +template +struct blender_rgba_pre_plain : agg::conv_rgba_pre +{ + typedef ColorT color_type; + typedef Order order_type; + typedef typename color_type::value_type value_type; + typedef typename color_type::calc_type calc_type; + typedef typename color_type::long_type long_type; + + // First premultiply the destination buffer, blend pixels using the premultiplied + // form of Alvy-Ray Smith's compositing function, then demultiply the destination. + + //-------------------------------------------------------------------- + static AGG_INLINE void blend_pix(value_type* p, + value_type cr, value_type cg, value_type cb, + value_type alpha, agg::cover_type cover) + { + blend_pix(p, + color_type::mult_cover(cr, cover), + color_type::mult_cover(cg, cover), + color_type::mult_cover(cb, cover), + color_type::mult_cover(alpha, cover)); + } + + //-------------------------------------------------------------------- + static AGG_INLINE void blend_pix(value_type* p, + value_type cr, value_type cg, value_type cb, + value_type alpha) + { + agg::multiplier_rgba::premultiply(p); + p[Order::R] = color_type::prelerp(p[Order::R], cr, alpha); + p[Order::G] = color_type::prelerp(p[Order::G], cg, alpha); + p[Order::B] = color_type::prelerp(p[Order::B], cb, alpha); + p[Order::A] = color_type::prelerp(p[Order::A], alpha, alpha); + agg::multiplier_rgba::demultiply(p); + } +}; + +static void +PyRendererAgg_draw_text_bgra_image(RendererAgg *self, + GCAgg &gc, + int x, + int y, + py::array_t image_obj) +{ + // TODO: This really shouldn't be mutable, but Agg's renderer buffers aren't const. + auto image = image_obj.mutable_unchecked<3>(); + + gc.alpha = 1.0; + + // FreeType uses premultiplied BGRA, so use a different pixel format than draw_image. + using blender_rgba32_pre_plain = blender_rgba_pre_plain; + using pixfmt_rgba32_pre_plain = agg::pixfmt_alpha_blend_rgba; + self->draw_image( + gc, x, y, image, true); +} + static void PyRendererAgg_draw_path_collection(RendererAgg *self, GCAgg &gc, @@ -227,6 +287,8 @@ PYBIND11_MODULE(_backend_agg, m, py::mod_gil_not_used()) "face"_a = nullptr) .def("draw_text_image", &PyRendererAgg_draw_text_image, "image"_a, "x"_a, "y"_a, "angle"_a, "gc"_a) + .def("draw_text_bgra_image", &PyRendererAgg_draw_text_bgra_image, + "gc"_a, "x"_a, "y"_a, "image"_a.noconvert(true)) .def("draw_image", &PyRendererAgg_draw_image, "gc"_a, "x"_a, "y"_a, "image"_a) .def("draw_path_collection", &PyRendererAgg_draw_path_collection, diff --git a/src/ft2font_wrapper.cpp b/src/ft2font_wrapper.cpp index bf345cd1d044..4dcba406af66 100644 --- a/src/ft2font_wrapper.cpp +++ b/src/ft2font_wrapper.cpp @@ -297,14 +297,22 @@ struct PyPositionedBitmap { left{slot->bitmap_left}, top{slot->bitmap_top}, owning{true} { FT_Bitmap_Init(&bitmap); - FT_CHECK(FT_Bitmap_Convert, _ft2Library, &slot->bitmap, &bitmap, 1); + if (slot->bitmap.pixel_mode == FT_PIXEL_MODE_MONO) { + FT_CHECK(FT_Bitmap_Convert, _ft2Library, &slot->bitmap, &bitmap, 1); + } else { + FT_CHECK(FT_Bitmap_Copy, _ft2Library, &slot->bitmap, &bitmap); + } } PyPositionedBitmap(FT_BitmapGlyph bg) : left{bg->left}, top{bg->top}, owning{true} { FT_Bitmap_Init(&bitmap); - FT_CHECK(FT_Bitmap_Convert, _ft2Library, &bg->bitmap, &bitmap, 1); + if (bg->bitmap.pixel_mode == FT_PIXEL_MODE_MONO) { + FT_CHECK(FT_Bitmap_Convert, _ft2Library, &bg->bitmap, &bitmap, 1); + } else { + FT_CHECK(FT_Bitmap_Copy, _ft2Library, &bg->bitmap, &bitmap); + } } PyPositionedBitmap(PyPositionedBitmap& other) = delete; // Non-copyable. @@ -1693,9 +1701,19 @@ PYBIND11_MODULE(ft2font, m, py::mod_gil_not_used()) .def_readonly("top", &PyPositionedBitmap::top) .def_property_readonly( "buffer", [](PyPositionedBitmap &self) -> py::array { - return {{self.bitmap.rows, self.bitmap.width}, + if (self.bitmap.pixel_mode == FT_PIXEL_MODE_BGRA) { + return { + {self.bitmap.rows, self.bitmap.width, 4u}, + {self.bitmap.pitch, 4, 1}, + self.bitmap.buffer + }; + } else { + return { + {self.bitmap.rows, self.bitmap.width}, {self.bitmap.pitch, 1}, - self.bitmap.buffer}; + self.bitmap.buffer + }; + } }) ;