obstudio / thuliummusic-wl Goto Github PK

Wolfram Language version of Thulium Music

Mathematica 96.34% JavaScript 3.66%

mathematica music-player synthesizer electronic-music wolfram-language music midi thulium-music

thuliummusic-wl's Introduction

Thulium Music Player (Wolfram Language Version)

Thulium Music Player is a simple program aimed to play textualized music on any platforms or devices.
铥铥播放器是一个旨在在任何平台和设备上播放文本化音乐的程序。

This repository is a Wolfram Language Version for Mathematica users.
这个仓库是该播放器的 Wolfram 语言版本，为 Mathematica 用户使用。

Watch our propaganda film on Bilibili.
在 Bilibili 上观看我们的宣传片。

Installation / 安装

The following steps require Internet connection. 下面的步骤将需要网络链接。

To run Thulium Music Player, you need to install Mathematica and Node.js first.
为了运行铥铥播放器，你需要首先安装 Mathematica 和 Node.js。

After installation, you need to switch to the library directory, open the terminal and run the following commands:
安装完成后，你需要切到library目录下，打开终端并输入下列指令：

For Windows:

npm init
cd %USERPROFILE%
npm i zeromq -g
ren node_modules .node_modules

For MacOS and Linux:

npm init
cd ~
npm i zeromq -g
mv node_modules .node_modules

Then you are ready to run Thulium Music Player. Open Thulium.nb with Mathematica, and follow the hint to enjoy the music.
这样就完成了所有的安装步骤。现在你可以点开Thulium.nb文件，按照软件中的提示来欣赏音乐了。

When the program is first run, it may takes some time to initialize. 当程序首次运行时，可能要花费一定的初始化时间。

Exception handling / 异常处理

If the program reports an error and does not run properly, you may try the following steps.
当程序在运行时报告了错误信息并无法运行，你可以尝试采取下面的步骤。

Check your Mathematica version. Make sure it is updated.
请检查你当前的 Mathematica 版本，确保它足够新以便能够执行程序中的所有命令。

Thulium Music Player uses some new functions in Mathematica 11.2, such as ExternalEvaluate and AudioStream. 铥铥播放器中使用了一些 Mathematica 11.2 中引进的新函数，包括 ExternalEvaluate 和 AudioStream。

Make sure Node.js and related packages has been installed. You can run a simple Mathematica program to check:
请确保 Node.js 以及相关的库已经被妥善地安装好了。你可以运行下面的 Mathematica 程序来测试是否已经全部安装完成。

session = StartExternalSession["NodeJS"]
ExternalEvaluate[session, "require('acorn')"]

Submit an issue with the question you have.
你也可以给我们提交一个 issue，在其中说明你遇到的问题。

Change log / 更新日志

2.3 (2018.5.5)
2.2 (2018.4.21)
2.1 (2018.4.1)

thuliummusic-wl's People

Contributors

Stargazers

Watchers

Forkers

ddffwyblxy

thuliummusic-wl's Issues

一些 Parser 优化

__oriDur在生成后已经没有必要了, 可以考虑其功能用StartTime代替
解决用户自定义数组不能正确extend()的问题
提供名为JoinTrack的 API 以帮助用户实现音轨的连接

部分歌曲存在加载错误的问题

七色光之歌等歌曲报错，可能是 RepeatEnd 错误
死体旅行等歌曲未报错但倚音渲染错误
风居住的街道出现未知错误 Token

Template Subtracks

目前的音轨头被允许在乐器后面任意地跟上函数 (当然仅仅是函数), 作为一个音轨的预处理部分. 那么如果要使用多个乐器共用的音轨中设置部分乐器的和弦环境, 又如何处理呢? "模板音轨"提供了一种解决方案.

模板音轨与正常的音轨语法完全相同, 但其中可能包含某种特定的宏音轨 (虽然不应该这么叫, 但是姑且这么说吧), 以保留字的形式呈现, 比如@0或者@_或者@this这样的 (还没定下来, 我就先以第一个为例了~)

正如你所见的那样, 模板音轨其实可以作为一个纯函数. 当它被调用时, 如果含有对应的参数, 则将该参数赋给当前的@0后执行. (具体的实现究竟是纯函数, 还是实体函数, 我个人认为都是可以的.)

那么在一个音轨的音轨头中, 如果我们允许函数和模板音轨, 并将函数组合理解成模板音轨处理, 那么就能够解决开始的问题了, 比如:
<Piano (100%) Oct(1)> => <Piano {(100%) Oct(1) @0}>
(这是程序的自然解读方式, 因而保证了兼容性.)

