README.rst

   1 Libgstsparrow
   2 =============
   3
   4 Libgstsparrow is a Gstreamer plug-in that obliterates everything it sees,
   5 replacing it with images of sparrows.
   6
   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.
  14
  15 Exhibition
  16 ==========
  17
  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.
  26
  27 Dependencies
  28 ============
  29
  30 Gstreamer, including dev packages.
  31
  32 OpenCV. On 32 bit x86 it is worth compiling it yourself for the SSE2
  33 speed up.  That comes for free with AMD64.
  34
  35 libjpeg-turbo. http://libjpeg-turbo.virtualgl.org.  In modern distros
  36 it is already the default. In the old days you had to compile it
  37 yourself and possibly symlink ``/usr/lib/libjpeg*`` to their
  38 counterparts in ``/opt/libjpeg-turbo`` (I mean, I did, but I can't
  39 recall whether it was necessary in the end).
  40
  41
  42 Compiling
  43 =========
  44
  45 Try ``make && make test``.  There isn't an ``install`` target.
  46 (``make test`` uses ``gst-launch-0.10 --gst-plugin-path=.``).
  47
  48
  49 Importing images
  50 ================
  51
  52 Before you can show sparrows you need some pictures to show.
  53
  54 There are a couple of python scripts in that will convert video
  55 streams into the correct format.
  56
  57 TODO: provide images, instructions.
  58
  59 Copyright and License
  60 =====================
  61
  62 Copyright 2010 Douglas Bagnall
  63
  64 Portions copyright Gstreamer developers.
  65
  66 Licensed under the Gnu Lesser General Public License Version 2.1 or
  67 greater.  See COPYING for license details.