worker.h

Go to the documentation of this file.

/*
    This file is part of the Ansel project.
    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_IOP_DRAWLAYER_WORKER_H
#define DT_IOP_DRAWLAYER_WORKER_H
 
#include "iop/iop_api.h"
#include "iop/drawlayer/common.h"    // dt_iop_drawlayer_params_t
#include "iop/drawlayer/paint.h"     // dt_drawlayer_patch_t
#include "develop/imageop.h"         // dt_iop_module_t
 
typedef struct dt_drawlayer_worker_t dt_drawlayer_worker_t;
typedef enum dt_drawlayer_worker_state_t
{
  DT_DRAWLAYER_WORKER_STATE_STOPPED = 0,
  DT_DRAWLAYER_WORKER_STATE_IDLE,
  DT_DRAWLAYER_WORKER_STATE_BUSY,
  DT_DRAWLAYER_WORKER_STATE_PAUSING,
  DT_DRAWLAYER_WORKER_STATE_PAUSED,
} dt_drawlayer_worker_state_t;
typedef struct dt_drawlayer_worker_snapshot_t
{
  dt_drawlayer_worker_state_t backend_state;
  guint backend_queue_count;
  gboolean commit_pending;
} dt_drawlayer_worker_snapshot_t;
 
void dt_drawlayer_worker_init(dt_iop_module_t *self,
                              dt_drawlayer_worker_t **worker,
                              gboolean *painting,
                              gboolean *finish_commit_pending,
                              guint *stroke_sample_count,
                              uint32_t *current_stroke_batch);
void dt_drawlayer_worker_cleanup(dt_drawlayer_worker_t **worker);
gboolean dt_drawlayer_worker_active(const dt_drawlayer_worker_t *worker);
gboolean dt_drawlayer_worker_any_active(const dt_drawlayer_worker_t *worker);
void dt_drawlayer_worker_get_snapshot(const dt_drawlayer_worker_t *worker,
                                      dt_drawlayer_worker_snapshot_t *snapshot);
void dt_drawlayer_worker_request_commit(dt_drawlayer_worker_t *worker);
void dt_drawlayer_worker_snapshot_params(dt_drawlayer_worker_t *worker,
                                         const dt_iop_drawlayer_params_t *params);
gboolean dt_drawlayer_worker_ensure_running(dt_iop_module_t *self, dt_drawlayer_worker_t *worker);
void dt_drawlayer_worker_stop(dt_iop_module_t *self, dt_drawlayer_worker_t *worker);
 
gboolean dt_drawlayer_worker_wait_idle(dt_iop_module_t *self, dt_drawlayer_worker_t *worker);
 
void dt_drawlayer_worker_pause(dt_iop_module_t *self, dt_drawlayer_worker_t *worker);
 
void dt_drawlayer_worker_resume(dt_iop_module_t *self, dt_drawlayer_worker_t *worker);
 
void dt_drawlayer_worker_cancel_async_commit(dt_drawlayer_worker_t *worker);
void dt_drawlayer_worker_seal_for_commit(dt_drawlayer_worker_t *worker);
void dt_drawlayer_worker_publish_backend_stroke_damage(dt_iop_module_t *self);
void dt_drawlayer_worker_reset_backend_path(dt_drawlayer_worker_t *worker);
void dt_drawlayer_worker_reset_live_publish(dt_drawlayer_worker_t *worker);
void dt_drawlayer_worker_reset_stroke(dt_drawlayer_worker_t *worker);
GArray *dt_drawlayer_worker_raw_inputs(dt_drawlayer_worker_t *worker);
 
gboolean dt_drawlayer_worker_enqueue_input(dt_drawlayer_worker_t *worker,
                                           const dt_drawlayer_paint_raw_input_t *input);
gboolean dt_drawlayer_worker_enqueue_stroke_end(dt_drawlayer_worker_t *worker,
                                                const dt_drawlayer_paint_raw_input_t *input);
#endif // DT_IOP_DRAWLAYER_WORKER_H