@vpalmisano/webrtcperf 4.1.5 → 4.1.9

package/src/server.ts

@@ -119,14 +119,14 @@ export class Server {
         log.error(`mkdir ${this.serverData} error: ${err.message}`)
       })
       this.app.get('/data', this.getDataArchive.bind(this))
-      this.app.get('/data/*', this.getData.bind(this))
+      this.app.get('/data/:path', this.getData.bind(this))
     }
     if (this.videoCachePath) {
       log.debug(`using videoCachePath: ${this.videoCachePath}`)
       fs.promises.mkdir(this.videoCachePath, { recursive: true }).catch(err => {
         log.error(`mkdir ${this.videoCachePath} error: ${err.message}`)
       })
-      this.app.get('/cache/*', this.getCache.bind(this))
+      this.app.get('/cache/:path', this.getCache.bind(this))
     }
 
     this.app.use((err: Error, req: express.Request, res: express.Response, next: express.NextFunction) => {
@@ -429,7 +429,7 @@ export class Server {
    * content in tar.gz format.
    */
   private getData(req: express.Request, res: express.Response, next: express.NextFunction): void {
-    const paramPath = path.normalize(req.params[0]).replace(/^(\.\.(\/|\\|$))+/, '')
+    const paramPath = path.normalize(req.params.path).replace(/^(\.\.(\/|\\|$))+/, '')
     log.debug(`GET /data/${paramPath}`, req.query)
     const fpath = path.resolve(this.serverData, paramPath)
     if (!fs.existsSync(fpath)) {
@@ -453,7 +453,7 @@ export class Server {
   }
 
   private getCache(req: express.Request, res: express.Response, next: express.NextFunction): void {
-    const paramPath = path.normalize(req.params[0]).replace(/^(\.\.(\/|\\|$))+/, '')
+    const paramPath = path.normalize(req.params.path).replace(/^(\.\.(\/|\\|$))+/, '')
     log.debug(`GET /cache/${paramPath}`, req.query)
     const fpath = path.resolve(this.videoCachePath, paramPath)
     if (!fs.existsSync(fpath)) {

package/src/session.ts

@@ -15,6 +15,7 @@ import puppeteer, {
   CDPSession,
   CookieParam,
   ElementHandle,
+  ImageFormat,
   KeyInput,
   Metrics,
   Page,
@@ -176,7 +177,7 @@ export interface SessionParams {
   debuggingAddress: string
   randomAudioPeriod: number
   maxVideoDecoders: number
-  maxVideoDecodersAt: number
+  maxVideoDecodersRange: string
   incognito: boolean
   serverPort: number
   serverSecret: string
@@ -245,7 +246,7 @@ export class Session extends EventEmitter {
   private readonly responseModifiers: Record<
     string,
     {
-      search?: RegExp
+      search?: string | RegExp
       replace?: string
       file?: string
       headers?: Record<string, string>
@@ -260,7 +261,7 @@ export class Session extends EventEmitter {
   private readonly debuggingAddress: string
   private readonly randomAudioPeriod: number
   private readonly maxVideoDecoders: number
-  private readonly maxVideoDecodersAt: number
+  private readonly maxVideoDecodersRange: string
   private readonly incognito: boolean
   private readonly serverPort: number
   private readonly serverSecret: string
@@ -390,7 +391,7 @@ export class Session extends EventEmitter {
     debuggingAddress,
     randomAudioPeriod,
     maxVideoDecoders,
-    maxVideoDecodersAt,
+    maxVideoDecodersRange,
     incognito,
     serverPort,
     serverSecret,
@@ -464,7 +465,7 @@ export class Session extends EventEmitter {
     this.userAgent = userAgent
     this.randomAudioPeriod = randomAudioPeriod
     this.maxVideoDecoders = maxVideoDecoders
-    this.maxVideoDecodersAt = maxVideoDecodersAt
+    this.maxVideoDecodersRange = maxVideoDecodersRange
     this.incognito = incognito
     this.serverPort = serverPort
     this.serverSecret = serverSecret
@@ -511,8 +512,8 @@ export class Session extends EventEmitter {
               `responseModifiers replacements should be an array of { search, replace, body, headers } objects: ${replacements}`,
             )
           }
-          this.responseModifiers[url] = replacements.map(({ search, replace, file, headers }) => ({
-            search: search ? new RegExp(search, 'g') : undefined,
+          this.responseModifiers[url] = replacements.map(({ search, regexp, replace, file, headers }) => ({
+            search: regexp ? new RegExp(regexp, 'g') : search,
             replace,
             file,
             headers,
@@ -596,7 +597,7 @@ export class Session extends EventEmitter {
       env.CHROME_LOG_FILE = path.resolve(pageLogDir, `chrome-${this.id}.log`)
     }
 
-    if (this.maxVideoDecoders !== -1 && this.id >= this.maxVideoDecodersAt) {
+    if (this.maxVideoDecoders !== -1 && enabledForSession(this.id, this.maxVideoDecodersRange)) {
       fieldTrials = `WebRTC-MaxVideoDecoders/${this.maxVideoDecoders}/` + fieldTrials
     }
     if (fieldTrials.length) {
@@ -1921,7 +1922,7 @@ webrtcperf.config.AUDIO_URL = "http${this.serverUseHttps ? 's' : ''}://localhost
     if (!page) {
       throw new Error(`Page ${index} not found`)
     }
-    const filePath = `/tmp/screenshot-${index}.${format}`
+    const filePath = `/tmp/screenshot-${index}.${format}` as `${string}.${ImageFormat}`
     await page.screenshot({
       path: filePath,
       fullPage: true,

package/src/stats.ts

@@ -795,10 +795,12 @@ export class Stats extends events.EventEmitter {
     this.collectedStatsConfig.pages = 0
     this.collectedStatsConfig.startTime = this.startTimestamp
     // Reset collectedStats object.
-    Object.values(this.collectedStats).forEach(stats => {
+    const prevByParticipantAndTrackStats = {} as Record<string, Set<string>>
+    Object.entries(this.collectedStats).forEach(([name, stats]) => {
       stats.all.reset()
       Object.values(stats.byHost).forEach(s => s.reset())
       Object.values(stats.byCodec).forEach(s => s.reset())
+      prevByParticipantAndTrackStats[name] = new Set(Object.keys(stats.byParticipantAndTrack))
       stats.byParticipantAndTrack = {}
     })
     for (const [sessionId, session] of this.sessions.entries()) {
@@ -812,6 +814,7 @@ export class Stats extends events.EventEmitter {
         //log.log(name, obj)
         try {
           const collectedStats = this.collectedStats[name]
+          const prevByParticipantAndTrack = prevByParticipantAndTrackStats[name]
           if (typeof obj === 'number' && isFinite(obj)) {
             collectedStats.all.push(obj)
           } else {
@@ -828,7 +831,9 @@ export class Stats extends events.EventEmitter {
                 stats.push(value)
                 // Push participant and track values.
                 if (enabledForSession(sessionId, this.enableDetailedStats) && participantName) {
-                  collectedStats.byParticipantAndTrack[`${participantName}:${trackId || ''}`] = value
+                  const label = `${participantName}:${trackId || ''}`
+                  collectedStats.byParticipantAndTrack[label] = value
+                  prevByParticipantAndTrack.delete(label)
                 }
               } else if (typeof value === 'string') {
                 // Codec stats.
@@ -869,6 +874,7 @@ export class Stats extends events.EventEmitter {
           return
         }
         const collectedStats = this.collectedStats[name]
+        const prevByParticipantAndTrack = prevByParticipantAndTrackStats[name]
         collectedStats.all.push(stats.all)
         Object.entries(stats.byHost).forEach(([host, values]) => {
           if (!collectedStats.byHost[host]) {
@@ -884,6 +890,7 @@ export class Stats extends events.EventEmitter {
         })
         Object.entries(stats.byParticipantAndTrack).forEach(([label, value]) => {
           collectedStats.byParticipantAndTrack[label] = value
+          prevByParticipantAndTrack.delete(label)
         })
       })
     }
@@ -930,7 +937,7 @@ export class Stats extends events.EventEmitter {
     await Promise.allSettled([
       this.writeStats(),
       this.writeDetailedStats(),
-      this.sendToPushGateway(),
+      this.sendToPushGateway(prevByParticipantAndTrackStats),
       this.writeAlertRulesReport(),
     ])
   }
@@ -1062,7 +1069,7 @@ export class Stats extends events.EventEmitter {
   /**
    * sendToPushGateway
    */
-  async sendToPushGateway(): Promise<void> {
+  async sendToPushGateway(removedByParticipantAndTrackStats: Record<string, Set<string>>): Promise<void> {
     if (!this.gateway || !this.running) {
       return
     }
@@ -1109,6 +1116,20 @@ export class Stats extends events.EventEmitter {
         })
       }
 
+      // Remove metrics for removed participants and tracks.
+      const removedByParticipantAndTrack = removedByParticipantAndTrackStats[name]
+      if (removedByParticipantAndTrack) {
+        for (const label of removedByParticipantAndTrack) {
+          const [participantName, trackId] = label.split(':', 2)
+          metric.value?.remove({
+            participantName,
+            trackId,
+            datetime,
+            ...this.customMetricsLabels,
+          })
+        }
+      }
+
       // Set alerts metrics.
       if (this.alertRules && this.alertRules[name]) {
         const rule = this.alertRules[name]

package/src/utils.ts

@@ -20,7 +20,7 @@ import os, { networkInterfaces } from 'os'
 import path, { dirname } from 'path'
 import pidtree from 'pidtree'
 import pidusage from 'pidusage'
-import puppeteer, { Page } from 'puppeteer-core'
+import puppeteer, { ImageFormat, Page } from 'puppeteer-core'
 
 import { Session } from './session'
 
@@ -255,7 +255,7 @@ export function startRandomActivateAudio(
   sessions: Map<number, Session>,
   randomAudioPeriod: number,
   randomAudioProbability: number,
-  randomAudioRange: number,
+  randomAudioRange: string,
 ): void {
   if (randomActivateAudioRunning) return
   randomActivateAudioRunning = true
@@ -272,13 +272,13 @@ export function stopRandomActivateAudio(): void {
  * @param sessions The sessions Map
  * @param randomAudioPeriod If set, the function will be called in loop
  * @param randomAudioProbability The activation probability
- * @param randomAudioRange The number of pages to include into the automation
+ * @param randomAudioRange The page indexes to include into the automation
  */
 export async function randomActivateAudio(
   sessions: Map<number, Session>,
   randomAudioPeriod: number,
   randomAudioProbability: number,
-  randomAudioRange: number,
+  randomAudioRange: string,
 ): Promise<void> {
   if (!randomAudioPeriod || !randomActivateAudioRunning) {
     return
@@ -287,13 +287,9 @@ export async function randomActivateAudio(
     let pages: (Page | null)[] = []
     for (const session of sessions.values()) {
       const sessionPages = [...session.pages.values()]
-      if (randomAudioRange) {
-        if (session.id > randomAudioRange) {
-          break
-        }
-        sessionPages.splice(randomAudioRange - session.id)
+      if (enabledForSession(session.id, randomAudioRange)) {
+        pages = pages.concat(sessionPages)
       }
-      pages = pages.concat(sessionPages)
     }
     // Remove pages with no audio tracks.
     for (const [i, page] of pages.entries()) {
@@ -1037,7 +1033,8 @@ export async function pageScreenshot(
     if (!element) {
       throw new Error(`pageScreenshot selector "${selector}" not found`)
     }
-    await element.screenshot({ path: filePath })
+    const path = filePath as `${string}.${ImageFormat}`
+    await element.screenshot({ path })
   } catch (err) {
     log.error(`pageScreenshot error: ${(err as Error).message}`)
   } finally {

package/src/vmaf.ts

@@ -464,7 +464,12 @@ export async function runVmaf(
   const sender = path.basename(referencePath).replace('.ivf', '')
   const receiver = path.basename(degradedPath).replace('.ivf', '').split('_recv-by_')[1]
 
-  const { frameRate: refFrameRate, frames: refFrames } = await parseIvf(referencePath, false)
+  const {
+    width: refWidth,
+    height: refHeight,
+    frameRate: refFrameRate,
+    frames: refFrames,
+  } = await parseIvf(referencePath, false)
   const {
     width: degWidth,
     height: degHeight,
@@ -517,13 +522,20 @@ export async function runVmaf(
 -i ${referencePath} \
 `
 
+  let cropWidth = 0
+  const refFactor = refWidth / refHeight
+  const degFactor = degWidth / degHeight
+  if (refFactor > degFactor) {
+    cropWidth = Math.round(degFactor * refHeight)
+  }
+
   const filter = `\
 [0:v]\
-scale=w=-1:h=${degHeight}:flags=bicubic,\
+scale=w=-1:h=${refHeight}:flags=bicubic,${cropWidth ? `crop=w=${cropWidth}:x=(iw-${cropWidth})/2,` : ''}\
 ${cropFilter(crop.deg, 0, ',')}\
 ${splitFilter(['deg_vmaf', 'deg_psnr', preview ? 'deg_preview' : ''])};\
 [1:v]\
-scale=w=-1:h=${degHeight}:flags=bicubic,crop=w=${degWidth}:x=(iw-${degWidth})/2,\
+scale=w=-1:h=${refHeight}:flags=bicubic,\
 ${cropFilter(crop.ref, 0, ',')}\
 ${splitFilter(['ref_vmaf', 'ref_psnr', preview ? 'ref_preview' : ''])};\
 [deg_vmaf][ref_vmaf]libvmaf=model='path=/usr/share/model/vmaf_v0.6.1.json':log_fmt=json:log_path=${vmafLogPath}:n_subsample=1:n_threads=${cpus}:shortest=1[vmaf];\
@@ -575,8 +587,19 @@ ${splitFilter(['ref_vmaf', 'ref_psnr', preview ? 'ref_preview' : ''])};\
 }
 
 async function writeGraph(vmafLogPath: string) {
+  const {
+    CategoryScale,
+    Chart,
+    LinearScale,
+    LineController,
+    LineElement,
+    PointElement,
+    Legend,
+    Title,
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+  } = require('chart.js')
   // eslint-disable-next-line @typescript-eslint/no-require-imports
-  const { ChartJSNodeCanvas } = require('chartjs-node-canvas')
+  const { Canvas } = require('skia-canvas')
 
   const vmafLog = JSON.parse(await fs.promises.readFile(vmafLogPath, 'utf-8')) as {
     frames: {
@@ -613,13 +636,9 @@ async function writeGraph(vmafLogPath: string) {
     )
     .map(d => ({ x: d.x, y: d.y / d.count }))
 
-  const chartJSNodeCanvas = new ChartJSNodeCanvas({
-    width: 1280,
-    height: 720,
-    backgroundColour: 'white',
-  })
-
-  const buffer = await chartJSNodeCanvas.renderToBuffer({
+  Chart.register([CategoryScale, LineController, LineElement, LinearScale, PointElement, Legend, Title])
+  const canvas = new Canvas(1280, 720)
+  const chart = new Chart(canvas, {
     type: 'line',
     data: {
       labels: data.map(d => d.x),
@@ -640,7 +659,7 @@ async function writeGraph(vmafLogPath: string) {
       plugins: {
         title: {
           display: true,
-          text: path.basename(vmafLogPath).replace('.vmaf.json', '').replace(/_/g, ' '),
+          text: path.basename(path.dirname(vmafLogPath)).replace(/_/g, ' '),
         },
       },
       scales: {
@@ -651,8 +670,8 @@ async function writeGraph(vmafLogPath: string) {
       },
     },
   })
-
-  await fs.promises.writeFile(fpath, buffer)
+  await canvas.saveAs(fpath, { format: 'png', matte: 'white' })
+  chart.destroy()
 }
 
 interface Crop {