third_party/WebKit/public/platform/WebSourceBuffer.h

   1 /*
   2  * Copyright (C) 2013 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebSourceBuffer_h
  32 #define WebSourceBuffer_h
  33
  34 #include "WebTimeRange.h"
  35
  36 namespace blink {
  37
  38 class WebSourceBufferClient;
  39
  40 class WebSourceBuffer {
  41 public:
  42     enum AppendMode {
  43         AppendModeSegments,
  44         AppendModeSequence
  45     };
  46
  47     virtual ~WebSourceBuffer() { }
  48
  49     // This will only be called once and only with a non-null pointer to a
  50     // client whose ownership is not transferred to this WebSourceBuffer.
  51     virtual void setClient(WebSourceBufferClient*) = 0;
  52
  53     virtual bool setMode(AppendMode) = 0;
  54     virtual WebTimeRanges buffered() = 0;
  55
  56     // Run coded frame eviction/garbage collection algorithm.
  57     // |currentPlaybackTime| is HTMLMediaElement::currentTime. The algorithm
  58     // will try to preserve data around current playback position.
  59     // |newDataSize| is size of new data about to be appended to SourceBuffer.
  60     // Could be zero for appendStream if stream size is unknown in advance.
  61     // Returns false if buffer is still full after eviction.
  62     virtual bool evictCodedFrames(double currentPlaybackTime, size_t newDataSize) = 0;
  63
  64     // Appends data and runs the segment parser loop algorithm.
  65     // The algorithm may update |*timestampOffset| if |timestampOffset| is not null.
  66     virtual void append(const unsigned char* data, unsigned length, double* timestampOffset) = 0;
  67
  68     virtual void resetParserState() = 0;
  69     virtual void remove(double start, double end) = 0;
  70     virtual bool setTimestampOffset(double) = 0;
  71
  72     // Set presentation timestamp for the start of append window.
  73     virtual void setAppendWindowStart(double) = 0;
  74
  75     // Set presentation timestamp for the end of append window.
  76     virtual void setAppendWindowEnd(double) = 0;
  77
  78     // After this method is called, this WebSourceBuffer should never use the
  79     // client pointer passed to setClient().
  80     virtual void removedFromMediaSource() = 0;
  81 };
  82
  83 } // namespace blink
  84
  85 #endif