MOVED to OpenKinect
[libfreenect.git] / README.txt
1 Horribly hacky first take at a Kinect Camera driver. Does RGB and Depth.
2
3 main.c implements a simple OpenGL visualization. Hopefully it should be mostly
4 self-explanatory... You pretty much just open the USB device, call
5 cams_init(dev, depthimg, rgbimg), and your depthimg and rgbimg callbacks get
6 called as libusb processes events.
7
8 TODO:
9         - TONS of cleanup. I mean LOTS.
10         - Determine exactly what the inits do
11         - Bayer to RGB conversion that doesn't suck
12         - Integrate support for the servo and accelerometer (which have already been
13           reverse engineered)
14
15 BIG TODO: audio. The audio chip (the Marvell) requires firmware and more init
16 and does a TON of stuff including the crypto authentication to prove that it is
17 an original Kinect and not a clone. Who knows what this thing does to the
18 incoming audio. This should be interesting to look at.
19
20
21 Libfreenect is Copyright (C) 2010  Hector Martin "marcan" <hector@marcansoft.com>
22
23 This code is licensed to you under the terms of the GNU GPL, version 2 or
24 version 3; see:
25  http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
26  http://www.gnu.org/licenses/gpl-3.0.txt
27
28 Credits:
29
30 Adafruit, for providing the USB logs that I used to work out the initialization
31 sequence and data format.
32
33 bushing, for trying to provide USB logs, although he got preempted by Adafruit ;)
34
35 A few other people who provided hints and encouragement along the way, you know
36 who you are!