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

apply periodStart instead of timestampOffset to text reference times #411

Closed
wants to merge 1 commit into from
Closed

apply periodStart instead of timestampOffset to text reference times #411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions lib/media/media_source_engine.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,14 +346,17 @@ shaka.media.MediaSourceEngine.prototype.getBuffered_ = function(contentType) {
* @param {!ArrayBuffer|!ArrayBufferView} data
* @param {?number} startTime
* @param {?number} endTime
* @param {?number} periodStart
* @return {!Promise}
*/
shaka.media.MediaSourceEngine.prototype.appendBuffer =
function(contentType, data, startTime, endTime) {
function(contentType, data, startTime, endTime, periodStart) {
if (contentType == 'text') {
goog.asserts.assert(startTime != null && endTime != null,
'text streams do not have init segments!');
return this.textEngine_.appendBuffer(data, startTime, endTime);
goog.asserts.assert(periodStart != null,
'must pass periodStart for text streams');
return this.textEngine_.appendBuffer(data, startTime, endTime, periodStart);
}
return this.enqueueOperation_(
contentType,
Expand Down
10 changes: 6 additions & 4 deletions lib/media/streaming_engine.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1312,8 +1312,8 @@ shaka.media.StreamingEngine.prototype.initSourceBuffer_ = function(
if (this.destroyed_) return;
shaka.log.v1(logPrefix, 'appending init segment');

return this.mediaSourceEngine_.appendBuffer(
mediaState.type, initSegment, null /* startTime */, null /* endTime */);
return this.mediaSourceEngine_.appendBuffer(mediaState.type, initSegment,
null /* startTime */, null /* endTime */, null /* periodStart */);
}.bind(this)).catch(function(error) {
mediaState.needInitSegment = true;
return Promise.reject(error);
Expand All @@ -1337,13 +1337,15 @@ shaka.media.StreamingEngine.prototype.initSourceBuffer_ = function(
shaka.media.StreamingEngine.prototype.append_ = function(
mediaState, playheadTime, stream, reference, segment) {
var logPrefix = shaka.media.StreamingEngine.logPrefix_(mediaState);
var currentPeriodIndex = this.findPeriodContainingStream_(stream);
var currentPeriod = this.manifest_.periods[currentPeriodIndex];

return this.evict_(mediaState, playheadTime).then(function() {
if (this.destroyed_) return;
shaka.log.v1(logPrefix, 'appending media segment');

return this.mediaSourceEngine_.appendBuffer(
mediaState.type, segment, reference.startTime, reference.endTime);
return this.mediaSourceEngine_.appendBuffer(mediaState.type, segment,
reference.startTime, reference.endTime, currentPeriod.startTime);
}.bind(this)).then(function() {
if (this.destroyed_) return;
shaka.log.v2(logPrefix, 'appended media segment');
Expand Down
10 changes: 7 additions & 3 deletions lib/media/text_engine.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,18 @@ shaka.media.TextEngine.prototype.destroy = function() {
* @param {ArrayBuffer|ArrayBufferView} buffer
* @param {number} startTime
* @param {number} endTime
* @param {number} periodStart
* @return {!Promise}
*/
shaka.media.TextEngine.prototype.appendBuffer =
function(buffer, startTime, endTime) {
function(buffer, startTime, endTime, periodStart) {
var offset = this.timestampOffset_;

startTime += offset;
endTime += offset;
// These times are derived from reference start and end times which are
// relative to the start of the period. The buffer should be relative to
// the presentation start time (AST), so we add the period start to adjust.
startTime += periodStart;
endTime += periodStart;

// Start the operation asynchronously to avoid blocking the caller.
return Promise.resolve().then(function() {
Expand Down
79 changes: 37 additions & 42 deletions test/media/text_engine_unit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,14 @@ describe('TextEngine', function() {
describe('appendBuffer', function() {
it('works asynchronously', function(done) {
mockParser.and.returnValue([1, 2, 3]);
textEngine.appendBuffer(dummyData, 0, 3).catch(fail).then(done);
textEngine.appendBuffer(dummyData, 0, 3, 0).catch(fail).then(done);
expect(mockTrack.addCue).not.toHaveBeenCalled();
});

it('adds cues to the track', function(done) {
mockParser.and.returnValue([1, 2, 3]);

textEngine.appendBuffer(dummyData, 0, 3).then(function() {
textEngine.appendBuffer(dummyData, 0, 3, 0).then(function() {
expect(mockParser).toHaveBeenCalledWith(dummyData);
expect(mockTrack.addCue).toHaveBeenCalledWith(1);
expect(mockTrack.addCue).toHaveBeenCalledWith(2);
Expand All @@ -74,7 +74,7 @@ describe('TextEngine', function() {
mockParser.calls.reset();

mockParser.and.returnValue([4, 5]);
return textEngine.appendBuffer(dummyData, 3, 5);
return textEngine.appendBuffer(dummyData, 3, 5, 0);
}).then(function() {
expect(mockParser).toHaveBeenCalledWith(dummyData);
expect(mockTrack.addCue).toHaveBeenCalledWith(4);
Expand All @@ -96,15 +96,15 @@ describe('TextEngine', function() {
});

it('works asynchronously', function(done) {
textEngine.appendBuffer(dummyData, 0, 3).then(function() {
textEngine.appendBuffer(dummyData, 0, 3, 0).then(function() {
var p = textEngine.remove(0, 1);
expect(mockTrack.removeCue).not.toHaveBeenCalled();
return p;
}).catch(fail).then(done);
});

it('removes cues which overlap the range', function(done) {
textEngine.appendBuffer(dummyData, 0, 3).then(function() {
textEngine.appendBuffer(dummyData, 0, 3, 0).then(function() {
return textEngine.remove(0, 1);
}).then(function() {
expect(mockTrack.removeCue.calls.allArgs()).toEqual([[cue1]]);
Expand Down Expand Up @@ -139,13 +139,13 @@ describe('TextEngine', function() {
return [createFakeCue(0, 1), createFakeCue(2, 3)];
});

textEngine.appendBuffer(dummyData, 0, 3).then(function() {
textEngine.appendBuffer(dummyData, 0, 3, 0).then(function() {
expect(mockTrack.addCue).toHaveBeenCalledWith(createFakeCue(0, 1));
expect(mockTrack.addCue).toHaveBeenCalledWith(createFakeCue(2, 3));

mockTrack.addCue.calls.reset();
textEngine.setTimestampOffset(4);
return textEngine.appendBuffer(dummyData, 0, 3);
return textEngine.appendBuffer(dummyData, 0, 3, 0);
}).then(function() {
expect(mockTrack.addCue).toHaveBeenCalledWith(createFakeCue(4, 5));
expect(mockTrack.addCue).toHaveBeenCalledWith(createFakeCue(6, 7));
Expand All @@ -166,49 +166,45 @@ describe('TextEngine', function() {
});

it('reflect newly-added cues', function(done) {
textEngine.appendBuffer(dummyData, 0, 3).then(function() {
expect(textEngine.bufferStart()).toBe(0);
expect(textEngine.bufferEnd()).toBe(3);
textEngine.appendBuffer(dummyData, 0, 3, 10).then(function() {
expect(textEngine.bufferStart()).toBe(10);
expect(textEngine.bufferEnd()).toBe(13);

textEngine.setTimestampOffset(3);
return textEngine.appendBuffer(dummyData, 0, 3);
return textEngine.appendBuffer(dummyData, 0, 3, 13);
}).then(function() {
expect(textEngine.bufferStart()).toBe(0);
expect(textEngine.bufferEnd()).toBe(6);
expect(textEngine.bufferStart()).toBe(10);
expect(textEngine.bufferEnd()).toBe(16);

textEngine.setTimestampOffset(7);
return textEngine.appendBuffer(dummyData, 0, 3);
return textEngine.appendBuffer(dummyData, 0, 3, 16);
}).then(function() {
expect(textEngine.bufferStart()).toBe(0);
expect(textEngine.bufferEnd()).toBe(10);
expect(textEngine.bufferStart()).toBe(10);
expect(textEngine.bufferEnd()).toBe(19);
}).catch(fail).then(done);
});

it('reflect newly-removed cues', function(done) {
textEngine.appendBuffer(dummyData, 0, 3).then(function() {
textEngine.setTimestampOffset(3);
return textEngine.appendBuffer(dummyData, 0, 3);
textEngine.appendBuffer(dummyData, 0, 3, 10).then(function() {
return textEngine.appendBuffer(dummyData, 0, 3, 10);
}).then(function() {
textEngine.setTimestampOffset(7);
return textEngine.appendBuffer(dummyData, 0, 3);
return textEngine.appendBuffer(dummyData, 0, 3, 13);
}).then(function() {
expect(textEngine.bufferStart()).toBe(0);
expect(textEngine.bufferEnd()).toBe(10);
expect(textEngine.bufferStart()).toBe(10);
expect(textEngine.bufferEnd()).toBe(16);

return textEngine.remove(0, 3);
return textEngine.remove(10, 13);
}).then(function() {
expect(textEngine.bufferStart()).toBe(3);
expect(textEngine.bufferEnd()).toBe(10);
expect(textEngine.bufferStart()).toBe(13);
expect(textEngine.bufferEnd()).toBe(16);

return textEngine.remove(8, 11);
return textEngine.remove(15, 20);
}).then(function() {
expect(textEngine.bufferStart()).toBe(3);
expect(textEngine.bufferEnd()).toBe(8);
expect(textEngine.bufferStart()).toBe(13);
expect(textEngine.bufferEnd()).toBe(15);

return textEngine.remove(11, 20);
return textEngine.remove(17, 20);
}).then(function() {
expect(textEngine.bufferStart()).toBe(3);
expect(textEngine.bufferEnd()).toBe(8);
expect(textEngine.bufferStart()).toBe(13);
expect(textEngine.bufferEnd()).toBe(15);

return textEngine.remove(0, Number.POSITIVE_INFINITY);
}).then(function() {
Expand All @@ -230,15 +226,14 @@ describe('TextEngine', function() {
});

it('returns 0 if |t| is not buffered', function(done) {
textEngine.setTimestampOffset(3);
textEngine.appendBuffer(dummyData, 0, 3).then(function() {
textEngine.appendBuffer(dummyData, 0, 3, 3).then(function() {
expect(textEngine.bufferedAheadOf(2.9)).toBe(0);
expect(textEngine.bufferedAheadOf(6.1)).toBe(0);
}).catch(fail).then(done);
});

it('returns the distance to the end if |t| is buffered', function(done) {
textEngine.appendBuffer(dummyData, 0, 3).then(function() {
textEngine.appendBuffer(dummyData, 0, 3, 0).then(function() {
expect(textEngine.bufferedAheadOf(0)).toBe(3);
expect(textEngine.bufferedAheadOf(1)).toBe(2);
expect(textEngine.bufferedAheadOf(2.5)).toBeCloseTo(0.5);
Expand All @@ -255,13 +250,13 @@ describe('TextEngine', function() {

it('limits appended cues', function(done) {
textEngine.setAppendWindowEnd(1.9);
textEngine.appendBuffer(dummyData, 0, 3).then(function() {
textEngine.appendBuffer(dummyData, 0, 3, 0).then(function() {
expect(mockTrack.addCue).toHaveBeenCalledWith(createFakeCue(0, 1));
expect(mockTrack.addCue).toHaveBeenCalledWith(createFakeCue(1, 2));

mockTrack.addCue.calls.reset();
textEngine.setAppendWindowEnd(2.1);
return textEngine.appendBuffer(dummyData, 0, 3);
return textEngine.appendBuffer(dummyData, 0, 3, 0);
}).then(function() {
expect(mockTrack.addCue).toHaveBeenCalledWith(createFakeCue(0, 1));
expect(mockTrack.addCue).toHaveBeenCalledWith(createFakeCue(1, 2));
Expand All @@ -271,16 +266,16 @@ describe('TextEngine', function() {

it('limits bufferEnd', function(done) {
textEngine.setAppendWindowEnd(1.9);
textEngine.appendBuffer(dummyData, 0, 3).then(function() {
textEngine.appendBuffer(dummyData, 0, 3, 0).then(function() {
expect(textEngine.bufferEnd()).toBe(1.9);

textEngine.setAppendWindowEnd(2.1);
return textEngine.appendBuffer(dummyData, 0, 3);
return textEngine.appendBuffer(dummyData, 0, 3, 0);
}).then(function() {
expect(textEngine.bufferEnd()).toBe(2.1);

textEngine.setAppendWindowEnd(4.1);
return textEngine.appendBuffer(dummyData, 0, 3);
return textEngine.appendBuffer(dummyData, 0, 3, 0);
}).then(function() {
expect(textEngine.bufferEnd()).toBe(3);
}).catch(fail).then(done);
Expand Down