Standard Music Font Layout (SMuFL)

https://w3c.github.io/smufl/latest
Admin
SMuFL is a specification that provides a standard way of mapping thousands of musical symbols...
Tokens:22,646
Snippets:81
Trust Score:8.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### SMuFL Ligature Structure Example (JSON)

Source: https://w3c.github.io/smufl/latest/specification/ligatures

An example excerpt from a SMuFL font metadata file demonstrating the 'ligatures' structure. It shows how to define a ligature with its code point and the sequence of component glyphs.

```json
{
  "ligatures": {
    "accidentalDoubleFlatParens": {
      "codepoint": "U+F530",
      "componentGlyphs": [
        "accidentalParensLeft",
        "accidentalDoubleFlat",
        "accidentalParensRight"
      ]
    }
  }
}
```

--------------------------------

### Engraving Defaults Structure Example

Source: https://w3c.github.io/smufl/latest/print

This snippet shows a partial example of the 'engravingDefaults' JSON structure. It includes common properties like 'textFontFamily', 'staffLineThickness', and others, illustrating their typical usage and data types. These defaults are crucial for consistent music engraving.

```json
{
  "engravingDefaults": {
    "textFontFamily" : [ "Academico", "Century Schoolbook", "serif" ],
    "staffLineThickness": 0.1,
    "stemThickness": 0.1,
    "beamThickness": 0.5,
    "beamSpacing": 0.25,
    "legerLineThickness": 0.2,
    "legerLineExtension": 0.2,
    ...
  },
  ...
}
```

--------------------------------

### SMuFL Ligature Construction Examples

Source: https://w3c.github.io/smufl/latest/print

Illustrates the construction of various musical ligatures using SMuFL glyphs. Each example specifies the sequence of glyphs and control characters required to form a particular musical shape, such as a Podatus or a Climacus. These are sequences of glyph names, not executable code.

```plaintext
chantPodatusLower + chantConnectingLineAsc3rd + (staffPosRaise3) + chantPodatusUpper
chantPunctumVirgaReversed + (staffPosLower4) chantConnectingLineAsc4th + (staffPosLower4) + chantPunctum
chantPunctum + (staffPosRaise1) + chantPodatusLower + (staffPosRaise1) + chantConnectingLineAsc2nd + (staffPosRaise2) + chantPodatusUpper
chantPunctumVirga + (staffPosLower1) + chantPunctumInclinatum + (staffPosLower2) + chantPunctumInclinatum
chantPunctum + (staffPosRaise1) + chantPunctum + chantPunctum
chantEntryLineAsc5th + (staffPosRaise5) + chantLigaturaDesc4th + (staffPosRaise1) + chantConnectingLineAsc3rd + (staffPosRaise4) + chantPunctum
chantPodatusLower + (staffPosRaise1) + chantConnectingLineAsc2nd + (staffPosRaise2) + chantPodatusUpper + chantPunctumVirga + chantConnectingLineAsc3rd + chantPunctum
chantConnectingLineAsc3rd + (staffPosRaise3) + chantLigaturaDesc3rd + chantPunctumVirga + chantConnectingLineAsc3rd + chantPunctum
chantPunctumVirga + (staffPosRaise1) + chantPunctumInclinatum + chantPunctumInclinatum + (staffPosRaise1) + chantPunctum
chantPunctum + (staffPosRaise1) + chantPunctum + chantPunctum + (staffPosRaise1) + chantPunctumVirga
chantPodatusLower + (staffPosRaise1) + chantConnectingLineAsc2nd + (staffPosRaise2) + chantPodatusUpper + chantPunctumInclinatum + (staffPosLower1) + chantPunctumInclinatum
chantPodatusLower + (staffPosRaise1) + chantConnectingLineAsc3rd + (staffPosRaise3) + chantPodatusUpper chantPodatus3rd + (staffPosRaise4) + chantPodatusLower + (staffPosRaise5) + chantConnectingLineAsc2nd + (staffPosRaise6) + chantPodatusUpper
chantAuctumAsc + (staffPosRaise1) + chantDeminutemUpper
chantConnectingLineAsc3rd + (staffPosRaise3) + chantAuctumDesc + (staffPosRaise2) + chantDeminutemLower
chantPunctum + chantConnectingLineAsc4th + (staffPosRaise4) + chantAuctumDesc + (staffPosRaise3) + chantDeminutemLower
chantPunctumVirgaReversed + (staffPosLower1) + chantAuctumAsc + (staffPosRaise1) + chantDeminutemUpper
chantPunctum + (staffPosRaise1) + chantAuctumAsc + + (staffPosRaise1) + chantConnectingLineAsc3rd + (staffPosRaise4) + chantDeminutemUpper
```

