From a27268c0d32c087ecef2c336a92b138722b8a6d3 Mon Sep 17 00:00:00 2001
From: sklett <sklett@techfak.uni-bielefeld.de>
Date: Wed, 18 Nov 2015 10:54:26 +0100
Subject: [PATCH] new sandbox proto-file for communicating with text-to-speech
 systems

---
 proto/sandbox/rst/hri/TextToSpeech.proto | 153 +++++++++++++++++++++++++++++++
 1 file changed, 153 insertions(+)
 create mode 100644 proto/sandbox/rst/hri/TextToSpeech.proto

diff --git a/proto/sandbox/rst/hri/TextToSpeech.proto b/proto/sandbox/rst/hri/TextToSpeech.proto
new file mode 100644
index 0000000..aef1c23
--- /dev/null
+++ b/proto/sandbox/rst/hri/TextToSpeech.proto
@@ -0,0 +1,153 @@
+package rst.hri;
+
+import "rst/hri/TextToSpeech.proto";
+
+option java_outer_classname = "TextToSpeechType";
+
+/**
+ * Collection of parameters for a Text-to-Speech module.
+ *
+ * @author Soeren Klett <sklett@techfak.uni-bielefeld.de>
+ * @author Birte Carlmeyer <bcarlmey@techfak.uni-bielefeld.de>
+ */
+message TextToSpeech {
+
+    /**
+     * Words which should be vocalized.
+     */
+    optional string text = 1;
+
+    /**
+     * Prosody of spoken words.
+     */
+    message Prosody {
+
+        /**
+         * The baseline pitch.
+         */
+        message Pitch {
+
+            /**
+             * Absolute value of pitch.
+             */
+            optional float absolute = 1;
+
+            /**
+             * Relative change of pitch.
+             */
+            optional float relative = 2;
+
+            /**
+             * Relative change of pitch in percentage.
+             */
+            optional float percentage = 3;
+
+        }
+
+        /**
+         * The baseline pitch for the contained words.
+         */
+        optional Pitch pitch = 1;
+
+        /**
+         * The pitch range (variability).
+         */
+        message Range {
+
+            /**
+             * Absolute range of pitch in hertz.
+             */
+            optional float absolute = 1;
+
+            /**
+             * Relative range of pitch.
+             */
+            optional float relative = 2;
+
+            /**
+             * Relative range of pitch in percentage.
+             */
+            optional float percentage = 3;
+
+        }
+
+        /**
+         * The pitch range (variability) of the contained words.
+         */
+        optional Range range = 2;
+
+        /**
+         * The change of volume relative to the baseline.
+         */
+        message Volume {
+
+            /**
+             * Absolute change of volume.
+             */
+            optional float absolute = 1;
+
+            /**
+             * Relative change of volume.
+             */
+            optional float relative = 2;
+
+            /**
+             * Relative change of volume in percentage.
+             */
+            optional float percentage = 3;
+
+        }
+
+        /**
+         * The desired change of volume of the contained words.
+         */
+        optional Volume volume = 3;
+
+        /**
+         * A value in milliseconds for the desired time to take to read the contained words.
+         */
+        optional uint32 duration = 4;
+
+        /**
+         * Relative speech rate.
+         */
+        optional float rate = 5;
+
+    }
+
+    /**
+     * Prosody to be applied to the given words.
+     */
+    optional Prosody prosody = 2;
+
+    enum PlaybackOption {
+
+        /**
+         * Play current message.
+         */
+        PLAY = 0;
+
+        /**
+         * Stop current message.
+         */
+        STOP = 0;
+
+        /**
+         * PAUSE current message.
+         */
+        PAUSE = 0;
+
+        /**
+         * RESUME current message.
+         */
+        RESUME = 0;
+
+    }
+
+    /**
+     * Action to be executed by the Text-to-Speech engine.
+     */
+    optional PlaybackOption playback_option = 3 [default = PLAY];
+
+}
+
-- 
2.1.0