Improves/updates/fixes indi-gige driver (#1338)

* remove compiler warnings of unused and unreturned values

* Change indi-gige in prepartion to support multiple gige cameras

This patch retains the camera device id (and model name) only as persistent,
even while the camera is disconnected.  The device id is used to open a
handle to the camera and the model name is used with the device id to
create a unique INDI device name to present to the user.

* make indi-gige really disconnect from cameras

* Several improvements to enable multiple cameras and models

This patch makes several improvments preparing to handle multiple cameras
and multiple models:
  1. Much better error handling/logging for all calls to aravis library.
  2. Uses device ID to idenfity cameras (includes vendor, model, serial)
  3. Changes GigECCD class functions signatures:
    - adds virtual specifier to those functions that we override that are
      virtual--proper virtual specification is necessary to ensure the
      correct functions are called in all cases
    - adds "override" modifier to overridden functions for cleaner code.

* Add device temperature to indi property and image info

In general, GiGE cameras often have sensors onboard to measure sensor the
temperature of the CCD/CMOS chip.  This patch gathers this data if the
camera claims that it has this information (using "DeviceTemperature"
property).  The temperature is added to the INDI panel display and also to
the image metadata.

* examine stream buffer queue status before looking at buffer

* GiGe: update gain property following ccd simulator

* GiGe: set expopsure start/duration for FITS header

* do not overwrite ArvGeneric::cam->device id--retain enumerated value from arv_get_device_id()

* GiGe: add pixel size property to allow for manual user config

* GiGe: save Gain and PixelSize settings in config file

* GiGe: minor simplification in setting deviceName

* GiGe: implement streaming

* GiGE: Fix binning

At least for FLIR GiGE cameras, changing binning changes the apparent size
of the chip, such that the region of interest is configured using a smaller
number of pixels.  This appears to be contrary to how INDI expects binning
to be configured.  Following the CCD Simulator (hopefully it is a decent
example of implementing a INDI::CCD device), it rather appears that the
region of interest is still expected to be set using the entire available
Width/Height.  It therefore appears necessary to mitigate this mismatch
since (at least for ekos) the client appears to mess up the apparent image
if binning is configured but a smaller region is selected, but in reality
the entire avaialble sensor was binned.

So, for now, even when binning is used, this patch makes the driver use the
full WidthMax and HeightMax manually divided by the binning to select the
region of interest.

This means that any use of get_x_offset().val(), get_y_offset().val(),
get_width().val(), or get_height().val() from the GigECCD::camera object must
be manually multiplied or divided by the values from get_bin_x().val() and
get_bin_y().val() as appropriate.  Similarly, camera->set_geometry(...) must
be given values that are divided by the appropriate binning.

It remains to verify this behavior on GiGE cameras from other vendors, or
at least to check what the standard says, if anything useful on the matter.

* GiGE: update aravis-0.8 requirement, authors, version in xml

* GigE: use unique_ptr to fix memory leak

This patch changes GigECCD to handle the pointer to the underlying
ArvCamera with a unqiue_ptr rather than a raw pointer.  Prior to this
patch, the GigECCD destructor did not delete the ArvCamera pointer.  Using
a smart pointer interface, this is handled much more carefully and memory
leaks are avoided entirely.

* GigE: enable multiple cameras

This patch implements an iterator in the ArvFactory and creates device
instances for all cameras found.

Author: olsonse

indi-gige/AUTHORS

@@ -1 +1,2 @@
 Hendrik Beijeman  (hbeyeman@gmail.com) http://phym.nl
+Spencer E. Olson (olsonse@umich.edu)

indi-gige/README

@@ -15,7 +15,7 @@ Requirements
 
 	cfitsio-devel is required to compile support for FITS.
 
-+ aravis >= v0.6
++ aravis >= v0.8
 
 	aravis is required, see https://github.com/AravisProject/aravis
 
@@ -57,9 +57,9 @@ GigE machine vision overview
             (2b) Vendor specific set
 
     Project Aravis only uses genicam standard. For some features you need to
-    access the CSR directly. These can easily be queried with arv-tool-0.6  that come
+    access the CSR directly. These can easily be queried with arv-tool-0.8  that come
     with aravis, i.e.
-        $ arv-tool-0.6 control R[0xF0F00A00] R[0xF0F00A04] R[0xF0F00A08] R[0xF0F00A10] R[0xF0F00A14]
+        $ arv-tool-0.8 control R[0xF0F00A00] R[0xF0F00A04] R[0xF0F00A08] R[0xF0F00A10] R[0xF0F00A14]
 
             Point Grey Research-16048874
             R[0xf0f00a00] = 0x08000600

indi-gige/indi_gige_ccd.xml

@@ -1,7 +1,7 @@
 <devGroup group="CCDs">
         <device label="GigE CCD" mdpd="true">
                 <driver name="GigE CCD">indi_gige_ccd</driver>
-		<version>0.1</version>
+		<version>0.2</version>
 	</device>
 </devGroup>
 

indi-gige/src/ArvFactory.cpp

@@ -26,23 +26,49 @@
 
 #define BLACKFLY_MODEL "BFLY-PGE-31S4M"
 
-arv::ArvCamera *ArvFactory::find_first_available(void)
+namespace arv {
+  std::unique_ptr<arv::ArvCamera> create_camera(unsigned int index)
+  {
+      if (index >= arv_get_n_devices())
+          /* no devices found */
+          return nullptr;
+
+      const char *device_id = arv_get_device_id(index);
+      const char *model_name = arv_get_device_model(index);
+
+      if (memmem(model_name, strlen(model_name), BLACKFLY_MODEL, strlen(BLACKFLY_MODEL)))
+      {
+          printf("Creating BlackFly... for %s-%s\n", model_name, device_id);
+          return std::unique_ptr<ArvCamera>(new BlackFly(device_id, model_name));
+      }
+      else
+      {
+          printf("Creating Generic... for %s-%s\n", model_name, device_id);
+          return std::unique_ptr<ArvCamera>(new ArvGeneric(device_id, model_name));
+      }
+  }
+}
+
+std::unique_ptr<arv::ArvCamera> ArvFactory::find_first_available(void)
+{
+    /* We first ensure the library knows of all available devices and info */
+    arv_update_device_list();
+    return create_camera(0);
+}
+
+ArvFactory::Iterator ArvFactory::begin(void)
+{
+    /* We first ensure the library knows of all available devices and info */
+    arv_update_device_list();
+    return ArvFactory::Iterator(0);
+}
+
+ArvFactory::Iterator ArvFactory::end(void)
+{
+    return ArvFactory::Iterator(arv_get_n_devices());
+}
+
+std::unique_ptr<arv::ArvCamera> ArvFactory::Index::instantiate(void) const
 {
-    GError *error = NULL;
-    ::ArvCamera *camera    = arv_camera_new(nullptr, &error);
-    const char *model_name = arv_camera_get_model_name(camera, &error);
-
-    if ((camera == nullptr) || (model_name == nullptr))
-        return nullptr;
-
-    if (memmem(model_name, strlen(model_name), BLACKFLY_MODEL, strlen(BLACKFLY_MODEL)))
-    {
-        printf("Creating BlackFly...\n");
-        return new BlackFly((void *)camera);
-    }
-    else
-    {
-        printf("Creating Generic...\n");
-        return new ArvGeneric((void *)camera);
-    }
+    return create_camera(this->index);
 }