| @@ -156,7 +156,7 @@ void MPEInstrument::processNextMidiEvent (const MidiMessage& message) | |||||
| //============================================================================== | //============================================================================== | ||||
| void MPEInstrument::processMidiNoteOnMessage (const MidiMessage& message) | void MPEInstrument::processMidiNoteOnMessage (const MidiMessage& message) | ||||
| { | { | ||||
| // Note: if a note-on with velocity = 0 is used to convey a note-off, | |||||
| // Note: If a note-on with velocity = 0 is used to convey a note-off, | |||||
| // then the actual note-off velocity is not known. In this case, | // then the actual note-off velocity is not known. In this case, | ||||
| // the MPE convention is to use note-off velocity = 64. | // the MPE convention is to use note-off velocity = 64. | ||||
| @@ -271,7 +271,7 @@ public: | |||||
| MPE note's key state (whether the key is down and/or the note is | MPE note's key state (whether the key is down and/or the note is | ||||
| sustained) has changed. | sustained) has changed. | ||||
| Note: if the key state changes to MPENote::off, noteReleased is | |||||
| Note: If the key state changes to MPENote::off, noteReleased is | |||||
| called instead. | called instead. | ||||
| */ | */ | ||||
| virtual void noteKeyStateChanged (MPENote changedNote) = 0; | virtual void noteKeyStateChanged (MPENote changedNote) = 0; | ||||
| @@ -215,7 +215,7 @@ private: | |||||
| std::size_t pos = 0; | std::size_t pos = 0; | ||||
| MidiBuffer::Iterator iter (midiBuffer); | MidiBuffer::Iterator iter (midiBuffer); | ||||
| MidiMessage midiMessage; | MidiMessage midiMessage; | ||||
| int samplePosition; // Note: not actually used, so no need to initialise. | |||||
| int samplePosition; // Note: Not actually used, so no need to initialise. | |||||
| while (iter.getNextEvent (midiMessage, samplePosition)) | while (iter.getNextEvent (midiMessage, samplePosition)) | ||||
| { | { | ||||
| @@ -35,7 +35,7 @@ namespace juce | |||||
| class instead. You just need to take care to send them to the appropriate | class instead. You just need to take care to send them to the appropriate | ||||
| per-note MIDI channel. | per-note MIDI channel. | ||||
| Note: if you are working with an MPEZoneLayout object inside your app, | |||||
| Note: If you are working with an MPEZoneLayout object inside your app, | |||||
| you should not use the message sequences provided here. Instead, you should | you should not use the message sequences provided here. Instead, you should | ||||
| change the zone layout programmatically with the member functions provided in the | change the zone layout programmatically with the member functions provided in the | ||||
| MPEZoneLayout class itself. You should also make sure that the Expressive | MPEZoneLayout class itself. You should also make sure that the Expressive | ||||
| @@ -42,7 +42,7 @@ void MidiOutput::sendBlockOfMessagesNow (const MidiBuffer& buffer) | |||||
| { | { | ||||
| MidiBuffer::Iterator i (buffer); | MidiBuffer::Iterator i (buffer); | ||||
| MidiMessage message; | MidiMessage message; | ||||
| int samplePosition; // Note: not actually used, so no need to initialise. | |||||
| int samplePosition; // Note: Not actually used, so no need to initialise. | |||||
| while (i.getNextEvent (message, samplePosition)) | while (i.getNextEvent (message, samplePosition)) | ||||
| sendMessageNow (message); | sendMessageNow (message); | ||||
| @@ -505,7 +505,7 @@ private: | |||||
| static int defaultFramesPerBurst = getDefaultFramesPerBurst(); | static int defaultFramesPerBurst = getDefaultFramesPerBurst(); | ||||
| // Note: letting OS to choose the buffer capacity & frames per callback. | |||||
| // Note: Letting OS to choose the buffer capacity & frames per callback. | |||||
| builder.setDirection (direction); | builder.setDirection (direction); | ||||
| builder.setSharingMode (sharingMode); | builder.setSharingMode (sharingMode); | ||||
| builder.setChannelCount (channelCount); | builder.setChannelCount (channelCount); | ||||
| @@ -47,7 +47,7 @@ public: | |||||
| //============================================================================== | //============================================================================== | ||||
| /** Receives a callback when a parameter is changed. | /** Receives a callback when a parameter is changed. | ||||
| IMPORTANT NOTE: this will be called synchronously when a parameter changes, and | |||||
| IMPORTANT NOTE: This will be called synchronously when a parameter changes, and | |||||
| many audio processors will change their parameter during their audio callback. | many audio processors will change their parameter during their audio callback. | ||||
| This means that not only has your handler code got to be completely thread-safe, | This means that not only has your handler code got to be completely thread-safe, | ||||
| but it's also got to be VERY fast, and avoid blocking. If you need to handle | but it's also got to be VERY fast, and avoid blocking. If you need to handle | ||||
| @@ -61,7 +61,7 @@ public: | |||||
| /** Called to indicate that something else in the plugin has changed, like its | /** Called to indicate that something else in the plugin has changed, like its | ||||
| program, number of parameters, etc. | program, number of parameters, etc. | ||||
| IMPORTANT NOTE: this will be called synchronously, and many audio processors will | |||||
| IMPORTANT NOTE: This will be called synchronously, and many audio processors will | |||||
| call it during their audio callback. This means that not only has your handler code | call it during their audio callback. This means that not only has your handler code | ||||
| got to be completely thread-safe, but it's also got to be VERY fast, and avoid | got to be completely thread-safe, but it's also got to be VERY fast, and avoid | ||||
| blocking. If you need to handle this event on your message thread, use this callback | blocking. If you need to handle this event on your message thread, use this callback | ||||
| @@ -76,7 +76,7 @@ public: | |||||
| press the mouse button, and audioProcessorParameterChangeGestureEnd would be | press the mouse button, and audioProcessorParameterChangeGestureEnd would be | ||||
| called when they release it. | called when they release it. | ||||
| IMPORTANT NOTE: this will be called synchronously, and many audio processors will | |||||
| IMPORTANT NOTE: This will be called synchronously, and many audio processors will | |||||
| call it during their audio callback. This means that not only has your handler code | call it during their audio callback. This means that not only has your handler code | ||||
| got to be completely thread-safe, but it's also got to be VERY fast, and avoid | got to be completely thread-safe, but it's also got to be VERY fast, and avoid | ||||
| blocking. If you need to handle this event on your message thread, use this callback | blocking. If you need to handle this event on your message thread, use this callback | ||||
| @@ -93,7 +93,7 @@ public: | |||||
| E.g. if the user is dragging a slider, this would be called when they release | E.g. if the user is dragging a slider, this would be called when they release | ||||
| the mouse button. | the mouse button. | ||||
| IMPORTANT NOTE: this will be called synchronously, and many audio processors will | |||||
| IMPORTANT NOTE: This will be called synchronously, and many audio processors will | |||||
| call it during their audio callback. This means that not only has your handler code | call it during their audio callback. This means that not only has your handler code | ||||
| got to be completely thread-safe, but it's also got to be VERY fast, and avoid | got to be completely thread-safe, but it's also got to be VERY fast, and avoid | ||||
| blocking. If you need to handle this event on your message thread, use this callback | blocking. If you need to handle this event on your message thread, use this callback | ||||
| @@ -242,7 +242,7 @@ public: | |||||
| /** Receives a callback when a parameter has been changed. | /** Receives a callback when a parameter has been changed. | ||||
| IMPORTANT NOTE: this will be called synchronously when a parameter changes, and | |||||
| IMPORTANT NOTE: This will be called synchronously when a parameter changes, and | |||||
| many audio processors will change their parameter during their audio callback. | many audio processors will change their parameter during their audio callback. | ||||
| This means that not only has your handler code got to be completely thread-safe, | This means that not only has your handler code got to be completely thread-safe, | ||||
| but it's also got to be VERY fast, and avoid blocking. If you need to handle | but it's also got to be VERY fast, and avoid blocking. If you need to handle | ||||
| @@ -257,7 +257,7 @@ public: | |||||
| being true when they first press the mouse button, and it will be called again with | being true when they first press the mouse button, and it will be called again with | ||||
| gestureIsStarting being false when they release it. | gestureIsStarting being false when they release it. | ||||
| IMPORTANT NOTE: this will be called synchronously, and many audio processors will | |||||
| IMPORTANT NOTE: This will be called synchronously, and many audio processors will | |||||
| call it during their audio callback. This means that not only has your handler code | call it during their audio callback. This means that not only has your handler code | ||||
| got to be completely thread-safe, but it's also got to be VERY fast, and avoid | got to be completely thread-safe, but it's also got to be VERY fast, and avoid | ||||
| blocking. If you need to handle this event on your message thread, use this callback | blocking. If you need to handle this event on your message thread, use this callback | ||||
| @@ -71,7 +71,7 @@ public: | |||||
| If the file can't be opened for some reason, the getData() method will return a null pointer. | If the file can't be opened for some reason, the getData() method will return a null pointer. | ||||
| NOTE: the start of the actual range used may be rounded-down to a multiple of the OS's page-size, | |||||
| NOTE: The start of the actual range used may be rounded-down to a multiple of the OS's page-size, | |||||
| so do not assume that the mapped memory will begin at exactly the position you requested - always | so do not assume that the mapped memory will begin at exactly the position you requested - always | ||||
| use getRange() to check the actual range that is being used. | use getRange() to check the actual range that is being used. | ||||
| */ | */ | ||||
| @@ -39,7 +39,7 @@ namespace juce | |||||
| the underlying object is also immediately destroyed. This allows you to use scoping | the underlying object is also immediately destroyed. This allows you to use scoping | ||||
| to manage the lifetime of a shared resource. | to manage the lifetime of a shared resource. | ||||
| Note: the construction/deletion of the shared object must not involve any | |||||
| Note: The construction/deletion of the shared object must not involve any | |||||
| code that makes recursive calls to a SharedResourcePointer, or you'll cause | code that makes recursive calls to a SharedResourcePointer, or you'll cause | ||||
| a deadlock. | a deadlock. | ||||
| @@ -241,7 +241,7 @@ namespace XmlOutputFunctions | |||||
| outputStream << (char) character; | outputStream << (char) character; | ||||
| break; | break; | ||||
| } | } | ||||
| // Note: deliberate fall-through here! | |||||
| // Note: Deliberate fall-through here! | |||||
| default: | default: | ||||
| outputStream << "&#" << ((int) character) << ';'; | outputStream << "&#" << ((int) character) << ';'; | ||||
| break; | break; | ||||
| @@ -55,7 +55,7 @@ struct FilterDesign | |||||
| It generates linear phase filters coefficients. | It generates linear phase filters coefficients. | ||||
| Note : the flatTop WindowingMethod generates an impulse response with a | |||||
| Note: The flatTop WindowingMethod generates an impulse response with a | |||||
| maximum amplitude higher than one, and might be normalized if necessary | maximum amplitude higher than one, and might be normalized if necessary | ||||
| depending on the applications. | depending on the applications. | ||||
| @@ -85,7 +85,7 @@ public: | |||||
| formats registered in JUCE, and performs some resampling and pre-processing | formats registered in JUCE, and performs some resampling and pre-processing | ||||
| as well if needed. | as well if needed. | ||||
| Note : obviously, don't try to use this function on float samples, since the | |||||
| Note: Obviously, don't try to use this function on float samples, since the | |||||
| data is supposed to be an audio file in its binary format, and be sure that | data is supposed to be an audio file in its binary format, and be sure that | ||||
| the original data is not going to move at all its memory location during the | the original data is not going to move at all its memory location during the | ||||
| process !! | process !! | ||||
| @@ -39,7 +39,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function cosh(x) using a Pade approximant | /** Provides a fast approximation of the function cosh(x) using a Pade approximant | ||||
| continued fraction, calculated sample by sample. | continued fraction, calculated sample by sample. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -5 and +5 for limiting the error. | advised to use input values only between -5 and +5 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -54,7 +54,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function cosh(x) using a Pade approximant | /** Provides a fast approximation of the function cosh(x) using a Pade approximant | ||||
| continued fraction, calculated on a whole buffer. | continued fraction, calculated on a whole buffer. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -5 and +5 for limiting the error. | advised to use input values only between -5 and +5 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -67,7 +67,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function sinh(x) using a Pade approximant | /** Provides a fast approximation of the function sinh(x) using a Pade approximant | ||||
| continued fraction, calculated sample by sample. | continued fraction, calculated sample by sample. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -5 and +5 for limiting the error. | advised to use input values only between -5 and +5 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -82,7 +82,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function sinh(x) using a Pade approximant | /** Provides a fast approximation of the function sinh(x) using a Pade approximant | ||||
| continued fraction, calculated on a whole buffer. | continued fraction, calculated on a whole buffer. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -5 and +5 for limiting the error. | advised to use input values only between -5 and +5 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -95,7 +95,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function tanh(x) using a Pade approximant | /** Provides a fast approximation of the function tanh(x) using a Pade approximant | ||||
| continued fraction, calculated sample by sample. | continued fraction, calculated sample by sample. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -5 and +5 for limiting the error. | advised to use input values only between -5 and +5 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -110,7 +110,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function tanh(x) using a Pade approximant | /** Provides a fast approximation of the function tanh(x) using a Pade approximant | ||||
| continued fraction, calculated on a whole buffer. | continued fraction, calculated on a whole buffer. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -5 and +5 for limiting the error. | advised to use input values only between -5 and +5 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -124,7 +124,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function cos(x) using a Pade approximant | /** Provides a fast approximation of the function cos(x) using a Pade approximant | ||||
| continued fraction, calculated sample by sample. | continued fraction, calculated sample by sample. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -pi and +pi for limiting the error. | advised to use input values only between -pi and +pi for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -139,7 +139,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function cos(x) using a Pade approximant | /** Provides a fast approximation of the function cos(x) using a Pade approximant | ||||
| continued fraction, calculated on a whole buffer. | continued fraction, calculated on a whole buffer. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -pi and +pi for limiting the error. | advised to use input values only between -pi and +pi for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -152,7 +152,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function sin(x) using a Pade approximant | /** Provides a fast approximation of the function sin(x) using a Pade approximant | ||||
| continued fraction, calculated sample by sample. | continued fraction, calculated sample by sample. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -pi and +pi for limiting the error. | advised to use input values only between -pi and +pi for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -167,7 +167,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function sin(x) using a Pade approximant | /** Provides a fast approximation of the function sin(x) using a Pade approximant | ||||
| continued fraction, calculated on a whole buffer. | continued fraction, calculated on a whole buffer. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -pi and +pi for limiting the error. | advised to use input values only between -pi and +pi for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -180,7 +180,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function tan(x) using a Pade approximant | /** Provides a fast approximation of the function tan(x) using a Pade approximant | ||||
| continued fraction, calculated sample by sample. | continued fraction, calculated sample by sample. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -pi/2 and +pi/2 for limiting the error. | advised to use input values only between -pi/2 and +pi/2 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -195,7 +195,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function tan(x) using a Pade approximant | /** Provides a fast approximation of the function tan(x) using a Pade approximant | ||||
| continued fraction, calculated on a whole buffer. | continued fraction, calculated on a whole buffer. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -pi/2 and +pi/2 for limiting the error. | advised to use input values only between -pi/2 and +pi/2 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -209,7 +209,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function exp(x) using a Pade approximant | /** Provides a fast approximation of the function exp(x) using a Pade approximant | ||||
| continued fraction, calculated sample by sample. | continued fraction, calculated sample by sample. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -6 and +4 for limiting the error. | advised to use input values only between -6 and +4 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -223,7 +223,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function exp(x) using a Pade approximant | /** Provides a fast approximation of the function exp(x) using a Pade approximant | ||||
| continued fraction, calculated on a whole buffer. | continued fraction, calculated on a whole buffer. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -6 and +4 for limiting the error. | advised to use input values only between -6 and +4 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -236,7 +236,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function log(x+1) using a Pade approximant | /** Provides a fast approximation of the function log(x+1) using a Pade approximant | ||||
| continued fraction, calculated sample by sample. | continued fraction, calculated sample by sample. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -0.8 and +5 for limiting the error. | advised to use input values only between -0.8 and +5 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -250,7 +250,7 @@ struct FastMathApproximations | |||||
| /** Provides a fast approximation of the function log(x+1) using a Pade approximant | /** Provides a fast approximation of the function log(x+1) using a Pade approximant | ||||
| continued fraction, calculated on a whole buffer. | continued fraction, calculated on a whole buffer. | ||||
| Note : this is an approximation which works on a limited range. You are | |||||
| Note: This is an approximation which works on a limited range. You are | |||||
| advised to use input values only between -0.8 and +5 for limiting the error. | advised to use input values only between -0.8 and +5 for limiting the error. | ||||
| */ | */ | ||||
| template <typename FloatType> | template <typename FloatType> | ||||
| @@ -164,7 +164,7 @@ private: | |||||
| LookupTableTransform<float> tanhApprox ([] (float x) { return std::tanh (x); }, -5.0f, 5.0f, 64); | LookupTableTransform<float> tanhApprox ([] (float x) { return std::tanh (x); }, -5.0f, 5.0f, 64); | ||||
| auto outValue = tanhApprox (4.2f); | auto outValue = tanhApprox (4.2f); | ||||
| Note : if you try to call the function with an input outside the provided | |||||
| Note: If you try to call the function with an input outside the provided | |||||
| range, it will return either the first or the last recorded LookupTable value. | range, it will return either the first or the last recorded LookupTable value. | ||||
| @see LookupTable | @see LookupTable | ||||
| @@ -75,7 +75,7 @@ public: | |||||
| Constructor of the oversampling class. All the processing parameters must be | Constructor of the oversampling class. All the processing parameters must be | ||||
| provided at the creation of the oversampling object. | provided at the creation of the oversampling object. | ||||
| Note : you might want to create a class heriting from Oversampling with a | |||||
| Note: You might want to create a class inheriting from Oversampling with a | |||||
| different constructor if you need more control on what happens in the process. | different constructor if you need more control on what happens in the process. | ||||
| @param numChannels the number of channels to process with this object | @param numChannels the number of channels to process with this object | ||||
| @@ -97,7 +97,7 @@ public: | |||||
| the oversampling, for example with a dry / wet functionality, and to report | the oversampling, for example with a dry / wet functionality, and to report | ||||
| the latency to the DAW. | the latency to the DAW. | ||||
| Note : the latency might not be integer, so you might need to round its value | |||||
| Note: The latency might not be integer, so you might need to round its value | |||||
| or to compensate it properly in your processing code. | or to compensate it properly in your processing code. | ||||
| */ | */ | ||||
| SampleType getLatencyInSamples() noexcept; | SampleType getLatencyInSamples() noexcept; | ||||
| @@ -44,7 +44,7 @@ namespace StateVariableFilter | |||||
| structures for more information). Its behaviour is based on the analog | structures for more information). Its behaviour is based on the analog | ||||
| state variable filter circuit. | state variable filter circuit. | ||||
| Note : the bandpass here is not the one in the RBJ CookBook, its gain can be | |||||
| Note: The bandpass here is not the one in the RBJ CookBook, its gain can be | |||||
| higher than 0 dB. For the classic 0 dB bandpass, we need to multiply the | higher than 0 dB. For the classic 0 dB bandpass, we need to multiply the | ||||
| result with R2 | result with R2 | ||||
| @@ -203,7 +203,8 @@ namespace StateVariableFilter | |||||
| Type type = Type::lowPass; | Type type = Type::lowPass; | ||||
| /** Sets the cutoff frequency and resonance of the IIR filter. | /** Sets the cutoff frequency and resonance of the IIR filter. | ||||
| Note : the bandwidth of the resonance increases with the value of the | |||||
| Note: The bandwidth of the resonance increases with the value of the | |||||
| parameter. To have a standard 12 dB/octave filter, the value must be set | parameter. To have a standard 12 dB/octave filter, the value must be set | ||||
| at 1 / sqrt(2). | at 1 / sqrt(2). | ||||
| */ | */ | ||||
| @@ -75,7 +75,7 @@ public: | |||||
| initialFileOrDirectory will be used as the initial | initialFileOrDirectory will be used as the initial | ||||
| directory of the native file chooser. | directory of the native file chooser. | ||||
| Note: on iOS when saving a file, a user will not | |||||
| Note: On iOS when saving a file, a user will not | |||||
| be able to change a file name, so it may be a good | be able to change a file name, so it may be a good | ||||
| idea to include at least a valid file name in | idea to include at least a valid file name in | ||||
| initialFileOrDirectory. When no filename is found, | initialFileOrDirectory. When no filename is found, | ||||
| @@ -251,7 +251,7 @@ public: | |||||
| may return a URL to a remote document. If a local file is chosen then you can | may return a URL to a remote document. If a local file is chosen then you can | ||||
| convert this file to a JUCE File class via the URL::getLocalFile method. | convert this file to a JUCE File class via the URL::getLocalFile method. | ||||
| Note: on iOS you must use the returned URL object directly (you are also | |||||
| Note: On iOS you must use the returned URL object directly (you are also | |||||
| allowed to copy- or move-construct another URL from the returned URL), rather | allowed to copy- or move-construct another URL from the returned URL), rather | ||||
| than just storing the path as a String and then creating a new URL from that | than just storing the path as a String and then creating a new URL from that | ||||
| String. This is because the returned URL contains internally a security | String. This is because the returned URL contains internally a security | ||||
| @@ -274,7 +274,7 @@ public: | |||||
| This array may be empty if no files were chosen, or can contain multiple entries | This array may be empty if no files were chosen, or can contain multiple entries | ||||
| if multiple files were chosen. | if multiple files were chosen. | ||||
| Note: on iOS you must use the returned URL object directly (you are also | |||||
| Note: On iOS you must use the returned URL object directly (you are also | |||||
| allowed to copy- or move-construct another URL from the returned URL), rather | allowed to copy- or move-construct another URL from the returned URL), rather | ||||
| than just storing the path as a String and then creating a new URL from that | than just storing the path as a String and then creating a new URL from that | ||||
| String. This is because the returned URL contains internally a security | String. This is because the returned URL contains internally a security | ||||
| @@ -1089,7 +1089,7 @@ private: | |||||
| { | { | ||||
| PopupMenuSettings::menuWasHiddenBecauseOfAppChange = true; | PopupMenuSettings::menuWasHiddenBecauseOfAppChange = true; | ||||
| window.dismissMenu (nullptr); | window.dismissMenu (nullptr); | ||||
| // Note: this object may have been deleted by the previous call.. | |||||
| // Note: This object may have been deleted by the previous call. | |||||
| } | } | ||||
| } | } | ||||
| else if (wasDown && timeNow > window.windowCreationTime + 250 | else if (wasDown && timeNow > window.windowCreationTime + 250 | ||||
| @@ -1100,7 +1100,7 @@ private: | |||||
| else if ((window.hasBeenOver || ! window.dismissOnMouseUp) && ! isOverAny) | else if ((window.hasBeenOver || ! window.dismissOnMouseUp) && ! isOverAny) | ||||
| window.dismissMenu (nullptr); | window.dismissMenu (nullptr); | ||||
| // Note: this object may have been deleted by the previous call.. | |||||
| // Note: This object may have been deleted by the previous call. | |||||
| } | } | ||||
| else | else | ||||
| { | { | ||||
| @@ -153,7 +153,7 @@ public: | |||||
| //============================================================================== | //============================================================================== | ||||
| /** Easy way of quickly showing a dialog box containing a given component. | /** Easy way of quickly showing a dialog box containing a given component. | ||||
| Note: this method has been superceded by the DialogWindow::LaunchOptions structure, | |||||
| Note: This method has been superceded by the DialogWindow::LaunchOptions structure, | |||||
| which does the same job with some extra flexibility. The showDialog method is here | which does the same job with some extra flexibility. The showDialog method is here | ||||
| for backwards compatibility, but please use DialogWindow::LaunchOptions in new code. | for backwards compatibility, but please use DialogWindow::LaunchOptions in new code. | ||||
| @@ -199,7 +199,7 @@ public: | |||||
| #if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN | #if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN | ||||
| /** Easy way of quickly showing a dialog box containing a given component. | /** Easy way of quickly showing a dialog box containing a given component. | ||||
| Note: this method has been superceded by the DialogWindow::LaunchOptions structure, | |||||
| Note: This method has been superceded by the DialogWindow::LaunchOptions structure, | |||||
| which does the same job with some extra flexibility. The showDialog method is here | which does the same job with some extra flexibility. The showDialog method is here | ||||
| for backwards compatibility, but please use DialogWindow::LaunchOptions in new code. | for backwards compatibility, but please use DialogWindow::LaunchOptions in new code. | ||||
| @@ -57,14 +57,14 @@ public: | |||||
| The view will be retained and released by this component for as long as | The view will be retained and released by this component for as long as | ||||
| it is needed. To remove the current view, just call setView (nullptr). | it is needed. To remove the current view, just call setView (nullptr). | ||||
| Note: a void* is used here to avoid including the cocoa headers as | |||||
| Note: A void* is used here to avoid including the cocoa headers as | |||||
| part of the juce.h, but the method expects an NSView*. | part of the juce.h, but the method expects an NSView*. | ||||
| */ | */ | ||||
| void setView (void* nsView); | void setView (void* nsView); | ||||
| /** Returns the current NSView. | /** Returns the current NSView. | ||||
| Note: a void* is returned here to avoid the needing to include the cocoa | |||||
| Note: A void* is returned here to avoid the needing to include the cocoa | |||||
| headers, so you should just cast the return value to an NSView*. | headers, so you should just cast the return value to an NSView*. | ||||
| */ | */ | ||||
| void* getView() const; | void* getView() const; | ||||
| @@ -57,14 +57,14 @@ public: | |||||
| The view will be retained and released by this component for as long as | The view will be retained and released by this component for as long as | ||||
| it is needed. To remove the current view, just call setView (nullptr). | it is needed. To remove the current view, just call setView (nullptr). | ||||
| Note: a void* is used here to avoid including the cocoa headers as | |||||
| Note: A void* is used here to avoid including the cocoa headers as | |||||
| part of the juce.h, but the method expects an UIView*. | part of the juce.h, but the method expects an UIView*. | ||||
| */ | */ | ||||
| void setView (void* uiView); | void setView (void* uiView); | ||||
| /** Returns the current UIView. | /** Returns the current UIView. | ||||
| Note: a void* is returned here to avoid the needing to include the cocoa | |||||
| Note: A void* is returned here to avoid the needing to include the cocoa | |||||
| headers, so you should just cast the return value to an UIView*. | headers, so you should just cast the return value to an UIView*. | ||||
| */ | */ | ||||
| void* getView() const; | void* getView() const; | ||||
| @@ -615,7 +615,7 @@ public: | |||||
| notification was received when the app was in the foreground already. On iOS 10 it will be | notification was received when the app was in the foreground already. On iOS 10 it will be | ||||
| called when a user presses on a notification | called when a user presses on a notification | ||||
| Note: on Android, if remote notification was received while the app was in the background and | |||||
| Note: On Android, if remote notification was received while the app was in the background and | |||||
| then user pressed on it, the notification object received in this callback will contain only | then user pressed on it, the notification object received in this callback will contain only | ||||
| "properties" member set. Hence, if you want to know what was the notification title, content | "properties" member set. Hence, if you want to know what was the notification title, content | ||||
| etc, you need to set them as additional properties, so that you will be able to restore them | etc, you need to set them as additional properties, so that you will be able to restore them | ||||
| @@ -1128,7 +1128,7 @@ struct PushNotifications::Pimpl | |||||
| var resultVar; | var resultVar; | ||||
| JSON::parse (juceString (varString.get()), resultVar); | JSON::parse (juceString (varString.get()), resultVar); | ||||
| // Note: we are not checking if result of parsing was okay, because there may be no properties set at all. | |||||
| // Note: We are not checking if result of parsing was okay, because there may be no properties set at all. | |||||
| return resultVar; | return resultVar; | ||||
| } | } | ||||
| @@ -1321,8 +1321,8 @@ struct PushNotifications::Pimpl | |||||
| auto objectClass = LocalRef<jobject> (env->CallObjectMethod (object, JavaObject.getClass)); | auto objectClass = LocalRef<jobject> (env->CallObjectMethod (object, JavaObject.getClass)); | ||||
| auto classAsString = LocalRef<jstring> ((jstring) env->CallObjectMethod (objectClass, JavaClass.getName)); | auto classAsString = LocalRef<jstring> ((jstring) env->CallObjectMethod (objectClass, JavaClass.getName)); | ||||
| // Note: seems that Firebase delivers values as strings always, so this check is rather unnecessary, | |||||
| // at least till they change the behaviour. | |||||
| // Note: It seems that Firebase delivers values as strings always, so this check is rather unnecessary, | |||||
| // at least untill they change the behaviour. | |||||
| var value = juceString (classAsString) == "java.lang.Bundle" ? bundleToVar (object) : var (juceString (objectAsString.get())); | var value = juceString (classAsString) == "java.lang.Bundle" ? bundleToVar (object) : var (juceString (objectAsString.get())); | ||||
| dynamicObject->setProperty (juceString (key.get()), value); | dynamicObject->setProperty (juceString (key.get()), value); | ||||
| } | } | ||||
| @@ -1411,7 +1411,7 @@ struct PushNotifications::Pimpl | |||||
| const uint8 b = (uint8) colourString.substring (4, 6).getIntValue(); | const uint8 b = (uint8) colourString.substring (4, 6).getIntValue(); | ||||
| n.accentColour = Colour (r, g, b); | n.accentColour = Colour (r, g, b); | ||||
| // Note: ignoring icon, because Firebase passes it as a string. | |||||
| // Note: Ignoring the icon, because Firebase passes it as a string. | |||||
| propertiesDynamicObject->setProperty ("clickAction", juceString (clickAction.get())); | propertiesDynamicObject->setProperty ("clickAction", juceString (clickAction.get())); | ||||
| propertiesDynamicObject->setProperty ("bodyLocalizationKey", juceString (bodyLocalizationKey.get())); | propertiesDynamicObject->setProperty ("bodyLocalizationKey", juceString (bodyLocalizationKey.get())); | ||||
| @@ -108,7 +108,7 @@ namespace ActiveXHelpers | |||||
| JUCE_COMRESULT GetWindowContext (LPOLEINPLACEFRAME* lplpFrame, LPOLEINPLACEUIWINDOW* lplpDoc, LPRECT, LPRECT, LPOLEINPLACEFRAMEINFO lpFrameInfo) | JUCE_COMRESULT GetWindowContext (LPOLEINPLACEFRAME* lplpFrame, LPOLEINPLACEUIWINDOW* lplpDoc, LPRECT, LPRECT, LPOLEINPLACEFRAMEINFO lpFrameInfo) | ||||
| { | { | ||||
| /* Note: if you call AddRef on the frame here, then some types of object (e.g. web browser control) cause leaks.. | |||||
| /* Note: If you call AddRef on the frame here, then some types of object (e.g. web browser control) cause leaks.. | |||||
| If you don't call AddRef then others crash (e.g. QuickTime).. Bit of a catch-22, so letting it leak is probably preferable. | If you don't call AddRef then others crash (e.g. QuickTime).. Bit of a catch-22, so letting it leak is probably preferable. | ||||
| */ | */ | ||||
| if (lplpFrame != nullptr) { frame->AddRef(); *lplpFrame = frame; } | if (lplpFrame != nullptr) { frame->AddRef(); *lplpFrame = frame; } | ||||
| @@ -97,7 +97,7 @@ namespace | |||||
| if (pattern == patternEnd) | if (pattern == patternEnd) | ||||
| return false; | return false; | ||||
| // Note: in case this code is ever moved into the more generic CharPointerFunctions, | |||||
| // Note: In case this code is ever moved into the more generic CharPointerFunctions, | |||||
| // the next two lines probably will not compile as soon as this class is used with a | // the next two lines probably will not compile as soon as this class is used with a | ||||
| // Char template type parameter that is not the same type as String::Char. | // Char template type parameter that is not the same type as String::Char. | ||||
| StringArray set; | StringArray set; | ||||
| @@ -486,7 +486,7 @@ public: | |||||
| expectDoesNotThrow (OSCAddressPattern ("/[a-e]")); | expectDoesNotThrow (OSCAddressPattern ("/[a-e]")); | ||||
| expectDoesNotThrow (OSCAddressPattern ("/foo/[a-z]x{foo,bar}/*BAZ42/")); | expectDoesNotThrow (OSCAddressPattern ("/foo/[a-z]x{foo,bar}/*BAZ42/")); | ||||
| /* Note: if malformed expressions are used, e.g. "bracenotclosed{" or "{a-e}" or "[-foo]", | |||||
| /* Note: If malformed expressions are used, e.g. "bracenotclosed{" or "{a-e}" or "[-foo]", | |||||
| this should not throw at construction time. Instead it should simply fail any pattern match later. | this should not throw at construction time. Instead it should simply fail any pattern match later. | ||||
| So there is no need to test for those. | So there is no need to test for those. | ||||
| The reason is that we do not actually parse the expressions now, but only during matching. | The reason is that we do not actually parse the expressions now, but only during matching. | ||||
| @@ -517,7 +517,7 @@ public: | |||||
| beginTest ("basic string matching"); | beginTest ("basic string matching"); | ||||
| { | { | ||||
| /* Note: the actual expression matching is tested in OSCPatternMatcher, so here we just | |||||
| /* Note: The actual expression matching is tested in OSCPatternMatcher, so here we just | |||||
| do some basic tests and check if the matching works with multi-part addresses. | do some basic tests and check if the matching works with multi-part addresses. | ||||
| */ | */ | ||||
| { | { | ||||
| @@ -70,7 +70,7 @@ public: | |||||
| bool operator!= (const OSCAddress& other) const noexcept; | bool operator!= (const OSCAddress& other) const noexcept; | ||||
| /** Converts the OSCAddress to a String. | /** Converts the OSCAddress to a String. | ||||
| Note: trailing slashes are always removed automatically. | |||||
| Note: Trailing slashes are always removed automatically. | |||||
| @returns a String object that represents the OSC address. | @returns a String object that represents the OSC address. | ||||
| */ | */ | ||||
| @@ -137,7 +137,7 @@ public: | |||||
| bool containsWildcards() const noexcept { return wasInitialisedWithWildcards; } | bool containsWildcards() const noexcept { return wasInitialisedWithWildcards; } | ||||
| /** Converts the OSCAddressPattern to a String. | /** Converts the OSCAddressPattern to a String. | ||||
| Note: trailing slashes are always removed automatically. | |||||
| Note: Trailing slashes are always removed automatically. | |||||
| @returns a String object that represents the OSC address pattern. | @returns a String object that represents the OSC address pattern. | ||||
| */ | */ | ||||
| @@ -128,7 +128,7 @@ public: | |||||
| /** Creates a new OSCArgument of type blob with binary data content copied from | /** Creates a new OSCArgument of type blob with binary data content copied from | ||||
| the given MemoryBlock. | the given MemoryBlock. | ||||
| Note: if the argument passed is an lvalue, this may copy the binary data. | |||||
| Note: If the argument passed is an lvalue, this may copy the binary data. | |||||
| */ | */ | ||||
| void addBlob (MemoryBlock blob); | void addBlob (MemoryBlock blob); | ||||
| @@ -37,7 +37,7 @@ namespace | |||||
| This class is implementing the Open Sound Control 1.0 Specification for | This class is implementing the Open Sound Control 1.0 Specification for | ||||
| interpreting the data. | interpreting the data. | ||||
| Note: some older implementations of OSC may omit the OSC Type Tag string | |||||
| Note: Some older implementations of OSC may omit the OSC Type Tag string | |||||
| in OSC messages. This class will treat such OSC messages as format errors. | in OSC messages. This class will treat such OSC messages as format errors. | ||||
| */ | */ | ||||
| class OSCInputStream | class OSCInputStream | ||||
| @@ -140,7 +140,7 @@ public: | |||||
| and has to be either MessageLoopCallback or RealtimeCallback. If not specified, | and has to be either MessageLoopCallback or RealtimeCallback. If not specified, | ||||
| MessageLoopCallback will be used by default. | MessageLoopCallback will be used by default. | ||||
| Note: this type of listener will ignore OSC bundles. | |||||
| Note: This type of listener will ignore OSC bundles. | |||||
| @see OSCReceiver::addListener, OSCReceiver::Listener, | @see OSCReceiver::addListener, OSCReceiver::Listener, | ||||
| OSCReceiver::MessageLoopCallback, OSCReceiver::RealtimeCallback | OSCReceiver::MessageLoopCallback, OSCReceiver::RealtimeCallback | ||||
| @@ -50,7 +50,7 @@ public: | |||||
| /** Connects to a datagram socket and prepares the socket for sending OSC | /** Connects to a datagram socket and prepares the socket for sending OSC | ||||
| packets to the specified target. | packets to the specified target. | ||||
| Note: the operating system will choose which specific network adapter(s) | |||||
| Note: The operating system will choose which specific network adapter(s) | |||||
| to bind your socket to, and which local port to use for the sender. | to bind your socket to, and which local port to use for the sender. | ||||
| @param targetHostName The remote host to which messages will be send. | @param targetHostName The remote host to which messages will be send. | ||||
| @@ -39,7 +39,7 @@ using OSCTypeList = Array<OSCType>; | |||||
| /** The definitions of supported OSC types and their associated OSC type tags, | /** The definitions of supported OSC types and their associated OSC type tags, | ||||
| as defined in the OpenSoundControl 1.0 specification. | as defined in the OpenSoundControl 1.0 specification. | ||||
| Note: this implementation does not support any additional type tags that | |||||
| Note: This implementation does not support any additional type tags that | |||||
| are not part of the specification. | are not part of the specification. | ||||
| @tags{OSC} | @tags{OSC} | ||||
| @@ -111,7 +111,7 @@ struct OSCFormatError : public OSCException | |||||
| //============================================================================== | //============================================================================== | ||||
| /** Exception type thrown in cases of unexpected errors in the OSC module. | /** Exception type thrown in cases of unexpected errors in the OSC module. | ||||
| Note: this should never happen, and all the places where this is thrown | |||||
| Note: This should never happen, and all the places where this is thrown | |||||
| should have a preceding jassertfalse to facilitate debugging. | should have a preceding jassertfalse to facilitate debugging. | ||||
| @tags{OSC} | @tags{OSC} | ||||
| @@ -142,7 +142,7 @@ public: | |||||
| InAppPurchases class will own downloads and will delete them as soon as they are finished. | InAppPurchases class will own downloads and will delete them as soon as they are finished. | ||||
| NOTE: it is possible to receive this callback for the same purchase multiple times. If that happens, | |||||
| NOTE: It is possible to receive this callback for the same purchase multiple times. If that happens, | |||||
| only the newest set of downloads and the newest orderId will be valid, the old ones should be not used anymore! | only the newest set of downloads and the newest orderId will be valid, the old ones should be not used anymore! | ||||
| */ | */ | ||||
| virtual void productPurchaseFinished (const PurchaseInfo&, bool /*success*/, const String& /*statusDescription*/) {} | virtual void productPurchaseFinished (const PurchaseInfo&, bool /*success*/, const String& /*statusDescription*/) {} | ||||
| @@ -150,7 +150,7 @@ public: | |||||
| /** Called when a list of all purchases is restored. This can be used to figure out to | /** Called when a list of all purchases is restored. This can be used to figure out to | ||||
| which products a user is entitled to. | which products a user is entitled to. | ||||
| NOTE: it is possible to receive this callback for the same purchase multiple times. If that happens, | |||||
| NOTE: It is possible to receive this callback for the same purchase multiple times. If that happens, | |||||
| only the newest set of downloads and the newest orderId will be valid, the old ones should be not used anymore! | only the newest set of downloads and the newest orderId will be valid, the old ones should be not used anymore! | ||||
| */ | */ | ||||
| virtual void purchasesListRestored (const Array<PurchaseInfo>&, bool /*success*/, const String& /*statusDescription*/) {} | virtual void purchasesListRestored (const Array<PurchaseInfo>&, bool /*success*/, const String& /*statusDescription*/) {} | ||||
| @@ -27,7 +27,7 @@ | |||||
| namespace juce | namespace juce | ||||
| { | { | ||||
| /* Note: there's a bit of light obfuscation in this code, just to make things | |||||
| /* Note: There's a bit of light obfuscation in this code, just to make things | |||||
| a bit more annoying for crackers who try to reverse-engineer your binaries, but | a bit more annoying for crackers who try to reverse-engineer your binaries, but | ||||
| nothing particularly foolproof. | nothing particularly foolproof. | ||||
| */ | */ | ||||
| @@ -112,7 +112,7 @@ public: | |||||
| /** Creates a component that can be used to display a preview of the | /** Creates a component that can be used to display a preview of the | ||||
| video from this camera. | video from this camera. | ||||
| Note: while you can change the size of the preview component, the actual | |||||
| Note: While you can change the size of the preview component, the actual | |||||
| preview display may be smaller than the size requested, because the correct | preview display may be smaller than the size requested, because the correct | ||||
| aspect ratio is maintained automatically. | aspect ratio is maintained automatically. | ||||
| */ | */ | ||||