--------------------------------

### SMuFL Glyph Classes Example (JSON)

Source: https://w3c.github.io/smufl/latest/print

An excerpt from the classes.json file, demonstrating how glyphs are grouped into arrays under keys like 'clefs', 'noteheads', and 'flags'. This structure allows software to easily access and manage sets of related musical symbols.

```json
{
  "clefs": [
    "gClef",
    "gClef15mb",
    "gClef8vb",
    "gClef8va",
    "gClef15ma",
    "gClef8vbOld",
    "gClef8vbCclef",
    ...
  ],
  "noteheads": [
    "noteheadDoubleWhole",
    "noteheadWhole",
    "noteheadHalf",
    "noteheadBlack",
    "noteheadNull",
    ...
  ],
  "flags": [
    "flag8thUp",
    "flag8thDown",
    "flag16thUp",
    "flag16thDown",
    "flag32ndUp",
    "flag32ndDown",
    ...
  ],
  ...
}
```

--------------------------------

### SMuFL Font Metadata: Optional Glyphs Structure Example

Source: https://w3c.github.io/smufl/latest/print

An example excerpt from a SMuFL font metadata file showcasing the 'optionalGlyphs' structure. This structure lists all optional glyphs, providing their code points and an array of associated classes, which helps in identifying private or specialized glyphs.

```json
{
  ...
  "optionalGlyphs": {
    "accdnPushAlt": {
      "classes": [],
      "codepoint": "U+F45B"
    },
    "accidentalDoubleFlatJoinedStems": {
      "classes": [
        "accidentals",
        "accidentalsSagittalMixed",
        "accidentalsStandard",
        "combiningStaffPositions"
      ],
      "codepoint": "U+F4A1"
    },
    "accidentalDoubleFlatParens": {
      "codepoint": "U+F566"
    },
    ...
  },
  ...
}
```

--------------------------------

### SMuFL Font Metadata: Sets Structure Example

Source: https://w3c.github.io/smufl/latest/print

An example excerpt from a SMuFL font metadata file illustrating the 'sets' structure. This structure defines stylistic sets, their types (e.g., optical variants, flag styles), descriptions, and lists of glyphs including code points, names, and alternateFor properties.

```json
{
...
  "sets": {
    "ss01": {
      "type": "opticalVariantsSmall",
      "description": "Smaller optical size for small staves",
      "glyphs": [
        {
          "codepoint": "U+F428",
          "name": "accidentalFlatSmall",
          "alternateFor": "accidentalFlat"
        },
        {
          "codepoint": "U+F429",
          "name": "accidentalNaturalSmall",
          "alternateFor": "accidentalNatural"
        },
        {
          "codepoint": "U+F42A",
          "name": "accidentalSharpSmall",
          "alternateFor": "accidentalSharp"
        },
        ...
      ],
    },
    "ss02": {
      "type": "FlagsShort",
      "description": "Short flags (to avoid augmentation dots)",
      "glyphs": [
        {
          "codepoint": "U+F411",
          "name": "flag8thUpShort",
          "alternateFor": "flag8thUp"
        },
        {
          "codepoint": "U+F414",
          "name": "flag16thUpShort",
          "alternateFor": "flag16thUp"
        },
        ...
      ],
    },
  ...
  }
...
}
```

--------------------------------

### SMuFL Glyph Advance Widths Structure Example (JSON)

Source: https://w3c.github.io/smufl/latest/specification/glyphadvancewidths

An example excerpt from a SMuFL font metadata file, showcasing the 'glyphAdvanceWidths' structure. This JSON object maps specific glyph names to their calculated advance widths in staff spaces.

```json
{
...
  "glyphAdvanceWidths":
  {
    "analyticsNebenstimme": 2.836,
    "figbass9": 0.944,
    "pictBeaterSoftBassDrumDown": 1.28,
    "wiggleCircularEnd": 0.648,
  ...
  }
}
```

--------------------------------

### SMuFL engravingDefaults Structure Example

Source: https://w3c.github.io/smufl/latest/specification/engravingdefaults

This JSON snippet demonstrates a portion of the engravingDefaults structure. It includes configurations for text font families and various line and stem thicknesses, as recommended by SMuFL. These values are typically expressed in staff spaces.

