abcfajs 0.1.0

package/LICENSE

@@ -0,0 +1,128 @@
+MIT License
+
+Copyright (c) 2026 Samyar Modaber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-------------------------------------------------------------------------------
+Third-party notices
+-------------------------------------------------------------------------------
+
+abcjs (bundled in dist/abcfajs.min.js)
+Copyright (c) 2009-2026 Paul Rosen and Gregory Dyke. MIT License.
+https://github.com/paulrosen/abcjs
+
+Koron and sori glyph outlines (src/glyphs.ts) are derived from the Bravura font
+by Steinberg Media Technologies GmbH, licensed under the SIL Open Font License,
+Version 1.1, reproduced below.
+https://github.com/steinbergmedia/bravura
+
+Copyright © 2019, Steinberg Media Technologies GmbH (http://www.steinberg.net/),
+with Reserved Font Name "Bravura".
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION AND CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/README.md

@@ -0,0 +1,104 @@
+# abcfajs
+
+[abcjs](https://www.npmjs.com/package/abcjs) with the Persian microtonal accidentals **koron** (کرن) and **sori** (سری).
+
+abcfajs is abcjs with one change: quarter-tone accidentals are drawn with the koron and sori signs used in Persian music notation. Everything else works the same as in abcjs, including rendering, playback, MIDI and the editor. Koron and sori notes play at their microtonal pitch.
+
+| ABC   | Sign  | Name          | Pitch          |
+| ----- | ----- | ------------- | -------------- |
+| `_/B` | koron | کرن           | −50 cents      |
+| `^/F` | sori  | سری           | +50 cents      |
+
+`_/` and `^/` are the standard ABC 2.1 quarter-tone accidentals. ABC tunes you already have that use them work without changes.
+
+## Install
+
+```sh
+npm install abcfajs
+```
+
+## Usage
+
+`abcfajs` has the same API as `abcjs`. To switch, change the import:
+
+```js
+import abcjs from 'abcfajs'; // instead of: import abcjs from 'abcjs'
+
+abcjs.renderAbc('paper', `X:1
+T:Koron & Sori
+M:4/4
+L:1/4
+K:C _/A _B
+G _/A B c | d _/e ^/f g |]`);
+```
+
+Named exports and CommonJS work too:
+
+```js
+import { renderAbc, synth, KORON, SORI } from 'abcfajs';
+const abcjs = require('abcfajs');
+```
+
+### In the browser with a `<script>` tag
+
+`abcfajs.min.js` has abcjs built in and defines the same `ABCJS` global as `abcjs-basic-min.js`, so you can swap one file for the other:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/abcfajs/dist/abcfajs.min.js"></script>
+<script>
+  ABCJS.renderAbc('paper', 'X:1\nK:C\n_/B ^/c d2|]');
+</script>
+```
+
+## Writing koron and sori
+
+- **On a note:** put `_/` (koron) or `^/` (sori) in front of it, the same way you would write `_` or `^`.
+- **In the key signature:** list the accidentals after the key, for example `K:C _/A _B` for A-koron and B-flat. Starting from `C` means no other sharps or flats are added.
+- **Within a bar:** a koron or sori lasts until the next bar line, like any other accidental. Write `=` to cancel it.
+
+```abc
+X:1
+T:Chahargah (C)
+L:1/8
+K:C _/D _/A
+C D E F G A B c |]
+```
+
+## API
+
+On top of the full abcjs API, abcfajs exports:
+
+| Export                        | Description                                                         |
+| ----------------------------- | ------------------------------------------------------------------- |
+| `KORON`                       | `'_/'`                                                              |
+| `SORI`                        | `'^/'`                                                              |
+| `koron(note)`                 | `koron('B')` → `'_/B'`                                              |
+| `sori(note)`                  | `sori('f')` → `'^/f'`                                               |
+| `KORON_GLYPH`, `SORI_GLYPH`   | The glyph outlines, in abcjs `setGlyph` format                       |
+| `installPersianAccidentals()` | Installs the glyphs again. This runs automatically on import.        |
+
+To use your own drawings of the signs, call `setGlyph('accidentals.halfflat', glyph)` (koron) or `setGlyph('accidentals.halfsharp', glyph)` (sori).
+
+TypeScript types come with the package. All abcjs types are re-exported, for example `import type { TuneObject } from 'abcfajs'`.
+
+## Limitations
+
+- Koron and sori always play exactly a quarter tone (50 cents) away from the natural note. In real performance the interval varies by dastgah and by player. abcjs only supports ±50 cents.
+- Importing abcfajs changes the quarter-tone glyphs everywhere abcjs is used in your app, because abcjs stores glyphs globally.
+
+## Development
+
+```sh
+npm install
+npm test          # builds, then runs the tests
+open example/index.html
+```
+
+## Credits
+
+- [abcjs](https://github.com/paulrosen/abcjs) by Paul Rosen and Gregory Dyke (MIT)
+- The koron and sori outlines come from the [Bravura](https://github.com/steinbergmedia/bravura) SMuFL font by Steinberg (SIL OFL 1.1)
+
+## License
+
+MIT. See [LICENSE](LICENSE) for the third-party notices.