Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: HD gear icon when manually changing quality #706

Merged
merged 6 commits into from
Mar 9, 2018
Merged

Fix: HD gear icon when manually changing quality #706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e653f23
Fix: HD gear icon when manually changing quality
DanDeMicco Mar 8, 2018
740aa3a
Merge branch 'master' into dash-hd
tonyjin Mar 8, 2018
1501d1f
Chore: update to camelCase
DanDeMicco Mar 9, 2018
ee7e964
Merge branch 'dash-hd' of github.com:DanDeMicco/box-content-preview i…
DanDeMicco Mar 9, 2018
fe53fc2
Chore: update to camelCase
DanDeMicco Mar 9, 2018
b1d2e10
Merge branch 'master' into dash-hd
DanDeMicco Mar 9, 2018
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
26 changes: 21 additions & 5 deletions src/lib/viewers/media/DashViewer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,11 +310,30 @@ class DashViewer extends VideoBaseViewer {
break;
}

this.showGearHdIcon(this.getActiveTrack());

if (quality) {
this.emit('qualitychange', quality);
}
}

/**
* Determines if the current track is playing HD video, then shows
* or hides 'HD' next to the gear icon
*
* @param {Object} activeTrack - the currently playing track
* @return {void}
*/
showGearHdIcon(activeTrack = {}) {
const isPlayingHD = activeTrack.videoId === this.hdVideoId;

if (isPlayingHD) {
this.wrapperEl.classList.add(CSS_CLASS_HD);
} else {
this.wrapperEl.classList.remove(CSS_CLASS_HD);
}
}

