ianZiPu is a way to write notation for Guqin (古琴) music.

Related tags

AudioJianZiPu
Overview

JianZiPu Font

JianZiPu is a way to write notation for Guqin (古琴) music. This document will cover how to use this font, and how to contribute to its design.

Demo: https://neuralfirings.github.io/jianzipu/

Guqin Shorthand for JianZiPu entry

The core of this font is a series of components (think, letters in word) that overlaps to form characters. These letters are represented by unicode characters. To determine which unicode characters to use, we will need to compile a shorthand developed for this font. The compiler looks at:

  • Strings: represented by numbers outside of parentheses.
  • Hui position: represented by numbers inside parentheses, since huis are round and parentheses are round, like (7) or (6.7). Use (0) for open string.
  • Left hand positions: represented by the following: s,d,f,v since that's where the left hand fingers are on a (US-based) keyboard
  • Right hand positions: reprented by: njkl for plucks towards the player, huio away from the player
  • Chords (cuo): representedy by H (cuo), U (fan cuo), I (da cuo), O (da+fan cuo).
  • Li: represented by U

So a string like 6ks(9) would produce a character that represents...

  • 6 -- 6th string
  • k -- gou (pluck inward with the right middle finger)
  • s -- press the string with left hand 4th finger on...
  • (9) -- hui position 9

Now, if you just type this in the font you'll get a string of components, not the actual characters. To produce the actual character, you'll need a special compiler. It just so happens, I have included one in this package in the form of a webpage. If you clone this package and open the index.html file, you should get a text area for inputting the shorthand.

You can also find this compiler here: https://neuralfirings.github.io/jianzipu/

Usage on Websites

If you want to embed JianZiPu in your website, you can copy/paste the three files in the /dist folder and include them in your header.

">


   

Or, you can use the GitHub.io as CDN.

">


   

To render JianZiPu on your website:

  • jzp class: anything embedded in [[double brackets]] will be in JianZiPu string using the JZP font; anything in [[[triple brackets]]] will be converted to a JianZiPu charater using the JZP font
  • jzp-font class: anything here will be use the JianZiPu font

Example of a String:

[[6ks(9)]]
">

  
[[6ks(9)]]

Example of a Character:

[[[6ks(9)]]]
">

  
[[[6ks(9)]]]

Example of Using the Raw Font:


">

  


Usage as a Font

To use the font, install /dist/JianZiPu.otf file. You will still need a converter since the font itself uses unicodes in the 58000 range (per its html entity)

You can access the converter here: https://neuralfirings.github.io/jianzipu/

You type in the string (e.g., 3ks(7)), and then copy/paste the compiled characters.

You can also use the unicodes themselves, but this might get a bit unweildy.

Font Mechanics

This is the part where we go into the nitty gritty of how this font works, and how you can contribute in this project.

There are three main components to the font.

1. Character component graphics SVGs

These are the raw graphics (SVGs) that make up individual components in a JianZiPu character. These are stored in the /components folder. I use /font/JianZiPuComponents.sketch to organize my workspace and generate SVGf files in bulk.

2. Character map (charMap) JSON

This represents a "map" of how various components can be laid out in the character. The map is a JSON object with different areas. Each area has:

  • x: x coordinate of where the area starts relative to the top/left corner of the character
  • y: y coordinate of where the area starts relative to the top/left corner of the character
  • w: the width of the area
  • h: the height of the area
  • components: an array of components that can go into the area. Each component is an object with...
    • key: this represents what the compiler looks up. For example, the key 1 represents a component representing 1. The key k represents a gou component.
    • filename: this is the filename (SVG) for the component
    • unicode: this is the unicode to assign to the component
    • width: this is the width of the component. Most components have 0 as width, so the componenets can layer and stack on top of one another.
    • scale (optional): this is how we want to scale the component to fit its area. By default, it will scale horizontally and vertically to fit the area. There's also the option of using lockRatio so the component's ratio remains the same.

This map is present in /dist/jianzipu.js and /font/fontForgeScript.py.

