[ViewVC] Diff of: cvs/rxvt-unicode/src/perl/background

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.33 by root, Thu Jun 7 16:30:58 2012 UTC vs.
Revision 1.42 by root, Sun Jun 10 10:42:19 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
		6	#TODO: once, rootalign
		7
		8	=head1 NAME
		9
6	=head1 background - manage terminal background	10	background - manage terminal background
7		11
8	=head2 SYNOPSIS	12	=head1 SYNOPSIS
9		13
10	rxvt -background-expr 'background expression'	14	urxvt --background-expr 'background expression'
11	-background-border	15	--background-border
12		16
13	=head2 DESCRIPTION	17	=head1 DESCRIPTION
14		18
		19	This extension manages the terminal background by creating a picture that
		20	is behind the text, replacing the normal background colour.
		21
		22	It does so by evaluating a Perl expression that I<calculates> the image on
		23	the fly, for example, by grabbing the root background or loading a file.
		24
		25	While the full power of Perl is available, the operators have been design
		26	to be as simple as possible.
		27
		28	For example, to load an image and scale it to the window size, you would
		29	use:
		30
		31	urxvt --background-expr 'scale load "/path/to/mybg.png"'
		32
		33	Or specified as a X resource:
		34
		35	URxvt.background-expr: scale load "/path/to/mybg.png"
		36
		37	=head1 THEORY OF OPERATION
		38
		39	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
		41	extended as necessary to cover the whole terminal window, and is set as a
		42	background pixmap.
		43
		44	If the image contains an alpha channel, then it will be used as-is in
		45	visuals that support alpha channels (for example, for a compositing
		46	manager). In other visuals, the terminal background colour will be used to
		47	replace any transparency.
		48
		49	When the expression relies, directly or indirectly, on the window size,
		50	position, the root pixmap, or a timer, then it will be remembered. If not,
		51	then it will be removed.
		52
		53	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
		55	pixmap is replaced by another one the root background changes; or when the
		56	timer elapses), then the expression will be evaluated again.
		57
		58	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the
		59	image to the window size, so it relies on the window size and will
		60	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
		62	after it's size changes.
		63
		64	=head2 EXPRESSIONS
		65
		66	Expressions are normal Perl expressions, in fact, they are Perl blocks -
		67	which means you could use multiple lines and statements:
		68
		69	again 3600;
		70	if (localtime now)[6]) {
		71	return scale load "$HOME/weekday.png";
		72	} else {
		73	return scale load "$HOME/sunday.png";
		74	}
		75
		76	This expression gets evaluated once per hour. It will set F<sunday.png> as
		77	background on Sundays, and F<weekday.png> on all other days.
		78
		79	Fortunately, we expect that most expressions will be much simpler, with
		80	little Perl knowledge needed.
		81
		82	Basically, you always start with a function that "generates" an image
		83	object, such as C<load>, which loads an image from disk, or C<root>, which
		84	returns the root window background image:
		85
		86	load "$HOME/mypic.png"
		87
		88	The path is usually specified as a quoted string (the exact rules can be
		89	found in the L<perlop> manpage). The F<$HOME> at the beginning of the
		90	string is expanded to the home directory.
		91
		92	Then you prepend one or more modifiers or filtering expressions, such as
		93	C<scale>:
		94
		95	scale load "$HOME/mypic.png"
		96
		97	Just like a mathematical expression with functions, you should read these
		98	expressions from right to left, as the C<load> is evaluated first, and
		99	its result becomes the argument to the C<scale> function.
		100
		101	Many operators also allow some parameters preceding the input image
		102	that modify its behaviour. For example, C<scale> without any additional
		103	arguments scales the image to size of the terminal window. If you specify
		104	an additional argument, it uses it as a percentage:
		105
		106	scale 200, load "$HOME/mypic.png"
		107
		108	This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
		109	has now two arguments, the C<200> and the C<load> expression, while
		110	C<load> only has one argument. Arguments are separated from each other by
		111	commas.
		112
		113	Scale also accepts two arguments, which are then separate factors for both
		114	horizontal and vertical dimensions. For example, this halves the image
		115	width and doubles the image height:
		116
		117	scale 50, 200, load "$HOME/mypic.png"
		118
		119	Other effects than scalign are also readily available, for exmaple, you can
		120	tile the image to fill the whole window, instead of resizing it:
		121
		122	tile load "$HOME/mypic.png"
		123
		124	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator
		125	is kind of superfluous.
		126
		127	Another common effect is to mirror the image, so that the same edges touch:
		128
		129	mirror load "$HOME/mypic.png"
		130
		131	This is also a typical background expression:
		132
		133	rootalign root
		134
		135	It first takes a snapshot of the screen background image, and then
		136	moves it to the upper left corner of the screen - the result is
		137	pseudo-transparency, as the image seems to be static while the window is
		138	moved around.
		139
		140	=head2 CYCLES AND CACHING
		141
		142	As has been mentioned before, the expression might be evaluated multiple
		143	times. Each time the expression is reevaluated, a new cycle is said to
		144	have begun. Many operators cache their results till the next cycle.
		145
		146	For example, the C<load> operator keeps a copy of the image. If it is
		147	asked to load the same image on the next cycle it will not load it again,
		148	but return the cached copy.
		149
		150	This only works for one cycle though, so as long as you load the same
		151	image every time, it will always be cached, but when you load a different
		152	image, it will forget about the first one.
		153
		154	This allows you to either speed things up by keeping multiple images in
		155	memory, or comserve memory by loading images more often.
		156
		157	For example, you can keep two images in memory and use a random one like
		158	this:
		159
		160	my $img1 = load "img1.png";
		161	my $img2 = load "img2.png";
		162	(0.5 > rand) ? $img1 : $img2
		163
		164	Since both images are "loaded" every time the expression is evaluated,
		165	they are always kept in memory. Contrast this version:
		166
		167	my $path1 = "img1.png";
		168	my $path2 = "img2.png";
		169	load ((0.5 > rand) ? $path1 : $path2)
		170
		171	Here, a path is selected randomly, and load is only called for one image,
		172	so keeps only one image in memory. If, on the next evaluation, luck
		173	decides to use the other path, then it will have to load that image again.
		174
