[speech-to-text] Detect the audio format automatically based on the

file extension. #135

Author: germanattanasio

src/main/java/com/ibm/watson/developer_cloud/http/HttpMediaType.java

@@ -80,6 +80,17 @@ public interface HttpMediaType {
    * Field AUDIO_WAV. (value is "audio/wav")
    */
   public final static String AUDIO_WAV = "audio/wav";
+
+  /**
+   * Field AUDIO_FLAC. (value is "audio/flac")
+   */
+  public static final String AUDIO_FLAC = "audio/flac";
+
+  /**
+   * Field AUDIO_RAW. (value is "audio/l16")
+   */
+  public static final String AUDIO_RAW = "audio/l16";
+
   /**
    * Field BINARY_FILE. (value is "application/octet-stream")
    */

src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/SpeechToText.java

@@ -25,6 +25,7 @@
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.SpeechModelSet;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.SpeechResults;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.SpeechSession;
+import com.ibm.watson.developer_cloud.speech_to_text.v1.util.MediaTypeUtils;
 import com.ibm.watson.developer_cloud.util.GsonSingleton;
 import com.ibm.watson.developer_cloud.util.ResponseUtil;
 import com.ibm.watson.developer_cloud.util.Validate;
@@ -206,6 +207,19 @@ public SessionStatus getRecognizeStatus(final SpeechSession session) {
     return GsonSingleton.getGson().fromJson(jsonObject.get(SESSION), SessionStatus.class);
   }
 
+  /**
+   * Recognizes an audio file and returns {@link SpeechResults}. It will try to recognize the audio
+   * format based on the file extension.
+   * 
+   * @param audio the audio file
+   * @return the {@link SpeechResults}
+   */
+  public SpeechResults recognize(File audio) {
+    String contentType = MediaTypeUtils.getMediaTypeFromFile(audio);
+    Validate.notNull(contentType, "Audio format cannot be recognized");
+    return recognize(audio, contentType, null);
+  }
+
   /**
    * Recognizes an audio file and returns {@link SpeechResults}.
    * 

src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/util/MediaTypeUtils.java

@@ -0,0 +1,68 @@
+/**
+ * Copyright 2015 IBM Corp. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.ibm.watson.developer_cloud.speech_to_text.v1.util;
+
+import java.io.File;
+
+import com.ibm.watson.developer_cloud.http.HttpMediaType;
+import com.ibm.watson.developer_cloud.speech_to_text.v1.SpeechToText;
+
+/**
+ * The utilities required for processing audio files using the {@link SpeechToText} service.
+ * 
+ * @see SpeechToText
+ */
+public class MediaTypeUtils {
+  private static String[] SUPPORTED_EXTENSION = {".wav", ".ogg", ".oga", ".flac", ".raw"};
+
+  private static String[] SUPPORTED_MEDIA_TYPES = {HttpMediaType.AUDIO_WAV,
+      HttpMediaType.AUDIO_OGG, HttpMediaType.AUDIO_OGG, HttpMediaType.AUDIO_FLAC,
+      HttpMediaType.AUDIO_RAW};
+
+  /**
+   * Returns the media type for a given file.
+   * 
+   * @param file the file object for which media type needs to be provided
+   * @return Internet media type for the file
+   */
+  public static String getMediaTypeFromFile(final File file) {
+    if (file != null) {
+      final String fileName = file.getName().toLowerCase();
+      for (int i = 0; i < SUPPORTED_MEDIA_TYPES.length; i++) {
+        if (fileName.endsWith(SUPPORTED_EXTENSION[i])) {
+          return SUPPORTED_MEDIA_TYPES[i];
+        }
+      }
+    }
+    return null;
+  }
+
+  /**
+   * Checks if the media type is supported by the service.
+   * 
+   * @param mediaType Internet media type for the file
+   * @return true if it is supported, false if not.
+   */
+  public static Boolean isValidMediaType(final String mediaType) {
+    if (mediaType != null) {
+      for (final String supportedMediaType : SUPPORTED_MEDIA_TYPES) {
+        if (mediaType.equalsIgnoreCase(supportedMediaType)) {
+          return true;
+        }
+      }
+    }
+    return false;
+  }
+
+}

src/test/java/com/ibm/watson/developer_cloud/speech_to_text/v1/SpeechToTextIT.java

@@ -1,11 +1,11 @@
 /**
  * Copyright 2015 IBM Corp. All Rights Reserved.
- *
+ * 
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
  * in compliance with the License. You may obtain a copy of the License at
- *
+ * 
  * http://www.apache.org/licenses/LICENSE-2.0
- *
+ * 
  * Unless required by applicable law or agreed to in writing, software distributed under the License
  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  * or implied. See the License for the specific language governing permissions and limitations under
@@ -108,8 +108,7 @@ public void testGetRecognizeStatus() {
   @Test
   public void testRecognizeFileString() {
     final File audio = new File("src/test/resources/speech_to_text/sample1.wav");
-    final String contentType = HttpMediaType.AUDIO_WAV;
-    final SpeechResults results = service.recognize(audio, contentType);
+    final SpeechResults results = service.recognize(audio);
     assertNotNull(results.getResults().get(0).getAlternatives().get(0).getTranscript());
   }