xref: /dports/graphics/photoflow/PhotoFlow-8472024f/src/base/operation.cc

/*
 */

/*

    Copyright (C) 2014 Ferrero Andrea

    This program 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.

    This program 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 this program. If not, see <http://www.gnu.org/licenses/>.


 */

/*

    These files are distributed with PhotoFlow - http://aferrero2707.github.io/PhotoFlow/

 */

#include <lcms2.h>

#include "file_util.hh"
#include "operation.hh"
#include "layer.hh"
#include "../operations/image_to_map.hh"
//#include "../vips/vips_layer.h"

static int _phf_operation_serial_id = 0;

int
vips_layer( int n, VipsImage **out,
    PF::ProcessorBase* proc,
    VipsImage* imap, VipsImage* omap,
    VipsDemandStyle demand_hint,
    int width, int height, int nbands, int sid, ... );





void PF::OperationConfigUI::open()
{
  get_layer()->get_processor()->get_par()->save_properties(initial_params);
}




PF::OpParBase::OpParBase(): output_caching_enabled(false),
    render_mode(PF_RENDER_PREVIEW),
    map_flag( false ),
    editing_flag( false ),
    modified_flag(false),
    intensity("intensity",this,1),
    grey_target_channel("grey_target_channel",this,-1,"Grey","Grey"),
    rgb_target_channel("rgb_target_channel",this,-1,"RGB","RGB"),
    lab_target_channel("lab_target_channel",this,-1,"Lab","Lab"),
    cmyk_target_channel("cmyk_target_channel",this,-1,"CMYK","CMYK"),
    mask_enabled("mask_enabled",this,true),
    file_format_version( PF_FILE_VERSION ),
    enable_padding( "enable_padding", this, false ), test_padding(64)
{
  //blend_mode.set_internal(true);
  intensity.set_internal(true);
  //opacity.set_internal(true);
  grey_target_channel.set_internal(true);
  rgb_target_channel.set_internal(true);
  lab_target_channel.set_internal(true);
  cmyk_target_channel.set_internal(true);

  processor = NULL;
  //out = NULL;
  config_ui = NULL;
  //blend_mode = PF_BLEND_PASSTHROUGH;
  //blend_mode = PF_BLEND_NORMAL;
  //blend_mode.set_enum_value( PF_BLEND_PASSTHROUGH );
  demand_hint = VIPS_DEMAND_STYLE_ANY;
  bands = 1;
  xsize = 100; ysize = 100;

  rgb_target_channel.add_enum_value(0,"R","R");
  rgb_target_channel.add_enum_value(1,"G","G");
  rgb_target_channel.add_enum_value(2,"B","B");

  lab_target_channel.add_enum_value(0,"L","L");
  lab_target_channel.add_enum_value(1,"a","a");
  lab_target_channel.add_enum_value(2,"b","b");

  cmyk_target_channel.add_enum_value(0,"C","C");
  cmyk_target_channel.add_enum_value(1,"M","M");
  cmyk_target_channel.add_enum_value(2,"Y","Y");
  cmyk_target_channel.add_enum_value(3,"K","K");

  to_map = NULL;

  //PF::PropertyBase* prop;
  //prop = new PF::Property<float>("intensity",&intensity);
}



PF::OpParBase::~OpParBase()
{
  //for(unsigned int i = 0; i < outvec.size(); i++ ) {
  //  PF_UNREF( outvec[i], "~OpParBase(): previous outputs unref" );
  //}
  //#ifndef NDEBUG
  //std::cout<<"~OpParBase(): deleting operation "<<(void*)this<<" ("<<get_type()<<")"<<std::endl;
  //#endif
}



