add definitions for sound trigger (5894b4bf) · Commits · e / os / android_system_core

include/system/sound_trigger.h

0 → 100644

+165 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2014 The Android Open Source Project
		*
		* 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.
		*/

		#ifndef ANDROID_SOUND_TRIGGER_H
		#define ANDROID_SOUND_TRIGGER_H

		#include <stdbool.h>

		#define SOUND_TRIGGER_MAX_STRING_LEN 64 /* max length of strings in properties or
		descriptor structs */
		#define SOUND_TRIGGER_MAX_LOCALE_LEN 6 /* max length of locale string. e.g en_US */
		#define SOUND_TRIGGER_MAX_USERS 10 /* max number of concurrent users */
		#define SOUND_TRIGGER_MAX_PHRASES 10 /* max number of concurrent phrases */

		#define RECOGNITION_MODE_VOICE_TRIGGER 0x1 /* simple voice trigger */
		#define RECOGNITION_MODE_USER_IDENTIFICATION 0x2 /* trigger only if one user in model identified */
		#define RECOGNITION_MODE_USER_AUTHENTICATION 0x4 /* trigger only if one user in mode
		authenticated */

		#define RECOGNITION_STATUS_SUCCESS 0
		#define RECOGNITION_STATUS_ABORT 1
		#define RECOGNITION_STATUS_FAILURE 2


		typedef enum {
		SOUND_MODEL_TYPE_UNKNOWN = -1, /* use for unspecified sound model type */
		SOUND_MODEL_TYPE_KEYPHRASE = 0 /* use for key phrase sound models */
		} sound_trigger_sound_model_type_t;


		typedef struct sound_trigger_uuid_s {
		unsigned int timeLow;
		unsigned short timeMid;
		unsigned short timeHiAndVersion;
		unsigned short clockSeq;
		unsigned char node[6];
		} sound_trigger_uuid_t;

		/*
		* sound trigger implementation descriptor read by the framework via get_properties().
		* Used by SoundTrigger service to report to applications and manage concurrency and policy.
		*/
		struct sound_trigger_properties {
		char implementor[SOUND_TRIGGER_MAX_STRING_LEN]; /* implementor name */
		char description[SOUND_TRIGGER_MAX_STRING_LEN]; /* implementation description */
		unsigned int version; /* implementation version */
		sound_trigger_uuid_t uuid; /* unique implementation ID.
		Must change with version each version */
		unsigned int max_sound_models; /* maximum number of concurrent sound models
		loaded */
		unsigned int max_key_phrases; /* maximum number of key phrases */
		unsigned int max_users; /* maximum number of concurrent users detected */
		unsigned int recognition_modes; /* all supported modes.
		e.g RECOGNITION_MODE_VOICE_TRIGGER */
		bool capture_transition; /* supports seamless transition from detection
		to capture */
		unsigned int max_buffer_ms; /* maximum buffering capacity in ms if
		capture_transition is true*/
		bool concurrent_capture; /* supports capture by other use cases while
		detection is active */
		unsigned int power_consumption_mw; /* Rated power consumption when detection is active
		with TDB silence/sound/speech ratio */
		};

		typedef int sound_trigger_module_handle_t;

		struct sound_trigger_module_descriptor {
		sound_trigger_module_handle_t handle;
		struct sound_trigger_properties properties;
		};

		typedef int sound_model_handle_t;

		/*
		* Generic sound model descriptor. This struct is the header of a larger block passed to
		* load_sound_model() and containing the binary data of the sound model.
		* Proprietary representation of users in binary data must match information indicated
		* by users field
		*/
		struct sound_trigger_sound_model {
		sound_trigger_sound_model_type_t type; /* model type. e.g. SOUND_MODEL_TYPE_KEYPHRASE */
		unsigned int data_size; /* size of opaque model data */
		unsigned int data_offset; /* offset of opaque data start from head of struct
		(e.g sizeof struct sound_trigger_sound_model) */
		};

		/* key phrase descriptor */
		struct sound_trigger_phrase {
		unsigned int recognition_mode; /* recognition modes supported by this key phrase */
		unsigned int num_users; /* number of users in the key phrase */
		char locale[SOUND_TRIGGER_MAX_LOCALE_LEN]; /* locale - JAVA Locale style (e.g. en_US) */
		char text[SOUND_TRIGGER_MAX_STRING_LEN]; /* phrase text in UTF-8 format. */
		};

		/*
		* Specialized sound model for key phrase detection.
		* Proprietary representation of key phrases in binary data must match information indicated
		* by phrases field
		*/
		struct sound_trigger_phrase_sound_model {
		struct sound_trigger_sound_model common;
		unsigned int num_phrases; /* number of key phrases in model */
		struct sound_trigger_phrase phrases[SOUND_TRIGGER_MAX_PHRASES];
		};


		/*
		* Generic recognition event sent via recognition callback
		*/
		struct sound_trigger_recognition_event {
		int status; /* recognition status e.g.
		RECOGNITION_STATUS_SUCCESS */
		sound_trigger_sound_model_type_t type; /* event type, same as sound model type.
		e.g. SOUND_MODEL_TYPE_KEYPHRASE */
		sound_model_handle_t model; /* loaded sound model that triggered the
		event */
		bool capture_available; /* it is possible to capture audio from this
		utterance buffered by the
		implementation */
		int capture_session; /* audio session ID. framework use */
		int capture_delay_ms; /* delay in ms between end of model
		detection and start of audio available
		for capture. A negative value is possible
		(e.g. if key phrase is also available for
		capture */
		unsigned int data_size; /* size of opaque event data */
		unsigned int data_offset; /* offset of opaque data start from start of
		this struct (e.g sizeof struct
		sound_trigger_phrase_recognition_event) */
		};

		/*
		* Specialized recognition event for key phrase detection
		*/
		struct sound_trigger_phrase_recognition_extra {
		unsigned int recognition_modes;
		unsigned int num_users;
		unsigned int confidence_levels[SOUND_TRIGGER_MAX_USERS];
		};

		struct sound_trigger_phrase_recognition_event {
		struct sound_trigger_recognition_event common;
		bool key_phrase_in_capture; /* true if the key phrase is
		present in audio data available
		for capture after recognition
		event is fired */
		unsigned int num_phrases;
		struct sound_trigger_phrase_recognition_extra phrase_extras[SOUND_TRIGGER_MAX_PHRASES];
		};


		#endif // ANDROID_SOUND_TRIGGER_H