Update the README to contain more information about files.
[deb_shairplay.git] / README
1 Licenses
2 --------
3
4 Following licenses apply:
5
6 src/alac/* - MIT License
7 src/crypto/* - New BSD License
8 src/* - LGPLv2.1 License
9 AirTV-Qt/* - LGPLv2.1 License
10
11 I haven't had time to clarify the licenses used in the source code yet, that is on TODO list.
12
13 Description
14 -----------
15
16 Short description about what each file in the main library does:
17
18 src/base64.* - base64 encoder/decoder
19 src/dnssd.* - dnssd helper functions
20 src/http_parser.* - HTTP parser from joyent (nginx fork)
21 src/http_request.* - Request parser that uses http_parser
22 src/http_response.* - Extremely simple HTTP response serializer
23 src/httpd.* - Generic HTTP/RTSP server
24 src/logger.* - Logging related functions
25 src/netutils.* - Mostly socket related code
26 src/raop.* - Main RAOP handler, handles all RTSP stuff
27 src/raop_rtp.* - Handles the RAOP RTP related stuff (UDP/TCP)
28 src/raop_buffer.* - Parses and buffers RAOP packets, resend logic here
29 src/rsakey.* - Decrypts and parses the RSA key to bigints
30 src/rsapem.* - Converts the RSA PEM key to DER encoded bytes
31 src/sdp.* - Extremely simple RAOP specific SDP parser
32 src/utils.* - Utils for reading a file and handling strings
33
34 Short description about what each file in the Qt application does:
35
36 AirTV-Qt/main.cpp - Initializes the application
37 AirTV-Qt/mainapplication.cpp - Creates the tray icon and starts RAOP
38 AirTV-Qt/raopservice.cpp - Handles all communication with the library
39 AirTV-Qt/raopcallbackhandler.cpp - Converts C callbacks to Qt callbacks
40 AirTV-Qt/audiooutput.cpp - Takes care of the actual audio output
41