PF::PropertyBase* PF::OpParBase::get_property(std::string name)
{
  std::list<PropertyBase*>::iterator pi;

  // Look into mapped properties first
  for(pi = mapped_properties.begin(); pi != mapped_properties.end(); pi++) {
    //std::cout<<"(*pi)->get_name(): "<<(*pi)->get_name()<<"    name: "<<name<<std::endl;
    if( (*pi)->get_name() == name ) return( *pi );
  }

  // If nothing is found, look into our own properties
  for(pi = properties.begin(); pi != properties.end(); pi++) {
    //std::cout<<"(*pi)->get_name(): "<<(*pi)->get_name()<<"    name: "<<name<<std::endl;
    if( (*pi)->get_name() == name ) return( *pi );
  }
  return NULL;
}


void PF::OpParBase::save_properties(std::list<std::string>& plist)
{
  std::list<PropertyBase*>::iterator pi;
  for(pi = mapped_properties.begin(); pi != mapped_properties.end(); pi++) {
    std::string str = (*pi)->get_str();
    plist.push_back(str);
  }
  for(pi = properties.begin(); pi != properties.end(); pi++) {
    std::string str = (*pi)->get_str();
    plist.push_back(str);
  }
}


void PF::OpParBase::restore_properties(const std::list<std::string>& plist)
{
  std::list<PropertyBase*>::iterator pi;
  std::list<std::string>::const_iterator si;
  for(pi = mapped_properties.begin(), si = plist.begin();
      (pi != mapped_properties.end()) && (si != plist.end());
      pi++, si++) {
    (*pi)->set_str(*si);
  }
  for(pi = properties.begin();
      (pi != properties.end()) && (si != plist.end());
      pi++, si++) {
    (*pi)->set_str(*si);
  }
}


void PF::OpParBase::compute_padding( VipsImage* full_res, unsigned int id, unsigned int level )
{
  int p = enable_padding.get() ? test_padding : 0;
  set_padding( p, id );
}


void PF::OpParBase::modified()
{
  //std::cout<<"OpParBase::modified() called for "<<type<<std::endl;
  set_modified();
  //std::cout<<"OpParBase::modified(): emitting signal_modified."<<std::endl;
  signal_modified.emit();
  //std::cout<<"OpParBase::modified(): signal_modified emitted."<<std::endl;
}


void PF::OpParBase::clear_modified()
{
  modified_flag = false;
  std::list<PropertyBase*>::iterator pi;
  for(pi = mapped_properties.begin();
      pi != mapped_properties.end();
      pi++) {
    (*pi)->clear_modified();
  }
  for(pi = properties.begin();
      pi != properties.end();
      pi++) {
    (*pi)->clear_modified();
  }
}

void PF::OpParBase::set_image_hints(int w, int h, VipsInterpretation interpr)
{
  xsize = w;
  ysize = h;
  coding = VIPS_CODING_NONE;
  interpretation = interpr;
}



void PF::OpParBase::set_image_hints(int w, int h, colorspace_t cs)
{
  xsize = w;
  ysize = h;
  coding = VIPS_CODING_NONE;
  switch(cs) {
  case PF_COLORSPACE_GRAYSCALE:
    interpretation = VIPS_INTERPRETATION_B_W; break;
  case PF_COLORSPACE_RGB:
    interpretation = VIPS_INTERPRETATION_RGB; break;
  case PF_COLORSPACE_LAB:
    interpretation = VIPS_INTERPRETATION_LAB; break;
  case PF_COLORSPACE_CMYK:
    interpretation = VIPS_INTERPRETATION_CMYK; break;
  default:
    interpretation = VIPS_INTERPRETATION_MULTIBAND; break;
  }
}


