Merge pull request #336 from LebedevRI/no-samples

Change lack-of-samples into a noisy warning (Refs. #335)

To be reverted in December 2022 (~+11 months from the date of this commit),
see #335 (comment)

Author: LebedevRI

data/cameras.xml

@@ -511,10 +511,11 @@
   </xs:simpleType>
   <xs:simpleType name="CameraTypeSupportedType">
     <xs:restriction base="xs:string">
-      <xs:pattern value="no"/>
+      <xs:pattern value="(no|no-samples)"/>
       <xs:minLength value="2"/>
-      <xs:maxLength value="2"/>
+      <xs:maxLength value="10"/>
       <xs:enumeration value="no"/>
+      <xs:enumeration value="no-samples"/>
     </xs:restriction>
   </xs:simpleType>
   <xs:complexType name="CameraType">

data/cameras.xsd

@@ -173,8 +173,20 @@ bool RawDecoder::checkCameraSupported(const CameraMetaData* meta,
     return false;
   }
 
-  if (!cam->supported)
+  switch (cam->supportStatus) {
+  case Camera::SupportStatus::Supported:
+    break; // Yay us!
+  case Camera::SupportStatus::Unsupported:
     ThrowRDE("Camera not supported (explicit). Sorry.");
+  case Camera::SupportStatus::NoSamples:
+    noSamples = true;
+    writeLog(DEBUG_PRIO::WARNING,
+             "Camera support status is unknown: '%s' '%s' '%s'\n"
+             "Please consider providing samples on <https://raw.pixls.us/> "
+             "if you wish for the support to not be discontinued, thanks!",
+             make.c_str(), model.c_str(), mode.c_str());
+    break; // WYSIWYG.
+  }
 
   if (cam->decoderVersion > getDecoderVersion())
     ThrowRDE("Camera not supported in this version. Update RawSpeed for support.");

src/librawspeed/decoders/RawDecoder.cpp

@@ -109,6 +109,10 @@ class RawDecoder
     explicit operator bool() const { return quadrantMultipliers /*|| ...*/; }
   } iiq;
 
+  // Indicate if the cameras.xml says that the camera support status is unknown
+  // due to the lack of RPU samples
+  bool noSamples = false;
+
 protected:
   /* Attempt to decode the image */
   /* A RawDecoderException will be thrown if the image cannot be decoded, */

src/librawspeed/decoders/RawDecoder.h

@@ -55,8 +55,16 @@ Camera::Camera(const pugi::xml_node& camera) : cfa(iPoint2D(0, 0)) {
 
   canonical_id = make + " " + model;
 
-  supported =
-      camera.attribute("supported").as_string("yes") == std::string("yes");
+  supportStatus = [&camera]() {
+    const std::string_view v = camera.attribute("supported").as_string("yes");
+    if (v == "yes")
+      return Camera::SupportStatus::Supported;
+    if (v == "no")
+      return Camera::SupportStatus::Unsupported;
+    if (v == "no-samples")
+      return Camera::SupportStatus::NoSamples;
+    ThrowCME("Attribute 'supported' has unknown value.");
+  }();
   mode = camera.attribute("mode").as_string("");
   decoderVersion = camera.attribute("decoder_version").as_int(0);
 

src/librawspeed/metadata/Camera.cpp

@@ -77,6 +77,12 @@ class Hints
 class Camera
 {
 public:
+  enum class SupportStatus {
+    Unsupported,
+    Supported,
+    NoSamples,
+  };
+
 #ifdef HAVE_PUGIXML
   explicit Camera(const pugi::xml_node& camera);
 #endif
@@ -93,7 +99,7 @@ class Camera
   std::vector<std::string> aliases;
   std::vector<std::string> canonical_aliases;
   ColorFilterArray cfa;
-  bool supported;
+  SupportStatus supportStatus;
   iPoint2D cropSize;
   iPoint2D cropPos;
   std::vector<BlackArea> blackAreas;

src/librawspeed/metadata/Camera.h

@@ -149,15 +149,15 @@ const Camera* CameraMetaData::addCamera(std::unique_ptr<Camera> cam) {
 void CameraMetaData::disableMake(std::string_view make) const {
   for (const auto& cam : cameras) {
     if (cam.second->make == make)
-      cam.second->supported = false;
+      cam.second->supportStatus = Camera::SupportStatus::Unsupported;
   }
 }
 
 void CameraMetaData::disableCamera(std::string_view make,
                                    std::string_view model) const {
   for (const auto& cam : cameras) {
     if (cam.second->make == make && cam.second->model == model)
-      cam.second->supported = false;
+      cam.second->supportStatus = Camera::SupportStatus::Unsupported;
   }
 }
 

src/librawspeed/metadata/CameraMetaData.cpp

@@ -152,9 +152,11 @@ APPEND(ostringstream* oss, const char* format, ...) {
   *oss << line.data();
 }
 
-std::string img_hash(const RawImage& r) {
+std::string img_hash(const RawImage& r, bool noSamples) {
   ostringstream oss;
 
+  if (noSamples)
+    APPEND(&oss, "camera support status is unknown due to lack of samples\n");
   APPEND(&oss, "make: %s\n", r->metadata.make.c_str());
   APPEND(&oss, "model: %s\n", r->metadata.model.c_str());
   APPEND(&oss, "mode: %s\n", r->metadata.mode.c_str());
@@ -363,6 +365,7 @@ size_t process(const std::string& filename, const CameraMetaData* metadata,
 
   decoder->failOnUnknown = false;
   decoder->checkSupport(metadata);
+  bool noSamples = decoder->noSamples;
 
   decoder->decodeRaw();
   decoder->decodeMetaData(metadata);
@@ -382,12 +385,12 @@ size_t process(const std::string& filename, const CameraMetaData* metadata,
   if (o.create) {
     // write the hash. if force is set, then we are potentially overwriting here
     ofstream f(hashfile);
-    f << img_hash(raw);
+    f << img_hash(raw, noSamples);
     if (o.dump)
       writeImage(raw, filename);
   } else {
     // do generate the hash string regardless.
-    std::string h = img_hash(raw);
+    std::string h = img_hash(raw, noSamples);
 
     // normally, here we would compare the old hash with the new one
     // but if the force is set, and the hash does not exist, do nothing.