rawTherapee/rtengine/dfmanager.cc

/*
 *  This file is part of RawTherapee.
 *
 *  Copyright (c) 2004-2010 Gabor Horvath <hgabor@rawtherapee.com>
 *
 *  RawTherapee is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  RawTherapee is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with RawTherapee.  If not, see <http://www.gnu.org/licenses/>.
 */
#include "dfmanager.h"
#include "../rtgui/options.h"
#include <giomm.h>
#include "../rtgui/guiutils.h"
#include "rawimage.h"
#include <sstream>
#include <iostream>
#include <cstdio>
#include "imagedata.h"
#include <glibmm/ustring.h>

namespace rtengine
{

extern const Settings* settings;

// *********************** class dfInfo **************************************

inline dfInfo& dfInfo::operator =(const dfInfo &o)
{
    if (this != &o) {
        pathname = o.pathname;
        maker = o.maker;
        model = o.model;
        iso = o.iso;
        shutter = o.shutter;
        timestamp = o.timestamp;

        if( ri ) {
            delete ri;
            ri = nullptr;
        }
    }

    return *this;
}

bool dfInfo::operator <(const dfInfo &e2) const
{
    if( this->maker.compare( e2.maker) >= 0 ) {
        return false;
    }

    if( this->model.compare( e2.model) >= 0 ) {
        return false;
    }

    if( this->iso >= e2.iso ) {
        return false;
    }

    if( this->shutter >= e2.shutter ) {
        return false;
    }

    if( this->timestamp >= e2.timestamp ) {
        return false;
    }

    return true;
}

std::string dfInfo::key(const std::string &mak, const std::string &mod, int iso, double shut )
{
    std::ostringstream s;
    s << mak << " " << mod << " ";
    s.width(5);
    s << iso << "ISO ";
    s.precision( 2 );
    s.width(4);
    s << shut << "s";
    return s.str();
}

double dfInfo::distance(const std::string &mak, const std::string &mod, int iso, double shutter) const
{
    if( this->maker.compare( mak) != 0 ) {
        return INFINITY;
    }

    if( this->model.compare( mod) != 0 ) {
        return INFINITY;
    }

    double dISO = (log(this->iso / 100.) - log(iso / 100.)) / log(2);
    double dShutter = (log(this->shutter) - log(shutter)) / log(2);
    return sqrt( dISO * dISO +  dShutter * dShutter);
}

RawImage* dfInfo::getRawImage()
{
    if(ri) {
        return ri;
    }

    updateRawImage();
    updateBadPixelList( ri );

    return ri;
}

std::vector<badPix>& dfInfo::getHotPixels()
{
    if( !ri ) {
        updateRawImage();
        updateBadPixelList( ri );
    }

    return badPixels;
}
/* updateRawImage() load into ri the actual pixel data from pathname if there is a single shot
 * otherwise load each file from the pathNames list and extract a template from the media;
 * the first file is used also for reading all information other than pixels
 */
void dfInfo::updateRawImage()
{
    typedef unsigned int acc_t;

    if( !pathNames.empty() ) {
        std::list<Glib::ustring>::iterator iName = pathNames.begin();
        ri = new RawImage(*iName); // First file used also for extra pixels information (width,height, shutter, filters etc.. )

        if( ri->loadRaw(true)) {
            delete ri;
            ri = nullptr;
        } else {
            int H = ri->get_height();
            int W = ri->get_width();
            ri->compress_image(0);
            int rSize = W * ((ri->getSensorType() == ST_BAYER || ri->getSensorType() == ST_FUJI_XTRANS) ? 1 : 3);
            acc_t **acc = new acc_t*[H];

            for( int row = 0; row < H; row++) {
                acc[row] = new acc_t[rSize ];
            }

            // copy first image into accumulators
            for (int row = 0; row < H; row++)
                for (int col = 0; col < rSize; col++) {
                    acc[row][col] = ri->data[row][col];
                }

            int nFiles = 1; // First file data already loaded

            for( ++iName; iName != pathNames.end(); ++iName) {
                RawImage* temp = new RawImage(*iName);

                if( !temp->loadRaw(true)) {
                    temp->compress_image(0);     //\ TODO would be better working on original, because is temporary
                    nFiles++;

                    if( ri->getSensorType() == ST_BAYER || ri->getSensorType() == ST_FUJI_XTRANS ) {
                        for( int row = 0; row < H; row++) {
                            for( int col = 0; col < W; col++) {
                                acc[row][col] += temp->data[row][col];
                            }
                        }
                    } else {
                        for( int row = 0; row < H; row++) {
                            for( int col = 0; col < W; col++) {
                                acc[row][3 * col + 0] += temp->data[row][3 * col + 0];
                                acc[row][3 * col + 1] += temp->data[row][3 * col + 1];
                                acc[row][3 * col + 2] += temp->data[row][3 * col + 2];
                            }
                        }
                    }
                }

                delete temp;
            }

            for (int row = 0; row < H; row++) {
                for (int col = 0; col < rSize; col++) {
                    ri->data[row][col] = acc[row][col] / nFiles;
                }

                delete [] acc[row];
            }

            delete [] acc;
        }
    } else {
        ri = new RawImage(pathname);

        if( ri->loadRaw(true)) {
            delete ri;
            ri = nullptr;
        } else {
            ri->compress_image(0);
        }
    }
}

void dfInfo::updateBadPixelList( RawImage *df )
{
    if(!df) {
        return;
    }
    const float threshold = 10.f / 8.f;

    if( df->getSensorType() == ST_BAYER || df->getSensorType() == ST_FUJI_XTRANS ) {
        std::vector<badPix> badPixelsTemp;

        #pragma omp parallel
        {
            std::vector<badPix> badPixelsThread;
            #pragma omp for nowait

            for( int row = 2; row < df->get_height() - 2; row++)
                for( int col = 2; col < df->get_width() - 2; col++) {
                    float m =   (df->data[row - 2][col - 2] + df->data[row - 2][col] + df->data[row - 2][col + 2] +
                                 df->data[row][col - 2] + df->data[row][col + 2] +
                                 df->data[row + 2][col - 2] + df->data[row + 2][col] + df->data[row + 2][col + 2]);

                    if( df->data[row][col] > m * threshold ) {
                        badPixelsThread.push_back( badPix(col, row) );
                    }
                }

            #pragma omp critical
            badPixelsTemp.insert(badPixelsTemp.end(), badPixelsThread.begin(), badPixelsThread.end());
        }
        badPixels.insert(badPixels.end(), badPixelsTemp.begin(), badPixelsTemp.end());
    } else {
        for( int row = 1; row < df->get_height() - 1; row++)
            for( int col = 1; col < df->get_width() - 1; col++) {
                float m[3];

                for( int c = 0; c < 3; c++) {
                    m[c] =  (df->data[row - 1][3 * (col - 1) + c] + df->data[row - 1][3 * col + c] + df->data[row - 1][3 * (col + 1) + c] +
                             df->data[row]  [3 * (col - 1) + c] + df->data[row]  [3 * col + c] +
                             df->data[row + 1][3 * (col - 1) + c] + df->data[row + 1][3 * col + c] + df->data[row + 1][3 * (col + 1) + c]);
                }

                if( df->data[row][3 * col] > m[0]*threshold || df->data[row][3 * col + 1] > m[1]*threshold || df->data[row][3 * col + 2] > m[2]*threshold) {
                    badPixels.push_back( badPix(col, row) );
                }
            }
    }

    if( settings->verbose ) {
        std::cout << "Extracted " << badPixels.size() << " pixels from darkframe:" << df->get_filename().c_str() << std::endl;
    }
}


// ************************* class DFManager *********************************

void DFManager::init( Glib::ustring pathname )
{
    std::vector<Glib::ustring> names;

    auto dir = Gio::File::create_for_path (pathname);
    if (!dir || !dir->query_exists()) {
        return;
    }

    try {

        auto enumerator = dir->enumerate_children ("standard::name");

        while (auto file = enumerator->next_file ()) {
            names.emplace_back (Glib::build_filename (pathname, file->get_name ()));
        }

    } catch (Glib::Exception&) {}

    dfList.clear();
    bpList.clear();

    for (size_t i = 0; i < names.size(); i++) {
        size_t lastdot = names[i].find_last_of ('.');

        if (lastdot != Glib::ustring::npos && names[i].substr(lastdot) == ".badpixels" ) {
            int n = scanBadPixelsFile( names[i] );

            if( n > 0 && settings->verbose) {
                printf("Loaded %s: %d pixels\n", names[i].c_str(), n);
            }

            continue;
        }

        try {
            addFileInfo(names[i]);
        } catch( std::exception& e ) {}
    }

    // Where multiple shots exist for same group, move filename to list
    for( dfList_t::iterator iter = dfList.begin(); iter != dfList.end(); ++iter ) {
        dfInfo &i = iter->second;

        if( !i.pathNames.empty() && !i.pathname.empty() ) {
            i.pathNames.push_back( i.pathname );
            i.pathname.clear();
        }

        if( settings->verbose ) {
            if( !i.pathname.empty() ) {
                printf( "%s:  %s\n", i.key().c_str(), i.pathname.c_str());
            } else {
                printf( "%s: MEAN of \n    ", i.key().c_str());

                for( std::list<Glib::ustring>::iterator iter = i.pathNames.begin(); iter != i.pathNames.end(); ++iter  ) {
                    printf( "%s, ", iter->c_str() );
                }

                printf("\n");
            }
        }
    }

    currentPath = pathname;
    return;
}

dfInfo* DFManager::addFileInfo (const Glib::ustring& filename, bool pool)
{
    auto ext = getFileExtension(filename);

    if (ext.empty() || !options.is_extention_enabled(ext)) {
        return nullptr;
    }

    auto file = Gio::File::create_for_path(filename);

    if (!file) {
        return nullptr;
    }

    if (!file->query_exists()) {
        return nullptr;
    }

    try {

        auto info = file->query_info("standard::name,standard::type,standard::is-hidden");

        if (!info && info->get_file_type() == Gio::FILE_TYPE_DIRECTORY) {
            return nullptr;
        }

        if (!options.fbShowHidden && info->is_hidden()) {
            return nullptr;
        }

        RawImage ri(filename);
        int res = ri.loadRaw(false); // Read information about shot

        if (res != 0) {
            return nullptr;
        }

        dfList_t::iterator iter;

        if(!pool) {
            dfInfo n(filename, "", "", 0, 0, 0);
            iter = dfList.emplace("", n);
            return &(iter->second);
        }

        FramesData idata(filename, std::unique_ptr<RawMetaDataLocation>(new RawMetaDataLocation(ri.get_exifBase(), ri.get_ciffBase(), ri.get_ciffLen())), true);
        /* Files are added in the map, divided by same maker/model,ISO and shutter*/
        std::string key(dfInfo::key(((Glib::ustring)idata.getMake()).uppercase(), ((Glib::ustring)idata.getModel()).uppercase(), idata.getISOSpeed(), idata.getShutterSpeed()));
        iter = dfList.find(key);

        if(iter == dfList.end()) {
            dfInfo n(filename, ((Glib::ustring)idata.getMake()).uppercase(), ((Glib::ustring)idata.getModel()).uppercase(), idata.getISOSpeed(), idata.getShutterSpeed(), idata.getDateTimeAsTS());
            iter = dfList.emplace(key, n);
        } else {
            while(iter != dfList.end() && iter->second.key() == key && ABS(iter->second.timestamp - idata.getDateTimeAsTS()) > 60 * 60 * 6) { // 6 hour difference
                ++iter;
            }

            if(iter != dfList.end()) {
                iter->second.pathNames.push_back(filename);
            } else {
                dfInfo n(filename, ((Glib::ustring)idata.getMake()).uppercase(), ((Glib::ustring)idata.getModel()).uppercase(), idata.getISOSpeed(), idata.getShutterSpeed(), idata.getDateTimeAsTS());
                iter = dfList.emplace(key, n);
            }
        }

        return &(iter->second);

    } catch(Gio::Error&) {}

    return nullptr;
}

void DFManager::getStat( int &totFiles, int &totTemplates)
{
    totFiles = 0;
    totTemplates = 0;

    for( dfList_t::iterator iter = dfList.begin(); iter != dfList.end(); ++iter ) {
        dfInfo &i = iter->second;

        if( i.pathname.empty() ) {
            totTemplates++;
            totFiles += i.pathNames.size();
        } else {
            totFiles++;
        }
    }
}

/*  The search for the best match is twofold:
 *  if perfect matches for iso and shutter are found, then the list is scanned for lesser distance in time
 *  otherwise if no match is found, the whole list is searched for lesser distance in iso and shutter
 */
dfInfo* DFManager::find( const std::string &mak, const std::string &mod, int isospeed, double shut, time_t t )
{
    if( dfList.empty() ) {
        return nullptr;
    }

    std::string key( dfInfo::key(mak, mod, isospeed, shut) );
    dfList_t::iterator iter = dfList.find( key );

    if(  iter != dfList.end() ) {
        dfList_t::iterator bestMatch = iter;
        time_t bestDeltaTime = ABS(iter->second.timestamp - t);

        for(++iter; iter != dfList.end() && !key.compare( iter->second.key() ); ++iter ) {
            time_t d = ABS(iter->second.timestamp - t );

            if( d < bestDeltaTime ) {
                bestMatch = iter;
                bestDeltaTime = d;
            }
        }

        return &(bestMatch->second);
    } else {
        iter = dfList.begin();
        dfList_t::iterator bestMatch = iter;
        double bestD = iter->second.distance(  mak, mod, isospeed, shut );

        for( ++iter; iter != dfList.end(); ++iter ) {
            double d = iter->second.distance(  mak, mod, isospeed, shut );

            if( d < bestD ) {
                bestD = d;
                bestMatch = iter;
            }
        }

        return bestD != INFINITY ? &(bestMatch->second) : nullptr ;
    }
}

RawImage* DFManager::searchDarkFrame( const std::string &mak, const std::string &mod, int iso, double shut, time_t t )
{
    dfInfo *df = find( ((Glib::ustring)mak).uppercase(), ((Glib::ustring)mod).uppercase(), iso, shut, t );

    if( df ) {
        return df->getRawImage();
    } else {
        return nullptr;
    }
}

RawImage* DFManager::searchDarkFrame( const Glib::ustring filename )
{
    for ( dfList_t::iterator iter = dfList.begin(); iter != dfList.end(); ++iter ) {
        if( iter->second.pathname.compare( filename ) == 0  ) {
            return iter->second.getRawImage();
        }
    }

    dfInfo *df = addFileInfo( filename, false );

    if(df) {
        return df->getRawImage();
    }

    return nullptr;
}
std::vector<badPix> *DFManager::getHotPixels ( const Glib::ustring filename )
{
    for ( dfList_t::iterator iter = dfList.begin(); iter != dfList.end(); ++iter ) {
        if( iter->second.pathname.compare( filename ) == 0  ) {
            return &iter->second.getHotPixels();
        }
    }

    return nullptr;
}
std::vector<badPix> *DFManager::getHotPixels ( const std::string &mak, const std::string &mod, int iso, double shut, time_t t )
{
    dfInfo *df = find( ((Glib::ustring)mak).uppercase(), ((Glib::ustring)mod).uppercase(), iso, shut, t );

    if( df ) {
        if( settings->verbose ) {
            if( !df->pathname.empty() ) {
                printf( "Searched hotpixels from %s\n", df->pathname.c_str());
            } else {
                if( !df->pathNames.empty() ) {
                    printf( "Searched hotpixels from template (first %s)\n", df->pathNames.begin()->c_str());
                }
            }
        }

        return &df->getHotPixels();
    } else {
        return nullptr;
    }
}

int DFManager::scanBadPixelsFile( Glib::ustring filename )
{
    FILE *file = fopen( filename.c_str(), "r" );

    if( !file ) {
        return false;
    }

    size_t lastdot = filename.find_last_of ('.');
    size_t dirpos1 = filename.find_last_of ('/');
    size_t dirpos2 = filename.find_last_of ('\\');

    if( dirpos1 == Glib::ustring::npos && dirpos2 == Glib::ustring::npos ) {
        dirpos1 = 0;
    } else if( dirpos1 != Glib::ustring::npos && dirpos2 != Glib::ustring::npos ) {
        dirpos1 = (dirpos1 > dirpos2 ? dirpos1 : dirpos2);
    } else if( dirpos1 == Glib::ustring::npos ) {
        dirpos1 = dirpos2;
    }

    std::string makmodel(filename, dirpos1 + 1, lastdot - (dirpos1 + 1) );
    std::vector<badPix> bp;
    char line[256];

    if(fgets(line, sizeof(line), file )) {
        int x, y;
        int offset = 0;
        int numparms = sscanf(line, "%d %d", &x, &y);

        if( numparms == 1 ) { // only one number in first line means, that this is the offset.
            offset = x;
        } else if(numparms == 2) {
            bp.push_back( badPix(x + offset, y + offset) );
        }

        while( fgets(line, sizeof(line), file ) ) {
            if( sscanf(line, "%d %d", &x, &y) == 2 ) {
                bp.push_back( badPix(x + offset, y + offset) );
            }
        }
    }

    int numPixels = bp.size();

    if( numPixels > 0 ) {
        bpList[ makmodel ] = bp;
    }

    fclose(file);
    return numPixels;
}

std::vector<badPix> *DFManager::getBadPixels ( const std::string &mak, const std::string &mod, const std::string &serial)
{
    bpList_t::iterator iter;
    bool found = false;

    if( !serial.empty() ) {
        // search with sreial number first
        std::ostringstream s;
        s << mak << " " << mod << " " << serial;
        iter = bpList.find( s.str() );

        if( iter != bpList.end() ) {
            found = true;
        }

        if( settings->verbose ) {
            if(found) {
                printf("%s.badpixels found\n", s.str().c_str());
            } else {
                printf("%s.badpixels not found\n", s.str().c_str());
            }
        }

    }

    if(!found) {
        // search without serial number
        std::ostringstream s;
        s << mak << " " << mod;
        iter = bpList.find( s.str() );

        if( iter != bpList.end() ) {
            found = true;
        }

        if( settings->verbose ) {
            if(found) {
                printf("%s.badpixels found\n", s.str().c_str());
            } else {
                printf("%s.badpixels not found\n", s.str().c_str());
            }
        }
    }

    if(!found) {
        return nullptr;
    } else {
        return &(iter->second);
    }
}

// Global variable
DFManager dfm;


}