third_party/WebKit/public/platform/WebAudioSourceProvider.h

   1 /*
   2  * Copyright (C) 2011, 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
   6  * are met:
   7  * 1.  Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2.  Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 #ifndef WebAudioSourceProvider_h
  26 #define WebAudioSourceProvider_h
  27
  28 #include "WebVector.h"
  29
  30 namespace blink {
  31
  32 class WebAudioSourceProviderClient;
  33
  34 // Abstract interface for a pull-model client.
  35 class WebAudioSourceProvider {
  36 public:
  37     virtual ~WebAudioSourceProvider() { }
  38
  39     // provideInput() gets called repeatedly to render time-slices of a continuous audio stream.
  40     virtual void provideInput(const WebVector<float*>& audioData, size_t numberOfFrames) = 0;
  41
  42     // If a client is set, we call it back when the audio format is available.
  43     virtual void setClient(WebAudioSourceProviderClient*) { }
  44 };
  45
  46 } // WebKit
  47
  48 #endif // WebAudioSourceProvider_h