altosdroid: Remove a debug line in AltosVoice
[fw/altos] / altosdroid / src / org / altusmetrum / AltosDroid / AltosVoice.java
index b3dba62693714403f95f0b312beeb890f6e88b1a..adf52dd9ab8f7907bf18fb95ee845ab31079a927 100644 (file)
-/*\r
- * Copyright © 2011 Keith Packard <keithp@keithp.com>\r
- * Copyright © 2012 Mike Beattie <mike@ethernal.org>\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; version 2 of the License.\r
- *\r
- * This program is distributed in the hope that it will be useful, but\r
- * WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\r
- * General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.\r
- */\r
-\r
-package org.altusmetrum.AltosDroid;\r
-\r
-import android.speech.tts.TextToSpeech;\r
-import android.speech.tts.TextToSpeech.OnInitListener;\r
-\r
-import org.altusmetrum.altoslib_1.*;\r
-\r
-public class AltosVoice {\r
-\r
-       private TextToSpeech tts         = null;\r
-       private boolean      tts_enabled = false;\r
-\r
-       private IdleThread   idle_thread = null;\r
-\r
-       private AltosState   old_state   = null;\r
-\r
-       public AltosVoice(AltosDroid a) {\r
-\r
-               tts = new TextToSpeech(a, new OnInitListener() {\r
-                       public void onInit(int status) {\r
-                               if (status == TextToSpeech.SUCCESS) tts_enabled = true;\r
-                               if (tts_enabled) {\r
-                                       idle_thread = new IdleThread();\r
-                               }\r
-                       }\r
-               });\r
-\r
-       }\r
-\r
-       public void speak(String s) {\r
-               if (!tts_enabled) return;\r
-               tts.speak(s, TextToSpeech.QUEUE_ADD, null);\r
-       }\r
-\r
-       public void stop() {\r
-               if (tts != null) tts.shutdown();\r
-               if (idle_thread != null) {\r
-                       idle_thread.interrupt();\r
-                       idle_thread = null;\r
-               }\r
-       }\r
-\r
-       public void tell(AltosState state) {\r
-               if (!tts_enabled) return;\r
-\r
-               boolean spoke = false;\r
-               if (old_state == null || old_state.state != state.state) {\r
-                       speak(state.data.state());\r
-                       if ((old_state == null || old_state.state <= AltosLib.ao_flight_boost) &&\r
-                           state.state > AltosLib.ao_flight_boost) {\r
-                               speak(String.format("max speed: %d meters per second.", (int) (state.max_speed() + 0.5)));\r
-                               spoke = true;\r
-                       } else if ((old_state == null || old_state.state < AltosLib.ao_flight_drogue) &&\r
-                                  state.state >= AltosLib.ao_flight_drogue) {\r
-                               speak(String.format("max height: %d meters.", (int) (state.max_height + 0.5)));\r
-                               spoke = true;\r
-                       }\r
-               }\r
-               if (old_state == null || old_state.gps_ready != state.gps_ready) {\r
-                       if (state.gps_ready) {\r
-                               speak("GPS ready");\r
-                               spoke = true;\r
-                       } else if (old_state != null) {\r
-                               speak("GPS lost");\r
-                               spoke = true;\r
-                       }\r
-               }\r
-               old_state = state;\r
-               idle_thread.notice(state, spoke);\r
-       }\r
-\r
-\r
-       class IdleThread extends Thread {\r
-               boolean            started;\r
-               private AltosState state;\r
-               int                reported_landing;\r
-               int                report_interval;\r
-               long               report_time;\r
-\r
-               public synchronized void report(boolean last) {\r
-                       if (state == null)\r
-                               return;\r
-\r
-                       /* reset the landing count once we hear about a new flight */\r
-                       if (state.state < AltosLib.ao_flight_drogue)\r
-                               reported_landing = 0;\r
-\r
-                       /* Shut up once the rocket is on the ground */\r
-                       if (reported_landing > 2) {\r
-                               return;\r
-                       }\r
-\r
-                       /* If the rocket isn't on the pad, then report height */\r
-                       if (AltosLib.ao_flight_drogue <= state.state &&\r
-                           state.state < AltosLib.ao_flight_landed &&\r
-                           state.range >= 0)\r
-                       {\r
-                               speak(String.format("Height %d, bearing %s %d, elevation %d, range %d.\n",\r
-                                                   (int) (state.height + 0.5),\r
-                                       state.from_pad.bearing_words(\r
-                                             AltosGreatCircle.BEARING_VOICE),\r
-                                                   (int) (state.from_pad.bearing + 0.5),\r
-                                                   (int) (state.elevation + 0.5),\r
-                                                   (int) (state.range + 0.5)));\r
-                       } else if (state.state > AltosLib.ao_flight_pad) {\r
-                               speak(String.format("%d meters", (int) (state.height + 0.5)));\r
-                       } else {\r
-                               reported_landing = 0;\r
-                       }\r
-\r
-                       /* If the rocket is coming down, check to see if it has landed;\r
-                        * either we've got a landed report or we haven't heard from it in\r
-                        * a long time\r
-                        */\r
-                       if (state.state >= AltosLib.ao_flight_drogue &&\r
-                           (last ||\r
-                            System.currentTimeMillis() - state.report_time >= 15000 ||\r
-                            state.state == AltosLib.ao_flight_landed))\r
-                       {\r
-                               if (Math.abs(state.baro_speed) < 20 && state.height < 100)\r
-                                       speak("rocket landed safely");\r
-                               else\r
-                                       speak("rocket may have crashed");\r
-                               if (state.from_pad != null)\r
-                                       speak(String.format("Bearing %d degrees, range %d meters.",\r
-                                                           (int) (state.from_pad.bearing + 0.5),\r
-                                                           (int) (state.from_pad.distance + 0.5)));\r
-                               ++reported_landing;\r
-                       }\r
-               }\r
-\r
-               long now () {\r
-                       return System.currentTimeMillis();\r
-               }\r
-\r
-               void set_report_time() {\r
-                       report_time = now() + report_interval;\r
-               }\r
-\r
-               public void run () {\r
-                       try {\r
-                               for (;;) {\r
-                                       set_report_time();\r
-                                       for (;;) {\r
-                                               synchronized (this) {\r
-                                                       long sleep_time = report_time - now();\r
-                                                       if (sleep_time <= 0)\r
-                                                               break;\r
-                                                       wait(sleep_time);\r
-                                               }\r
-                                       }\r
-                                       report(false);\r
-                               }\r
-                       } catch (InterruptedException ie) {\r
-                       }\r
-               }\r
-\r
-               public synchronized void notice(AltosState new_state, boolean spoken) {\r
-                       AltosState old_state = state;\r
-                       state = new_state;\r
-                       if (!started && state.state > AltosLib.ao_flight_pad) {\r
-                               started = true;\r
-                               start();\r
-                       }\r
-\r
-                       if (state.state < AltosLib.ao_flight_drogue)\r
-                               report_interval = 10000;\r
-                       else\r
-                               report_interval = 20000;\r
-                       if (old_state != null && old_state.state != state.state) {\r
-                               report_time = now();\r
-                               this.notify();\r
-                       } else if (spoken)\r
-                               set_report_time();\r
-               }\r
-\r
-               public IdleThread() {\r
-                       state = null;\r
-                       reported_landing = 0;\r
-                       report_interval = 10000;\r
-               }\r
-       }\r
-\r
-}\r
+/*
+ * Copyright © 2011 Keith Packard <keithp@keithp.com>
+ * Copyright © 2012 Mike Beattie <mike@ethernal.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ */
+
+package org.altusmetrum.AltosDroid;
+
+import android.speech.tts.TextToSpeech;
+import android.speech.tts.TextToSpeech.OnInitListener;
+import android.location.Location;
+
+import org.altusmetrum.altoslib_7.*;
+
+public class AltosVoice {
+
+       private TextToSpeech tts         = null;
+       private boolean      tts_enabled = false;
+
+       static final int TELL_MODE_NONE = 0;
+       static final int TELL_MODE_PAD = 1;
+       static final int TELL_MODE_FLIGHT = 2;
+       static final int TELL_MODE_RECOVER = 3;
+
+       static final int TELL_FLIGHT_NONE = 0;
+       static final int TELL_FLIGHT_STATE = 1;
+       static final int TELL_FLIGHT_SPEED = 2;
+       static final int TELL_FLIGHT_HEIGHT = 3;
+       static final int TELL_FLIGHT_TRACK = 4;
+
+       private int             last_tell_mode;
+       private int             last_tell_serial = AltosLib.MISSING;
+       private int             last_state;
+       private AltosGPS        last_gps;
+       private double          last_height = AltosLib.MISSING;
+       private Location        last_receiver;
+       private long            last_speak_time;
+       private int             last_flight_tell = TELL_FLIGHT_NONE;
+
+       private long now() {
+               return System.currentTimeMillis();
+       }
+
+       private void reset_last() {
+               last_tell_mode = TELL_MODE_NONE;
+               last_speak_time = now() - 100 * 1000;
+               last_gps = null;
+               last_height = AltosLib.MISSING;
+               last_receiver = null;
+               last_state = AltosLib.ao_flight_invalid;
+               last_flight_tell = TELL_FLIGHT_NONE;
+       }
+
+       public AltosVoice(AltosDroid a) {
+               tts = new TextToSpeech(a, new OnInitListener() {
+                       public void onInit(int status) {
+                               if (status == TextToSpeech.SUCCESS) tts_enabled = true;
+                       }
+               });
+               reset_last();
+       }
+
+       public synchronized void set_enable(boolean enable) {
+               tts_enabled = enable;
+       }
+
+       public synchronized void speak(String s) {
+               if (!tts_enabled) return;
+               last_speak_time = now();
+               tts.speak(s, TextToSpeech.QUEUE_ADD, null);
+       }
+
+       public synchronized long time_since_speak() {
+               return now() - last_speak_time;
+       }
+
+       public synchronized void speak(String format, Object ... arguments) {
+               speak(String.format(format, arguments));
+       }
+
+       public synchronized boolean is_speaking() {
+               return tts.isSpeaking();
+       }
+
+       public void stop() {
+               if (tts != null) {
+                       tts.stop();
+                       tts.shutdown();
+               }
+       }
+
+       private boolean         last_apogee_good;
+       private boolean         last_main_good;
+       private boolean         last_gps_good;
+
+       private boolean tell_gonogo(String name,
+                                 boolean current,
+                                 boolean previous,
+                                 boolean new_mode) {
+               if (current != previous || new_mode)
+                       speak("%s %s.", name, current ? "ready" : "not ready");
+               return current;
+       }
+
+       private boolean tell_pad(TelemetryState telem_state, AltosState state,
+                             AltosGreatCircle from_receiver, Location receiver) {
+
+               if (state == null)
+                       return false;
+
+               if (state.apogee_voltage != AltosLib.MISSING)
+                       last_apogee_good = tell_gonogo("apogee",
+                                                      state.apogee_voltage >= AltosLib.ao_igniter_good,
+                                                      last_apogee_good,
+                                                      last_tell_mode != TELL_MODE_PAD);
+
+               if (state.main_voltage != AltosLib.MISSING)
+                       last_main_good = tell_gonogo("main",
+                                                    state.main_voltage >= AltosLib.ao_igniter_good,
+                                                    last_main_good,
+                                                    last_tell_mode != TELL_MODE_PAD);
+
+               if (state.gps != null)
+                       last_gps_good = tell_gonogo("G P S",
+                                                   state.gps_ready,
+                                                   last_gps_good,
+                                                   last_tell_mode != TELL_MODE_PAD);
+               return true;
+       }
+
+
+       private boolean descending(int state) {
+               return AltosLib.ao_flight_drogue <= state && state <= AltosLib.ao_flight_landed;
+       }
+
+       private boolean target_moved(AltosState state) {
+               if (last_gps != null && state != null && state.gps != null) {
+                       AltosGreatCircle        moved = new AltosGreatCircle(last_gps.lat, last_gps.lon, last_gps.alt,
+                                                                            state.gps.lat, state.gps.lon, state.gps.alt);
+                       double                  height_change = 0;
+                       double                  height = state.height();
+
+                       if (height != AltosLib.MISSING && last_height != AltosLib.MISSING)
+                               height_change = Math.abs(last_height - height);
+
+                       if (moved.range < 10 && height_change < 10)
+                               return false;
+               }
+               return true;
+       }
+
+       private boolean receiver_moved(Location receiver) {
+               if (last_receiver != null && receiver != null) {
+                       AltosGreatCircle        moved = new AltosGreatCircle(last_receiver.getLatitude(),
+                                                                            last_receiver.getLongitude(),
+                                                                            last_receiver.getAltitude(),
+                                                                            receiver.getLatitude(),
+                                                                            receiver.getLongitude(),
+                                                                            receiver.getAltitude());
+                       if (moved.range < 10)
+                               return false;
+               }
+               return true;
+       }
+
+       private boolean tell_flight(TelemetryState telem_state, AltosState state,
+                                   AltosGreatCircle from_receiver, Location receiver) {
+
+               boolean spoken = false;
+
+               if (state == null)
+                       return false;
+
+               if (last_tell_mode != TELL_MODE_FLIGHT)
+                       last_flight_tell = TELL_FLIGHT_NONE;
+
+               if (state.state != last_state && AltosLib.ao_flight_boost <= state.state && state.state <= AltosLib.ao_flight_landed) {
+                       speak(state.state_name());
+                       if (descending(state.state) && !descending(last_state)) {
+                               if (state.max_height() != AltosLib.MISSING) {
+                                       speak("max height: %s.",
+                                             AltosConvert.height.say_units(state.max_height()));
+                               }
+                       }
+                       last_flight_tell = TELL_FLIGHT_STATE;
+                       return true;
+               }
+
+               if (last_tell_mode == TELL_MODE_FLIGHT && last_flight_tell == TELL_FLIGHT_TRACK) {
+                       if (time_since_speak() < 10 * 1000)
+                               return false;
+                       if (!target_moved(state) && !receiver_moved(receiver))
+                               return false;
+               }
+
+               double  speed;
+               double  height;
+
+               if (last_flight_tell == TELL_FLIGHT_NONE || last_flight_tell == TELL_FLIGHT_STATE || last_flight_tell == TELL_FLIGHT_TRACK) {
+                       last_flight_tell = TELL_FLIGHT_SPEED;
+
+                       if (state.state <= AltosLib.ao_flight_coast) {
+                               speed = state.speed();
+                       } else {
+                               speed = state.gps_speed();
+                               if (speed == AltosLib.MISSING)
+                                       speed = state.speed();
+                       }
+
+                       if (speed != AltosLib.MISSING) {
+                               speak("speed: %s.", AltosConvert.speed.say_units(speed));
+                               return true;
+                       }
+               }
+
+               if (last_flight_tell == TELL_FLIGHT_SPEED) {
+                       last_flight_tell = TELL_FLIGHT_HEIGHT;
+                       height = state.height();
+
+                       if (height != AltosLib.MISSING) {
+                               speak("height: %s.", AltosConvert.height.say_units(height));
+                               return true;
+                       }
+               }
+
+               if (last_flight_tell == TELL_FLIGHT_HEIGHT) {
+                       last_flight_tell = TELL_FLIGHT_TRACK;
+                       if (from_receiver != null) {
+                               speak("bearing %s %d, elevation %d, range %s.",
+                                     from_receiver.bearing_words(
+                                             AltosGreatCircle.BEARING_VOICE),
+                                     (int) (from_receiver.bearing + 0.5),
+                                     (int) (from_receiver.elevation + 0.5),
+                                     AltosConvert.distance.say(from_receiver.range));
+                               return true;
+                       }
+               }
+
+               return spoken;
+       }
+
+       private boolean tell_recover(TelemetryState telem_state, AltosState state,
+                                    AltosGreatCircle from_receiver, Location receiver) {
+
+               if (from_receiver == null)
+                       return false;
+
+               if (last_tell_mode == TELL_MODE_RECOVER) {
+                       if (!target_moved(state) && !receiver_moved(receiver))
+                               return false;
+                       if (time_since_speak() <= 10 * 1000)
+                               return false;
+               }
+
+               String direction = AltosDroid.direction(from_receiver, receiver);
+               if (direction == null)
+                       direction = String.format("Bearing %d", (int) (from_receiver.bearing + 0.5));
+
+               speak("%s, range %s.", direction,
+                     AltosConvert.distance.say_units(from_receiver.distance));
+
+               return true;
+       }
+
+       public void tell(TelemetryState telem_state, AltosState state,
+                        AltosGreatCircle from_receiver, Location receiver,
+                        AltosDroidTab tab) {
+
+               boolean spoken = false;
+
+               if (!tts_enabled) return;
+
+               if (is_speaking()) return;
+
+               int     tell_serial = last_tell_serial;
+
+               if (state != null)
+                       tell_serial = state.serial;
+
+               if (tell_serial != last_tell_serial)
+                       reset_last();
+
+               int     tell_mode = TELL_MODE_NONE;
+
+               if (tab.tab_name().equals(AltosDroid.tab_pad_name))
+                       tell_mode = TELL_MODE_PAD;
+               else if (tab.tab_name().equals(AltosDroid.tab_flight_name))
+                       tell_mode = TELL_MODE_FLIGHT;
+               else
+                       tell_mode = TELL_MODE_RECOVER;
+
+               if (tell_mode == TELL_MODE_PAD)
+                       spoken = tell_pad(telem_state, state, from_receiver, receiver);
+               else if (tell_mode == TELL_MODE_FLIGHT)
+                       spoken = tell_flight(telem_state, state, from_receiver, receiver);
+               else
+                       spoken = tell_recover(telem_state, state, from_receiver, receiver);
+
+               if (spoken) {
+                       last_tell_mode = tell_mode;
+                       last_tell_serial = tell_serial;
+                       if (state != null) {
+                               last_state = state.state;
+                               last_height = state.height();
+                               if (state.gps != null)
+                                       last_gps = state.gps;
+                       }
+                       if (receiver != null)
+                               last_receiver = receiver;
+               }
+       }
+}