bool PF::OpParBase::import_settings( OpParBase* pin )
{
  if( !pin ) {
    std::cout<<"OpParBase::import_settings(): pin = NULL"<<std::endl;
    return false;
  }

  std::list<PropertyBase*>& propin = pin->get_properties();
  std::list<PropertyBase*>::iterator pi=propin.begin(), pj=properties.begin();
  for( ; pi != propin.end(); pi++, pj++ ) {
    if( !(*pj)->import( *pi ) ) {
      std::cout<<"OpParBase::import_settings(): failed to import values for property \""<<(*pj)->get_name()<<"\""<<std::endl;
      return false;
    }
    //std::cout<<"OpParBase::import_settings(): property \""<<(*pj)->get_name()<<"\" se to "<<(*pj)->get_str()<<std::endl;
  }

  std::list<PropertyBase*>& mpropin = pin->get_mapped_properties();
  std::list<PropertyBase*>::iterator mpi=mpropin.begin(), mpj=mapped_properties.begin();
  for( ; mpi != mpropin.end(); mpi++, mpj++ ) {
    if( !(*mpj)->import( *mpi ) ) {
      std::cout<<"OpParBase::import_settings(): failed to import values for property \""<<(*mpj)->get_name()<<"\""<<std::endl;
      return false;
    }
  }

  // update properties of sub-operations
  propagate_settings();

  set_map_flag( pin->is_map() );
  //std::cout<<"OpParBase["<<get_type()<<"]::import_settings(): set_editing_flag("<<pin->is_editing()<<")"<<std::endl;
  set_editing_flag( pin->is_editing() );
  //set_demand_hint( pin->get_demand_hint() );
  //set_image_hints( pin->get_xsize(), pin->get_ysize(),
  //	   pin->get_interpretation() );
  //set_nbands( pin->get_nbands() );
  //set_coding( pin->get_coding() );
  //set_format( pin->get_format() );
  return true;
}


VipsImage* PF::OpParBase::build(std::vector<VipsImage*>& in, int first,
    VipsImage* imap, VipsImage* omap, unsigned int& level)
{
  VipsImage* outnew = NULL;
  VipsImage* invec[100];
  unsigned int n = 0;
  for(unsigned int i = 0; i < in.size(); i++) {
    if( !in[i] ) continue;
    invec[n] = in[i];
    n++;
  }
  if(n > 100) n = 100;
#ifndef NDEBUG
  //std::cout<<"OpParBase::build("<<get_type()<<"): size = "<<get_xsize()<<"x"<<get_ysize()<<std::endl;
  std::cout<<"OpParBase::build("<<get_type()<<"): in.size()="<<in.size()<<"  n="<<n<<std::endl;
#endif
  if( _phf_operation_serial_id == 0xFFFFFFF ) _phf_operation_serial_id = 0;
  else _phf_operation_serial_id += 1;
  switch( n ) {
  case 0:
    vips_layer( n, &outnew, processor, imap, omap,
        get_demand_hint(), get_xsize(), get_ysize(), get_nbands(), _phf_operation_serial_id,
        NULL );
    break;
  case 1:
    vips_layer( n, &outnew, processor, imap, omap,
        get_demand_hint(), get_xsize(), get_ysize(), get_nbands(), _phf_operation_serial_id,
        "in0", invec[0], NULL );
    break;
  case 2:
    vips_layer( n, &outnew, processor, imap, omap,
        get_demand_hint(), get_xsize(), get_ysize(), get_nbands(), _phf_operation_serial_id,
        "in0", invec[0], "in1", invec[1], NULL );
    break;
  case 3:
    vips_layer( n, &outnew, processor, imap, omap,
        get_demand_hint(), get_xsize(), get_ysize(), get_nbands(), _phf_operation_serial_id,
        "in0", invec[0], "in1", invec[1],
        "in2", invec[2], NULL );
    break;
  case 4:
    vips_layer( n, &outnew, processor, imap, omap,
        get_demand_hint(), get_xsize(), get_ysize(), get_nbands(), _phf_operation_serial_id,
        "in0", invec[0], "in1", invec[1],
        "in2", invec[2], "in3", invec[3], NULL );
    break;
  default:
    break;
  }

#ifndef NDEBUG
  std::cout<<"OpParBase::build(): type="<<type<<"  format="<<get_format()<<std::endl
      <<"input images:"<<std::endl;
  for(int i = 0; i < n; i++) {
    std::cout<<"  "<<(void*)invec[i]<<"   ref_count="<<G_OBJECT( invec[i] )->ref_count<<std::endl;
  }
  std::cout<<"imap: "<<(void*)imap<<std::endl<<"omap: "<<(void*)omap<<std::endl;
  std::cout<<"out: "<<(void*)outnew<<std::endl<<std::endl;
#endif

  //set_image( outnew );
#ifndef NDEBUG
  std::cout<<"OpParBase::build(): outnew refcount ("<<(void*)outnew<<") = "<<G_OBJECT(outnew)->ref_count<<std::endl;
#endif
  return outnew;
}



