Skip to content

Commit

Permalink
Add ability to shift brightness with --delta flag (#43)
Browse files Browse the repository at this point in the history 
Implement the `--delta` flag functionality for the brightness parameter.

The use case of this change is to be able to easily increase and decrease
monitor brightness. For example, a key shortcut can be set to run
`xsct -d 0 0.1` for increasing the brightness by 0.1, or `xsct -d 0
-0.1` for decreasing the brightness by 0.1.

---------

Co-authored-by: Fabian Foerg <[email protected]>
  • Loading branch information
@j-silv @faf0
j-silv and faf0 authored Jan 20, 2024
1 parent eb78f4d commit b34723e
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 19 deletions.
16 changes: 15 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,25 @@ If `xsct` is called without parameters, the current display temperature and brig
The following options, which can be specified before the optional temperature parameter, are supported:
- `-h`, `--help`: display the help page
- `-v`, `--verbose`: display debugging information
- `-d <delta>`, `--delta <delta>`: shift temperature by the temperature value
- `-d <delta>`, `--delta <delta>`: temperature and brightness are shifted relatively and not absolutely
- `-s <screen>`, `--screen <screen>` `N`: use the screen specified by given zero-based index
- `-t`, `--toggle`: toggle between night and day temperature
- `-c <crtc>`, `--crtc <crtc>` `N`: use the CRTC specified by given zero-based index

Here are a few examples of how to control the brightness and the temperature using `xsct`:

| Command | Explanation |
|---------------------|-------------------------------------------------------------------------|
| `xsct` | Estimate the current display temperature and brightness |
| `xsct 0` | Set the temperature to `6500` and the brightness to `1.0` (default) |
| `xsct 3700 0.9` | Set the temperature to `3700` and the brightness to `0.9` |
| `xsct 3700` | Set the temperature to `3700` and the brightness to `1.0` (default) |
| `xsct -d 1000` | Increase the temperature by `1000` |
| `xsct -d -500` | Decrease the temperature by `500` |
| `xsct -d 1000 0.2` | Increase the temperature by `1000` and increase the brightness by `0.2` |
| `xsct -d -500 -0.3` | Decrease the temperature by `500` and decrease the brightness by `0.3` |
| `xsct -d 0 0.2` | Increase the brightness by `0.2` |

Test xsct using the following command:
~~~sh
xsct 3700 0.9 && xsct
Expand Down
56 changes: 39 additions & 17 deletions src/xsct.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ static void usage(const char *const pname)
"Options:\n"
"\t-h, --help \t xsct will display this usage information\n"
"\t-v, --verbose \t xsct will display debugging information\n"
"\t-d, --delta\t xsct will shift temperature by the temperature value\n"
"\t-d, --delta\t xsct will consider temperature and brightness parameters as relative shifts\n"
"\t-s, --screen N\t xsct will only select screen specified by given zero-based index\n"
"\t-t, --toggle \t xsct will toggle between 'day' and 'night' mode\n"
"\t-c, --crtc N\t xsct will only select CRTC specified by given zero-based index\n", XSCT_VERSION, pname);
Expand Down Expand Up @@ -156,6 +156,25 @@ static void sct_for_screen(Display *dpy, int screen, int icrtc, struct temp_stat
XFree(res);
}

static void bound_temp(struct temp_status *const temp)
{
if (temp->temp < TEMPERATURE_ZERO)
{
fprintf(stderr, "WARNING! Temperatures below %d cannot be displayed.\n", TEMPERATURE_ZERO);
temp->temp = TEMPERATURE_ZERO;
}
if (temp->brightness < 0.0)
{
fprintf(stderr, "WARNING! Brightness values below 0.0 cannot be displayed.\n");
temp->brightness = 0.0;
}
else if (temp->brightness > 1.0)
{
fprintf(stderr, "WARNING! Brightness values above 1.0 cannot be displayed.\n");
temp->brightness = 1.0;
}
}

