… | |
… | |
4 | #:META:X_RESOURCE:%.border:boolean:respect the terminal border |
4 | #:META:X_RESOURCE:%.border:boolean:respect the terminal border |
5 | #:META:X_RESOURCE:%.interval:seconds:minimum time between updates |
5 | #:META:X_RESOURCE:%.interval:seconds:minimum time between updates |
6 | |
6 | |
7 | =head1 NAME |
7 | =head1 NAME |
8 | |
8 | |
9 | background - manage terminal background |
9 | background - manage terminal background |
10 | |
10 | |
11 | =head1 SYNOPSIS |
11 | =head1 SYNOPSIS |
12 | |
12 | |
13 | urxvt --background-expr 'background expression' |
13 | urxvt --background-expr 'background expression' |
14 | --background-border |
14 | --background-border |
15 | --background-interval seconds |
15 | --background-interval seconds |
16 | |
16 | |
|
|
17 | =head1 QUICK AND DIRTY CHEAT SHEET |
|
|
18 | |
|
|
19 | Just load a random jpeg image and tile the background with it without |
|
|
20 | scaling or anything else: |
|
|
21 | |
|
|
22 | load "/path/to/img.jpg" |
|
|
23 | |
|
|
24 | The same, but use mirroring/reflection instead of tiling: |
|
|
25 | |
|
|
26 | mirror load "/path/to/img.jpg" |
|
|
27 | |
|
|
28 | Load an image and scale it to exactly fill the terminal window: |
|
|
29 | |
|
|
30 | scale keep { load "/path/to/img.jpg" } |
|
|
31 | |
|
|
32 | Implement pseudo-transparency by using a suitably-aligned root pixmap |
|
|
33 | as window background: |
|
|
34 | |
|
|
35 | rootalign root |
|
|
36 | |
|
|
37 | Likewise, but keep a blurred copy: |
|
|
38 | |
|
|
39 | rootalign keep { blur 10, root } |
|
|
40 | |
17 | =head1 DESCRIPTION |
41 | =head1 DESCRIPTION |
18 | |
42 | |
19 | This extension manages the terminal background by creating a picture that |
43 | This extension manages the terminal background by creating a picture that |
20 | is behind the text, replacing the normal background colour. |
44 | is behind the text, replacing the normal background colour. |
21 | |
45 | |
… | |
… | |
26 | to be as simple as possible. |
50 | to be as simple as possible. |
27 | |
51 | |
28 | For example, to load an image and scale it to the window size, you would |
52 | For example, to load an image and scale it to the window size, you would |
29 | use: |
53 | use: |
30 | |
54 | |
31 | urxvt --background-expr 'scale load "/path/to/mybg.png"' |
55 | urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }' |
32 | |
56 | |
33 | Or specified as a X resource: |
57 | Or specified as a X resource: |
34 | |
58 | |
35 | URxvt.background-expr: scale load "/path/to/mybg.png" |
59 | URxvt.background-expr: scale keep { load "/path/to/mybg.png" } |
36 | |
60 | |
37 | =head1 THEORY OF OPERATION |
61 | =head1 THEORY OF OPERATION |
38 | |
62 | |
39 | At startup, just before the window is mapped for the first time, the |
63 | At startup, just before the window is mapped for the first time, the |
40 | expression is evaluated and must yield an image. The image is then |
64 | expression is evaluated and must yield an image. The image is then |
… | |
… | |
53 | If any of the parameters that the expression relies on changes (when the |
77 | If any of the parameters that the expression relies on changes (when the |
54 | window is moved or resized, its position or size changes; when the root |
78 | window is moved or resized, its position or size changes; when the root |
55 | pixmap is replaced by another one the root background changes; or when the |
79 | pixmap is replaced by another one the root background changes; or when the |
56 | timer elapses), then the expression will be evaluated again. |
80 | timer elapses), then the expression will be evaluated again. |
57 | |
81 | |
58 | For example, an expression such as C<scale load "$HOME/mybg.png"> scales the |
82 | For example, an expression such as C<scale keep { load "$HOME/mybg.png" |
59 | image to the window size, so it relies on the window size and will |
83 | }> scales the image to the window size, so it relies on the window size |
60 | be reevaluated each time it is changed, but not when it moves for |
84 | and will be reevaluated each time it is changed, but not when it moves for |
61 | example. That ensures that the picture always fills the terminal, even |
85 | example. That ensures that the picture always fills the terminal, even |
62 | after its size changes. |
86 | after its size changes. |
63 | |
87 | |
64 | =head2 EXPRESSIONS |
88 | =head2 EXPRESSIONS |
65 | |
89 | |
66 | Expressions are normal Perl expressions, in fact, they are Perl blocks - |
90 | Expressions are normal Perl expressions, in fact, they are Perl blocks - |
67 | which means you could use multiple lines and statements: |
91 | which means you could use multiple lines and statements: |
68 | |
92 | |
|
|
93 | scale keep { |
69 | again 3600; |
94 | again 3600; |
70 | if (localtime now)[6]) { |
95 | if (localtime now)[6]) { |
71 | return scale load "$HOME/weekday.png"; |
96 | return load "$HOME/weekday.png"; |
72 | } else { |
97 | } else { |
73 | return scale load "$HOME/sunday.png"; |
98 | return load "$HOME/sunday.png"; |
|
|
99 | } |
74 | } |
100 | } |
75 | |
101 | |
76 | This expression is evaluated once per hour. It will set F<sunday.png> as |
102 | This inner expression is evaluated once per hour (and whenever the |
|
|
103 | terminal window is resized). It sets F<sunday.png> as background on |
77 | background on Sundays, and F<weekday.png> on all other days. |
104 | Sundays, and F<weekday.png> on all other days. |
78 | |
105 | |
79 | Fortunately, we expect that most expressions will be much simpler, with |
106 | Fortunately, we expect that most expressions will be much simpler, with |
80 | little Perl knowledge needed. |
107 | little Perl knowledge needed. |
81 | |
108 | |
82 | Basically, you always start with a function that "generates" an image |
109 | Basically, you always start with a function that "generates" an image |
… | |
… | |
115 | horizontal and vertical dimensions. For example, this halves the image |
142 | horizontal and vertical dimensions. For example, this halves the image |
116 | width and doubles the image height: |
143 | width and doubles the image height: |
117 | |
144 | |
118 | scale 0.5, 2, load "$HOME/mypic.png" |
145 | scale 0.5, 2, load "$HOME/mypic.png" |
119 | |
146 | |
120 | Other effects than scaling are also readily available, for example, you can |
147 | IF you try out these expressions, you might suffer from some sluggishness, |
121 | tile the image to fill the whole window, instead of resizing it: |
148 | because each time the terminal is resized, it loads the PNG image again |
|
|
149 | and scales it. Scaling is usually fast (and unavoidable), but loading the |
|
|
150 | image can be quite time consuming. This is where C<keep> comes in handy: |
122 | |
151 | |
|
|
152 | scale 0.5, 2, keep { load "$HOME/mypic.png" } |
|
|
153 | |
|
|
154 | The C<keep> operator executes all the statements inside the braces only |
|
|
155 | once, or when it thinks the outcome might change. In other cases it |
|
|
156 | returns the last value computed by the brace block. |
|
|
157 | |
|
|
158 | This means that the C<load> is only executed once, which makes it much |
|
|
159 | faster, but also means that more memory is being used, because the loaded |
|
|
160 | image must be kept in memory at all times. In this expression, the |
|
|
161 | trade-off is likely worth it. |
|
|
162 | |
|
|
163 | But back to effects: Other effects than scaling are also readily |
|
|
164 | available, for example, you can tile the image to fill the whole window, |
|
|
165 | instead of resizing it: |
|
|
166 | |
123 | tile load "$HOME/mypic.png" |
167 | tile keep { load "$HOME/mypic.png" } |
124 | |
168 | |
125 | In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator |
169 | In fact, images returned by C<load> are in C<tile> mode by default, so the |
126 | is kind of superfluous. |
170 | C<tile> operator is kind of superfluous. |
127 | |
171 | |
128 | Another common effect is to mirror the image, so that the same edges touch: |
172 | Another common effect is to mirror the image, so that the same edges |
|
|
173 | touch: |
129 | |
174 | |
130 | mirror load "$HOME/mypic.png" |
175 | mirror keep { load "$HOME/mypic.png" } |
131 | |
176 | |
132 | This is also a typical background expression: |
177 | Another common background expression is: |
133 | |
178 | |
134 | rootalign root |
179 | rootalign root |
135 | |
180 | |
136 | It first takes a snapshot of the screen background image, and then |
181 | This one first takes a snapshot of the screen background image, and then |
137 | moves it to the upper left corner of the screen - the result is |
182 | moves it to the upper left corner of the screen (as opposed to the upper |
138 | pseudo-transparency, as the image seems to be static while the window is |
183 | left corner of the terminal window)- the result is pseudo-transparency: |
139 | moved around. |
184 | the image seems to be static while the window is moved around. |
140 | |
185 | |
141 | =head2 CYCLES AND CACHING |
186 | =head2 COLOUR SPECIFICATIONS |
142 | |
187 | |
143 | As has been mentioned before, the expression might be evaluated multiple |
188 | Whenever an operator expects a "colour", then this can be specified in one |
144 | times. Each time the expression is reevaluated, a new cycle is said to |
189 | of two ways: Either as string with an X11 colour specification, such as: |
145 | have begun. Many operators cache their results till the next cycle. |
|
|
146 | |
190 | |
147 | For example, the C<load> operator keeps a copy of the image. If it is |
191 | "red" # named colour |
148 | asked to load the same image on the next cycle it will not load it again, |
192 | "#f00" # simple rgb |
149 | but return the cached copy. |
193 | "[50]red" # red with 50% alpha |
|
|
194 | "TekHVC:300/50/50" # anything goes |
150 | |
195 | |
151 | This only works for one cycle though, so as long as you load the same |
196 | OR as an array reference with one, three or four components: |
152 | image every time, it will always be cached, but when you load a different |
|
|
153 | image, it will forget about the first one. |
|
|
154 | |
197 | |
155 | This allows you to either speed things up by keeping multiple images in |
198 | [0.5] # 50% gray, 100% alpha |
156 | memory, or conserve memory by loading images more often. |
199 | [0.5, 0, 0] # dark red, no green or blur, 100% alpha |
|
|
200 | [0.5, 0, 0, 0.7] # same with explicit 70% alpha |
157 | |
201 | |
158 | For example, you can keep two images in memory and use a random one like |
202 | =head2 CACHING AND SENSITIVITY |
159 | this: |
|
|
160 | |
203 | |
161 | my $img1 = load "img1.png"; |
204 | Since some operations (such as C<load> and C<blur>) can take a long time, |
162 | my $img2 = load "img2.png"; |
205 | caching results can be very important for a smooth operation. Caching can |
163 | (0.5 > rand) ? $img1 : $img2 |
206 | also be useful to reduce memory usage, though, for example, when an image |
|
|
207 | is cached by C<load>, it could be shared by multiple terminal windows |
|
|
208 | running inside urxvtd. |
164 | |
209 | |
165 | Since both images are "loaded" every time the expression is evaluated, |
210 | =head3 C<keep { ... }> caching |
166 | they are always kept in memory. Contrast this version: |
|
|
167 | |
211 | |
168 | my $path1 = "img1.png"; |
212 | The most important way to cache expensive operations is to use C<keep { |
169 | my $path2 = "img2.png"; |
213 | ... }>. The C<keep> operator takes a block of multiple statements enclosed |
170 | load ((0.5 > rand) ? $path1 : $path2) |
214 | by C<{}> and keeps the return value in memory. |
171 | |
215 | |
172 | Here, a path is selected randomly, and load is only called for one image, |
216 | An expression can be "sensitive" to various external events, such as |
173 | so keeps only one image in memory. If, on the next evaluation, luck |
217 | scaling or moving the window, root background changes and timers. Simply |
174 | decides to use the other path, then it will have to load that image again. |
218 | using an expression (such as C<scale> without parameters) that depends on |
|
|
219 | certain changing values (called "variables"), or using those variables |
|
|
220 | directly, will make an expression sensitive to these events - for example, |
|
|
221 | using C<scale> or C<TW> will make the expression sensitive to the terminal |
|
|
222 | size, and thus to resizing events. |
|
|
223 | |
|
|
224 | When such an event happens, C<keep> will automatically trigger a |
|
|
225 | reevaluation of the whole expression with the new value of the expression. |
|
|
226 | |
|
|
227 | C<keep> is most useful for expensive operations, such as C<blur>: |
|
|
228 | |
|
|
229 | rootalign keep { blur 20, root } |
|
|
230 | |
|
|
231 | This makes a blurred copy of the root background once, and on subsequent |
|
|
232 | calls, just root-aligns it. Since C<blur> is usually quite slow and |
|
|
233 | C<rootalign> is quite fast, this trades extra memory (for the cached |
|
|
234 | blurred pixmap) with speed (blur only needs to be redone when root |
|
|
235 | changes). |
|
|
236 | |
|
|
237 | =head3 C<load> caching |
|
|
238 | |
|
|
239 | The C<load> operator itself does not keep images in memory, but as long as |
|
|
240 | the image is still in memory, C<load> will use the in-memory image instead |
|
|
241 | of loading it freshly from disk. |
|
|
242 | |
|
|
243 | That means that this expression: |
|
|
244 | |
|
|
245 | keep { load "$HOME/path..." } |
|
|
246 | |
|
|
247 | Not only caches the image in memory, other terminal instances that try to |
|
|
248 | C<load> it can reuse that in-memory copy. |
175 | |
249 | |
176 | =head1 REFERENCE |
250 | =head1 REFERENCE |
177 | |
251 | |
178 | =head2 COMMAND LINE SWITCHES |
252 | =head2 COMMAND LINE SWITCHES |
179 | |
253 | |
… | |
… | |
204 | |
278 | |
205 | =cut |
279 | =cut |
206 | |
280 | |
207 | our %_IMG_CACHE; |
281 | our %_IMG_CACHE; |
208 | our $HOME; |
282 | our $HOME; |
209 | our ($self, $old, $new); |
283 | our ($self, $frame); |
210 | our ($x, $y, $w, $h); |
284 | our ($x, $y, $w, $h); |
211 | |
285 | |
212 | # enforce at least this interval between updates |
286 | # enforce at least this interval between updates |
213 | our $MIN_INTERVAL = 6/59.951; |
287 | our $MIN_INTERVAL = 6/59.951; |
214 | |
288 | |
215 | { |
289 | { |
216 | package urxvt::bgdsl; # background language |
290 | package urxvt::bgdsl; # background language |
|
|
291 | |
|
|
292 | sub FR_PARENT() { 0 } # parent frame, if any - must be #0 |
|
|
293 | sub FR_CACHE () { 1 } # cached values |
|
|
294 | sub FR_AGAIN () { 2 } # what this expr is sensitive to |
|
|
295 | sub FR_STATE () { 3 } # watchers etc. |
217 | |
296 | |
218 | use List::Util qw(min max sum shuffle); |
297 | use List::Util qw(min max sum shuffle); |
219 | |
298 | |
220 | =head2 PROVIDERS/GENERATORS |
299 | =head2 PROVIDERS/GENERATORS |
221 | |
300 | |
… | |
… | |
228 | =item load $path |
307 | =item load $path |
229 | |
308 | |
230 | Loads the image at the given C<$path>. The image is set to plane tiling |
309 | Loads the image at the given C<$path>. The image is set to plane tiling |
231 | mode. |
310 | mode. |
232 | |
311 | |
233 | Loaded images will be cached for one cycle, and shared between temrinals |
312 | If the image is already in memory (e.g. because another terminal instance |
234 | running in the same process (e.g. in C<urxvtd>). |
313 | uses it), then the in-memory copy us returned instead. |
235 | |
314 | |
236 | =item load_uc $path |
315 | =item load_uc $path |
237 | |
316 | |
238 | Load uncached - same as load, but does not cache the image. This function |
317 | Load uncached - same as load, but does not cache the image, which means it |
239 | is most useufl if you want to optimise a background expression in some |
318 | is I<always> loaded from the filesystem again, even if another copy of it |
240 | way. |
319 | is in memory at the time. |
241 | |
320 | |
242 | =cut |
321 | =cut |
243 | |
322 | |
244 | sub load_uc($) { |
323 | sub load_uc($) { |
|
|
324 | $self->new_img_from_file ($_[0]) |
|
|
325 | } |
|
|
326 | |
|
|
327 | sub load($) { |
245 | my ($path) = @_; |
328 | my ($path) = @_; |
246 | |
329 | |
247 | $_IMG_CACHE{$path} || do { |
330 | $_IMG_CACHE{$path} || do { |
248 | my $img = $self->new_img_from_file ($path); |
331 | my $img = load_uc $path; |
249 | Scalar::Util::weaken ($_IMG_CACHE{$path} = $img); |
332 | Scalar::Util::weaken ($_IMG_CACHE{$path} = $img); |
250 | $img |
333 | $img |
251 | } |
334 | } |
252 | } |
335 | } |
253 | |
336 | |
254 | sub load($) { |
|
|
255 | my ($path) = @_; |
|
|
256 | |
|
|
257 | $new->{load}{$path} = $old->{load}{$path} || load_uc $path; |
|
|
258 | } |
|
|
259 | |
|
|
260 | =item root |
337 | =item root |
261 | |
338 | |
262 | Returns the root window pixmap, that is, hopefully, the background image |
339 | Returns the root window pixmap, that is, hopefully, the background image |
263 | of your screen. The image is set to extend mode. |
340 | of your screen. |
264 | |
341 | |
265 | This function makes your expression root sensitive, that means it will be |
342 | This function makes your expression root sensitive, that means it will be |
266 | reevaluated when the bg image changes. |
343 | reevaluated when the bg image changes. |
267 | |
344 | |
268 | =cut |
345 | =cut |
269 | |
346 | |
270 | sub root() { |
347 | sub root() { |
271 | $new->{again}{rootpmap} = 1; |
348 | $frame->[FR_AGAIN]{rootpmap} = 1; |
272 | $self->new_img_from_root |
349 | $self->new_img_from_root |
273 | } |
350 | } |
274 | |
351 | |
275 | =item solid $colour |
352 | =item solid $colour |
276 | |
353 | |
… | |
… | |
304 | } |
381 | } |
305 | |
382 | |
306 | =item merge $img ... |
383 | =item merge $img ... |
307 | |
384 | |
308 | Takes any number of images and merges them together, creating a single |
385 | Takes any number of images and merges them together, creating a single |
309 | image containing them all. |
386 | image containing them all. The tiling mode of the first image is used as |
|
|
387 | the tiling mode of the resulting image. |
|
|
388 | |
|
|
389 | This function is called automatically when an expression returns multiple |
|
|
390 | images. |
310 | |
391 | |
311 | =cut |
392 | =cut |
312 | |
393 | |
313 | sub merge(@) { |
394 | sub merge(@) { |
|
|
395 | return $_[0] unless $#_; |
|
|
396 | |
314 | # rather annoyingly clumsy, but optimisation is for another time |
397 | # rather annoyingly clumsy, but optimisation is for another time |
315 | |
398 | |
316 | my $x0 = +1e9; |
399 | my $x0 = +1e9; |
317 | my $y0 = +1e9; |
400 | my $y0 = +1e9; |
318 | my $x1 = -1e9; |
401 | my $x1 = -1e9; |
… | |
… | |
330 | $x1 = $x if $x1 < $x; |
413 | $x1 = $x if $x1 < $x; |
331 | $y1 = $y if $y1 < $y; |
414 | $y1 = $y if $y1 < $y; |
332 | } |
415 | } |
333 | |
416 | |
334 | my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0); |
417 | my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0); |
|
|
418 | $base->repeat_mode ($_[0]->repeat_mode); |
335 | $base->fill ([0, 0, 0, 0]); |
419 | $base->fill ([0, 0, 0, 0]); |
336 | |
420 | |
337 | $base->draw ($_) |
421 | $base->draw ($_) |
338 | for @_; |
422 | for @_; |
339 | |
423 | |
340 | $base |
424 | $base |
341 | } |
425 | } |
|
|
426 | |
|
|
427 | =back |
342 | |
428 | |
343 | =head2 TILING MODES |
429 | =head2 TILING MODES |
344 | |
430 | |
345 | The following operators modify the tiling mode of an image, that is, the |
431 | The following operators modify the tiling mode of an image, that is, the |
346 | way that pixels outside the image area are painted when the image is used. |
432 | way that pixels outside the image area are painted when the image is used. |
… | |
… | |
443 | Using these functions make your expression sensitive to window moves. |
529 | Using these functions make your expression sensitive to window moves. |
444 | |
530 | |
445 | These functions are mainly useful to align images to the root window. |
531 | These functions are mainly useful to align images to the root window. |
446 | |
532 | |
447 | Example: load an image and align it so it looks as if anchored to the |
533 | Example: load an image and align it so it looks as if anchored to the |
448 | background. |
534 | background (that's exactly what C<rootalign> does btw.): |
449 | |
535 | |
450 | move -TX, -TY, load "mybg.png" |
536 | move -TX, -TY, keep { load "mybg.png" } |
451 | |
537 | |
452 | =item TW |
538 | =item TW |
|
|
539 | |
|
|
540 | =item TH |
453 | |
541 | |
454 | Return the width (C<TW>) and height (C<TH>) of the terminal window (the |
542 | Return the width (C<TW>) and height (C<TH>) of the terminal window (the |
455 | terminal window is the full window by default, and the character area only |
543 | terminal window is the full window by default, and the character area only |
456 | when in border-respect mode). |
544 | when in border-respect mode). |
457 | |
545 | |
… | |
… | |
461 | the window size to conserve memory. |
549 | the window size to conserve memory. |
462 | |
550 | |
463 | Example: take the screen background, clip it to the window size, blur it a |
551 | Example: take the screen background, clip it to the window size, blur it a |
464 | bit, align it to the window position and use it as background. |
552 | bit, align it to the window position and use it as background. |
465 | |
553 | |
466 | clip move -TX, -TY, once { blur 5, root } |
554 | clip move -TX, -TY, keep { blur 5, root } |
467 | |
555 | |
468 | =cut |
556 | =cut |
469 | |
557 | |
470 | sub TX() { $new->{again}{position} = 1; $x } |
558 | sub TX() { $frame->[FR_AGAIN]{position} = 1; $x } |
471 | sub TY() { $new->{again}{position} = 1; $y } |
559 | sub TY() { $frame->[FR_AGAIN]{position} = 1; $y } |
472 | sub TW() { $new->{again}{size} = 1; $w } |
560 | sub TW() { $frame->[FR_AGAIN]{size} = 1; $w } |
473 | sub TH() { $new->{again}{size} = 1; $h } |
561 | sub TH() { $frame->[FR_AGAIN]{size} = 1; $h } |
474 | |
562 | |
475 | =item now |
563 | =item now |
476 | |
564 | |
477 | Returns the current time as (fractional) seconds since the epoch. |
565 | Returns the current time as (fractional) seconds since the epoch. |
478 | |
566 | |
… | |
… | |
485 | C<$seconds> seconds. |
573 | C<$seconds> seconds. |
486 | |
574 | |
487 | Example: load some image and rotate it according to the time of day (as if it were |
575 | Example: load some image and rotate it according to the time of day (as if it were |
488 | the hour pointer of a clock). Update this image every minute. |
576 | the hour pointer of a clock). Update this image every minute. |
489 | |
577 | |
|
|
578 | again 60; |
490 | again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" |
579 | rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" } |
491 | |
580 | |
492 | =item counter $seconds |
581 | =item counter $seconds |
493 | |
582 | |
494 | Like C<again>, but also returns an increasing counter value, starting at |
583 | Like C<again>, but also returns an increasing counter value, starting at |
495 | 0, which might be useful for some simple animation effects. |
584 | 0, which might be useful for some simple animation effects. |
… | |
… | |
497 | =cut |
586 | =cut |
498 | |
587 | |
499 | sub now() { urxvt::NOW } |
588 | sub now() { urxvt::NOW } |
500 | |
589 | |
501 | sub again($) { |
590 | sub again($) { |
502 | $new->{again}{time} = $_[0]; |
591 | $frame->[FR_AGAIN]{time} = $_[0]; |
503 | } |
592 | } |
504 | |
593 | |
505 | sub counter($) { |
594 | sub counter($) { |
506 | $new->{again}{time} = $_[0]; |
595 | $frame->[FR_AGAIN]{time} = $_[0]; |
507 | $self->{counter} + 0 |
596 | $frame->[FR_STATE]{counter} + 0 |
508 | } |
597 | } |
509 | |
598 | |
510 | =back |
599 | =back |
511 | |
600 | |
512 | =head2 SHAPE CHANGING OPERATORS |
601 | =head2 SHAPE CHANGING OPERATORS |
… | |
… | |
524 | Clips an image to the given rectangle. If the rectangle is outside the |
613 | Clips an image to the given rectangle. If the rectangle is outside the |
525 | image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is |
614 | image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is |
526 | larger than the image, then the tiling mode defines how the extra pixels |
615 | larger than the image, then the tiling mode defines how the extra pixels |
527 | will be filled. |
616 | will be filled. |
528 | |
617 | |
529 | If C<$x> an C<$y> are missing, then C<0> is assumed for both. |
618 | If C<$x> and C<$y> are missing, then C<0> is assumed for both. |
530 | |
619 | |
531 | If C<$width> and C<$height> are missing, then the window size will be |
620 | If C<$width> and C<$height> are missing, then the window size will be |
532 | assumed. |
621 | assumed. |
533 | |
622 | |
534 | Example: load an image, blur it, and clip it to the window size to save |
623 | Example: load an image, blur it, and clip it to the window size to save |
535 | memory. |
624 | memory. |
536 | |
625 | |
537 | clip blur 10, load "mybg.png" |
626 | clip keep { blur 10, load "mybg.png" } |
538 | |
627 | |
539 | =cut |
628 | =cut |
540 | |
629 | |
541 | sub clip($;$$;$$) { |
630 | sub clip($;$$;$$) { |
542 | my $img = pop; |
631 | my $img = pop; |
… | |
… | |
636 | the terminal window (or the box specified by C<$width> and C<$height> if |
725 | the terminal window (or the box specified by C<$width> and C<$height> if |
637 | given). |
726 | given). |
638 | |
727 | |
639 | Example: load an image and center it. |
728 | Example: load an image and center it. |
640 | |
729 | |
641 | center pad load "mybg.png" |
730 | center keep { pad load "mybg.png" } |
642 | |
731 | |
643 | =item rootalign $img |
732 | =item rootalign $img |
644 | |
733 | |
645 | Moves the image so that it appears glued to the screen as opposed to the |
734 | Moves the image so that it appears glued to the screen as opposed to the |
646 | window. This gives the illusion of a larger area behind the window. It is |
735 | window. This gives the illusion of a larger area behind the window. It is |
647 | exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the |
736 | exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the |
648 | top left of the screen. |
737 | top left of the screen. |
649 | |
738 | |
650 | Example: load a background image, put it in mirror mode and root align it. |
739 | Example: load a background image, put it in mirror mode and root align it. |
651 | |
740 | |
652 | rootalign mirror load "mybg.png" |
741 | rootalign keep { mirror load "mybg.png" } |
653 | |
742 | |
654 | Example: take the screen background and align it, giving the illusion of |
743 | Example: take the screen background and align it, giving the illusion of |
655 | transparency as long as the window isn't in front of other windows. |
744 | transparency as long as the window isn't in front of other windows. |
656 | |
745 | |
657 | rootalign root |
746 | rootalign root |
… | |
… | |
682 | |
771 | |
683 | sub rootalign($) { |
772 | sub rootalign($) { |
684 | move -TX, -TY, $_[0] |
773 | move -TX, -TY, $_[0] |
685 | } |
774 | } |
686 | |
775 | |
687 | =item rotate $center_x, $center_y, $degrees |
776 | =item rotate $center_x, $center_y, $degrees, $img |
688 | |
777 | |
689 | Rotates the image by C<$degrees> degrees, counter-clockwise, around the |
778 | Rotates the image clockwise by C<$degrees> degrees, around the point at |
690 | pointer at C<$center_x> and C<$center_y> (specified as factor of image |
779 | C<$center_x> and C<$center_y> (specified as factor of image width/height). |
691 | width/height). |
|
|
692 | |
780 | |
693 | #TODO# new width, height, maybe more operators? |
|
|
694 | |
|
|
695 | Example: rotate the image by 90 degrees |
781 | Example: rotate the image by 90 degrees around it's center. |
|
|
782 | |
|
|
783 | rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" } |
696 | |
784 | |
697 | =cut |
785 | =cut |
698 | |
786 | |
699 | sub rotate($$$$) { |
787 | sub rotate($$$$) { |
700 | my $img = pop; |
788 | my $img = pop; |
… | |
… | |
711 | |
799 | |
712 | The following operators change the pixels of the image. |
800 | The following operators change the pixels of the image. |
713 | |
801 | |
714 | =over 4 |
802 | =over 4 |
715 | |
803 | |
|
|
804 | =item tint $color, $img |
|
|
805 | |
|
|
806 | Tints the image in the given colour. |
|
|
807 | |
|
|
808 | Example: tint the image red. |
|
|
809 | |
|
|
810 | tint "red", load "rgb.png" |
|
|
811 | |
|
|
812 | Example: the same, but specify the colour by component. |
|
|
813 | |
|
|
814 | tint [1, 0, 0], load "rgb.png" |
|
|
815 | |
|
|
816 | =cut |
|
|
817 | |
|
|
818 | sub tint($$) { |
|
|
819 | $_[1]->tint ($_[0]) |
|
|
820 | } |
|
|
821 | |
716 | =item contrast $factor, $img |
822 | =item contrast $factor, $img |
717 | |
823 | |
718 | =item contrast $r, $g, $b, $img |
824 | =item contrast $r, $g, $b, $img |
719 | |
825 | |
720 | =item contrast $r, $g, $b, $a, $img |
826 | =item contrast $r, $g, $b, $a, $img |
… | |
… | |
749 | latter in a white picture. |
855 | latter in a white picture. |
750 | |
856 | |
751 | Due to idiosyncrasies in the underlying XRender extension, biases less |
857 | Due to idiosyncrasies in the underlying XRender extension, biases less |
752 | than zero can be I<very> slow. |
858 | than zero can be I<very> slow. |
753 | |
859 | |
|
|
860 | You can also try the experimental(!) C<muladd> operator. |
|
|
861 | |
754 | =cut |
862 | =cut |
755 | |
863 | |
756 | sub contrast($$;$$;$) { |
864 | sub contrast($$;$$;$) { |
757 | my $img = pop; |
865 | my $img = pop; |
758 | my ($r, $g, $b, $a) = @_; |
866 | my ($r, $g, $b, $a) = @_; |
… | |
… | |
773 | $a = 1 if @_ < 4; |
881 | $a = 1 if @_ < 4; |
774 | |
882 | |
775 | $img = $img->clone; |
883 | $img = $img->clone; |
776 | $img->brightness ($r, $g, $b, $a); |
884 | $img->brightness ($r, $g, $b, $a); |
777 | $img |
885 | $img |
|
|
886 | } |
|
|
887 | |
|
|
888 | =item muladd $mul, $add, $img # EXPERIMENTAL |
|
|
889 | |
|
|
890 | First multiplies the pixels by C<$mul>, then adds C<$add>. This can be used |
|
|
891 | to implement brightness and contrast at the same time, with a wider value |
|
|
892 | range than contrast and brightness operators. |
|
|
893 | |
|
|
894 | Due to numerous bugs in XRender implementations, it can also introduce a |
|
|
895 | number of visual artifacts. |
|
|
896 | |
|
|
897 | Example: increase contrast by a factor of C<$c> without changing image |
|
|
898 | brightness too much. |
|
|
899 | |
|
|
900 | muladd $c, (1 - $c) * 0.5, $img |
|
|
901 | |
|
|
902 | =cut |
|
|
903 | |
|
|
904 | sub muladd($$$) { |
|
|
905 | $_[2]->muladd ($_[0], $_[1]) |
778 | } |
906 | } |
779 | |
907 | |
780 | =item blur $radius, $img |
908 | =item blur $radius, $img |
781 | |
909 | |
782 | =item blur $radius_horz, $radius_vert, $img |
910 | =item blur $radius_horz, $radius_vert, $img |
… | |
… | |
803 | Anything that didn't fit any of the other categories, even after applying |
931 | Anything that didn't fit any of the other categories, even after applying |
804 | force and closing our eyes. |
932 | force and closing our eyes. |
805 | |
933 | |
806 | =over 4 |
934 | =over 4 |
807 | |
935 | |
808 | =item once { ... } |
936 | =item keep { ... } |
809 | |
937 | |
810 | This function takes a code block as argument, that is, one or more |
938 | This operator takes a code block as argument, that is, one or more |
811 | statements enclosed by braces. |
939 | statements enclosed by braces. |
812 | |
940 | |
813 | The trick is that this code block is only evaluated once - future calls |
941 | The trick is that this code block is only evaluated when the outcome |
814 | will simply return the original image (yes, it should only be used with |
942 | changes - on other calls the C<keep> simply returns the image it computed |
815 | images). |
943 | previously (yes, it should only be used with images). Or in other words, |
|
|
944 | C<keep> I<caches> the result of the code block so it doesn't need to be |
|
|
945 | computed again. |
816 | |
946 | |
817 | This can be extremely useful to avoid redoign the same slow operations |
947 | This can be extremely useful to avoid redoing slow operations - for |
818 | again and again- for example, if your background expression takes the root |
948 | example, if your background expression takes the root background, blurs it |
819 | background, blurs it and then root-aligns it it would have to blur the |
949 | and then root-aligns it it would have to blur the root background on every |
820 | root background on every window move or resize. |
950 | window move or resize. |
821 | |
951 | |
|
|
952 | Another example is C<load>, which can be quite slow. |
|
|
953 | |
|
|
954 | In fact, urxvt itself encloses the whole expression in some kind of |
|
|
955 | C<keep> block so it only is reevaluated as required. |
|
|
956 | |
822 | Putting the blur into a C<once> block will make sure the blur is only done |
957 | Putting the blur into a C<keep> block will make sure the blur is only done |
823 | once: |
958 | once, while the C<rootalign> is still done each time the window moves. |
824 | |
959 | |
825 | rootlign once { blur 10, root } |
960 | rootalign keep { blur 10, root } |
826 | |
961 | |
827 | This leaves the question of how to force reevaluation of the block, in |
962 | This leaves the question of how to force reevaluation of the block, |
828 | case the root background changes: Right now, all once blocks forget that |
963 | in case the root background changes: If expression inside the block |
829 | they ahve been executed before each time the root background changes (if |
964 | is sensitive to some event (root background changes, window geometry |
830 | the expression is sensitive to that) or when C<once_again> is called. |
965 | changes), then it will be reevaluated automatically as needed. |
831 | |
966 | |
832 | =item once_again |
|
|
833 | |
|
|
834 | Resets all C<once> block as if they had never been called, i.e. on the |
|
|
835 | next call they will be reevaluated again. |
|
|
836 | |
|
|
837 | =cut |
967 | =cut |
838 | |
968 | |
839 | sub once(&) { |
969 | sub keep(&) { |
840 | my $once = $self->{once_cache}{$_[0]+0} ||= do { |
970 | my $id = $_[0]+0; |
841 | local $new->{again}; |
971 | |
842 | my @res = $_[0](); |
972 | local $frame = $self->{frame_cache}{$id} ||= [$frame]; |
843 | [$new->{again}, \@res] |
973 | |
|
|
974 | unless ($frame->[FR_CACHE]) { |
|
|
975 | $frame->[FR_CACHE] = [ $_[0]() ]; |
|
|
976 | |
|
|
977 | my $self = $self; |
|
|
978 | my $frame = $frame; |
|
|
979 | Scalar::Util::weaken $frame; |
|
|
980 | $self->compile_frame ($frame, sub { |
|
|
981 | # clear this frame cache, also for all parents |
|
|
982 | for (my $frame = $frame; $frame; $frame = $frame->[0]) { |
|
|
983 | undef $frame->[FR_CACHE]; |
|
|
984 | } |
|
|
985 | |
|
|
986 | $self->recalculate; |
844 | }; |
987 | }); |
845 | |
|
|
846 | $new->{again} = { |
|
|
847 | %{ $new->{again} }, |
|
|
848 | %{ $once->[0] } |
|
|
849 | }; |
988 | }; |
850 | |
989 | |
851 | # in scalar context we always return the first original result, which |
990 | # in scalar context we always return the first original result, which |
852 | # is not quite how perl works. |
991 | # is not quite how perl works. |
853 | wantarray |
992 | wantarray |
854 | ? @{ $once->[1] } |
993 | ? @{ $frame->[FR_CACHE] } |
855 | : $once->[1][0] |
994 | : $frame->[FR_CACHE][0] |
|
|
995 | } |
|
|
996 | |
|
|
997 | # sub keep_clear() { |
|
|
998 | # delete $self->{frame_cache}; |
856 | } |
999 | # } |
857 | |
|
|
858 | sub once_again() { |
|
|
859 | delete $self->{once_cache}; |
|
|
860 | } |
|
|
861 | |
1000 | |
862 | =back |
1001 | =back |
863 | |
1002 | |
864 | =cut |
1003 | =cut |
865 | |
1004 | |
866 | } |
1005 | } |
867 | |
1006 | |
868 | sub parse_expr { |
1007 | sub parse_expr { |
869 | my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}"; |
1008 | my $expr = eval |
|
|
1009 | "sub {\n" |
|
|
1010 | . "package urxvt::bgdsl;\n" |
|
|
1011 | . "#line 0 'background expression'\n" |
|
|
1012 | . "$_[0]\n" |
|
|
1013 | . "}"; |
870 | die if $@; |
1014 | die if $@; |
871 | $expr |
1015 | $expr |
872 | } |
1016 | } |
873 | |
1017 | |
874 | # compiles a parsed expression |
1018 | # compiles a parsed expression |
875 | sub set_expr { |
1019 | sub set_expr { |
876 | my ($self, $expr) = @_; |
1020 | my ($self, $expr) = @_; |
877 | |
1021 | |
|
|
1022 | $self->{root} = []; # the outermost frame |
878 | $self->{expr} = $expr; |
1023 | $self->{expr} = $expr; |
879 | $self->recalculate; |
1024 | $self->recalculate; |
|
|
1025 | } |
|
|
1026 | |
|
|
1027 | # takes a hash of sensitivity indicators and installs watchers |
|
|
1028 | sub compile_frame { |
|
|
1029 | my ($self, $frame, $cb) = @_; |
|
|
1030 | |
|
|
1031 | my $state = $frame->[urxvt::bgdsl::FR_STATE] ||= {}; |
|
|
1032 | my $again = $frame->[urxvt::bgdsl::FR_AGAIN]; |
|
|
1033 | |
|
|
1034 | # don't keep stuff alive |
|
|
1035 | Scalar::Util::weaken $state; |
|
|
1036 | |
|
|
1037 | if ($again->{nested}) { |
|
|
1038 | $state->{nested} = 1; |
|
|
1039 | } else { |
|
|
1040 | delete $state->{nested}; |
|
|
1041 | } |
|
|
1042 | |
|
|
1043 | if (my $interval = $again->{time}) { |
|
|
1044 | $state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)] |
|
|
1045 | if $state->{time}[0] != $interval; |
|
|
1046 | |
|
|
1047 | # callback *might* have changed, although we could just rule that out |
|
|
1048 | $state->{time}[1]->cb (sub { |
|
|
1049 | ++$state->{counter}; |
|
|
1050 | $cb->(); |
|
|
1051 | }); |
|
|
1052 | } else { |
|
|
1053 | delete $state->{time}; |
|
|
1054 | } |
|
|
1055 | |
|
|
1056 | if ($again->{position}) { |
|
|
1057 | $state->{position} = $self->on (position_change => $cb); |
|
|
1058 | } else { |
|
|
1059 | delete $state->{position}; |
|
|
1060 | } |
|
|
1061 | |
|
|
1062 | if ($again->{size}) { |
|
|
1063 | $state->{size} = $self->on (size_change => $cb); |
|
|
1064 | } else { |
|
|
1065 | delete $state->{size}; |
|
|
1066 | } |
|
|
1067 | |
|
|
1068 | if ($again->{rootpmap}) { |
|
|
1069 | $state->{rootpmap} = $self->on (rootpmap_change => $cb); |
|
|
1070 | } else { |
|
|
1071 | delete $state->{rootpmap}; |
|
|
1072 | } |
880 | } |
1073 | } |
881 | |
1074 | |
882 | # evaluate the current bg expression |
1075 | # evaluate the current bg expression |
883 | sub recalculate { |
1076 | sub recalculate { |
884 | my ($arg_self) = @_; |
1077 | my ($arg_self) = @_; |
… | |
… | |
894 | |
1087 | |
895 | $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; |
1088 | $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; |
896 | |
1089 | |
897 | # set environment to evaluate user expression |
1090 | # set environment to evaluate user expression |
898 | |
1091 | |
899 | local $self = $arg_self; |
1092 | local $self = $arg_self; |
900 | |
|
|
901 | local $HOME = $ENV{HOME}; |
1093 | local $HOME = $ENV{HOME}; |
902 | local $old = $self->{state}; |
1094 | local $frame = $self->{root}; |
903 | local $new = my $state = $self->{state} = {}; |
|
|
904 | |
1095 | |
905 | ($x, $y, $w, $h) = |
|
|
906 | $self->background_geometry ($self->{border}); |
1096 | ($x, $y, $w, $h) = $self->background_geometry ($self->{border}); |
907 | |
1097 | |
908 | # evaluate user expression |
1098 | # evaluate user expression |
909 | |
1099 | |
910 | my $img = eval { $self->{expr}->() }; |
1100 | my @img = eval { $self->{expr}->() }; |
911 | warn $@ if $@;#d# |
1101 | die $@ if $@; |
912 | die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img"; |
1102 | die "background-expr did not return anything.\n" unless @img; |
|
|
1103 | die "background-expr: expected image(s), got something else.\n" |
|
|
1104 | if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img; |
|
|
1105 | |
|
|
1106 | my $img = urxvt::bgdsl::merge @img; |
|
|
1107 | |
|
|
1108 | $frame->[FR_AGAIN]{size} = 1 |
|
|
1109 | if $img->repeat_mode != urxvt::RepeatNormal; |
913 | |
1110 | |
914 | # if the expression is sensitive to external events, prepare reevaluation then |
1111 | # if the expression is sensitive to external events, prepare reevaluation then |
915 | |
1112 | $self->compile_frame ($frame, sub { $arg_self->recalculate }); |
916 | my $again = delete $state->{again}; |
|
|
917 | |
|
|
918 | $again->{size} = 1 |
|
|
919 | if $img->repeat_mode != urxvt::RepeatNormal; |
|
|
920 | |
|
|
921 | if (my $again = $again->{time}) { |
|
|
922 | my $self = $self; |
|
|
923 | $state->{timer} = $again == $old->{again} |
|
|
924 | ? $old->{timer} |
|
|
925 | : urxvt::timer->new->after ($again)->interval ($again)->cb (sub { |
|
|
926 | ++$self->{counter}; |
|
|
927 | $self->recalculate |
|
|
928 | }); |
|
|
929 | } |
|
|
930 | |
|
|
931 | if ($again->{position}) { |
|
|
932 | $self->enable (position_change => sub { $_[0]->recalculate }); |
|
|
933 | } else { |
|
|
934 | $self->disable ("position_change"); |
|
|
935 | } |
|
|
936 | |
|
|
937 | if ($again->{size}) { |
|
|
938 | $self->enable (size_change => sub { $_[0]->recalculate }); |
|
|
939 | } else { |
|
|
940 | $self->disable ("size_change"); |
|
|
941 | } |
|
|
942 | |
|
|
943 | if ($again->{rootpmap}) { |
|
|
944 | $self->enable (rootpmap_change => sub { |
|
|
945 | delete $_[0]{once_cache}; # this will override once-block values from |
|
|
946 | $_[0]->recalculate; |
|
|
947 | }); |
|
|
948 | } else { |
|
|
949 | $self->disable ("rootpmap_change"); |
|
|
950 | } |
|
|
951 | |
1113 | |
952 | # clear stuff we no longer need |
1114 | # clear stuff we no longer need |
953 | |
1115 | |
954 | %$old = (); |
1116 | # unless (%{ $frame->[FR_STATE] }) { |
955 | |
|
|
956 | unless (%$again) { |
|
|
957 | delete $self->{state}; |
1117 | # delete $self->{state}; |
958 | delete $self->{expr}; |
1118 | # delete $self->{expr}; |
959 | } |
1119 | # } |
960 | |
1120 | |
961 | # set background pixmap |
1121 | # set background pixmap |
962 | |
1122 | |
963 | $self->set_background ($img, $self->{border}); |
1123 | $self->set_background ($img, $self->{border}); |
964 | $self->scr_recolour (0); |
1124 | $self->scr_recolour (0); |