std::vector<VipsImage*> PF::OpParBase::build_many(std::vector<VipsImage*>& in, int first,
    VipsImage* imap, VipsImage* omap, unsigned int& level)
{
  std::vector<VipsImage*> result;
  VipsImage* out = build( in, first, imap, omap, level );
  //std::cout<<"OpParBase::build_many(): padding="<<get_padding()<<std::endl;

  VipsImage* cached = out;
  /*
  if( out && false && needs_caching() ) {
    int tw = 64, th = 64;
    // reserve two complete rows of tiles
    int nt = out->Xsize*2/tw;
    VipsAccess acc = VIPS_ACCESS_RANDOM;
    int threaded = 1, persistent = 0;

    if( vips_tilecache(out, &cached,
        "tile_width", tw, "tile_height", th, "max_tiles", nt,
        "access", acc, "threaded", threaded, "persistent", persistent, NULL) ) {
      std::cout<<"GaussBlurPar::build(): vips_tilecache() failed."<<std::endl;
      return result;
    }
    PF_UNREF( out, "OpParBase::build_many(): out unref" );
  }
   */
  result.push_back( cached );
  return result;
}


std::vector<VipsImage*> PF::OpParBase::build_many_internal(std::vector<VipsImage*>& in, int first,
    VipsImage* imap, VipsImage* omap, unsigned int& level)
{
  std::vector<VipsImage*> in_temp;

  if( true && convert_inputs_on_map_build() && is_map() && interpretation == VIPS_INTERPRETATION_B_W ) {
    if( !to_map ) to_map = new_image_to_map();
    std::vector<VipsImage*> in_temp2;
    std::vector<VipsImage*>* in_ptr = in_temp.empty() ? &in : &in_temp;
    for(unsigned int i = 0; i < in_ptr->size(); i++) {
      VipsImage* img = (*in_ptr)[i];
      if( img == NULL || img->Type == interpretation ) {
        in_temp2.push_back(img);
        std::cout<<"OpParBase::build_many_internal: op_type="<<get_type()<<"  in_temp2.push_back("<<img<<")"<<std::endl;
        PF_REF( img, "build_many_internal: img ref" );
      } else {
        std::vector<VipsImage*> in2; in2.push_back(img);
        std::cout<<"OpParBase::build_many_internal: to_map="<<to_map<<std::endl;
        PF::OpParBase* to_map_op = to_map->get_par();
        to_map_op->set_format(get_format());
        //to_map_op->set_image_hints(img);
        //to_map_op->grayscale_image( img->Xsize, img->Ysize );
        VipsImage* bwimg = to_map_op->build(in2, 0, NULL, NULL, level);
        std::cout<<"OpParBase::build_many_internal: bwimg built"<<std::endl;
        in_temp2.push_back(bwimg);
        //PF_UNREF( img, "build_many_internal: img unref" );
      }
    }
    in_temp = in_temp2;
  }

  std::vector<VipsImage*> result;
  if( in_temp.empty() )
    result = build_many( in, first, imap, omap, level );
  else
    result = build_many( in_temp, first, imap, omap, level );

#ifndef NDEBUG
  std::cout<<"OpParBase::build_many_internal(): filling hierarchy with padding "<<get_padding()<<std::endl;
#endif
  if( in_temp.empty() )
    fill_image_hierarchy( in, imap, omap, result );
  else
    fill_image_hierarchy( in_temp, imap, omap, result );

  // add output caching if needed
  if( output_caching_enabled ) {

    std::vector<VipsImage*> result_cached;
    for( unsigned int i = 0; i < result.size(); i++ ) {
      bool is_dup = false;
      VipsImage* out = result[i];
      for( unsigned int j = 0; j < in.size(); j++ ) {
        if( out == in[j] ) {
          is_dup = true;
          break;
        }
      }
      if( is_dup ) {
        result_cached.push_back( out );
        continue;
      }

      int p = get_output_padding( i );
      if( p > 32 || needs_caching() ) {
        VipsAccess acc = VIPS_ACCESS_RANDOM;
        int threaded = 1, persistent = 1;
        VipsImage* cached;
        std::cout<<"OpParBase::build_many_internal(): adding tilecache for output image #"
            <<i<<", padding="<<p<<std::endl;
        if( !phf_tilecache(out, &cached,
            "access", acc, "threaded", threaded,
            "persistent", persistent, NULL) ) {
          result_cached.push_back( cached );
          PF_UNREF( out, "OpParBase::build_many_internal(): out unref" );
          std::cout<<"OpParBase::build_many_internal(): added tilecache for output image #"
              <<i<<", padding="<<p<<std::endl;
        } else {
          std::cout<<"OpParBase::build_many_internal(): phf_tilecache() failed."<<std::endl;
          result_cached.push_back( out );
        }
      } else {
        result_cached.push_back( out );
      }
    }
    result = result_cached;
  }

  if( true && convert_inputs_on_map_build() && is_map() && interpretation == VIPS_INTERPRETATION_B_W ) {
    std::vector<VipsImage*>* in_ptr = in_temp.empty() ? &in : &in_temp;
    for(unsigned int i = 0; i < in_ptr->size(); i++) {
      VipsImage* img = (*in_ptr)[i];
      PF_UNREF( img, "build_many_internal: img unref" );
      std::cout<<"OpParBase::build_many_internal: op_type="<<get_type()<<"  "<<img<<" unref"<<std::endl;
    }
  }

  //for(unsigned int i = 0; i < outvec.size(); i++ ) {
  //  PF_UNREF( outvec[i], "OpParBase::build_many_internal(): previous outputs unref" );
  //}
  //outvec = result;

  return result;
}


