@chronocide/id3v2 0.0.1 → 0.1.0

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/README.md CHANGED
@@ -40,8 +40,14 @@ npm i @chronocide/id3v2
40
40
  ### Example
41
41
 
42
42
  ```ts
43
- import parse from '@chronocide/id3v2';
43
+ import parse, { frames } from '@chronocide/id3v2';
44
44
  import fsp from 'fs/promises';
45
45
 
46
- const frames = await fsp.readFile('song.mp3').then(parse);
46
+ const metadata = await fsp.readFile('song.mp3').then(parse);
47
+ metadata.text.TIT2 // Title
48
+ metadata.picture[2].data // Cover
49
+ metadata.user.COMM // TXXX COMM
50
+ metadata.unknown.length // Unparsable tags
51
+
52
+ const f = await fsp.readFile('song.mp3').then(parse); // Raw frames, if desired
47
53
  ```
package/dist/id3v2.d.ts CHANGED
@@ -1,6 +1,5 @@
1
1
  export type Frame<T = unknown> = {
2
- type: string;
3
- size: number;
2
+ id: string;
4
3
  value: T;
5
4
  };
6
5
  export type TextFrame = Frame<string>;
@@ -16,8 +15,26 @@ export type PictureValue = {
16
15
  data: Uint8Array;
17
16
  };
18
17
  export type PictureFrame = Frame<PictureValue>;
19
- export type UnknownFrame = Frame<null>;
20
- declare const _default: (buffer: Uint8Array) => Frame[];
18
+ export type UnknownFrame = Frame<string>;
19
+ export declare const frames: (raw: Uint8Array) => Frame[];
20
+ export type ID3v2 = {
21
+ text: Record<string, string>;
22
+ user: Record<string, string>;
23
+ picture: Record<number, PictureValue>;
24
+ unknown: string[];
25
+ };
26
+ declare const _default: (buffer: Uint8Array) => {
27
+ text: {
28
+ [k: string]: string;
29
+ };
30
+ user: {
31
+ [k: string]: string;
32
+ };
33
+ picture: {
34
+ [k: string]: PictureValue;
35
+ };
36
+ unknown: Frame[];
37
+ };
21
38
 
