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