15	=head2 REFERENCE	175	=head1 REFERENCE
16		176
17	=cut	177	=head2 COMMAND LINE SWITCHES
18		178
19	our $EXPR;	179	=over 4
20	#$EXPR = 'move W * 0.1, -H * 0.1, resize W * 0.5, H * 0.5, repeat_none load "opensource.png"';
21	$EXPR = 'move -TX, -TY, load "argb.png"';
22	#$EXPR = '
23	# rotate W, H, 50, 50, counter 1/59.95, repeat_mirror,
24	# clip X, Y, W, H, repeat_mirror,
25	# load "/root/pix/das_fette_schwein.jpg"
26	#';
27	#$EXPR = 'solid "red"';
28	#$EXPR = 'blur root, 10, 10'
29	#$EXPR = 'blur move (root, -x, -y), 5, 5'
30	#resize load "/root/pix/das_fette_schwein.jpg", w, h
31		180
		181	=item --background-expr perl-expression
		182
		183	Specifies the Perl expression to evaluate.
		184
		185	=item --background-border
		186
		187	By default, the expression creates an image that fills the full window,
		188	overwriting borders and any other areas, such as the scrollbar.
		189
		190	Specifying this flag changes the behaviour, so that the image only
		191	replaces the background of the character area.
		192
		193	=back
		194
		195	=cut
		196
		197	our $HOME;
