ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/perl/background
(Generate patch)

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.11 by sf-exg, Tue Jun 5 15:18:23 2012 UTC vs.
Revision 1.35 by root, Fri Jun 8 08:06:38 2012 UTC

1#! perl 1#! perl
2 2
3our $EXPR = 'move load "/root/pix/das_fette_schwein.jpg", repeat_wrap, X, Y'; 3#:META:X_RESOURCE:%.expr:string:background expression
4#:META:X_RESOURCE:%.border.:boolean:respect the terminal border
5
6#TODO: once, rootalign
7
8=head1 background - manage terminal background
9
10=head2 SYNOPSIS
11
12 rxvt -background-expr 'background expression'
13 -background-border
14
15=head2 DESCRIPTION
16
17=head2 REFERENCE
18
19=cut
20
21our $EXPR;
22#$EXPR = 'move W * 0.1, -H * 0.1, resize W * 0.5, H * 0.5, repeat_none load "opensource.png"';
23$EXPR = 'move -TX, -TY, load "argb.png"';
4$EXPR = ' 24#$EXPR = '
5 rotate W, H, 50, 50, counter 1/59.95, repeat_mirror, 25# rotate W, H, 50, 50, counter 1/59.95, repeat_mirror,
6 clip X, Y, W, H, repeat_mirror, 26# clip X, Y, W, H, repeat_mirror,
7 load "/root/pix/das_fette_schwein.jpg" 27# load "/root/pix/das_fette_schwein.jpg"
8'; 28#';
29#$EXPR = 'solid "red"';
9#$EXPR = 'blur root, 10, 10' 30#$EXPR = 'blur root, 10, 10'
10#$EXPR = 'blur move (root, -x, -y), 5, 5' 31#$EXPR = 'blur move (root, -x, -y), 5, 5'
11#resize load "/root/pix/das_fette_schwein.jpg", w, h 32#resize load "/root/pix/das_fette_schwein.jpg", w, h
12 33
13use Safe;
14
15our ($bgdsl_self, $old, $new); 34our ($self, $old, $new);
16our ($l, $t, $w, $h); 35our ($x, $y, $w, $h);
17 36
37# enforce at least this interval between updates
18our $MIN_INTERVAL = 1/100; 38our $MIN_INTERVAL = 1/100;
19 39
20{ 40{
21 package urxvt::bgdsl; # background language 41 package urxvt::bgdsl; # background language
22 42
23 *repeat_black = \&urxvt::RepeatNone; #TODO wtf 43=head2 PROVIDERS/GENERATORS
24 *repeat_wrap = \&urxvt::RepeatNormal; 44
25 *repeat_pad = \&urxvt::RepeatPad; 45These functions provide an image, by loading it from disk, grabbing it
26 *repeat_mirror = \&urxvt::RepeatReflect; 46from the root screen or by simply generating it. They are used as starting
47points to get an image you can play with.
48
49=over 4
50
51=item load $path
52
53Loads the image at the given C<$path>. The image is set to plane tiling
54mode.
55
56Loaded images will be cached for one cycle.
57
58=cut
27 59
28 sub load($) { 60 sub load($) {
29 my ($path) = @_; 61 my ($path) = @_;
30 62
31 $new->{load}{$path} = $old->{load}{$path} || $bgdsl_self->new_img_from_file ($path); 63 $new->{load}{$path} = $old->{load}{$path} || $self->new_img_from_file ($path);
32 } 64 }
65
66=item root
67
68Returns the root window pixmap, that is, hopefully, the background image
69of your screen. The image is set to extend mode.
70
71This function makes your expression root sensitive, that means it will be
72reevaluated when the bg image changes.
73
74=cut
33 75
34 sub root() { 76 sub root() {
35 $new->{rootpmap_sensitive} = 1; 77 $new->{rootpmap_sensitive} = 1;
36 die "root op not supported, exg, we need you"; 78 die "root op not supported, exg, we need you";
37 } 79 }
38 80
81=item solid $colour
82
83=item solid $width, $height, $colour
84
85Creates a new image and completely fills it with the given colour. The
86image is set to tiling mode.
87
88If <$width> and C<$height> are omitted, it creates a 1x1 image, which is
89useful for solid backgrounds or for use in filtering effects.
90
91=cut
92
93 sub solid($$;$) {
94 my $colour = pop;
95
96 my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1);
97 $img->fill ($colour);
98 $img
99 }
100
101=back
102
103=head2 VARIABLES
104
105The following functions provide variable data such as the terminal
106window dimensions. Most of them make your expression sensitive to some
107events, for example using C<TW> (terminal width) means your expression is
108evaluated again when the terminal is resized.
109
110=over 4
111
112=item TX
113
114=item TY
115
116Return the X and Y coordinates of the terminal window (the terminal
117window is the full window by default, and the character area only when in
118border-respect mode).
119
120Using these functions make your expression sensitive to window moves.
121
122These functions are mainly useful to align images to the root window.
123
124Example: load an image and align it so it looks as if anchored to the
125background.
126
127 move -TX, -TY, load "mybg.png"
128
129=item TW
130
131Return the width (C<TW>) and height (C<TH>) of the terminal window (the
132terminal window is the full window by default, and the character area only
133when in border-respect mode).
134
135Using these functions make your expression sensitive to window resizes.
136
137These functions are mainly useful to scale images, or to clip images to
138the window size to conserve memory.
139
140Example: take the screen background, clip it to the window size, blur it a
141bit, align it to the window position and use it as background.
142
143 clip move -TX, -TY, blur 5, root
144
145=cut
146
147 sub TX() { $new->{position_sensitive} = 1; $x }
148 sub TY() { $new->{position_sensitive} = 1; $y }
149 sub TW() { $new->{size_sensitive} = 1; $w }
150 sub TH() { $new->{size_sensitive} = 1; $h }
151
152=item now
153
154Returns the current time as (fractional) seconds since the epoch.
155
156Using this expression does I<not> make your expression sensitive to time,
157but the next two functions do.
158
159=item again $seconds
160
161When this function is used the expression will be reevaluated again in
162C<$seconds> seconds.
163
164Example: load some image and rotate it according to the time of day (as if it were
165the hour pointer of a clock). update this image every minute.
166
167 again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
168
169=item counter $seconds
170
171Like C<again>, but also returns an increasing counter value, starting at
1720, which might be useful for some simple animation effects.
173
174=cut
175
176 sub now() { urxvt::NOW }
177
178 sub again($) {
179 $new->{again} = $_[0];
180 }
181
182 sub counter($) {
183 $new->{again} = $_[0];
184 $self->{counter} + 0
185 }
186
187=back
188
189=head2 TILING MODES
190
191The following operators modify the tiling mode of an image, that is, the
192way that pixels outside the image area are painted when the image is used.
193
194=over 4
195
196=item tile $img
197
198Tiles the whole plane with the image and returns this new image - or in
199other words, it returns a copy of the image in plane tiling mode.
200
201Example: load an image and tile it over the background, without
202resizing. The C<tile> call is superfluous because C<load> already defaults
203to tiling mode.
204
205 tile load "mybg.png"
206
207=item mirror $img
208
209Similar to tile, but reflects the image each time it uses a new copy, so
210that top edges always touch top edges, right edges always touch right
211edges and so on (with normal tiling, left edges always touch right edges
212and top always touch bottom edges).
213
214Exmaple: load an image and mirror it over the background, avoiding sharp
215edges at the image borders at the expense of mirroring the image itself
216
217 mirror load "mybg.png"
218
219=item pad $img
220
221Takes an image and modifies it so that all pixels outside the image area
222become transparent. This mode is most useful when you want to place an
223image over another image or the background colour while leaving all
224background pixels outside the image unchanged.
225
226Example: load an image and display it in the upper left corner. The rets
227of the space is left "empty" (transparent or wahtever your compisotr does
228in alpha mode, else background colour).
229
230 pad load "mybg.png"
231
232=item extend $img
233
234Extends the image over the whole plane, using the closest pixel in the
235area outside the image. This mode is mostly useful when you more complex
236filtering operations and want the pixels outside the image to have the
237same values as the pixels near the edge.
238
239Example: just for curiosity, how does this pixel extension stuff work?
240
241 extend move 50, 50, load "mybg.png"
242
243=cut
244
245 sub pad($) {
246 my $img = $_[0]->clone;
247 $img->repeat_mode (urxvt::RepeatNone);
248 $img
249 }
250
251 sub tile($) {
252 my $img = $_[0]->clone;
253 $img->repeat_mode (urxvt::RepeatNormal);
254 $img
255 }
256
257 sub mirror($) {
258 my $img = $_[0]->clone;
259 $img->repeat_mode (urxvt::RepeatReflect);
260 $img
261 }
262
263 sub extend($) {
264 my $img = $_[0]->clone;
265 $img->repeat_mode (urxvt::RepeatPad);
266 $img
267 }
268
269=back
270
271=head2 PIXEL OPERATORS
272
273The following operators modify the image pixels in various ways.
274
275=over 4
276
277=item clone $img
278
279Returns an exact copy of the image.
280
281=cut
282
39# sub clone($) { 283 sub clone($) {
40# $_[0]->clone 284 $_[0]->clone
41# } 285 }
42 286
287=item clip $img
288
289=item clip $width, $height, $img
290
291=item clip $x, $y, $width, $height, $img
292
293Clips an image to the given rectangle. If the rectangle is outside the
294image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
295larger than the image, then the tiling mode defines how the extra pixels
296will be filled.
297
298If C<$x> an C<$y> are missing, then C<0> is assumed for both.
299
300If C<$width> and C<$height> are missing, then the window size will be
301assumed.
302
303Example: load an image, blur it, and clip it to the window size to save
304memory.
305
306 clip blur 10, load "mybg.png"
307
308=cut
309
43 sub clip($$$$$;$) { 310 sub clip($;$$;$$) {
311 my $img = pop;
44 my $img = pop; 312 my $h = pop || TH;
313 my $w = pop || TW;
45 $img->sub_rect ($_[0], $_[1], $_[2], $_[3], $_[4]) 314 $img->sub_rect ($_[0], $_[1], $w, $h)
315 }
316
317=item scale $img
318
319=item scale $size_percent, $img
320
321=item scale $width_percent, $height_percent, $img
322
323Scales the image by the given percentages in horizontal
324(C<$width_percent>) and vertical (C<$height_percent>) direction.
325
326If only one percentage is give, it is used for both directions.
327
328If no percentages are given, scales the image to the window size without
329keeping aspect.
330
331=item resize $width, $height, $img
332
333Resizes the image to exactly C<$width> times C<$height> pixels.
334
335=cut
336
337#TODO: maximise, maximise_fill?
338
339 sub scale($;$;$) {
340 my $img = pop;
341
342 @_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01)
343 : @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01)
344 : $img->scale (TW, TH)
46 } 345 }
47 346
48 sub resize($$$) { 347 sub resize($$$) {
49 my $img = pop; 348 my $img = pop;
50 $img->scale ($_[0], $_[1]) 349 $img->scale ($_[0], $_[1])
51 } 350 }
52 351
53 # TODO: ugly
54 sub move($$;$) { 352 sub move($$;$) {
55 my $img = pop; 353 my $img = pop->clone;
56 $img->sub_rect ( 354 $img->move ($_[0], $_[1]);
57 $_[0], $_[1], 355 $img
58 $img->w, $img->h,
59 $_[2],
60 )
61 } 356 }
62 357
63 sub rotate($$$$$$;$) { 358 sub rotate($$$$$$) {
64 my $img = pop; 359 my $img = pop;
65 $img->rotate ( 360 $img->rotate (
66 $_[0], 361 $_[0],
67 $_[1], 362 $_[1],
68 $_[2] * $img->w * .01, 363 $_[2] * $img->w * .01,
69 $_[3] * $img->h * .01, 364 $_[3] * $img->h * .01,
70 $_[4] * (3.14159265 / 180), 365 $_[4] * (3.14159265 / 180),
71 $_[5],
72 ) 366 )
73 } 367 }
74 368
75 sub blur($$$) { 369 sub blur($$;$) {
76 my ($rh, $rv, $img) = @_; 370 my $img = pop;
77 371 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
78 $img->blur ($rh, $rv);
79 } 372 }
80 373
81 sub contrast($$;$$;$) { 374 sub contrast($$;$$;$) {
82 my $img = pop; 375 my $img = pop;
83 my ($r, $g, $b, $a) = @_; 376 my ($r, $g, $b, $a) = @_;
100 $img = $img->clone; 393 $img = $img->clone;
101 $img->brightness ($r, $g, $b, $a); 394 $img->brightness ($r, $g, $b, $a);
102 $img 395 $img
103 } 396 }
104 397
105 sub X() { $new->{position_sensitive} = 1; $l } 398=back
106 sub Y() { $new->{position_sensitive} = 1; $t }
107 sub W() { $new->{size_sensitive} = 1; $w }
108 sub H() { $new->{size_sensitive} = 1; $h }
109 399
110 sub now() { urxvt::NOW } 400=cut
111 401
112 sub again($) {
113 $new->{again} = $_[0];
114 }
115
116 sub counter($) {
117 $new->{again} = $_[0];
118 $bgdsl_self->{counter} + 0
119 }
120} 402}
121 403
122sub parse_expr { 404sub parse_expr {
123 my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}"; 405 my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}";
124 die if $@; 406 die if $@;
133 $self->recalculate; 415 $self->recalculate;
134} 416}
135 417
136# evaluate the current bg expression 418# evaluate the current bg expression
137sub recalculate { 419sub recalculate {
138 my ($self) = @_; 420 my ($arg_self) = @_;
139 421
140 # rate limit evaluation 422 # rate limit evaluation
141 423
142 if ($self->{next_refresh} > urxvt::NOW) { 424 if ($arg_self->{next_refresh} > urxvt::NOW) {
143 $self->{next_refresh_timer} = urxvt::timer->new->after ($self->{next_refresh} - urxvt::NOW)->cb (sub { 425 $arg_self->{next_refresh_timer} = urxvt::timer->new->after ($arg_self->{next_refresh} - urxvt::NOW)->cb (sub {
144 $self->recalculate; 426 $arg_self->recalculate;
145 }); 427 });
428 return;
146 } 429 }
147 430
148 $self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; 431 $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
149 432
150 # set environment to evaluate user expression 433 # set environment to evaluate user expression
151 434
152 local $bgdsl_self = $self; 435 local $self = $arg_self;
153 436
154 local $old = $self->{state}; 437 local $old = $self->{state};
155 local $new = my $state = $self->{state} = {}; 438 local $new = my $state = $self->{state} = {};
156 439
157 ($l, $t, $w, $h) = 440 ($x, $y, $w, $h) =
158 $self->get_geometry; 441 $self->background_geometry ($self->{border});
159 442
160 # evaluate user expression 443 # evaluate user expression
161 444
162 my $img = eval { $self->{expr}->() }; 445 my $img = eval { $self->{expr}->() };
163 warn $@ if $@;#d# 446 warn $@ if $@;#d#
447 die if !UNIVERSAL::isa $img, "urxvt::img";
448
449 $state->{size_sensitive} = 1
450 if $img->repeat_mode != urxvt::RepeatNormal;
164 451
165 # if the expression is sensitive to external events, prepare reevaluation then 452 # if the expression is sensitive to external events, prepare reevaluation then
166 453
167 my $repeat; 454 my $repeat;
168 455
169 if (my $again = $state->{again}) { 456 if (my $again = $state->{again}) {
170 $repeat = 1; 457 $repeat = 1;
458 my $self = $self;
171 $state->{timer} = $again == $old->{again} 459 $state->{timer} = $again == $old->{again}
172 ? $old->{timer} 460 ? $old->{timer}
173 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub { 461 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
174 ++$self->{counter}; 462 ++$self->{counter};
175 $self->recalculate 463 $self->recalculate
204 unless ($repeat) { 492 unless ($repeat) {
205 delete $self->{state}; 493 delete $self->{state};
206 delete $self->{expr}; 494 delete $self->{expr};
207 } 495 }
208 496
209 # prepare and set background pixmap 497 # set background pixmap
210 498
211 $img = $img->sub_rect (0, 0, $w, $h)
212 if $img->w != $w || $img->h != $h;
213
214 $self->set_background ($img); 499 $self->set_background ($img, $self->{border});
215 $self->scr_recolour (0); 500 $self->scr_recolour (0);
216 $self->want_refresh; 501 $self->want_refresh;
217} 502}
218 503
219sub on_start { 504sub on_start {
220 my ($self) = @_; 505 my ($self) = @_;
221 506
507 my $expr = $self->x_resource ("background.expr")
508 or return;
509
222 $self->set_expr (parse_expr $EXPR); 510 $self->set_expr (parse_expr $expr);
511 $self->{border} = $self->x_resource_boolean ("background.border");
223 512
224 () 513 ()
225} 514}
226 515

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines