dev_roi_request.h

Go to the documentation of this file.

/*
    This file is part of Ansel.
    Copyright (C) 2026 Aurélien Pierre.
 
    Ansel 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.
 
    Ansel 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 Ansel.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef DT_DEVELOP_DEV_ROI_REQUEST_H
#define DT_DEVELOP_DEV_ROI_REQUEST_H
 
#include <glib.h>
#include <math.h>
#include <stdint.h>
 
#include "system/atomic.h"
 
struct dt_develop_t;
struct dt_dev_pixelpipe_t;
 
typedef struct dt_dev_roi_request_t
{
  uint64_t generation;
 
  int32_t box_width, box_height;             
  int32_t processed_width, processed_height; 
  int32_t preview_width, preview_height;     
  float natural_scale;                       
  float scaling;                             
  float center_x, center_y;                  
  gboolean valid;
} dt_dev_roi_request_t;
 
typedef struct dt_dev_roi_request_store_t
{
  dt_atomic_uint64 generation;   
  dt_dev_roi_request_t value;
} dt_dev_roi_request_store_t;
 
static inline float dt_dev_roi_natural_scale(const int32_t box_width, const int32_t box_height,
                                             const int32_t processed_width,
                                             const int32_t processed_height)
{
  if(processed_width <= 0 || processed_height <= 0) return -1.f;
 
  return fminf(fminf((float)box_width / (float)processed_width,
                     (float)box_height / (float)processed_height),
               1.f);
}
 
dt_dev_roi_request_t dt_dev_roi_request_neutral(void);
 
void dt_dev_roi_request_init(struct dt_develop_t *dev);
 
uint64_t dt_dev_roi_request_publish(struct dt_develop_t *dev);
 
dt_dev_roi_request_t dt_dev_roi_request_get(const struct dt_develop_t *dev);
 
void dt_dev_roi_request_latch(struct dt_dev_pixelpipe_t *pipe, const dt_dev_roi_request_t *request);
 
dt_dev_roi_request_t dt_dev_roi_request_of_pipe(const struct dt_dev_pixelpipe_t *pipe);
 
/* Single-field readers, one line each. Use dt_dev_roi_request_get() wherever more than one is
 * needed: the whole point of the record is that its members are consumed as a product. */
int32_t dt_dev_roi_request_preview_width(const struct dt_develop_t *dev);
int32_t dt_dev_roi_request_preview_height(const struct dt_develop_t *dev);
float dt_dev_roi_request_natural_scale(const struct dt_develop_t *dev);
gboolean dt_dev_roi_request_valid(const struct dt_develop_t *dev);
 
#endif // DT_DEVELOP_DEV_ROI_REQUEST_H
 
// clang-format off
// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
// vim: shiftwidth=2 expandtab tabstop=2 cindent
// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
// clang-format on