UniMRCP  1.3.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
mrcp_verifier_header.h
Go to the documentation of this file.
1 /*
2  * Copyright 2008-2014 Arsen Chaloyan
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  * $Id:
17  */
18 
19 #ifndef MRCP_VERIFIER_HEADER_H
20 #define MRCP_VERIFIER_HEADER_H
21 
22 /**
23  * @file mrcp_verifier_header.h
24  * @brief MRCP Verifier Header
25  */
26 
27 #include "mrcp_types.h"
28 #include "mrcp_header_accessor.h"
29 
30 APT_BEGIN_EXTERN_C
31 
32 /** MRCP verifier header fields */
33 typedef enum {
34  VERIFIER_HEADER_REPOSITORY_URI,
35  VERIFIER_HEADER_VOICEPRINT_IDENTIFIER,
36  VERIFIER_HEADER_VERIFICATION_MODE,
37  VERIFIER_HEADER_ADAPT_MODEL,
38  VERIFIER_HEADER_ABORT_MODEL,
39  VERIFIER_HEADER_MIN_VERIFICATION_SCORE,
40  VERIFIER_HEADER_NUM_MIN_VERIFICATION_PHRASES,
41  VERIFIER_HEADER_NUM_MAX_VERIFICATION_PHRASES,
42  VERIFIER_HEADER_NO_INPUT_TIMEOUT,
43  VERIFIER_HEADER_SAVE_WAVEFORM,
44  VERIFIER_HEADER_MEDIA_TYPE,
45  VERIFIER_HEADER_WAVEFORM_URI,
46  VERIFIER_HEADER_VOICEPRINT_EXISTS,
47  VERIFIER_HEADER_VER_BUFFER_UTTERANCE,
48  VERIFIER_HEADER_INPUT_WAVEFORM_URI,
49  VERIFIER_HEADER_COMPLETION_CAUSE,
50  VERIFIER_HEADER_COMPLETION_REASON,
51  VERIFIER_HEADER_SPEECH_COMPLETE_TIMEOUT,
52  VERIFIER_HEADER_NEW_AUDIO_CHANNEL,
53  VERIFIER_HEADER_ABORT_VERIFICATION,
54  VERIFIER_HEADER_START_INPUT_TIMERS,
55 
56  VERIFIER_HEADER_COUNT
57 } mrcp_verifier_header_id;
58 
59 
60 /** MRCP verifier completion-cause */
61 typedef enum {
62  VERIFIER_COMPLETION_CAUSE_SUCCESS = 0,
63  VERIFIER_COMPLETION_CAUSE_ERROR = 1,
64  VERIFIER_COMPLETION_CAUSE_NO_INPUT_TIMEOUT = 2,
65  VERIFIER_COMPLETION_CAUSE_TOO_MUCH_SPEECH_TIMEOUT = 3,
66  VERIFIER_COMPLETION_CAUSE_SPEECH_TOO_EARLY = 4,
67  VERIFIER_COMPLETION_CAUSE_BUFFER_EMPTY = 5,
68  VERIFIER_COMPLETION_CAUSE_OUT_OF_SEQUENCE = 6,
69  VERIFIER_COMPLETION_CAUSE_REPOSITORY_URI_FAILURE = 7,
70  VERIFIER_COMPLETION_CAUSE_REPOSITORY_URI_MISSING = 8,
71  VERIFIER_COMPLETION_CAUSE_VOICEPRINT_ID_MISSING = 9,
72  VERIFIER_COMPLETION_CAUSE_VOICEPRINT_ID_NOT_EXIST = 10,
73  VERIFIER_COMPLETION_CAUSE_SPEECH_NOT_USABLE = 11,
74 
75  VERIFIER_COMPLETION_CAUSE_COUNT = 12,
76  VERIFIER_COMPLETION_CAUSE_UNKNOWN = VERIFIER_COMPLETION_CAUSE_COUNT
77 } mrcp_verifier_completion_cause_e;
78 
79 
80 
81 /** MRCP verifier-header declaration */
82 typedef struct mrcp_verifier_header_t mrcp_verifier_header_t;
83 
84 /** MRCP verifier-header */
85 struct mrcp_verifier_header_t {
86  /** Specifies the voiceprint repository to be used or referenced during
87  speaker verification or identification operations */
88  apt_str_t repository_uri;
89  /** Specifies the claimed identity for verification applications */
90  apt_str_t voiceprint_identifier;
91  /** Specifies the mode of the verification resource */
92  apt_str_t verification_mode;
93  /** Indicates the desired behavior of the verification resource
94  after a successful verification operation */
95  apt_bool_t adapt_model;
96  /** Indicates the desired behavior of the verification resource
97  upon session termination */
98  apt_bool_t abort_model;
99  /** Determines the minimum verification score for which a verification
100  decision of "accepted" may be declared by the server */
101  float min_verification_score;
102  /** Specifies the minimum number of valid utterances
103  before a positive decision is given for verification */
104  apr_size_t num_min_verification_phrases;
105  /** Specifies the number of valid utterances required
106  before a decision is forced for verification */
107  apr_size_t num_max_verification_phrases;
108  /** Sets the length of time from the start of the verification timers
109  (see START-INPUT-TIMERS) until the declaration of a no-input event
110  in the VERIFICATION-COMPLETE server event message */
111  apr_size_t no_input_timeout;
112  /** Allows the client to request the verification resource to save
113  the audio stream that was used for verification/identification */
114  apt_bool_t save_waveform;
115  /** Tells the server resource the Media Type of the captured audio or video
116  such as the one captured and returned by the Waveform-URI header field */
117  apt_str_t media_type;
118  /** If the Save-Waveform header field is set to true, the verification resource
119  MUST attempt to record the incoming audio stream of the verification into
120  a file and provide a URI for the client to access it */
121  apt_str_t waveform_uri;
122  /** Shows the status of the voiceprint specified
123  in the QUERY-VOICEPRINT method */
124  apt_bool_t voiceprint_exists;
125  /** Indicates that this utterance could be
126  later considered for Speaker Verification */
127  apt_bool_t ver_buffer_utterance;
128  /** Specifies stored audio content that the client requests the server
129  to fetch and process according to the current verification mode,
130  either to train the voiceprint or verify a claimed identity */
131  apt_str_t input_waveform_uri;
132  /** Indicates the cause of VERIFY or VERIFY-FROM-BUFFER method completion */
133  mrcp_verifier_completion_cause_e completion_cause;
134  /** MAY be specified in a VERIFICATION-COMPLETE event
135  coming from the verifier resource to the client */
136  apt_str_t completion_reason;
137  /** Specifies the length of silence required following user
138  speech before the speech verifier finalizes a result */
139  apr_size_t speech_complete_timeout;
140  /** MAY be specified in a VERIFIER request and allows the
141  client to tell the server that, from this point on, further input
142  audio comes from a different audio source */
143  apt_bool_t new_audio_channel;
144  /** MUST be sent in a STOP request to indicate
145  whether or not to abort a VERIFY method in progress */
146  apt_bool_t abort_verification;
147  /** MAY be sent as part of a VERIFY request. A value of false
148  tells the verification resource to start the VERIFY operation,
149  but not to start the no-input timer yet */
150  apt_bool_t start_input_timers;
151 };
152 
153 
154 /** Get verifier header vtable */
155 const mrcp_header_vtable_t* mrcp_verifier_header_vtable_get(mrcp_version_e version);
156 
157 /** Get verifier completion cause string */
158 MRCP_DECLARE(const apt_str_t*) mrcp_verifier_completion_cause_get(mrcp_verifier_completion_cause_e completion_cause, mrcp_version_e version);
159 
160 APT_END_EXTERN_C
161 
162 #endif /* MRCP_VERIFIER_HEADER_H */
Generated on Mon Feb 2 2015 19:41:39 for UniMRCP by   doxygen 1.8.3.1