src/third_party/WebKit/Source/modules/webaudio/AudioScheduledSourceNode.h

   1 /*
   2  * Copyright (C) 2012 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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef AudioScheduledSourceNode_h
  30 #define AudioScheduledSourceNode_h
  31
  32 #include "modules/webaudio/AudioSourceNode.h"
  33
  34 namespace WebCore {
  35
  36 class AudioBus;
  37
  38 class AudioScheduledSourceNode : public AudioSourceNode {
  39 public:
  40     // These are the possible states an AudioScheduledSourceNode can be in:
  41     //
  42     // UNSCHEDULED_STATE - Initial playback state. Created, but not yet scheduled.
  43     // SCHEDULED_STATE - Scheduled to play (via noteOn() or noteGrainOn()), but not yet playing.
  44     // PLAYING_STATE - Generating sound.
  45     // FINISHED_STATE - Finished generating sound.
  46     //
  47     // The state can only transition to the next state, except for the FINISHED_STATE which can
  48     // never be changed.
  49     enum PlaybackState {
  50         // These must be defined with the same names and values as in the .idl file.
  51         UNSCHEDULED_STATE = 0,
  52         SCHEDULED_STATE = 1,
  53         PLAYING_STATE = 2,
  54         FINISHED_STATE = 3
  55     };
  56
  57     // This helper class handles the lifetime of an AudioScheduledSourceNode with an onended event
  58     // listener. This keeps the node alive until the event listener is processed.
  59     class NotifyEndedTask {
  60     public:
  61         NotifyEndedTask(PassRefPtr<AudioScheduledSourceNode> scheduledNode);
  62         void notifyEnded();
  63
  64     private:
  65         RefPtr<AudioScheduledSourceNode> m_scheduledNode;
  66     };
  67
  68     AudioScheduledSourceNode(AudioContext*, float sampleRate);
  69
  70     // Scheduling.
  71     void start(ExceptionState& exceptionState) { start(0.0, exceptionState); }
  72     void start(double when, ExceptionState&);
  73     void stop(ExceptionState& exceptionState) { stop(0.0, exceptionState); }
  74     void stop(double when, ExceptionState&);
  75
  76     unsigned short playbackState() const { return static_cast<unsigned short>(m_playbackState); }
  77     bool isPlayingOrScheduled() const { return m_playbackState == PLAYING_STATE || m_playbackState == SCHEDULED_STATE; }
  78     bool hasFinished() const { return m_playbackState == FINISHED_STATE; }
  79
  80     EventListener* onended() { return getAttributeEventListener(EventTypeNames::ended); }
  81     void setOnended(PassRefPtr<EventListener>);
  82
  83 protected:
  84     // Get frame information for the current time quantum.
  85     // We handle the transition into PLAYING_STATE and FINISHED_STATE here,
  86     // zeroing out portions of the outputBus which are outside the range of startFrame and endFrame.
  87     //
  88     // Each frame time is relative to the context's currentSampleFrame().
  89     // quantumFrameOffset    : Offset frame in this time quantum to start rendering.
  90     // nonSilentFramesToProcess : Number of frames rendering non-silence (will be <= quantumFrameSize).
  91     void updateSchedulingInfo(size_t quantumFrameSize,
  92                               AudioBus* outputBus,
  93                               size_t& quantumFrameOffset,
  94                               size_t& nonSilentFramesToProcess);
  95
  96     // Called when we have no more sound to play or the noteOff() time has been reached.
  97     virtual void finish();
  98
  99     static void notifyEndedDispatch(void*);
 100
 101     PlaybackState m_playbackState;
 102
 103     // m_startTime is the time to start playing based on the context's timeline (0 or a time less than the context's current time means "now").
 104     double m_startTime; // in seconds
 105
 106     // m_endTime is the time to stop playing based on the context's timeline (0 or a time less than the context's current time means "now").
 107     // If it hasn't been set explicitly, then the sound will not stop playing (if looping) or will stop when the end of the AudioBuffer
 108     // has been reached.
 109     double m_endTime; // in seconds
 110
 111     bool m_hasEndedListener;
 112
 113     static const double UnknownTime;
 114 };
 115
 116 } // namespace WebCore
 117
 118 #endif // AudioScheduledSourceNode_h