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.

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: Seek time doesn't match filmstrip timecode #131

Merged
merged 2 commits into from
May 22, 2017
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
2 changes: 1 addition & 1 deletion src/lib/viewers/media/MediaControls.js
Original file line number Diff line number Diff line change
Expand Up @@ -721,7 +721,7 @@ class MediaControls extends EventEmitter {
* @return {Object}
*/
computeFilmstripPositions(pageX, rectLeft, rectWidth, filmstripWidth) {
const time = ((pageX - rectLeft) * this.mediaEl.duration) / rectWidth; // given the mouse X position, get the relative time
const time = this.timeScrubber.computeScrubberPosition(pageX) * this.mediaEl.duration; // given the mouse X position, get the relative time
const frame = Math.floor(time / this.filmstripInterval); // get the frame number to show
let frameWidth = filmstripWidth / FILMSTRIP_FRAMES_PER_ROW; // calculate the frame width based on the filmstrip width
let left = -1 * (frame % FILMSTRIP_FRAMES_PER_ROW) * frameWidth; // get the frame position in a given row
Expand Down
19 changes: 14 additions & 5 deletions src/lib/viewers/media/Scrubber.js
Original file line number Diff line number Diff line change
Expand Up @@ -162,19 +162,28 @@ class Scrubber extends EventEmitter {
this.convertedEl.style.width = `${this.convertedValue * 100}%`;
}

/**
* Returns the relative X position of mouse on scrubber
*
* @param {number} pageX - Mouse X position
* @return {number} A float between 0 and 1, for the relative position of pageX
*/
computeScrubberPosition(pageX) {
const rect = this.scrubberEl.getBoundingClientRect();
const relPos = (pageX - rect.left) / rect.width;
return Math.max(Math.min(relPos, MAX_VALUE), MIN_VALUE);
}

/**
* Calculates the position of the scrubber handle based on mouse action
*
* @private
* @param {Event} event - the instance of the class
* @param {Event} event - The mouse event that this handler is subscribed to
* @return {void}
*/
scrubbingHandler(event) {
const rect = this.scrubberEl.getBoundingClientRect();
const pageX = event.pageX;
let newValue = (pageX - rect.left) / rect.width;

newValue = Math.max(Math.min(newValue, MAX_VALUE), MIN_VALUE);
const newValue = this.computeScrubberPosition(pageX);

this.setValue(newValue);
this.emit('valuechange');
Expand Down
8 changes: 7 additions & 1 deletion src/lib/viewers/media/__tests__/MediaControls-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -752,10 +752,11 @@ describe('lib/viewers/media/MediaControls', () => {
duration: 100
};
mediaControls.filmstripInterval = 1;
sandbox.stub(mediaControls.timeScrubber, 'computeScrubberPosition').returns(0.25);

const positions = mediaControls.computeFilmstripPositions(400, 200, 1000, null);

expect(positions.time).to.equal(20);
expect(positions.time).to.equal(25);
expect(positions.left).to.equal(0);
expect(positions.top).to.equal(0);
expect(positions.containerLeft).to.equal(120);
Expand All @@ -766,6 +767,7 @@ describe('lib/viewers/media/MediaControls', () => {
duration: 100
};
mediaControls.filmstripInterval = 1;
sandbox.stub(mediaControls.timeScrubber, 'computeScrubberPosition').returns(0.2);

const positions = mediaControls.computeFilmstripPositions(400, 200, 1000, 16000);

Expand All @@ -780,6 +782,7 @@ describe('lib/viewers/media/MediaControls', () => {
duration: 1100
};
mediaControls.filmstripInterval = 1;
sandbox.stub(mediaControls.timeScrubber, 'computeScrubberPosition').returns(0.2);

const positions = mediaControls.computeFilmstripPositions(400, 200, 1000, 16000);

Expand All @@ -794,6 +797,7 @@ describe('lib/viewers/media/MediaControls', () => {
duration: 2000
};
mediaControls.filmstripInterval = 5;
sandbox.stub(mediaControls.timeScrubber, 'computeScrubberPosition').returns(0.6);

const positions = mediaControls.computeFilmstripPositions(800, 200, 1000, 16000);

Expand All @@ -808,6 +812,7 @@ describe('lib/viewers/media/MediaControls', () => {
duration: 100
};
mediaControls.filmstripInterval = 1;
sandbox.stub(mediaControls.timeScrubber, 'computeScrubberPosition').returns(0.01);

const positions = mediaControls.computeFilmstripPositions(210, 200, 1000, 16000);

Expand All @@ -822,6 +827,7 @@ describe('lib/viewers/media/MediaControls', () => {
duration: 100
};
mediaControls.filmstripInterval = 1;
sandbox.stub(mediaControls.timeScrubber, 'computeScrubberPosition').returns(0.99);

const positions = mediaControls.computeFilmstripPositions(1190, 200, 1000, 16000);

Expand Down
43 changes: 40 additions & 3 deletions src/lib/viewers/media/__tests__/Scrubber-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -122,14 +122,51 @@ describe('lib/viewers/media/Scrubber', () => {
it('should adjust the scrubber value to the current scrubber handle position value in the video', () => {
stubs.setValue = sandbox.stub(scrubber, 'setValue');
stubs.emit = sandbox.stub(scrubber, 'emit');
scrubber.scrubberEl.style.width = '25px';
scrubber.scrubbingHandler({ pageX: 100 });
stubs.scrubberPosition = sandbox.stub(scrubber, 'computeScrubberPosition').returns(0.5);

expect(stubs.setValue).to.be.calledWith(1);
scrubber.scrubbingHandler({ pageX: 50 });

expect(stubs.scrubberPosition).to.be.calledWith(50);
expect(stubs.setValue).to.be.calledWith(0.5);
expect(stubs.emit).to.be.calledWith('valuechange');
});
});

describe('computeScrubberPosition()', () => {
it('should compute correct scrubber position', () => {
sandbox.stub(scrubber.scrubberEl, 'getBoundingClientRect').returns({
left: 20,
width: 100
});

const position = scrubber.computeScrubberPosition(30);

expect(position).to.equal(0.1);
});

it('should cap the scrubber position to 1', () => {
sandbox.stub(scrubber.scrubberEl, 'getBoundingClientRect').returns({
left: 20,
width: 100
});

const position = scrubber.computeScrubberPosition(130);

expect(position).to.equal(1);
});

it('should floor the scrubber position to 0', () => {
sandbox.stub(scrubber.scrubberEl, 'getBoundingClientRect').returns({
left: 20,
width: 100
});

const position = scrubber.computeScrubberPosition(10);

expect(position).to.equal(0);
});
});

describe('mouseDownHandler()', () => {
beforeEach(() => {
stubs.scrub = sandbox.stub(scrubber, 'scrubbingHandler');
Expand Down