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