Skip to content
This repository

OSCeleton is a proxy that sends skeleton information collected from the kinect sensor via OSC, making it easier to use input from the device in any language / framework that supports the OSC protocol.

branch: master
README.md

OSCeleton

What is this?

As the title says, it's just a small program that takes kinect skeleton data from the OpenNI framework and spits out the coordinates of the skeleton's joints via OSC messages. These can can then be used on your language / framework of choice.

How do I use it?

First you need to install the OpenNI driver, framework, and

middleware

Windows / Linux / Mac OSX

Get avin's hacked Primesense PSDK driver for kinect: https://github.com/avin2/SensorKinect Folow his instructions for installing the OpenNI framwork, the driver, and the NITE middleware.

After OpenNI / NITE is working

Then you can run one of the precompiled binaries in the "bin" directory or compile your own:

on Linux or Mac OSX: make

NOTE FOR MAC USERS: You must run OSCeleton from the terminal or it will not run correctly.

on windows: you can use the precompiled binary in bin\win32 or use the VC++ express .sln file.

If you run the executable without any arguments, it will send the OSC messagens in the default format to localhost on port 7110. To learn about the OSC message format, continue reading below or check out our processing examples at https://github.com/Sensebloom/OSCeleton-examples

Other stuff

Another fun way to test OSCeleton is to use the awesome animata skeletal animation software by the Kitchen Budapest guys. You can get it at: http://animata.kibu.hu/

Animata needs its OSC messages in a very specific format, so you must use the "-k" ("kitchen" mode) option. Multiplying the x and y coordinates and adding some offsets can also be useful to tune the size of the skeleton, try running it like this: OSCeleton.exe -k -mx 640 -my 480 -ox -160

If your animation is going crazy try to play with -mx and -my values, and -ox and -oy values a bit.

To get a complete list of available options run OSCeleton -h.

OSC Message format

New user detected - no skeleton available yet. This is a good time

for you to ask the user to do the calibration pose:

Address pattern: "/new_user"
Type tag: "i"
i: A numeric ID attributed to the new user.

New skeleton detected - The calibration was finished successfully,

joint coordinate messages for this user will be incoming soon ;):

Address pattern: "/new_skel"
Type tag: "i"
i: ID of the user whose skeleton is detected.

Lost user - we have lost the user with the following id:

Address pattern: "/lost_user"
Type tag: "i"
i: The ID of the lost user. (This ID will be free for reuse from now 

on)

Joint message - message with the coordinates of each skeleton joint:

Address pattern: "/joint"
Type tag: "sifff"
s: Joint name, check out the full list of joints below.
i: The ID of the user.
f: X coordinate of joint in interval [0.0, 1.0]
f: Y coordinate of joint in interval [0.0, 1.0]
f: Z coordinate of joint in interval [0.0, 7.0]

NOTE: Kitchen mode

To send OSC messages compatible with the awesome animata skeletal animation software use the "-k" option. The messages will have the following format: Address pattern: "/joint" Type tag: "sff" s: joint name concatenated with user id (ex: "l_shoulder0") f: X coordinate of joint in interval [0.0, 1.0] f: Y coordinate of joint in interval [0.0, 1.0] In this mode new_user, new_skel and lost_user messages will not be sent.

NOTE: Quartz Composer mode

You can enable a message format that is more friendly to Quartz composer with the "-q" option. The messages will have the following format: Address pattern: "/joint/name/id" Type tag: "fff" f: X coordinate of joint in interval [0.0, 1.0] f: Y coordinate of joint in interval [0.0, 1.0] f: Z coordinate of joint in interval [0.0, 7.0] Example (left knee of user 3): /joint/l_knee/3 0.08823146 0.5761504 0.44253197

Full list of joints

  • head
  • neck
  • torso

  • r_collar #not working yet

  • r_shoulder
  • r_elbow
  • r_wrist #not working yet
  • r_hand
  • r_finger #not working yet

  • l_collar #not working yet

  • l_shoulder
  • l_elbow
  • l_wrist #not working yet
  • l_hand
  • l_finger #not working yet

  • r_hip

  • r_knee
  • r_ankle
  • r_foot

  • l_hip

  • l_knee
  • l_ankle
  • l_foot

Other

For feature request, reporting bugs, or general osceleton

discussion, come join the fun in our google group!

Have fun!

OSCeleton-Puppet

This is a fork of OSCeleton that adds a number of hacks for a specific project.

Checkout https://github.com/Sensebloom/OSCeleton for more information

New options

OSCeleton-Puppet adds a number of new command line options all starrting with -x.

-xr

This option outputs the X,Y & Z data as "raw" kinect values

-xt

This option outputs the joint rotation data. Address pattern: "/orient" Type tag: "sifffffffff" s: Joint name, check out the full list of joints below. i: The ID of the user. f f f: X axis orientation data f f f : Y axis orientation data f f f : Z axis orientation data

or if in Quartz Composer mode:

Address pattern: "/joint/name/id"
Type tag: "fffffffff"
f f f: X axis orientation data
f f f : Y axis orientation data
f f f : Z axis orientation data

Example (torso of user 4): /orient/torso/4 0.938792 -0.0774589 0.335662 0.0649184 0.996714 0.0484401 -0.338311 -0.0236846 0.940736

-xd

Runs the program with a number of options enabled by default: -xr -xt -p -w -r

Something went wrong with that request. Please try again.