32	our ($self, $old, $new);	198	our ($self, $old, $new);
33	our ($x, $y, $w, $h);	199	our ($x, $y, $w, $h);
34		200
35	# enforce at least this interval between updates	201	# enforce at least this interval between updates
36	our $MIN_INTERVAL = 1/100;	202	our $MIN_INTERVAL = 1/100;
81	=item solid $width, $height, $colour	247	=item solid $width, $height, $colour
82		248
83	Creates a new image and completely fills it with the given colour. The	249	Creates a new image and completely fills it with the given colour. The
84	image is set to tiling mode.	250	image is set to tiling mode.
85		251
86	If <$width> and C<$height> are omitted, it creates a 1x1 image, which is	252	If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is
87	useful for solid backgrounds or for use in filtering effects.	253	useful for solid backgrounds or for use in filtering effects.
88		254
89	=cut	255	=cut
90		256
91	sub solid($$;$) {	257	sub solid($;$$) {
92	my $colour = pop;	258	my $colour = pop;
93		259
94	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	260	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);
95	$img->fill ($colour);	261	$img->fill ($colour);
96	$img	262	$img
…		…
98		264
99	=back	265	=back
100		266
101	=head2 VARIABLES	267	=head2 VARIABLES
102		268
103	The following functions provide variable data such as the terminal	269	The following functions provide variable data such as the terminal window
		270	dimensions. They are not (Perl-) variables, they jsut return stuff that
104	window dimensions. Most of them make your expression sensitive to some	271	varies. Most of them make your expression sensitive to some events, for
105	events, for example using C<TW> (terminal width) means your expression is	272	example using C<TW> (terminal width) means your expression is evaluated
106	evaluated again when the terminal is resized.	273	again when the terminal is resized.
107		274
108	=over 4	275	=over 4
109		276
110	=item TX	277	=item TX
111		278
…		…
158		325
159	When this function is used the expression will be reevaluated again in	326	When this function is used the expression will be reevaluated again in
160	C<$seconds> seconds.	327	C<$seconds> seconds.
161		328
162	Example: load some image and rotate it according to the time of day (as if it were	329	Example: load some image and rotate it according to the time of day (as if it were
163	the hour pointer of a clock). update this image every minute.	330	the hour pointer of a clock). Update this image every minute.
164		331
165	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	332	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
166		333
167	=item counter $seconds	334	=item counter $seconds
168		335
…		…
193		360
194	=item tile $img	361	=item tile $img
195		362
196	Tiles the whole plane with the image and returns this new image - or in	363	Tiles the whole plane with the image and returns this new image - or in
197	other words, it returns a copy of the image in plane tiling mode.	364	other words, it returns a copy of the image in plane tiling mode.
		365
		366	Example: load an image and tile it over the background, without
		367	resizing. The C<tile> call is superfluous because C<load> already defaults
		368	to tiling mode.
		369
		370	tile load "mybg.png"
198		371
199	=item mirror $img	372	=item mirror $img
200		373
201	Similar to tile, but reflects the image each time it uses a new copy, so	374	Similar to tile, but reflects the image each time it uses a new copy, so
202	that top edges always touch top edges, right edges always touch right	375	that top edges always touch top edges, right edges always touch right
203	edges and so on (with normal tiling, left edges always touch right edges	376	edges and so on (with normal tiling, left edges always touch right edges
204	and top always touch bottom edges).	377	and top always touch bottom edges).
205		378
		379	Example: load an image and mirror it over the background, avoiding sharp
		380	edges at the image borders at the expense of mirroring the image itself
		381
		382	mirror load "mybg.png"
		383
206	=item pad $img	384	=item pad $img
207		385
208	Takes an image and modifies it so that all pixels outside the image area	386	Takes an image and modifies it so that all pixels outside the image area
209	become transparent. This mode is most useful when you want to place an	387	become transparent. This mode is most useful when you want to place an
210	image over another image or the background colour while leaving all	388	image over another image or the background colour while leaving all
211	background pixels outside the image unchanged.	389	background pixels outside the image unchanged.
212		390
		391	Example: load an image and display it in the upper left corner. The rest
		392	of the space is left "empty" (transparent or wahtever your compisotr does
		393	in alpha mode, else background colour).
		394
		395	pad load "mybg.png"
		396
213	=item extend $img	397	=item extend $img
214		398
215	Extends the image over the whole plane, using the closest pixel in the	399	Extends the image over the whole plane, using the closest pixel in the
216	area outside the image. This mode is mostly useful when you more complex	400	area outside the image. This mode is mostly useful when you more complex
217	filtering operations and want the pixels outside the image to have the	401	filtering operations and want the pixels outside the image to have the
218	same values as the pixels near the edge.	402	same values as the pixels near the edge.
		403
		404	Example: just for curiosity, how does this pixel extension stuff work?
		405
		406	extend move 50, 50, load "mybg.png"
219		407
220	=cut	408	=cut
221		409
222	sub pad($) {	410	sub pad($) {
223	my $img = $_[0]->clone;	411	my $img = $_[0]->clone;
…		…
324	sub resize($$$) {	512	sub resize($$$) {
325	my $img = pop;	513	my $img = pop;
326	$img->scale ($_[0], $_[1])	514	$img->scale ($_[0], $_[1])
327	}	515	}
328		516
		517	=item move $dx, $dy, $img
		518
		519	Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
		520	the vertical.
		521
		522	Example: move the image right by 20 pixels and down by 30.
		523
		524	move 20, 30, ...
		525
		526	=item rootalign $img
		527
		528	Moves the image so that it appears glued to the screen as opposed to the
		529	window. This gives the illusion of a larger area behind the window. It is
		530	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
		531	top left of the screen.
		532
		533	Example: load a background image, put it in mirror mode and root align it.
		534
		535	rootalign mirror load "mybg.png"
		536
		537	Example: take the screen background and align it, giving the illusion of
		538	transparency as long as the window isn't in front of other windows.
		539
		540	rootalign root
		541
		542	=cut
		543
329	sub move($$;$) {	544	sub move($$;$) {
330	my $img = pop->clone;	545	my $img = pop->clone;
331	$img->move ($_[0], $_[1]);	546	$img->move ($_[0], $_[1]);
332	$img	547	$img
333	}	548	}
		549
		550	sub rootalign($) {
		551	move -TX, -TY, $_[0]
		552	}
		553
		554	=item contrast $factor, $img
		555
		556	=item contrast $r, $g, $b, $img
		557
		558	=item contrast $r, $g, $b, $a, $img
		559
		560	Adjusts the I<contrast> of an image.
		561
		562	#TODO#
		563
		564	=item brightness $factor, $img
		565
		566	=item brightness $r, $g, $b, $img
		567
		568	=item brightness $r, $g, $b, $a, $img
		569
		570	Adjusts the brightness of an image.
		571
		572	=cut
		573
		574	sub contrast($$;$$;$) {
		575	my $img = pop;
		576	my ($r, $g, $b, $a) = @_;
		577
		578	($g, $b) = ($r, $r) if @_ < 4;
		579	$a = 1 if @_ < 5;
		580
		581	$img = $img->clone;
		582	$img->contrast ($r, $g, $b, $a);
		583	$img
		584	}
		585
		586	sub brightness($$;$$;$) {
		587	my $img = pop;
		588	my ($r, $g, $b, $a) = @_;
		589
		590	($g, $b) = ($r, $r) if @_ < 4;
		591	$a = 1 if @_ < 5;
		592
		593	$img = $img->clone;
		594	$img->brightness ($r, $g, $b, $a);
		595	$img
		596	}
		597
		598	=item blur $radius, $img
		599
		600	=item blur $radius_horz, $radius_vert, $img
		601
		602	Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii
		603	can also be specified separately.
		604
		605	Blurring is often I<very> slow, at least compared or other
		606	operators. Larger blur radii are slower than smaller ones, too, so if you
		607	don't want to freeze your screen for long times, start experimenting with
		608	low values for radius (<5).
		609
		610	=cut
		611
		612	sub blur($$;$) {
		613	my $img = pop;
		614	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
		615	}
		616
		617	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees
		618
		619	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		620	pointer at C<$center_x> and C<$center_y> (specified as percentage of image
		621	width/height), generating a new image with width C<$new_width> and height
		622	C<$new_height>.
		623
		624	#TODO# new width, height, maybe more operators?
		625
		626	Example: rotate the image by 90 degrees
		627
		628	=cut
334		629
335	sub rotate($$$$$$) {	630	sub rotate($$$$$$) {
336	my $img = pop;	631	my $img = pop;
337	$img->rotate (	632	$img->rotate (
338	$_[0],	633	$_[0],
…		…
341	$_[3] * $img->h * .01,	636	$_[3] * $img->h * .01,
342	$_[4] * (3.14159265 / 180),	637	$_[4] * (3.14159265 / 180),
343	)	638	)
344	}	639	}
345		640
346	sub blur($$;$) {
347	my $img = pop;
348	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
349	}
350
351	sub contrast($$;$$;$) {
352	my $img = pop;
353	my ($r, $g, $b, $a) = @_;
354
355	($g, $b) = ($r, $r) if @_ < 4;
356	$a = 1 if @_ < 5;
357
358	$img = $img->clone;
359	$img->contrast ($r, $g, $b, $a);
360	$img
361	}
362
363	sub brightness($$;$$;$) {
364	my $img = pop;
365	my ($r, $g, $b, $a) = @_;
366
367	($g, $b) = ($r, $r) if @_ < 4;
368	$a = 1 if @_ < 5;
369
370	$img = $img->clone;
371	$img->brightness ($r, $g, $b, $a);
372	$img
373	}
374
375	=back	641	=back
376		642
377	=cut	643	=cut
378		644
379	}	645	}
…		…
409		675
410	# set environment to evaluate user expression	676	# set environment to evaluate user expression
411		677
412	local $self = $arg_self;	678	local $self = $arg_self;
413		679
		680	local $HOME = $ENV{HOME};
414	local $old = $self->{state};	681	local $old = $self->{state};
415	local $new = my $state = $self->{state} = {};	682	local $new = my $state = $self->{state} = {};
416		683
417	($x, $y, $w, $h) =	684	($x, $y, $w, $h) =
418	$self->background_geometry ($self->{border});	685	$self->background_geometry ($self->{border});
…		…
421		688
422	my $img = eval { $self->{expr}->() };	689	my $img = eval { $self->{expr}->() };
423	warn $@ if $@;#d#	690	warn $@ if $@;#d#
424	die if !UNIVERSAL::isa $img, "urxvt::img";	691	die if !UNIVERSAL::isa $img, "urxvt::img";
425		692
		693	$state->{size_sensitive} = 1
		694	if $img->repeat_mode != urxvt::RepeatNormal;
		695
426	# if the expression is sensitive to external events, prepare reevaluation then	696	# if the expression is sensitive to external events, prepare reevaluation then
427		697
428	my $repeat;	698	my $repeat;
429		699
430	if (my $again = $state->{again}) {	700	if (my $again = $state->{again}) {
431	$repeat = 1;	701	$repeat = 1;
		702	my $self = $self;
432	$state->{timer} = $again == $old->{again}	703	$state->{timer} = $again == $old->{again}
433	? $old->{timer}	704	? $old->{timer}
434	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	705	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
435	++$self->{counter};	706	++$self->{counter};
436	$self->recalculate	707	$self->recalculate
…		…
465	unless ($repeat) {	736	unless ($repeat) {
466	delete $self->{state};	737	delete $self->{state};
467	delete $self->{expr};	738	delete $self->{expr};
468	}	739	}
469		740
470	# prepare and set background pixmap	741	# set background pixmap
471
472	$img = $img->sub_rect (0, 0, $w, $h)
473	if $img->w != $w \|\| $img->h != $h;
474		742
475	$self->set_background ($img, $self->{border});	743	$self->set_background ($img, $self->{border});
476	$self->scr_recolour (0);	744	$self->scr_recolour (0);
477	$self->want_refresh;	745	$self->want_refresh;
478	}	746	}

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.33 by root, Thu Jun 7 16:30:58 2012 UTC vs. Revision 1.42 by root, Sun Jun 10 10:42:19 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.33 by root, Thu Jun 7 16:30:58 2012 UTC vs.
Revision 1.42 by root, Sun Jun 10 10:42:19 2012 UTC