```json
{
  "engravingDefaults": {
    "textFontFamily" : [ "Academico", "Century Schoolbook", "serif" ],
    "staffLineThickness": 0.1,
    "stemThickness": 0.1,
    "beamThickness": 0.5,
    "beamSpacing": 0.25,
    "legerLineThickness": 0.2,
    "legerLineExtension": 0.2
  }
}
```

--------------------------------

### SMuFL glyphAdvanceWidths Structure Example

Source: https://w3c.github.io/smufl/latest/print

This JSON snippet demonstrates the structure of 'glyphAdvanceWidths' within a SMuFL font metadata file. It maps glyph names to their corresponding advance widths, measured in staff spaces. Note that glyphs can have negative side-bearings, which are not included in the advance width.

```json
{
  "glyphAdvanceWidths":
  {
    "analyticsNebenstimme": 2.836,
    "figbass9": 0.944,
    "pictBeaterSoftBassDrumDown": 1.28,
    "wiggleCircularEnd": 0.648
  }
}
```

--------------------------------

### SMuFL Optional Glyphs Structure Example (JSON)

Source: https://w3c.github.io/smufl/latest/specification/optionalglyphs

This JSON excerpt demonstrates the structure of 'optionalGlyphs' in SMuFL metadata. It shows how optional glyphs are identified by name, with their Unicode codepoint and associated classes specified. This allows applications to manage and display glyphs not part of the core SMuFL ranges.

```json
{
  "...",
  "optionalGlyphs": {
    "accdnPushAlt": {
      "classes": [],
      "codepoint": "U+F45B"
    },
    "accidentalDoubleFlatJoinedStems": {
      "classes": [
        "accidentals",
        "accidentalsSagittalMixed",
        "accidentalsStandard",
        "combiningStaffPositions"
      ],
      "codepoint": "U+F4A1"
    },
    "accidentalDoubleFlatParens": {
      "codepoint": "U+F566"
    },
    "..."
  },
  "..."
}
```

--------------------------------

### SMuFL Font Metadata Sets Structure Example (JSON)

Source: https://w3c.github.io/smufl/latest/specification/sets

This JSON excerpt demonstrates the 'sets' structure within SMuFL font metadata. It defines stylistic sets (e.g., ss01, ss02), their types (e.g., opticalVariantsSmall, FlagsShort), descriptions, and a list of glyphs including codepoint, name, and alternateFor information. This is crucial for applications to interpret and use advanced typographic features in music fonts.

```json
{
  "sets": {
    "ss01": {
      "type": "opticalVariantsSmall",
      "description": "Smaller optical size for small staves",
      "glyphs": [
        {
          "codepoint": "U+F428",
          "name": "accidentalFlatSmall",
          "alternateFor": "accidentalFlat"
        },
        {
          "codepoint": "U+F429",
          "name": "accidentalNaturalSmall",
          "alternateFor": "accidentalNatural"
        },
        {
          "codepoint": "U+F42A",
          "name": "accidentalSharpSmall",
          "alternateFor": "accidentalSharp"
        }
      ]
    },
    "ss02": {
      "type": "FlagsShort",
      "description": "Short flags (to avoid augmentation dots)",
      "glyphs": [
        {
          "codepoint": "U+F411",
          "name": "flag8thUpShort",
          "alternateFor": "flag8thUp"
        },
        {
          "codepoint": "U+F414",
          "name": "flag16thUpShort",
          "alternateFor": "flag16thUp"
        }
      ]
    }
  }
}
```

--------------------------------

### JSON Structure for SMuFL Glyph Ranges

Source: https://w3c.github.io/smufl/latest/specification/ranges

This JSON excerpt defines a 'ranges.json' structure used in SMuFL to categorize music glyphs. It includes a description, a list of glyph names, and the start and end Unicode code points for a given range. This format helps in organizing and referencing glyphs within fonts.

```json
{
  "analytics": {
    "description": "Analytics",
    "glyphs": [
      "analyticsHauptstimme",
      "analyticsNebenstimme",
      "analyticsStartStimme",
      "analyticsEndStimme",
      "analyticsTheme",
      "analyticsThemeRetrograde",
      "analyticsThemeRetrogradeInversion",
      "analyticsThemeInversion",
      "analyticsTheme1",
      "analyticsInversion1"
    ],
    "range_end": "U+E86F",
    "range_start": "U+E860"
  }
}
```

--------------------------------

### SMuFL glyphnames.json Excerpt - Barline Glyphs

Source: https://w3c.github.io/smufl/latest/specification/glyphnames

