README.md

   1 Shairplay
   2 =========
   3 Free portable AirPlay server implementation similar to [ShairPort](https://github.com/abrasive/shairport).
   4
   5 Currently only AirPort Express emulation is supported.
   6
   7 Disclaimer
   8 ----------
   9 All the resources in this repository are written using only freely available
  10 information from the internet. The code and related resources are meant for
  11 educational purposes only. It is the responsibility of the user to make sure
  12 all local laws are adhered to.
  13
  14 Installation
  15 ------------
  16
  17 First you need to install some dependencies, for example on Ubuntu you would
  18 write:
  19 ```
  20 sudo apt-get install autoconf automake libtool
  21 sudo apt-get install libao-dev libavahi-compat-libdnssd-dev
  22 ```
  23
  24 ```
  25 ./autogen.sh
  26 ./configure
  27 make
  28 sudo make install
  29 ```
  30
  31 Notice that libao is required in order to install the shairplay binary,
  32 otherwise only the library is compiled and installed.
  33
  34 Usage
  35 -----
  36
  37 Check available options with ```shairplay --help```:
  38
  39 ```
  40 Usage: shairplay [OPTION...]
  41
  42   -a, --apname=AirPort            Sets Airport name
  43   -p, --password=secret           Sets password
  44   -o, --server_port=5000          Sets port for RAOP service
  45       --ao_driver=driver          Sets the ao driver (optional)
  46       --ao_devicename=devicename  Sets the ao device name (optional)
  47       --ao_deviceid=id            Sets the ao device id (optional)
  48   -h, --help                      This help
  49 ```
  50
  51 Start the server with ```shairplay```, if you are connected to a Wi-Fi the
  52 server should show as an AirPort Express on your iOS devices and Mac OS X
  53 computers in the same network.
  54
  55 Related software
  56 ----------------
  57
  58 * [ShairPort](https://github.com/abrasive/shairport), original AirPort Express emulator
  59 * [ALAC](http://craz.net/programs/itunes/alac.html), ALAC decoder by David Hammerton
  60
  61 Description
  62 -----------
  63
  64 Short description about what each file in the main library does:
  65
  66 ```
  67 src/lib/base64.*         - base64 encoder/decoder
  68 src/lib/dnssd.*          - dnssd helper functions
  69 src/lib/http_parser.*    - HTTP parser from joyent (nginx fork)
  70 src/lib/http_request.*   - Request parser that uses http_parser
  71 src/lib/http_response.*  - Extremely simple HTTP response serializer
  72 src/lib/httpd.*          - Generic HTTP/RTSP server
  73 src/lib/logger.*         - Logging related functions
  74 src/lib/netutils.*       - Mostly socket related code
  75 src/lib/raop.*           - Main RAOP handler, handles all RTSP stuff
  76 src/lib/raop_rtp.*       - Handles the RAOP RTP related stuff (UDP/TCP)
  77 src/lib/raop_buffer.*    - Parses and buffers RAOP packets, resend logic here
  78 src/lib/rsakey.*         - Decrypts and parses the RSA key to bigints
  79 src/lib/rsapem.*         - Converts the RSA PEM key to DER encoded bytes
  80 src/lib/sdp.*            - Extremely simple RAOP specific SDP parser
  81 src/lib/utils.*          - Utils for reading a file and handling strings
  82 ```
  83
  84 Short description about what each file in the Qt application does:
  85
  86 ```
  87 AirTV-Qt/main.cpp                 - Initializes the application
  88 AirTV-Qt/mainapplication.cpp      - Creates the tray icon and starts RAOP
  89 AirTV-Qt/raopservice.cpp          - Handles all communication with the library
  90 AirTV-Qt/raopcallbackhandler.cpp  - Converts C callbacks to Qt callbacks
  91 AirTV-Qt/audiooutput.cpp          - Takes care of the actual audio output
  92 ```
  93