void PF::OpParBase::fill_image_hierarchy(std::vector<VipsImage*>& in,
    VipsImage* imap, VipsImage* omap, std::vector<VipsImage*>& out)
{
  for( unsigned int i = 0; i < out.size(); i++ ) {
    bool is_dup = false;
    for( unsigned int j = 0; j < in.size(); j++ ) {
      if( out[i] == in[j] ) {
        is_dup = true;
        break;
      }
    }
    if( is_dup ) continue;

#ifndef NDEBUG
    if( get_padding() > 0 ) {
      std::cout<<"OpParBase::fill_image_hierarchy(): filling hierarchy for image "<<i<<"("<<out[i]<<") with padding "<<get_padding()<<std::endl;
    }
#endif
    PF::image_hierarchy_fill( out[i], get_padding(), in );
    std::vector<VipsImage*> maps;
    if( imap ) maps.push_back(imap);
    if( omap ) maps.push_back(omap);
    if( !maps.empty() ) PF::image_hierarchy_fill( out[i], 0, maps );
  }
}


bool PF::OpParBase::save( std::ostream& ostr, int level )
{
  for(int i = 0; i < level; i++) ostr<<"  ";
  ostr<<"<operation type=\""<<get_type()<<"\">"<<std::endl;

  for( std::list<PropertyBase*>::iterator pi = properties.begin();
      pi != properties.end(); pi++ ) {
    if( (*pi)->is_persistent() == false ) continue;
    std::string pvalue = (*pi)->get_str();
    for(int i = 0; i < level+1; i++) ostr<<"  ";
    ostr<<"<property name=\""<<(*pi)->get_name()<<"\" value=\"";
    //(*pi)->to_stream( ostr );
    ostr<<PF::pf_escape_xml(pvalue);
    ostr<<"\">"<<std::endl;
    for(int i = 0; i < level+1; i++) ostr<<"  ";
    ostr<<"</property>"<<std::endl;
  }

  for( std::list<PropertyBase*>::iterator pi = mapped_properties.begin();
      pi != mapped_properties.end(); pi++ ) {
    if( (*pi)->is_persistent() == false ) continue;
    std::string pvalue = (*pi)->get_str();
    for(int i = 0; i < level+1; i++) ostr<<"  ";
    ostr<<"<property name=\""<<(*pi)->get_name()<<"\" value=\"";
    //(*pi)->to_stream( ostr );
    ostr<<PF::pf_escape_xml(pvalue);
    ostr<<"\">"<<std::endl;
    for(int i = 0; i < level+1; i++) ostr<<"  ";
    ostr<<"</property>"<<std::endl;
  }

  for(int i = 0; i < level; i++) ostr<<"  ";
  ostr<<"</operation>"<<std::endl;

  return true;
}


