Argus Camera Sample Argus Camera Sample

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
XMLConfig.cpp
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of NVIDIA CORPORATION nor the names of its
13 * contributors may be used to endorse or promote products derived
14 * from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
20 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #include <string>
30 #include <fstream>
31 #include <stdio.h>
32
33 #include <expat.h>
34
35 #include "XMLConfig.h"
36 #include "Dispatcher.h"
37 #include "UniquePointer.h"
38
39 namespace ArgusSamples
40 {
41
42 // XML version
43 static const char *VERSION = "1.0";
44
45 // element names
46 static const char *ELEMENT_DEVICE_INDEX = "deviceIndex";
47 static const char *ELEMENT_VERBOSE = "verbose";
48 static const char *ELEMENT_KPI = "kpi";
49 static const char *ELEMENT_EXPOSURE_TIME_RANGE = "exposureTimeRange";
50 static const char *ELEMENT_GAIN_RANGE = "gainRange";
51 static const char *ELEMENT_SENSOR_MODE_INDEX = "sensorModeIndex";
52 static const char *ELEMENT_FRAME_RATE = "frameRate";
53 static const char *ELEMENT_FOCUS_POSITION = "focusPosition";
54 static const char *ELEMENT_AE_ANTIBANDING_MODE = "aeAntibandingMode";
55 static const char *ELEMENT_AE_LOCK = "aeLock";
56 static const char *ELEMENT_AWB_LOCK = "awbLock";
57 static const char *ELEMENT_AWB_MODE = "awbMode";
58 static const char *ELEMENT_EXPOSURE_COMPENSATION = "exposureCompensation";
59 static const char *ELEMENT_ISP_DIGITAL_GAIN_RANGE = "ispDigitalGainRange";
60 static const char *ELEMENT_DENOISE_MODE = "denoiseMode";
61 static const char *ELEMENT_VSTAB_MODE = "vstabMode";
62 static const char *ELEMENT_VIDEO_FORMAT = "videoFormat";
63 static const char *ELEMENT_VIDEO_FILE_TYPE = "videoFileType";
64 static const char *ELEMENT_VIDEO_BIT_RATE = "videoBitRate";
65 static const char *ELEMENT_OUTPUT_SIZE = "outputSize";
66 static const char *ELEMENT_OUTPUT_PATH = "outputPath";
67 static const char *ELEMENT_DE_FOG_ENABLE = "deFogEnable";
68 static const char *ELEMENT_DE_FOG_AMOUNT = "deFogAmount";
69 static const char *ELEMENT_DE_FOG_QUALITY = "deFogQaulity";
70
71 static void XMLCALL xmlHandleData(void *parser, const char *s, int len)
72 {
73 XML_Parser p = (XML_Parser)parser;
74 std::string *data = reinterpret_cast<std::string*>(XML_GetUserData(p));
75
76 data->append(s, len);
77 }
78
79 static void XMLCALL xmlStartElement(void *parser, const char *name, const char **atts)
80 {
81 XML_Parser p = (XML_Parser)parser;
82
83 if (strcmp(name, "argusconfig") == 0)
84 {
85 const char **curAtt = atts;
86
87 while (*curAtt != NULL)
88 {
89 const char *attribute = curAtt[0];
90 const char *value = curAtt[1];
91
92 if (strcmp(attribute, "version") == 0)
93 {
94 if (strcmp(value, VERSION) != 0)
95 {
96 ORIGINATE_ERROR_FAIL("Unsupported version '%s' expected version '%s'",
97 value, VERSION);
98 }
99 }
100 else
101 ORIGINATE_ERROR_FAIL("Found unexpected attribute '%s'", attribute);
102 curAtt += 2;
103 }
104 }
105
106 XML_SetCharacterDataHandler(p, xmlHandleData);
107
108 return;
109
110 fail:
111 XML_StopParser(p, XML_FALSE);
112 }
113
114 /**
115 * Check if an element matches the value name, if this is the case set the value to 'dataStr'
116 * @param [in] elementName current element
117 * @param [in] dataStr data for that element
118 * @param [in] valueName value name
119 * @param [in] value value to update with dataStr if there is a match
120 * @param [out] match set if there was a match
121 */
122 template<typename T> static bool checkValue(const char *elementName, const char *dataStr,
123 const char *valueName, Value<T> &value, bool *match)
124 {
125 if (strcmp(elementName, valueName) == 0)
126 {
127 PROPAGATE_ERROR(value.setFromString(dataStr));
128 *match = true;
129 }
130
131 return true;
132 }
133
134 static void XMLCALL xmlEndElement(void *parser, const char *name)
135 {
136 Dispatcher &dispatcher = Dispatcher::getInstance();
137 XML_Parser p = (XML_Parser)parser;
138 std::string *data = reinterpret_cast<std::string*>(XML_GetUserData(p));
139
140 if (strcmp(name, ELEMENT_DEVICE_INDEX) == 0)
141 {
142 PROPAGATE_ERROR_FAIL(dispatcher.m_deviceIndex.setFromString(data->c_str()));
143 }
144 else if (strcmp(name, ELEMENT_VERBOSE) == 0)
145 {
146 PROPAGATE_ERROR_FAIL(dispatcher.m_verbose.setFromString(data->c_str()));
147 }
148 else if (strcmp(name, ELEMENT_KPI) == 0)
149 {
150 PROPAGATE_ERROR_FAIL(dispatcher.m_kpi.setFromString(data->c_str()));
151 }
152 else if (strcmp(name, ELEMENT_EXPOSURE_TIME_RANGE) == 0)
153 {
154 PROPAGATE_ERROR_FAIL(dispatcher.m_exposureTimeRange.setFromString(data->c_str()));
155 }
156 else if (strcmp(name, ELEMENT_GAIN_RANGE) == 0)
157 {
158 PROPAGATE_ERROR_FAIL(dispatcher.m_gainRange.setFromString(data->c_str()));
159 }
160 else if (strcmp(name, ELEMENT_SENSOR_MODE_INDEX) == 0)
161 {
162 PROPAGATE_ERROR_FAIL(dispatcher.m_sensorModeIndex.setFromString(data->c_str()));
163 }
164 else if (strcmp(name, ELEMENT_FRAME_RATE) == 0)
165 {
166 PROPAGATE_ERROR_FAIL(dispatcher.m_frameRate.setFromString(data->c_str()));
167 }
168 else if (strcmp(name, ELEMENT_FOCUS_POSITION) == 0)
169 {
170 PROPAGATE_ERROR_FAIL(dispatcher.m_focusPosition.setFromString(data->c_str()));
171 }
172 else if (strcmp(name, ELEMENT_DENOISE_MODE) == 0)
173 {
174 PROPAGATE_ERROR_FAIL(dispatcher.m_denoiseMode.setFromString(data->c_str()));
175 }
176 else if (strcmp(name, ELEMENT_VSTAB_MODE) == 0)
177 {
178 PROPAGATE_ERROR_FAIL(dispatcher.m_vstabMode.setFromString(data->c_str()));
179 }
180 else if (strcmp(name, ELEMENT_AE_ANTIBANDING_MODE) == 0)
181 {
182 PROPAGATE_ERROR_FAIL(dispatcher.m_aeAntibandingMode.setFromString(data->c_str()));
183 }
184 else if (strcmp(name, ELEMENT_AE_LOCK) == 0)
185 {
186 PROPAGATE_ERROR_FAIL(dispatcher.m_aeLock.setFromString(data->c_str()));
187 }
188 else if (strcmp(name, ELEMENT_AWB_LOCK) == 0)
189 {
190 PROPAGATE_ERROR_FAIL(dispatcher.m_awbLock.setFromString(data->c_str()));
191 }
192 else if (strcmp(name, ELEMENT_AWB_MODE) == 0)
193 {
194 PROPAGATE_ERROR_FAIL(dispatcher.m_awbMode.setFromString(data->c_str()));
195 }
196 else if (strcmp(name, ELEMENT_EXPOSURE_COMPENSATION) == 0)
197 {
198 PROPAGATE_ERROR_FAIL(dispatcher.m_exposureCompensation.setFromString(data->c_str()));
199 }
200 else if (strcmp(name, ELEMENT_ISP_DIGITAL_GAIN_RANGE) == 0)
201 {
202 PROPAGATE_ERROR_FAIL(dispatcher.m_ispDigitalGainRange.setFromString(data->c_str()));
203 }
204 else if (strcmp(name, ELEMENT_VIDEO_FORMAT) == 0)
205 {
206 PROPAGATE_ERROR_FAIL(dispatcher.m_videoFormat.setFromString(data->c_str()));
207 }
208 else if (strcmp(name, ELEMENT_VIDEO_FILE_TYPE) == 0)
209 {
210 PROPAGATE_ERROR_FAIL(dispatcher.m_videoFileType.setFromString(data->c_str()));
211 }
212 else if (strcmp(name, ELEMENT_VIDEO_BIT_RATE) == 0)
213 {
214 PROPAGATE_ERROR_FAIL(dispatcher.m_videoBitRate.setFromString(data->c_str()));
215 }
216 else if (strcmp(name, ELEMENT_OUTPUT_SIZE) == 0)
217 {
218 PROPAGATE_ERROR_FAIL(dispatcher.m_outputSize.setFromString(data->c_str()));
219 }
220 else if (strcmp(name, ELEMENT_OUTPUT_PATH) == 0)
221 {
222 PROPAGATE_ERROR_FAIL(dispatcher.m_outputPath.set(*data));
223 }
224 else if (strcmp(name, ELEMENT_DE_FOG_ENABLE) == 0)
225 {
226 PROPAGATE_ERROR_FAIL(dispatcher.m_deFogEnable.setFromString(data->c_str()));
227 }
228 else if (strcmp(name, ELEMENT_DE_FOG_AMOUNT) == 0)
229 {
230 PROPAGATE_ERROR_FAIL(dispatcher.m_deFogAmount.setFromString(data->c_str()));
231 }
232 else if (strcmp(name, ELEMENT_DE_FOG_QUALITY) == 0)
233 {
234 PROPAGATE_ERROR_FAIL(dispatcher.m_deFogQuality.setFromString(data->c_str()));
235 }
236 else if (strcmp(name, "argusconfig") == 0)
237 {
238 }
239 else
240 {
241 ORIGINATE_ERROR_FAIL("Unhandled element '%s'.", name);
242 }
243
244 XML_SetCharacterDataHandler(p, NULL);
245 data->clear();
246
247 return;
248
249 fail:
250 XML_StopParser(p, XML_FALSE);
251 }
252
253 bool loadConfig(const char *configFile)
254 {
255 if (configFile == NULL)
256 ORIGINATE_ERROR("'configFile' is NULL");
257
258 FILE *xmlFile;
259 bool success = true;
260 long ftellResult;
261 size_t fileSize;
262 UniquePointer<char> fileData;
263 XML_Parser parser = NULL;
264 std::string data;
265
266 // open the file
267 xmlFile = fopen(configFile, "rb");
268 if (xmlFile == NULL)
269 ORIGINATE_ERROR_FAIL("Failed to open file %s", configFile);
270
271 // get file size
272 if (fseek(xmlFile, 0, SEEK_END) != 0)
273 ORIGINATE_ERROR_FAIL("Failed to read buffer file %s", configFile);
274
275 ftellResult = ftell(xmlFile);
276 if (ftellResult == -1)
277 ORIGINATE_ERROR_FAIL("Failed to read buffer file %s", configFile);
278 if (ftellResult == 0)
279 ORIGINATE_ERROR_FAIL("Empty file %s", configFile);
280
281 fileSize = ftellResult;
282
283 if (fseek(xmlFile, 0, SEEK_SET) != 0)
284 ORIGINATE_ERROR_FAIL("Failed to read buffer file %s", configFile);
285
286 // allocate buffer
287 fileData.reset(new char[fileSize + 1]);
288 if (!fileData)
289 ORIGINATE_ERROR_FAIL("Out of memory");
290
291 // read from file to buffer
292 if (fread(fileData.get(), fileSize, 1, xmlFile) != 1)
293 ORIGINATE_ERROR_FAIL("Failed to read buffer file %s", configFile);
294 // terminate string
295 fileData.get()[fileSize] = 0;
296
297 // create XML parser
298 parser = XML_ParserCreate(NULL);
299 if (parser == NULL)
300 ORIGINATE_ERROR_FAIL("Failed to create parser");
301
302 XML_UseParserAsHandlerArg(parser);
303 // the user data is a string, the XML data handler appens to this, the end element handler
304 // then uses it to set the values
305 XML_SetUserData(parser, &data);
306 XML_SetElementHandler(parser, xmlStartElement, xmlEndElement);
307
308 // start parsing
309 if (XML_Parse(parser, fileData.get(), (int)fileSize, 1) == XML_STATUS_ERROR)
310 {
311 // on failure print the line and column number and the line in which the error occured
312 const XML_Size lineNumber = XML_GetCurrentLineNumber(parser);
313 const XML_Size columnNumber = XML_GetCurrentColumnNumber(parser);
314 const XML_Index byteIndex = XML_GetCurrentByteIndex(parser);
315
316 std::string line;
317
318 if ((byteIndex >= 0) && (static_cast<size_t>(byteIndex) < fileSize))
319 {
320 // find line start
321 size_t lineStart = static_cast<size_t>(byteIndex);
322 while ((lineStart > 0) && (fileData.get()[lineStart] != '\n'))
323 --lineStart;
324 // point after new line
325 if (fileData.get()[lineStart] == '\n')
326 ++lineStart;
327
328 // find line end
329 size_t lineEnd = static_cast<size_t>(lineStart);
330 while ((lineEnd < fileSize) && (fileData.get()[lineEnd] != '\n'))
331 ++lineEnd;
332
333 line.append(&fileData.get()[lineStart], lineEnd - lineStart);
334 }
335 else
336 {
337 line += "-";
338 }
339
340 ORIGINATE_ERROR_FAIL("%s at line %lu:%lu:\n%s",
341 XML_ErrorString(XML_GetErrorCode(parser)),
342 lineNumber, columnNumber, line.c_str());
343 }
344
345 goto succeeded;
346
347 fail:
348 success = false;
349
350 succeeded:
351 if (parser != 0)
352 XML_ParserFree(parser);
353 if (xmlFile != NULL)
354 fclose(xmlFile);
355
356 return success;
357 }
358
359 // write an string to XML
360 static void writeValue(std::ofstream &stream, const char *name, const std::string& string)
361 {
362 stream << " <" << name << ">" << string << "</" << name << ">" << std::endl;
363 }
364
365 // write an value to XML
366 template<typename T> static void writeValue(std::ofstream &stream, const char *name,
367 const Value<T> &value)
368 {
369 writeValue(stream, name, value.toString());
370 }
371
372 bool saveConfig(const char *configFile)
373 {
374 if (configFile == NULL)
375 ORIGINATE_ERROR("'configFile' is NULL");
376
377 Dispatcher &dispatcher = Dispatcher::getInstance();
378
379 // open the stream
380 std::ofstream stream(configFile, std::ofstream::out);
381 if (!stream.is_open())
382 ORIGINATE_ERROR("Failed to open file '%s' for saving.", configFile);
383
384 // header
385 stream << "<?xml version='1.0' encoding='utf-8'?>" << std::endl;
386 stream << "<argusconfig version='" << VERSION << "'>" << std::endl;
387
388 // write the value
389 writeValue(stream, ELEMENT_DEVICE_INDEX, dispatcher.m_deviceIndex);
390 writeValue(stream, ELEMENT_VERBOSE, dispatcher.m_verbose);
391 writeValue(stream, ELEMENT_KPI, dispatcher.m_kpi);
392 writeValue(stream, ELEMENT_EXPOSURE_TIME_RANGE, dispatcher.m_exposureTimeRange);
393 writeValue(stream, ELEMENT_GAIN_RANGE, dispatcher.m_gainRange);
394 writeValue(stream, ELEMENT_SENSOR_MODE_INDEX, dispatcher.m_sensorModeIndex);
395 writeValue(stream, ELEMENT_FRAME_RATE, dispatcher.m_frameRate);
396 writeValue(stream, ELEMENT_FOCUS_POSITION, dispatcher.m_focusPosition);
397 writeValue(stream, ELEMENT_DENOISE_MODE, dispatcher.m_denoiseMode);
398 writeValue(stream, ELEMENT_VSTAB_MODE, dispatcher.m_vstabMode);
399 writeValue(stream, ELEMENT_AE_ANTIBANDING_MODE, dispatcher.m_aeAntibandingMode);
400 writeValue(stream, ELEMENT_AE_LOCK, dispatcher.m_aeLock);
401 writeValue(stream, ELEMENT_AWB_LOCK, dispatcher.m_awbLock);
402 writeValue(stream, ELEMENT_AWB_MODE, dispatcher.m_awbMode);
403 writeValue(stream, ELEMENT_EXPOSURE_COMPENSATION, dispatcher.m_exposureCompensation);
404 writeValue(stream, ELEMENT_ISP_DIGITAL_GAIN_RANGE, dispatcher.m_ispDigitalGainRange);
405 writeValue(stream, ELEMENT_VIDEO_FORMAT, dispatcher.m_videoFormat);
406 writeValue(stream, ELEMENT_VIDEO_FILE_TYPE, dispatcher.m_videoFileType);
407 writeValue(stream, ELEMENT_VIDEO_BIT_RATE, dispatcher.m_videoBitRate);
408 writeValue(stream, ELEMENT_OUTPUT_SIZE, dispatcher.m_outputSize);
409 writeValue(stream, ELEMENT_OUTPUT_PATH, dispatcher.m_outputPath.get());
410 writeValue(stream, ELEMENT_DE_FOG_ENABLE, dispatcher.m_deFogEnable);
411 writeValue(stream, ELEMENT_DE_FOG_AMOUNT, dispatcher.m_deFogAmount);
412 writeValue(stream, ELEMENT_DE_FOG_QUALITY, dispatcher.m_deFogQuality);
413
414 // footer
415 stream << "</argusconfig>" << std::endl;
416
417 stream.close();
418
419 return true;
420 }
421
422 }; // namespace ArgusSamples