asciianything 0.0.0-stage → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 sloemo01
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,106 @@
1
- # Temporary Holding Version
1
+ # asciianything
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Turn any video into a mosaic of coloured lowercase prose — frame-accurate, full length, full resolution.
4
+
5
+ ```bash
6
+ npx asciianything night-drive.mp4
7
+ ```
8
+
9
+ ![night highway, source and ascii prose](https://raw.githubusercontent.com/sloemo01/asciianything/main/assets/comparison.png)
10
+
11
+ Not an `@%#*+=-:.` ramp. Every cell of the picture is one stable English word-character, the prose is readable up close, and at normal viewing distance the mosaic reads as the original footage: same framing, same colours, same exposure, same motion.
12
+
13
+ ![ascii frame](https://raw.githubusercontent.com/sloemo01/asciianything/main/assets/preview.png)
14
+
15
+ ## Why it looks like the video and not like text wallpaper
16
+
17
+ A glyph only covers part of its cell. Drawing the sampled source colour into the letter multiplies the source by the ink coverage and turns bright footage into a dark wall of text. So the renderer measures, for every character at every weight, how much of the cell it actually inks, and divides:
18
+
19
+ ```
20
+ emitted = scene / (coverage × calibration)
21
+ ```
22
+
23
+ Each glyph is therefore brighter than its source cell, and the **integrated cell** — letters plus the black gaps between them — averages back to the sampled colour in linear light. Bright regions stay bright; a blue sky stays blue instead of going navy.
24
+
25
+ The rest of the contract:
26
+
27
+ - **One fixed prose field.** A sentence bank is shuffled per row with a deterministic hash, so no row repeats the row above and every cell keeps the same character for the whole video. Only colour and glyph weight follow the scene.
28
+ - **Subcell sampling.** Each cell integrates a `cellW × cellH` block of the full-resolution frame, recovering percentiles and the bright-quartile colour, so a light smaller than a cell still lifts it.
29
+ - **Linear light.** sRGB is decoded to linear before any averaging or compensation, then encoded once on output.
30
+ - **No synthetic cinematography.** No zoom, pan, transitions, grain, vignette or animated font size. One source frame in, one rendered frame out.
31
+
32
+ ## Requirements
33
+
34
+ - Node 18+
35
+ - `ffmpeg` and `ffprobe` on `PATH`
36
+
37
+ ## Usage
38
+
39
+ ```bash
40
+ # whole video, same resolution / frame rate / duration
41
+ npx asciianything input.mp4 -o output.mp4
42
+
43
+ # bigger letters
44
+ npx asciianything input.mp4 --font-size 32
45
+
46
+ # one still as PNG (seconds into the video)
47
+ npx asciianything input.mp4 --still 8 -o frame.png
48
+
49
+ # preview the first 60 frames
50
+ npx asciianything input.mp4 --limit 60 -o preview.mp4
51
+
52
+ # your own prose instead of the bundled night-highway bank
53
+ npx asciianything input.mp4 --prose my-words.txt
54
+ ```
55
+
56
+ ### Options
57
+
58
+ | flag | default | meaning |
59
+ | --- | --- | --- |
60
+ | `-o, --out <file>` | `<input>-ascii.mp4` | output path |
61
+ | `--font-size <px>` | `20` | glyph size in output pixels; cells are `0.6 × fs` wide, `1.12 × fs` tall |
62
+ | `--cell-ratio <r>` | `1.12` | cell height ÷ font size |
63
+ | `--weights <a,b,…>` | `400,500,600,700,800` | font weights available to the atlas |
64
+ | `--weight-min / --weight-max` | `600` / `800` | weight range chosen from scene luminance |
65
+ | `--stroke <px>` | `0.5` | extra outline that raises ink coverage |
66
+ | `--calibration <n>` | `0.86` | ink-coverage calibration for the final composite |
67
+ | `--diffusion <n>` | `0.1` | base softening of ink into the gaps |
68
+ | `--diffusion-adaptive <n>` | `0.25` | extra softening for bright cells (tames highlight clipping) |
69
+ | `--detail <n>` | `0.14` | subcell luminance recovery |
70
+ | `--color-detail <n>` | `0.1` | subcell colour recovery |
71
+ | `--prose <file>` | bundled bank | `.txt` (sentences) or `.json` (array of sentences) |
72
+ | `--crf <n>` / `--preset <p>` | `17` / `slow` | x264 quality and speed |
73
+ | `--still <seconds>` | — | render a single PNG instead |
74
+ | `--limit <n>` | — | stop after n frames |
75
+ | `--info` | — | print grid, cell size and measured coverage |
76
+
77
+ ## The bundled look
78
+
79
+ `assets/prose.json` holds 1,844 deterministic sentences about night highways, sodium light, lane dashes and distant towers. It is the house voice for the demo — pass `--prose` to write your own. Any lowercase English works; longer sentences read better at small font sizes.
80
+
81
+ ![prose detail](https://raw.githubusercontent.com/sloemo01/asciianything/main/assets/detail.png)
82
+
83
+ ## Demo
84
+
85
+ `assets/demo.mp4` — 1440×2560, 29.97 fps, 19.42 s, rendered from a night freeway clip at `--font-size 20` (120 × 117 cells, 14,040 characters). The MP4 was produced by this package's renderer and encoder path.
86
+
87
+ ## How it is built
88
+
89
+ - `src/atlas.js` rasterises every character at every weight through Skia (`@napi-rs/canvas`), supersampled 4× and box-averaged down to the cell pitch, then measures the real ink coverage of each tile.
90
+ - `src/render.js` samples the frame, computes per-cell linear colour and luminance, picks a weight, divides by measured coverage, and composites the ink into an RGB buffer.
91
+ - `src/prose.js` builds the fixed character field from the sentence bank.
92
+ - `src/cli.js` pipes raw frames from `ffmpeg` into the renderer and rendered frames straight into `libx264`, so no intermediate frame sequence ever touches disk.
93
+
94
+ Rendering is deterministic: same input frame and settings produce the same output frame.
95
+
96
+ ## Limits
97
+
98
+ Large glyphs mean fewer cells, and a cell can only average as bright as its ink coverage allows. Very bright, very large highlights (a full-white sky at `--font-size 32`) will top out below the source; lowering `--calibration` brightens the whole mosaic, raising it darkens it. Small font sizes preserve more detail and read as a finer texture.
99
+
100
+ ## Credits
101
+
102
+ Demo footage: [Night Traffic Flow in Urban Highway View](https://www.pexels.com/video/night-traffic-flow-in-urban-highway-view-35835506/) by [Sururi Ballıdağ](https://www.pexels.com/@drector/), used under the [Pexels license](https://www.pexels.com/license/). `assets/demo.mp4` is the ASCII derivative of that clip.
103
+
104
+ ## Licence
105
+
106
+ MIT for the code. The bundled JetBrains Mono font is SIL OFL 1.1 — see `assets/OFL.txt`.
package/assets/OFL.txt ADDED
@@ -0,0 +1,93 @@
1
+ Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono)
2
+
3
+ This Font Software is licensed under the SIL Open Font License, Version 1.1.
4
+ This license is copied below, and is also available with a FAQ at:
5
+ https://openfontlicense.org
6
+
7
+
8
+ -----------------------------------------------------------
9
+ SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10
+ -----------------------------------------------------------
11
+
12
+ PREAMBLE
13
+ The goals of the Open Font License (OFL) are to stimulate worldwide
14
+ development of collaborative font projects, to support the font creation
15
+ efforts of academic and linguistic communities, and to provide a free and
16
+ open framework in which fonts may be shared and improved in partnership
17
+ with others.
18
+
19
+ The OFL allows the licensed fonts to be used, studied, modified and
20
+ redistributed freely as long as they are not sold by themselves. The
21
+ fonts, including any derivative works, can be bundled, embedded,
22
+ redistributed and/or sold with any software provided that any reserved
23
+ names are not used by derivative works. The fonts and derivatives,
24
+ however, cannot be released under any other type of license. The
25
+ requirement for fonts to remain under this license does not apply
26
+ to any document created using the fonts or their derivatives.
27
+
28
+ DEFINITIONS
29
+ "Font Software" refers to the set of files released by the Copyright
30
+ Holder(s) under this license and clearly marked as such. This may
31
+ include source files, build scripts and documentation.
32
+
33
+ "Reserved Font Name" refers to any names specified as such after the
34
+ copyright statement(s).
35
+
36
+ "Original Version" refers to the collection of Font Software components as
37
+ distributed by the Copyright Holder(s).
38
+
39
+ "Modified Version" refers to any derivative made by adding to, deleting,
40
+ or substituting -- in part or in whole -- any of the components of the
41
+ Original Version, by changing formats or by porting the Font Software to a
42
+ new environment.
43
+
44
+ "Author" refers to any designer, engineer, programmer, technical
45
+ writer or other person who contributed to the Font Software.
46
+
47
+ PERMISSION & CONDITIONS
48
+ Permission is hereby granted, free of charge, to any person obtaining
49
+ a copy of the Font Software, to use, study, copy, merge, embed, modify,
50
+ redistribute, and sell modified and unmodified copies of the Font
51
+ Software, subject to the following conditions:
52
+
53
+ 1) Neither the Font Software nor any of its individual components,
54
+ in Original or Modified Versions, may be sold by itself.
55
+
56
+ 2) Original or Modified Versions of the Font Software may be bundled,
57
+ redistributed and/or sold with any software, provided that each copy
58
+ contains the above copyright notice and this license. These can be
59
+ included either as stand-alone text files, human-readable headers or
60
+ in the appropriate machine-readable metadata fields within text or
61
+ binary files as long as those fields can be easily viewed by the user.
62
+
63
+ 3) No Modified Version of the Font Software may use the Reserved Font
64
+ Name(s) unless explicit written permission is granted by the corresponding
65
+ Copyright Holder. This restriction only applies to the primary font name as
66
+ presented to the users.
67
+
68
+ 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69
+ Software shall not be used to promote, endorse or advertise any
70
+ Modified Version, except to acknowledge the contribution(s) of the
71
+ Copyright Holder(s) and the Author(s) or with their explicit written
72
+ permission.
73
+
74
+ 5) The Font Software, modified or unmodified, in part or in whole,
75
+ must be distributed entirely under this license, and must not be
76
+ distributed under any other license. The requirement for fonts to
77
+ remain under this license does not apply to any document created
78
+ using the Font Software.
79
+
80
+ TERMINATION
81
+ This license becomes null and void if any of the above conditions are
82
+ not met.
83
+
84
+ DISCLAIMER
85
+ THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88
+ OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89
+ COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90
+ INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91
+ DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92
+ FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93
+ OTHER DEALINGS IN THE FONT SOFTWARE.