这样一来, 模板音轨{(100%) Oct(1) @0}才是这个音轨的本体, 当执行时将音轨的内容作为@0本身来处理, 于是我们就允许对于音轨整体进行更丰富的操作了.

下面是一个例子 (使用了@this):

<:env:> (80%) Dur(1) 1>51'51'5

< Guitar {(72%) Rest(24) @env: Oct(-1) @this},
  Strings {(60%) Oct(-2) Con(-1,0.8) @this @this},
  SlapBass {(64%) Oct(-3) Stac(1/2, 0) @this @this}
> 6--^|%--^|%--|7--|1'--^|%--|4--|5--|

这样就将三个相似但完全不同的音轨统一地表示了.

Initialize Thulium 点按无反应

但手动运行 Thulium.build.wl 后正常，请检查。

进度条拖动出现故障

Buffer加载时进度条错误

新内核上传后，发现了加载Buffer时进度条显示错误的情况。具体表现为：

当进度条加载到第二首歌曲时会迅速地跳回第一首，然后一直停留在第一首的状态
尽管如此，程序依旧处于加载过程中，一段时间后加载完成，进度条消失

如果有类似情况的同学发现了可能的原因，欢迎提供线索。

东方绀珠传 QYS转TM

全部完成后请@Kouchya 检查是否正确。

检查通过

东方绀珠传曲子一大堆待优化。。。

鉴于太多太杂，我就单独开个issue好了，原来的issue随它在冷风中飘

一些播放器的 bug

无法加载 paclet 导致无法初始化
UpdateImage 模块错误导致无法正常加载图片
播放器图片无法正常显示 tooltip

在新的电脑上运行时 Parser 无法正常工作

目前已有 3 例（ @Track07-cda @Anemonefish01 电脑上都出现了该问题）在之前没有运行过 QYMP 的电脑上出现 Parser 无法正常工作的情况（可能是 Audio[] 不能正常工作）。
是不是在使用 Audio[] 之前还需要做什么初始化工作？

东方地灵殿扒谱计划

TMD v2.0 全部语法

A More Systematic Argument System

随着语言的发展, 我认为我们的变量类型也是时候发生一些更新了. 更新前瞻: #39

新加入的成分充其量就是表达式和函数, 宏音轨类型. 如果上述对于表达式的描述有疑问, 或者是怀疑程序可行性, 以及可能存在的歧义问题, 可以联系我.

子音轨以及相关类型

子音轨, 以{...}区分, 与其 Token 记法一致
函数, 以标准函数记法Func(...)区分, 与其 Token 记法一致
宏音轨, 以@foo区分, 与其 Token 记法一致

表达式以及相关类型

表达式使用完全的解析取代过去的字符串传递模式, 允许数值函数的定义和调用, 以及四则运算和括号的使用.
Tokenizer 将返回一个 Expression 类型, 其 Content 属性包含了对齐内容的解析 (数组), 包含数字 (实数, 允许正负号和小数点, 分数线作为运算符处理), 运算符, 以及子表达式 (通过圆括号识别).
原则上允许单位, 但只写一个, 写在表达式的最后即可, 将作为表达式的 Unit 属性, 包含常见的Bar, Beat, Sec类型.

字符串以及相关类型

字符串, 以"..."区分, 与过去记法一致

数组以及相关类型

数组, 以[...]区分, 内部元素以逗号分隔, 与过去记法一致

Prolog & Epilog Functions

在目前的实践中, 一些功能在实现上可能与现有函数冲突, 另一些功能则较大地依赖于音轨 meta 属性导致不能直接用函数体现. 对于这样的问题, 我提出了一种解决方案供大家参考. 这种方案在目前协议的基础上开放用户添加和使用 meta 的接口.

实现

除了官方钦定的一部分 meta 外, 用户可以像添加 settings 那样自由添加 meta, 这些 meta 将作为音轨本身的属性传递到外层音轨中. 与此同时, 用户可以编写 Prolog 和 Epilog 函数. 这些函数将按照一定的顺序在运行一个 SubtrackParser 的之前和之后运行, 并改变当前音轨的信息. 这些函数(除非标准包内置)可以被声明跳过, 从而不被调用.

用途

