Version 1.0.1

Author: ArminJo

Diff for: README.md

@@ -7,7 +7,7 @@
 The original version can be found [here](https://github.com/going-digital/Talkie)
 A good explanation of the TMS5220 operation and the LPC frame format can be found [here](https://github.com/mamedev/mame/blob/master/src/devices/sound/tms5220.txt)
 
-Youtube Demonstration of Talkie Voltmeter example
+YouTube Demonstration of Talkie Voltmeter example
 
 [![Demonstration of Talkie Voltmeter example](https://img.youtube.com/vi/6jXkugZTwCs/0.jpg)](https://www.youtube.com/watch?v=6jXkugZTwCs)
 
@@ -25,25 +25,26 @@ Youtube Demonstration of Talkie Voltmeter example
   - **ARM0** (but not tested) as found on the **SAMD**, **Teensy** and **Particle** boards.
 
 ## Hints
-- Connect the speaker to digital pin 3 and 11 of Arduino. They are enabled as non inverted and inverted outputs by default to increase volume for direct attached piezo or speaker. 
-- As speaker I use the speakers from old earphones or headphones, which have ca. 32 Ohm, directly without a series resistor. The headphone speaker tend to be much louder, especially when they stay in their original housings.
-- The Library uses Timer 1 and Timer 2, so libraries like Tone, Servo, analogWrite(), and some other libraries cannot be used while speaking.
+- **Connect the speaker between digital pin 3 and 11 of Arduino**. They are enabled as non inverted and inverted outputs by default to **increase volume** for direct attached piezo or speaker.
+- I use the speakers from old earphones or headphones, which have approximately 32 Ohm, directly without a series resistor. The headphone speaker tend to be much louder, especially when they stay in their original housings.
+- The library uses Timer 1 and Timer 2, so libraries like Tone, Servo, analogWrite(), and some other libraries cannot be used while speaking.
 - After a call to say... you can use tone() again.
 - To use Servo write() after a call to say... you must detach() and attach() the servo before first write() in order to initialize the timer again for Servo.
+- If you want to use SPI functions **while Talkie is speaking**, then disable Talkies usage of pin 11 by `Talkie Voice(true, false);` instead of `Talkie Voice;` **or** `Voice.doNotUseUseInvertedOutput();`.
 - Porting to ATtinys is not possible, since they lack the hardware multiplication. ( Believe me, I tried it! )
 
 ## Own vocabulary
 To create LPC data you can use [Qboxpro](http://ftp.whtech.com/pc%20utilities/qboxpro.zip), an unsupported old Windows application running under XP, which can produce Talkie compatible data streams. The missing BWCC.DLL (Borland Windows Custom Control Library) can be found e.g. [here](http://www.download-dll.com/dll-BWCC.dll.html).
 The process is described [here](http://furrtek.free.fr/index.php?a=speakandspell&ss=9&i=2) and goes like this:
- - Create a new project using the following project parameters : Byte / 8 Khz / 5220 coding table
+ - Create a new project using the following project parameters : Byte / 8 KHz / 5220 coding table
  - Goto Project and add the audio file
  - Choose process using : medium bit rate and pressing OK
- - Edit concatenation : insert concatenation after by adding a name; then insert phrase and press ok
+ - Edit concatenation : insert concatenation after by adding a name; then insert phrase and press OK
  - Format it by choosing the first line in the format menu : LPC 10V, 4UV
 
-Another way to generate the LPC data is to use the pyton script at https://github.com/ptwz/python_wizard
+Another way to generate the LPC data is to use the python script at https://github.com/ptwz/python_wizard
 
-### Schematic for voltmeter example
+## Schematic for voltmeter example
 ![Fritzing schematic for voltmeter example](https://github.com/ArminJo/Talkie/blob/master/extras/TalkieVoltmeter_Steckplatine.png)
 
 # Modifying library properties
@@ -53,10 +54,13 @@ The library files itself are located in the `src` sub-directory.<br/>
 If you did not yet store the example as your own sketch, then with Ctrl+K you are instantly in the right library folder.
 
 # Revision History
+### Version 1.0.1
+- Added SPI compatibility by not resetting pin 11 to input if SPI is detected
+- Added new constructor Talkie(bool aUseNonInvertedOutputPin, bool aUseInvertedOutputPin);
 ### Version 1.0.0
-Initial Arduino library version
+- Initial Arduino library version
 
-## Travis CI
+# Travis CI
 The Talkie library examples are built on Travis CI for the following boards:
 
 - Arduino Uno

Diff for: src/Talkie.cpp

@@ -60,12 +60,9 @@
 #define TIMING_PIN 12
 #endif
 
-// If you do not use the Tone library, then activating can save up to 844 byte program size :-)
+// If you do not use the Tone library, then activating can save up to 844 bytes program size :-)
 //#define NO_COMPATIBILITY_FOR_TONE_LIB_NEEDED
 
-// If you do not use a SPI library, then activating can save 8 byte program size
-//#define NO_COMPATIBILITY_FOR_SPI_NEEDED
-
 /*
  * Use 8bit coefficients K1 and K2.
  * Saves 10 microseconds (40 instead of 50 us) for a 16 MHz ATmega
@@ -121,6 +118,19 @@ Talkie::Talkie() { // @suppress("Class members should be properly initialized")
      */
     NonInvertedOutputPin = TALKIE_USE_PIN_FLAG;
     InvertedOutputPin = TALKIE_USE_PIN_FLAG;
+
+    isTalkingFlag = false;
+    sPointerToTalkieForISR = this;
+}
+
+Talkie::Talkie(bool aUseNonInvertedOutputPin, bool aUseInvertedOutputPin) { // @suppress("Class members should be properly initialized")
+    if (aUseNonInvertedOutputPin) {
+        NonInvertedOutputPin = TALKIE_USE_PIN_FLAG;
+    }
+    if (aUseInvertedOutputPin) {
+        InvertedOutputPin = TALKIE_USE_PIN_FLAG;
+    }
+
     isTalkingFlag = false;
     sPointerToTalkieForISR = this;
 }
@@ -198,7 +208,7 @@ void Talkie::FIFOPushBack(const uint8_t *aAddress) {
  * returns next element from queue or 0
  */
 const uint8_t * Talkie::FIFOPopFront() {
-// 56 byte compiled
+// 56 bytes compiled
     const uint8_t *addr = 0;    // returns 0 if empty.
     if (free < FIFO_BUFFER_SIZE) {
         free++;
@@ -257,7 +267,7 @@ void Talkie::resetFIFO() {
 }
 
 /*
- * On Arduino enables pin 11 as inverted PWM output to increase the volume
+ * On Arduino disables/enables pin 11 as inverted PWM output ( in order to increase the volume, if speaker is attached between 3 and 11)
  */
 void Talkie::doNotUseUseInvertedOutput(bool aDoNotUseInvertedOutput) {
     if (aDoNotUseInvertedOutput) {
@@ -268,11 +278,11 @@ void Talkie::doNotUseUseInvertedOutput(bool aDoNotUseInvertedOutput) {
 }
 
 /*
- * On Arduino disables pin 3 (Talkie default) as PWM output
+ * On Arduino disables/enables pin 3 (Talkie default) as PWM output
  */
 void Talkie::doNotUseNonInvertedOutput(bool aDoNotUseNonInvertedOutput) {
     if (aDoNotUseNonInvertedOutput) {
-        NonInvertedOutputPin = 0;
+        NonInvertedOutputPin = TALKIE_DO_NOT_USE_PIN_FLAG;
     } else {
         NonInvertedOutputPin = TALKIE_USE_PIN_FLAG;
     }
@@ -285,7 +295,7 @@ void Talkie::initializeHardware() {
 #if defined(__AVR_ATmega32U4__) // Use Timer 4 instead of Timer 2
 #if defined(ARDUINO_AVR_CIRCUITPLAY) || defined(ARDUINO_AVR_PROMICRO)
 // Adafruit Circuit Playground Classic or Sparkfun Pro Micro board. The first does not need inverted output, the latter does not connect it.
-// Cannot be used on plain Leonardos since inverted output is connected to internal led.
+// Cannot be used on plain Leonardos because inverted output is connected to internal led.
     NonInvertedOutputPin = 5;// D5 / PC6 / !OC4A
     InvertedOutputPin = 0;// disable InvertedOutputPin
     pinMode(NonInvertedOutputPin, OUTPUT);
@@ -428,24 +438,19 @@ void Talkie::terminateHardware() {
      * pinMode(3|11, INPUT) avoids the click at the end, if speaker is coupled by a capacitance.
      */
     if (NonInvertedOutputPin) {
-
-#ifndef NO_COMPATIBILITY_FOR_SPI_NEEDED
-        // Reset pin 11 to input only if no active SPI detected - needs 8 byte Flash
-        if (!(SPCR &  _BV(SPE))) {
-#endif
-            // force initializing of tone library, next time tone() is called.
+        // Reset pin 11 to input only if no active SPI detected
+        if (!(SPCR & _BV(SPE))) {
 #ifdef NO_COMPATIBILITY_FOR_TONE_LIB_NEEDED
-            pinMode(NonInvertedOutputPin, INPUT); // tone needs this as output
+            pinMode(NonInvertedOutputPin, INPUT); // As tone needs this as output, disconnect only if no compatibility needed
 #else
+            // force initializing of tone library, next time tone() is called.
             noTone(NonInvertedOutputPin);
 #endif
-#ifndef NO_COMPATIBILITY_FOR_SPI_NEEDED
         }
-#endif
     }
     if (InvertedOutputPin) {
 #ifdef NO_COMPATIBILITY_FOR_TONE_LIB_NEEDED
-        pinMode(InvertedOutputPin, INPUT); // tone needs this as output
+        pinMode(InvertedOutputPin, INPUT); // As tone needs this as output, disconnect only if no compatibility needed
 #else
         noTone(InvertedOutputPin);
 #endif
@@ -468,7 +473,7 @@ int8_t Talkie::sayQ(const uint8_t * aWordDataAddress) {
         stop();
     } else {
         noInterrupts();
-        // disable Interrupt since ptrAddr is also modified by ISR. This avoids race conditions.
+        // disable Interrupt because ptrAddr is also modified by ISR. This avoids race conditions.
         if (isTalkingFlag) {
             /*
              *  Word synthesizer still active -> queue this aWordDataAddress when there is room in FIFO
@@ -560,7 +565,7 @@ void timerInterrupt() {
     }
 
 // Lattice filter forward path -> fill temporary variables
-// rescale by shifting >> 7 since we have signed values here (for unsigned it would need >> 8)
+// rescale by shifting >> 7 because we have signed values here (for unsigned it would need >> 8)
     u9 = u10 - (((int16_t) synthK10 * x9) >> 7);
     u8 = u9 - (((int16_t) synthK9 * x8) >> 7);
     u7 = u8 - (((int16_t) synthK8 * x7) >> 7);

Diff for: src/Talkie.h

@@ -44,10 +44,12 @@
 #define FIFO_BUFFER_SIZE     24 // 24 sets of 4 bytes plus added queue indexes is about 100 added bytes.
 
 #define TALKIE_USE_PIN_FLAG 0xFF // Flag to signal, that pin should be used as output, but pin number is not yet filled in, since it depends of board type.
+#define TALKIE_DO_NOT_USE_PIN_FLAG 0x00 // As pin number is initially != 0xFF, this is not really needed at startup
 
 class Talkie {
 public:
     Talkie();
+    Talkie(bool aUseNonInvertedOutputPin, bool aUseInvertedOutputPin);
     void say(const uint8_t * aWordDataAddress); // Blocking version
     int8_t sayQ(const uint8_t * aWordDataAddress); // Queuing version. Returns free space in FIFO
     void wait(); // wait for sayQ to end