1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
/*
Loaded data is !Send+!Sync so we probably don't need to cache it.
*/
use std::{fmt, mem::size_of};
use byteorder::{BigEndian, ReadBytesExt};
use icu_properties::sets;
use zng_color::{rgba, ColorScheme, Rgba};
use zng_var::impl_from_and_into_var;
use zng_view_api::font::GlyphIndex;
pub(super) fn maybe_emoji(c: char) -> bool {
sets::emoji().contains(c)
}
pub(super) fn definitely_emoji(c: char) -> bool {
sets::emoji_presentation().contains(c) || is_modifier(c)
}
pub(super) fn is_modifier(c: char) -> bool {
sets::emoji_modifier().contains(c)
}
pub(super) fn is_component(c: char) -> bool {
sets::emoji_component().contains(c)
}
/*
https://learn.microsoft.com/en-us/typography/opentype/spec/otff
All OpenType fonts use Motorola-style byte ordering (Big Endian)
Offset32 = uint32
*/
// OpenType is Big Endian, table IDs are their ASCII name (4 chars) as an `u32`.
/// Color Palette Table
const CPAL: u32 = u32::from_be_bytes(*b"CPAL");
/// Color Table.
const COLR: u32 = u32::from_be_bytes(*b"COLR");
/// CPAL table.
///
/// The palettes for a font are available in [`FontFace::color_palettes`].
///
/// [`FontFace::color_palettes`]: crate::FontFace::color_palettes
#[derive(Clone, Debug)]
pub struct ColorPalettes {
num_palettes: u16,
num_palette_entries: u16,
colors: Box<[Rgba]>,
types: Box<[ColorPaletteType]>,
}
impl Default for ColorPalettes {
/// Empty.
fn default() -> Self {
Self::empty()
}
}
impl ColorPalettes {
/// No palettes.
pub fn empty() -> Self {
Self {
num_palettes: 0,
num_palette_entries: 0,
colors: Box::new([]),
types: Box::new([]),
}
}
/// Load the table, if present in the font.
pub fn load(font: &ttf_parser::RawFace) -> std::io::Result<Self> {
// ttf_parser::Face does not expose CPAL
let table = match font.table(ttf_parser::Tag(CPAL)) {
Some(t) => t,
None => return Ok(Self::empty()),
};
/*
https://learn.microsoft.com/en-us/typography/opentype/spec/cpal
CPAL version 0
The CPAL header version 0 is organized as follows:
Type Name Description
uint16 version Table version number (=0).
uint16 numPaletteEntries Number of palette entries in each palette.
uint16 numPalettes Number of palettes in the table.
uint16 numColorRecords Total number of color records, combined for all palettes.
Offset32 colorRecordsArrayOffset Offset from the beginning of CPAL table to the first ColorRecord.
uint16 colorRecordIndices[numPalettes] Index of each palette’s first color record in the combined color record array.
*/
let mut cursor = std::io::Cursor::new(&table);
let version = cursor.read_u16::<BigEndian>()?;
let num_palette_entries = cursor.read_u16::<BigEndian>()?;
let num_palettes = cursor.read_u16::<BigEndian>()?;
let _num_color_records = cursor.read_u16::<BigEndian>()?;
let color_records_array_offset = cursor.read_u32::<BigEndian>()? as u64;
let color_record_indices = cursor.position();
let mut colors = Vec::with_capacity(num_palettes as usize * num_palette_entries as usize);
for i in 0..num_palettes {
cursor.set_position(color_record_indices + i as u64 * size_of::<u16>() as u64);
let color_record_index = cursor.read_u16::<BigEndian>()? as u64;
let color_record_offset = color_records_array_offset + color_record_index * size_of::<(u8, u8, u8, u8)>() as u64;
cursor.set_position(color_record_offset);
for _ in 0..num_palette_entries {
let b = cursor.read_u8()?;
let g = cursor.read_u8()?;
let r = cursor.read_u8()?;
let a = cursor.read_u8()?;
colors.push(rgba(r, g, b, a));
}
}
let mut palette_types = vec![];
if version >= 1 {
cursor.set_position(color_record_indices + num_palettes as u64 * size_of::<u16>() as u64);
/*
CPAL version 1
{version..colorRecordIndices[numPalettes]}
Offset32 paletteTypesArrayOffset Offset from the beginning of CPAL table to the Palette Types Array. Set to 0 if no array is provided.
Offset32 paletteLabelsArrayOffset Offset from the beginning of CPAL table to the Palette Labels Array. Set to 0 if no array is provided.
Offset32 paletteEntryLabelsArrayOffset Offset from the beginning of CPAL table to the Palette Entry Labels Array. Set to 0 if no array is provided.
*/
let palette_types_array_offset = cursor.read_u32::<BigEndian>()? as u64;
let _palette_labels_array_offset = cursor.read_u32::<BigEndian>()? as u64;
let _palette_entry_labels_array_offset = cursor.read_u32::<BigEndian>()? as u64;
if palette_types_array_offset > 0 {
palette_types.reserve(num_palettes as usize);
cursor.set_position(palette_types_array_offset);
for _ in 0..num_palettes {
let flags = cursor.read_u32::<BigEndian>()?;
let flags = ColorPaletteType::from_bits(flags).unwrap_or_else(ColorPaletteType::empty);
palette_types.push(flags);
}
}
}
Ok(Self {
num_palettes,
num_palette_entries,
colors: colors.into_boxed_slice(),
types: palette_types.into_boxed_slice(),
})
}
/// Number of palettes.
pub fn len(&self) -> usize {
self.num_palettes as usize
}
/// If the font does not have any color palette.
pub fn is_empty(&self) -> bool {
self.num_palettes == 0
}
/// Gets the requested palette or the first if it is not found.
pub fn palette(&self, p: impl Into<FontColorPalette>) -> Option<ColorPalette> {
let i = self.palette_i(p.into());
self.palette_get(i.unwrap_or(0))
}
/// Gets the requested palette.
pub fn palette_exact(&self, p: impl Into<FontColorPalette>) -> Option<ColorPalette> {
let i = self.palette_i(p.into())?;
self.palette_get(i)
}
fn palette_i(&self, p: FontColorPalette) -> Option<usize> {
match p {
FontColorPalette::Light => self
.types
.iter()
.position(|p| p.contains(ColorPaletteType::USABLE_WITH_LIGHT_BACKGROUND)),
FontColorPalette::Dark => self
.types
.iter()
.position(|p| p.contains(ColorPaletteType::USABLE_WITH_DARK_BACKGROUND)),
FontColorPalette::Index(i) => {
if i < self.num_palette_entries {
Some(i as _)
} else {
None
}
}
}
}
fn palette_get(&self, i: usize) -> Option<ColorPalette> {
let len = self.num_palette_entries as usize;
let s = len * i;
let e = s + len;
self.colors.get(s..e).map(|c| ColorPalette {
flags: self.types.get(i).copied().unwrap_or_else(ColorPaletteType::empty),
colors: c,
})
}
/// Iterate over color palettes.
pub fn iter(&self) -> impl ExactSizeIterator<Item = ColorPalette> {
self.colors
.chunks_exact(self.num_palette_entries as _)
.enumerate()
.map(|(i, c)| ColorPalette {
flags: self.types.get(i).copied().unwrap_or_else(ColorPaletteType::empty),
colors: c,
})
}
}
bitflags! {
/// Represents a color palette v1 flag.
///
/// See [`ColorPalettes`] for more details.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct ColorPaletteType: u32 {
/// Palette is appropriate to use when displaying the font on a light background such as white.
const USABLE_WITH_LIGHT_BACKGROUND = 0x0001;
/// Palette is appropriate to use when displaying the font on a dark background such as black.
const USABLE_WITH_DARK_BACKGROUND = 0x0002;
}
}
/// Represents a color palette entry.
///
/// See [`ColorPalettes`] for more details.
pub struct ColorPalette<'a> {
/// Palette v1 flags.
pub flags: ColorPaletteType,
/// Palette colors.
pub colors: &'a [Rgba],
}
/// COLR table.
///
/// The color glyphs for a font are available in [`FontFace::color_glyphs`].
///
/// [`FontFace::color_glyphs`]: crate::FontFace::color_glyphs
#[derive(Clone, Debug)]
pub struct ColorGlyphs {
base_glyph_records: Vec<BaseGlyphRecord>,
layer_records: Vec<LayerRecord>,
}
impl ColorGlyphs {
/// No color glyphs.
pub fn empty() -> Self {
Self {
base_glyph_records: vec![],
layer_records: vec![],
}
}
/// Load the table, if present in the font.
pub fn load(font: &ttf_parser::RawFace) -> std::io::Result<Self> {
let table = match font.table(ttf_parser::Tag(COLR)) {
Some(t) => t,
None => return Ok(Self::empty()),
};
/*
https://learn.microsoft.com/en-us/typography/opentype/spec/colr#colr-formats
COLR version 0
Type Name Description
uint16 version Table version number—set to 0.
uint16 numBaseGlyphRecords Number of BaseGlyph records.
Offset32 baseGlyphRecordsOffset Offset to baseGlyphRecords array.
Offset32 layerRecordsOffset Offset to layerRecords array.
uint16 numLayerRecords Number of Layer records.
*/
let mut cursor = std::io::Cursor::new(&table);
let _version = cursor.read_u16::<BigEndian>()?;
let num_base_glyph_records = cursor.read_u16::<BigEndian>()?;
let base_glyph_records_offset = cursor.read_u32::<BigEndian>()? as u64;
let layer_records_offset = cursor.read_u32::<BigEndian>()? as u64;
let num_layer_records = cursor.read_u16::<BigEndian>()?;
let mut base_glyph_records = Vec::with_capacity(num_base_glyph_records as _);
cursor.set_position(base_glyph_records_offset);
for _ in 0..num_base_glyph_records {
/*
https://learn.microsoft.com/en-us/typography/opentype/spec/colr#baseglyph-and-layer-records
BaseGlyph record:
Type Name Description
uint16 glyphID Glyph ID of the base glyph.
uint16 firstLayerIndex Index (base 0) into the layerRecords array.
uint16 numLayers Number of color layers associated with this glyph.
*/
base_glyph_records.push(BaseGlyphRecord {
glyph_id: cursor.read_u16::<BigEndian>()?,
first_layer_index: cursor.read_u16::<BigEndian>()?,
num_layers: cursor.read_u16::<BigEndian>()?,
});
}
let mut layer_records = Vec::with_capacity(num_layer_records as _);
cursor.set_position(layer_records_offset);
for _ in 0..num_layer_records {
/*
Layer record:
Type Name Description
uint16 glyphID Glyph ID of the glyph used for a given layer.
uint16 paletteIndex Index (base 0) for a palette entry in the CPAL table.
*/
layer_records.push(LayerRecord {
glyph_id: cursor.read_u16::<BigEndian>()?,
palette_index: cursor.read_u16::<BigEndian>()?,
});
}
Ok(Self {
base_glyph_records,
layer_records,
})
}
/// Iterate over color glyphs that replace the `base_glyph` to render in color.
///
/// The `base_glyph` is the glyph selected by the font during shaping.
///
/// Returns an iterator that *renders* an Emoji by overlaying colored glyphs, from the back (first item)
/// to the front (last item). Paired with each glyph is an index in the font's [`ColorPalette::colors`] or
/// `None` if the base text color must be used.
///
/// Yields the `base_glyph` with no palette color if the font does not provide colored replacements for it.
pub fn glyph(&self, base_glyph: GlyphIndex) -> Option<ColorGlyph> {
match self.base_glyph_records.binary_search_by_key(&(base_glyph as u16), |e| e.glyph_id) {
Ok(i) => {
let rec = &self.base_glyph_records[i];
let s = rec.first_layer_index as usize;
let e = s + rec.num_layers as usize;
Some(ColorGlyph {
layers: &self.layer_records[s..e],
})
}
Err(_) => None,
}
}
/// If the font does not have any colored glyphs.
pub fn is_empty(&self) -> bool {
self.base_glyph_records.is_empty()
}
/// Number of base glyphs that have colored replacements.
pub fn len(&self) -> usize {
self.base_glyph_records.len()
}
}
/// Represents all layer glyphs selected by the font to replace a colored glyph.
///
/// Get using [`ColorGlyphs::glyph`].
pub struct ColorGlyph<'a> {
layers: &'a [LayerRecord],
}
impl<'a> ColorGlyph<'a> {
/// Iterate over the layer glyphs and palette color from back to front.
pub fn iter(&self) -> impl ExactSizeIterator<Item = (GlyphIndex, Option<usize>)> + 'a {
self.layers.iter().map(|l| (l.glyph_id(), l.palette_index()))
}
/// Number of layer glyphs that replace the colored glyph.
pub fn layers_len(&self) -> usize {
self.layers.len()
}
}
#[derive(Debug, Clone, Copy)]
struct BaseGlyphRecord {
glyph_id: u16,
first_layer_index: u16,
num_layers: u16,
}
#[derive(Debug, Clone, Copy)]
struct LayerRecord {
glyph_id: u16,
palette_index: u16,
}
impl LayerRecord {
fn glyph_id(&self) -> GlyphIndex {
self.glyph_id as _
}
fn palette_index(&self) -> Option<usize> {
if self.palette_index == 0xFFFF {
None
} else {
Some(self.palette_index as _)
}
}
}
/// Color palette selector for colored fonts.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum FontColorPalette {
/// Select first font palette tagged [`ColorPaletteType::USABLE_WITH_LIGHT_BACKGROUND`], or 0 if the
/// font does not tag any palette or no match is found.
Light,
/// Select first font palette tagged [`ColorPaletteType::USABLE_WITH_DARK_BACKGROUND`], or 0 if the
/// font does not tag any palette or no match is found.
Dark,
/// Select one of the font provided palette by index.
///
/// The palette list of a font is available in [`FontFace::color_palettes`]. If the index
/// is not found uses the first font palette.
///
/// [`FontFace::color_palettes`]: crate::FontFace::color_palettes
Index(u16),
}
impl fmt::Debug for FontColorPalette {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if f.alternate() {
write!(f, "FontColorPalette::")?;
}
match self {
Self::Light => write!(f, "Light"),
Self::Dark => write!(f, "Dark"),
Self::Index(arg0) => f.debug_tuple("Index").field(arg0).finish(),
}
}
}
impl_from_and_into_var! {
fn from(index: u16) -> FontColorPalette {
FontColorPalette::Index(index)
}
fn from(color_scheme: ColorScheme) -> FontColorPalette {
match color_scheme {
ColorScheme::Light => FontColorPalette::Light,
ColorScheme::Dark => FontColorPalette::Dark,
}
}
}