Codec-Compare version 0.2.3 (#13)

y-guyon · web-flow · commit 3437550c9536 · 2024-08-29T10:14:00.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog
 
+## v0.2.3
+
+- No longer limit JPEG XL input quality range to [75:99] by default (introduced
+  at v0.2.1). Expect custom bpp or quality filters to be defined in the presets
+  instead.
+- Add lazy row loading setting for more reactive table panels.
+- Add animation frame count support.
+- Fade unused images in the gallery tab.
+- Hide matched pairs in the graph by default if there are more than two
+  experiments.
+
 ## v0.2.2
 
 - Add DSSIM distortion metric recognition.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "codec_compare",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Codec performance comparison tool",
   "publisher": "Google LLC",
   "author": "Yannis Guyon",
diff --git a/readme_preview.png b/readme_preview.png
diff --git a/src/codec_compare.ts b/src/codec_compare.ts
@@ -207,7 +207,7 @@ export class CodecCompare extends LitElement {
           </p>
 
           <p id="credits">
-            Codec Compare beta version 0.2.2<br>
+            Codec Compare beta version 0.2.3<br>
             <a href="https://github.com/webmproject/codec-compare">
               Sources on GitHub
             </a>
diff --git a/src/entry.ts b/src/entry.ts
@@ -36,6 +36,7 @@ export enum FieldId {
   DECODED_IMAGE_NAME,
   WIDTH,                   // Number of pixel columns in SOURCE_IMAGE_NAME.
   HEIGHT,                  // Number of pixel rows in SOURCE_IMAGE_NAME.
+  FRAME_COUNT,             // Number of frames in SOURCE_IMAGE_NAME.
   EFFORT,                  // Encoding setting.
   QUALITY,                 // Encoding setting.
   PSNR,                    // Difference between original and decoded images.
@@ -93,6 +94,7 @@ const NAME_TO_FIELD_ID = new Map<string, FieldId>([
   ['decoded image name', FieldId.DECODED_IMAGE_NAME],
   ['width', FieldId.WIDTH],
   ['height', FieldId.HEIGHT],
+  ['frame count', FieldId.FRAME_COUNT],
   ['effort', FieldId.EFFORT],
   ['quality', FieldId.QUALITY],
   ['psnr', FieldId.PSNR],
diff --git a/src/entry_loader.ts b/src/entry_loader.ts
@@ -210,6 +210,8 @@ function jsonToBatch(
         batch.fields.findIndex(field => field.id === FieldId.WIDTH);
     const heightFieldIndex =
         batch.fields.findIndex(field => field.id === FieldId.HEIGHT);
+    const frameCountFieldIndex =
+        batch.fields.findIndex(field => field.id === FieldId.FRAME_COUNT);
     const encodedSizeFieldIndex =
         batch.fields.findIndex(field => field.id === FieldId.ENCODED_SIZE);
     if (widthFieldIndex !== -1 && heightFieldIndex !== -1 &&
@@ -222,9 +224,13 @@ function jsonToBatch(
       batch.fields.push(field);
       uniqueValuesSets.push(new Set<string>());
       for (const row of batch.rows) {
-        const bpp = (row[encodedSizeFieldIndex] as number) * 8 /
+        let bpp = (row[encodedSizeFieldIndex] as number) * 8 /
             ((row[widthFieldIndex] as number) *
              (row[heightFieldIndex] as number));
+        if (frameCountFieldIndex !== -1 &&
+            batch.fields[frameCountFieldIndex].isInteger) {
+          bpp /= (row[frameCountFieldIndex] as number);
+        }
         row.push(bpp);
         field.addValue(String(bpp), uniqueValuesSets[fieldIndex]);
       }
diff --git a/src/events.ts b/src/events.ts
@@ -45,6 +45,9 @@ export enum EventType {
 
   // The state changed and the UI needs to reflect them.
   MATCHED_DATA_POINTS_CHANGED = 'MATCHED_DATA_POINTS_CHANGED',
+
+  // Some setting was toggled.
+  SETTINGS_CHANGED = 'SETTINGS_CHANGED',
 }
 
 /**
@@ -63,6 +66,7 @@ declare global {
     REFERENCE_CHANGED: Event;
     MATCHER_OR_METRIC_CHANGED: Event;
     MATCHED_DATA_POINTS_CHANGED: Event;
+    SETTINGS_CHANGED: Event;
   }
 }
 
diff --git a/src/filter.ts b/src/filter.ts
@@ -36,7 +36,7 @@ export class FieldFilter {
   }
 }
 
-/** Arbitrarily enables some filters (focusing on lossy image comparison). */
+/** Arbitrarily enables some filters. */
 export function enableDefaultFilters(batch: Batch, filters: FieldFilter[]) {
   // Pick the highest (usually meaning slowest) effort for best compression
   // results.
@@ -50,21 +50,6 @@ export function enableDefaultFilters(batch: Batch, filters: FieldFilter[]) {
       effortFilter.rangeStart = effortFilter.rangeEnd;
     }
   }
-
-  // Restrict JPEG XL to a "reasonable" encoder quality setting range.
-  if (batch.codec.toLowerCase() === 'jxl' ||
-      batch.codec.toLowerCase() === 'jpegxl') {
-    const qualityIndex =
-        batch.fields.findIndex((field: Field) => field.id === FieldId.QUALITY);
-    if (qualityIndex !== -1) {
-      const qualityField = batch.fields[qualityIndex];
-      if (qualityField.isInteger && qualityField.uniqueValuesArray.length > 1) {
-        filters[qualityIndex].enabled = true;
-        filters[qualityIndex].rangeStart =
-            Math.max(filters[qualityIndex].rangeStart, 75);
-      }
-    }
-  }
 }
 
 function rowPassesFilter(
diff --git a/src/filtered_images_ui.ts b/src/filtered_images_ui.ts
@@ -21,6 +21,7 @@ import {customElement, property} from 'lit/decorators.js';
 
 import {BatchSelection} from './batch_selection';
 import {Entry} from './entry';
+import {dispatch, EventType} from './events';
 import {State} from './state';
 
 /** Component displaying filtered images in a table. */
@@ -44,6 +45,24 @@ export class FilteredImagesUi extends LitElement {
 
   override render() {
     const batch = this.batchSelection.batch;
+    let rows = batch.rows;
+    let truncatedRows = html``;
+    if (!this.state.showAllRows && rows.length > 100) {
+      const onDisplayHiddenRow = () => {
+        this.state.showAllRows = true;
+        dispatch(EventType.SETTINGS_CHANGED);
+        this.requestUpdate();
+      };
+      truncatedRows = html`
+        <tr>
+          <td @click=${onDisplayHiddenRow}
+              colspan=${batch.fields.length} class="hiddenRow">
+            ${rows.length - 100} hidden rows. Click to expand.
+          </td>
+        </tr>`;
+      rows = rows.slice(0, 100);
+    }
+
     return html`
         <div class="horizontalFlex">
           <div id="imageChip">
@@ -71,7 +90,8 @@ export class FilteredImagesUi extends LitElement {
             (field) => html`<th title="${field.description}">${
                 field.displayName}</th>`)}
             </tr>
-            ${batch.rows.map((row, rowIndex) => this.renderRow(row, rowIndex))}
+            ${rows.map((row, rowIndex) => this.renderRow(row, rowIndex))}
+            ${truncatedRows}
           </table>
         </div>`;
   }
@@ -151,6 +171,15 @@ export class FilteredImagesUi extends LitElement {
       color: grey;
     }
 
+    .hiddenRow {
+      color: grey;
+      font-style: italic;
+      text-align: center;
+    }
+    .hiddenRow:hover {
+      cursor: pointer;
+    }
+
     a {
       text-decoration: none;
     }
diff --git a/src/gallery_ui.ts b/src/gallery_ui.ts
@@ -65,7 +65,8 @@ export class GalleryUi extends LitElement {
       if (asset.sourcePath !== undefined) {
         // Use a link to open the image in a new tab.
         return html`
-          <a href="${asset.sourcePath}" target="_blank" title="${title}">
+          <a href="${asset.sourcePath}" target="_blank" title="${title}"
+            class="${asset.count == 0 ? 'unused' : ''}">
             <img src="${asset.previewPath}" class="constrainedSize"
               alt="${asset.sourceName}">
             <span class="countBubble">${asset.count}</span>
@@ -194,6 +195,10 @@ export class GalleryUi extends LitElement {
       font-size: 16px;
     }
 
+    .unused {
+      opacity: 0.2;
+    }
+
     .countBubble {
       position: absolute;
       top: 5px;
diff --git a/src/matcher.ts b/src/matcher.ts
@@ -100,6 +100,7 @@ export function createMatchers(batches: Batch[]): FieldMatcher[] {
     if (field.id === FieldId.DECODED_IMAGE_NAME) continue;
     // Same source image, so these will always match. Remove them from the UI.
     if (field.id === FieldId.WIDTH || field.id === FieldId.HEIGHT) continue;
+    if (field.id === FieldId.FRAME_COUNT) continue;
     // If bpp values are available, encoded sizes probably are too.
     // Skip the former which brings nothing as a matcher over the latter.
     if (field.id === FieldId.ENCODED_BITS_PER_PIXEL) continue;
diff --git a/src/matches_table_ui.ts b/src/matches_table_ui.ts
@@ -69,7 +69,8 @@ export class MatchesTableUi extends LitElement {
     const cssClass = isNumber ? 'numberCell' : '';
 
     if (isNumber && selectionField.id !== FieldId.WIDTH &&
-        selectionField.id !== FieldId.HEIGHT) {
+        selectionField.id !== FieldId.HEIGHT &&
+        selectionField.id !== FieldId.FRAME_COUNT) {
       const ratio =
           getRatio(selectionValue as number, referenceValue as number);
       return html`<td class="${cssClass}">${getRelativePercent(ratio)}</td>`;
@@ -202,14 +203,32 @@ export class MatchesTableUi extends LitElement {
 
     const numColumns =
         matchers.length + metrics.length + selectionSharedFieldIndices.length;
+    let rows = this.batchSelection.matchedDataPoints.rows;
+    let truncatedRows = html``;
+    if (!this.state.showAllRows && rows.length > 100) {
+      const onDisplayHiddenRow = () => {
+        this.state.showAllRows = true;
+        dispatch(EventType.SETTINGS_CHANGED);
+        this.requestUpdate();
+      };
+      truncatedRows = html`
+        <tr>
+          <td @click=${onDisplayHiddenRow}
+              colspan=${numColumns} class="hiddenRow">
+            ${rows.length - 100} hidden rows. Click to expand.
+          </td>
+        </tr>`;
+      rows = rows.slice(0, 100);
+    }
 
     return html`
       <table>
         ${
         this.renderFirstHeaderRow(
             reference, matchers, metrics, referenceSharedFieldIndices)}
         ${this.renderSecondHeaderRow(reference, matchers, metrics)}
-        ${this.batchSelection.matchedDataPoints.rows.map(renderRow)}
+        ${rows.map(renderRow)}
+        ${truncatedRows}
 
         <tr>
           <th colspan=${numColumns}>Arithmetic means</th>
@@ -290,6 +309,14 @@ export class MatchesTableUi extends LitElement {
       background: var(--mdc-theme-surface);
       cursor: pointer;
     }
+    .hiddenRow {
+      color: grey;
+      font-style: italic;
+      text-align: center;
+    }
+    .hiddenRow:hover {
+      cursor: pointer;
+    }
 
     .missing {
       background: var(--mdc-theme-surface);
diff --git a/src/metric.ts b/src/metric.ts
@@ -80,6 +80,7 @@ export function createMetrics(batches: Batch[]): FieldMetric[] {
     if (!isNumber) continue;
     // Same source image, so same source image features. No need to compare.
     if (field.id === FieldId.WIDTH || field.id === FieldId.HEIGHT) continue;
+    if (field.id === FieldId.FRAME_COUNT) continue;
     // Encoder settings should not be compared.
     if (field.id === FieldId.EFFORT || field.id === FieldId.QUALITY) continue;
     // If bpp values are available, encoded sizes probably are too.
diff --git a/src/settings_ui.ts b/src/settings_ui.ts
@@ -21,39 +21,70 @@ import './filters_ui';
 import {css, html, LitElement} from 'lit';
 import {customElement, property} from 'lit/decorators.js';
 
-import {dispatch, EventType} from './events';
+import {dispatch, EventType, listen} from './events';
 import {State} from './state';
 
 /** Pop-up settings menu. */
 @customElement('settings-ui')
 export class SettingsUi extends LitElement {
   @property({attribute: false}) state!: State;
 
+  override firstUpdated() {
+    listen(EventType.SETTINGS_CHANGED, () => {
+      this.requestUpdate();
+    });
+  }
+
   override render() {
     if (!this.state) return html``;
+    const slownessWarning = 'warning: may cause graphical interface slowness';
 
     return html`
         <div class="settingGroup">
-          <span>Hide data points</span>
+          <span title="Hide the matched pairs in the graph">
+            Hide data points
+          </span>
           <mwc-switch ?selected=${this.state.showEachMatch}
             @click=${() => {
       this.state.showEachMatch = !this.state.showEachMatch;
       dispatch(EventType.MATCHER_OR_METRIC_CHANGED);
-      this.requestUpdate();
+      dispatch(EventType.SETTINGS_CHANGED);
     }}>
           </mwc-switch>
-          <span>Show data points</span>
+          <span title="Show each matched pair as a small dot in the graph (${
+        slownessWarning})">
+            Show data points
+          </span>
         </div>
         <div class="settingGroup">
-          <span>Arithmetic mean</span>
+          <span title="Aggregate the metrics using the arithmetic mean of the values of the matched data points">
+            Arithmetic mean
+          </span>
           <mwc-switch ?selected=${this.state.useGeometricMean}
             @click=${() => {
       this.state.useGeometricMean = !this.state.useGeometricMean;
       dispatch(EventType.MATCHER_OR_METRIC_CHANGED);
-      this.requestUpdate();
+      dispatch(EventType.SETTINGS_CHANGED);
+    }}>
+          </mwc-switch>
+          <span title="Aggregate the metrics using the geometric mean of the ratios of the matched pairs">
+            Geometric mean
+          </span>
+        </div>
+        <div class="settingGroup">
+          <span title="Only display the first rows of the filtered or matched data point tables">
+            Show some rows
+          </span>
+          <mwc-switch ?selected=${this.state.showAllRows}
+            @click=${() => {
+      this.state.showAllRows = !this.state.showAllRows;
+      dispatch(EventType.SETTINGS_CHANGED);
     }}>
           </mwc-switch>
-          <span>Geometric mean</span>
+          <span title="Display all rows of the filtered or matched data point tables (${
+        slownessWarning})">
+            Show all rows
+          </span>
         </div>`;
   }
 
diff --git a/src/state.ts b/src/state.ts
@@ -59,6 +59,9 @@ export class State {
    */
   useGeometricMean = true;
 
+  /** If true, each row is shown in the tables. NOT stored in URL params. */
+  showAllRows = false;
+
   /** Sets all other fields up based on the contents of the batches field. */
   initialize() {
     if (this.batches.length === 0) return;
@@ -113,13 +116,17 @@ export class State {
     [this.plotMetricHorizontal, this.plotMetricVertical] =
         selectPlotMetrics(this.batches[0], this.metrics);
 
-    // It would be better to count the matches rather than the data points but
-    // it is more important to have a default setting value right now, before
-    // reading the URL arguments, which happens before finding the matches.
-    const numDataPoints =
-        this.batches.reduce((n, batch) => n + batch.rows.length, 0);
-    if (numDataPoints > 50000) {
-      this.showEachMatch = false;  // Avoids plot sluggishness by default.
+    if (this.batches.length > 2) {
+      this.showEachMatch = false;  // Avoids visual confusion.
+    } else {
+      // It would be better to count the matches rather than the data points but
+      // it is more important to have a default setting value right now, before
+      // reading the URL arguments, which happens before finding the matches.
+      const numDataPoints =
+          this.batches.reduce((n, batch) => n + batch.rows.length, 0);
+      if (numDataPoints > 50000) {
+        this.showEachMatch = false;  // Avoids plot sluggishness by default.
+      }
     }
 
     const computeMatchesAndStats = (batchSelection: BatchSelection) => {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "codec_compare",`
`3`		`- "version": "0.2.2",`
	`3`	`+ "version": "0.2.3",`
`4`	`4`	`"description": "Codec performance comparison tool",`
`5`	`5`	`"publisher": "Google LLC",`
`6`	`6`	`"author": "Yannis Guyon",`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,9 @@ export enum EventType {`
`45`	`45`
`46`	`46`	`// The state changed and the UI needs to reflect them.`
`47`	`47`	`MATCHED_DATA_POINTS_CHANGED = 'MATCHED_DATA_POINTS_CHANGED',`
	`48`	`+`
	`49`	`+ // Some setting was toggled.`
	`50`	`+ SETTINGS_CHANGED = 'SETTINGS_CHANGED',`
`48`	`51`	`}`
`49`	`52`
`50`	`53`	`/**`
`@@ -63,6 +66,7 @@ declare global {`
`63`	`66`	`REFERENCE_CHANGED: Event;`
`64`	`67`	`MATCHER_OR_METRIC_CHANGED: Event;`
`65`	`68`	`MATCHED_DATA_POINTS_CHANGED: Event;`
	`69`	`+ SETTINGS_CHANGED: Event;`
`66`	`70`	`}`
`67`	`71`	`}`
`68`	`72`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ export class FieldFilter {`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`
`39`		`-/** Arbitrarily enables some filters (focusing on lossy image comparison). */`
	`39`	`+/** Arbitrarily enables some filters. */`
`40`	`40`	`export function enableDefaultFilters(batch: Batch, filters: FieldFilter[]) {`
`41`	`41`	`// Pick the highest (usually meaning slowest) effort for best compression`
`42`	`42`	`// results.`
`@@ -50,21 +50,6 @@ export function enableDefaultFilters(batch: Batch, filters: FieldFilter[]) {`
`50`	`50`	`effortFilter.rangeStart = effortFilter.rangeEnd;`
`51`	`51`	`}`
`52`	`52`	`}`
`53`		`-`
`54`		`- // Restrict JPEG XL to a "reasonable" encoder quality setting range.`
`55`		`- if (batch.codec.toLowerCase() === 'jxl' \|\|`
`56`		`- batch.codec.toLowerCase() === 'jpegxl') {`
`57`		`- const qualityIndex =`
`58`		`- batch.fields.findIndex((field: Field) => field.id === FieldId.QUALITY);`
`59`		`- if (qualityIndex !== -1) {`
`60`		`- const qualityField = batch.fields[qualityIndex];`
`61`		`- if (qualityField.isInteger && qualityField.uniqueValuesArray.length > 1) {`
`62`		`- filters[qualityIndex].enabled = true;`
`63`		`- filters[qualityIndex].rangeStart =`
`64`		`- Math.max(filters[qualityIndex].rangeStart, 75);`
`65`		`- }`
`66`		`- }`
`67`		`- }`
`68`	`53`	`}`
`69`	`54`
`70`	`55`	`function rowPassesFilter(`