Prolog 函数和 Epilog 函数相结合, 可以实现一些本来不被认为可以通过函数实现的功能. 踏板就是一个例子. 目前的一个问题是踏板并不能很好地处理 Overlay, 以及与函数内部读写相冲突的问题. 这种做法可以完美地被上述方案解决. 每一个音轨解析完成后, 直接对其内部的 PedalPress 和 PedalRelease 进行分析处理, 而音轨头的 PedalRelease 和音轨尾部的 PedalPress 则写入 meta, 然后像连音线一样处理.
一些用户功能可以被无冲突地实现. 比如如果现在考虑在原有的系统上加入节拍系统 (即每一小节按强弱渲染), 则不可避免地与一些函数产生矛盾 (比如在内部改变 bar 属性的 Tuplet 函数, 跨小节生成音乐的大量函数等). 而一个 Epilog 函数则能够在生成整个主音轨后依照拍数进行处理 (这一点与其他的 Epilog 不同, 可以通过设置这个 Epilog 为主音轨 Epilog 来实现), 从而避免了内部函数被错误地强化或是被二次强化的问题.

修复对文件名中单引号的支持

单引号在文件名中是合法的，但 new Thulium('...') 中使用了单引号作为字符串分隔符，导致文件无法正常解析。

Optimization for Void Track Detection

优化对空音轨的识别, 目标是:

能够分辨出子音轨中是否含有音符或者非空函数
力所能及的情况下检测音轨内的音轨调用的返回值是否为空

文档系统初步

坑有点大，慢慢做吧……

初次安装路径设置界面没有默认路径

当第一次运行程序并单击Initialize Thulium时，路径设置界面正常弹出但文本框内没有默认路径。

一些播放器 bug

Initialize 函数在非主界面的地方运行会报错
Effects 在单一音轨中失效

报错系统初步

建立报错系统的雏形，并实现基本的系统报错。

利用新的报错系统和规定的报错规范完成：

Note 相关
- Note::ChordRange 计算和弦时出现错误的范围
- Note::Reduplicate 和弦内存在重复的音
- Note::OutOfRegister 某一个音超出音域
- Note::NoPrevious 使用%时缺乏前置音符
- Note::VolumeLimit 音量超过上限
Track 相关
- Track::BarLength 小节长度错误
- Track::Instrument 声明了不存在的乐器
- Track::Undefined 发现了未知字符
- Track::Overlay 各Overlay部分的长度不一致
Sect 相关
- Sect::DiffDuration 各音轨长度不同
- Sect::InitiativeBar 各音轨的起始小节不等长
- Sect::Mismatch 相邻乐章的起始小节与终止小节不匹配

几个需要紧急处理的bug

特定情况下pitchQueue报错（怀疑是parser未同步）。
样例：<Piano>(Oct:-3)(84%)(6~){5o%%%%%}|4#(1=)4'#---|
有的音被延长到了当前音轨的最后。
样例：<PanFlute>(2^)3---^|%---|0---|0---|
% 的传递问题，希望能在一个音轨（暂时不跨音轨或乐章）中按时间顺序（程序执行的时间顺序，即在子音轨中就是播放的时间顺序，在函数中则是参数从左至右的顺序）传递，无论是否穿过子音轨

更改一些涉及拍数计算的处理

Tremolo2：如果subtrack1或2中含有pre和post，那么返回的音轨也应对应地进行处理。
Portamento：如果subtrack1或2中含有pre和post，那么返回的音轨也应对应地进行处理。
Tuplet：若读入的音轨有pre和post，则对应的拍数也应对应地进行处理。
/x:和/：由于它也是小节线的一种，应补上对于小节拍数的判定。

Unit System

对于以时间作为参数的函数, 用户往往有着不同的表达需求. 有时用户希望以"秒"为单位, 另一些时候以"拍"为单位则是更好的选择. 为了迎合这两种选择, 同时增强函数的复用性, 我建议允许用户在数字的后面跟上单位来表示这个时间量. 在 tokenizer 也相应地增加一个Unit标签. 举下面的例子:

FadeOut(1s) // 1秒
Extend({...}, 1b) // 1拍

大家对此有什么看法呢?

Thulium Music 2.4 计划内容

完成对 Pedal 和 Tie 的解耦，以及实现跨乐章支持
- 完成 pedal.tml
- 完成 tie.tml
- 跨乐章支持
重整 overlay 系统，修复 oriDur 的问题
- 重整 overlay 系统，允许踏板和连音线分配入每一个部分中
- 删除 oriDur 属性，所有相关内容全部用另外方法实现
使用新的 NoteParser 和音符系统
- 允许在方括号外使用 Chord (Tokenizer 已支持)
- 允许在音轨头定义音符宏，并取代 currentType 系统
规范类型系统：已经通过，将逐步取代过去的函数语法
参见：obstudio/ThuliumMusic-Tokenizer#1