This JSON excerpt from glyphnames.json demonstrates the mapping of SMuFL code points to canonical glyph names for various barline types. It includes 'codepoint', 'alternateCodepoint', and 'description' for each glyph.

```json
{
  "barlineDashed": {
    "alternateCodepoint": "U+1D104",
    "codepoint": "U+E036",
    "description": "Dashed barline"
  },
  "barlineDotted": {
    "codepoint": "U+E037",
    "description": "Dotted barline"
  },
  "barlineDouble": {
    "alternateCodepoint": "U+1D101",
    "codepoint": "U+E031",
    "description": "Double barline"
  },
  "barlineFinal": {
    "alternateCodepoint": "U+1D102",
    "codepoint": "U+E032",
    "description": "Final barline"
  },
  "barlineHeavy": {
    "codepoint": "U+E034",
    "description": "Heavy barline"
  }
}
```

--------------------------------

### SMuFL Glyph Classes in classes.json (JSON)

Source: https://w3c.github.io/smufl/latest/specification/classes

This JSON snippet illustrates the structure of classes.json, showcasing how glyphs are organized into categories such as 'clefs', 'noteheads', and 'flags'. It demonstrates the use of arrays to list glyph names within each class, facilitating programmatic access and manipulation of musical symbols.

```json
{
  "clefs": [
    "gClef",
    "gClef15mb",
    "gClef8vb",
    "gClef8va",
    "gClef15ma",
    "gClef8vbOld",
    "gClef8vbCclef",
    ...
  ],
  "noteheads": [
    "noteheadDoubleWhole",
    "noteheadWhole",
    "noteheadHalf",
    "noteheadBlack",
    "noteheadNull",
    ...
  ],
  "flags": [
    "flag8thUp",
    "flag8thDown",
    "flag16thUp",
    "flag16thDown",
    "flag32ndUp",
    "flag32ndDown",
    ...
  ],
...
}
```

--------------------------------

### Glyph Bounding Box Data Structure (JSON)

Source: https://w3c.github.io/smufl/latest/print

The 'glyphBBoxes' structure within a SMuFL metadata file defines the bounding box for each glyph. It uses the glyph name as a key and provides coordinates for the bottom-left ('bBoxSW') and top-right ('bBoxNE') corners of the bounding rectangle, expressed in staff spaces relative to the glyph origin. This data is crucial for graphical and spacing calculations in music notation software.

```json
{
  "glyphBBoxes":
  {
    "brace": {
      "bBoxNE": [
        0.328,
        3.988
      ],
      "bBoxSW": [
        0.008,
        0.0
      ]
    },
    "braceFlat": {
      "bBoxNE": [
        0.36,
        4.084
      ],
      "bBoxSW": [
        0.0,
        0.004
      ]
    }
  }
}
```

--------------------------------

### SMuFL Ictus Glyphs

Source: https://w3c.github.io/smufl/latest/print

Lists SMuFL glyphs for indicating musical stress (ictus). It provides the glyph character, its Unicode codepoint, and a descriptive name for each type of ictus, whether placed above or below the staff.

```json
[
  {
    "glyph": "",
    "unicode": "U+E9D0",
    "description": "chantIctusAbove"
  },
  {
    "glyph": "",
    "unicode": "U+E9D1",
    "description": "chantIctusBelow"
  }
]
```

--------------------------------

### SMuFL Augmentum (Mora) Glyph

Source: https://w3c.github.io/smufl/latest/print

Provides information on the SMuFL glyph used to indicate a mora (augmentation) in musical notation. This includes the glyph character, its Unicode codepoint, and its descriptive name.

```json
[
  {
    "glyph": "",
    "unicode": "U+E9D9",
    "description": "chantAugmentum"
  }
]
```

--------------------------------

### JSON Structure for Glyphs with Alternates

Source: https://w3c.github.io/smufl/latest/specification/glyphswithalternates

This JSON structure defines glyphs that have stylistic alternates. For each glyph, it lists available alternates with their respective codepoints and names. This serves as a fallback for applications not supporting advanced font features.

```json
{
  "...",
  "glyphsWithAlternates": {
    "flag8thUp": {
      "alternates": [
        {
          "codepoint": "U+F410",
          "name": "flag8thUpStraight"
        },
        {
          "codepoint": "U+F411",
          "name": "flag8thUpShort"
        }
      ]
    },
    "gClef": {
      "alternates": [
        {
          "codepoint": "U+F470",
          "name": "gClefSmall"
        }
      ]
    },
  "..."
}
```
Tokens:
Raw