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.45 by root, Sun Jun 10 11:53:32 2012 UTC vs.
Revision 1.55 by root, Thu Jun 14 16:48:57 2012 UTC

1#! perl 1#! perl
2 2
3#:META:X_RESOURCE:%.expr:string:background expression 3#:META:X_RESOURCE:%.expr:string:background expression
4#:META:X_RESOURCE:%.border.:boolean:respect the terminal border 4#:META:X_RESOURCE:%.border:boolean:respect the terminal border
5 5#:META:X_RESOURCE:%.interval:seconds:minimum time between updates
6#TODO: once, rootalign
7 6
8=head1 NAME 7=head1 NAME
9 8
10 background - manage terminal background 9 background - manage terminal background
11 10
12=head1 SYNOPSIS 11=head1 SYNOPSIS
13 12
14 urxvt --background-expr 'background expression' 13 urxvt --background-expr 'background expression'
15 --background-border 14 --background-border
15 --background-interval seconds
16 16
17=head1 DESCRIPTION 17=head1 DESCRIPTION
18 18
19This extension manages the terminal background by creating a picture that 19This extension manages the terminal background by creating a picture that
20is behind the text, replacing the normal background colour. 20is behind the text, replacing the normal background colour.
57 57
58For example, an expression such as C<scale load "$HOME/mybg.png"> scales the 58For example, an expression such as C<scale load "$HOME/mybg.png"> scales the
59image to the window size, so it relies on the window size and will 59image to the window size, so it relies on the window size and will
60be reevaluated each time it is changed, but not when it moves for 60be reevaluated each time it is changed, but not when it moves for
61example. That ensures that the picture always fills the terminal, even 61example. That ensures that the picture always fills the terminal, even
62after it's size changes. 62after its size changes.
63 63
64=head2 EXPRESSIONS 64=head2 EXPRESSIONS
65 65
66Expressions are normal Perl expressions, in fact, they are Perl blocks - 66Expressions are normal Perl expressions, in fact, they are Perl blocks -
67which means you could use multiple lines and statements: 67which means you could use multiple lines and statements:
71 return scale load "$HOME/weekday.png"; 71 return scale load "$HOME/weekday.png";
72 } else { 72 } else {
73 return scale load "$HOME/sunday.png"; 73 return scale load "$HOME/sunday.png";
74 } 74 }
75 75
76This expression gets evaluated once per hour. It will set F<sunday.png> as 76This expression is evaluated once per hour. It will set F<sunday.png> as
77background on Sundays, and F<weekday.png> on all other days. 77background on Sundays, and F<weekday.png> on all other days.
78 78
79Fortunately, we expect that most expressions will be much simpler, with 79Fortunately, we expect that most expressions will be much simpler, with
80little Perl knowledge needed. 80little Perl knowledge needed.
81 81
115horizontal and vertical dimensions. For example, this halves the image 115horizontal and vertical dimensions. For example, this halves the image
116width and doubles the image height: 116width and doubles the image height:
117 117
118 scale 0.5, 2, load "$HOME/mypic.png" 118 scale 0.5, 2, load "$HOME/mypic.png"
119 119
120Other effects than scalign are also readily available, for exmaple, you can 120Other effects than scaling are also readily available, for example, you can
121tile the image to fill the whole window, instead of resizing it: 121tile the image to fill the whole window, instead of resizing it:
122 122
123 tile load "$HOME/mypic.png" 123 tile load "$HOME/mypic.png"
124 124
125In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator 125In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator
151This only works for one cycle though, so as long as you load the same 151This only works for one cycle though, so as long as you load the same
152image every time, it will always be cached, but when you load a different 152image every time, it will always be cached, but when you load a different
153image, it will forget about the first one. 153image, it will forget about the first one.
154 154
155This allows you to either speed things up by keeping multiple images in 155This allows you to either speed things up by keeping multiple images in
156memory, or comserve memory by loading images more often. 156memory, or conserve memory by loading images more often.
157 157
158For example, you can keep two images in memory and use a random one like 158For example, you can keep two images in memory and use a random one like
159this: 159this:
160 160
161 my $img1 = load "img1.png"; 161 my $img1 = load "img1.png";
189overwriting borders and any other areas, such as the scrollbar. 189overwriting borders and any other areas, such as the scrollbar.
190 190
191Specifying this flag changes the behaviour, so that the image only 191Specifying this flag changes the behaviour, so that the image only
192replaces the background of the character area. 192replaces the background of the character area.
193 193
194=item --background-interval seconds
195
196Since some operations in the underlying XRender extension can effectively
197freeze your X-server for prolonged time, this extension enforces a minimum
198time between updates, which is normally about 0.1 seconds.
199
200If you want to do updates more often, you can decrease this safety
201interval with this switch.
202
194=back 203=back
195 204
196=cut 205=cut
197 206
207our %_IMG_CACHE;
198our $HOME; 208our $HOME;
199our ($self, $old, $new); 209our ($self, $old, $new);
200our ($x, $y, $w, $h); 210our ($x, $y, $w, $h);
201 211
202# enforce at least this interval between updates 212# enforce at least this interval between updates
203our $MIN_INTERVAL = 1/100; 213our $MIN_INTERVAL = 6/59.951;
204 214
205{ 215{
206 package urxvt::bgdsl; # background language 216 package urxvt::bgdsl; # background language
207 217
208 use List::Util qw(min max sum shuffle); 218 use List::Util qw(min max sum shuffle);
218=item load $path 228=item load $path
219 229
220Loads the image at the given C<$path>. The image is set to plane tiling 230Loads the image at the given C<$path>. The image is set to plane tiling
221mode. 231mode.
222 232
223Loaded images will be cached for one cycle. 233Loaded images will be cached for one cycle, and shared between temrinals
234running in the same process (e.g. in C<urxvtd>).
224 235
236=item load_uc $path
237
238Load uncached - same as load, but does not cache the image. This function
239is most useufl if you want to optimise a background expression in some
240way.
241
225=cut 242=cut
243
244 sub load_uc($) {
245 my ($path) = @_;
246
247 $_IMG_CACHE{$path} || do {
248 my $img = $self->new_img_from_file ($path);
249 Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
250 $img
251 }
252 }
226 253
227 sub load($) { 254 sub load($) {
228 my ($path) = @_; 255 my ($path) = @_;
229 256
230 $new->{load}{$path} = $old->{load}{$path} || $self->new_img_from_file ($path); 257 $new->{load}{$path} = $old->{load}{$path} || load_uc $path;
231 } 258 }
232 259
233=item root 260=item root
234 261
235Returns the root window pixmap, that is, hopefully, the background image 262Returns the root window pixmap, that is, hopefully, the background image
239reevaluated when the bg image changes. 266reevaluated when the bg image changes.
240 267
241=cut 268=cut
242 269
243 sub root() { 270 sub root() {
244 $new->{rootpmap_sensitive} = 1; 271 $new->{again}{rootpmap} = 1;
245 die "root op not supported, exg, we need you"; 272 $self->new_img_from_root
246 } 273 }
247 274
248=item solid $colour 275=item solid $colour
249 276
250=item solid $width, $height, $colour 277=item solid $width, $height, $colour
273=cut 300=cut
274 301
275 sub clone($) { 302 sub clone($) {
276 $_[0]->clone 303 $_[0]->clone
277 } 304 }
278
279=back
280 305
281=head2 TILING MODES 306=head2 TILING MODES
282 307
283The following operators modify the tiling mode of an image, that is, the 308The following operators modify the tiling mode of an image, that is, the
284way that pixels outside the image area are painted when the image is used. 309way that pixels outside the image area are painted when the image is used.
314become transparent. This mode is most useful when you want to place an 339become transparent. This mode is most useful when you want to place an
315image over another image or the background colour while leaving all 340image over another image or the background colour while leaving all
316background pixels outside the image unchanged. 341background pixels outside the image unchanged.
317 342
318Example: load an image and display it in the upper left corner. The rest 343Example: load an image and display it in the upper left corner. The rest
319of the space is left "empty" (transparent or wahtever your compisotr does 344of the space is left "empty" (transparent or whatever your compositor does
320in alpha mode, else background colour). 345in alpha mode, else background colour).
321 346
322 pad load "mybg.png" 347 pad load "mybg.png"
323 348
324=item extend $img 349=item extend $img
325 350
326Extends the image over the whole plane, using the closest pixel in the 351Extends the image over the whole plane, using the closest pixel in the
327area outside the image. This mode is mostly useful when you more complex 352area outside the image. This mode is mostly useful when you use more complex
328filtering operations and want the pixels outside the image to have the 353filtering operations and want the pixels outside the image to have the
329same values as the pixels near the edge. 354same values as the pixels near the edge.
330 355
331Example: just for curiosity, how does this pixel extension stuff work? 356Example: just for curiosity, how does this pixel extension stuff work?
332 357
399the window size to conserve memory. 424the window size to conserve memory.
400 425
401Example: take the screen background, clip it to the window size, blur it a 426Example: take the screen background, clip it to the window size, blur it a
402bit, align it to the window position and use it as background. 427bit, align it to the window position and use it as background.
403 428
404 clip move -TX, -TY, blur 5, root 429 clip move -TX, -TY, once { blur 5, root }
405 430
406=cut 431=cut
407 432
408 sub TX() { $new->{position_sensitive} = 1; $x } 433 sub TX() { $new->{again}{position} = 1; $x }
409 sub TY() { $new->{position_sensitive} = 1; $y } 434 sub TY() { $new->{again}{position} = 1; $y }
410 sub TW() { $new->{size_sensitive} = 1; $w } 435 sub TW() { $new->{again}{size} = 1; $w }
411 sub TH() { $new->{size_sensitive} = 1; $h } 436 sub TH() { $new->{again}{size} = 1; $h }
412 437
413=item now 438=item now
414 439
415Returns the current time as (fractional) seconds since the epoch. 440Returns the current time as (fractional) seconds since the epoch.
416 441
423C<$seconds> seconds. 448C<$seconds> seconds.
424 449
425Example: load some image and rotate it according to the time of day (as if it were 450Example: load some image and rotate it according to the time of day (as if it were
426the hour pointer of a clock). Update this image every minute. 451the hour pointer of a clock). Update this image every minute.
427 452
428 again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" 453 again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
429 454
430=item counter $seconds 455=item counter $seconds
431 456
432Like C<again>, but also returns an increasing counter value, starting at 457Like C<again>, but also returns an increasing counter value, starting at
4330, which might be useful for some simple animation effects. 4580, which might be useful for some simple animation effects.
435=cut 460=cut
436 461
437 sub now() { urxvt::NOW } 462 sub now() { urxvt::NOW }
438 463
439 sub again($) { 464 sub again($) {
440 $new->{again} = $_[0]; 465 $new->{again}{time} = $_[0];
441 } 466 }
442 467
443 sub counter($) { 468 sub counter($) {
444 $new->{again} = $_[0]; 469 $new->{again}{time} = $_[0];
445 $self->{counter} + 0 470 $self->{counter} + 0
446 } 471 }
447 472
448=back 473=back
449 474
553 578
554Example: move the image right by 20 pixels and down by 30. 579Example: move the image right by 20 pixels and down by 30.
555 580
556 move 20, 30, ... 581 move 20, 30, ...
557 582
583=item align $xalign, $yalign, $img
584
585Aligns the image according to a factor - C<0> means the image is moved to
586the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is
587exactly centered and C<1> means it touches the right or bottom edge.
588
589Example: remove any visible border around an image, center it vertically but move
590it to the right hand side.
591
592 align 1, 0.5, pad $img
593
558=item center $img 594=item center $img
559 595
560=item center $width, $height, $img 596=item center $width, $height, $img
561 597
562Centers the image, i.e. the center of the image is moved to the center of 598Centers the image, i.e. the center of the image is moved to the center of
563the terminal window (or the box specified by C<$width> and C<$height> if 599the terminal window (or the box specified by C<$width> and C<$height> if
564given). 600given).
601
602Example: load an image and center it.
603
604 center pad load "mybg.png"
565 605
566=item rootalign $img 606=item rootalign $img
567 607
568Moves the image so that it appears glued to the screen as opposed to the 608Moves the image so that it appears glued to the screen as opposed to the
569window. This gives the illusion of a larger area behind the window. It is 609window. This gives the illusion of a larger area behind the window. It is
575 rootalign mirror load "mybg.png" 615 rootalign mirror load "mybg.png"
576 616
577Example: take the screen background and align it, giving the illusion of 617Example: take the screen background and align it, giving the illusion of
578transparency as long as the window isn't in front of other windows. 618transparency as long as the window isn't in front of other windows.
579 619
580 rootalign root 620 rootalign root
581 621
582=cut 622=cut
583 623
584 sub move($$;$) { 624 sub move($$;$) {
585 my $img = pop->clone; 625 my $img = pop->clone;
586 $img->move ($_[0], $_[1]); 626 $img->move ($_[0], $_[1]);
587 $img 627 $img
588 } 628 }
589 629
630 sub align($;$$) {
631 my $img = pop;
632
633 move $_[0] * (TW - $img->w),
634 $_[1] * (TH - $img->h),
635 $img
636 }
637
590 sub center($;$$) { 638 sub center($;$$) {
591 my $img = pop; 639 my $img = pop;
592 my $w = $_[0] || TW; 640 my $w = $_[0] || TW;
593 my $h = $_[0] || TH; 641 my $h = $_[1] || TH;
594 642
595 move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img 643 move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
596 } 644 }
597 645
598 sub rootalign($) { 646 sub rootalign($) {
599 move -TX, -TY, $_[0] 647 move -TX, -TY, $_[0]
648 }
649
650=item rotate $center_x, $center_y, $degrees
651
652Rotates the image by C<$degrees> degrees, counter-clockwise, around the
653pointer at C<$center_x> and C<$center_y> (specified as factor of image
654width/height).
655
656#TODO# new width, height, maybe more operators?
657
658Example: rotate the image by 90 degrees
659
660=cut
661
662 sub rotate($$$$) {
663 my $img = pop;
664 $img->rotate (
665 $_[0] * $img->w,
666 $_[1] * $img->h,
667 $_[2] * (3.14159265 / 180),
668 )
600 } 669 }
601 670
602=back 671=back
603 672
604=head2 COLOUR MODIFICATIONS 673=head2 COLOUR MODIFICATIONS
640 709
641Values less than 0 reduce brightness, while values larger than 0 increase 710Values less than 0 reduce brightness, while values larger than 0 increase
642it. Useful range is from -1 to 1 - the former results in a black, the 711it. Useful range is from -1 to 1 - the former results in a black, the
643latter in a white picture. 712latter in a white picture.
644 713
645Due to idiosynchrasies in the underlying XRender extension, biases less 714Due to idiosyncrasies in the underlying XRender extension, biases less
646than zero can be I<very> slow. 715than zero can be I<very> slow.
647 716
648=cut 717=cut
649 718
650 sub contrast($$;$$;$) { 719 sub contrast($$;$$;$) {
651 my $img = pop; 720 my $img = pop;
652 my ($r, $g, $b, $a) = @_; 721 my ($r, $g, $b, $a) = @_;
653 722
654 ($g, $b) = ($r, $r) if @_ < 4; 723 ($g, $b) = ($r, $r) if @_ < 3;
655 $a = 1 if @_ < 5; 724 $a = 1 if @_ < 4;
656 725
657 $img = $img->clone; 726 $img = $img->clone;
658 $img->contrast ($r, $g, $b, $a); 727 $img->contrast ($r, $g, $b, $a);
659 $img 728 $img
660 } 729 }
661 730
662 sub brightness($$;$$;$) { 731 sub brightness($$;$$;$) {
663 my $img = pop; 732 my $img = pop;
664 my ($r, $g, $b, $a) = @_; 733 my ($r, $g, $b, $a) = @_;
665 734
666 ($g, $b) = ($r, $r) if @_ < 4; 735 ($g, $b) = ($r, $r) if @_ < 3;
667 $a = 1 if @_ < 5; 736 $a = 1 if @_ < 4;
668 737
669 $img = $img->clone; 738 $img = $img->clone;
670 $img->brightness ($r, $g, $b, $a); 739 $img->brightness ($r, $g, $b, $a);
671 $img 740 $img
672 } 741 }
688 sub blur($$;$) { 757 sub blur($$;$) {
689 my $img = pop; 758 my $img = pop;
690 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) 759 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
691 } 760 }
692 761
693=item rotate $new_width, $new_height, $center_x, $center_y, $degrees 762=back
694 763
695Rotates the image by C<$degrees> degrees, counter-clockwise, around the 764=head2 OTHER STUFF
696pointer at C<$center_x> and C<$center_y> (specified as factor of image
697width/height), generating a new image with width C<$new_width> and height
698C<$new_height>.
699 765
700#TODO# new width, height, maybe more operators? 766Anything that didn't fit any of the other categories, even after appliyng
767force and closing our eyes.
701 768
702Example: rotate the image by 90 degrees 769=over 4
703 770
704=cut 771=item once { ... }
705 772
706 sub rotate($$$$$$) { 773This function takes a code block as argument, that is, one or more
707 my $img = pop; 774statements enclosed by braces.
708 $img->rotate ( 775
709 $_[0], 776The trick is that this code block is only evaluated once - future calls
710 $_[1], 777will simply return the original image (yes, it should only be used with
711 $_[2] * $img->w, 778images).
712 $_[3] * $img->h, 779
713 $_[4] * (3.14159265 / 180), 780This can be extremely useful to avoid redoign the same slow operations
781again and again- for example, if your background expression takes the root
782background, blurs it and then root-aligns it it would have to blur the
783root background on every window move or resize.
784
785Putting the blur into a C<once> block will make sure the blur is only done
786once:
787
788 rootlign once { blur 10, root }
789
790This leaves the question of how to force reevaluation of the block, in
791case the root background changes: Right now, all once blocks forget that
792they ahve been executed before each time the root background changes (if
793the expression is sensitive to that) or when C<once_again> is called.
794
795=item once_again
796
797Resets all C<once> block as if they had never been called, i.e. on the
798next call they will be reevaluated again.
799
800=cut
801
802 sub once(&) {
803 my $once = $self->{once_cache}{$_[0]+0} ||= do {
804 local $new->{again};
805 my @res = $_[0]();
806 [$new->{again}, \@res]
714 ) 807 };
808
809 $new->{again} = {
810 %{ $new->{again} },
811 %{ $once->[0] }
812 };
813
814 # in scalar context we always return the first original result, which
815 # is not quite how perl works.
816 wantarray
817 ? @{ $once->[1] }
818 : $once->[1][0]
819 }
820
821 sub once_again() {
822 delete $self->{once_cache};
715 } 823 }
716 824
717=back 825=back
718 826
719=cut 827=cut
762 870
763 # evaluate user expression 871 # evaluate user expression
764 872
765 my $img = eval { $self->{expr}->() }; 873 my $img = eval { $self->{expr}->() };
766 warn $@ if $@;#d# 874 warn $@ if $@;#d#
767 die if !UNIVERSAL::isa $img, "urxvt::img"; 875 die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
768 876
769 $state->{size_sensitive} = 1 877 # if the expression is sensitive to external events, prepare reevaluation then
878
879 my $again = delete $state->{again};
880
881 $again->{size} = 1
770 if $img->repeat_mode != urxvt::RepeatNormal; 882 if $img->repeat_mode != urxvt::RepeatNormal;
771 883
772 # if the expression is sensitive to external events, prepare reevaluation then
773
774 my $repeat;
775
776 if (my $again = $state->{again}) { 884 if (my $again = $again->{time}) {
777 $repeat = 1;
778 my $self = $self; 885 my $self = $self;
779 $state->{timer} = $again == $old->{again} 886 $state->{timer} = $again == $old->{again}
780 ? $old->{timer} 887 ? $old->{timer}
781 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub { 888 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
782 ++$self->{counter}; 889 ++$self->{counter};
783 $self->recalculate 890 $self->recalculate
784 }); 891 });
785 } 892 }
786 893
787 if (delete $state->{position_sensitive}) { 894 if ($again->{position}) {
788 $repeat = 1;
789 $self->enable (position_change => sub { $_[0]->recalculate }); 895 $self->enable (position_change => sub { $_[0]->recalculate });
790 } else { 896 } else {
791 $self->disable ("position_change"); 897 $self->disable ("position_change");
792 } 898 }
793 899
794 if (delete $state->{size_sensitive}) { 900 if ($again->{size}) {
795 $repeat = 1;
796 $self->enable (size_change => sub { $_[0]->recalculate }); 901 $self->enable (size_change => sub { $_[0]->recalculate });
797 } else { 902 } else {
798 $self->disable ("size_change"); 903 $self->disable ("size_change");
799 } 904 }
800 905
801 if (delete $state->{rootpmap_sensitive}) { 906 if ($again->{rootpmap}) {
802 $repeat = 1;
803 $self->enable (rootpmap_change => sub { $_[0]->recalculate }); 907 $self->enable (rootpmap_change => sub {
908 delete $_[0]{once_cache}; # this will override once-block values from
909 $_[0]->recalculate;
910 });
804 } else { 911 } else {
805 $self->disable ("rootpmap_change"); 912 $self->disable ("rootpmap_change");
806 } 913 }
807 914
808 # clear stuff we no longer need 915 # clear stuff we no longer need
809 916
810 %$old = (); 917 %$old = ();
811 918
812 unless ($repeat) { 919 unless (%$again) {
813 delete $self->{state}; 920 delete $self->{state};
814 delete $self->{expr}; 921 delete $self->{expr};
815 } 922 }
816 923
817 # set background pixmap 924 # set background pixmap
822} 929}
823 930
824sub on_start { 931sub on_start {
825 my ($self) = @_; 932 my ($self) = @_;
826 933
827 my $expr = $self->x_resource ("background.expr") 934 my $expr = $self->x_resource ("%.expr")
828 or return; 935 or return;
829 936
937 $self->has_render
938 or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
939
830 $self->set_expr (parse_expr $expr); 940 $self->set_expr (parse_expr $expr);
831 $self->{border} = $self->x_resource_boolean ("background.border"); 941 $self->{border} = $self->x_resource_boolean ("%.border");
942
943 $MIN_INTERVAL = $self->x_resource ("%.interval");
832 944
833 () 945 ()
834} 946}
835 947

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines