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