int PF::vips_copy_metadata( VipsImage* in, VipsImage* out )
{
  if( !out ) return 0;
  int Xsize = out->Xsize;
  int Ysize = out->Ysize;
  int bands = out->Bands;
  VipsBandFormat fmt = out->BandFmt;
  VipsCoding coding = out->Coding;
  VipsInterpretation type = out->Type;
  gdouble xres = out->Xres;
  gdouble yres = out->Yres;
  VipsImage* invec[2] = {in, NULL};
  vips__image_copy_fields_array( out, invec );
  vips_image_init_fields( out,
      Xsize, Ysize, bands, fmt,
      coding, type, xres, yres
  );
  return 0;
}



void PF::print_embedded_profile( VipsImage* image )
{
  PF::ICCProfile* icc_data = PF::get_icc_profile( image );
  if(icc_data) {
    cmsHPROFILE in_profile = icc_data->get_profile();
    if( in_profile ) {
      char tstr[1024];
      cmsGetProfileInfoASCII(in_profile, cmsInfoDescription, "en", "US", tstr, 1024);
      std::cout<<"\""<<tstr<<"\", ";
      //cmsCloseProfile( in_profile );
      //return;
    //} else {
    //  std::cout<<"Cannot open profile from memory."<<std::endl;
    }
  }

  void *data;
  size_t data_length;
  if( !PF_VIPS_IMAGE_GET_BLOB( image, VIPS_META_ICC_NAME, &data, &data_length ) ) {
    cmsHPROFILE in_profile = cmsOpenProfileFromMem( data, data_length );
    if( in_profile ) {
      char tstr[1024];
      cmsGetProfileInfoASCII(in_profile, cmsInfoDescription, "en", "US", tstr, 1024);
      std::cout<<"\""<<tstr<<"\""<<std::endl;
      cmsCloseProfile( in_profile );
      return;
    }
    std::cout<<"Cannot open profile from memory."<<std::endl;
  }
  std::cout<<"Embedded ICC profile not found."<<std::endl;
}




float PF::vivid_light_f(float nbottom, float ntop)
{
  //nbottom = 50.0f/255.0f;
  //ntop = 200.0f/255.0f;
  float nvivid;
  if( ntop <= 0.5 )
    nvivid = PF::color_burn( nbottom, ntop*2.0f );
  else
    nvivid = PF::color_dodge( nbottom, ntop*2.0f-1.0f );

  //std::cout<<"vivid_light=("<<nbottom*255<<","<<ntop*255<<")="<<nvivid*255.0f<<std::endl;
  return nvivid;
}