Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 5.01 KB

1_Terminology.md

File metadata and controls

66 lines (46 loc) · 5.01 KB

Terminology

Here you'll find definitions of certain words used throughout the wiki

Composition/Compositions

An audio file that contains the necessary metadata to be played back by the Glyph Composer.

Dependencies

Dependencies are other programs which are needed so the Glyph Tools can do their jobs.

Glyph Tools location

The directory where you extracted the Glyph Tools in step 2 of the wiki (Downloading the Glyph Tools).

Label Track

In Audacity® you can have multiple Tracks in one project. A named [Label] can be placed on this Track to mark points of interest of an audio. More info here.

Label

A Label is placed on a [Label Track]. A Label has a starting and ending position and can be named. We differentiate between a [Point Label] and a [Region Label].

Point Label

A Point Label is a [Label] that has the same starting and ending position. See here.

Region Label

A Point Label is a [Label] that has a different starting and ending position. See here.

Glyph(s)

The Glyphs are the whole light segments on the back of the phones. In contrast stand the [Zones]. E.g.: The Nothing Phone (1) has 5 Glyphs.

Zone(s)

A Zone is one individually addressable light region. One [Glyph] can be one Zone or it can have multiple Zones inside. E.g.: The Nothing Phone (1) has 8 Zones in the USB Line [Glyph].

Glyph Format

This is a logic and naming scheme for the [Labels]. It explains in great detail on how to name your [Labels] in the Audacity® project so the [GlyphTranslator] can understand what you want to do with the [Glyphs]/[Zones].
It consists of four parts each separated by a dash (-):

  1. [glyphId]
  2. [lightLevelFrom]
  3. [lightLevelTo]
  4. [interpolationMode]

glyphId

Is the first part of the [Glyph Format] and tells the Glyph Tools which [Glyph]/[Zone] should be controlled. This is different for every device supported by the tools - see Explaining the Glyph Format for the detailed explanation.

lightLevelFrom

Is the second part of the [Glyph Format] and tells the Glyph Tools how bright (0% to 100%) the, with the [glyphId] selected, [Glyph]/[Zone] should be at the start of the [Label].

lightLevelTo

Is the third part of the [Glyph Format] and tells the Glyph Tools how bright (0% to 100%) the, with the [glyphId] selected, [Glyph]/[Zone] should be at the end of the [Label].

interpolationMode

Is the fourth part of the [Glyph Format] and tells the Glyph Tools how the brightness level should be interpolated (from [lightLevelFrom] to [lightLevelTo]) for the, with the [glyphId] selected, [Glyph]/[Zone] in the time given by the difference of the start and the end of the [Label] - see Explaining the Glyph Format for the detailed explanation.

GlyphTranslator

The GlyphTranslator (GlyphTranslator.py) is one of the many scripts that are part of the Glyph Tools. It takes in your exported [Labels] and spits out the [NGlyph File]. It is also possible to supply it with a [Watermark File].

NGlyph File

This is an itermediate (json) file which is generated by the [GlyphTranslator] and consumed by the [GlyphModder].

Watermark File

A simple text file (UTF-8 encoded) containing a watermark of the [composition] creator. It is optionally consumbed by the [GlyphTranslator].
The content of this file will be saved inside the [NGlyph File] and will also be saved as metadata to the [composition].

GlyphModder

The GlyphModder (GlyphModder.py) is one of the many scripts that are part of the Glyph Tools. It takes in your [NGlyph File] and your exported audio file and spits out the finished [composition].

Label File

A text file that contains all the exported [Labels] from an Audacity® project. More info here.