read_fonts/tables/
mvar.rs1use super::variations::{DeltaSetIndex, ItemVariationStore};
4use types::F48Dot16;
5
6pub mod tags {
8 use font_types::Tag;
9
10 pub const HASC: Tag = Tag::new(b"hasc");
12 pub const HDSC: Tag = Tag::new(b"hdsc");
14 pub const HLGP: Tag = Tag::new(b"hlgp");
16
17 pub const HCLA: Tag = Tag::new(b"hcla");
19 pub const HCLD: Tag = Tag::new(b"hcld");
21
22 pub const VASC: Tag = Tag::new(b"vasc");
24 pub const VDSC: Tag = Tag::new(b"vdsc");
26 pub const VLGP: Tag = Tag::new(b"vlgp");
28
29 pub const HCRS: Tag = Tag::new(b"hcrs");
31 pub const HCRN: Tag = Tag::new(b"hcrn");
33 pub const HCOF: Tag = Tag::new(b"hcof");
35
36 pub const VCRS: Tag = Tag::new(b"vcrs");
38 pub const VCRN: Tag = Tag::new(b"vcrn");
40 pub const VCOF: Tag = Tag::new(b"vcof");
42
43 pub const XHGT: Tag = Tag::new(b"xhgt");
45 pub const CPHT: Tag = Tag::new(b"cpht");
47
48 pub const SBXO: Tag = Tag::new(b"sbxo");
50 pub const SBYO: Tag = Tag::new(b"sbyo");
52 pub const SBXS: Tag = Tag::new(b"sbxs");
54 pub const SBYS: Tag = Tag::new(b"sbys");
56
57 pub const SPXO: Tag = Tag::new(b"spxo");
59 pub const SPYO: Tag = Tag::new(b"spyo");
61 pub const SPXS: Tag = Tag::new(b"spxs");
63 pub const SPYS: Tag = Tag::new(b"spys");
65
66 pub const STRS: Tag = Tag::new(b"strs");
68 pub const STRO: Tag = Tag::new(b"stro");
70
71 pub const UNDS: Tag = Tag::new(b"unds");
73 pub const UNDO: Tag = Tag::new(b"undo");
75
76 pub const GSP0: Tag = Tag::new(b"gsp0");
78 pub const GSP1: Tag = Tag::new(b"gsp1");
80 pub const GSP2: Tag = Tag::new(b"gsp2");
82 pub const GSP3: Tag = Tag::new(b"gsp3");
84 pub const GSP4: Tag = Tag::new(b"gsp4");
86 pub const GSP5: Tag = Tag::new(b"gsp5");
88 pub const GSP6: Tag = Tag::new(b"gsp6");
90 pub const GSP7: Tag = Tag::new(b"gsp7");
92 pub const GSP8: Tag = Tag::new(b"gsp8");
94 pub const GSP9: Tag = Tag::new(b"gsp9");
96}
97
98include!("../../generated/generated_mvar.rs");
99
100pub struct MvarInstance<'a> {
105 records: &'a [ValueRecord],
106 ivs: ItemVariationStore<'a>,
107 coords: &'a [F2Dot14],
108}
109
110impl<'a> Mvar<'a> {
111 pub fn at(&self, coords: &'a [F2Dot14]) -> Option<MvarInstance<'a>> {
116 if coords.is_empty() {
117 return None;
118 }
119 Some(MvarInstance {
120 records: self.value_records(),
121 ivs: self.item_variation_store()?.ok()?,
122 coords,
123 })
124 }
125}
126
127impl MvarInstance<'_> {
128 pub fn get(&self, tag: Tag) -> Option<F48Dot16> {
135 let index = self
136 .records
137 .binary_search_by(|record| record.value_tag().cmp(&tag))
138 .ok()?;
139 let record = &self.records[index];
140 self.ivs.compute_delta(
141 DeltaSetIndex {
142 outer: record.delta_set_outer_index(),
143 inner: record.delta_set_inner_index(),
144 },
145 self.coords,
146 )
147 }
148}
149
150impl Mvar<'_> {
151 pub fn metric_delta(&self, tag: Tag, coords: &[F2Dot14]) -> Option<Fixed> {
158 use std::cmp::Ordering;
159 let records = self.value_records();
160 let mut lo = 0;
161 let mut hi = records.len();
162 while lo < hi {
163 let i = (lo + hi) / 2;
164 let record = &records[i];
165 match tag.cmp(&record.value_tag()) {
166 Ordering::Less => {
167 hi = i;
168 }
169 Ordering::Greater => {
170 lo = i + 1;
171 }
172 Ordering::Equal => {
173 let ivs = self.item_variation_store()?.ok()?;
174 return Some(Fixed::from_i32(
175 ivs.compute_delta(
176 DeltaSetIndex {
177 outer: record.delta_set_outer_index(),
178 inner: record.delta_set_inner_index(),
179 },
180 coords,
181 )?
182 .to_i32(),
183 ));
184 }
185 }
186 }
187 None
188 }
189}
190
191#[cfg(test)]
192mod tests {
193 use super::*;
194 use crate::{FontRef, TableProvider};
195 use types::F2Dot14;
196
197 const VAR: &[u8] = font_test_data::AMSTELVAR_AVAR2_A;
199
200 fn far() -> [F2Dot14; 12] {
201 [F2Dot14::from_f32(1.0); 12]
202 }
203
204 #[test]
205 fn the_default_location_has_no_instance() {
206 let font = FontRef::new(VAR).unwrap();
208 assert!(font.mvar().unwrap().at(&[]).is_none());
209 }
210
211 #[test]
212 fn an_instance_agrees_with_the_single_metric_accessor() {
213 let font = FontRef::new(VAR).unwrap();
214 let mvar = font.mvar().unwrap();
215 let coords = far();
216 let instance = mvar.at(&coords).expect("a location away from the default");
217 let mut varied = 0;
218 for record in mvar.value_records() {
219 let tag = record.value_tag();
220 let exact = instance.get(tag).expect("a tag the table states");
221 let rounded = mvar.metric_delta(tag, &coords).unwrap();
222 assert_eq!(exact.to_i32(), rounded.to_i32(), "{tag}");
223 varied += (exact != F48Dot16::ZERO) as u32;
224 }
225 assert!(varied > 0, "no metric moved at the far end of every axis");
226 }
227
228 #[test]
229 fn a_tag_the_font_does_not_state_is_absent() {
230 let font = FontRef::new(VAR).unwrap();
231 let mvar = font.mvar().unwrap();
232 let coords = far();
233 let instance = mvar.at(&coords).unwrap();
234 assert!(instance.get(Tag::new(b"zzzz")).is_none());
235 }
236
237 #[test]
238 fn an_instance_keeps_a_fraction_the_single_accessor_drops() {
239 let font = FontRef::new(VAR).unwrap();
242 let mvar = font.mvar().unwrap();
243 let coords = [F2Dot14::from_f32(0.37); 12];
244 let instance = mvar.at(&coords).unwrap();
245 let fractional = mvar
246 .value_records()
247 .iter()
248 .filter_map(|record| instance.get(record.value_tag()))
249 .any(|delta| delta.to_bits() & 0xFFFF != 0);
250 assert!(fractional, "no metric delta carried a fraction");
251 }
252}