Add a name attribute for each AudioParam

third_party/WebKit/Source/modules/webaudio/AudioParam.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
@@ skipping 25 matching lines @@
 #include "modules/webaudio/AudioSummingJunction.h"
 #include "wtf/PassRefPtr.h"
 #include "wtf/ThreadSafeRefCounted.h"
 #include "wtf/text/WTFString.h"
 #include <sys/types.h>
 
 namespace blink {
 
 class AudioNodeOutput;
 
+// Each AudioParam gets an identifier here.  This is mostly for instrospection if warnings or
+// other messages need to be printed. It's useful to know what the AudioParam represents.  The
+// name should include the node type and the name of the AudioParam.
+enum AudioParamType {
+    ParamTypeAudioBufferSourcePlaybackRate,
+    ParamTypeAudioBufferSourceDetune,
+    ParamTypeBiquadFilterFrequency,
+    ParamTypeBiquadFilterQ,
+    ParamTypeBiquadFilterGain,
+    ParamTypeBiquadFilterDetune,
+    ParamTypeDelayDelayTime,
+    ParamTypeDynamicsCompressorThreshold,
+    ParamTypeDynamicsCompressorKnee,
+    ParamTypeDynamicsCompressorRatio,
+    ParamTypeDynamicsCompressorAttack,
+    ParamTypeDynamicsCompressorRelease,
+    ParamTypeGainGain,
+    ParamTypeOscillatorFrequency,
+    ParamTypeOscillatorDetune,
+    ParamTypeStereoPannerPan
+};
+
 // AudioParamHandler is an actual implementation of web-exposed AudioParam
 // interface. Each of AudioParam object creates and owns an AudioParamHandler,
 // and it is responsible for all of AudioParam tasks. An AudioParamHandler
 // object is owned by the originator AudioParam object, and some audio
 // processing classes have additional references. An AudioParamHandler can
 // outlive the owner AudioParam, and it never dies before the owner AudioParam
 // dies.
 class AudioParamHandler final : public ThreadSafeRefCounted<AudioParamHandler>, public AudioSummingJunction {
 public:
+    AudioParamType getParamType() const { return m_paramType; }
+    // Return a nice name for the AudioParam.
+    String getParamName() const;
+
     static const double DefaultSmoothingConstant;
     static const double SnapThreshold;
 
-    static PassRefPtr<AudioParamHandler> create(AbstractAudioContext& context, double defaultValue)
+    static PassRefPtr<AudioParamHandler> create(AbstractAudioContext& context, AudioParamType paramType, double defaultValue)
     {
-        return adoptRef(new AudioParamHandler(context, defaultValue));
+        return adoptRef(new AudioParamHandler(context, paramType, defaultValue));
     }
 
     // This should be used only in audio rendering thread.
     AudioDestinationHandler& destinationHandler() const;
 
     // AudioSummingJunction
     void didUpdate() override { }
 
     AudioParamTimeline& timeline() { return m_timeline; }
 
@@ skipping 24 matching lines @@
     // Calculates numberOfValues parameter values starting at the context's current time.
     // Must be called in the context's render thread.
     void calculateSampleAccurateValues(float* values, unsigned numberOfValues);
 
     // Connect an audio-rate signal to control this parameter.
     void connect(AudioNodeOutput&);
     void disconnect(AudioNodeOutput&);
 
     float intrinsicValue() const { return noBarrierLoad(&m_intrinsicValue); }
 private:
-    AudioParamHandler(AbstractAudioContext& context, double defaultValue)
+    AudioParamHandler(AbstractAudioContext& context, AudioParamType paramType, double defaultValue)
         : AudioSummingJunction(context.deferredTaskHandler())
+        , m_paramType(paramType)
         , m_intrinsicValue(defaultValue)
         , m_defaultValue(defaultValue)
         , m_smoothedValue(defaultValue)
         , m_destinationHandler(context.destination()->audioDestinationHandler())
     { }
 
     // sampleAccurate corresponds to a-rate (audio rate) vs. k-rate in the Web Audio specification.
     void calculateFinalValues(float* values, unsigned numberOfValues, bool sampleAccurate);
     void calculateTimelineValues(float* values, unsigned numberOfValues);
 
+    // The type of AudioParam, indicating what this AudioParam represents and what node it belongs
+    // to.  Mostly for informational purposes and doesn't affect implementation.
+    AudioParamType m_paramType;
+
     // Intrinsic value
     float m_intrinsicValue;
     void setIntrinsicValue(float newValue) { noBarrierStore(&m_intrinsicValue, newValue); }
 
     float m_defaultValue;
 
     // Smoothing (de-zippering)
     float m_smoothedValue;
 
     AudioParamTimeline m_timeline;
 
     // The destination node used to get necessary information like the smaple rate and context time.
     RefPtr<AudioDestinationHandler> m_destinationHandler;
 };
 
 // AudioParam class represents web-exposed AudioParam interface.
 class AudioParam final : public GarbageCollectedFinalized<AudioParam>, public ScriptWrappable {
     DEFINE_WRAPPERTYPEINFO();
 public:
-    static AudioParam* create(AbstractAudioContext&, double defaultValue);
+    static AudioParam* create(AbstractAudioContext&, AudioParamType, double defaultValue);
     DECLARE_TRACE();
     // |handler| always returns a valid object.
     AudioParamHandler& handler() const { return *m_handler; }
     // |context| always returns a valid object.
     AbstractAudioContext* context() const { return m_context; }
 
+    AudioParamType getParamType() const { return handler().getParamType(); }
+    String getParamName() const;
+
     float value() const;
     void setValue(float);
     float defaultValue() const;
     AudioParam* setValueAtTime(float value, double time, ExceptionState&);
     AudioParam* linearRampToValueAtTime(float value, double time, ExceptionState&);
     AudioParam* exponentialRampToValueAtTime(float value, double time, ExceptionState&);
     AudioParam* setTargetAtTime(float target, double time, double timeConstant, ExceptionState&);
     AudioParam* setValueCurveAtTime(DOMFloat32Array* curve, double time, double duration, ExceptionState&);
     AudioParam* cancelScheduledValues(double startTime, ExceptionState&);
 
 private:
-    AudioParam(AbstractAudioContext&, double defaultValue);
+    AudioParam(AbstractAudioContext&, AudioParamType, double defaultValue);
 
     RefPtr<AudioParamHandler> m_handler;
     Member<AbstractAudioContext> m_context;
 };
 
 } // namespace blink
 
 #endif // AudioParam_h