gitignore ignorable gtksparrow executable
[sparrow.git] / README
blob4615d34fa3cb9e8ba6b97433af8e3e84a03a41e4
1 Libgstsparrow
2 =============
4 Libgstsparrow  is a Gstreamer plug-in that obliterates everything it sees,
5 replacing it with images of sparrows.
7 It is designed to be used with a camera and projector pointed at the
8 same wall.  After a calibration phase, it will project a negative
9 image of whatever is visible but not wanted on the wall.  The
10 combination of the original and negative images is a flat grey, and
11 images of sparrows are superimposed on this by adding or subtracting
12 from the projected negative. It works reasonably well for most images
13 on flat surfaces.
15 Exhibition
16 ==========
18 The plug-in was made for an artwork first exhibited at the Dowse Art
19 Gallery in Lower Hutt, NZ, in June 2010.  It consists of two of these
20 plugins, each with its own projector, competing for control of a
21 single screen.  Each projection works to cancel out the other, and the
22 resultant complex feedback loops make for occasionally interesting
23 video.  People can disrupt the flow of the work by moving in front of
24 the projectors and camera, the aftereffects of which can last for
25 several seconds.
27 Dependencies
28 ============
30 Gstreamer, including dev packages.
32 OpenCV. On 32 bit x86 it is worth compiling it yourself for the SSE2
33 speed up.  That comes for free with AMD64.
35 libjpeg-turbo. http://libjpeg-turbo.virtualgl.org.  You might need to
36 symlink /usr/lib/libjpeg* to their counterparts in /opt/libjpeg-turbo
37 (I mean, I did, but I can't recall whether it was necessary in the
38 end).
41 Compiling
42 =========
44 Try `make && make test`.  There isn't an "install" target.
45 (`make test` uses "gst-launch-0.10 --gst-plugin-path=.").
48 Importing images
49 ================
51 Before you can show sparrows you need some pictures to show.
53 There are a couple of python scripts in that will convert video
54 streams into the correct format.
56 TODO: provide images, instructions.
58 Copyright and License
59 =====================
61 Copyright 2010 Douglas Bagnall
63 Portions copyright Gstreamer developers.
65 Licensed under the Gnu Lesser General Public License Version 2.1 or
66 greater.  See COPYING for license details.