├── .gitignore ├── .github └── ISSUE_TEMPLATE │ ├── config.yml │ ├── song_request.md │ ├── feature_request.md │ └── bug_report.md ├── git_install.lua ├── install.lua ├── README.md ├── lib ├── youcubeapi.lua ├── semver.lua └── dfpwm.lua ├── musicify.lua └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | start.bat -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Discussions 4 | url: https://github.com/knijn/musicify/discussions 5 | about: Please ask and answer questions here. 6 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/song_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Song Request 3 | about: Use this if you wanna request a song 4 | title: '[SONG REQUEST] Artist - Song Name' 5 | labels: Song Request 6 | assignees: '' 7 | --- 8 | 9 | ## The song name and artist 10 | 11 | For example: Rick Astley - Never Gonna Give You Up 12 | 13 | ## Links to the song 14 | 15 | For example: `https://www.youtube.com/watch?v=dQw4w9WgXcQ` 16 | -------------------------------------------------------------------------------- /git_install.lua: -------------------------------------------------------------------------------- 1 | shell.run("rm musicify.lua") 2 | shell.run("wget https://raw.githubusercontent.com/knijn/musicify/main/musicify.lua") 3 | shell.run("mkdir /lib") 4 | shell.run("wget https://raw.githubusercontent.com/knijn/musicify/refs/heads/main/lib/semver.lua /lib/semver.lua") 5 | shell.run("wget https://raw.githubusercontent.com/knijn/musicify/refs/heads/main/lib/basalt.lua /lib/basalt.lua") 6 | shell.run("wget https://raw.githubusercontent.com/knijn/musicify/refs/heads/main/lib/youcubeapi.lua /lib/youcubeapi.lua") -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: "[FEATURE]" 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a bug report to help us improve! 4 | title: '[BUG]' 5 | labels: bug 6 | assignees: '' 7 | --- 8 | 9 | **Describe the bug** 10 | A clear and concise description of what the bug is. 11 | 12 | **To Reproduce** 13 | Steps to reproduce the behavior: 14 | 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Setup (please complete the following information):** 27 | 28 | - Type of Computer: [e.g. Advanced Computer] 29 | - Version [e.g. 22] 30 | 31 | **Additional context** 32 | Add any other context about the problem here. 33 | -------------------------------------------------------------------------------- /install.lua: -------------------------------------------------------------------------------- 1 | -- data[1].assets[1].browser_download_url 2 | local apiURL = "http://api.github.com/repos/knijn/musicify/releases" 3 | local baseRepoURL = "https://raw.githubusercontent.com/knijn/musicify/main" 4 | local args = {...} 5 | local skipcheck = false 6 | if args and args[1] == "y" then 7 | skipcheck = true 8 | end 9 | 10 | local scKey = _G._GIT_API_KEY 11 | if scKey then 12 | requestData = { 13 | url = apiURL, 14 | headers = {["Authorization"] = "token " .. scKey} 15 | } 16 | http.request(requestData) 17 | else 18 | http.request(apiURL) -- when not on switchcraft, use no authentication 19 | end 20 | print("Made request to " .. apiURL) 21 | 22 | while true do 23 | event, url, handle = os.pullEvent() 24 | if event == "http_failure" then 25 | error("Failed to download file: " .. handle) 26 | elseif event == "http_success" then 27 | print(handle.getResponseCode()) 28 | local data = textutils.unserialiseJSON(handle.readAll()) 29 | local url = data[1].assets[1].browser_download_url 30 | print("Downloading Musicify from: " .. url .. ", is this okay? (n to cancel, anything else to continue)") 31 | local input = read() 32 | if not skipcheck and input == keys.n then 33 | error("Cancelled Installation") 34 | end 35 | print("Installing now") 36 | shell.run("rm musicify") 37 | shell.run("wget " .. url) 38 | 39 | print("Downloading libraries right now") 40 | shell.run("rm /lib/semver.lua") 41 | shell.run("rm /lib/youcubeapi.lua") 42 | shell.run("rm /lib/basalt.lua") 43 | shell.run("rm /lib/dfpwm.lua") 44 | shell.run("wget " .. baseRepoURL .. "/lib/semver.lua /lib/semver.lua") 45 | shell.run("wget " .. baseRepoURL .. "/lib/dfpwm.lua /lib/dfpwm.lua") 46 | shell.run("wget " .. baseRepoURL .. "/lib/youcubeapi.lua /lib/youcubeapi.lua") 47 | shell.run("wget " .. baseRepoURL .. "/lib/basalt.lua /lib/basalt.lua") 48 | print("Done!!") 49 | return 50 | end 51 | end 52 | 53 | 54 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Musicify 2 | 3 | [![License badge](https://img.shields.io/github/license/RubenHetKonijn/musicify?style=flat-square)](https://github.com/knijn/musicify/blob/main/LICENSE) 4 | [![Mentioned in Awesome ComputerCraft](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/tomodachi94/awesome-computercraft) 5 | [![CC: Tweaked Version: 1.100+](https://img.shields.io/badge/CC:%20tweaked-1.100+-green?style=flat-square&logo=GNOME%20Terminal)](https://tweaked.cc/) 6 | 7 | Musicify is a command line utility for ComputerCraft:Tweaked to stream\* songs in game. 8 | 9 | ## Install 10 | 11 | To install, run 12 | 13 | ```shell 14 | wget run https://raw.githubusercontent.com/knijn/musicify/main/install.lua 15 | ``` 16 | 17 | 18 | # Codespaces 19 | 20 | To develop under Codespaces, you'll need the CraftOS VSCode Extention and install CraftOS-PC with the following commands: 21 | ```sh 22 | sudo add-apt-repository ppa:jackmacwindows/ppa 23 | sudo apt update 24 | sudo apt install craftos-pc 25 | ``` 26 | 27 | ## License 28 | 29 | Musicify is licensed under the [GNU General Public License v3.0](LICENSE). 30 | 31 | ## Commands 32 | 33 | ### musicify help 34 | Shows the help menu showing all commands 35 | 36 | ### musicify list 37 | Shows all of the playable songs in the repository set 38 | 39 | ### musicify info 40 | Displays info about the current version of Musicify, and about the repository set 41 | 42 | ### musicify play 43 | Plays the song with the specified ID 44 | 45 | ### musicify playlist 46 | A playlist file has the following format: `,,,`. These song IDs can be found using musicify list. And can also be URLs. 47 | 48 | ## musicify gui 49 | Show an in development GUI 50 | 51 | ## musicify shuffle [from] [to] 52 | Shuffle the songs in the repository, and optionally from and to a specific song id 53 | 54 | ## musicify update 55 | Forces an update on Musicify 56 | 57 | ## musicify loop 58 | Loops over a specific song or URL 59 | 60 | ## musicify url 61 | Plays a specific URL 62 | 63 | ## Setup 64 | 65 | Set up your Computer with the install command above. Make sure to have a speaker and a modem (or ender modem) attached if you want to use multiple speakers 66 | 67 | Musicify offers the following configuration options: 68 | - `musicify.repo`: Sets the repo to music load from (default: `https://raw.githubusercontent.com/knijn/musicify-songs/main/index.json`) 69 | - `musicify.autoUpdates`: Sets whether Musicify will automatically update when there's a new version. (default: `true`) 70 | - `musicify.serverChannel`: Sets the channel to broadcast audio packets on 71 | - `musicify.serverMode`: Sets whether Musicify will broadcast audio packets 72 | 73 | ## Development 74 | 75 | The program also should work as an api, this is not tested though. 76 | If you want to support the program, please make a pull request. It helps out a ton! 77 | 78 | If you want to run the development version of Musicify, run 79 | 80 | ```shell 81 | wget run https://raw.githubusercontent.com/knijn/musicify/main/git_install.lua 82 | ``` 83 | -------------------------------------------------------------------------------- /lib/youcubeapi.lua: -------------------------------------------------------------------------------- 1 | --[[- Lua library for accessing [YouCub's API](https://commandcracker.github.io/YouCube/) 2 | @module youcubeapi 3 | ]] 4 | 5 | --[[ 6 | _ _ ____ _ _ ____ _ _ ___ ____ ____ ___ _ 7 | \_/ | | | | | | | |__] |___ |__| |__] | 8 | | |__| |__| |___ |__| |__] |___ | | | | 9 | Github Repository: https://github.com/Commandcracker/YouCube 10 | License: GPL-3.0 11 | Lib Version: poc0.0.0 12 | API Version: 0.0.poc0 (https://commandcracker.github.io/YouCube/) 13 | ]] 14 | 15 | --[[- "wrapper" for accessing [YouCub's API](https://commandcracker.github.io/YouCube/) 16 | @type API 17 | @usage Example: 18 | local youcubeapi = require("youcubeapi") 19 | local api = youcubeapi.API.new() 20 | api:detect_bestest_server() 21 | api:request_media(url) 22 | local data = api.websocket.receive() 23 | ]] 24 | local API = {} 25 | 26 | --- Create's a new API instance. 27 | -- @param websocket [Websocket](https://tweaked.cc/module/http.html#ty:Websocket) The websocket. 28 | -- @treturn API instance 29 | function API.new(websocket) 30 | return setmetatable({ 31 | websocket = websocket, 32 | }, { __index = API }) 33 | end 34 | 35 | local servers = { 36 | "ws://localhost:5000", 37 | "ws://oxygen.knijn.one:5000", -- By EmmaKnijn, Contact EmmaKnijn#0043 on Discord if this doesn't work 38 | "wss://youcube.onrender.com" -- By Commandcracker 39 | } 40 | 41 | if settings then 42 | local server = settings.get("youcube.server") 43 | if server then 44 | table.insert(servers, 1, server) 45 | end 46 | end 47 | 48 | --- Connects to a YouCub Server 49 | function API:detect_bestest_server() 50 | for i, server in pairs(servers) do 51 | local websocket, websocket_error = http.websocket(server) 52 | 53 | if websocket ~= false then 54 | term.write("Using the YouCube server: ") 55 | term.setTextColor(colors.blue) 56 | print(server) 57 | term.setTextColor(colors.white) 58 | self.websocket = websocket 59 | break 60 | elseif i == #servers then 61 | error(websocket_error) 62 | end 63 | 64 | end 65 | end 66 | 67 | --- Receive data from The YouCub Server 68 | function API:receive() 69 | local status, retval = pcall( 70 | self.websocket.receive 71 | ) 72 | if not status then 73 | print("Lost connection to server -> Reconnection ...") 74 | self:detect_bestest_server() 75 | return self:receive() 76 | end 77 | return retval 78 | end 79 | 80 | --- Send data to The YouCub Server 81 | -- @tparam table data data to send 82 | function API:send(data) 83 | local status, retval = pcall( 84 | self.websocket.send, 85 | textutils.serialiseJSON(data) 86 | ) 87 | if not status then 88 | print("Lost connection to server -> Reconnection ...") 89 | self:detect_bestest_server() 90 | self:send(data) 91 | end 92 | end 93 | 94 | --- Request a `16 * 1024` bit chunk 95 | -- @tparam number chunkindex The chunkindex 96 | -- @tparam number id Media id 97 | -- @treturn bytes chunk `16 * 1024` bit chunk 98 | function API:get_chunk(chunkindex, id) 99 | self:send({ 100 | ["action"] = "get_chunk", 101 | ["chunkindex"] = chunkindex, 102 | ["id"] = id 103 | }) 104 | return self:receive() 105 | end 106 | 107 | --- Request media 108 | -- @tparam string url Url or Search Term 109 | -- @treturn table json response 110 | function API:request_media(url) 111 | self:send({ 112 | ["action"] = "request_media", 113 | ["url"] = url 114 | }) 115 | return textutils.unserialiseJSON(self:receive()) 116 | end 117 | 118 | --[[ handshake function coming soon 119 | function YouCubeAPI:handshake() 120 | local version = "0.0.poc0" 121 | self.websocket.send(textutils.serialiseJSON({ 122 | ["action"] = "handshake", 123 | ["version"] = version 124 | })) 125 | end 126 | ]] 127 | 128 | --[[- Abstraction for Audio Devices 129 | @type AudioDevice 130 | ]] 131 | local AudioDevice = {} 132 | 133 | --- Create's a new AudioDevice instance. 134 | -- @tparam table object Base values 135 | -- @treturn AudioDevice instance 136 | function AudioDevice.new(object) 137 | -- @type AudioDevice 138 | local self = object or {} 139 | 140 | function self:validate() end 141 | 142 | function self:setLabel(lable) end 143 | 144 | function self:write(chunk) end 145 | 146 | function self:play() end 147 | 148 | function self:reset() end 149 | 150 | return self 151 | end 152 | 153 | --[[- AudioDevice from a Speaker 154 | @type Speaker 155 | @usage Example: 156 | local youcubeapi = require("youcubeapi") 157 | local speaker = peripheral.find("speaker") 158 | local audiodevice = youcubeapi.Speaker.new(speaker) 159 | ]] 160 | local Speaker = {} 161 | 162 | local decoder 163 | local status, dfpwm = pcall(require, "cc.audio.dfpwm") 164 | 165 | if status then 166 | decoder = dfpwm.make_decoder() 167 | end 168 | 169 | --- Create's a new Tape instance. 170 | -- @tparam speaker speaker The speaker 171 | -- @treturn AudioDevice instance 172 | function Speaker.new(speaker) 173 | local self = AudioDevice.new { speaker = speaker } 174 | 175 | function self:validate() 176 | if not decoder then 177 | error("This ComputerCraft version dos not support DFPWM") 178 | end 179 | end 180 | 181 | function self:write(chunk) 182 | local buffer = decoder(chunk) 183 | while not self.speaker.playAudio(buffer) do 184 | os.pullEvent("speaker_audio_empty") 185 | end 186 | end 187 | 188 | return self 189 | end 190 | 191 | --[[- AudioDevice from a [Computronics tape_drive](https://wiki.vexatos.com/wiki:computronics:tape) 192 | @type Tape 193 | @usage Example: 194 | local youcubeapi = require("youcubeapi") 195 | local tape_drive = peripheral.find("tape_drive") 196 | local audiodevice = youcubeapi.Tape.new(tape_drive) 197 | ]] 198 | local Tape = {} 199 | 200 | --- Create's a new Tape instance. 201 | -- @tparam tape tape The tape_drive 202 | -- @treturn AudioDevice instance 203 | function Tape.new(tape) 204 | local self = AudioDevice.new { tape = tape } 205 | 206 | function self:validate() 207 | if not self.tape.isReady() then 208 | error("You need to insert a tape") 209 | end 210 | end 211 | 212 | function self:play(chunk) 213 | self.tape.seek(-self.tape.getSize()) 214 | self.tape.play() 215 | end 216 | 217 | function self:write(chunk) 218 | self.tape.write(chunk) 219 | end 220 | 221 | function self:setLabel(lable) 222 | self.tape.setLabel(lable) 223 | end 224 | 225 | function self:reset() 226 | -- https://github.com/Vexatos/Computronics/blob/b0ade53cab10529dbe91ebabfa882d1b4b21fa90/src/main/resources/assets/computronics/lua/peripheral/tape_drive/programs/tape_drive/tape#L109-L123 227 | local size = self.tape.getSize() 228 | self.tape.stop() 229 | self.tape.seek(-size) 230 | self.tape.stop() 231 | self.tape.seek(-90000) 232 | local s = string.rep(string.char(170), 8192) 233 | for i = 1, size + 8191, 8192 do 234 | self.tape.write(s) 235 | end 236 | self.tape.seek(-size) 237 | self.tape.seek(-90000) 238 | end 239 | 240 | return self 241 | end 242 | 243 | return { 244 | API = API, 245 | AudioDevice = AudioDevice, 246 | Speaker = Speaker, 247 | Tape = Tape 248 | } 249 | -------------------------------------------------------------------------------- /lib/semver.lua: -------------------------------------------------------------------------------- 1 | local semver = { 2 | _VERSION = '1.2.1', 3 | _DESCRIPTION = 'semver for Lua', 4 | _URL = 'https://github.com/kikito/semver.lua', 5 | _LICENSE = [[ 6 | MIT LICENSE 7 | 8 | Copyright (c) 2015 Enrique García Cota 9 | 10 | Permission is hereby granted, free of charge, to any person obtaining a 11 | copy of tother software and associated documentation files (the 12 | "Software"), to deal in the Software without restriction, including 13 | without limitation the rights to use, copy, modify, merge, publish, 14 | distribute, sublicense, and/or sell copies of the Software, and to 15 | permit persons to whom the Software is furnished to do so, subject to 16 | the following conditions: 17 | 18 | The above copyright notice and tother permission notice shall be included 19 | in all copies or substantial portions of the Software. 20 | 21 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 22 | OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 23 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 24 | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 25 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 26 | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 27 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 28 | ]] 29 | } 30 | 31 | local function checkPositiveInteger(number, name) 32 | assert(number >= 0, name .. ' must be a valid positive number') 33 | assert(math.floor(number) == number, name .. ' must be an integer') 34 | end 35 | 36 | local function present(value) 37 | return value and value ~= '' 38 | end 39 | 40 | -- splitByDot("a.bbc.d") == {"a", "bbc", "d"} 41 | local function splitByDot(str) 42 | str = str or "" 43 | local t, count = {}, 0 44 | str:gsub("([^%.]+)", function(c) 45 | count = count + 1 46 | t[count] = c 47 | end) 48 | return t 49 | end 50 | 51 | local function parsePrereleaseAndBuildWithSign(str) 52 | local prereleaseWithSign, buildWithSign = str:match("^(-[^+]+)(+.+)$") 53 | if not (prereleaseWithSign and buildWithSign) then 54 | prereleaseWithSign = str:match("^(-.+)$") 55 | buildWithSign = str:match("^(+.+)$") 56 | end 57 | assert(prereleaseWithSign or buildWithSign, ("The parameter %q must begin with + or - to denote a prerelease or a build"):format(str)) 58 | return prereleaseWithSign, buildWithSign 59 | end 60 | 61 | local function parsePrerelease(prereleaseWithSign) 62 | if prereleaseWithSign then 63 | local prerelease = prereleaseWithSign:match("^-(%w[%.%w-]*)$") 64 | assert(prerelease, ("The prerelease %q is not a slash followed by alphanumerics, dots and slashes"):format(prereleaseWithSign)) 65 | return prerelease 66 | end 67 | end 68 | 69 | local function parseBuild(buildWithSign) 70 | if buildWithSign then 71 | local build = buildWithSign:match("^%+(%w[%.%w-]*)$") 72 | assert(build, ("The build %q is not a + sign followed by alphanumerics, dots and slashes"):format(buildWithSign)) 73 | return build 74 | end 75 | end 76 | 77 | local function parsePrereleaseAndBuild(str) 78 | if not present(str) then return nil, nil end 79 | 80 | local prereleaseWithSign, buildWithSign = parsePrereleaseAndBuildWithSign(str) 81 | 82 | local prerelease = parsePrerelease(prereleaseWithSign) 83 | local build = parseBuild(buildWithSign) 84 | 85 | return prerelease, build 86 | end 87 | 88 | local function parseVersion(str) 89 | local sMajor, sMinor, sPatch, sPrereleaseAndBuild = str:match("^(%d+)%.?(%d*)%.?(%d*)(.-)$") 90 | assert(type(sMajor) == 'string', ("Could not extract version number(s) from %q"):format(str)) 91 | local major, minor, patch = tonumber(sMajor), tonumber(sMinor), tonumber(sPatch) 92 | local prerelease, build = parsePrereleaseAndBuild(sPrereleaseAndBuild) 93 | return major, minor, patch, prerelease, build 94 | end 95 | 96 | 97 | -- return 0 if a == b, -1 if a < b, and 1 if a > b 98 | local function compare(a,b) 99 | return a == b and 0 or a < b and -1 or 1 100 | end 101 | 102 | local function compareIds(myId, otherId) 103 | if myId == otherId then return 0 104 | elseif not myId then return -1 105 | elseif not otherId then return 1 106 | end 107 | 108 | local selfNumber, otherNumber = tonumber(myId), tonumber(otherId) 109 | 110 | if selfNumber and otherNumber then -- numerical comparison 111 | return compare(selfNumber, otherNumber) 112 | -- numericals are always smaller than alphanums 113 | elseif selfNumber then 114 | return -1 115 | elseif otherNumber then 116 | return 1 117 | else 118 | return compare(myId, otherId) -- alphanumerical comparison 119 | end 120 | end 121 | 122 | local function smallerIdList(myIds, otherIds) 123 | local myLength = #myIds 124 | local comparison 125 | 126 | for i=1, myLength do 127 | comparison = compareIds(myIds[i], otherIds[i]) 128 | if comparison ~= 0 then 129 | return comparison == -1 130 | end 131 | -- if comparison == 0, continue loop 132 | end 133 | 134 | return myLength < #otherIds 135 | end 136 | 137 | local function smallerPrerelease(mine, other) 138 | if mine == other or not mine then return false 139 | elseif not other then return true 140 | end 141 | 142 | return smallerIdList(splitByDot(mine), splitByDot(other)) 143 | end 144 | 145 | local methods = {} 146 | 147 | function methods:nextMajor() 148 | return semver(self.major + 1, 0, 0) 149 | end 150 | function methods:nextMinor() 151 | return semver(self.major, self.minor + 1, 0) 152 | end 153 | function methods:nextPatch() 154 | return semver(self.major, self.minor, self.patch + 1) 155 | end 156 | 157 | local mt = { __index = methods } 158 | function mt:__eq(other) 159 | return self.major == other.major and 160 | self.minor == other.minor and 161 | self.patch == other.patch and 162 | self.prerelease == other.prerelease 163 | -- notice that build is ignored for precedence in semver 2.0.0 164 | end 165 | function mt:__lt(other) 166 | if self.major ~= other.major then return self.major < other.major end 167 | if self.minor ~= other.minor then return self.minor < other.minor end 168 | if self.patch ~= other.patch then return self.patch < other.patch end 169 | return smallerPrerelease(self.prerelease, other.prerelease) 170 | -- notice that build is ignored for precedence in semver 2.0.0 171 | end 172 | -- This works like the "pessimisstic operator" in Rubygems. 173 | -- if a and b are versions, a ^ b means "b is backwards-compatible with a" 174 | -- in other words, "it's safe to upgrade from a to b" 175 | function mt:__pow(other) 176 | if self.major == 0 then 177 | return self == other 178 | end 179 | return self.major == other.major and 180 | self.minor <= other.minor 181 | end 182 | function mt:__tostring() 183 | local buffer = { ("%d.%d.%d"):format(self.major, self.minor, self.patch) } 184 | if self.prerelease then table.insert(buffer, "-" .. self.prerelease) end 185 | if self.build then table.insert(buffer, "+" .. self.build) end 186 | return table.concat(buffer) 187 | end 188 | 189 | local function new(major, minor, patch, prerelease, build) 190 | assert(major, "At least one parameter is needed") 191 | 192 | if type(major) == 'string' then 193 | major,minor,patch,prerelease,build = parseVersion(major) 194 | end 195 | patch = patch or 0 196 | minor = minor or 0 197 | 198 | checkPositiveInteger(major, "major") 199 | checkPositiveInteger(minor, "minor") 200 | checkPositiveInteger(patch, "patch") 201 | 202 | local result = {major=major, minor=minor, patch=patch, prerelease=prerelease, build=build} 203 | return setmetatable(result, mt) 204 | end 205 | 206 | setmetatable(semver, { __call = function(_, ...) return new(...) end }) 207 | semver._VERSION= semver(semver._VERSION) 208 | 209 | return semver 210 | -------------------------------------------------------------------------------- /lib/dfpwm.lua: -------------------------------------------------------------------------------- 1 | -- SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers 2 | -- 3 | -- SPDX-License-Identifier: MPL-2.0 4 | 5 | --[[- 6 | Convert between streams of DFPWM audio data and a list of amplitudes. 7 | 8 | DFPWM (Dynamic Filter Pulse Width Modulation) is an audio codec designed by GreaseMonkey. It's a relatively compact 9 | format compared to raw PCM data, only using 1 bit per sample, but is simple enough to simple enough to encode and decode 10 | in real time. 11 | 12 | Typically DFPWM audio is read from @{fs.BinaryReadHandle|the filesystem} or a @{http.Response|a web request} as a 13 | string, and converted a format suitable for @{speaker.playAudio}. 14 | 15 | ## Encoding and decoding files 16 | This modules exposes two key functions, @{make_decoder} and @{make_encoder}, which construct a new decoder or encoder. 17 | The returned encoder/decoder is itself a function, which converts between the two kinds of data. 18 | 19 | These encoders and decoders have lots of hidden state, so you should be careful to use the same encoder or decoder for 20 | a specific audio stream. Typically you will want to create a decoder for each stream of audio you read, and an encoder 21 | for each one you write. 22 | 23 | ## Converting audio to DFPWM 24 | DFPWM is not a popular file format and so standard audio processing tools will not have an option to export to it. 25 | Instead, you can convert audio files online using [music.madefor.cc], the [LionRay Wav Converter][LionRay] Java 26 | application or development builds of [FFmpeg]. 27 | 28 | [music.madefor.cc]: https://music.madefor.cc/ "DFPWM audio converter for Computronics and CC: Tweaked" 29 | [LionRay]: https://github.com/gamax92/LionRay/ "LionRay Wav Converter " 30 | [FFmpeg]: https://ffmpeg.org "FFmpeg command-line audio manipulation library" 31 | 32 | @see guide!speaker_audio Gives a more general introduction to audio processing and the speaker. 33 | @see speaker.playAudio To play the decoded audio data. 34 | @since 1.100.0 35 | @usage Reads "data/example.dfpwm" in chunks, decodes them and then doubles the speed of the audio. The resulting audio 36 | is then re-encoded and saved to "speedy.dfpwm". This processed audio can then be played with the `speaker` program. 37 | 38 | ```lua 39 | local dfpwm = require("cc.audio.dfpwm") 40 | 41 | local encoder = dfpwm.make_encoder() 42 | local decoder = dfpwm.make_decoder() 43 | 44 | local out = fs.open("speedy.dfpwm", "wb") 45 | for input in io.lines("data/example.dfpwm", 16 * 1024 * 2) do 46 | local decoded = decoder(input) 47 | local output = {} 48 | 49 | -- Read two samples at once and take the average. 50 | for i = 1, #decoded, 2 do 51 | local value_1, value_2 = decoded[i], decoded[i + 1] 52 | output[(i + 1) / 2] = (value_1 + value_2) / 2 53 | end 54 | 55 | out.write(encoder(output)) 56 | 57 | sleep(0) -- This program takes a while to run, so we need to make sure we yield. 58 | end 59 | out.close() 60 | ``` 61 | ]] 62 | 63 | local expect = require "cc.expect".expect 64 | 65 | local char, byte, floor, band, rshift = string.char, string.byte, math.floor, bit32.band, bit32.arshift 66 | 67 | local PREC = 10 68 | local PREC_POW = 2 ^ PREC 69 | local PREC_POW_HALF = 2 ^ (PREC - 1) 70 | local STRENGTH_MIN = 2 ^ (PREC - 8 + 1) 71 | 72 | local function make_predictor() 73 | local charge, strength, previous_bit = 0, 0, false 74 | 75 | return function(current_bit) 76 | local target = current_bit and 127 or -128 77 | 78 | local next_charge = charge + floor((strength * (target - charge) + PREC_POW_HALF) / PREC_POW) 79 | if next_charge == charge and next_charge ~= target then 80 | next_charge = next_charge + (current_bit and 1 or -1) 81 | end 82 | 83 | local z = current_bit == previous_bit and PREC_POW - 1 or 0 84 | local next_strength = strength 85 | if next_strength ~= z then next_strength = next_strength + (current_bit == previous_bit and 1 or -1) end 86 | if next_strength < STRENGTH_MIN then next_strength = STRENGTH_MIN end 87 | 88 | charge, strength, previous_bit = next_charge, next_strength, current_bit 89 | return charge 90 | end 91 | end 92 | 93 | --[[- Create a new encoder for converting PCM audio data into DFPWM. 94 | 95 | The returned encoder is itself a function. This function accepts a table of amplitude data between -128 and 127 and 96 | returns the encoded DFPWM data. 97 | 98 | :::caution Reusing encoders 99 | Encoders have lots of internal state which tracks the state of the current stream. If you reuse an encoder for multiple 100 | streams, or use different encoders for the same stream, the resulting audio may not sound correct. 101 | ::: 102 | 103 | @treturn function(pcm: { number... }):string The encoder function 104 | @see encode A helper function for encoding an entire file of audio at once. 105 | ]] 106 | local function make_encoder() 107 | local predictor = make_predictor() 108 | local previous_charge = 0 109 | 110 | return function(input) 111 | expect(1, input, "table") 112 | 113 | local output, output_n = {}, 0 114 | for i = 1, #input, 8 do 115 | local this_byte = 0 116 | for j = 0, 7 do 117 | local inp_charge = floor(input[i + j] or 0) 118 | if inp_charge > 127 or inp_charge < -128 then 119 | error(("Amplitude at position %d was %d, but should be between -128 and 127"):format(i + j, inp_charge), 2) 120 | end 121 | 122 | local current_bit = inp_charge > previous_charge or (inp_charge == previous_charge and inp_charge == 127) 123 | this_byte = floor(this_byte / 2) + (current_bit and 128 or 0) 124 | 125 | previous_charge = predictor(current_bit) 126 | end 127 | 128 | output_n = output_n + 1 129 | output[output_n] = char(this_byte) 130 | end 131 | 132 | return table.concat(output, "", 1, output_n) 133 | end 134 | end 135 | 136 | --[[- Create a new decoder for converting DFPWM into PCM audio data. 137 | 138 | The returned decoder is itself a function. This function accepts a string and returns a table of amplitudes, each value 139 | between -128 and 127. 140 | 141 | :::caution Reusing decoders 142 | Decoders have lots of internal state which tracks the state of the current stream. If you reuse an decoder for multiple 143 | streams, or use different decoders for the same stream, the resulting audio may not sound correct. 144 | ::: 145 | 146 | @treturn function(dfpwm: string):{ number... } The encoder function 147 | @see decode A helper function for decoding an entire file of audio at once. 148 | 149 | @usage Reads "data/example.dfpwm" in blocks of 16KiB (the speaker can accept a maximum of 128×1024 samples), decodes 150 | them and then plays them through the speaker. 151 | 152 | ```lua {data-peripheral=speaker} 153 | local dfpwm = require "cc.audio.dfpwm" 154 | local speaker = peripheral.find("speaker") 155 | 156 | local decoder = dfpwm.make_decoder() 157 | for input in io.lines("data/example.dfpwm", 16 * 1024) do 158 | local decoded = decoder(input) 159 | while not speaker.playAudio(decoded) do 160 | os.pullEvent("speaker_audio_empty") 161 | end 162 | end 163 | ``` 164 | ]] 165 | 166 | local function make_decoder() 167 | local predictor = make_predictor() 168 | local low_pass_charge = 0 169 | local previous_charge, previous_bit = 0, false 170 | 171 | return function (input, output) 172 | expect(1, input, "string") 173 | 174 | local output, output_n = {}, 0 175 | for i = 1, #input do 176 | local input_byte = byte(input, i) 177 | for _ = 1, 8 do 178 | local current_bit = band(input_byte, 1) ~= 0 179 | local charge = predictor(current_bit) 180 | 181 | local antijerk = charge 182 | if current_bit ~= previous_bit then 183 | antijerk = floor((charge + previous_charge + 1) / 2) 184 | end 185 | 186 | previous_charge, previous_bit = charge, current_bit 187 | 188 | low_pass_charge = low_pass_charge + floor(((antijerk - low_pass_charge) * 140 + 0x80) / 256) 189 | 190 | output_n = output_n + 1 191 | output[output_n] = low_pass_charge 192 | 193 | input_byte = rshift(input_byte, 1) 194 | end 195 | end 196 | 197 | return output 198 | end 199 | end 200 | 201 | local function make_intdecoder() 202 | local byte, band, rshift = string.byte, bit32.band, bit32.arshift 203 | return function (input) 204 | local output, output_n = {}, 0 205 | for i = 1, #input do 206 | local input_byte = byte(input, i) 207 | for _ = 1, 8 do 208 | local current_bit = band(input_byte, 1) ~= 0 209 | 210 | output_n = output_n + 1 211 | output[output_n] = (current_bit and 127 or -128) 212 | 213 | input_byte = rshift(input_byte, 1) 214 | end 215 | end 216 | 217 | return output 218 | end 219 | end 220 | 221 | --[[- A convenience function for decoding a complete file of audio at once. 222 | 223 | This should only be used for short files. For larger files, one should read the file in chunks and process it using 224 | @{make_decoder}. 225 | 226 | @tparam string input The DFPWM data to convert. 227 | @treturn { number... } The produced amplitude data. 228 | @see make_decoder 229 | ]] 230 | local function decode(input) 231 | expect(1, input, "string") 232 | return make_decoder()(input) 233 | end 234 | 235 | --[[- A convenience function for encoding a complete file of audio at once. 236 | 237 | This should only be used for complete pieces of audio. If you are writing writing multiple chunks to the same place, 238 | you should use an encoder returned by @{make_encoder} instead. 239 | 240 | @tparam { number... } input The table of amplitude data. 241 | @treturn string The encoded DFPWM data. 242 | @see make_encoder 243 | ]] 244 | local function encode(input) 245 | expect(1, input, "table") 246 | return make_encoder()(input) 247 | end 248 | 249 | return { 250 | make_encoder = make_encoder, 251 | encode = encode, 252 | 253 | make_decoder = make_decoder, 254 | make_intdecoder = make_intdecoder, 255 | decode = decode, 256 | } 257 | -------------------------------------------------------------------------------- /musicify.lua: -------------------------------------------------------------------------------- 1 | if periphemu then -- probably on CraftOS-PC 2 | periphemu.create("back","speaker") 3 | config.set("standardsMode",true) 4 | end 5 | 6 | settings.load() 7 | local repo = settings.get("musicify.repo","https://raw.githubusercontent.com/knijn/musicify-songs/main/index.json") 8 | local autoUpdates = settings.get("musicify.autoUpdates",true) 9 | local dfpwm = require("cc.audio.dfpwm") 10 | local indexURL = repo .. "?cb=" .. os.epoch("utc") 11 | local version = "3.3.0" 12 | local args = {...} 13 | local musicify = {} 14 | local speakers = {peripheral.find("speaker")} 15 | local serverChannel = settings.get("musicify.serverChannel", 2561) 16 | local serverMode = settings.get("musicify.serverMode", false) 17 | local modem = peripheral.find("modem") 18 | local v = require("/lib/semver") 19 | local volume = settings.get("musicify.volume",1) 20 | local softVolume = settings.get("musicify.softVolume",1) 21 | local audioCalls = {} 22 | local buffer 23 | 24 | if not speakers then -- Check if there is a speaker 25 | error("Speaker(s) not found, refer to the wiki on how to set up Musicify",0) 26 | end 27 | 28 | local handle , msg = http.get(indexURL) 29 | if not handle then 30 | error(msg) 31 | end 32 | local indexJSON = handle.readAll() 33 | handle.close() 34 | local index = textutils.unserialiseJSON(indexJSON) 35 | 36 | if not index then 37 | error("The index is malformed. Please make an issue on the github if it already doesn't exist",0) 38 | end 39 | 40 | local function getSongID(songname) 41 | for i in pairs(index.songs) do 42 | if index.songs[i].name == songname then 43 | return i 44 | end 45 | end 46 | end 47 | 48 | local function play(songID) 49 | if type(songID) == "table" then 50 | if string.find(songID.file,"flac") or string.find(songID.file,"wav") or string.find(songID.file,"mp3") or string.find(songID.file,"aac") or string.find(songID.file,"opus") or string.find(songID.file,"ogg") then 51 | songID.file = "https://cc.alexdevs.me/dfpwm?url=" .. textutils.urlEncode(songID.file) 52 | end 53 | end 54 | if type(songID) == "string" then 55 | local newSongID = {} 56 | newSongID.file = songID 57 | newSongID.name = songID 58 | if string.find(songID,"flac") or string.find(songID,"wav") or string.find(songID,"mp3") or string.find(songID,"aac") or string.find(songID,"opus") or string.find(songID,"ogg") then 59 | newSongID.file = "https://cc.alexdevs.me/dfpwm?url=" .. textutils.urlEncode(songID) 60 | newSongID.author = "URL (converting)" 61 | else 62 | newSongID.author = "URL" 63 | end 64 | songID = newSongID 65 | 66 | function getSongID() 67 | return "from" 68 | end 69 | end 70 | 71 | if not gui then 72 | print("Playing " .. getSongID(songID.name) .. " | " .. songID.author .. " - " .. songID.name) 73 | 74 | print("") 75 | print("Press CTRL+T to stop the song") 76 | end 77 | local h, err = http.get({["url"] = songID.file, ["binary"] = true, ["redirect"] = true}) -- write in binary mode 78 | if not h then error("Failed to download song: " .. err) end 79 | local decoder = dfpwm.make_decoder() 80 | while true do 81 | local chunk = h.read(16 * 1024) 82 | if not chunk then break end 83 | buffer = decoder(chunk) 84 | for i,_ in pairs(buffer) do 85 | buffer[i] = buffer[i] * softVolume 86 | if buffer[i] > 127 then 87 | buffer[i] = 127 88 | elseif buffer[i] < -127 then 89 | buffer[i] = -127 90 | end 91 | end 92 | if modem and serverMode then 93 | modem.transmit(serverChannel,serverChannel,buffer) 94 | end 95 | 96 | if songID.speed == 2 then 97 | error("Whoops!! You're trying to play unsupported audio, please use 48khz audio in your repository") 98 | end 99 | 100 | 101 | 102 | parallel.waitForAll(table.unpack(audioCalls)) 103 | end 104 | h.close() 105 | end 106 | 107 | 108 | local function update() 109 | if not autoUpdates then 110 | error("It seems like you've disabled autoupdates, we're skipping this update", 0) 111 | end 112 | shell.run("wget run https://raw.githubusercontent.com/knijn/musicify/main/install.lua") 113 | end 114 | 115 | if v(version) < v(index.latestVersion) then 116 | error("Client outdated, Updating Musicify.",0) -- Update check 117 | -- this has broken so many times it's actually not even funny anymore 118 | update() 119 | end 120 | 121 | musicify.help = function (arguments) 122 | print([[ 123 | Usage: [arguments] 124 | Actions: 125 | musicify 126 | help -- Displays this message 127 | list -- Displays a list of songs you can play 128 | info -- Displays information about Musicify's version and repo 129 | play -- Plays the specified song by it's ID 130 | playlist -- Plays a playlist file 131 | gui -- Starts the GUI (WIP) 132 | shuffle [from] [to] -- Starts shuffle mode in the specified range 133 | update -- Updates musicify 134 | loop -- Loop on a specific song 135 | url -- Play a song from a URL 136 | ]]) 137 | end 138 | 139 | musicify.client = function (arguments) 140 | if not modem then error("There needs to be a modem attached") end 141 | while true do 142 | 143 | modem.open(serverChannel) 144 | print("Listening on " .. serverChannel) 145 | local event, side, channel, replyChannel, message, distance = os.pullEvent("modem_message") 146 | if channel == serverChannel and replyChannel == serverChannel then 147 | buffer = message 148 | parallel.waitForAll(table.unpack(audioCalls)) 149 | end 150 | end 151 | end 152 | 153 | musicify.url = function (arguments) 154 | if string.find(arguments[1],"youtube") then 155 | print("Youtube support isn't garuanteed, proceed with caution") 156 | end 157 | play(arguments[1]) 158 | end 159 | 160 | musicify.youcube = function (arguments) 161 | print("YouCube has been removed in favor of the new URL system. Please use `musicify url ` instead.") 162 | end 163 | 164 | musicify.gui = function (arguments) 165 | local basalt = require("lib/basalt") 166 | gui = true 167 | if not basalt then 168 | error("Basalt wasn't found or was installed incorrectly") 169 | end 170 | local main = basalt.createFrame() 171 | 172 | local function goHome() 173 | list = main:addList() 174 | :setPosition(2,2) 175 | :setSize("parent.w - 2","parent.h - 6") 176 | for i,o in pairs(index.songs) do 177 | list:addItem(index.songs[i].author .. " - " .. index.songs[i].name) 178 | 179 | end 180 | local function startSong() 181 | play(index.songs[list:getItemIndex()]) 182 | end 183 | local function threadedStartSong() 184 | local thread = main:addThread() 185 | thread:start(startSong) 186 | end 187 | local playButton = main:addButton() 188 | :setPosition(2,"parent.h - 3") 189 | :setSize(6,3) 190 | :setText("Play") 191 | :onClick(threadedStartSong) 192 | end 193 | goHome() 194 | 195 | basalt.autoUpdate() 196 | end 197 | 198 | musicify.update = function (arguments) 199 | print("Updating Musicify, please hold on.") 200 | autoUpdates = true -- bypass autoupdate check 201 | update() -- Calls the update function to re-download the latest release 202 | end 203 | 204 | musicify.list = function (arguments) 205 | if not arguments then 206 | arguments[1] = nil 207 | end 208 | print("Format: `ID | Author - Name`") 209 | local buffer = "" 210 | local songAmount = #index.songs 211 | for i in pairs(index.songs) do -- Loop through all songs 212 | buffer = buffer .. i .. " | " .. index.songs[i].author .. " - " .. index.songs[i].name .. "\n" 213 | end 214 | local offset = 0 215 | local xSize, ySize = term.getSize() 216 | local function keyboardHandler() 217 | local event, key, is_held = os.pullEvent("key") 218 | if key == keys.q then 219 | error("Closed list") 220 | elseif key == keys.s then 221 | if offset < songAmount - ySize then 222 | offset = offset + 1 223 | end 224 | elseif key == keys.w then 225 | if offset > 0 then 226 | offset = offset - 1 227 | end 228 | end 229 | end 230 | local function draw() 231 | term.clear() 232 | for i=1,ySize do 233 | term.setCursorPos(1,i) 234 | i = i + offset 235 | term.write(i .. " | " .. index.songs[i].author .. " - " .. index.songs[i].name) 236 | end 237 | coroutine.yield() 238 | end 239 | while true do 240 | parallel.waitForAny(keyboardHandler,draw) 241 | end 242 | end 243 | 244 | musicify.shuffle = function (arguments) 245 | local from = arguments[1] or 1 246 | local to = arguments[2] or #index.songs 247 | if tostring(arguments[1]) and not tonumber(arguments[1]) and arguments[1] then -- Check if selection is valid 248 | error("Please specify arguments in a form like `musicify shuffle 1 5`",0) 249 | return 250 | end 251 | while true do 252 | print("Currently in shuffle mode") 253 | local ranNum = math.random(from, to) 254 | play(index.songs[ranNum]) 255 | end 256 | end 257 | 258 | musicify.play = function (arguments) 259 | local songList = {} 260 | if arguments[1] == "all" then -- TODO: Make this NOT a mess 261 | for i2,o2 in pairs(index.songs) do 262 | local songID = "," .. tostring(i2) 263 | table.insert(songList,songID) 264 | end 265 | local handle = fs.open(".musicifytmp","w") 266 | for i,o in pairs(songList) do 267 | local song = "," .. songList[i] 268 | handle.write(song) 269 | end 270 | handle.close() 271 | musicify.playlist({".musicifytmp"}) 272 | return 273 | end 274 | 275 | if not tonumber(arguments[1]) or not index.songs[tonumber(arguments[1])] then 276 | error("Please provide a valid track ID. Use `list` to see all valid track numbers.",0) 277 | return 278 | end 279 | play(index.songs[tonumber(arguments[1])]) 280 | end 281 | 282 | 283 | musicify.info = function (arguments) 284 | print("Latest version: " .. index.latestVersion) 285 | local devVer = v(version) > v(index.latestVersion) 286 | if devVer == true then 287 | print("Current version: " .. version .. " (Development Version)") 288 | else 289 | print("Current version: " .. version) 290 | end 291 | print("Repository name: " .. index.indexName) 292 | end 293 | 294 | musicify.loop = function (arguments) 295 | while true do 296 | if tonumber(arguments[1]) then 297 | play(index.songs[tonumber(arguments[1])]) 298 | elseif tostring(arguments[1]) then 299 | play(arguments[1]) 300 | end 301 | speaker.stopAudio() 302 | end 303 | end 304 | 305 | musicify.playlist = function (arguments) 306 | if not arguments[1] or not tostring(arguments[1]) or not fs.exists(arguments[1]) then 307 | error("Please specify a playlist file to play") 308 | end 309 | local playlist = fs.open(arguments[1], "r") -- Load playlist file into a variable 310 | local list = playlist.readAll() -- Also load playlist file into a variable 311 | playlist.close() 312 | local toPlay = {} 313 | 314 | for word in string.gmatch(list, '([^,]+)') do -- Seperate different song ID's from file 315 | table.insert(toPlay,word) 316 | end 317 | for i,songID in pairs(toPlay) do 318 | print("Currently in playlist mode, press to exit. Use to skip songs") 319 | 320 | 321 | 322 | local function songLengthWait() -- Wait until the end of the song 323 | if tonumber(songID) then 324 | play(index.songs[tonumber(songID)]) 325 | elseif tostring(songID) then 326 | play(songID) 327 | end 328 | end 329 | local function keyboardWait() -- Wait for keyboard presses 330 | while true do 331 | local event, key = os.pullEvent("key") 332 | if key == keys.enter then 333 | print("Skipping!") 334 | break 335 | elseif key == keys.q then 336 | musicify.stop() 337 | error("Stopped playing",0) 338 | end 339 | end 340 | end 341 | parallel.waitForAny(songLengthWait, keyboardWait) -- Combine the two above functions 342 | end 343 | end 344 | 345 | musicify.random = function(args) 346 | local from = args[1] or 1 347 | local to = args[2] or #index.songs 348 | if tostring(args[1]) and not tonumber(args[1]) and args[1] then -- Check if selection is valid 349 | error("Please specify arguments in a form like `musicify random 1 5`",0) 350 | return 351 | end 352 | local ranNum = math.random(from, to) 353 | play(index.songs[ranNum]) 354 | end 355 | 356 | 357 | command = table.remove(args, 1) 358 | musicify.index = index 359 | 360 | for spkr,dev in pairs(speakers) do 361 | table.insert(audioCalls,function() 362 | coroutine.resume(coroutine.create(function()dev.playAudio(buffer,volume)end))end) 363 | table.insert(audioCalls,function()repeat _,which=os.pullEvent("speaker_audio_empty") if which==peripheral.getName(dev) or which=="flush" then break end until(false)end) 364 | end 365 | 366 | if musicify[command] then 367 | musicify[command](args) 368 | else 369 | print("Please provide a valid command. For usage, use `musicify help`.") 370 | end 371 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------