├── .gitignore ├── convertSoundBank.py ├── createSFZ.py ├── README.md ├── sfz.py ├── sf2.py └── LICENSE.txt /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | *.pyc 3 | -------------------------------------------------------------------------------- /convertSoundBank.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # 3 | # Copyright 2016, roberto@zenvoid.org 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | 15 | import sys, logging 16 | logging.basicConfig(level=logging.INFO, format='%(levelname)s: %(message)s') 17 | 18 | import re, textwrap 19 | from sfz import SFZ 20 | from sf2 import SF2 21 | 22 | inputFormats = ['sfz'] 23 | outputFormats = ['sfz', 'sf2'] 24 | 25 | if len(sys.argv) < 3: 26 | print("Usage:", sys.argv[0], "INPUT OUTPUT\n") 27 | print(textwrap.dedent(""" 28 | Process INPUT sound bank and writes an OUTPUT file, which can be in different 29 | format. It tries to guess formats from file names. Supported formats in this 30 | version: 31 | """).strip()) 32 | print("") 33 | print(" Input:", ", ".join(inputFormats).upper()) 34 | print(" Output:", ", ".join(outputFormats).upper()) 35 | print("") 36 | print(textwrap.dedent(""" 37 | This program supports a limited subset of the SFZ format, extended with 38 | annotations which enable better control of the generated output files. 39 | """).strip()) 40 | sys.exit(1) 41 | 42 | inputFile = sys.argv[1] 43 | inputFormat = None 44 | outputFile = sys.argv[2] 45 | outputFormat = None 46 | soundBank = None 47 | 48 | match = re.search('\.([a-z0-9]+)$', inputFile.lower()) 49 | if match: 50 | inputFormat = match.group(1) 51 | else: 52 | logging.error("Can not guess format from file name: {}".format(inputFile)) 53 | sys.exit(1) 54 | 55 | if not inputFormat in inputFormats: 56 | logging.error("Unknown or unsupported input format: {}".format(inputFormat)) 57 | sys.exit(1) 58 | 59 | match = re.search('\.([a-z0-9]+)$', outputFile.lower()) 60 | if match: 61 | outputFormat = match.group(1) 62 | else: 63 | logging.error("Can not guess format from file name: {}".format(outputFile)) 64 | sys.exit(1) 65 | 66 | if not outputFormat in outputFormats: 67 | logging.error("Unknown or unsupported output format: {}".format(outputFormat)) 68 | sys.exit(1) 69 | 70 | print("Reading and processing input file...") 71 | if inputFormat == 'sfz': 72 | sfz = SFZ() 73 | if not sfz.importSFZ(sys.argv[1]): 74 | sys.exit(1) 75 | soundBank = sfz.soundBank 76 | 77 | print("Writing output file...") 78 | if outputFormat == 'sfz': 79 | sfz = SFZ() 80 | sfz.soundBank = soundBank 81 | if not sfz.exportSFZ(outputFile): 82 | sys.exit(1) 83 | elif outputFormat == 'sf2': 84 | sf2 = SF2() 85 | if not sf2.exportSF2(soundBank, outputFile): 86 | sys.exit(1) 87 | 88 | print("Done") 89 | -------------------------------------------------------------------------------- /createSFZ.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # 3 | # Copyright 2016, roberto@zenvoid.org 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | 15 | import sys, logging 16 | logging.basicConfig(level=logging.INFO, stream=sys.stderr, format='%(levelname)s: %(message)s') 17 | 18 | import re, os.path, time, textwrap 19 | from sfz import SFZ 20 | 21 | if len(sys.argv) < 2: 22 | print("Usage:", sys.argv[0], "[SAMPLE]...\n", file=sys.stderr) 23 | print(textwrap.dedent(""" 24 | Takes audio files as input and writes to stdout a SFZ template for them. 25 | It tries to guess the pitch of each sample from its file name. 26 | 27 | Examples: 28 | """).strip(), file=sys.stderr) 29 | print("") 30 | print(" {}".format(sys.argv[0]), "samples/*.wav", file=sys.stderr) 31 | print(" {}".format(sys.argv[0]), "piano_C4.wav piano_C5.wav piano_F#4.wav", file=sys.stderr) 32 | sys.exit(0) 33 | 34 | sfz = SFZ() 35 | regions = {} 36 | 37 | noteRegEx = re.compile('^(.+[-_])?(([abcdefgABCDEFG])([b#]?)(-?[0-9]))(v(([0-9]{1,3})|[LMHlmh]))?([-_][0-9]+)?\.wav$') 38 | numRegEx = re.compile('^(.+[-_])?([0-9]{1,3})(v(([0-9]{1,3})|[LMHlmh]))?([-_][0-9]+)?\.wav') 39 | 40 | for fName in sys.argv[1:]: 41 | match = noteRegEx.search(os.path.basename(fName)) 42 | if match: 43 | noteNum = sfz.convertNote(match.group(2)) 44 | if noteNum == None: 45 | logging.warning("Can't guess pitch from file name: {}".format(fName)) 46 | continue 47 | regions[noteNum] = fName 48 | continue 49 | match = numRegEx.search(os.path.basename(fName)) 50 | if match: 51 | noteNum = int(match.group(2)) 52 | if noteNum < 0 or noteNum > 127: 53 | logging.warning("Can't guess pitch from file name: {}".format(fName)) 54 | continue 55 | regions[noteNum] = fName 56 | continue 57 | logging.warning("Can't guess pitch from file name: {}".format(fName)) 58 | 59 | soundBank = { 60 | 'Name': 'Unnamed sound bank', 61 | 'Date': time.strftime("%Y-%m-%d"), 62 | 'instruments': [{ 63 | 'Instrument': 'Unnamed instrument', 64 | 'ampeg_release': '0.5', 65 | 'groups': [{ 66 | 'loop_mode': 'no_loop', 67 | 'regions': [] 68 | }] 69 | }] 70 | } 71 | 72 | prevRegion = None 73 | for noteNum in sorted(regions.keys()): 74 | region = {} 75 | region['sample'] = regions[noteNum] 76 | region['pitch_keycenter'] = noteNum 77 | if prevRegion: 78 | gap = noteNum - prevRegion['pitch_keycenter'] - 1 79 | leftGap = gap // 2 80 | rightGap = gap - leftGap 81 | prevRegion['hikey'] = prevRegion['pitch_keycenter'] + leftGap 82 | region['lokey'] = noteNum - rightGap 83 | soundBank['instruments'][0]['groups'][0]['regions'].append(region) 84 | prevRegion = soundBank['instruments'][0]['groups'][0]['regions'][-1] 85 | 86 | sfz.soundBank = soundBank 87 | sfz.exportSFZ() 88 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # FreePats-Tools 2 | 3 | Tools to manage, create and convert sound fonts, collections of sampled 4 | musical instruments and sound banks. Originally created for the FreePats 5 | project: http://freepats.zenvoid.org/ 6 | 7 | 8 | ## Dependencies 9 | 10 | Requires Python 3 with dateutil, soundfile and numpy modules. This will 11 | install the required dependencencies on Debian and derived distributions: 12 | 13 | apt-get install python3 python3-dateutil python3-soundfile python3-numpy 14 | 15 | 16 | ## Usage 17 | 18 | There are two programs included: 19 | 20 | * createSFZ.py: Takes audio files as input and writes to stdout a SFZ template 21 | for them. 22 | 23 | * convertSoundBank.py: Process a sound bank and writes another file, possibly 24 | converted to a different format. 25 | 26 | 27 | createSFZ.py is useful to create a new sound bank in SFZ format. It accepts a 28 | collection of samples as a list of arguments and writes a template to the 29 | standard output. 30 | 31 | The SFZ format is composed of text that can be modified with any text editor 32 | to complete the missing parts. Later, it can be converted to other formats 33 | with the convertSoundBank.py program. 34 | 35 | createSFZ.py will try to guess the pitch of each sample from its file name. 36 | For this reason, each sample must be named with a suffix indicating its note. 37 | It accepts either standard MIDI numbers (where 60 is middle C), or English 38 | alphabetic notation plus an octave number (where C4 is middle C). 39 | 40 | Examples: 41 | 42 | createSFZ.py piano_C4.wav piano_C5.wav piano_F#4.wav piano_F#5.wav 43 | createSFZ.py samples/*.wav > soundBank.sfz 44 | 45 | 46 | Generated output will look like this: 47 | 48 | //+ Name: Unnamed sound bank 49 | //+ Date: 2016-12-19 50 | 51 | 52 | //+ Instrument: Unnamed instrument 53 | ampeg_release=0.5 54 | 55 | 56 | loop_mode=no_loop 57 | 58 | hikey=62 59 | pitch_keycenter=60 60 | sample=piano_C4.wav 61 | 62 | lokey=63 63 | hikey=68 64 | pitch_keycenter=66 65 | sample=piano_F#4.wav 66 | 67 | lokey=69 68 | hikey=74 69 | pitch_keycenter=72 70 | sample=piano_C5.wav 71 | 72 | lokey=75 73 | pitch_keycenter=78 74 | sample=piano_F#5.wav 75 | 76 | 77 | Lines starting with // are comments. Lines starting with //+ contain hints 78 | that will be processed by these tools to provide additional information and 79 | aid conversion between different formats. They will be ignored by SFZ players. 80 | 81 | There are a few things that should be edited. In particular: 82 | 83 | * Name of the sound bank and instrument. For compatibility with the SF2 format, 84 | the instrument name should be no longer than 19 characters. 85 | 86 | * If samples contain loops, `loop_mode` instruction should be modified and each 87 | sample should have `loop_start` and `loop_end` information added. 88 | 89 | 90 | convertSoundBank.py can be used to validate and convert the SFZ file. When 91 | converted to SF2, global options included within `` will be converted 92 | to global instrument options that can be overriden in subsequent groups or 93 | regions. 94 | 95 | This example will create a SF2 sound font. 96 | 97 | convertSoundBank.py grandPiano.sfz grandPiano.sf2 98 | 99 | The resulting file grandPiano.sf2 should be ready to be used with fluidsynth, 100 | qsynth, or any other program that handle SF2 files. It can also be open with a 101 | sound font editor (swami, polyphone...) and inspect or continue editing its 102 | contents. 103 | 104 | 105 | ## Limitations 106 | 107 | * Has only been tested on Linux. 108 | 109 | * Only SFZ to SF2 conversion is available. The opposite conversion from SF2 to 110 | SFZ is not done yet. Other formats are missing. 111 | 112 | * Supports a minimal subset of SFZ opcodes. 113 | 114 | This software supports a small set of features, and is only useful to convert 115 | very simple sound fonts, please note that on most cases the resulting file 116 | will require manual editing. 117 | 118 | 119 | ## License 120 | 121 | This program is free software: you can redistribute it and/or modify it under 122 | the terms of the GNU General Public License as published by the Free Software 123 | Foundation, either version 3 of the License, or (at your option) any later 124 | version. 125 | 126 | This program is distributed in the hope that it will be useful, but WITHOUT 127 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 128 | FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 129 | -------------------------------------------------------------------------------- /sfz.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # 3 | # Copyright 2016, roberto@zenvoid.org 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | 15 | import logging, re, os.path, sys 16 | import dateutil.parser 17 | 18 | 19 | class SFZParseError(Exception): 20 | pass 21 | 22 | 23 | class SFZ: 24 | 25 | noteValue = {'C': 0, 'D': 2, 'E': 4, 'F': 5, 'G': 7, 'A': 9, 'B': 11} 26 | 27 | 28 | def importSFZ(self, fileName): 29 | self.soundBank = {'instruments': []} 30 | self.instrument = {'groups': []} 31 | self.group = {'regions': []} 32 | self.region = {} 33 | self.insideInstrument = False 34 | self.insideGroup = False 35 | self.insideRegion = False 36 | try: 37 | inFile = open(fileName, 'r') 38 | except: 39 | logging.error("Can not open file: {}".format(fileName)) 40 | return False 41 | path = os.path.dirname(fileName) 42 | if len(path) > 0: 43 | self.soundBank['Path'] = path 44 | 45 | lineNumber = 0 46 | for line in inFile: 47 | lineNumber += 1 48 | try: 49 | self.processLine(line) 50 | except SFZParseError: 51 | logging.error("Error on line {} of file {}".format(lineNumber, fileName)) 52 | inFile.close() 53 | return False 54 | 55 | self.commitRegion() 56 | self.commitGroup() 57 | self.commitInstrument() 58 | inFile.close() 59 | return True 60 | 61 | 62 | def exportSFZ(self, fileName = None): 63 | if fileName: 64 | outFile = open(fileName, 'w') 65 | else: 66 | outFile = sys.stdout 67 | for hint in ('Name', 'Date', 'URL'): 68 | if hint in self.soundBank.keys(): 69 | outFile.write('//+ {}: {}\n'.format(hint, self.soundBank[hint])) 70 | 71 | for instrument in self.soundBank['instruments']: 72 | if len(self.soundBank['instruments']) > 1 or len(instrument) > 1: 73 | outFile.write('\n\n') 74 | for instKey in sorted(instrument.keys()): 75 | if instKey[0].isupper(): 76 | outFile.write(' //+ {}: {}\n'.format(instKey, instrument[instKey])) 77 | elif instKey != 'groups': 78 | outFile.write(' {}={}\n'.format(instKey, instrument[instKey])) 79 | for group in instrument['groups']: 80 | outFile.write('\n\n') 81 | for groupKey in sorted(group.keys()): 82 | if groupKey != 'regions': 83 | outFile.write(' {}={}\n'.format(groupKey, group[groupKey])) 84 | for region in group['regions']: 85 | outFile.write('\n') 86 | 87 | # if hikey, lokey and pitch_keycenter are set to the same value, 88 | # write a single key opcode 89 | hikey = 127 90 | lokey = 0 91 | pitch = 60 92 | if 'hikey' in region.keys(): 93 | hikey = region['hikey'] 94 | if 'lokey' in region.keys(): 95 | lokey = region['lokey'] 96 | if 'pitch_keycenter' in region.keys(): 97 | pitch = region['pitch_keycenter'] 98 | if hikey == lokey and hikey == pitch: 99 | outFile.write(' key={}\n'.format(region['hikey'])) 100 | else: 101 | if lokey != 0: 102 | outFile.write(' lokey={}\n'.format(lokey)) 103 | if hikey != 127: 104 | outFile.write(' hikey={}\n'.format(hikey)) 105 | if 'pitch_keycenter' in region.keys(): 106 | outFile.write(' pitch_keycenter={}\n'.format(pitch)) 107 | 108 | for regionKey in sorted(region.keys()): 109 | if regionKey == 'hikey' \ 110 | or regionKey == 'lokey' \ 111 | or regionKey == 'pitch_keycenter': 112 | continue 113 | outFile.write(' {}={}\n'.format(regionKey, region[regionKey])) 114 | outFile.close() 115 | return True 116 | 117 | 118 | def processLine(self, line): 119 | match = re.search('//\+ ([a-zA-Z0-9_&.+-]+): +(\S.*)$', line) 120 | if match: 121 | value = match.group(2) 122 | value = value.rstrip() 123 | return self.processHint(match.group(1), value) 124 | 125 | line = line.partition('//')[0] # Erase comments 126 | line = line.rstrip() 127 | 128 | while True: 129 | line = line.lstrip() 130 | if len(line) == 0: 131 | return True 132 | 133 | # Header 134 | if line[0] == '<': 135 | end = line.find('>') 136 | if end == -1: 137 | raise SFZParseError 138 | header = line[1:end] 139 | if len(header) < 1: 140 | raise SFZParseError 141 | self.processHeader(header) 142 | line = line[end+1:] 143 | continue 144 | 145 | # Opcode 146 | end = line.find('=') 147 | if end == -1: 148 | raise SFZParseError 149 | opcode = line[:end] 150 | if len(opcode) < 1: 151 | raise SFZParseError 152 | line = line[end+1:] 153 | if len(line) == 0: 154 | raise SFZParseError 155 | 156 | # Find next opcode or header 157 | match = re.search('[=<]', line) 158 | if not match: 159 | return self.processOpcode(opcode, line) 160 | 161 | if line[match.start()] == '=': 162 | nextOpcode = re.search('\s[a-zA-Z0-9_]+=', line) 163 | if not nextOpcode: 164 | raise SFZParseError 165 | value = line[:nextOpcode.start()].rstrip() 166 | line = line[nextOpcode.start():] 167 | else: 168 | value = line[:match.start()].rstrip() 169 | line = line[match.start():] 170 | 171 | self.processOpcode(opcode, value) 172 | 173 | return False 174 | 175 | 176 | def processHeader(self, header): 177 | if header == 'global': 178 | self.commitRegion() 179 | self.commitGroup() 180 | self.commitInstrument() 181 | self.insideInstrument = True 182 | self.insideGroup = False 183 | self.insideRegion = False 184 | elif header == 'group': 185 | self.commitRegion() 186 | self.commitGroup() 187 | self.insideInstrument = True 188 | self.insideGroup = True 189 | self.insideRegion = False 190 | elif header == 'region': 191 | self.commitRegion() 192 | self.insideInstrument = True 193 | self.insideRegion = True 194 | else: 195 | raise SFZParseError 196 | 197 | 198 | def getOpcode(self, opcode, instrument = None, group = None, region = None, default = None): 199 | if region and opcode in region.keys(): 200 | return region[opcode] 201 | elif group and opcode in group.keys(): 202 | return group[opcode] 203 | elif instrument and opcode in instrument.keys(): 204 | return instrument[opcode] 205 | return default 206 | 207 | 208 | def commitInstrument(self): 209 | if len(self.instrument['groups']) > 0: 210 | if self.getOpcode('loop_start', self.instrument) != None \ 211 | and self.getOpcode('loop_end', self.instrument) != None \ 212 | and not self.getOpcode('loop_mode', self.instrument): 213 | self.instrument['loop_mode'] = 'loop_continuous' 214 | self.soundBank['instruments'].append(self.instrument) 215 | self.instrument = {'groups': []} 216 | 217 | 218 | def commitGroup(self): 219 | if len(self.group['regions']) > 0: 220 | if self.getOpcode('loop_start', self.instrument, self.group) != None \ 221 | and self.getOpcode('loop_end', self.instrument, self.group) != None \ 222 | and not self.getOpcode('loop_mode', self.instrument, self.group): 223 | self.group['loop_mode'] = 'loop_continuous' 224 | self.instrument['groups'].append(self.group) 225 | self.group = {'regions': []} 226 | 227 | 228 | def commitRegion(self): 229 | if len(self.region) > 0: 230 | if self.getOpcode('loop_start', self.instrument, self.group, self.region) != None \ 231 | and self.getOpcode('loop_end', self.instrument, self.group, self.region) != None \ 232 | and not self.getOpcode('loop_mode', self.instrument, self.group, self.region): 233 | self.region['loop_mode'] = 'loop_continuous' 234 | self.group['regions'].append(self.region) 235 | self.region = {} 236 | 237 | 238 | def processOpcode(self, opcode, value): 239 | if opcode == 'sample': 240 | value = os.path.normpath(value.replace('\\', '/')) 241 | elif opcode == 'lokey' \ 242 | or opcode == 'hikey' \ 243 | or opcode == 'pitch_keycenter': 244 | value = self.convertNote(value) 245 | elif opcode == 'key': 246 | value = self.convertNote(value) 247 | self.addOpcode('hikey', value) 248 | self.addOpcode('lokey', value) 249 | self.addOpcode('pitch_keycenter', value) 250 | return True 251 | elif opcode == 'lovel' \ 252 | or opcode == 'hivel': 253 | value = self.convertNumberI(value, -1, 127) 254 | elif opcode == 'volume': 255 | value = self.convertNumberF(value, -144, 6) 256 | elif opcode == 'tune': 257 | value = self.convertNumberI(value, -100, 100) 258 | elif opcode == 'pitch_keytrack': 259 | value = self.convertNumberI(value, -1200, 1200) 260 | elif opcode == 'ampeg_attack' \ 261 | or opcode == 'ampeg_decay' \ 262 | or opcode == 'ampeg_sustain' \ 263 | or opcode == 'ampeg_hold' \ 264 | or opcode == 'ampeg_release': 265 | value = self.convertNumberF(value, 0, 100) 266 | elif opcode == 'loop_start' \ 267 | or opcode == 'loop_end': 268 | value = self.convertNumberI(value, 0, 4294967296) 269 | elif opcode == 'loop_mode': 270 | if not value in ['no_loop', 'one_shot', 'loop_continuous', 'loop_sustain']: 271 | logging.error("Unknown parameter for loop_mode: {}".format(value)) 272 | raise SFZParseError 273 | elif opcode == 'fil_type': 274 | if not value in ['lpf_1p', 'hpf_1p', 'lpf_2p', 'hpf_2p', 'bpf_2p', 'brf_2p']: 275 | logging.error("Unknown parameter for fil_type: {}".format(value)) 276 | raise SFZParseError 277 | elif opcode == 'cutoff': 278 | value = self.convertNumberF(value, 0, 2822400) 279 | elif opcode == 'resonance': 280 | value = self.convertNumberF(value, 0, 40) 281 | elif opcode == 'delay': 282 | value = self.convertNumberF(value, 0, 100) 283 | elif opcode == 'lorand': 284 | value = self.convertNumberF(value, 0, 1) 285 | elif opcode == 'hirand': 286 | value = self.convertNumberF(value, 0, 1) 287 | elif opcode == 'pan': 288 | value = self.convertNumberF(value, -100, 100) 289 | elif opcode == 'seq_length': 290 | value = self.convertNumberI(value, 1, 100) 291 | elif opcode == 'seq_position': 292 | value = self.convertNumberI(value, 1, 100) 293 | elif opcode == 'amp_veltrack': 294 | value = self.convertNumberF(value, -100, 100) 295 | else: 296 | logging.warning("Unknown opcode: {}".format(opcode)) 297 | return True 298 | 299 | self.addOpcode(opcode, value) 300 | return True 301 | 302 | 303 | def addOpcode(self, opcode, value): 304 | if self.insideRegion: 305 | self.region[opcode] = value 306 | elif self.insideGroup: 307 | self.group[opcode] = value 308 | elif self.insideInstrument: 309 | self.instrument[opcode] = value 310 | else: 311 | self.soundBank[opcode] = value 312 | 313 | 314 | def processHint(self, var, value): 315 | if var == 'Name': 316 | if self.insideGroup: 317 | raise SFZParseError 318 | elif var == 'Date': 319 | if self.insideGroup: 320 | raise SFZParseError 321 | try: 322 | date = dateutil.parser.parse(value) 323 | except: 324 | logging.error("Invalid or unknown date format: {}".format(value)) 325 | raise SFZParseError 326 | value = date.strftime('%Y-%m-%d') 327 | elif var == 'URL': 328 | if self.insideGroup: 329 | raise SFZParseError 330 | if not value.startswith(('http://', 'https://', 'ftp://', 'file:')): 331 | raise SFZParseError 332 | elif var == 'Instrument': 333 | if self.insideGroup: 334 | raise SFZParseError 335 | elif var == 'Program': 336 | if self.insideGroup: 337 | raise SFZParseError 338 | value = self.convertNumberI(value, 1, 128) 339 | elif var == 'PercussionMode': 340 | if self.insideGroup or not self.insideInstrument: 341 | raise SFZParseError 342 | value = self.convertBoolean(value) 343 | elif var == 'RandomRegion': 344 | if self.insideRegion or not self.insideGroup: 345 | raise SFZParseError 346 | value = self.convertBoolean(value) 347 | else: 348 | return True 349 | 350 | self.addOpcode(var, value) 351 | return True 352 | 353 | 354 | def convertNumberI(self, numS, minVal, maxVal): 355 | if not re.search('^-?[0-9]+$', numS): 356 | raise SFZParseError 357 | num = int(numS) 358 | if num < minVal or num > maxVal: 359 | raise SFZParseError 360 | return num 361 | 362 | 363 | def convertNumberF(self, numS, minVal, maxVal): 364 | if not re.search('^-?[0-9]*.?[0-9]+$', numS): 365 | raise SFZParseError 366 | num = float(numS) 367 | if num < minVal or num > maxVal: 368 | raise SFZParseError 369 | return num 370 | 371 | def convertBoolean(self, value): 372 | if value == 'Yes': 373 | return True 374 | elif value == 'No': 375 | return False 376 | raise SFZParseError 377 | 378 | def convertNote(self, note): 379 | if re.search('^[0-9]{1,3}$', note): 380 | noteNum = int(note) 381 | if noteNum >= 0 and noteNum <= 127: 382 | return noteNum; 383 | 384 | match = re.search('^([abcdefgABCDEFG])([b#]?)(-?[0-9])$', note) 385 | if not match: 386 | raise SFZParseError 387 | noteNum = SFZ.noteValue[match.group(1).upper()] 388 | if match.group(2): 389 | if match.group(2) == '#': 390 | noteNum += 1 391 | elif match.group(2) == 'b': 392 | noteNum -= 1 393 | octave = int(match.group(3)) 394 | if octave < -1 or octave > 9: 395 | raise SFZParseError 396 | noteNum += (octave + 1) * 12 397 | if noteNum > 127: 398 | raise SFZParseError 399 | return noteNum 400 | 401 | -------------------------------------------------------------------------------- /sf2.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # 3 | # Copyright 2016, roberto@zenvoid.org 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | 15 | # While the implementation of this module is new, the idea of building a SF2 16 | # file from python lists comes from the pysf utility, a public domain program 17 | # to convert from XML descriptions to SoundFont files: 18 | # https://github.com/freepats/tools 19 | 20 | import struct, logging, os, math, sys 21 | import dateutil.parser 22 | import soundfile 23 | 24 | 25 | class SF2ExportError(Exception): 26 | pass 27 | 28 | 29 | class SF2: 30 | 31 | sfGenId = { 32 | 'initialFilterFc': 8, 33 | 'initialFilterQ': 9, 34 | 'pan': 17, 35 | 'delayVolEnv': 33, 36 | 'attackVolEnv': 34, 37 | 'holdVolEnv': 35, 38 | 'decayVolEnv': 36, 39 | 'sustainVolEnv': 37, 40 | 'releaseVolEnv': 38, 41 | 'instrument': 41, 42 | 'keyRange': 43, 43 | 'velRange': 44, 44 | 'velocity': 47, 45 | 'initialAttenuation': 48, 46 | 'fineTune': 52, 47 | 'sampleID': 53, 48 | 'sampleModes': 54, 49 | 'scaleTuning': 56, 50 | 'overridingRootKey': 58 51 | } 52 | 53 | sfGenType = { 54 | 'delayVolEnv': 'h', 55 | 'attackVolEnv': 'h', 56 | 'decayVolEnv': 'h', 57 | 'sustainVolEnv': 'h', 58 | 'holdVolEnv': 'h', 59 | 'releaseVolEnv': 'h', 60 | 'initialFilterFc': 'h', 61 | 'initialFilterQ': 'h', 62 | 'initialAttenuation': 'h', 63 | 'fineTune': 'h', 64 | 'scaleTuning': 'h' 65 | } 66 | 67 | def exportSF2(self, soundBank, fileName): 68 | self.soundBank = soundBank 69 | self.nextProgram = 0 70 | try: 71 | self.outFile = open(fileName, 'wb') 72 | except: 73 | logging.error("Can not create file {}".format(fileName)) 74 | return False 75 | 76 | try: 77 | sf2 = [[[b'RIFF', b'sfbk'], [ 78 | self.sfInfo(), 79 | self.sfSdta(), 80 | self.sfPdta() 81 | ]]] 82 | 83 | self.exportChunks(sf2) 84 | except SF2ExportError: 85 | self.outFile.close() 86 | os.unlink(fileName) 87 | logging.error("Failed to export SF2 to file {}".format(fileName)) 88 | return False 89 | except: 90 | self.outFile.close() 91 | os.unlink(fileName) 92 | logging.error("Failed to export SF2 to file {}".format(fileName)) 93 | raise 94 | 95 | self.outFile.close() 96 | self.outFile = None 97 | self.sampleList = {} 98 | self.shdrData = bytearray() 99 | return True 100 | 101 | 102 | def exportChunks(self, chunks): 103 | for chunk in chunks: 104 | (key, data) = chunk 105 | form = None 106 | if type(key) == list: 107 | (key, form) = key 108 | chunkPos = self.outFile.tell() 109 | self.outFile.write(struct.pack('<4sI', key, 0)) 110 | dataStart = self.outFile.tell() 111 | if form: 112 | self.outFile.write(struct.pack('<4s', form)) 113 | 114 | if type(data) == list: 115 | self.exportChunks(data) 116 | else: 117 | self.outFile.write(data) 118 | 119 | dataEnd = self.outFile.tell() 120 | dataSize = dataEnd - dataStart 121 | self.outFile.seek(chunkPos + 4) 122 | self.outFile.write(struct.pack(' 0: 142 | length += 1 143 | 144 | if length > maxLength: 145 | newString = string[0:maxLength-1] 146 | logging.warning("Truncating string: {}".format(string)) 147 | string = newString 148 | length = maxLength 149 | 150 | return struct.pack('{}s'.format(length), string.encode('ascii')) 151 | 152 | 153 | def percentToCentibels(self, percent): 154 | percent = float(percent) 155 | return int(round(200 * math.log10(100 / percent))) 156 | 157 | 158 | def freqToAbsoluteCents(self, freq): 159 | freq = float(freq) 160 | if freq == 0: 161 | return 1500 162 | value = int(round(1200 * math.log2(freq/440) + 6900)) 163 | if value < 1500: 164 | value = 1500 165 | if value > 13500: 166 | value = 13500 167 | return value 168 | 169 | 170 | def genTime(self, seconds): 171 | if seconds == 0: 172 | return -32768 173 | value = int(round(1200 * math.log2(seconds))) 174 | if value < -32768: 175 | return -32768 176 | if value > 32767: 177 | return 32767 178 | return value 179 | 180 | 181 | def sfInfo(self): 182 | sfMajor = 2 183 | sfMinor = 1 184 | name = 'Sound Bank' 185 | comments = '' 186 | 187 | chunk = [[b'LIST', b'INFO'], [ 188 | [b'ifil', struct.pack('<2H', sfMajor, sfMinor)], 189 | [b'isng', self.sfPackString('EMU8000')] 190 | ]] 191 | if 'Name' in self.soundBank.keys(): 192 | name = self.soundBank['Name'] 193 | chunk[1].append([b'INAM', self.sfPackString(name)]) 194 | if 'Date' in self.soundBank.keys(): 195 | date = dateutil.parser.parse(self.soundBank['Date']) 196 | chunk[1].append([b'ICRD', self.sfPackString(date.strftime('%b %d, %Y'))]) 197 | if 'Author' in self.soundBank.keys(): 198 | chunk[1].append([b'IENG', self.sfPackString(self.soundBank['Author'])]) 199 | if 'URL' in self.soundBank.keys(): 200 | chunk[1].append([b'ICMT', self.sfPackString(self.soundBank['URL'])]) 201 | return chunk 202 | 203 | 204 | def sfSdta(self): 205 | sampleIndex = 0 206 | self.sampleList = {} 207 | self.shdrData = bytearray() 208 | smplData = bytearray() 209 | for instrument in self.soundBank['instruments']: 210 | for group in instrument['groups']: 211 | for region in group['regions']: 212 | sample = self.getOpcode('sample', instrument, group, region) 213 | if not sample or sample in self.sampleList.keys(): 214 | continue 215 | 216 | samplePath = sample 217 | if not os.path.isabs(samplePath) and 'Path' in self.soundBank.keys(): 218 | samplePath = os.path.join(self.soundBank['Path'], sample) 219 | try: 220 | data, rate = soundfile.read(file=samplePath, dtype='int16', always_2d=True) 221 | except: 222 | logging.error("Can not read input audio file {}".format(samplePath)) 223 | raise SF2ExportError 224 | channels = len(data[0]) 225 | if channels < 1: 226 | logging.error("Can not read data from audio file {}".format(samplePath)) 227 | raise SF2ExportError 228 | if channels > 2: 229 | logging.error("Audio file contains more than 2 channels: {}".format(samplePath)) 230 | raise SF2ExportError 231 | 232 | pitch = self.getOpcode('pitch_keycenter', instrument, group, region, 60) 233 | self.sampleList[sample] = [channels, sampleIndex, pitch] 234 | for ch in range(0, channels): 235 | start = len(smplData) // 2 236 | for n in data: 237 | smplData += struct.pack(' 1000: 303 | genList[gen] = 1000 304 | elif gen == 'initialFilterFc': 305 | fil_type = self.getOpcode('fil_type', instrument, group, region) 306 | if fil_type == None or fil_type == 'lpf_2p': 307 | genList[gen] = self.freqToAbsoluteCents(value) 308 | else: 309 | logging.error("SF2 format does not support filter type {}".format(fil_type)) 310 | raise SF2ExportError 311 | elif gen == 'initialFilterQ': 312 | genList[gen] = int(float(value) * 10) 313 | elif gen == 'initialAttenuation': 314 | value = float(value) 315 | if value > 0: 316 | logging.warning("SF2 format does not support amplification (positive volume value)") 317 | genList[gen] = int(-value * 10) 318 | elif gen == 'fineTune': 319 | genList[gen] = int(value) 320 | elif gen == 'scaleTuning': 321 | genList[gen] = int(value) 322 | 323 | loopMode = self.getOpcode('loop_mode', instrument, group, region, 'no_loop') 324 | if loopMode == 'one_shot': 325 | # Simulate one_shot mode using a large value for releaseVolEnv 326 | genList['releaseVolEnv'] = self.genTime(100) 327 | 328 | return genList 329 | 330 | 331 | def getKeyRange(self, instrument): 332 | lokeyMin = 128 333 | hikeyMax = -1 334 | for group in instrument['groups']: 335 | for region in group['regions']: 336 | lokey = self.getOpcode('lokey', instrument, group, region, 0) 337 | if lokey < lokeyMin: 338 | lokeyMin = lokey 339 | hikey = self.getOpcode('hikey', instrument, group, region, 127) 340 | if hikey > hikeyMax: 341 | hikeyMax = hikey 342 | if lokeyMin == 128: 343 | lokeyMin = 0 344 | if hikeyMax == -1: 345 | hikeyMax = 127 346 | return lokeyMin, hikeyMax 347 | 348 | 349 | def sfPdta(self): 350 | instNum = 0 351 | pbagNdx = 0 352 | pgenNdx = 0 353 | ibagNdx = 0 354 | igenNdx = 0 355 | phdrData = bytearray() 356 | pbagData = bytearray() 357 | pgenData = bytearray() 358 | instData = bytearray() 359 | ibagData = bytearray() 360 | igenData = bytearray() 361 | 362 | if 'Instrument' in self.soundBank.keys(): 363 | # Create a main preset which includes all instruments 364 | 365 | instrumentName = self.soundBank['Instrument'] 366 | program = self.nextProgram 367 | if 'Program' in self.soundBank.keys(): 368 | program = self.soundBank['Program'] - 1 369 | else: 370 | self.nextProgram += 1 371 | phdrData += struct.pack('<19sBHHHIII', instrumentName.encode('ascii'), 0, program, 0, pbagNdx, 0, 0, 0) 372 | 373 | for instrument in self.soundBank['instruments']: 374 | pbagData += struct.pack(' 0 or keyMax < 127: 383 | pgenData += struct.pack(' 0 or hivel < 127: 394 | pgenData += struct.pack(' 0 or keyMax < 127: 432 | pgenData += struct.pack(' 0: 448 | # Create a global zone for this instrument 449 | ibagData += struct.pack(' 0 or hikey < 127: 486 | igenData += struct.pack(' 0 or hivel < 127: 497 | igenData += struct.pack(' 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 | --------------------------------------------------------------------------------