[deb_shairplay.git] / README

Licenses
--------

Following licenses apply:

src/lib/alac/*         - MIT License
src/lib/crypto/*       - New BSD License
src/lib/http_parser.*  - MIT License
src/lib/bindings/*     - MIT License
src/lib/*              - LGPLv2.1+ License
AirTV-Qt/*             - LGPLv2.1+ License

Also the following files are used, although not necessary:

AirTV-Qt/qtsingleapplication/src/* - New BSD License

Description
-----------

Short description about what each file in the main library does:

src/lib/base64.*         - base64 encoder/decoder
src/lib/dnssd.*          - dnssd helper functions
src/lib/http_parser.*    - HTTP parser from joyent (nginx fork)
src/lib/http_request.*   - Request parser that uses http_parser
src/lib/http_response.*  - Extremely simple HTTP response serializer
src/lib/httpd.*          - Generic HTTP/RTSP server
src/lib/logger.*         - Logging related functions
src/lib/netutils.*       - Mostly socket related code
src/lib/raop.*           - Main RAOP handler, handles all RTSP stuff
src/lib/raop_rtp.*       - Handles the RAOP RTP related stuff (UDP/TCP)
src/lib/raop_buffer.*    - Parses and buffers RAOP packets, resend logic here
src/lib/rsakey.*         - Decrypts and parses the RSA key to bigints
src/lib/rsapem.*         - Converts the RSA PEM key to DER encoded bytes
src/lib/sdp.*            - Extremely simple RAOP specific SDP parser
src/lib/utils.*          - Utils for reading a file and handling strings

Short description about what each file in the Qt application does:

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