1724639803

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/tmigone/pulseaudio/commit/<a class=hub.com/tmigone/pulseaudio/commit/<a class="double-link" href="https://git"><a class=hub.com/tmigone/pulseaudio/commit/<a class="double-link" href="https://git"><a class=hub.com/tmigone/pulseaudio/commit/<a class="double-link" href="https://git"><a class=hub.com/tmigone/pulseaudio/commit/f16dd24ee77c1cc079cd24431f19a4a2566185a1">f16dd24ee">&lt;a href=&quot;https://github.com/tmigone/pulseaudio/commit/</a><a class="double-link" href="https://github.com/tmigone/pulseaudio/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/tmigone/pulseaudio/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/tmigone/pulseaudio/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/tmigone/pulseaudio/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/tmigone/pulseaudio/commit/f16dd24ee77c1cc079cd24431f19a4a2566185a1">f16dd24ee</a><a href="https://github.com/tmigone/pulseaudio/commit/f16dd24ee77c1cc079cd24431f19a4a2566185a1">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/tmigone/pulseaudio/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/tmigone/pulseaudio/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/tmigone/pulseaudio/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/tmigone/pulseaudio/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/tmigone/pulseaudio/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/tmigone/pulseaudio/commit/f16dd24ee77c1cc079cd24431f19a4a2566185a1&quot;&gt;f16dd24ee&lt;/a&gt;&lt;a href=&quot;https://github.com/tmigone/pulseaudio/commit/f16dd24ee77c1cc079cd24431f19a4a2566185a1&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/tmigone/pulseaudio/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/tmigone/pulseaudio/comm... (continued)

Pull Request Pull Request #22: Refactor

Run Details

94 of 187 branches covered (50.27%)

Branch coverage included in aggregate %.

588 of 588 new or added lines in 44 files covered. (100.0%)

848 of 1093 relevant lines covered (77.58%)

85.98 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.59

/src/packet.ts

// PulseAudio tagstruct
// https://github.com/pulseaudio/pulseaudio/blob/master/src/pulsecore/tagstruct.h
// https://github.com/pulseaudio/pulseaudio/blob/master/src/pulsecore/tagstruct.c

import * as fs from 'fs'
import { createIterator, Iterator } from './utils/iterator'
import {
  PATag,
  PATagType,
  PAU32,
  PAArbitrary,
  PABoolean,
  PAString,
  PAProp,
  PAPropList,
  PASampleSpec,
  PAChannelMap,
  PAChannelVolume,
  PAUsec,
  PAVolume,
  PAFormat,
  PAU8
} from './tag'
import { ChannelVolume } from './types/pulseaudio'
import { JSONStringify } from './utils/bigInt'

export const PA_PACKET_HEADER: Buffer = Buffer.from([
  0xFF, 0xFF, 0xFF, 0xFF,
  0x00, 0x00, 0x00, 0x00,
  0x00, 0x00, 0x00, 0x00,
  0x00, 0x00, 0x00, 0x00
])

const enum SectionLength {
  SIZE = 4,
  HEADER = 16,
  COMMAND = 5,
  REQUEST = 5
}
const enum SectionIndex {
  SIZE = 0,
  HEADER = 4,
  HEADER_END = 20,
  COMMAND = 21,
  REQUEST = 26,
  TAGS = 30
}

// PulseAudio Packet structure by section
// - 4 bytes: Size of the TAGS section in bytes (including command and requestId)!
// - 16 bytes: Packet header
// - 5 bytes: Packet command with u32 tag prefix
// - 5 bytes: Request ID with u32 tag prefix
// - X bytes: TAGS section, multiple [tag + value]
export default class PAPacket {
  // Raw packet buffer
  packet: Buffer

  // Parsed packet sections
  tagsSize: number = 0
  header: Buffer = PA_PACKET_HEADER
  command: PAU32
  requestId: PAU32
  tags: Array<PATag<any>> = []
  private readonly debugPrint: boolean = process.env.DEBUG_PRINT !== undefined

  constructor (buffer?: Buffer) {
    if (buffer != null) {
      this.packet = Buffer.from(buffer.subarray(0, PAPacket.getPacketSize(buffer)))
      this.read(this.packet)
    }
  }