3. Character rules (charRules) JSON

This map represents the rules used to compile the font from shorthand. It's a series of RegEx expressions which matches a particular string (e.g., if a hui position exists), and assigns which areas to the matching string.

The compiler then executes the areas in order. For example { regex: /[0-9]/, area: 'strFull'} is the first rule, which looks for the existance of numbers to assign it to the strFull area. Later rules will assign any numbers as areas specific to huis (if parentheses exists) or smaller areas in the component if things like left hand keys exists.

Font Compiling Instructions

These are the steps I use.

  1. Edit components
    • Open /font/JianZiPuComponents.sketch: select all / export as SVG (transparent background)
  2. Modify charMap variable in the /font/fontForgeScript.py file and the /dist/jianzipu.js file.
    • Make sure unicodes are unique and something in the 58000 range
    • To do this in Sublime (with Text Pastry plugin): highlight "unicode": > Ctrl+Cmd+G to select all > Scroll over to the unicodes and replace with > Package: Text Pastry Command Line, \i(58000,1)
  3. Modify charRules variable in the /dist/jianzipu.js file if rules need to be modified. Get comfy with RegEx.
  4. Create the font
    • Open JianZiPu.template.sfd, save as new version (ex: JianZiPu.v10.sfd) (also update the font version Edit > Font Info)
    • Modify /font/fontForgeScript.py so that it's pointing to the right directories for SVGs, and the right FontForge file
    • Open Python console (Ctrl + .) > copy/paste in fontForgeScript.py > run
    • Generate Font > select Open Type, save as .otf file (make sure Options > Open Type is checked)

Example of Shorthand

梧叶舞秋风

Here are the first few lines of my favorite Guqin piece to play, 梧叶舞秋风.

3fk(7) 4k 6vu(7) 3sk(9) 6vk(7) f(7)U7,6 5k 6vu(7) 3fk(7) 7vu(7) 6u 3s(9)k  
6vu(7) 3fk(7) 4k 5juv(7) 3fk(7) 5vu(7) 5juf(7) 3kf(7) 5vu(7) 4u 1kd(9)
4vk(7) 6vu(7) 3sk(9) 6vu(7) 4,3Uv(7) 4,3Uv(7) 2fk(7) 4vu(7) 3k 4sk(7.6)
7juv(6.2) \7jv(7) \7u sc(7.6) 6us(10.9) 
6V(7) 4kf(7) 5uv(7) 4uv(7.6) 2fk(7.6) \3v(7.9)k 4vk(7.6) 5u? sc(8.5) 3k(0) 5v(8.5)u 
4v(9)k 5v(8.5)u 4uv(9) sc(10) 3sk(10.8) 4vu(10) 2kf(10)? 3sk(10.8)

This generates

To Do

Should probably move this to use the Issues tracker in Github.

  • slides in cuo
  • Shuang1 Tan3 (in the Leaves)
  • insert random text in vertical order
  • Fix styling in the hui decimal

Credits/License

Code is licensed under The MIT License.

Font is licensed under Open Font License.

Font is adapted from the beautiful Ma Shan Zheng font.

A python wrapper for REAPER

pyreaper A python wrapper for REAPER (Robust Epoch And Pitch EstimatoR) Installation pip install pyreaper Demonstration notebnook http://nbviewer.jupy

Ryuichi Yamamoto 56 Dec 27, 2022
Sequencer: Deep LSTM for Image Classification

Sequencer: Deep LSTM for Image Classification Created by Yuki Tatsunami Masato Taki This repository contains implementation for Sequencer. Abstract In

Yuki Tatsunami 111 Dec 16, 2022
PianoPlayer - Automatic fingering generator for piano scores

PianoPlayer - Automatic fingering generator for piano scores

Marco Musy 571 Jan 02, 2023
Telegram Voice-Chat Bot Written In Python Using Pyrogram.

Telegram Voice-Chat Bot Telegram Voice-Chat Bot To Play Music From Various Sources In Your Group Support All linux based os. Windows Mac Diagram Requi

