JeVois  1.9
JeVois Smart Embedded Machine Vision Toolkit
Share this page:
Engine.C
Go to the documentation of this file.
1 // ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
2 //
3 // JeVois Smart Embedded Machine Vision Toolkit - Copyright (C) 2016 by Laurent Itti, the University of Southern
4 // California (USC), and iLab at USC. See http://iLab.usc.edu and http://jevois.org for information about this project.
5 //
6 // This file is part of the JeVois Smart Embedded Machine Vision Toolkit. This program is free software; you can
7 // redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software
8 // Foundation, version 2. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
9 // without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
10 // License for more details. You should have received a copy of the GNU General Public License along with this program;
11 // if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
12 //
13 // Contact information: Laurent Itti - 3641 Watt Way, HNB-07A - Los Angeles, CA 90089-2520 - USA.
14 // Tel: +1 213 740 3527 - itti@pollux.usc.edu - http://iLab.usc.edu - http://jevois.org
15 // ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
16 /*! \file */
17 
18 #include <jevois/Core/Engine.H>
19 
20 #include <jevois/Core/Camera.H>
21 #include <jevois/Core/MovieInput.H>
22 
23 #include <jevois/Core/Gadget.H>
27 
28 #include <jevois/Core/Serial.H>
30 
31 #include <jevois/Core/Module.H>
35 
36 #include <jevois/Debug/Log.H>
37 #include <jevois/Util/Utils.H>
38 #include <jevois/Debug/SysInfo.H>
39 
40 #include <cmath> // for fabs
41 #include <fstream>
42 #include <algorithm>
43 #include <cstdlib> // for std::system()
44 #include <cstdio> // for std::remove()
45 
46 // On the older platform kernel, detect class is not defined:
47 #ifndef V4L2_CTRL_CLASS_DETECT
48 #define V4L2_CTRL_CLASS_DETECT 0x00a30000
49 #endif
50 
51 namespace
52 {
53  // Assign a short name to every V4L2 control, for use by getcam and setcam commands
54  struct shortcontrol { int id; char const * const shortname; };
55 
56  // All V4L2 controls
57  // From this: grep V4L2_CID v4l2-controls.h | awk '{ print " { " $2 ", \"\" }," }'
58  // then fill-in the short names.
59  static shortcontrol camcontrols[] = {
60  // In V4L2_CID_BASE class:
61  { V4L2_CID_BRIGHTNESS, "brightness" },
62  { V4L2_CID_CONTRAST, "contrast" },
63  { V4L2_CID_SATURATION, "saturation" },
64  { V4L2_CID_HUE, "hue" },
65  { V4L2_CID_AUDIO_VOLUME, "audiovol" },
66  { V4L2_CID_AUDIO_BALANCE, "audiobal" },
67  { V4L2_CID_AUDIO_BASS, "audiobass" },
68  { V4L2_CID_AUDIO_TREBLE, "audiotreble" },
69  { V4L2_CID_AUDIO_MUTE, "audiomute" },
70  { V4L2_CID_AUDIO_LOUDNESS, "audioloudness" },
71  { V4L2_CID_BLACK_LEVEL, "blacklevel" },
72  { V4L2_CID_AUTO_WHITE_BALANCE, "autowb" },
73  { V4L2_CID_DO_WHITE_BALANCE, "dowb" },
74  { V4L2_CID_RED_BALANCE, "redbal" },
75  { V4L2_CID_BLUE_BALANCE, "bluebal" },
76  { V4L2_CID_GAMMA, "gamma" },
77  { V4L2_CID_WHITENESS, "whiteness" },
78  { V4L2_CID_EXPOSURE, "exposure" },
79  { V4L2_CID_AUTOGAIN, "autogain" },
80  { V4L2_CID_GAIN, "gain" },
81  { V4L2_CID_HFLIP, "hflip" },
82  { V4L2_CID_VFLIP, "vflip" },
83  { V4L2_CID_POWER_LINE_FREQUENCY, "powerfreq" },
84  { V4L2_CID_HUE_AUTO, "autohue" },
85  { V4L2_CID_WHITE_BALANCE_TEMPERATURE, "wbtemp" },
86  { V4L2_CID_SHARPNESS, "sharpness" },
87  { V4L2_CID_BACKLIGHT_COMPENSATION, "backlight" },
88  { V4L2_CID_CHROMA_AGC, "chromaagc" },
89  { V4L2_CID_COLOR_KILLER, "colorkiller" },
90  { V4L2_CID_COLORFX, "colorfx" },
91  { V4L2_CID_AUTOBRIGHTNESS, "autobrightness" },
92  { V4L2_CID_BAND_STOP_FILTER, "bandfilter" },
93  { V4L2_CID_ROTATE, "rotate" },
94  { V4L2_CID_BG_COLOR, "bgcolor" },
95  { V4L2_CID_CHROMA_GAIN, "chromagain" },
96  { V4L2_CID_ILLUMINATORS_1, "illum1" },
97  { V4L2_CID_ILLUMINATORS_2, "illum2" },
98  { V4L2_CID_MIN_BUFFERS_FOR_CAPTURE, "mincapbuf" },
99  { V4L2_CID_MIN_BUFFERS_FOR_OUTPUT, "minoutbuf" },
100  { V4L2_CID_ALPHA_COMPONENT, "alphacompo" },
101  // This one is not defined in our older platform kernel:
102  //{ V4L2_CID_COLORFX_CBCR, "colorfxcbcr" },
103 
104  // In V4L2_CID_CAMERA_CLASS_BASE class
105  { V4L2_CID_EXPOSURE_AUTO, "autoexp" },
106  { V4L2_CID_EXPOSURE_ABSOLUTE, "absexp" },
107  { V4L2_CID_EXPOSURE_AUTO_PRIORITY, "exppri" },
108  { V4L2_CID_PAN_RELATIVE, "panrel" },
109  { V4L2_CID_TILT_RELATIVE, "tiltrel" },
110  { V4L2_CID_PAN_RESET, "panreset" },
111  { V4L2_CID_TILT_RESET, "tiltreset" },
112  { V4L2_CID_PAN_ABSOLUTE, "panabs" },
113  { V4L2_CID_TILT_ABSOLUTE, "tiltabs" },
114  { V4L2_CID_FOCUS_ABSOLUTE, "focusabs" },
115  { V4L2_CID_FOCUS_RELATIVE, "focusrel" },
116  { V4L2_CID_FOCUS_AUTO, "focusauto" },
117  { V4L2_CID_ZOOM_ABSOLUTE, "zoomabs" },
118  { V4L2_CID_ZOOM_RELATIVE, "zoomrel" },
119  { V4L2_CID_ZOOM_CONTINUOUS, "zoomcontinuous" },
120  { V4L2_CID_PRIVACY, "privacy" },
121  { V4L2_CID_IRIS_ABSOLUTE, "irisabs" },
122  { V4L2_CID_IRIS_RELATIVE, "irisrel" },
123 
124  // definition for this one seems to be in the kernel but missing somehow here:
125 #ifndef V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE
126 #define V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE (V4L2_CID_CAMERA_CLASS_BASE+20)
127 #endif
128  { V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE, "presetwb" },
129 
130  // Those are not defined in our older platform kernel:
131  //{ V4L2_CID_AUTO_EXPOSURE_BIAS, "expbias" },
132  //{ V4L2_CID_WIDE_DYNAMIC_RANGE, "wdr" },
133  //{ V4L2_CID_IMAGE_STABILIZATION, "stabilization" },
134  //{ V4L2_CID_ISO_SENSITIVITY, "isosens" },
135  //{ V4L2_CID_ISO_SENSITIVITY_AUTO, "isosensauto" },
136  //{ V4L2_CID_EXPOSURE_METERING, "expmetering" },
137  //{ V4L2_CID_SCENE_MODE, "scene" },
138  //{ V4L2_CID_3A_LOCK, "3alock" },
139  //{ V4L2_CID_AUTO_FOCUS_START, "autofocusstart" },
140  //{ V4L2_CID_AUTO_FOCUS_STOP, "autofocusstop" },
141  //{ V4L2_CID_AUTO_FOCUS_STATUS, "autofocusstatus" },
142  //{ V4L2_CID_AUTO_FOCUS_RANGE, "autofocusrange" },
143  //{ V4L2_CID_PAN_SPEED, "panspeed" },
144  //{ V4L2_CID_TILT_SPEED, "tiltspeed" },
145 
146  // In V4L2_CID_FLASH_CLASS_BASE:
147  { V4L2_CID_FLASH_LED_MODE, "flashled" },
148  { V4L2_CID_FLASH_STROBE_SOURCE, "flashstrobesrc" },
149  { V4L2_CID_FLASH_STROBE, "flashstrobe" },
150  { V4L2_CID_FLASH_STROBE_STOP, "flashstrobestop" },
151  { V4L2_CID_FLASH_STROBE_STATUS, "flashstrovestat" },
152  { V4L2_CID_FLASH_TIMEOUT, "flashtimeout" },
153  { V4L2_CID_FLASH_INTENSITY, "flashintens" },
154  { V4L2_CID_FLASH_TORCH_INTENSITY, "flashtorch" },
155  { V4L2_CID_FLASH_INDICATOR_INTENSITY, "flashindintens" },
156  { V4L2_CID_FLASH_FAULT, "flashfault" },
157  { V4L2_CID_FLASH_CHARGE, "flashcharge" },
158  { V4L2_CID_FLASH_READY, "flashready" },
159 
160  // In V4L2_CID_JPEG_CLASS_BASE:
161  { V4L2_CID_JPEG_CHROMA_SUBSAMPLING, "jpegchroma" },
162  { V4L2_CID_JPEG_RESTART_INTERVAL, "jpegrestartint" },
163  { V4L2_CID_JPEG_COMPRESSION_QUALITY, "jpegcompression" },
164  { V4L2_CID_JPEG_ACTIVE_MARKER, "jpegmarker" },
165 
166  // In V4L2_CID_IMAGE_SOURCE_CLASS_BASE:
167  // Those are not defined in our older platform kernel:
168  //{ V4L2_CID_VBLANK, "vblank" },
169  //{ V4L2_CID_HBLANK, "hblank" },
170  //{ V4L2_CID_ANALOGUE_GAIN, "again" },
171  //{ V4L2_CID_TEST_PATTERN_RED, "testpatred" },
172  //{ V4L2_CID_TEST_PATTERN_GREENR, "testpatgreenr" },
173  //{ V4L2_CID_TEST_PATTERN_BLUE, "testpatblue" },
174  //{ V4L2_CID_TEST_PATTERN_GREENB, "testpatbreenb" },
175 
176  // In V4L2_CID_IMAGE_PROC_CLASS_BASE:
177  //{ V4L2_CID_LINK_FREQ, "linkfreq" },
178  //{ V4L2_CID_PIXEL_RATE, "pixrate" },
179  //{ V4L2_CID_TEST_PATTERN, "testpat" },
180 
181  // In V4L2_CID_DETECT_CLASS_BASE:
182  //{ V4L2_CID_DETECT_MD_MODE, "detectmode" },
183  //{ V4L2_CID_DETECT_MD_GLOBAL_THRESHOLD, "detectthresh" },
184  //{ V4L2_CID_DETECT_MD_THRESHOLD_GRID, "detectthreshgrid" },
185  //{ V4L2_CID_DETECT_MD_REGION_GRID, "detectregiongrid" },
186  };
187 
188  // Convert a long name to a short name:
189  std::string abbreviate(std::string const & longname)
190  {
191  std::string name(longname);
192  std::transform(name.begin(), name.end(), name.begin(), ::tolower);
193  name.erase(std::remove_if(name.begin(), name.end(), [](int c) { return !std::isalnum(c); }), name.end());
194  return name;
195  }
196 } // anonymous namespace
197 
198 
199 // ####################################################################################################
200 jevois::Engine::Engine(std::string const & instance) :
201  jevois::Manager(instance), itsMappings(), itsRunning(false), itsStreaming(false), itsStopMainLoop(false),
202  itsTurbo(false), itsManualStreamon(false), itsVideoErrors(false), itsFrame(0), itsNumSerialSent(0)
203 {
204  JEVOIS_TRACE(1);
205 
206 #ifdef JEVOIS_PLATFORM
207  // Start mass storage thread:
208  itsCheckingMassStorage.store(false); itsMassStorageMode.store(false);
209  itsCheckMassStorageFut = std::async(std::launch::async, &jevois::Engine::checkMassStorage, this);
210  while (itsCheckingMassStorage.load() == false) std::this_thread::sleep_for(std::chrono::milliseconds(5));
211 #endif
212 }
213 
214 // ####################################################################################################
215 jevois::Engine::Engine(int argc, char const* argv[], std::string const & instance) :
216  jevois::Manager(argc, argv, instance), itsMappings(), itsRunning(false), itsStreaming(false),
217  itsStopMainLoop(false), itsTurbo(false), itsManualStreamon(false), itsVideoErrors(false), itsFrame(0),
218  itsNumSerialSent(0)
219 {
220  JEVOIS_TRACE(1);
221 
222 #ifdef JEVOIS_PLATFORM
223  // Start mass storage thread:
224  itsCheckingMassStorage.store(false); itsMassStorageMode.store(false);
225  itsCheckMassStorageFut = std::async(std::launch::async, &jevois::Engine::checkMassStorage, this);
226  while (itsCheckingMassStorage.load() == false) std::this_thread::sleep_for(std::chrono::milliseconds(5));
227 #endif
228 }
229 
230 // ####################################################################################################
231 void jevois::Engine::onParamChange(jevois::engine::serialdev const & JEVOIS_UNUSED_PARAM(param),
232  std::string const & newval)
233 {
235 
236  // If we have a serial already, nuke it:
237  for (std::list<std::shared_ptr<UserInterface> >::iterator itr = itsSerials.begin(); itr != itsSerials.end(); ++itr)
238  if ((*itr)->instanceName() == "serial") itr = itsSerials.erase(itr);
239  removeComponent("serial", false);
240 
241  // Open the usb hardware (4-pin connector) serial port, if any:
242  if (newval.empty() == false)
243  try
244  {
245  std::shared_ptr<jevois::UserInterface> s;
246  if (newval == "stdio")
247  s = addComponent<jevois::StdioInterface>("serial");
248  else
249  {
250  s = addComponent<jevois::Serial>("serial", jevois::UserInterface::Type::Hard);
251  s->setParamVal("devname", newval);
252  }
253 
254  itsSerials.push_back(s);
255  LINFO("Using [" << newval << "] hardware (4-pin connector) serial port");
256  }
257  catch (...) { jevois::warnAndIgnoreException(); LERROR("Could not start hardware (4-pin connector) serial port"); }
258  else LINFO("No hardware (4-pin connector) serial port used");
259 }
260 
261 // ####################################################################################################
262 void jevois::Engine::onParamChange(jevois::engine::usbserialdev const & JEVOIS_UNUSED_PARAM(param),
263  std::string const & newval)
264 {
266 
267  // If we have a usbserial already, nuke it:
268  for (std::list<std::shared_ptr<UserInterface> >::iterator itr = itsSerials.begin(); itr != itsSerials.end(); ++itr)
269  if ((*itr)->instanceName() == "usbserial") itr = itsSerials.erase(itr);
270  removeComponent("usbserial", false);
271 
272  // Open the USB serial port, if any:
273  if (newval.empty() == false)
274  try
275  {
276  std::shared_ptr<jevois::UserInterface> s =
277  addComponent<jevois::Serial>("usbserial", jevois::UserInterface::Type::USB);
278  s->setParamVal("devname", newval);
279  itsSerials.push_back(s);
280  LINFO("Using [" << newval << "] USB serial port");
281  }
282  catch (...) { jevois::warnAndIgnoreException(); LERROR("Could not start USB serial port"); }
283  else LINFO("No USB serial port used");
284 }
285 
286 // ####################################################################################################
287 void jevois::Engine::onParamChange(jevois::engine::cpumode const & JEVOIS_UNUSED_PARAM(param),
288  jevois::engine::CPUmode const & newval)
289 {
290  std::ofstream ofs("/sys/devices/system/cpu/cpu0/cpufreq/scaling_governor");
291  if (ofs.is_open() == false)
292  {
293 #ifdef JEVOIS_PLATFORM
294  LERROR("Cannot set cpu frequency governor mode -- IGNORED");
295 #endif
296  return;
297  }
298 
299  switch (newval)
300  {
301  case engine::CPUmode::PowerSave: ofs << "powersave" << std::endl; break;
302  case engine::CPUmode::Conservative: ofs << "conservative" << std::endl; break;
303  case engine::CPUmode::OnDemand: ofs << "ondemand" << std::endl; break;
304  case engine::CPUmode::Interactive: ofs << "interactive" << std::endl; break;
305  case engine::CPUmode::Performance: ofs << "performance" << std::endl; break;
306  }
307 }
308 
309 // ####################################################################################################
310 void jevois::Engine::onParamChange(jevois::engine::cpumax const & JEVOIS_UNUSED_PARAM(param),
311  unsigned int const & newval)
312 {
313  std::ofstream ofs("/sys/devices/system/cpu/cpu0/cpufreq/scaling_max_freq");
314  if (ofs.is_open() == false)
315  {
316 #ifdef JEVOIS_PLATFORM
317  LERROR("Cannot set cpu max frequency -- IGNORED");
318 #endif
319  return;
320  }
321 
322  ofs << newval * 1000U << std::endl;
323 }
324 
325 // ####################################################################################################
326 void jevois::Engine::onParamChange(jevois::engine::videoerrors const & JEVOIS_UNUSED_PARAM(param),
327  bool const & newval)
328 {
329  itsVideoErrors.store(newval);
330 }
331 
332 // ####################################################################################################
334 {
335  // Set any initial parameters from global config file:
336  std::string const paramcfg = std::string(JEVOIS_CONFIG_PATH) + '/' + JEVOIS_MODULE_PARAMS_FILENAME;
337  std::ifstream ifs(paramcfg); if (ifs.is_open()) setParamsFromStream(ifs, paramcfg);
338 
339  // Run the Manager version. This parses the command line:
341 }
342 
343 // ####################################################################################################
345 {
346  // First make sure the manager gets to run this:
348 
349  // Freeze the serial port device names, their params, and camera and gadget too:
350  serialdev::freeze();
351  usbserialdev::freeze();
352  for (auto & s : itsSerials) s->freezeAllParams();
353  cameradev::freeze();
354  camerasens::freeze();
355  cameranbuf::freeze();
356  camturbo::freeze();
357  gadgetdev::freeze();
358  gadgetnbuf::freeze();
359  itsTurbo = camturbo::get();
360  multicam::freeze();
361  quietcmd::freeze();
362  python::freeze();
363 
364  // Grab the log messages, itsSerials is not going to change anymore now that the serial params are frozen:
365  jevois::logSetEngine(this);
366 
367  // Load our video mappings:
368  itsMappings = jevois::loadVideoMappings(camerasens::get(), itsDefaultMappingIdx);
369  LINFO("Loaded " << itsMappings.size() << " vision processing modes.");
370 
371  // Get python going, we need to do this here to avoid segfaults on platform when instantiating our first python
372  // module. This likely has to do with the fact that the python core is not very thread-safe, and setFormatInternal()
373  // in Engine, which instantiates python modules, will indeed be invoked from a different thread (the one that receives
374  // USB UVC events). Have a look at Python Thread State, Python Gobal Interpreter Lock, etc if interested:
375  if (python::get())
376  {
377  LINFO("Initalizing Python...");
378  jevois::pythonModuleSetEngine(this);
379  }
380 
381  // Instantiate a camera: If device names starts with "/dev/v", assume a hardware camera, otherwise a movie file:
382  std::string const camdev = cameradev::get();
383  if (jevois::stringStartsWith(camdev, "/dev/v"))
384  {
385  LINFO("Starting camera device " << camdev);
386 
387 #ifdef JEVOIS_PLATFORM
388  // Set turbo mode or not:
389  std::ofstream ofs("/sys/module/vfe_v4l2/parameters/turbo");
390  if (ofs.is_open())
391  {
392  if (itsTurbo) ofs << "1" << std::endl; else ofs << "0" << std::endl;
393  ofs.close();
394  }
395  else LERROR("Could not access VFE turbo parameter -- IGNORED");
396 #endif
397 
398  // Now instantiate the camera:
399  itsCamera.reset(new jevois::Camera(camdev, cameranbuf::get()));
400 
401 #ifndef JEVOIS_PLATFORM
402  // No need to confuse people with a non-working camreg param:
403  camreg::set(false);
404  camreg::freeze();
405 #endif
406  }
407  else
408  {
409  LINFO("Using movie input " << camdev << " -- issue a 'streamon' to start processing.");
410  itsCamera.reset(new jevois::MovieInput(camdev, cameranbuf::get()));
411 
412  // No need to confuse people with a non-working camreg param:
413  camreg::set(false);
414  camreg::freeze();
415  }
416 
417  // Instantiate a USB gadget: Note: it will want to access the mappings. If the user-selected video mapping has no usb
418  // out, do not instantiate a gadget:
419  int midx = videomapping::get();
420 
421  // The videomapping parameter is now disabled, users should use the 'setmapping' command once running:
422  videomapping::freeze();
423 
424  if (midx >= int(itsMappings.size()))
425  { LERROR("Mapping index " << midx << " out of range -- USING DEFAULT"); midx = -1; }
426 
427  if (midx < 0) midx = itsDefaultMappingIdx;
428 
429  // Always instantiate a gadget even if not used right now, may be used later:
430  std::string const gd = gadgetdev::get();
431  if (gd == "None")
432  {
433  LINFO("Using no USB video output.");
434  // No USB output and no display, useful for benchmarking only:
435  itsGadget.reset(new jevois::VideoOutputNone());
436  itsManualStreamon = true;
437  }
438  else if (jevois::stringStartsWith(gd, "/dev/"))
439  {
440  LINFO("Loading USB video driver " << gd);
441  // USB gadget driver:
442  itsGadget.reset(new jevois::Gadget(gd, itsCamera.get(), this, gadgetnbuf::get(), multicam::get()));
443  }
444  else if (gd.empty() == false)
445  {
446  LINFO("Saving output video to file " << gd);
447  // Non-empty filename, save to file:
448  itsGadget.reset(new jevois::MovieOutput(gd));
449  itsManualStreamon = true;
450  }
451  else
452  {
453  LINFO("Using display for video output");
454  // Local video display, for use on a host desktop:
455  itsGadget.reset(new jevois::VideoDisplay("jevois", gadgetnbuf::get()));
456  itsManualStreamon = true;
457  }
458 
459  // We are ready to run:
460  itsRunning.store(true);
461 
462  // Set initial format:
463  try { setFormat(midx); } catch (...) { jevois::warnAndIgnoreException(); }
464 
465  // Run init script:
467  runScriptFromFile(JEVOIS_ENGINE_INIT_SCRIPT, nullptr, false);
468 }
469 
470 // ####################################################################################################
472 {
473  JEVOIS_TRACE(1);
474 
475  // Turn off stream if it is on:
476  streamOff();
477 
478  // Tell our run() thread to finish up:
479  itsRunning.store(false);
480 
481 #ifdef JEVOIS_PLATFORM
482  // Tell checkMassStorage() thread to finish up:
483  itsCheckingMassStorage.store(false);
484 #endif
485 
486  // Nuke our module as soon as we can, hopefully soon now that we turned off streaming and running:
487  {
490  itsModule.reset();
491 
492  // Gone, nuke the loader now:
493  itsLoader.reset();
494  }
495 
496  // Because we passed the camera as a raw pointer to the gadget, nuke the gadget first and then the camera:
497  itsGadget.reset();
498  itsCamera.reset();
499 
500 #ifdef JEVOIS_PLATFORM
501  // Will block until the checkMassStorage() thread completes:
502  if (itsCheckMassStorageFut.valid())
503  try { itsCheckMassStorageFut.get(); } catch (...) { jevois::warnAndIgnoreException(); }
504 #endif
505 
506  // Things should be quiet now, unhook from the logger (this call is not strictly thread safe):
507  jevois::logSetEngine(nullptr);
508 }
509 
510 // ####################################################################################################
511 #ifdef JEVOIS_PLATFORM
512 void jevois::Engine::checkMassStorage()
513 {
514  itsCheckingMassStorage.store(true);
515 
516  while (itsCheckingMassStorage.load())
517  {
518  // Check from the mass storage gadget (with JeVois extension) whether the virtual USB drive is mounted by the
519  // host. If currently in mass storage mode and the host just ejected the virtual flash drive, resume normal
520  // operation. If not in mass-storage mode and the host mounted it, enter mass-storage mode (may happen if
521  // /boot/usbsdauto was selected):
522  std::ifstream ifs("/sys/devices/platform/sunxi_usb_udc/gadget/lun0/mass_storage_in_use");
523  if (ifs.is_open())
524  {
525  int inuse; ifs >> inuse;
526  if (itsMassStorageMode.load())
527  {
528  if (inuse == 0) stopMassStorageMode();
529  }
530  else
531  {
532  if (inuse) { JEVOIS_TIMED_LOCK(itsMtx); startMassStorageMode(); }
533  }
534  }
535  std::this_thread::sleep_for(std::chrono::milliseconds(500));
536  }
537 }
538 #endif
539 
540 // ####################################################################################################
542 {
543  JEVOIS_TRACE(2);
544 
546  itsCamera->streamOn();
547  itsGadget->streamOn();
548  itsStreaming.store(true);
549 }
550 
551 // ####################################################################################################
553 {
554  JEVOIS_TRACE(2);
555 
556  // First, tell both the camera and gadget to abort streaming, this will make get()/done()/send() throw:
557  itsGadget->abortStream();
558  itsCamera->abortStream();
559 
560  // Stop the main loop, which will flip itsStreaming to false and will make it easier for us to lock itsMtx:
561  LDEBUG("Stopping main loop...");
562  itsStopMainLoop.store(true);
563  while (itsStopMainLoop.load() && itsRunning.load()) std::this_thread::sleep_for(std::chrono::milliseconds(10));
564  LDEBUG("Main loop stopped.");
565 
566  // Lock up and stream off:
568  itsGadget->streamOff();
569  itsCamera->streamOff();
570 }
571 
572 // ####################################################################################################
574 {
575  JEVOIS_TRACE(2);
576 
577  LDEBUG("Set format number " << idx << " start...");
578 
579  if (idx >= itsMappings.size())
580  LFATAL("Requested mapping index " << idx << " out of range [0 .. " << itsMappings.size()-1 << ']');
581 
583  setFormatInternal(idx);
584  LDEBUG("Set format number " << idx << " done");
585 }
586 
587 // ####################################################################################################
588 void jevois::Engine::setFormatInternal(size_t idx)
589 {
590  // itsMtx should be locked by caller, idx should be valid:
591  JEVOIS_TRACE(2);
592 
593  jevois::VideoMapping const & m = itsMappings[idx];
594  setFormatInternal(m);
595 }
596 
597 // ####################################################################################################
598 void jevois::Engine::setFormatInternal(jevois::VideoMapping const & m, bool reload)
599 {
600  // itsMtx should be locked by caller, idx should be valid:
601  JEVOIS_TRACE(2);
602 
603  LINFO(m.str());
604 
605 #ifdef JEVOIS_PLATFORM
606  if (itsMassStorageMode.load())
607  LFATAL("Cannot setup video streaming while in mass-storage mode. Eject the USB drive on your host computer first.");
608 #endif
609 
610  // Set the format at the camera and gadget levels, unless we are just reloading:
611  if (reload == false)
612  {
613  itsCamera->setFormat(m);
614  if (m.ofmt) itsGadget->setFormat(m);
615  }
616 
617  // Keep track of our current mapping:
618  itsCurrentMapping = m;
619 
620  // Nuke the processing module, if any, so we can also safely nuke the loader. We always nuke the module instance so we
621  // won't have any issues with latent state even if we re-use the same module but possibly with different input
622  // image resolution, etc:
623  if (itsModule)
624  try { removeComponent(itsModule); itsModule.reset(); } catch (...) { jevois::warnAndIgnoreException(); }
625 
626  // Reset our master frame counter on each module load:
627  itsFrame.store(0);
628 
629  // Instantiate the module. If the constructor throws, code is bogus, for example some syntax error in a python module
630  // that is detected at load time. We get the exception's error message for later display into video frames in the main
631  // loop, and mark itsModuleConstructionError:
632  try
633  {
634  // For python modules, we do not need a loader, we just instantiate our special python wrapper module instead:
635  std::string const sopath = m.sopath();
636  if (m.ispython)
637  {
638  if (python::get() == false) LFATAL("Python disabled, delete BOOT:nopython and restart to enable python");
639 
640  // Instantiate the python wrapper:
641  itsLoader.reset();
642  itsModule.reset(new jevois::PythonModule(m));
643  }
644  else
645  {
646  // C++ compiled module. We can re-use the same loader and avoid closing the .so if we will use the same module:
647  if (itsLoader.get() == nullptr || itsLoader->sopath() != sopath)
648  {
649  // Nuke our previous loader and free its resources if needed, then start a new loader:
650  LINFO("Instantiating dynamic loader for " << sopath);
651  itsLoader.reset(new jevois::DynamicLoader(sopath, true));
652  }
653 
654  // Check version match:
655  auto version_major = itsLoader->load<int()>(m.modulename + "_version_major");
656  auto version_minor = itsLoader->load<int()>(m.modulename + "_version_minor");
657  if (version_major() != JEVOIS_VERSION_MAJOR || version_minor() != JEVOIS_VERSION_MINOR)
658  LERROR("Module " << m.modulename << " in file " << sopath << " was build for JeVois v" << version_major() << '.'
659  << version_minor() << ", but running framework is v" << JEVOIS_VERSION_STRING << " -- TRYING ANYWAY");
660 
661  // Instantiate the new module:
662  auto create = itsLoader->load<std::shared_ptr<jevois::Module>(std::string const &)>(m.modulename + "_create");
663  itsModule = create(m.modulename); // Here we just use the class name as instance name
664  }
665 
666  // Add the module as a component to us. Keep this code in sync with Manager::addComponent():
667  {
668  // Lock up so we guarantee the instance name does not get robbed as we add the sub:
669  boost::unique_lock<boost::shared_mutex> ulck(itsSubMtx);
670 
671  // Then add it as a sub-component to us:
672  itsSubComponents.push_back(itsModule);
673  itsModule->itsParent = this;
674  itsModule->setPath(sopath.substr(0, sopath.rfind('/')));
675  }
676 
677  // Bring it to our runstate and load any extra params. NOTE: Keep this in sync with Component::init():
678  if (itsInitialized) itsModule->runPreInit();
679 
680  std::string const paramcfg = itsModule->absolutePath(JEVOIS_MODULE_PARAMS_FILENAME);
681  std::ifstream ifs(paramcfg); if (ifs.is_open()) itsModule->setParamsFromStream(ifs, paramcfg);
682 
683  if (itsInitialized) { itsModule->setInitialized(); itsModule->runPostInit(); }
684 
685  // And finally run any config script:
686  runScriptFromFile(itsModule->absolutePath(JEVOIS_MODULE_SCRIPT_FILENAME), nullptr, false);
687 
688  LINFO("Module [" << m.modulename << "] loaded, initialized, and ready.");
689  itsModuleConstructionError.clear();
690  }
691  catch (...)
692  {
693  itsModuleConstructionError = jevois::warnAndIgnoreException();
694  if (itsModule) try { removeComponent(itsModule); itsModule.reset(); } catch (...) { }
695  LERROR("Module [" << m.modulename << "] startup error and not operational.");
696  }
697 }
698 
699 // ####################################################################################################
701 {
702  JEVOIS_TRACE(2);
703 
704  std::string pfx; // optional command prefix
705 
706  // Announce that we are ready to the hardware serial port, if any. Do not use sendSerial() here so we always issue
707  // this message irrespectively of the user serial preferences:
708  for (auto & s : itsSerials)
709  if (s->instanceName() == "serial")
710  try { s->writeString("INF READY JEVOIS " JEVOIS_VERSION_STRING); }
711  catch (...) { jevois::warnAndIgnoreException(); }
712 
713  while (itsRunning.load())
714  {
715  bool dosleep = true;
716 
717  if (itsStreaming.load())
718  {
719  // Lock up while we use the module:
721 
722  if (itsModule)
723  {
724  // For standard modules, indicate frame start mark if user wants it:
725  jevois::StdModule * stdmod = dynamic_cast<jevois::StdModule *>(itsModule.get());
726  if (stdmod) stdmod->sendSerialMarkStart();
727 
728  // We have a module ready for action. Call its process function and handle any exceptions:
729  try
730  {
731  if (itsCurrentMapping.ofmt) // Process with USB outputs:
732  itsModule->process(jevois::InputFrame(itsCamera, itsTurbo),
733  jevois::OutputFrame(itsGadget, itsVideoErrors.load() ? &itsVideoErrorImage : nullptr));
734  else // Process with no USB outputs:
735  itsModule->process(jevois::InputFrame(itsCamera, itsTurbo));
736  dosleep = false;
737  }
738  catch (...)
739  {
740  // Report exceptions to video if desired: We have to be extra careful here because the exception might have
741  // been called by the input frame (camera not streaming) or the output frame (gadget not streaming), in
742  // addition to exceptions thrown by the module:
743  if (itsCurrentMapping.ofmt && itsVideoErrors.load())
744  {
745  try
746  {
747  // If the module threw before get() or after send() on the output frame, get a buffer from the gadget:
748  if (itsVideoErrorImage.valid() == false)
749  itsGadget->get(itsVideoErrorImage); // could throw when streamoff
750 
751  // Report module exception to serlog and get it back as a string:
752  std::string errstr = jevois::warnAndIgnoreException();
753 
754  // Draw the error message into our video frame:
755  jevois::drawErrorImage(errstr, itsVideoErrorImage);
756  }
757  catch (...) { jevois::warnAndIgnoreException(); }
758 
759  try
760  {
761  // Send the error image over USB:
762  if (itsVideoErrorImage.valid()) itsGadget->send(itsVideoErrorImage); // could throw if gadget stream off
763  }
764  catch (...) { jevois::warnAndIgnoreException(); }
765 
766  // Invalidate the error image so it is clean for the next frame:
767  itsVideoErrorImage.invalidate();
768  }
769  else
770  {
771  // Report module exception to serlog, and ignore:
773  }
774  }
775 
776  // For standard modules, indicate frame start stop if user wants it:
777  if (stdmod) stdmod->sendSerialMarkStop();
778 
779  // Increment our master frame counter
780  ++ itsFrame;
781  itsNumSerialSent.store(0);
782  }
783  else
784  {
785  // No module. If we have a module construction error, render it to an image and stream it over USB now (if we
786  // are doing USB and we want to see errors in the video stream):
787  if (itsCurrentMapping.ofmt && itsVideoErrors.load())
788  try
789  {
790  // Get an output image, draw error message, and send to host:
791  itsGadget->get(itsVideoErrorImage);
792  jevois::drawErrorImage(itsModuleConstructionError, itsVideoErrorImage);
793  itsGadget->send(itsVideoErrorImage);
794 
795  // Also get one camera frame to avoid accumulation of stale buffers:
796  (void)jevois::InputFrame(itsCamera, itsTurbo).get();
797  }
798  catch (...) { jevois::warnAndIgnoreException(); }
799  }
800  }
801 
802  if (itsStopMainLoop.load())
803  {
804  itsStreaming.store(false);
805  LDEBUG("-- Main loop stopped --");
806  itsStopMainLoop.store(false);
807  }
808 
809  if (dosleep)
810  {
811  LDEBUG("No processing module loaded or not streaming... Sleeping...");
812  std::this_thread::sleep_for(std::chrono::milliseconds(50));
813  }
814 
815  // Serial input handling. Note that readSome() and writeString() on the serial could throw. The code below is
816  // organized to catch all other exceptions, except for those, which are caught here at the first try level:
817  for (auto & s : itsSerials)
818  {
819  try
820  {
821  std::string str; bool parsed = false; bool success = false;
822 
823  if (s->readSome(str))
824  {
826 
827 
828  // If the command starts with our hidden command prefix, set the prefix, otherwise clear it:
829  if (jevois::stringStartsWith(str, JEVOIS_JVINV_PREFIX))
830  {
831  pfx = JEVOIS_JVINV_PREFIX;
832  str = str.substr(pfx.length());
833  }
834  else pfx.clear();
835 
836  // Try to execute this command. If the command is for us (e.g., set a parameter) and is correct,
837  // parseCommand() will return true; if it is for us but buggy, it will throw. If it is not recognized by us,
838  // it will return false and we should try sending it to the Module:
839  try { parsed = parseCommand(str, s, pfx); success = parsed; }
840  catch (std::exception const & e)
841  { s->writeString(pfx, std::string("ERR ") + e.what()); parsed = true; }
842  catch (...)
843  { s->writeString(pfx, "ERR Unknown error"); parsed = true; }
844 
845  if (parsed == false)
846  {
847  if (itsModule)
848  {
849  // Note: prefixing is currently not supported for modules, it is for the Engine only
850  try { itsModule->parseSerial(str, s); success = true; }
851  catch (std::exception const & me) { s->writeString(pfx, std::string("ERR ") + me.what()); }
852  catch (...) { s->writeString(pfx, "ERR Command [" + str + "] not recognized by Engine or Module"); }
853  }
854  else s->writeString(pfx, "ERR Unsupported command [" + str + "] and no module");
855  }
856 
857  // If success, let user know:
858  if (success && quietcmd::get() == false) s->writeString(pfx, "OK");
859  }
860  }
861  catch (...) { jevois::warnAndIgnoreException(); }
862  }
863  }
864 }
865 
866 // ####################################################################################################
867 void jevois::Engine::sendSerial(std::string const & str, bool islog)
868 {
869  // If not a log message, we may want to limit the number of serout messages that a module sends on each frame:
870  size_t slim = serlimit::get();
871  if (islog == false && slim)
872  {
873  if (itsNumSerialSent.load() >= slim) return; // limit reached, message dropped
874  ++itsNumSerialSent; // increment number of messages sent. It is reset in the main loop on each new frame.
875  }
876 
877  // Decide where to send this message based on the value of islog:
878  jevois::engine::SerPort p = islog ? serlog::get() : serout::get();
879 
880  switch (p)
881  {
882  case jevois::engine::SerPort::None:
883  break; // Nothing to send
884 
885  case jevois::engine::SerPort::All:
886  for (auto & s : itsSerials)
887  try { s->writeString(str); } catch (...) { jevois::warnAndIgnoreException(); }
888  break;
889 
890  case jevois::engine::SerPort::Hard:
891  for (auto & s : itsSerials)
892  if (s->type() == jevois::UserInterface::Type::Hard)
893  try { s->writeString(str); } catch (...) { jevois::warnAndIgnoreException(); }
894  break;
895 
896  case jevois::engine::SerPort::USB:
897  for (auto & s : itsSerials)
898  if (s->type() == jevois::UserInterface::Type::USB)
899  try { s->writeString(str); } catch (...) { jevois::warnAndIgnoreException(); }
900  break;
901  }
902 }
903 
904 // ####################################################################################################
906 { return itsFrame; }
907 
908 // ####################################################################################################
910 {
911  return itsCurrentMapping;
912 }
913 
914 // ####################################################################################################
916 {
917  return itsMappings.size();
918 }
919 
920 // ####################################################################################################
922 {
923  if (idx >= itsMappings.size())
924  LFATAL("Index " << idx << " out of range [0 .. " << itsMappings.size()-1 << ']');
925 
926  return itsMappings[idx];
927 }
928 
929 // ####################################################################################################
930 size_t jevois::Engine::getVideoMappingIdx(unsigned int iformat, unsigned int iframe, unsigned int interval) const
931 {
932  // If the iformat or iframe is zero, that's probably a probe for the default mode, so return it:
933  if (iformat == 0 || iframe == 0) return itsDefaultMappingIdx;
934 
935  // If interval is zero, probably a driver trying to probe for our default interval, so return the first available one;
936  // otherwise try to find the desired interval and return the corresponding mapping:
937  if (interval)
938  {
939  float const fps = jevois::VideoMapping::uvcToFps(interval);
940  size_t idx = 0;
941 
942  for (jevois::VideoMapping const & m : itsMappings)
943  if (m.uvcformat == iformat && m.uvcframe == iframe && std::fabs(m.ofps - fps) < 0.1F) return idx;
944  else ++idx;
945 
946  LFATAL("No video mapping for iformat=" << iformat <<", iframe=" << iframe << ", interval=" << interval);
947  }
948  else
949  {
950  size_t idx = 0;
951 
952  for (jevois::VideoMapping const & m : itsMappings)
953  if (m.uvcformat == iformat && m.uvcframe == iframe) return idx;
954  else ++idx;
955 
956  LFATAL("No video mapping for iformat=" << iformat <<", iframe=" << iframe << ", interval=" << interval);
957  }
958 }
959 
960 // ####################################################################################################
963 
964 // ####################################################################################################
966 { return itsDefaultMappingIdx; }
967 
968 // ####################################################################################################
969 jevois::VideoMapping const &
970 jevois::Engine::findVideoMapping(unsigned int oformat, unsigned int owidth, unsigned int oheight,
971  float oframespersec) const
972 {
973  for (jevois::VideoMapping const & m : itsMappings)
974  if (m.match(oformat, owidth, oheight, oframespersec)) return m;
975 
976  LFATAL("Could not find mapping for output format " << jevois::fccstr(oformat) << ' ' <<
977  owidth << 'x' << oheight << " @ " << oframespersec << " fps");
978 }
979 
980 // ####################################################################################################
981 std::string jevois::Engine::camctrlname(int id, char const * longname) const
982 {
983  for (size_t i = 0; i < sizeof camcontrols / sizeof camcontrols[0]; ++i)
984  if (camcontrols[i].id == id) return camcontrols[i].shortname;
985 
986  // Darn, this control is not in our list, probably something exotic. Compute a name from the control's long name:
987  return abbreviate(longname);
988 }
989 
990 // ####################################################################################################
991 int jevois::Engine::camctrlid(std::string const & shortname)
992 {
993  for (size_t i = 0; i < sizeof camcontrols / sizeof camcontrols[0]; ++i)
994  if (shortname.compare(camcontrols[i].shortname) == 0) return camcontrols[i].id;
995 
996  // Not in our list, all right, let's find it then in the camera:
997  struct v4l2_queryctrl qc = { };
998  for (int cls = V4L2_CTRL_CLASS_USER; cls <= V4L2_CTRL_CLASS_DETECT; cls += 0x10000)
999  {
1000  // Enumerate all controls in this class. Looks like there is some spillover between V4L2 classes in the V4L2
1001  // enumeration process, we end up with duplicate controls if we try to enumerate all the classes. Hence the
1002  // doneids set to keep track of the ones already reported:
1003  qc.id = cls | 0x900;
1004  while (true)
1005  {
1006  qc.id |= V4L2_CTRL_FLAG_NEXT_CTRL; unsigned int old_id = qc.id; bool failed = false;
1007  try
1008  {
1009  itsCamera->queryControl(qc);
1010  if (abbreviate(reinterpret_cast<char const *>(qc.name)) == shortname) return qc.id;
1011  }
1012  catch (...) { failed = true; }
1013 
1014  // With V4L2_CTRL_FLAG_NEXT_CTRL, the camera kernel driver is supposed to pass down the next valid control if
1015  // the requested one is not found, but some drivers do not honor that, so let's move on to the next control
1016  // manually if needed:
1017  qc.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
1018  if (qc.id == old_id) { ++qc.id; if (qc.id > 100 + (cls | 0x900 | V4L2_CTRL_FLAG_NEXT_CTRL)) break; }
1019  else if (failed) break;
1020  }
1021  }
1022 
1023  LFATAL("Could not find control [" << shortname << "] in the camera");
1024 }
1025 
1026 // ####################################################################################################
1027 std::string jevois::Engine::camCtrlHelp(struct v4l2_queryctrl & qc, std::set<int> & doneids)
1028 {
1029  // See if we have this control:
1030  itsCamera->queryControl(qc);
1031  qc.id &= ~V4L2_CTRL_FLAG_NEXT_CTRL;
1032 
1033  // If we have already done this control, just return an empty string:
1034  if (doneids.find(qc.id) != doneids.end()) return std::string(); else doneids.insert(qc.id);
1035 
1036  // Control exists, let's also get its current value:
1037  struct v4l2_control ctrl = { }; ctrl.id = qc.id;
1038  itsCamera->getControl(ctrl);
1039 
1040  // Print out some description depending on control type:
1041  std::ostringstream ss;
1042  ss << "- " << camctrlname(qc.id, reinterpret_cast<char const *>(qc.name));
1043 
1044  switch (qc.type)
1045  {
1046  case V4L2_CTRL_TYPE_INTEGER:
1047  ss << " [int] min=" << qc.minimum << " max=" << qc.maximum << " step=" << qc.step
1048  << " def=" << qc.default_value << " curr=" << ctrl.value;
1049  break;
1050 
1051  //case V4L2_CTRL_TYPE_INTEGER64:
1052  //ss << " [int64] value=" << ctrl.value64;
1053  //break;
1054 
1055  //case V4L2_CTRL_TYPE_STRING:
1056  //ss << " [str] min=" << qc.minimum << " max=" << qc.maximum << " step=" << qc.step
1057  // << " curr=" << ctrl.string;
1058  //break;
1059 
1060  case V4L2_CTRL_TYPE_BOOLEAN:
1061  ss << " [bool] default=" << qc.default_value << " curr=" << ctrl.value;
1062  break;
1063 
1064  // This one is not supported by the older kernel on platform:
1065  //case V4L2_CTRL_TYPE_INTEGER_MENU:
1066  //ss << " [intmenu] min=" << qc.minimum << " max=" << qc.maximum
1067  // << " def=" << qc.default_value << " curr=" << ctrl.value;
1068  //break;
1069 
1070  case V4L2_CTRL_TYPE_BUTTON:
1071  ss << " [button]";
1072  break;
1073 
1074  case V4L2_CTRL_TYPE_BITMASK:
1075  ss << " [bitmask] max=" << qc.maximum << " def=" << qc.default_value << " curr=" << ctrl.value;
1076  break;
1077 
1078  case V4L2_CTRL_TYPE_MENU:
1079  {
1080  struct v4l2_querymenu querymenu = { };
1081  querymenu.id = qc.id;
1082  ss << " [menu] values ";
1083  for (querymenu.index = qc.minimum; querymenu.index <= (unsigned int)qc.maximum; ++querymenu.index)
1084  {
1085  try { itsCamera->queryMenu(querymenu); } catch (...) { strcpy((char *)(querymenu.name), "fixme"); }
1086  ss << querymenu.index << ':' << querymenu.name << ' ';
1087  }
1088  ss << "curr=" << ctrl.value;
1089  }
1090  break;
1091 
1092  default:
1093  ss << "[unknown type]";
1094  }
1095 
1096  if (qc.flags & V4L2_CTRL_FLAG_DISABLED) ss << " [DISABLED]";
1097 
1098  return ss.str();
1099 }
1100 
1101 // ####################################################################################################
1102 std::string jevois::Engine::camCtrlInfo(struct v4l2_queryctrl & qc, std::set<int> & doneids)
1103 {
1104  // See if we have this control:
1105  itsCamera->queryControl(qc);
1106  qc.id &= ~V4L2_CTRL_FLAG_NEXT_CTRL;
1107 
1108  // If we have already done this control, just return an empty string:
1109  if (doneids.find(qc.id) != doneids.end()) return std::string(); else doneids.insert(qc.id);
1110 
1111  // Control exists, let's also get its current value:
1112  struct v4l2_control ctrl = { }; ctrl.id = qc.id;
1113  itsCamera->getControl(ctrl);
1114 
1115  // Print out some description depending on control type:
1116  std::ostringstream ss;
1117  ss << camctrlname(qc.id, reinterpret_cast<char const *>(qc.name));
1118 
1119  if (qc.flags & V4L2_CTRL_FLAG_DISABLED) ss << " D ";
1120 
1121  switch (qc.type)
1122  {
1123  case V4L2_CTRL_TYPE_INTEGER:
1124  ss << " I " << qc.minimum << ' ' << qc.maximum << ' ' << qc.step
1125  << ' ' << qc.default_value << ' ' << ctrl.value;
1126  break;
1127 
1128  //case V4L2_CTRL_TYPE_INTEGER64:
1129  //ss << " J " << ctrl.value64;
1130  //break;
1131 
1132  //case V4L2_CTRL_TYPE_STRING:
1133  //ss << " S " << qc.minimum << ' ' << qc.maximum << ' ' << qc.step << ' ' << ctrl.string;
1134  //break;
1135 
1136  case V4L2_CTRL_TYPE_BOOLEAN:
1137  ss << " B " << qc.default_value << ' ' << ctrl.value;
1138  break;
1139 
1140  // This one is not supported by the older kernel on platform:
1141  //case V4L2_CTRL_TYPE_INTEGER_MENU:
1142  //ss << " N " << qc.minimum << ' ' << qc.maximum << ' ' << qc.default_value << ' ' << ctrl.value;
1143  //break;
1144 
1145  case V4L2_CTRL_TYPE_BUTTON:
1146  ss << " U";
1147  break;
1148 
1149  case V4L2_CTRL_TYPE_BITMASK:
1150  ss << " K " << qc.maximum << ' ' << qc.default_value << ' ' << ctrl.value;
1151  break;
1152 
1153  case V4L2_CTRL_TYPE_MENU:
1154  {
1155  struct v4l2_querymenu querymenu = { };
1156  querymenu.id = qc.id;
1157  ss << " M " << qc.default_value << ' ' << ctrl.value;
1158  for (querymenu.index = qc.minimum; querymenu.index <= (unsigned int)qc.maximum; ++querymenu.index)
1159  {
1160  try { itsCamera->queryMenu(querymenu); } catch (...) { strcpy((char *)(querymenu.name), "fixme"); }
1161  ss << ' ' << querymenu.index << ':' << querymenu.name << ' ';
1162  }
1163  }
1164  break;
1165 
1166  default:
1167  ss << 'X';
1168  }
1169 
1170  return ss.str();
1171 }
1172 
1173 #ifdef JEVOIS_PLATFORM
1174 // ####################################################################################################
1175 void jevois::Engine::startMassStorageMode()
1176 {
1177  // itsMtx must be locked by caller
1178 
1179  if (itsMassStorageMode.load()) { LERROR("Already in mass-storage mode -- IGNORED"); return; }
1180 
1181  // Nuke any module and loader so we have nothing loaded that uses /jevois:
1182  if (itsModule) { removeComponent(itsModule); itsModule.reset(); }
1183  if (itsLoader) itsLoader.reset();
1184 
1185  // Unmount /jevois:
1186  if (std::system("sync")) LERROR("Disk sync failed -- IGNORED");
1187  if (std::system("mount -o remount,ro /jevois")) LERROR("Failed to remount /jevois read-only -- IGNORED");
1188 
1189  // Now set the backing partition in mass-storage gadget:
1190  std::ofstream ofs(JEVOIS_USBSD_SYS);
1191  if (ofs.is_open() == false) LFATAL("Cannot setup mass-storage backing file to " << JEVOIS_USBSD_SYS);
1192  ofs << JEVOIS_USBSD_FILE << std::endl;
1193 
1194  LINFO("Exported JEVOIS partition of microSD to host computer as virtual flash drive.");
1195  itsMassStorageMode.store(true);
1196 }
1197 
1198 // ####################################################################################################
1199 void jevois::Engine::stopMassStorageMode()
1200 {
1201  //itsMassStorageMode.store(false);
1202  LINFO("JeVois virtual USB drive ejected by host -- REBOOTING");
1203  reboot();
1204 }
1205 
1206 // ####################################################################################################
1207 void jevois::Engine::reboot()
1208 {
1209  if (std::system("sync")) LERROR("Disk sync failed -- IGNORED");
1210  itsCheckingMassStorage.store(false);
1211  itsRunning.store(false);
1212 
1213  // Hard reset to avoid possible hanging during module unload, etc:
1214  if ( ! std::ofstream("/proc/sys/kernel/sysrq").put('1')) LERROR("Cannot trigger hard reset -- please unplug me!");
1215  if ( ! std::ofstream("/proc/sysrq-trigger").put('s')) LERROR("Cannot trigger hard reset -- please unplug me!");
1216  if ( ! std::ofstream("/proc/sysrq-trigger").put('b')) LERROR("Cannot trigger hard reset -- please unplug me!");
1217  std::terminate();
1218 }
1219 #endif
1220 
1221 // ####################################################################################################
1222 void jevois::Engine::cmdInfo(std::shared_ptr<UserInterface> s, bool showAll, std::string const & pfx)
1223 {
1224  s->writeString(pfx, "help - print this help message");
1225  s->writeString(pfx, "help2 - print compact help message about current vision module only");
1226  s->writeString(pfx, "info - show system information including CPU speed, load and temperature");
1227  s->writeString(pfx, "setpar <name> <value> - set a parameter value");
1228  s->writeString(pfx, "getpar <name> - get a parameter value(s)");
1229  s->writeString(pfx, "runscript <filename> - run script commands in specified file");
1230  s->writeString(pfx, "setcam <ctrl> <val> - set camera control <ctrl> to value <val>");
1231  s->writeString(pfx, "getcam <ctrl> - get value of camera control <ctrl>");
1232 
1233  if (showAll || camreg::get())
1234  {
1235  s->writeString(pfx, "setcamreg <reg> <val> - set raw camera register <reg> to value <val>");
1236  s->writeString(pfx, "getcamreg <reg> - get value of raw camera register <reg>");
1237  }
1238 
1239  s->writeString(pfx, "listmappings - list all available video mappings");
1240  s->writeString(pfx, "setmapping <num> - select video mapping <num>, only possible while not streaming");
1241  s->writeString(pfx, "setmapping2 <CAMmode> <CAMwidth> <CAMheight> <CAMfps> <Vendor> <Module> - set no-USB-out "
1242  "video mapping defined on the fly, while not streaming");
1243  s->writeString(pfx, "reload - reload and reset the current module");
1244 
1245  if (showAll || itsCurrentMapping.ofmt == 0 || itsManualStreamon)
1246  {
1247  s->writeString(pfx, "streamon - start camera video streaming");
1248  s->writeString(pfx, "streamoff - stop camera video streaming");
1249  }
1250 
1251  s->writeString(pfx, "ping - returns 'ALIVE'");
1252  s->writeString(pfx, "serlog <string> - forward string to the serial port(s) specified by the serlog parameter");
1253  s->writeString(pfx, "serout <string> - forward string to the serial port(s) specified by the serout parameter");
1254 
1255  if (showAll)
1256  {
1257  // Hide machine-oriented commands by default
1258  s->writeString(pfx, "caminfo - returns machine-readable info about camera parameters");
1259  s->writeString(pfx, "cmdinfo [all] - returns machine-readable info about Engine commands");
1260  s->writeString(pfx, "modcmdinfo - returns machine-readable info about Module commands");
1261  s->writeString(pfx, "paraminfo [hot|mod|modhot] - returns machine-readable info about parameters");
1262  s->writeString(pfx, "serinfo - returns machine-readable info about serial settings (serout serlog serstyle serprec serstamp)");
1263  s->writeString(pfx, "fileget <filepath> - get a file from JeVois to the host. Use with caution!");
1264  s->writeString(pfx, "fileput <filepath> - put a file from the host to JeVois. Use with caution!");
1265  }
1266 
1267 #ifdef JEVOIS_PLATFORM
1268  s->writeString(pfx, "usbsd - export the JEVOIS partition of the microSD card as a virtual USB drive");
1269 #endif
1270  s->writeString(pfx, "sync - commit any pending data write to microSD");
1271  s->writeString(pfx, "date [date and time] - get or set the system date and time");
1272 
1273  s->writeString(pfx, "shell <string> - execute <string> as a shell command. Use with caution!");
1274 
1275 #ifdef JEVOIS_PLATFORM
1276  s->writeString(pfx, "restart - restart the JeVois smart camera");
1277 #else
1278  s->writeString(pfx, "quit - quit this program");
1279 #endif
1280 }
1281 
1282 // ####################################################################################################
1283 void jevois::Engine::modCmdInfo(std::shared_ptr<UserInterface> s, std::string const & pfx)
1284 {
1285  if (itsModule)
1286  {
1287  std::stringstream css; itsModule->supportedCommands(css);
1288  for (std::string line; std::getline(css, line); /* */) s->writeString(pfx, line);
1289  }
1290 }
1291 
1292 // ####################################################################################################
1293 bool jevois::Engine::parseCommand(std::string const & str, std::shared_ptr<UserInterface> s, std::string const & pfx)
1294 {
1295  // itsMtx should be locked by caller
1296 
1297  std::string errmsg;
1298 
1299  // Note: ModemManager on Ubuntu sends this on startup, kill ModemManager to avoid:
1300  // 41 54 5e 53 51 50 4f 52 54 3f 0d 41 54 0d 41 54 0d 41 54 0d 7e 00 78 f0 7e 7e 00 78 f0 7e
1301  //
1302  // AT^SQPORT?
1303  // AT
1304  // AT
1305  // AT
1306  // ~
1307  //
1308  // then later on it insists on trying to mess with us, issuing things like AT, AT+CGMI, AT+GMI, AT+CGMM, AT+GMM,
1309  // AT%IPSYS?, ATE0, ATV1, etc etc
1310 
1311  switch (str.length())
1312  {
1313  case 0:
1314  LDEBUG("Ignoring empty string"); return true;
1315  break;
1316 
1317  case 1:
1318  if (str[0] == '~') { LDEBUG("Ignoring modem config command [~]"); return true; }
1319 
1320  // If the string starts with "#", then just print it out on the serlog port(s). We use this to allow debug messages
1321  // from the arduino to be printed out to the user:
1322  if (str[0] == '#') { sendSerial(str, true); return true; }
1323  break;
1324 
1325  default: // length is 2 or more:
1326 
1327  // Ignore any command that starts with a '~':
1328  if (str[0] == '~') { LDEBUG("Ignoring modem config command [" << str << ']'); return true; }
1329 
1330  // Ignore any command that starts with "AT":
1331  if (str[0] == 'A' && str[1] == 'T') { LDEBUG("Ignoring AT command [" << str <<']'); return true; }
1332 
1333  // If the string starts with "#", then just print it out on the serlog port(s). We use this to allow debug messages
1334  // in the arduino to be printed out to the user:
1335  if (str[0] == '#') { sendSerial(str, true); return true; }
1336 
1337  // Get the first word, i.e., the command:
1338  size_t const idx = str.find(' '); std::string cmd, rem;
1339  if (idx == str.npos) cmd = str; else { cmd = str.substr(0, idx); if (idx < str.length()) rem = str.substr(idx+1); }
1340 
1341  // ----------------------------------------------------------------------------------------------------
1342  if (cmd == "help")
1343  {
1344  // Show all commands, first ours, as supported below:
1345  s->writeString(pfx, "GENERAL COMMANDS:");
1346  s->writeString(pfx, "");
1347  cmdInfo(s, false, pfx);
1348  s->writeString(pfx, "");
1349 
1350  // Then the module's custom commands, if any:
1351  if (itsModule)
1352  {
1353  s->writeString(pfx, "MODULE-SPECIFIC COMMANDS:");
1354  s->writeString(pfx, "");
1355  modCmdInfo(s, pfx);
1356  s->writeString(pfx, "");
1357  }
1358 
1359  // Get the help message for our parameters and write it out line by line so the serial fixes the line endings:
1360  std::stringstream pss; constructHelpMessage(pss);
1361  for (std::string line; std::getline(pss, line); /* */) s->writeString(pfx, line);
1362 
1363  // Show all camera controls
1364  s->writeString(pfx, "AVAILABLE CAMERA CONTROLS:");
1365  s->writeString(pfx, "");
1366 
1367  struct v4l2_queryctrl qc = { }; std::set<int> doneids;
1368  for (int cls = V4L2_CTRL_CLASS_USER; cls <= V4L2_CTRL_CLASS_DETECT; cls += 0x10000)
1369  {
1370  // Enumerate all controls in this class. Looks like there is some spillover between V4L2 classes in the V4L2
1371  // enumeration process, we end up with duplicate controls if we try to enumerate all the classes. Hence the
1372  // doneids set to keep track of the ones already reported:
1373  qc.id = cls | 0x900; unsigned int old_id;
1374  while (true)
1375  {
1376  qc.id |= V4L2_CTRL_FLAG_NEXT_CTRL; old_id = qc.id; bool failed = false;
1377  try { std::string hlp = camCtrlHelp(qc, doneids); if (hlp.empty() == false) s->writeString(pfx, hlp); }
1378  catch (...) { failed = true; }
1379 
1380  // The camera kernel driver is supposed to pass down the next valid control if the requested one is not
1381  // found, but some drivers do not honor that, so let's move on to the next control manually if needed:
1382  qc.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
1383  if (qc.id == old_id) { ++qc.id; if (qc.id > 100 + (cls | 0x900 | V4L2_CTRL_FLAG_NEXT_CTRL)) break; }
1384  else if (failed) break;
1385  }
1386  }
1387 
1388  return true;
1389  }
1390 
1391  // ----------------------------------------------------------------------------------------------------
1392  if (cmd == "caminfo")
1393  {
1394  // Machine-readable list of camera parameters:
1395  struct v4l2_queryctrl qc = { }; std::set<int> doneids;
1396  for (int cls = V4L2_CTRL_CLASS_USER; cls <= V4L2_CTRL_CLASS_DETECT; cls += 0x10000)
1397  {
1398  // Enumerate all controls in this class. Looks like there is some spillover between V4L2 classes in the V4L2
1399  // enumeration process, we end up with duplicate controls if we try to enumerate all the classes. Hence the
1400  // doneids set to keep track of the ones already reported:
1401  qc.id = cls | 0x900; unsigned int old_id;
1402  while (true)
1403  {
1404  qc.id |= V4L2_CTRL_FLAG_NEXT_CTRL; old_id = qc.id; bool failed = false;
1405  try { std::string hlp = camCtrlInfo(qc, doneids); if (hlp.empty() == false) s->writeString(pfx, hlp); }
1406  catch (...) { failed = true; }
1407 
1408  // The camera kernel driver is supposed to pass down the next valid control if the requested one is not
1409  // found, but some drivers do not honor that, so let's move on to the next control manually if needed:
1410  qc.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
1411  if (qc.id == old_id) { ++qc.id; if (qc.id > 100 + (cls | 0x900 | V4L2_CTRL_FLAG_NEXT_CTRL)) break; }
1412  else if (failed) break;
1413  }
1414  }
1415 
1416  return true;
1417  }
1418 
1419  // ----------------------------------------------------------------------------------------------------
1420  if (cmd == "cmdinfo")
1421  {
1422  bool showAll = (rem == "all") ? true : false;
1423  cmdInfo(s, showAll, pfx);
1424  return true;
1425  }
1426 
1427  // ----------------------------------------------------------------------------------------------------
1428  if (cmd == "modcmdinfo")
1429  {
1430  modCmdInfo(s, pfx);
1431  return true;
1432  }
1433 
1434  // ----------------------------------------------------------------------------------------------------
1435  if (cmd == "paraminfo")
1436  {
1437  std::map<std::string, std::string> categs;
1438  bool skipFrozen = (rem == "hot" || rem == "modhot") ? true : false;
1439 
1440  if (rem == "mod" || rem == "modhot")
1441  {
1442  // Report only on our module's parameter, if any:
1443  if (itsModule) itsModule->paramInfo(s, categs, skipFrozen, instanceName(), pfx);
1444  }
1445  else
1446  {
1447  // Report on all parameters:
1448  paramInfo(s, categs, skipFrozen, "", pfx);
1449  }
1450 
1451  return true;
1452  }
1453 
1454  // ----------------------------------------------------------------------------------------------------
1455  if (cmd == "serinfo")
1456  {
1457  std::string info = getParamStringUnique("serout") + ' ' + getParamStringUnique("serlog");
1458  if (auto mod = dynamic_cast<jevois::StdModule *>(itsModule.get()))
1459  info += ' ' + mod->getParamStringUnique("serstyle") + ' ' + mod->getParamStringUnique("serprec") +
1460  ' ' + mod->getParamStringUnique("serstamp");
1461  else info += " - - -";
1462 
1463  s->writeString(pfx, info);
1464 
1465  return true;
1466  }
1467 
1468  // ----------------------------------------------------------------------------------------------------
1469  if (cmd == "help2")
1470  {
1471  if (itsModule)
1472  {
1473  // Start with the module's commands:
1474  std::stringstream css; itsModule->supportedCommands(css);
1475  s->writeString(pfx, "MODULE-SPECIFIC COMMANDS:");
1476  s->writeString(pfx, "");
1477  for (std::string line; std::getline(css, line); /* */) s->writeString(pfx, line);
1478  s->writeString(pfx, "");
1479 
1480  // Now the parameters for that module (and its subs) only:
1481  s->writeString(pfx, "MODULE PARAMETERS:");
1482  s->writeString(pfx, "");
1483 
1484  // Keep this in sync with Manager::constructHelpMessage():
1485  std::unordered_map<std::string, // category:description
1486  std::unordered_map<std::string, // --name (type) default=[def]
1487  std::vector<std::pair<std::string, // component name
1488  std::string // current param value
1489  > > > > helplist;
1490  itsModule->populateHelpMessage("", helplist);
1491 
1492  if (helplist.empty())
1493  s->writeString(pfx, "None.");
1494  else
1495  {
1496  for (auto const & c : helplist)
1497  {
1498  // Print out the category name and description
1499  s->writeString(pfx, c.first);
1500 
1501  // Print out the parameter details
1502  for (auto const & n : c.second)
1503  {
1504  std::vector<std::string> tok = jevois::split(n.first, "[\\r\\n]+");
1505  bool first = true;
1506  for (auto const & t : tok)
1507  {
1508  // Add current value info to the first thing we write (which is name, default, etc)
1509  if (first)
1510  {
1511  auto const & v = n.second;
1512  if (v.size() == 1) // only one component using this param
1513  {
1514  if (v[0].second.empty())
1515  s->writeString(pfx, t); // only one comp, and using default val
1516  else
1517  s->writeString(pfx, t + " current=[" + v[0].second + ']'); // using non-default val
1518  }
1519  else if (v.size() > 1) // several components using this param with possibly different values
1520  {
1521  std::string sss = t + " current=";
1522  for (auto const & pp : v)
1523  if (pp.second.empty() == false) sss += '[' + pp.first + ':' + pp.second + "] ";
1524  s->writeString(pfx, sss);
1525  }
1526  else s->writeString(pfx, t); // no non-default value(s) to report
1527 
1528  first = false;
1529  }
1530 
1531  else // just write out the other lines (param description)
1532  s->writeString(pfx, t);
1533  }
1534  }
1535  s->writeString(pfx, "");
1536  }
1537  }
1538  }
1539  else
1540  s->writeString(pfx, "No module loaded.");
1541 
1542  return true;
1543  }
1544 
1545  // ----------------------------------------------------------------------------------------------------
1546  if (cmd == "info")
1547  {
1548  s->writeString(pfx, "INFO: JeVois " JEVOIS_VERSION_STRING);
1549  s->writeString(pfx, "INFO: " + jevois::getSysInfoVersion());
1550  s->writeString(pfx, "INFO: " + jevois::getSysInfoCPU());
1551  s->writeString(pfx, "INFO: " + jevois::getSysInfoMem());
1552  if (itsModule) s->writeString(pfx, "INFO: " + itsCurrentMapping.str());
1553  else s->writeString(pfx, "INFO: " + jevois::VideoMapping().str());
1554  return true;
1555  }
1556 
1557  // ----------------------------------------------------------------------------------------------------
1558  if (cmd == "setpar")
1559  {
1560  size_t const remidx = rem.find(' ');
1561  if (remidx != rem.npos)
1562  {
1563  std::string const desc = rem.substr(0, remidx);
1564  if (remidx < rem.length())
1565  {
1566  std::string const val = rem.substr(remidx+1);
1567  setParamString(desc, val);
1568  return true;
1569  }
1570  }
1571  errmsg = "Need to provide a parameter name and a parameter value in setpar";
1572  }
1573 
1574  // ----------------------------------------------------------------------------------------------------
1575  if (cmd == "getpar")
1576  {
1577  auto vec = getParamString(rem);
1578  for (auto const & p : vec) s->writeString(pfx, p.first + ' ' + p.second);
1579  return true;
1580  }
1581 
1582  // ----------------------------------------------------------------------------------------------------
1583  if (cmd == "setcam")
1584  {
1585  std::istringstream ss(rem); std::string ctrl; int val; ss >> ctrl >> val;
1586  struct v4l2_control c = { }; c.id = camctrlid(ctrl); c.value = val;
1587  itsCamera->setControl(c);
1588  return true;
1589  }
1590 
1591  // ----------------------------------------------------------------------------------------------------
1592  if (cmd == "getcam")
1593  {
1594  struct v4l2_control c = { }; c.id = camctrlid(rem);
1595  itsCamera->getControl(c);
1596  s->writeString(pfx, rem + ' ' + std::to_string(c.value));
1597  return true;
1598  }
1599 
1600  // ----------------------------------------------------------------------------------------------------
1601  if (cmd == "setcamreg")
1602  {
1603  if (camreg::get())
1604  {
1605  // Read register and value as strings, then std::stoi to convert to int, supports 0x (and 0 for octal, caution)
1606  std::istringstream ss(rem); std::string reg, val; ss >> reg >> val;
1607  itsCamera->writeRegister(std::stoi(reg, nullptr, 0), std::stoi(val, nullptr, 0));
1608  return true;
1609  }
1610  errmsg = "Access to camera registers is disabled, enable with: setpar camreg true";
1611  }
1612 
1613  // ----------------------------------------------------------------------------------------------------
1614  if (cmd == "getcamreg")
1615  {
1616  if (camreg::get())
1617  {
1618  unsigned int val = itsCamera->readRegister(std::stoi(rem, nullptr, 0));
1619  std::ostringstream os; os << std::hex << val;
1620  s->writeString(pfx, os.str());
1621  return true;
1622  }
1623  errmsg = "Access to camera registers is disabled, enable with: setpar camreg true";
1624  }
1625 
1626  // ----------------------------------------------------------------------------------------------------
1627  if (cmd == "listmappings")
1628  {
1629  s->writeString(pfx, "AVAILABLE VIDEO MAPPINGS:");
1630  s->writeString(pfx, "");
1631  for (size_t idx = 0; idx < itsMappings.size(); ++idx)
1632  {
1633  std::string idxstr = std::to_string(idx);
1634  if (idxstr.length() < 5) idxstr = std::string(5 - idxstr.length(), ' ') + idxstr; // pad to 5-char long
1635  s->writeString(pfx, idxstr + " - " + itsMappings[idx].str());
1636  }
1637  return true;
1638  }
1639 
1640  // ----------------------------------------------------------------------------------------------------
1641  if (cmd == "setmapping")
1642  {
1643  size_t const idx = std::stoi(rem);
1644  bool was_streaming = itsStreaming.load();
1645 
1646  if (was_streaming)
1647  {
1648  errmsg = "Cannot set mapping while streaming: ";
1649  if (itsCurrentMapping.ofmt) errmsg += "Stop your webcam program on the host computer first.";
1650  else errmsg += "Issue a 'streamoff' command first.";
1651  }
1652  else if (idx >= itsMappings.size())
1653  errmsg = "Requested mapping index " + std::to_string(idx) + " out of range [0 .. " +
1654  std::to_string(itsMappings.size()-1) + ']';
1655  else
1656  {
1657  try
1658  {
1659  setFormatInternal(idx);
1660  return true;
1661  }
1662  catch (std::exception const & e) { errmsg = "Error parsing or setting mapping [" + rem + "]: " + e.what(); }
1663  catch (...) { errmsg = "Error parsing or setting mapping [" + rem + ']'; }
1664  }
1665  }
1666 
1667  // ----------------------------------------------------------------------------------------------------
1668  if (cmd == "setmapping2")
1669  {
1670  bool was_streaming = itsStreaming.load();
1671 
1672  if (was_streaming)
1673  {
1674  errmsg = "Cannot set mapping while streaming: ";
1675  if (itsCurrentMapping.ofmt) errmsg += "Stop your webcam program on the host computer first.";
1676  else errmsg += "Issue a 'streamoff' command first.";
1677  }
1678  else
1679  {
1680  try
1681  {
1682  jevois::VideoMapping m; std::istringstream full("NONE 0 0 0.0 " + rem); full >> m;
1683  setFormatInternal(m);
1684  return true;
1685  }
1686  catch (std::exception const & e) { errmsg = "Error parsing or setting mapping [" + rem + "]: " + e.what(); }
1687  catch (...) { errmsg = "Error parsing or setting mapping [" + rem + ']'; }
1688  }
1689  }
1690 
1691  // ----------------------------------------------------------------------------------------------------
1692  if (cmd == "reload")
1693  {
1694  setFormatInternal(itsCurrentMapping, true);
1695  return true;
1696  }
1697 
1698  // ----------------------------------------------------------------------------------------------------
1699  if (itsCurrentMapping.ofmt == 0 || itsManualStreamon)
1700  {
1701  if (cmd == "streamon")
1702  {
1703  // keep this in sync with streamOn(), modulo the fact that here we are already locked:
1704  itsCamera->streamOn();
1705  itsGadget->streamOn();
1706  itsStreaming.store(true);
1707  return true;
1708  }
1709 
1710  if (cmd == "streamoff")
1711  {
1712  // keep this in sync with streamOff(), modulo the fact that here we are already locked:
1713  itsGadget->abortStream();
1714  itsCamera->abortStream();
1715 
1716  itsStreaming.store(false);
1717 
1718  itsGadget->streamOff();
1719  itsCamera->streamOff();
1720  return true;
1721  }
1722  }
1723 
1724  // ----------------------------------------------------------------------------------------------------
1725  if (cmd == "ping")
1726  {
1727  s->writeString(pfx, "ALIVE");
1728  return true;
1729  }
1730 
1731  // ----------------------------------------------------------------------------------------------------
1732  if (cmd == "serlog")
1733  {
1734  sendSerial(rem, true);
1735  return true;
1736  }
1737 
1738  // ----------------------------------------------------------------------------------------------------
1739  if (cmd == "serout")
1740  {
1741  sendSerial(rem, false);
1742  return true;
1743  }
1744 
1745  // ----------------------------------------------------------------------------------------------------
1746 #ifdef JEVOIS_PLATFORM
1747  if (cmd == "usbsd")
1748  {
1749  if (itsStreaming.load())
1750  {
1751  errmsg = "Cannot export microSD over USB while streaming: ";
1752  if (itsCurrentMapping.ofmt) errmsg += "Stop your webcam program on the host computer first.";
1753  else errmsg += "Issue a 'streamoff' command first.";
1754  }
1755  else
1756  {
1757  startMassStorageMode();
1758  return true;
1759  }
1760  }
1761 #endif
1762 
1763  // ----------------------------------------------------------------------------------------------------
1764  if (cmd == "sync")
1765  {
1766  if (std::system("sync")) errmsg = "Disk sync failed";
1767  else return true;
1768  }
1769 
1770  // ----------------------------------------------------------------------------------------------------
1771  if (cmd == "date")
1772  {
1773  std::string dat = jevois::system("/bin/date " + rem);
1774  s->writeString(pfx, "date now " + dat.substr(0, dat.size()-1)); // skip trailing newline
1775  return true;
1776  }
1777 
1778  // ----------------------------------------------------------------------------------------------------
1779  if (cmd == "runscript")
1780  {
1781  std::string const fname = itsModule ? itsModule->absolutePath(rem) : rem;
1782 
1783  try { runScriptFromFile(fname, s, true); return true; }
1784  catch (...) { errmsg = "Script " + fname + " execution failed"; }
1785  }
1786 
1787  // ----------------------------------------------------------------------------------------------------
1788  if (cmd == "shell")
1789  {
1790  std::string ret = jevois::system(rem, true);
1791  std::vector<std::string> rvec = jevois::split(ret, "\n");
1792  for (std::string const & r : rvec) s->writeString(pfx, r);
1793  return true;
1794  }
1795 
1796  // ----------------------------------------------------------------------------------------------------
1797  if (cmd == "fileget")
1798  {
1799  std::shared_ptr<jevois::Serial> ser = std::dynamic_pointer_cast<jevois::Serial>(s);
1800  if (!ser)
1801  errmsg = "File transfer only supported over USB or Hard serial ports";
1802  else
1803  {
1804  std::string const abspath = itsModule ? itsModule->absolutePath(rem) : rem;
1805  ser->fileGet(abspath);
1806  return true;
1807  }
1808  }
1809 
1810  // ----------------------------------------------------------------------------------------------------
1811  if (cmd == "fileput")
1812  {
1813  std::shared_ptr<jevois::Serial> ser = std::dynamic_pointer_cast<jevois::Serial>(s);
1814  if (!ser)
1815  errmsg = "File transfer only supported over USB or Hard serial ports";
1816  else
1817  {
1818  std::string const abspath = itsModule ? itsModule->absolutePath(rem) : rem;
1819  ser->filePut(abspath);
1820  if (std::system("sync")) { } // quietly ignore any errors on sync
1821  return true;
1822  }
1823  }
1824 
1825 #ifdef JEVOIS_PLATFORM
1826  // ----------------------------------------------------------------------------------------------------
1827  if (cmd == "restart")
1828  {
1829  s->writeString(pfx, "Restart command received - bye-bye!");
1830 
1831  if (itsStreaming.load())
1832  s->writeString(pfx, "ERR Video streaming is on - you should quit your video viewer before rebooting");
1833 
1834  // Turn off the SD storage if it is there:
1835  std::ofstream(JEVOIS_USBSD_SYS).put('\n'); // ignore errors
1836  if (std::system("sync")) s->writeString(pfx, "ERR Disk sync failed -- IGNORED");
1837 
1838  // Hard reboot:
1839  this->reboot();
1840  return true;
1841  }
1842  // ----------------------------------------------------------------------------------------------------
1843 #else
1844  // ----------------------------------------------------------------------------------------------------
1845  if (cmd == "quit")
1846  {
1847  s->writeString(pfx, "Quit command received - bye-bye!");
1848  itsGadget->abortStream();
1849  itsCamera->abortStream();
1850  itsStreaming.store(false);
1851  itsGadget->streamOff();
1852  itsCamera->streamOff();
1853  itsRunning.store(false);
1854  return true;
1855  }
1856  // ----------------------------------------------------------------------------------------------------
1857 #endif
1858  }
1859 
1860  // If we make it here, we did not parse the command. If we have an error message, that means we had started parsing
1861  // the command but it was buggy, so let's throw. Otherwise, we just return false to indicate that we did not parse
1862  // this command and maybe it is for the Module:
1863  if (errmsg.size()) throw std::runtime_error("Command error [" + str + "]: " + errmsg);
1864  return false;
1865 }
1866 
1867 // ####################################################################################################
1868 void jevois::Engine::runScriptFromFile(std::string const & filename, std::shared_ptr<jevois::UserInterface> ser,
1869  bool throw_no_file)
1870 {
1871  // itsMtx should be locked by caller
1872 
1873  // Try to find the file:
1874  std::ifstream ifs(filename);
1875  if (!ifs) { if (throw_no_file) LFATAL("Could not open file " << filename); else return; }
1876 
1877  // We need to identify a serial to send any errors to, if none was given to us. Let's use the one in serlog, or, if
1878  // none is specified there, the first available serial:
1879  if (!ser)
1880  {
1881  if (itsSerials.empty()) LFATAL("Need at least one active serial to run script");
1882  switch (serlog::get())
1883  {
1884  case jevois::engine::SerPort::Hard:
1885  for (auto & s : itsSerials) if (s->type() == jevois::UserInterface::Type::Hard) { ser = s; break; }
1886  break;
1887 
1888  case jevois::engine::SerPort::USB:
1889  for (auto & s : itsSerials) if (s->type() == jevois::UserInterface::Type::USB) { ser = s; break; }
1890  break;
1891 
1892  default: break;
1893  }
1894  if (!ser) ser = itsSerials.front();
1895  }
1896 
1897  // Ok, run the script, plowing through any errors:
1898  size_t linenum = 1;
1899  for (std::string line; std::getline(ifs, line); /* */)
1900  {
1901  // Strip any extra whitespace at end, which could be a CR if the file was edited in Windows:
1902  line = jevois::strip(line);
1903 
1904  // Skip comments and empty lines:
1905  if (line.length() == 0 || line[0] == '#') continue;
1906 
1907  // Go and parse that line:
1908  try
1909  {
1910  bool parsed = false;
1911  try { parsed = parseCommand(line, ser); }
1912  catch (std::exception const & e)
1913  { ser->writeString("ERR " + filename + ':' + std::to_string(linenum) + ": " + e.what()); }
1914  catch (...)
1915  { ser->writeString("ERR " + filename + ':' + std::to_string(linenum) + ": Bogus command ["+line+"] ignored"); }
1916 
1917  if (parsed == false)
1918  {
1919  if (itsModule)
1920  {
1921  try { itsModule->parseSerial(line, ser); }
1922  catch (std::exception const & me)
1923  { ser->writeString("ERR " + filename + ':' + std::to_string(linenum) + ": " + me.what()); }
1924  catch (...)
1925  { ser->writeString("ERR " + filename + ':' + std::to_string(linenum)+": Bogus command ["+line+"] ignored"); }
1926  }
1927  else ser->writeString("ERR Unsupported command [" + line + "] and no module");
1928  }
1929  }
1930  catch (...) { jevois::warnAndIgnoreException(); }
1931 
1932  ++linenum;
1933  }
1934 }
#define LDEBUG(msg)
Convenience macro for users to print out console or syslog messages, DEBUG level. ...
Definition: Log.H:155
std::string warnAndIgnoreException()
Convenience function to catch an exception, issue some LERROR (depending on type), and ignore it.
Definition: Log.C:211
float ofps
output frame rate in frames/sec
Definition: VideoMapping.H:48
std::string strip(std::string const &str)
Strip white space (including CR, LF, tabs, etc) from the end of a string.
Definition: Utils.C:180
size_t getVideoMappingIdx(unsigned int iformat, unsigned int iframe, unsigned int interval) const
Get the video mapping index for a given UVC iformat, iframe and interval.
Definition: Engine.C:930
size_t numVideoMappings() const
Return the number of video mappings.
Definition: Engine.C:915
unsigned int uvcformat
USB-UVC format number (1-based)
Definition: VideoMapping.H:55
void drawErrorImage(std::string const &errmsg, RawImage &videoerrimg)
Display an error message into a RawImage.
Definition: Log.C:244
Class to open shared object (.so) files and load functions contained in them.
Definition: DynamicLoader.H:69
Exception-safe wrapper around a raw camera input frame.
Definition: Module.H:57
size_t itsDefaultMappingIdx
Index of default mapping.
Definition: Engine.H:362
std::vector< std::string > setParamString(std::string const &paramdescriptor, std::string const &val)
Set a parameter value, by string.
Definition: Component.C:347
void postInit() override
Override of Manager::postInit()
Definition: Engine.C:344
std::shared_ptr< VideoInput > itsCamera
Our camera.
Definition: Engine.H:366
#define V4L2_CTRL_CLASS_DETECT
Definition: Engine.C:48
void streamOff()
Stop streaming on video from camera, processing, and USB.
Definition: Engine.C:552
void preInit() override
Calls parseCommandLine()
Definition: Manager.C:49
void preInit() override
Override of Manager::preInit()
Definition: Engine.C:333
std::unique_ptr< DynamicLoader > itsLoader
Our module loader.
Definition: Engine.H:369
std::atomic< bool > itsStreaming
True when we are streaming video.
Definition: Engine.H:373
Manager of a hierarchy of Component objects.
Definition: Manager.H:73
void streamOn()
Start streaming on video from camera, processing, and USB.
Definition: Engine.C:541
unsigned int ofmt
output pixel format, or 0 for no output over USB
Definition: VideoMapping.H:45
VideoMapping const & findVideoMapping(unsigned int oformat, unsigned int owidth, unsigned int oheight, float oframespersec) const
Find the VideoMapping that has the given output specs, or throw if not found.
Definition: Engine.C:970
#define JEVOIS_TIMED_LOCK(mtx)
Helper macro to create a timed_lock_guard object.
Definition: Log.H:299
std::vector< VideoMapping > itsMappings
All our mappings from videomappings.cfg.
Definition: Engine.H:363
#define success()
void invalidate()
Invalidate the image by zero&#39;ing out the pointer to pixel buffer and the dims and format...
Definition: RawImage.C:42
RawImage const & get(bool casync=false) const
Get the next captured camera image.
Definition: Module.C:51
void mainLoop()
Main loop: grab, process, send over USB. Should be called by main application thread.
Definition: Engine.C:700
#define JEVOIS_TRACE(level)
Trace object.
Definition: Log.H:267
std::string modulename
Name of the Module that will process this mapping.
Definition: VideoMapping.H:60
Video output to a movie file, using OpenCV video encoding.
Definition: MovieOutput.H:33
std::string getSysInfoVersion()
Get O.S. version info.
Definition: SysInfo.C:72
Interface to a serial port.
Definition: Serial.H:84
void sendSerial(std::string const &str, bool islog=false)
Send a string to all serial ports.
Definition: Engine.C:867
bool parseCommand(std::string const &str, std::shared_ptr< UserInterface > s, std::string const &pfx="")
Parse a user command received over serial port.
Definition: Engine.C:1293
std::string str() const
Convenience function to print out the whole mapping in a human-friendly way.
Definition: VideoMapping.C:87
size_t frameNum() const
Get frame number.
Definition: Engine.C:905
bool valid() const
Check whether the image has a valid pixel buffer.
Definition: RawImage.C:46
void removeComponent(std::shared_ptr< Comp > &component)
Remove a top-level Component from the Manager, by shared_ptr.
Definition: ManagerImpl.H:100
std::shared_ptr< VideoOutput > itsGadget
Our gadget.
Definition: Engine.H:367
void constructHelpMessage(std::ostream &out) const
Constructs a help message from all parameters in the model, and outputs it to &#39;out&#39;.
Definition: Manager.C:82
#define LERROR(msg)
Convenience macro for users to print out console or syslog messages, ERROR level. ...
Definition: Log.H:193
std::string getParamStringUnique(std::string const &paramdescriptor) const
Get a parameter value by string, simple version assuming only one parameter match.
Definition: Component.C:390
std::string sopath() const
Return the full absolute path and file name of the module&#39;s .so or .py file.
Definition: VideoMapping.C:30
VideoMapping itsCurrentMapping
Current video mapping, may not match any in itsMappings if setmapping2 used.
Definition: Engine.H:364
static float uvcToFps(unsigned int interval)
Convert from USB/UVC interval to fps.
Definition: VideoMapping.C:45
VideoMapping const & getVideoMapping(size_t idx) const
Allow access to our video mappings which are parsed from file at construction.
Definition: Engine.C:921
~Engine()
Destructor.
Definition: Engine.C:471
std::string getSysInfoCPU()
Get CPU info: frequency, thermal, load.
Definition: SysInfo.C:38
JeVois camera driver class - grabs frames from a Video4Linux camera sensor.
Definition: Camera.H:64
void logSetEngine(Engine *e)
Set an Engine so that all log messages will be forwarded to its serial ports.
Definition: Log.C:114
Simple struct to hold video mapping definitions for the processing Engine.
Definition: VideoMapping.H:43
std::string system(std::string const &cmd, bool errtoo=true)
Execute a command and grab stdout output to a string.
Definition: Utils.C:248
VideoMapping const & getCurrentVideoMapping() const
Get the current video mapping.
Definition: Engine.C:909
std::atomic< bool > itsStopMainLoop
Flag used to stop the main loop.
Definition: Engine.H:374
void onParamChange(engine::cameradev const &param, std::string const &newval)
Parameter callback.
bool stringStartsWith(std::string const &str, std::string const &prefix)
Return true if str starts with prefix (including if both strings are equal)
Definition: Utils.C:166
std::string fccstr(unsigned int fcc)
Convert a V4L2 four-cc code (V4L2_PIX_FMT_...) to a 4-char string.
Definition: Utils.C:39
unsigned int uvcframe
USB UVC frame number (1-based)
Definition: VideoMapping.H:56
void sendSerialMarkStop()
Send a message MARK STOP to indicate the end of processing.
Definition: Module.C:728
JeVois gadget driver - exposes a uvcvideo interface to host computer connected over USB...
Definition: Gadget.H:65
#define LFATAL(msg)
Convenience macro for users to print out console or syslog messages, FATAL level. ...
Definition: Log.H:212
Movie input, can be used as a replacement for Camera to debug algorithms using a fixed video sequence...
Definition: MovieInput.H:35
size_t getDefaultVideoMappingIdx() const
Allow access to the default video mapping index.
Definition: Engine.C:965
std::istream & setParamsFromStream(std::istream &is, std::string const &absfile)
Set some parameters from an open stream.
Definition: Component.C:452
virtual void paramInfo(std::shared_ptr< UserInterface > s, std::map< std::string, std::string > &categs, bool skipFrozen, std::string const &cname="", std::string const &pfx="")
Get machine-oriented descriptions of all parameters.
Definition: Component.C:522
Video output to local screen.
Definition: VideoDisplay.H:34
Wrapper module to allow users to develop new modules written in Python.
Definition: PythonModule.H:189
std::vector< std::pair< std::string, std::string > > getParamString(std::string const &paramdescriptor) const
Get a parameter value, by string.
Definition: Component.C:374
Base class for a module that supports standardized serial messages.
Definition: Module.H:456
void runScriptFromFile(std::string const &filename, std::shared_ptr< UserInterface > ser, bool throw_no_file)
Run a script from file.
Definition: Engine.C:1868
std::string to_string(T const &val)
Convert from type to string.
Definition: UtilsImpl.H:58
bool match(unsigned int oformat, unsigned int owidth, unsigned int oheight, float oframespersec) const
Return true if this VideoMapping&#39;s output format is a match to the given output parameters.
Definition: VideoMapping.C:306
std::timed_mutex itsMtx
Mutex to protect our internals.
Definition: Engine.H:376
Exception-safe wrapper around a raw image to be sent over USB.
Definition: Module.H:145
VideoMapping const & getDefaultVideoMapping() const
Allow access to the default video mapping.
Definition: Engine.C:961
bool ispython
True if the module is written in Python; affects behavior of sopath() only.
Definition: VideoMapping.H:62
void postInit() override
Checks for the –help flag.
Definition: Manager.C:58
std::string const & instanceName() const
The instance name of this component.
Definition: Component.C:49
std::string getSysInfoMem()
Get memory info.
Definition: SysInfo.C:64
void setFormat(size_t idx)
Callback for when the user selects a new output video format.
Definition: Engine.C:573
#define LINFO(msg)
Convenience macro for users to print out console or syslog messages, INFO level.
Definition: Log.H:176
std::atomic< bool > itsRunning
True when we are running.
Definition: Engine.H:372
void sendSerialMarkStart()
Send a message MARK START to indicate the beginning of processing.
Definition: Module.C:720
std::shared_ptr< Module > itsModule
Our current module.
Definition: Engine.H:370
No-op VideoOutput derivative for when there is no video output.
Engine(std::string const &instance)
Constructor.
Definition: Engine.C:200
std::vector< std::string > split(std::string const &input, std::string const &regex="\+")
Split string into vector of tokens using a regex to specify what to split on; default regex splits by...
Definition: Utils.C:142
#define V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE