README.md

   1 Shairplay
   2 =========
   3 Free portable AirPlay server implementation.
   4
   5 Disclaimer
   6 ----------
   7 All the resources in this repository are written using only freely available
   8 information from the internet. The code and related resources are meant for
   9 educational purposes only. It is up to the user to make sure all local laws are
  10 adhered to.
  11
  12 Related software
  13 ----------------
  14
  15 * [ShairPort](https://github.com/abrasive/shairport), original AirPort Express emulator
  16 * [ALAC](http://craz.net/programs/itunes/alac.html), ALAC decoder by David Hammerton
  17
  18 Description
  19 -----------
  20
  21 Short description about what each file in the main library does:
  22
  23 src/lib/base64.*         - base64 encoder/decoder
  24 src/lib/dnssd.*          - dnssd helper functions
  25 src/lib/http_parser.*    - HTTP parser from joyent (nginx fork)
  26 src/lib/http_request.*   - Request parser that uses http_parser
  27 src/lib/http_response.*  - Extremely simple HTTP response serializer
  28 src/lib/httpd.*          - Generic HTTP/RTSP server
  29 src/lib/logger.*         - Logging related functions
  30 src/lib/netutils.*       - Mostly socket related code
  31 src/lib/raop.*           - Main RAOP handler, handles all RTSP stuff
  32 src/lib/raop_rtp.*       - Handles the RAOP RTP related stuff (UDP/TCP)
  33 src/lib/raop_buffer.*    - Parses and buffers RAOP packets, resend logic here
  34 src/lib/rsakey.*         - Decrypts and parses the RSA key to bigints
  35 src/lib/rsapem.*         - Converts the RSA PEM key to DER encoded bytes
  36 src/lib/sdp.*            - Extremely simple RAOP specific SDP parser
  37 src/lib/utils.*          - Utils for reading a file and handling strings
  38
  39 Short description about what each file in the Qt application does:
  40
  41 AirTV-Qt/main.cpp                 - Initializes the application
  42 AirTV-Qt/mainapplication.cpp      - Creates the tray icon and starts RAOP
  43 AirTV-Qt/raopservice.cpp          - Handles all communication with the library
  44 AirTV-Qt/raopcallbackhandler.cpp  - Converts C callbacks to Qt callbacks
  45 AirTV-Qt/audiooutput.cpp          - Takes care of the actual audio output
  46