TheHamkerCat 314 Dec 29, 2022
Marsyas - Music Analysis, Retrieval and Synthesis for Audio Signals

Welcome to MARSYAS. MARSYAS is a software framework for rapid prototyping of audio applications, with flexibility and extensibility as primary concer

Marsyas Developers Group 364 Oct 31, 2022
Jarvis From Basic to Advance - make a voice assistant similar to JARVIS (in iron man movie)

JARVIS (Basic to Advance) This was my attempt to make a voice assistant similar to JARVIS (in iron man movie) Let's be honest, it's not as intelligent

codesempai 17 Dec 25, 2022
music library manager and MusicBrainz tagger

beets Beets is the media library management system for obsessive music geeks. The purpose of beets is to get your music collection right once and for

beetbox 11.3k Dec 31, 2022
A tool for retrieving audio in the past

Rewinder A tool for retrieving audio in the past. Ever felt like, I need to remember that discussion which happened 10 min back. Now you can! Rewind a

Bharat 1 Jan 24, 2022
A simple voice detection system which can be applied practically for designing a device with capability to detect a baby’s cry and automatically turning on music

Auto-Baby-Cry-Detection-with-Music-Player A simple voice detection system which can be applied practically for designing a device with capability to d

2 Dec 15, 2021
Sync Toolbox - Python package with reference implementations for efficient, robust, and accurate music synchronization based on dynamic time warping (DTW)

Sync Toolbox - Python package with reference implementations for efficient, robust, and accurate music synchronization based on dynamic time warping (DTW)

Meinard Mueller 66 Jan 02, 2023
This is a realtime voice translator program which gets input from user at any language and converts it to the desired language that the user asks

This is a realtime voice translator program which gets input from user at any language and converts it to the desired language that the user asks ...

Mohan Ram S 1 Dec 30, 2021
Use android as mic/speaker for ubuntu

Pulse Audio Control Panel Platforms Requirements sudo apt install ffmpeg pactl (already installed) Download Download the AppImage from release page ch

19 Dec 01, 2022
Voicefixer aims at the restoration of human speech regardless how serious its degraded.

Voicefixer aims at the restoration of human speech regardless how serious its degraded.

Leo 324 Dec 26, 2022
Reading list for research topics in sound event detection

Sound event detection aims at processing the continuous acoustic signal and converting it into symbolic descriptions of the corresponding sound events present at the auditory scene.

Soham 64 Jan 05, 2023
Python wrapper around sox.

pysox Python wrapper around sox. Read the Docs here. This library was presented in the following paper: R. M. Bittner, E. J. Humphrey and J. P. Bello,

Rachel Bittner 446 Dec 07, 2022
Python module for handling audio metadata

Mutagen is a Python module to handle audio metadata. It supports ASF, FLAC, MP4, Monkey's Audio, MP3, Musepack, Ogg Opus, Ogg FLAC, Ogg Speex, Ogg The

Quod Libet 1.1k Dec 31, 2022
AudioDVP:Photorealistic Audio-driven Video Portraits

AudioDVP This is the official implementation of Photorealistic Audio-driven Video Portraits. Major Requirements Ubuntu = 18.04 PyTorch = 1.2 GCC =

232 Jan 03, 2023
SU Music Player — The first open-source PyTgCalls based Pyrogram bot to play music in voice chats

SU Music Player — The first open-source PyTgCalls based Pyrogram bot to play music in voice chats Note Neither this, or PyTgCalls are fully

SU Projects 58 Jan 02, 2023
A Youtube audio player for your terminal

AudioLine A lightweight Youtube audio player for your terminal Explore the docs » View Demo · Report Bug · Request Feature · Send a Pull Request About

Haseeb Khalid 26 Jan 04, 2023
Pyrogram bot to automate streaming music in voice chats

Pyrogram bot to automate streaming music in voice chats Help If you face an error, want to discuss this project or get support for it, join it's group

Roj 124 Oct 21, 2022