YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
WhisperSpeechTranscription_ParamsParser.cpp
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2023-2023 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: LGPL-2.1-or-later
4 */
5
6
7// Generated by yarpDeviceParamParserGenerator (2.0)
8// This is an automatically generated file. Please do not edit it.
9// It will be re-generated if the cmake flag ALLOW_DEVICE_PARAM_PARSER_GERNERATION is ON.
10
11// Generated on: Tue Apr 14 11:22:26 2026
12
13
15#include <yarp/os/LogStream.h>
16#include <yarp/os/Value.h>
17
18namespace {
19 YARP_LOG_COMPONENT(WhisperSpeechTranscriptionParamsCOMPONENT, "yarp.device.WhisperSpeechTranscription")
20}
21
22
26
27
29{
30 std::vector<std::string> params;
31 params.push_back("model_context");
32 params.push_back("model_name");
33 params.push_back("language");
34 params.push_back("remove_symbols");
35 return params;
36}
37
38
39bool WhisperSpeechTranscription_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
40{
41 if (paramName =="model_context")
42 {
43 paramValue = m_model_context;
44 return true;
45 }
46 if (paramName =="model_name")
47 {
48 paramValue = m_model_name;
49 return true;
50 }
51 if (paramName =="language")
52 {
53 paramValue = m_language;
54 return true;
55 }
56 if (paramName =="remove_symbols")
57 {
58 paramValue = std::to_string(m_remove_symbols);
59 return true;
60 }
61
62 yError() <<"parameter '" << paramName << "' was not found";
63 return false;
64
65}
66
67
69{
70 //This is a sub-optimal solution.
71 //Ideally getConfiguration() should return all parameters but it is currently
72 //returning only user provided parameters (excluding default values)
73 //This behaviour will be fixed in the near future.
74 std::string s_cfg = m_provided_configuration;
75 return s_cfg;
76}
77
79{
80 //Check for --help option
81 if (config.check("help"))
82 {
83 yCInfo(WhisperSpeechTranscriptionParamsCOMPONENT) << getDocumentationOfDeviceParams();
84 }
85
88 //Parser of parameter model_context
89 {
90 if (config.check("model_context"))
91 {
92 m_model_context = config.find("model_context").asString();
93 yCInfo(WhisperSpeechTranscriptionParamsCOMPONENT) << "Parameter 'model_context' using value:" << m_model_context;
94 }
95 else
96 {
97 yCInfo(WhisperSpeechTranscriptionParamsCOMPONENT) << "Parameter 'model_context' using DEFAULT value:" << m_model_context;
98 }
99 prop_check.unput("model_context");
100 }
101
102 //Parser of parameter model_name
103 {
104 if (config.check("model_name"))
105 {
106 m_model_name = config.find("model_name").asString();
107 yCInfo(WhisperSpeechTranscriptionParamsCOMPONENT) << "Parameter 'model_name' using value:" << m_model_name;
108 }
109 else
110 {
111 yCError(WhisperSpeechTranscriptionParamsCOMPONENT) << "Mandatory parameter 'model_name' not found!";
112 yCError(WhisperSpeechTranscriptionParamsCOMPONENT) << "Description of the parameter: name of Whisper model";
113 return false;
114 }
115 prop_check.unput("model_name");
116 }
117
118 //Parser of parameter language
119 {
120 if (config.check("language"))
121 {
122 m_language = config.find("language").asString();
123 yCInfo(WhisperSpeechTranscriptionParamsCOMPONENT) << "Parameter 'language' using value:" << m_language;
124 }
125 else
126 {
127 yCInfo(WhisperSpeechTranscriptionParamsCOMPONENT) << "Parameter 'language' using DEFAULT value:" << m_language;
128 }
129 prop_check.unput("language");
130 }
131
132 //Parser of parameter remove_symbols
133 {
134 if (config.check("remove_symbols"))
135 {
136 m_remove_symbols = config.find("remove_symbols").asInt64();
137 yCInfo(WhisperSpeechTranscriptionParamsCOMPONENT) << "Parameter 'remove_symbols' using value:" << m_remove_symbols;
138 }
139 else
140 {
141 yCInfo(WhisperSpeechTranscriptionParamsCOMPONENT) << "Parameter 'remove_symbols' using DEFAULT value:" << m_remove_symbols;
142 }
143 prop_check.unput("remove_symbols");
144 }
145
146 /*
147 //This code check if the user set some parameter which are not check by the parser
148 //If the parser is set in strict mode, this will generate an error
149 if (prop_check.size() > 0)
150 {
151 bool extra_params_found = false;
152 for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
153 {
154 if (m_parser_is_strict)
155 {
156 yCError(WhisperSpeechTranscriptionParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
157 extra_params_found = true;
158 }
159 else
160 {
161 yCWarning(WhisperSpeechTranscriptionParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
162 }
163 }
164
165 if (m_parser_is_strict && extra_params_found)
166 {
167 return false;
168 }
169 }
170 */
171 return true;
172}
173
174
176{
177 std::string doc;
178 doc = doc + std::string("\n=============================================\n");
179 doc = doc + std::string("This is the help for device: WhisperSpeechTranscription\n");
180 doc = doc + std::string("\n");
181 doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
182 doc = doc + std::string("'model_context': context of Whisper model\n");
183 doc = doc + std::string("'model_name': name of Whisper model\n");
184 doc = doc + std::string("'language': Language (??? TBC)\n");
185 doc = doc + std::string("'remove_symbols': If symbols from output text, (i.e. ...[bla bla]...) are removed\n");
186 doc = doc + std::string("\n");
187 doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
188 doc = doc + " yarpdev --device yarp_whisperSpeechTranscription --model_context <optional_value> --model_name <mandatory_value> --language auto --remove_symbols 1\n";
189 doc = doc + std::string("Using only mandatory params:\n");
190 doc = doc + " yarpdev --device yarp_whisperSpeechTranscription --model_name <mandatory_value>\n";
191 doc = doc + std::string("=============================================\n\n"); return doc;
192}
#define yError(...)
Definition Log.h:361
bool getParamValue(const std::string &paramName, std::string &paramValue) const override
Return the value (represented as a string) of the requested parameter.
bool parseParams(const yarp::os::Searchable &config) override
Parse the DeviceDriver parameters.
std::string getConfiguration() const override
Return the configuration of the device.
std::string getDocumentationOfDeviceParams() const override
Get the documentation of the DeviceDriver's parameters.
std::vector< std::string > getListOfParams() const override
Return a list of all params used by the device.
A class for storing options and configuration information.
Definition Property.h:32
void unput(const std::string &key)
Remove the association from the given key to a value, if present.
A base class for nested structures that can be searched.
Definition Searchable.h:31
virtual bool check(const std::string &key) const =0
Check if there exists a property of the given name.
virtual std::string toString() const =0
Return a standard text representation of the content of the object.
virtual Value & find(const std::string &key) const =0
Gets a value corresponding to a given keyword.
#define yCInfo(component,...)
#define yCError(component,...)
#define YARP_LOG_COMPONENT(name,...)