/* common.h -- Common header file for Redshift source files
   This file is part of Redshift.

   Redshift 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.

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

   Copyright (c) 2009-2017               Jon Lund Steffensen <jonlst@gmail.com>
   Copyright (c) 2014, 2015, 2016, 2025  Mattias Andrée <m@maandree.se>
*/
#ifndef REDSHIFT_COMMON_H
#define REDSHIFT_COMMON_H

#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#if !defined(__WIN32__)
# include <signal.h>
#endif


/* The color temperature when no adjustment is applied. */
#define NEUTRAL_TEMP  6500


/* Location */
typedef struct {
	float lat;
	float lon;
} location_t;

/* Periods of day. */
typedef enum {
	PERIOD_NONE = 0,
	PERIOD_DAYTIME,
	PERIOD_NIGHT,
	PERIOD_TRANSITION
} period_t;

/* Color setting */
typedef struct {
	int temperature;
	float gamma[3];
	float brightness;
} color_setting_t;

/* Program modes. */
typedef enum {
	PROGRAM_MODE_CONTINUAL,
	PROGRAM_MODE_ONE_SHOT,
	PROGRAM_MODE_PRINT,
	PROGRAM_MODE_RESET,
	PROGRAM_MODE_MANUAL
} program_mode_t;

/* Time range.
   Fields are offsets from midnight in seconds. */
typedef struct {
	int start;
	int end;
} time_range_t;

/* Transition scheme.
   The solar elevations at which the transition begins/ends,
   and the association color settings. */
typedef struct {
	double high;
	double low;
	int use_time; /* When enabled, ignore elevation and use time ranges. */
	time_range_t dawn;
	time_range_t dusk;
	color_setting_t day;
	color_setting_t night;
} transition_scheme_t;


/* Gamma adjustment method */
typedef struct gamma_state gamma_state_t;

typedef int gamma_method_init_func(gamma_state_t **state);
typedef int gamma_method_start_func(gamma_state_t *state, program_mode_t mode);
typedef void gamma_method_free_func(gamma_state_t *state);
typedef void gamma_method_print_help_func(FILE *f);
typedef int gamma_method_set_option_func(gamma_state_t *state, const char *key,
					 const char *value);
typedef void gamma_method_restore_func(gamma_state_t *state);
typedef int gamma_method_set_temperature_func(
	gamma_state_t *state, const color_setting_t *setting, int preserve);

typedef struct {
	char *name;

	/* If true, this method will be tried if none is explicitly chosen. */
	int autostart;

	/* Initialize state. Options can be set between init and start. */
	gamma_method_init_func *init;
	/* Allocate storage and make connections that depend on options. */
	gamma_method_start_func *start;
	/* Free all allocated storage and close connections. */
	gamma_method_free_func *free;

	/* Print help on options for this adjustment method. */
	gamma_method_print_help_func *print_help;
	/* Set an option key, value-pair */
	gamma_method_set_option_func *set_option;

	/* Restore the adjustment to the state before start was called. */
	gamma_method_restore_func *restore;
	/* Set a specific color temperature. */
	gamma_method_set_temperature_func *set_temperature;
} gamma_method_t;


/* Location provider */
typedef struct location_state location_state_t;

typedef int location_provider_init_func(location_state_t **state);
typedef int location_provider_start_func(location_state_t *state);
typedef void location_provider_free_func(location_state_t *state);
typedef void location_provider_print_help_func(FILE *f);
typedef int location_provider_set_option_func(
	location_state_t *state, const char *key, const char *value);
typedef int location_provider_get_fd_func(location_state_t *state);
typedef int location_provider_handle_func(
	location_state_t *state, location_t *location, int *available);

typedef struct {
	char *name;

	/* Initialize state. Options can be set between init and start. */
	location_provider_init_func *init;
	/* Allocate storage and make connections that depend on options. */
	location_provider_start_func *start;
	/* Free all allocated storage and close connections. */
	location_provider_free_func *free;

	/* Print help on options for this location provider. */
	location_provider_print_help_func *print_help;
	/* Set an option key, value-pair. */
	location_provider_set_option_func *set_option;

	/* Listen and handle location updates. */
	location_provider_get_fd_func *get_fd;
	location_provider_handle_func *handle;
} location_provider_t;


#define LIST_RAMPS_STOP_VALUE_TYPES\
	X(u8, uint8_t, UINT8_MAX + 1ULL, UINT8_MAX, 8)\
	X(u16, uint16_t, UINT16_MAX + 1ULL, UINT16_MAX, 16)\
	X(u32, uint32_t, UINT32_MAX + 1ULL, UINT32_MAX, 32)\
	X(u64, uint64_t, UINT64_MAX, UINT64_MAX, 64)\
	X(float, float, 1, 1, -1)\
	X(double, double, 1, 1, -2)

#define X(SUFFIX, TYPE, MAX, TRUE_MAX, DEPTH)\
	void colorramp_fill_##SUFFIX(TYPE *gamma_r, TYPE *gamma_g, TYPE *gamma_b,\
				     size_t size_r, size_t size_g, size_t size_b,\
				     const color_setting_t *setting);
LIST_RAMPS_STOP_VALUE_TYPES
#undef X


void hooks_signal_period_change(period_t prev_period,
				period_t period);


int pipeutils_create_nonblocking(int pipefds[2]);

void pipeutils_signal(int write_fd);
void pipeutils_handle_signal(int read_fd);


#if !defined(__WIN32__)
extern volatile sig_atomic_t exiting;
extern volatile sig_atomic_t disable;
#else
extern int exiting;
extern int disable;
#endif

int signals_install_handlers(void);


int systemtime_get_time(double *now);
void systemtime_msleep(unsigned int msecs);


extern const gamma_method_t dummy_gamma_method;

#ifdef ENABLE_COOPGAMMA
extern const gamma_method_t coopgamma_gamma_method;
#endif

#ifdef ENABLE_RANDR
extern const gamma_method_t randr_gamma_method;
#endif

#ifdef ENABLE_VIDMODE
extern const gamma_method_t vidmode_gamma_method;
#endif

#ifdef ENABLE_DRM
extern const gamma_method_t drm_gamma_method;
#endif

#ifdef ENABLE_QUARTZ
extern const gamma_method_t quartz_gamma_method;
#endif

#ifdef ENABLE_W32GDI
extern const gamma_method_t w32gdi_gamma_method;
#endif


extern const location_provider_t manual_location_provider;

#ifdef ENABLE_GEOCLUE2
extern const location_provider_t geoclue2_location_provider;
#endif

#ifdef ENABLE_CORELOCATION
extern const location_provider_t corelocation_location_provider;
#endif


#endif