reflow comments in modules/{webaudio,vr}

third_party/WebKit/Source/modules/webaudio/BaseAudioContext.h

 /*
  * Copyright (C) 2010, Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1.  Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2.  Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 62 matching lines @@
 class PannerNode;
 class PeriodicWave;
 class PeriodicWaveConstraints;
 class ScriptProcessorNode;
 class ScriptPromiseResolver;
 class ScriptState;
 class SecurityOrigin;
 class StereoPannerNode;
 class WaveShaperNode;
 
-// BaseAudioContext is the cornerstone of the web audio API and all AudioNodes are created from it.
-// For thread safety between the audio thread and the main thread, it has a rendering graph locking mechanism.
+// BaseAudioContext is the cornerstone of the web audio API and all AudioNodes
+// are created from it.  For thread safety between the audio thread and the main
+// thread, it has a rendering graph locking mechanism.
 
 class MODULES_EXPORT BaseAudioContext : public EventTargetWithInlineData,
                                         public ActiveScriptWrappable,
                                         public ActiveDOMObject {
   USING_GARBAGE_COLLECTED_MIXIN(BaseAudioContext);
   DEFINE_WRAPPERTYPEINFO();
 
  public:
-  // The state of an audio context.  On creation, the state is Suspended. The state is Running if
-  // audio is being processed (audio graph is being pulled for data). The state is Closed if the
-  // audio context has been closed.  The valid transitions are from Suspended to either Running or
-  // Closed; Running to Suspended or Closed. Once Closed, there are no valid transitions.
+  // The state of an audio context.  On creation, the state is Suspended. The
+  // state is Running if audio is being processed (audio graph is being pulled
+  // for data). The state is Closed if the audio context has been closed.  The
+  // valid transitions are from Suspended to either Running or Closed; Running
+  // to Suspended or Closed. Once Closed, there are no valid transitions.
   enum AudioContextState { Suspended, Running, Closed };
 
   // Create an AudioContext for rendering to the audio hardware.
   static BaseAudioContext* create(Document&, ExceptionState&);
 
   ~BaseAudioContext() override;
 
   DECLARE_VIRTUAL_TRACE();
 
   // Is the destination node initialized and ready to handle audio?
   bool isDestinationInitialized() const {
     AudioDestinationNode* dest = destination();
     return dest ? dest->audioDestinationHandler().isInitialized() : false;
   }
 
   // Document notification
   void stop() final;
   bool hasPendingActivity() const final;
 
   // Cannnot be called from the audio thread.
   AudioDestinationNode* destination() const;
 
   size_t currentSampleFrame() const {
-    // TODO: What is the correct value for the current frame if the destination node has gone
-    // away?  0 is a valid frame.
+    // TODO: What is the correct value for the current frame if the destination
+    // node has gone away?  0 is a valid frame.
     return m_destinationNode
                ? m_destinationNode->audioDestinationHandler()
                      .currentSampleFrame()
                : 0;
   }
 
   double currentTime() const {
-    // TODO: What is the correct value for the current time if the destination node has gone
-    // away? 0 is a valid time.
+    // TODO: What is the correct value for the current time if the destination
+    // node has gone away? 0 is a valid time.
     return m_destinationNode
                ? m_destinationNode->audioDestinationHandler().currentTime()
                : 0;
   }
 
   float sampleRate() const {
     return m_destinationNode ? m_destinationNode->handler().sampleRate() : 0;
   }
 
   String state() const;
   AudioContextState contextState() const { return m_contextState; }
   void throwExceptionForClosedState(ExceptionState&);
 
   AudioBuffer* createBuffer(unsigned numberOfChannels,
                             size_t numberOfFrames,
                             float sampleRate,
                             ExceptionState&);
 
   // Asynchronous audio file data decoding.
   ScriptPromise decodeAudioData(ScriptState*,
                                 DOMArrayBuffer* audioData,
                                 AudioBufferCallback* successCallback,
                                 AudioBufferCallback* errorCallback,
                                 ExceptionState&);
 
-  // Handles the promise and callbacks when |decodeAudioData| is finished decoding.
+  // Handles the promise and callbacks when |decodeAudioData| is finished
+  // decoding.
   void handleDecodeAudioData(AudioBuffer*,
                              ScriptPromiseResolver*,
                              AudioBufferCallback* successCallback,
                              AudioBufferCallback* errorCallback);
 
   AudioListener* listener() { return m_listener; }
 
   virtual bool hasRealtimeConstraint() = 0;
 
-  // The AudioNode create methods are called on the main thread (from JavaScript).
+  // The AudioNode create methods are called on the main thread (from
+  // JavaScript).
   AudioBufferSourceNode* createBufferSource(ExceptionState&);
   MediaElementAudioSourceNode* createMediaElementSource(HTMLMediaElement*,
                                                         ExceptionState&);
   MediaStreamAudioSourceNode* createMediaStreamSource(MediaStream*,
                                                       ExceptionState&);
   MediaStreamAudioDestinationNode* createMediaStreamDestination(
       ExceptionState&);
   GainNode* createGain(ExceptionState&);
   BiquadFilterNode* createBiquadFilter(ExceptionState&);
   WaveShaperNode* createWaveShaper(ExceptionState&);
@@ skipping 105 matching lines @@
   void notifyStateChange();
 
   // A context is considered closed if:
   //  - closeContext() has been called.
   //  - it has been stopped by its execution context.
   virtual bool isContextClosed() const { return m_isCleared; }
 
   // Get the security origin for this audio context.
   SecurityOrigin* getSecurityOrigin() const;
 
-  // Get the PeriodicWave for the specified oscillator type.  The table is initialized internally
-  // if necessary.
+  // Get the PeriodicWave for the specified oscillator type.  The table is
+  // initialized internally if necessary.
   PeriodicWave* periodicWave(int type);
 
  protected:
   explicit BaseAudioContext(Document*);
   BaseAudioContext(Document*,
                    unsigned numberOfChannels,
                    size_t numberOfFrames,
                    float sampleRate);
 
   void initialize();
   void uninitialize();
 
   void setContextState(AudioContextState);
 
   virtual void didClose() {}
 
-  // Tries to handle AudioBufferSourceNodes that were started but became disconnected or was never
-  // connected. Because these never get pulled anymore, they will stay around forever. So if we
-  // can, try to stop them so they can be collected.
+  // Tries to handle AudioBufferSourceNodes that were started but became
+  // disconnected or was never connected. Because these never get pulled
+  // anymore, they will stay around forever. So if we can, try to stop them so
+  // they can be collected.
   void handleStoppableSourceNodes();
 
   Member<AudioDestinationNode> m_destinationNode;
 
   // FIXME(dominicc): Move m_resumeResolvers to AudioContext, because only
   // it creates these Promises.
-  // Vector of promises created by resume(). It takes time to handle them, so we collect all of
-  // the promises here until they can be resolved or rejected.
+  // Vector of promises created by resume(). It takes time to handle them, so we
+  // collect all of the promises here until they can be resolved or rejected.
   HeapVector<Member<ScriptPromiseResolver>> m_resumeResolvers;
 
   void setClosedContextSampleRate(float newSampleRate) {
     m_closedContextSampleRate = newSampleRate;
   }
   float closedContextSampleRate() const { return m_closedContextSampleRate; }
 
   void rejectPendingDecodeAudioDataResolvers();
 
   // If any, unlock user gesture requirements if a user gesture is being
@@ skipping 34 matching lines @@
   // the nodes are added to |m_finishedSourceNodes| and scheduled for removal
   // from |m_activeSourceNodes| by the main thread.
   HashSet<UntracedMember<AudioNode>> m_finishedSourceNodes;
 
   // FIXME(dominicc): Move these to AudioContext because only
   // it creates these Promises.
   // Handle Promises for resume() and suspend()
   void resolvePromisesForResume();
   void resolvePromisesForResumeOnMainThread();
 
-  // When the context is going away, reject any pending script promise resolvers.
+  // When the context is going away, reject any pending script promise
+  // resolvers.
   virtual void rejectPendingResolvers();
 
-  // True if we're in the process of resolving promises for resume().  Resolving can take some
-  // time and the audio context process loop is very fast, so we don't want to call resolve an
-  // excessive number of times.
+  // True if we're in the process of resolving promises for resume().  Resolving
+  // can take some time and the audio context process loop is very fast, so we
+  // don't want to call resolve an excessive number of times.
   bool m_isResolvingResumePromises;
 
   // Whether a user gesture is required to start this AudioContext.
   bool m_userGestureRequired;
 
   unsigned m_connectionCount;
 
   // Graph locking.
   RefPtr<DeferredTaskHandler> m_deferredTaskHandler;
 
   // The state of the BaseAudioContext.
   AudioContextState m_contextState;
 
   AsyncAudioDecoder m_audioDecoder;
 
-  // When a context is closed, the sample rate is cleared.  But decodeAudioData can be called
-  // after the context has been closed and it needs the sample rate.  When the context is closed,
-  // the sample rate is saved here.
+  // When a context is closed, the sample rate is cleared.  But decodeAudioData
+  // can be called after the context has been closed and it needs the sample
+  // rate.  When the context is closed, the sample rate is saved here.
   float m_closedContextSampleRate;
 
-  // Vector of promises created by decodeAudioData.  This keeps the resolvers alive until
-  // decodeAudioData finishes decoding and can tell the main thread to resolve them.
+  // Vector of promises created by decodeAudioData.  This keeps the resolvers
+  // alive until decodeAudioData finishes decoding and can tell the main thread
+  // to resolve them.
   HeapHashSet<Member<ScriptPromiseResolver>> m_decodeAudioResolvers;
 
-  // PeriodicWave's for the builtin oscillator types.  These only depend on the sample rate. so
-  // they can be shared with all OscillatorNodes in the context.  To conserve memory, these are
-  // lazily initiialized on first use.
+  // PeriodicWave's for the builtin oscillator types.  These only depend on the
+  // sample rate. so they can be shared with all OscillatorNodes in the context.
+  // To conserve memory, these are lazily initialized on first use.
   Member<PeriodicWave> m_periodicWaveSine;
   Member<PeriodicWave> m_periodicWaveSquare;
   Member<PeriodicWave> m_periodicWaveSawtooth;
   Member<PeriodicWave> m_periodicWaveTriangle;
 
   // This is considering 32 is large enough for multiple channels audio.
   // It is somewhat arbitrary and could be increased if necessary.
   enum { MaxNumberOfChannels = 32 };
 };
 
 }  // namespace blink
 
 #endif  // BaseAudioContext_h