22
39
  export {
23
40
  _default as default,
package/dist/id3v2.js CHANGED
@@ -1,42 +1,4 @@
1
1
  // src/lib/buffer.ts
2
- var BIG_ENDIAN = Buffer.from([254, 255]);
3
- var LITTLE_ENDIAN = Buffer.from([255, 254]);
4
- var toAscii = (buffer) => {
5
- const end = buffer.findIndex((byte) => byte === 0);
6
- if (end === -1) throw new Error("Missing termination");
7
- return Buffer.from(buffer.slice(0, end)).toString("ascii");
8
- };
9
- var toUtf8 = (buffer) => {
10
- const end = buffer.findIndex((byte) => byte === 0);
11
- if (end === -1) throw new Error("Missing termination");
12
- return Buffer.from(buffer.slice(0, end)).toString("utf-8");
13
- };
14
- var toUtf16 = (buffer, swap) => {
15
- let end = -1;
16
- for (let i = 0; i < buffer.length; i += 2) {
17
- if (buffer[i] === 0 && buffer[i + 1] === 0) {
18
- end = i;
19
- break;
20
- }
21
- }
22
- if (end === -1) throw new Error("Missing termination");
23
- const value = Buffer.from(buffer.slice(0, end));
24
- if (swap) value.swap16();
25
- return value.toString("utf16le");
26
- };
27
- var toString = (encoding) => (buffer) => {
28
- if (encoding === 3) return toUtf8(buffer);
29
- if (encoding === 2) return toUtf16(buffer, true);
30
- if (encoding === 1) {
31
- const bom = Buffer.from(buffer.slice(0, 2));
32
- const isBom = bom.equals(BIG_ENDIAN) || bom.equals(LITTLE_ENDIAN);
33
- return toUtf16(
34
- isBom ? buffer.slice(2) : buffer,
35
- bom.equals(BIG_ENDIAN)
36
- );
37
- }
38
- return toAscii(buffer);
39
- };
40
2
  var size = (buffer) => {
41
3
  let n = 0;
42
4
  for (const byte of buffer) {
@@ -46,106 +8,169 @@ var size = (buffer) => {
46
8
  };
47
9
 
48
10
  // src/lib/header.ts
49
- var header_default = (buffer) => {
50
- if (buffer.length < 10) return null;
51
- if (buffer.slice(0, 3).toString() !== "ID3") return null;
52
- const major = buffer.at(3);
53
- if (typeof major !== "number") return null;
54
- const minor = buffer.at(4);
55
- if (typeof minor !== "number") return null;
56
- const flags = buffer.at(5);
57
- if (typeof flags !== "number") return null;
11
+ var header_default = (view) => {
12
+ if (view.bytes(3).toString() !== "ID3") throw new Error("Invalid header ID");
13
+ view.advance(2);
14
+ const extended = ((view.byte() ?? 0) & 64) !== 0;
15
+ const size2 = size(view.bytes(4));
16
+ if (extended) view.advance(size(view.bytes(4)));
17
+ return size2;
18
+ };
19
+
20
+ // src/lib/frame.ts
21
+ var header = (view) => {
22
+ const id = view.bytes(4).toString();
23
+ const size2 = size(view.bytes(4));
24
+ view.advance(2);
58
25
  return {
59
- version: {
60
- major: +major,
61
- minor
62
- },
63
- flags: {
64
- unsynchronisation: (flags & 128) !== 0,
65
- extended: (flags & 64) !== 0,
66
- experimental: (flags & 32) !== 0,
67
- footer: (flags & 16) !== 0
68
- },
69
- size: size(buffer.slice(6, 10))
26
+ id,
27
+ size: size2,
28
+ flags: null
70
29
  };
71
30
  };
72
- var extended = (buffer) => ({
73
- size: size(buffer.slice(0, 4))
74
- });
31
+ var frame_default = (view) => {
32
+ const { id, size: size2 } = header(view);
33
+ const text = (encoding) => ({ id, value: view.string(encoding) });
34
+ const user = (encoding) => {
35
+ const key = view.string(encoding);
36
+ const value = view.string(encoding);
37
+ return { id, value: { key, value } };
38
+ };
39
+ if (id.startsWith("T")) {
40
+ const encoding = view.byte() ?? 0;
41
+ if (id === "TXXX") return user(encoding);
42
+ return text(encoding);
43
+ }
44
+ if (id === "WXXX") return user(0);
45
+ if (id.startsWith("W")) return text(0);
46
+ if (id === "APIC") {
47
+ const offset = view.offset;
48
+ const encoding = view.byte() ?? 0;
49
+ const frame2 = {
50
+ id,
51
+ value: {
52
+ mime: view.ascii(),
53
+ type: view.byte() ?? 0,
54
+ description: view.string(encoding),
55
+ data: view.bytes(size2 - (view.offset - offset))
56
+ }
57
+ };
58
+ return frame2;
59
+ }
60
+ const frame = { id: "UNKNOWN", value: id };
61
+ view.advance(size2);
62
+ return frame;
63
+ };
75
64
 
76
- // src/lib/frame.ts
77
- var textFrame = (type) => (size2) => (value) => ({ type, size: size2, value });
78
- var userFrame = (type) => (size2) => (value) => ({ type, size: size2, value });
79
- var pictureFrame = (type) => (size2) => (value) => ({ type, size: size2, value });
80
- var unknownFrame = (type) => (size2) => ({ type, size: size2, value: null });
81
- var frame_default = (buffer) => {
82
- const type = Buffer.from(buffer.slice(0, 4)).toString();
83
- const max = size(buffer.slice(5, 8));
84
- if (type.startsWith("T")) {
85
- const encoding = buffer.at(10) ?? 0;
86
- let offset = 1;
87
- if (encoding === 1 || encoding === 2) offset = 2;
88
- if (type === "TXXX") {
89
- const key = toString(encoding)(buffer.slice(11, 10 + max));
90
- const bom = Buffer.from(buffer.slice(11, 13));
91
- const hasBom = bom.equals(BIG_ENDIAN) || bom.equals(LITTLE_ENDIAN);
92
- const value = toString(encoding)(buffer.slice(
93
- 11 + (hasBom ? 2 : 0) + Buffer.from(key).byteLength * 2 + offset,
94
- 10 + max
95
- ));
96
- return userFrame(type)(max + 10)({ key, value });
65
+ // src/lib/view.ts
66
+ var BIG_ENDIAN = Buffer.from([254, 255]);
67
+ var LITTLE_ENDIAN = Buffer.from([255, 254]);
68
+ var View = class {
69
+ #buffer;
70
+ #offset;
71
+ /**
72
+ * Find 0x00 byte (relative)
73
+ *
74
+ * **Note**: Does not advance
75
+ */
76
+ #zero(size2) {
77
+ const j = size2 ?? 1;
78
+ for (let i = this.#offset; i < this.#buffer.length; i += j) {
79
+ if (this.#buffer.slice(i, i + j).every((byte) => byte === 0)) {
80
+ return i - this.#offset;
81
+ }
97
82
  }
98
- return textFrame(type)(max + 10)(toString(encoding)(buffer.slice(11, 10 + max)));
83
+ throw new Error(`Missing ${"0x00 ".repeat(j)}termination`);
99
84
  }
100
- if (type.startsWith("W")) {
101
- if (type === "WXXX") {
102
- const key = toString(0)(buffer.slice(10, 10 + max));
103
- const value = toString(0)(buffer.slice(
104
- 10 + Buffer.from(key).byteLength + 1,
105
- 10 + max
106
- ));
107
- return userFrame(type)(max + 10)({ key, value });
108
- }
109
- return textFrame(type)(max + 10)(toString(0)(buffer.slice(10, 10 + max)));
85
+ constructor(buffer) {
86
+ this.#buffer = buffer;
87
+ this.#offset = 0;
88
+ }
89
+ get offset() {
90
+ return this.#offset;
91
+ }
92
+ byte() {
93
+ const cur = this.offset;
94
+ this.#offset += 1;
95
+ return this.#buffer.at(cur);
96
+ }
97
+ bytes(n) {
98
+ const cur = this.#offset;
99
+ this.#offset += n;
100
+ return Buffer.from(this.#buffer.slice(cur, this.#offset));
101
+ }
102
+ advance(n) {
103
+ this.#offset += n ?? 1;
110
104
  }
111
- if (type === "APIC") {
112
- let offset = 0;
113
- const encoding = buffer.at(10) ?? 0;
114
- offset += 1;
115
- const mime = toString(0)(buffer.slice(10 + offset, 10 + max));
116
- offset += Buffer.from(mime).byteLength + 1;
117
- const ptype = buffer.at(10 + offset) ?? 0;
118
- offset += 1;
119
- const description = toString(encoding)(buffer.slice(
120
- 10 + offset,
121
- 10 + max
122
- ));
123
- offset += Buffer.from(description).byteLength + 1;
124
- return pictureFrame(type)(max + 10)({
125
- mime,
126
- type: ptype,
127
- description,
128
- data: buffer.slice(10 + offset, 10 + max)
129
- });
105
+ bom() {
106
+ const bom = this.bytes(2);
107
+ if (bom.equals(BIG_ENDIAN)) return "be";
108
+ if (bom.equals(LITTLE_ENDIAN)) return "le";
109
+ this.advance(-2);
110
+ return null;
111
+ }
112
+ ascii() {
113
+ const x = this.bytes(this.#zero()).toString("ascii");
114
+ this.advance();
115
+ return x;
116
+ }
117
+ utf8() {
118
+ const x = this.bytes(this.#zero()).toString("utf-8");
119
+ this.advance();
120
+ return x;
121
+ }
122
+ utf16(be) {
123
+ const bom = this.bom();
124
+ const x = this.bytes(this.#zero(2));
125
+ this.advance(2);
126
+ if (bom === "be" || be) x.swap16();
127
+ return x.toString("utf-16le");
128
+ }
129
+ string(encoding) {
130
+ if (encoding === 3) return this.utf8();
131
+ if (encoding === 2) return this.utf16(true);
132
+ if (encoding === 1) return this.utf16();
133
+ return this.ascii();
130
134
  }
131
- return unknownFrame("UNKNOWN")(max + 10);
132
135
  };
133
136
 
134
137
  // src/id3v2.ts
138
+ var frames = (raw) => {
139
+ if (raw.length < 10) return [];
140
+ const view = new View(raw);
141
+ const size2 = header_default(view);
142
+ const frames2 = [];
143
+ while (view.offset < size2) frames2.push(frame_default(view));
144
+ return frames2;
145
+ };
135
146
  var id3v2_default = (buffer) => {
136
- let offset = 0;
137
- const header = header_default(buffer.slice(0, 10));
138
- if (!header) return [];
139
- offset += 10;
140
- if (header.flags.extended) offset += extended(buffer.slice(offset, 10)).size + 10;
141
- const frames = [];
142
- while (offset < header.size) {
143
- const frame = frame_default(buffer.slice(offset));
144
- frames.push(frame);
145
- offset += frame.size;
146
- }
147
- return frames;
147
+ const raw = frames(buffer);
148
+ return {
149
+ text: Object.fromEntries(raw.reduce((acc, cur) => {
150
+ if (cur.id.startsWith("T") && cur.id !== "TXXX" || cur.id.startsWith("W") && cur.id !== "WXXX") {
151
+ const frame = cur;
152
+ acc.push([frame.id, frame.value]);
153
+ }
154
+ return acc;
155
+ }, [])),
156
+ user: Object.fromEntries(raw.reduce((acc, cur) => {
157
+ if (cur.id === "TXXX" || cur.id === "WXXX") {
158
+ const frame = cur;
159
+ acc.push([frame.value.key, frame.value.value]);
160
+ }
161
+ return acc;
162
+ }, [])),
163
+ picture: Object.fromEntries(raw.reduce((acc, cur) => {
164
+ if (cur.id === "APIC") {
165
+ const frame = cur;
166
+ acc.push([frame.value.type, frame.value]);
167
+ }
168
+ return acc;
169
+ }, [])),
170
+ unknown: raw.filter((frame) => frame.id === "UNKNOWN")
171
+ };
148
172
  };
149
173
  export {
150
- id3v2_default as default
174
+ id3v2_default as default,
175
+ frames
151
176
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@chronocide/id3v2",
3
3
  "description": "ID3v2 metadata parser",
4
- "version": "0.0.1",
4
+ "version": "0.1.0",
5
5
  "type": "module",
6
6
  "exports": {
7
7
  ".": "./dist/id3v2.js"