  write (): Buffer {
    // Calculate tagsSize
    const allTags: Array<PATag<any>> = [this.command, this.requestId, ...this.tags]
    this.tagsSize = allTags.reduce((sum, tag): number => {
      sum += tag.size
      return sum
    }, 0)

    // Create packet buffer
    this.packet = Buffer.allocUnsafe(SectionLength.SIZE + SectionLength.HEADER + this.tagsSize)

    // Sections: tagsSize and header
    let offset: number = 0
    offset = this.packet.writeUInt32BE(this.tagsSize, offset)
    offset += PA_PACKET_HEADER.copy(this.packet, offset)

    // Sections: command, request and tags
    for (const tag of allTags) {
      tag.tag.copy(this.packet, offset)
      offset += tag.size
    }

    if (this.debugPrint) {
      fs.writeFileSync('PAPacket.write.buffer', this.packet.toString('hex'))
      fs.writeFileSync('PAPacket.write.tags', JSONStringify(allTags))
    }
    return this.packet
  }

  read (buffer: Buffer): void {
    // Sections: tagSize, header,
    if (!PAPacket.isValidPacket(buffer)) {
      throw new Error('Packet is not valid.')
    }

    try {
      this.tagsSize = buffer.readUInt32BE(SectionIndex.SIZE)
      this.header = buffer.subarray(SectionIndex.HEADER, SectionIndex.HEADER_END)
      this.command = new PAU32(buffer.readUInt32BE(SectionIndex.COMMAND))
      this.requestId = new PAU32(buffer.readUInt32BE(SectionIndex.REQUEST))

      // Sections: tags
      const tagsBuffer: Buffer = buffer.subarray(SectionIndex.TAGS, SectionIndex.TAGS + this.tagsSize - SectionLength.COMMAND - SectionLength.REQUEST)

      let offset: number = 0
      let tag: PATag<any>
      while (offset < tagsBuffer.length) {
        const tagType: PATagType = tagsBuffer.readUInt8(offset)
        switch (tagType) {
          case PATagType.PA_TAG_U32.toString().charCodeAt(0):
            tag = new PAU32(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_ARBITRARY.toString().charCodeAt(0):
            tag = new PAArbitrary(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_STRING.toString().charCodeAt(0):
          case PATagType.PA_TAG_STRING_NULL.toString().charCodeAt(0):
            tag = new PAString(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_BOOLEAN.toString().charCodeAt(0):
          case PATagType.PA_TAG_BOOLEAN_FALSE.toString().charCodeAt(0):
          case PATagType.PA_TAG_BOOLEAN_TRUE.toString().charCodeAt(0):
            tag = new PABoolean(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_PROPLIST.toString().charCodeAt(0):
            tag = new PAPropList(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_SAMPLE_SPEC.toString().charCodeAt(0):
            tag = new PASampleSpec(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_CHANNEL_MAP.toString().charCodeAt(0):
            tag = new PAChannelMap(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_CVOLUME.toString().charCodeAt(0):
            tag = new PAChannelVolume(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_USEC.toString().charCodeAt(0):
            tag = new PAUsec(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_VOLUME.toString().charCodeAt(0):
            tag = new PAVolume(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_U8.toString().charCodeAt(0):
            tag = new PAU8(tagsBuffer.subarray(offset))
            break
          case PATagType.PA_TAG_FORMAT_INFO.toString().charCodeAt(0):
            tag = new PAFormat(tagsBuffer.subarray(offset))
            break
          default:
            throw new Error(`Tag type: ${tagType} not supported. Please report issue.`)
        }
        this.tags.push(tag)
        offset += tag.size
      }
    } catch (error) {
      console.log(error)
    }
    if (this.debugPrint) {
      fs.writeFileSync('PAPacket.read.buffer', buffer.toString('hex'))
      fs.writeFileSync('PAPacket.read.tags', JSONStringify(this.tags))
    }
  }

  // Test wether a chunk is valid as a PA Packet start
  // Returns true even if the chunk is incomplete (chunk size < SectionLength.SIZE + SectionLength.HEADER + dataLength)
  static isChunkHeader (chunk: Buffer): boolean {
    if (chunk.length < SectionLength.SIZE + SectionLength.HEADER) {
      return false
    }

    const header: Buffer = chunk.subarray(SectionIndex.HEADER, SectionIndex.HEADER_END)
    return Buffer.compare(header, PA_PACKET_HEADER) === 0
  }

  // Returns the size of split shunks in bytes
  static getChunksSize (chunks: Buffer[]): number {
    return chunks.reduce((sum, chunk) => {
      sum += chunk.length
      return sum
    }, 0)
  }

  // Get size of the packet in bytes
  static getPacketSize (buffer: Buffer): number {
    const tagsSize = buffer.readUInt32BE(SectionIndex.SIZE)
    return SectionLength.SIZE + SectionLength.HEADER + tagsSize
  }

  // Test wether a series of chunks can construct a valid PA Packet
  // Min requirements are starting with a chunk header and having enough bytes to complete the packet
  static isValidPacket (chunks: Buffer | Buffer[]): boolean {
    if (chunks instanceof Buffer) {
      chunks = [chunks]
    }
    if (chunks.length === 0) {
      return false
    }
    const chunksSize: number = this.getChunksSize(chunks)
    const dataLength: number = chunks[0].readUInt32BE(0)

    return this.isChunkHeader(chunks[0]) && chunksSize >= (SectionLength.SIZE + SectionLength.HEADER + dataLength)
  }

  setCommand (value: number): void {
    this.command = new PAU32(value)
  }

  setRequestId (value: number): void {
    this.requestId = new PAU32(value)
  }

  // Put methods
  // https://github.com/pulseaudio/pulseaudio/blob/master/src/pulsecore/tagstruct.h#L70
  putU32 (value: number): void {
    this.tags.push(new PAU32(value))
  }

  putBoolean (value: boolean): void {
    this.tags.push(new PABoolean(value))
  }

  putArbitrary (value: Buffer): void {
    this.tags.push(new PAArbitrary(value))
  }

  putString (value: string): void {
    this.tags.push(new PAString(value))
  }

  putProp (value: [string, string]): void {
    this.tags.push(new PAProp(value))
  }

  putPropList (value: Array<[string, string]>): void {
    this.tags.push(new PAPropList(value))
  }

  putChannelVolume (value: ChannelVolume): void {
    this.tags.push(new PAChannelVolume(value))
  }

  getTagsIterable (): Iterator<PATag<any>> {
    return createIterator(this.tags.map(t => t.value))
  }
}

1	// PulseAudio tagstruct
2	// https://github.com/pulseaudio/pulseaudio/blob/master/src/pulsecore/tagstruct.h
3	// https://github.com/pulseaudio/pulseaudio/blob/master/src/pulsecore/tagstruct.c
4
5	import * as fs from 'fs'	9✔
6	import { createIterator, Iterator } from './utils/iterator'	9✔
7	import {	9✔
8	PATag,
9	PATagType,
10	PAU32,
11	PAArbitrary,
12	PABoolean,
13	PAString,
14	PAProp,
15	PAPropList,
16	PASampleSpec,
17	PAChannelMap,
18	PAChannelVolume,
19	PAUsec,
20	PAVolume,
21	PAFormat,
22	PAU8
23	} from './tag'
24	import { ChannelVolume } from './types/pulseaudio'
25	import { JSONStringify } from './utils/bigInt'	9✔
26
27	export const PA_PACKET_HEADER: Buffer = Buffer.from([	9✔
28	0xFF, 0xFF, 0xFF, 0xFF,
29	0x00, 0x00, 0x00, 0x00,
30	0x00, 0x00, 0x00, 0x00,
31	0x00, 0x00, 0x00, 0x00
32	])
33
34	const enum SectionLength {	9✔
35	SIZE = 4,	9✔
36	HEADER = 16,	9✔
37	COMMAND = 5,	9✔
38	REQUEST = 5	9✔
39	}
40	const enum SectionIndex {	9✔
41	SIZE = 0,	9✔
42	HEADER = 4,	9✔
43	HEADER_END = 20,	9✔
44	COMMAND = 21,	9✔
45	REQUEST = 26,	9✔
46	TAGS = 30	9✔
47	}
48
49	// PulseAudio Packet structure by section
50	// - 4 bytes: Size of the TAGS section in bytes (including command and requestId)!
51	// - 16 bytes: Packet header
52	// - 5 bytes: Packet command with u32 tag prefix
53	// - 5 bytes: Request ID with u32 tag prefix
54	// - X bytes: TAGS section, multiple [tag + value]
55	export default class PAPacket {	9✔
56	// Raw packet buffer
57	packet: Buffer
58
59	// Parsed packet sections
60	tagsSize: number = 0	44✔
61	header: Buffer = PA_PACKET_HEADER	44✔
62	command: PAU32
63	requestId: PAU32
64	tags: Array<PATag<any>> = []	44✔
65	private readonly debugPrint: boolean = process.env.DEBUG_PRINT !== undefined	44✔
66
67	constructor (buffer?: Buffer) {
68	if (buffer != null) {	44✔
69	this.packet = Buffer.from(buffer.subarray(0, PAPacket.getPacketSize(buffer)))	22✔
70	this.read(this.packet)	22✔
71	}
72	}
73
74	write (): Buffer {
75	// Calculate tagsSize
76	const allTags: Array<PATag<any>> = [this.command, this.requestId, ...this.tags]	22✔
77	this.tagsSize = allTags.reduce((sum, tag): number => {	22✔
78	sum += tag.size	74✔
79	return sum	74✔
80	}, 0)
81
82	// Create packet buffer
83	this.packet = Buffer.allocUnsafe(SectionLength.SIZE + SectionLength.HEADER + this.tagsSize)	22✔
84
85	// Sections: tagsSize and header
86	let offset: number = 0	22✔
87	offset = this.packet.writeUInt32BE(this.tagsSize, offset)	22✔
88	offset += PA_PACKET_HEADER.copy(this.packet, offset)	22✔
89
90	// Sections: command, request and tags
91	for (const tag of allTags) {	22✔
92	tag.tag.copy(this.packet, offset)	74✔
93	offset += tag.size	74✔
94	}
95
96	if (this.debugPrint) {	22!
97	fs.writeFileSync('PAPacket.write.buffer', this.packet.toString('hex'))	×
98	fs.writeFileSync('PAPacket.write.tags', JSONStringify(allTags))	×
99	}
100	return this.packet	22✔
101	}
102
103	read (buffer: Buffer): void {
104	// Sections: tagSize, header,
105	if (!PAPacket.isValidPacket(buffer)) {	22!
106	throw new Error('Packet is not valid.')	×
107	}
108
109	try {	22✔
110	this.tagsSize = buffer.readUInt32BE(SectionIndex.SIZE)	22✔
111	this.header = buffer.subarray(SectionIndex.HEADER, SectionIndex.HEADER_END)	22✔
112	this.command = new PAU32(buffer.readUInt32BE(SectionIndex.COMMAND))	22✔
113	this.requestId = new PAU32(buffer.readUInt32BE(SectionIndex.REQUEST))	22✔
114
115	// Sections: tags
116	const tagsBuffer: Buffer = buffer.subarray(SectionIndex.TAGS, SectionIndex.TAGS + this.tagsSize - SectionLength.COMMAND - SectionLength.REQUEST)	22✔
117
118	let offset: number = 0	22✔
119	let tag: PATag<any>
120	while (offset < tagsBuffer.length) {	22✔
121	const tagType: PATagType = tagsBuffer.readUInt8(offset)	380✔
122	switch (tagType) {	380!
123	case PATagType.PA_TAG_U32.toString().charCodeAt(0):
124	tag = new PAU32(tagsBuffer.subarray(offset))	135✔
125	break	135✔
126	case PATagType.PA_TAG_ARBITRARY.toString().charCodeAt(0):
127	tag = new PAArbitrary(tagsBuffer.subarray(offset))	1✔
128	break	1✔
129	case PATagType.PA_TAG_STRING.toString().charCodeAt(0):
130	case PATagType.PA_TAG_STRING_NULL.toString().charCodeAt(0):
131	tag = new PAString(tagsBuffer.subarray(offset))	109✔
132	break	109✔
133	case PATagType.PA_TAG_BOOLEAN.toString().charCodeAt(0):
134	case PATagType.PA_TAG_BOOLEAN_FALSE.toString().charCodeAt(0):
135	case PATagType.PA_TAG_BOOLEAN_TRUE.toString().charCodeAt(0):
136	tag = new PABoolean(tagsBuffer.subarray(offset))	23✔
137	break	23✔
138	case PATagType.PA_TAG_PROPLIST.toString().charCodeAt(0):
139	tag = new PAPropList(tagsBuffer.subarray(offset))	37✔
140	break	37✔
141	case PATagType.PA_TAG_SAMPLE_SPEC.toString().charCodeAt(0):
142	tag = new PASampleSpec(tagsBuffer.subarray(offset))	12✔
143	break	12✔
144	case PATagType.PA_TAG_CHANNEL_MAP.toString().charCodeAt(0):
145	tag = new PAChannelMap(tagsBuffer.subarray(offset))	12✔
146	break	12✔
147	case PATagType.PA_TAG_CVOLUME.toString().charCodeAt(0):
148	tag = new PAChannelVolume(tagsBuffer.subarray(offset))	11✔
149	break	11✔
150	case PATagType.PA_TAG_USEC.toString().charCodeAt(0):
151	tag = new PAUsec(tagsBuffer.subarray(offset))	22✔
152	break	22✔
153	case PATagType.PA_TAG_VOLUME.toString().charCodeAt(0):
154	tag = new PAVolume(tagsBuffer.subarray(offset))	7✔
155	break	7✔
156	case PATagType.PA_TAG_U8.toString().charCodeAt(0):
157	tag = new PAU8(tagsBuffer.subarray(offset))	7✔
158	break	7✔
159	case PATagType.PA_TAG_FORMAT_INFO.toString().charCodeAt(0):
160	tag = new PAFormat(tagsBuffer.subarray(offset))	4✔
161	break	4✔
162	default:
163	throw new Error(`Tag type: ${tagType} not supported. Please report issue.`)	×
164	}
165	this.tags.push(tag)	380✔
166	offset += tag.size	380✔
167	}
168	} catch (error) {
169	console.log(error)	×
170	}
171	if (this.debugPrint) {	22!
172	fs.writeFileSync('PAPacket.read.buffer', buffer.toString('hex'))	×
173	fs.writeFileSync('PAPacket.read.tags', JSONStringify(this.tags))	×
174	}
175	}
176
177	// Test wether a chunk is valid as a PA Packet start
178	// Returns true even if the chunk is incomplete (chunk size < SectionLength.SIZE + SectionLength.HEADER + dataLength)
179	static isChunkHeader (chunk: Buffer): boolean {
180	if (chunk.length < SectionLength.SIZE + SectionLength.HEADER) {	22!
181	return false	×
182	}
183
184	const header: Buffer = chunk.subarray(SectionIndex.HEADER, SectionIndex.HEADER_END)	22✔
185	return Buffer.compare(header, PA_PACKET_HEADER) === 0	22✔
186	}
187
188	// Returns the size of split shunks in bytes
189	static getChunksSize (chunks: Buffer[]): number {
190	return chunks.reduce((sum, chunk) => {	22✔
191	sum += chunk.length	22✔
192	return sum	22✔
193	}, 0)
194	}
195
196	// Get size of the packet in bytes
197	static getPacketSize (buffer: Buffer): number {
198	const tagsSize = buffer.readUInt32BE(SectionIndex.SIZE)	22✔
199	return SectionLength.SIZE + SectionLength.HEADER + tagsSize	22✔
200	}
201
202	// Test wether a series of chunks can construct a valid PA Packet
203	// Min requirements are starting with a chunk header and having enough bytes to complete the packet
204	static isValidPacket (chunks: Buffer \| Buffer[]): boolean {
205	if (chunks instanceof Buffer) {	22!
206	chunks = [chunks]	22✔
207	}
208	if (chunks.length === 0) {	22!
209	return false	×
210	}
211	const chunksSize: number = this.getChunksSize(chunks)	22✔
212	const dataLength: number = chunks[0].readUInt32BE(0)	22✔
213
214	return this.isChunkHeader(chunks[0]) && chunksSize >= (SectionLength.SIZE + SectionLength.HEADER + dataLength)	22✔
215	}
216
217	setCommand (value: number): void {
218	this.command = new PAU32(value)	22✔
219	}
220
221	setRequestId (value: number): void {
222	this.requestId = new PAU32(value)	22✔
223	}
224
225	// Put methods
226	// https://github.com/pulseaudio/pulseaudio/blob/master/src/pulsecore/tagstruct.h#L70
227	putU32 (value: number): void {
228	this.tags.push(new PAU32(value))	16✔
229	}
230
231	putBoolean (value: boolean): void {
232	this.tags.push(new PABoolean(value))	×
233	}
234
235	putArbitrary (value: Buffer): void {
236	this.tags.push(new PAArbitrary(value))	2✔
237	}
238
239	putString (value: string): void {
240	this.tags.push(new PAString(value))	9✔
241	}
242
243	putProp (value: [string, string]): void {
244	this.tags.push(new PAProp(value))	×
245	}
246
247	putPropList (value: Array<[string, string]>): void {
248	this.tags.push(new PAPropList(value))	1✔
249	}
250
251	putChannelVolume (value: ChannelVolume): void {
252	this.tags.push(new PAChannelVolume(value))	2✔
253	}
254
255	getTagsIterable (): Iterator<PATag<any>> {
256	return createIterator(this.tags.map(t => t.value))	374✔
257	}
258	}

tmigone / pulseaudio / 1724639803

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous