Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions _locales/en/messages.json
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,9 @@
"hdThumbnail": {
"message": "HD thumbnail"
},
"hdrBadge": {
"message": "Show HDR badge next to the video title"
},
"header": {
"message": "Header"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
# General
--------------------------------------------------------------*/
#info #info-text {max-height: 6rem; display: block;}
.it-hdr-badge{display:inline-block;margin-left:8px;padding:1px 6px;border:1px solid #e6c200;border-radius:4px;color:#e6c200;font-size:12px;font-weight:600;line-height:1.4;vertical-align:middle;white-space:nowrap;}
html:not([it-below-player-screenshot='false']) #above-the-fold #channel-name,
html:not([it-below-player-pip='false']) #above-the-fold #channel-name,
html[it-below-player-loop='true'] #above-the-fold #channel-name { max-height: max(25px, 1.5vw) }
Expand Down
1 change: 1 addition & 0 deletions js&css/web-accessible/functions.js
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,7 @@ ImprovedTube.videoPageUpdate = function () {
ImprovedTube.playerCinemaModeButton();
ImprovedTube.playerHamburgerButton();
ImprovedTube.playerControls();
if ( this.storage.hdr_badge === true && document.documentElement.dataset.pageType === 'video') { ImprovedTube.hdrBadge(); };

// Initialize large playlist handler for playlist videos
if (this.getParam(location.href, 'list')) {
Expand Down
103 changes: 102 additions & 1 deletion js&css/web-accessible/www.youtube.com/appearance.js
Original file line number Diff line number Diff line change
Expand Up @@ -943,6 +943,107 @@ ImprovedTube.channelVideosCount = function () {
xhr.send();
}
};
/*------------------------------------------------------------------------------
SHOW HDR BADGE NEXT TO THE VIDEO TITLE
------------------------------------------------------------------------------*/
ImprovedTube.hdrBadge = function () {
var badgeClass = 'it-hdr-badge';

function clearBadge () {
var old = document.querySelectorAll('.' + badgeClass),
i;
for (i = 0; i < old.length; i++) {
old[i].remove();
}
}

clearBadge();

var self = this,
videoId = null;
try { videoId = self.getParam(location.href.slice(location.href.indexOf('?') + 1), 'v'); } catch (e) {}

function belongsToVideo (resp) {
if (!resp || typeof resp !== 'object') { return false; }
var id = resp.videoDetails && resp.videoDetails.videoId;
return !id || !videoId || id === videoId;
}

function isHdrResponse (resp) {
var formats, i, format, colorInfo, tc, primaries;
if (!resp || typeof resp !== 'object' || !resp.streamingData) { return false; }
formats = resp.streamingData.adaptiveFormats || [];
for (i = 0; i < formats.length; i++) {
format = formats[i] || {};
colorInfo = format.colorInfo || {};
tc = String(colorInfo.transferCharacteristics || '').toUpperCase();
// PQ (SMPTE 2084 / HDR10)
if (tc.indexOf('2084') !== -1 || tc.indexOf('PQ') !== -1) { return true; }
// HLG (ARIB STD-B67)
if (tc.indexOf('HLG') !== -1 || tc.indexOf('B67') !== -1 || tc.indexOf('ARIB') !== -1) { return true; }
primaries = String(colorInfo.primaries || colorInfo.colorGamut || '').toUpperCase();
if (primaries.indexOf('2020') !== -1 || primaries.indexOf('2100') !== -1) { return true; }
if (String(format.qualityLabel || '').toUpperCase().indexOf('HDR') !== -1) { return true; }
// VP9 Profile 2 is YouTube's HDR carrier codec
if (/VP0?9[\._]0?2/i.test(format.mimeType || '')) { return true; }
}
return false;
}

function getResponse () {
var player, resp;
try {
player = document.getElementById('movie_player');
if (player && typeof player.getPlayerResponse === 'function') {
resp = player.getPlayerResponse();
if (resp && belongsToVideo(resp)) { return resp; }
}
} catch (e) {}
try {
if (belongsToVideo(window.ytInitialPlayerResponse)) { return window.ytInitialPlayerResponse; }
} catch (e) {}
return null;
}

function ensureBadge () {
var title = document.querySelector('ytd-watch-metadata #title') || document.querySelector('#above-the-fold #title'),
badge;
if (!title) { return false; }
if (title.querySelector('.' + badgeClass)) { return true; }
badge = document.createElement('span');
badge.className = badgeClass;
badge.textContent = 'HDR';
badge.title = 'This video offers HDR (shown even while Windows is in SDR mode)';
title.appendChild(badge);
return true;
}

function attempt (retriesLeft) {
if (document.documentElement.dataset.pageType !== 'video') { return; }
var resp = getResponse();
if (resp && isHdrResponse(resp)) {
if (ensureBadge()) {
// Title node may be re-created by YouTube after we checked; verify briefly.
if (retriesLeft > 0) {
setTimeout(function () {
if (!document.querySelector('.' + badgeClass)) { attempt(retriesLeft - 1); }
}, 1500);
}
} else if (retriesLeft > 0) {
// HDR confirmed but the title node is not in the DOM yet; wait for it.
setTimeout(function () { attempt(retriesLeft - 1); }, 1200);
}
return;
}
// Player response may not be populated yet (or belong to the previous
// video right after SPA navigation); retry a few times, then give up.
if (retriesLeft > 0) {
setTimeout(function () { attempt(retriesLeft - 1); }, 1200);
}
}

attempt(4);
};
if (ImprovedTube.storage.header_transparent2 === true) {
/*------------------------------------------------------------------------------
TURN TOP BAR TRANSPARENT WHEN SCROLLING
Expand Down Expand Up @@ -1278,4 +1379,4 @@ ImprovedTube.ccIndicator = function () {
window.addEventListener('load', run);
setTimeout(run, 1000);
})();
};
};
4 changes: 4 additions & 0 deletions menu/skeleton-parts/appearance.js
Original file line number Diff line number Diff line change
Expand Up @@ -631,6 +631,10 @@ extension.skeleton.main.layers.section.appearance.on.click.details = {
cc_indicator: {
component: "switch",
text: "ccIndicator"
},
hdr_badge: {
component: "switch",
text: "hdrBadge"
}
}
}
Expand Down
161 changes: 161 additions & 0 deletions tests/unit/hdr-badge.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
const fs = require('fs');
const path = require('path');
const vm = require('vm');

function loadHdrBadge(context) {
const source = fs.readFileSync(
path.join(__dirname, '../../js&css/web-accessible/www.youtube.com/appearance.js'),
'utf8'
);
const start = source.indexOf('ImprovedTube.hdrBadge = function');
const end = source.indexOf('if (ImprovedTube.storage.header_transparent2', start);

if (start < 0 || end < 0) {
throw new Error('HDR badge source was not found');
}

vm.createContext(context);
vm.runInContext(source.slice(start, end), context);
}

function adaptiveFormat(overrides = {}) {
return Object.assign({
mimeType: 'video/webm; codecs="vp9"',
qualityLabel: '2160p',
colorInfo: {transferCharacteristics: 'BT709', primaries: 'BT709'}
}, overrides);
}

function playerResponse(videoId, formats) {
return {videoDetails: {videoId}, streamingData: {adaptiveFormats: formats}};
}

function createHarness({setting = true, response = null, pageType = 'video', staleBadges = []} = {}) {
const appended = [];
const removed = [];
staleBadges.forEach(badge => {
badge.remove = () => { removed.push(badge); };
});
const title = {
querySelector: () => null,
appendChild: el => { appended.push(el); }
};
const moviePlayer = response ? {getPlayerResponse: () => response} : null;
const context = {
Array,
Object,
String,
RegExp,
console,
setTimeout: () => 0,
document: {
documentElement: {dataset: {pageType}},
getElementById: id => (id === 'movie_player' ? moviePlayer : null),
querySelector: sel => (/#title/.test(sel) ? title : null),
querySelectorAll: sel => (sel === '.it-hdr-badge' ? staleBadges : []),
createElement: () => ({className: '', textContent: '', title: ''})
},
window: {},
location: {href: 'https://www.youtube.com/watch?v=abc123abc12'},
ImprovedTube: {
storage: {hdr_badge: setting},
getParam: (query, name) => (name === 'v' ? 'abc123abc12' : null)
}
};
loadHdrBadge(context);
return {context, appended, removed};
}

describe('HDR badge (ImprovedTube.hdrBadge)', () => {
test('shows badge for PQ / SMPTE 2084 transfer', () => {
const {context, appended} = createHarness({
response: playerResponse('abc123abc12', [
adaptiveFormat({colorInfo: {transferCharacteristics: 'SMPTE2084', primaries: 'BT2020'}})
])
});
context.ImprovedTube.hdrBadge();
expect(appended.length).toBe(1);
expect(appended[0].className).toBe('it-hdr-badge');
expect(appended[0].textContent).toBe('HDR');
});

test('shows badge for HLG (ARIB STD-B67) transfer', () => {
const {context, appended} = createHarness({
response: playerResponse('abc123abc12', [
adaptiveFormat({colorInfo: {transferCharacteristics: 'ARIB_STD_B67', primaries: 'BT2020'}})
])
});
context.ImprovedTube.hdrBadge();
expect(appended.length).toBe(1);
});

test('shows badge for BT.2020 primaries', () => {
const {context, appended} = createHarness({
response: playerResponse('abc123abc12', [
adaptiveFormat({colorInfo: {transferCharacteristics: 'BT2020-10', primaries: 'BT2020'}})
])
});
context.ImprovedTube.hdrBadge();
expect(appended.length).toBe(1);
});

test('shows badge when quality label contains HDR', () => {
const {context, appended} = createHarness({
response: playerResponse('abc123abc12', [
adaptiveFormat({qualityLabel: '2160p60 HDR'})
])
});
context.ImprovedTube.hdrBadge();
expect(appended.length).toBe(1);
});

test('shows badge for VP9 Profile 2 codec string', () => {
const {context, appended} = createHarness({
response: playerResponse('abc123abc12', [
adaptiveFormat({mimeType: 'video/webm; codecs="vp09.02.51.10.01.09.18.09.00"'})
])
});
context.ImprovedTube.hdrBadge();
expect(appended.length).toBe(1);
});

test('shows no badge for plain SDR (BT.709) streams', () => {
const {context, appended} = createHarness({
response: playerResponse('abc123abc12', [adaptiveFormat(), adaptiveFormat()])
});
context.ImprovedTube.hdrBadge();
expect(appended.length).toBe(0);
});

test('shows no badge when the setting is off, but clears stale badges', () => {
const stale = [{}];
const {context, appended, removed} = createHarness({setting: false, staleBadges: stale,
response: playerResponse('abc123abc12', [
adaptiveFormat({colorInfo: {transferCharacteristics: 'SMPTE2084'}})
])
});
context.ImprovedTube.hdrBadge();
expect(appended.length).toBe(0);
expect(removed.length).toBe(1);
});

test('ignores a player response that belongs to another video (SPA staleness)', () => {
const {context, appended} = createHarness({
response: playerResponse('otherVideoId', [
adaptiveFormat({colorInfo: {transferCharacteristics: 'SMPTE2084'}})
])
});
context.ImprovedTube.hdrBadge();
expect(appended.length).toBe(0);
});

test('shows no badge outside video pages', () => {
const {context, appended} = createHarness({pageType: 'home',
response: playerResponse('abc123abc12', [
adaptiveFormat({colorInfo: {transferCharacteristics: 'SMPTE2084'}})
])
});
context.ImprovedTube.hdrBadge();
expect(appended.length).toBe(0);
});
});