/**
* Handles adaptation changes
*
Expand All @@ -324,11 +343,8 @@ class DashViewer extends VideoBaseViewer {
*/
adaptationHandler() {
const activeTrack = this.getActiveTrack();
if (activeTrack.videoId === this.hdVideoId) {
this.wrapperEl.classList.add(CSS_CLASS_HD);
} else {
this.wrapperEl.classList.remove(CSS_CLASS_HD);
}

this.showGearHdIcon(activeTrack);

if (!this.isLoaded()) {
return;
Expand Down
128 changes: 76 additions & 52 deletions src/lib/viewers/media/__tests__/DashViewer-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,14 +170,20 @@ describe('lib/viewers/media/DashViewer', () => {
});

it('should not prefetch rep content if content is false', () => {
sandbox.mock(util).expects('get').never();
sandbox
.mock(util)
.expects('get')
.never();
dash.prefetch({ assets: false, content: false });
expect(stubs.prefetchAssets).to.not.be.called;
});

it('should not prefetch rep content if representation is not ready', () => {
stubs.repReady.returns(false);
sandbox.mock(util).expects('get').never();
sandbox
.mock(util)
.expects('get')
.never();

dash.prefetch({ assets: false, content: true });
expect(stubs.prefetchAssets).to.not.be.called;
Expand All @@ -186,7 +192,10 @@ describe('lib/viewers/media/DashViewer', () => {
it('should prefetch rep content if representation is ready', () => {
const contentUrl = 'someUrl';
stubs.createUrl.returns(contentUrl);
sandbox.mock(util).expects('get').withArgs(contentUrl, 'any');
sandbox
.mock(util)
.expects('get')
.withArgs(contentUrl, 'any');

dash.prefetch({ assets: false, content: true });
expect(stubs.prefetchAssets).to.not.be.called;
Expand Down Expand Up @@ -232,7 +241,7 @@ describe('lib/viewers/media/DashViewer', () => {
stubs.mockPlayer.expects('load').withArgs('url', START_TIME_IN_SECONDS);

dash.loadDashPlayer();
})
});
});

describe('requestFilter()', () => {
Expand All @@ -245,12 +254,10 @@ describe('lib/viewers/media/DashViewer', () => {
is_watermarked: false
},
representations: {
entries: [
{ representation: 'dash' },
]
entries: [{ representation: 'dash' }]
}
}
}
};

dash.requestFilter('', stubs.req);

Expand All @@ -261,19 +268,17 @@ describe('lib/viewers/media/DashViewer', () => {
it('should append watermark cache-busting query params if file is watermarked', () => {
stubs.createUrl = sandbox.stub(dash, 'createContentUrlWithAuthParams').returns('www.authed.com/?foo=bar');
stubs.req = { uris: ['uri'] };
dash.watermarkCacheBust = '123'
dash.watermarkCacheBust = '123';
dash.options = {
file: {
watermark_info: {
is_watermarked: true
},
representations: {
entries: [
{ representation: 'dash' },
]
entries: [{ representation: 'dash' }]
}
}
}
};

dash.requestFilter('', stubs.req);

Expand Down Expand Up @@ -311,9 +316,9 @@ describe('lib/viewers/media/DashViewer', () => {
const variant4 = { id: 4, videoId: 2, audioId: 6, active: true };
const variant5 = { id: 5, videoId: 1, audioId: 7, active: false };
const variant6 = { id: 6, videoId: 2, audioId: 7, active: false };
stubs.mockPlayer.expects('getVariantTracks').returns([
variant1, variant2, variant3, variant4, variant5, variant6
]);
stubs.mockPlayer
.expects('getVariantTracks')
.returns([variant1, variant2, variant3, variant4, variant5, variant6]);
sandbox.stub(dash, 'getActiveTrack').returns(variant4);
sandbox.stub(dash, 'showLoadingIcon');
stubs.mockPlayer.expects('selectVariantTrack').withArgs(variant3, true);
Expand All @@ -326,9 +331,7 @@ describe('lib/viewers/media/DashViewer', () => {
it('should do nothing if enabling a videoId which is already active', () => {
const variant1 = { id: 1, videoId: 1, audioId: 5, active: false };
const variant2 = { id: 2, videoId: 2, audioId: 5, active: true };
stubs.mockPlayer.expects('getVariantTracks').returns([
variant1, variant2
]);
stubs.mockPlayer.expects('getVariantTracks').returns([variant1, variant2]);
sandbox.stub(dash, 'getActiveTrack').returns(variant2);
sandbox.stub(dash, 'showLoadingIcon');
stubs.mockPlayer.expects('selectVariantTrack').never();
Expand All @@ -341,9 +344,7 @@ describe('lib/viewers/media/DashViewer', () => {
it('should do nothing if enabling an invalid videoId', () => {
const variant1 = { id: 1, videoId: 1, audioId: 5, active: false };
const variant2 = { id: 2, videoId: 2, audioId: 5, active: true };
stubs.mockPlayer.expects('getVariantTracks').returns([
variant1, variant2
]);
stubs.mockPlayer.expects('getVariantTracks').returns([variant1, variant2]);
sandbox.stub(dash, 'getActiveTrack').returns(variant2);
sandbox.stub(dash, 'showLoadingIcon');
stubs.mockPlayer.expects('selectVariantTrack').never();
Expand Down Expand Up @@ -372,6 +373,8 @@ describe('lib/viewers/media/DashViewer', () => {
dash.sdVideoId = -1;
stubs.enableVideoId = sandbox.stub(dash, 'enableVideoId');
stubs.adapt = sandbox.stub(dash, 'enableAdaptation');
stubs.showGearHdIcon = sandbox.stub(dash, 'showGearHdIcon');
stubs.getActiveTrack = sandbox.stub(dash, 'getActiveTrack');
});

it('should enforce SD if there is no HD video ID', () => {
Expand Down Expand Up @@ -480,7 +483,7 @@ describe('lib/viewers/media/DashViewer', () => {

dash.shakaErrorHandler(shakaError);

const [ event, error ] = dash.emit.getCall(0).args;
const [event, error] = dash.emit.getCall(0).args;
expect(event).to.equal('error');
expect(error).to.be.instanceof(PreviewError);
expect(error.code).to.equal('error_shaka');
Expand Down Expand Up @@ -570,7 +573,6 @@ describe('lib/viewers/media/DashViewer', () => {
};

Object.defineProperty(VideoBaseViewer.prototype, 'loadUI', { value: sandbox.mock() });

});

afterEach(() => {
Expand All @@ -581,7 +583,6 @@ describe('lib/viewers/media/DashViewer', () => {
dash.hdVideoId = 3;
dash.loadUI();
expect(dash.mediaControls.enableHDSettings).to.be.called;

});

it('should do nothing if there is no HD rep', () => {
Expand Down Expand Up @@ -714,11 +715,11 @@ describe('lib/viewers/media/DashViewer', () => {

describe('loadAlternateAudio()', () => {
it('should select unique audio tracks', () => {
const variant1 = { videoId: 0, audioId: 0, language: 'eng', roles: ['audio0']};
const variant2 = { videoId: 1, audioId: 0, language: 'eng', roles: ['audio0']};
const variant3 = { videoId: 0, audioId: 1, language: 'rus', roles: ['audio1']};
const variant4 = { videoId: 1, audioId: 1, language: 'rus', roles: ['audio1']};
const variant5 = { videoId: 2, audioId: 1, language: 'rus', roles: ['audio1']};
const variant1 = { videoId: 0, audioId: 0, language: 'eng', roles: ['audio0'] };
const variant2 = { videoId: 1, audioId: 0, language: 'eng', roles: ['audio0'] };
const variant3 = { videoId: 0, audioId: 1, language: 'rus', roles: ['audio1'] };
const variant4 = { videoId: 1, audioId: 1, language: 'rus', roles: ['audio1'] };
const variant5 = { videoId: 2, audioId: 1, language: 'rus', roles: ['audio1'] };
const allVariants = [variant1, variant2, variant3, variant4, variant5];
stubs.mockPlayer.expects('getVariantTracks').returns(allVariants);
stubs.mockControls.expects('initAlternateAudio');
Expand All @@ -732,11 +733,11 @@ describe('lib/viewers/media/DashViewer', () => {
});

it('should translate and initialize audio in sorted order', () => {
const variant1 = { videoId: 0, audioId: 0, language: 'eng', roles: ['audio0']};
const variant2 = { videoId: 0, audioId: 1, language: 'rus', roles: ['audio0']};
const variant3 = { videoId: 0, audioId: 2, language: 'spa', roles: ['audio0']};
const variant4 = { videoId: 0, audioId: 3, language: 'kor', roles: ['audio0']};
const variant5 = { videoId: 0, audioId: 4, language: 'fra', roles: ['audio0']};
const variant1 = { videoId: 0, audioId: 0, language: 'eng', roles: ['audio0'] };
const variant2 = { videoId: 0, audioId: 1, language: 'rus', roles: ['audio0'] };
const variant3 = { videoId: 0, audioId: 2, language: 'spa', roles: ['audio0'] };
const variant4 = { videoId: 0, audioId: 3, language: 'kor', roles: ['audio0'] };
const variant5 = { videoId: 0, audioId: 4, language: 'fra', roles: ['audio0'] };
const allVariants = [variant3, variant1, variant4, variant2, variant5];
stubs.mockPlayer.expects('getVariantTracks').returns(allVariants);
stubs.mockControls
Expand All @@ -747,17 +748,15 @@ describe('lib/viewers/media/DashViewer', () => {
});

it('should not initialize alternate audio if there is none', () => {
const variant1 = { videoId: 0, audioId: 0, language: 'eng', roles: ['audio0']};
const variant2 = { videoId: 1, audioId: 0, language: 'eng', roles: ['audio0']};
const variant1 = { videoId: 0, audioId: 0, language: 'eng', roles: ['audio0'] };
const variant2 = { videoId: 1, audioId: 0, language: 'eng', roles: ['audio0'] };
const allVariants = [variant1, variant2];
stubs.mockPlayer.expects('getVariantTracks').returns(allVariants);
stubs.mockControls.expects('initAlternateAudio').never();

dash.loadAlternateAudio();

expect(dash.audioTracks).to.deep.equal([
{ language: 'eng', role: 'audio0' }
]);
expect(dash.audioTracks).to.deep.equal([{ language: 'eng', role: 'audio0' }]);
});
});

Expand Down Expand Up @@ -852,10 +851,9 @@ describe('lib/viewers/media/DashViewer', () => {
describe('calculateVideoDimensions()', () => {
it('should calculate the video dimensions based on the reps', () => {
stubs.mockPlayer.expects('isAudioOnly').returns(false);
stubs.mockPlayer.expects('getVariantTracks').returns([
{ width: 200, videoId: 1 },
{ width: 100, videoId: 2 }
]);
stubs.mockPlayer
.expects('getVariantTracks')
.returns([{ width: 200, videoId: 1 }, { width: 100, videoId: 2 }]);
dash.calculateVideoDimensions();
expect(dash.hdVideoId).to.equal(1);
expect(dash.sdVideoId).to.equal(2);
Expand All @@ -864,10 +862,9 @@ describe('lib/viewers/media/DashViewer', () => {

it('should use SD video dimensions if no HD', () => {
stubs.mockPlayer.expects('isAudioOnly').returns(false);
stubs.mockPlayer.expects('getVariantTracks').returns([
{ width: 640, videoId: 1, audioId: 2 },
{ width: 640, videoId: 1, audioId: 3 }
]);
stubs.mockPlayer
.expects('getVariantTracks')
.returns([{ width: 640, videoId: 1, audioId: 2 }, { width: 640, videoId: 1, audioId: 3 }]);
dash.calculateVideoDimensions();
expect(dash.hdVideoId).to.equal(-1);
expect(dash.sdVideoId).to.equal(1);
Expand All @@ -876,10 +873,9 @@ describe('lib/viewers/media/DashViewer', () => {

it('should default video dimensions when video is audio-only', () => {
stubs.mockPlayer.expects('isAudioOnly').returns(true);
stubs.mockPlayer.expects('getVariantTracks').returns([
{ width: null, videoId: null, audioId: 1 },
{ width: null, videoId: null, audioId: 2 }
]);
stubs.mockPlayer
.expects('getVariantTracks')
.returns([{ width: null, videoId: null, audioId: 1 }, { width: null, videoId: null, audioId: 2 }]);
dash.calculateVideoDimensions();
expect(dash.hdVideoId).to.equal(-1);
expect(dash.sdVideoId).to.equal(-1);
Expand Down Expand Up @@ -1070,4 +1066,32 @@ describe('lib/viewers/media/DashViewer', () => {
expect(result).to.not.be.true;
});
});

describe('showGearHdIcon()', () => {
const hdTrack = {
videoId: 1
};

const sdTrack = {
videoId: 2
};

beforeEach(() => {
dash.hdVideoId = 1;
});

it('should add the hd class', () => {
expect(dash.wrapperEl).to.not.have.class(CSS_CLASS_HD);
dash.showGearHdIcon(hdTrack);
expect(dash.wrapperEl).to.have.class(CSS_CLASS_HD);
});

it('should remove the hd class', () => {
expect(dash.wrapperEl).to.not.have.class(CSS_CLASS_HD);
dash.showGearHdIcon(hdTrack);
expect(dash.wrapperEl).to.have.class(CSS_CLASS_HD);
dash.showGearHdIcon(sdTrack);
expect(dash.wrapperEl).to.not.have.class(CSS_CLASS_HD);
});
});
});