int main(int argc, char **argv)
{
int i, screen, screens;
Expand All @@ -176,7 +195,7 @@ int main(int argc, char **argv)
screen_specified = -1;
crtc_specified = -1;
temp.temp = DELTA_MIN;
temp.brightness = -1.0;
temp.brightness = DELTA_MIN;
for (i = 1; i < argc; i++)
{
if ((strcmp(argv[i],"-h") == 0) || (strcmp(argv[i],"--help") == 0)) fhelp = 1;
Expand Down Expand Up @@ -206,7 +225,7 @@ int main(int argc, char **argv)
}
}
else if (temp.temp == DELTA_MIN) temp.temp = atoi(argv[i]);
else if (temp.brightness < 0.0) temp.brightness = atof(argv[i]);
else if (temp.brightness == DELTA_MIN) temp.brightness = atof(argv[i]);
else
{
fprintf(stderr, "ERROR! Unknown parameter: %s\n!", argv[i]);
Expand Down Expand Up @@ -242,13 +261,13 @@ int main(int argc, char **argv)
sct_for_screen(dpy, screen, crtc_specified, temp, fdebug);
}
}
if (temp.brightness < 0.0) temp.brightness = 1.0;
if ((temp.brightness == DELTA_MIN) && (fdelta == 0)) temp.brightness = 1.0;
if (screen_specified >= 0)
{
screen_first = screen_specified;
screen_last = screen_specified;
}
if ((temp.temp < 0) && (fdelta == 0))
if ((temp.temp == DELTA_MIN) && (fdelta == 0))
{
// No arguments, so print estimated temperature for each screen
for (screen = screen_first; screen <= screen_last; screen++)
Expand All @@ -266,29 +285,32 @@ int main(int argc, char **argv)
{
temp.temp = TEMPERATURE_NORM;
}
else if (temp.temp < TEMPERATURE_ZERO)
else
{
fprintf(stderr, "WARNING! Temperatures below %d cannot be displayed.\n", TEMPERATURE_ZERO);
temp.temp = TEMPERATURE_ZERO;
}
bound_temp(&temp);
}
for (screen = screen_first; screen <= screen_last; screen++)
{
sct_for_screen(dpy, screen, crtc_specified, temp, fdebug);
}
}
else
{
// Delta mode: Shift temperature of each screen by given value
for (screen = screen_first; screen <= screen_last; screen++)
// Delta mode: Shift temperature and optionally brightness of each screen by given value
if (temp.temp == DELTA_MIN)
{
fprintf(stderr, "ERROR! Required temperature value for delta not specified!\n");
}
else
{
struct temp_status tempd = get_sct_for_screen(dpy, screen, crtc_specified, fdebug);
tempd.temp += temp.temp;
if (tempd.temp < TEMPERATURE_ZERO)
for (screen = screen_first; screen <= screen_last; screen++)
{
fprintf(stderr, "WARNING! Temperatures below %d cannot be displayed.\n", TEMPERATURE_ZERO);
tempd.temp = TEMPERATURE_ZERO;
struct temp_status tempd = get_sct_for_screen(dpy, screen, crtc_specified, fdebug);
tempd.temp += temp.temp;
if (temp.brightness != DELTA_MIN) tempd.brightness += temp.brightness;
bound_temp(&tempd);
sct_for_screen(dpy, screen, crtc_specified, tempd, fdebug);
}
sct_for_screen(dpy, screen, crtc_specified, tempd, fdebug);
}
}
}
Expand Down
1 change: 1 addition & 0 deletions src/xsct.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,6 @@ static void usage(const char *const pname);
static double DoubleTrim(double x, double a, double b);
static struct temp_status get_sct_for_screen(Display *dpy, int screen, int icrtc, int fdebug);
static void sct_for_screen(Display *dpy, int screen, int icrtc, struct temp_status temp, int fdebug);
static void bound_temp(struct temp_status *const temp);

#endif /* __XSCT_H */
2 changes: 1 addition & 1 deletion xsct.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Display usage information and exit
Display debugging information
.TP
.B -d, --delta
Shift temperature by temperature value
Shift temperature and brightness by temperature and brightness value
.TP
.B -s, --screen N
Zero-based index of screen to use.
Expand Down

0 comments on commit b34723e

Please sign in to comment.