kitstarter 0.2.2__tar.gz → 0.3.0__tar.gz

{kitstarter-0.2.2 → kitstarter-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kitstarter
-Version: 0.2.2
+Version: 0.3.0
 Summary: kitstarter is a program you can use to "sketch in" a drumkit SFZ file.
 Author-email: Leon Dionne <ldionne@dridesign.sh.cn>
 Description-Content-Type: text/markdown
@@ -9,7 +9,7 @@ Requires-Dist: PyQt5
 Requires-Dist: soso_qt_extras >= 1.6.0
 Requires-Dist: conn_jack
 Requires-Dist: midi_notes
-Requires-Dist: sfzen >= 1.2.0
+Requires-Dist: sfzen >= 1.2.0, <= 2.0.0
 Requires-Dist: liquiphy
 Requires-Dist: soundfile
 Requires-Dist: jack_audio_player

{kitstarter-0.2.2 → kitstarter-0.3.0}/kitstarter/__init__.py

@@ -15,7 +15,7 @@ from PyQt5.QtWidgets import QApplication, QWidget, QSplitter
 from qt_extras import DevilBox
 from conn_jack import JackConnectError
 
-__version__ = "0.2.2"
+__version__ = "0.3.0"
 
 
 APPLICATION_NAME	= "KitStarter"
@@ -77,13 +77,13 @@ def _geometry_key(widget):
 	"""
 	Automatic QSettings key generated from class name.
 	"""
-	return f'{type(widget).__name__}/geometry'
+	return f'{widget.__class__.__name__}/geometry'
 
 def _splitter_geometry_key(widget, splitter):
 	"""
 	Automatic QSettings key generated from class name.
 	"""
-	return f'{type(widget).__name__}/{splitter.objectName()}/geometry'
+	return f'{widget.__class__.__name__}/{splitter.objectName()}/geometry'
 
 QWidget.restore_geometry = _restore_geometry
 QWidget.save_geometry = _save_geometry

{kitstarter-0.2.2 → kitstarter-0.3.0}/kitstarter/gui/main_window.py

@@ -2,7 +2,10 @@
 #
 #  Copyright 2025 Leon Dionne <ldionne@dridesign.sh.cn>
 #
-import os, logging, platform, subprocess, tempfile
+"""
+Provides MainWindow of the kitstarter application.
+"""
+import os, logging, tempfile
 from os.path import join, dirname, basename, abspath, splitext
 from functools import lru_cache
 from collections import namedtuple
@@ -39,6 +42,9 @@ MESSAGE_TIMEOUT = 3000
 
 
 class MainWindow(QMainWindow):
+	"""
+	User interface of the kitstarter application.
+	"""
 
 	sig_ports_complete = pyqtSignal()	# \
 	sig_sources_changed = pyqtSignal()	#  Used to decouple JackConnectionManager callbacks
@@ -369,7 +375,7 @@ class MainWindow(QMainWindow):
 	# file tree / sample display management
 
 	@pyqtSlot(int)
-	def slot_instrument_changed(self, index):
+	def slot_instrument_changed(self, _):
 		self.chk_filter_instrument.setText('Filter "{}"'.format(
 			self.lst_instruments.currentItem().text()))
 		if self.chk_filter_instrument.isChecked():

{kitstarter-0.2.2 → kitstarter-0.3.0}/kitstarter/gui/samples_widget.py

@@ -2,6 +2,9 @@
 #
 #  Copyright 2025 Leon Dionne <ldionne@dridesign.sh.cn>
 #
+"""
+Provides classes used inside a Qt dialog for editing a multi-sample instrument.
+"""
 import logging
 from os.path import join, basename
 from math import sqrt
@@ -161,23 +164,23 @@ class VelocityGraph(_Track):
 			if self.hover_point_index is None:
 				self.range_change_event(event)
 			else:
-				self.sample._velcurves[self.hover_point_index] = Velcurve(
-					self.sample._velcurves[self.hover_point_index].velocity \
+				self.sample.velcurves[self.hover_point_index] = Velcurve(
+					self.sample.velcurves[self.hover_point_index].velocity \
 						if event.modifiers() & Qt.ControlModifier \
 						else self.x2v(event.x()),
-					self.sample._velcurves[self.hover_point_index].amplitude \
+					self.sample.velcurves[self.hover_point_index].amplitude \
 						if event.modifiers() & Qt.ShiftModifier \
 						else self.y2a(event.y())
 				)
 				self.update()
-		elif event.buttons() == Qt.NoButton and self.sample._velcurves:
+		elif event.buttons() == Qt.NoButton and self.sample.velcurves:
 			near_points = [ (
 				sqrt(
 					pow(abs(self.v2x(velcurve.velocity) - event.x()), 2) +
 					pow(abs(self.a2y(velcurve.amplitude) - event.y()), 2)
 				),
 				index
-			) for index, velcurve in enumerate(self.sample._velcurves) ]
+			) for index, velcurve in enumerate(self.sample.velcurves) ]
 			near_points.sort()
 			hover_point_index = near_points[0][1] if near_points[0][0] < POLAR_SNAP_RANGE else None
 			if hover_point_index != self.hover_point_index:
@@ -192,7 +195,7 @@ class VelocityGraph(_Track):
 				self.hover_point_grabbed = True
 				self.update()
 
-	def mouseReleaseEvent(self, event):
+	def mouseReleaseEvent(self, _):
 		if self.hover_point_grabbed:
 			self.hover_point_grabbed = False
 			self.sig_value_changed.emit()
@@ -240,8 +243,8 @@ class VelocityGraph(_Track):
 			# line across to lovel:
 			points.append(QPointF(self.v2x(self.lovel), self.rect().bottom()))
 
-		if self.sample._velcurves:
-			for velcurve in self.sample._velcurves:
+		if self.sample.velcurves:
+			for velcurve in self.sample.velcurves:
 				points.append(QPointF(self.v2x(velcurve.velocity), self.a2y(velcurve.amplitude)))
 		else:
 			points.append(QPointF(self.v2x(self.lovel), self.v2y(self.lovel)))
@@ -264,7 +267,7 @@ class VelocityGraph(_Track):
 				painter.drawLine(start, end)
 				start = end
 
-		for index, velcurve in enumerate(self.sample._velcurves):
+		for index, velcurve in enumerate(self.sample.velcurves):
 			if self.hover_point_index == index:
 				painter.setPen(self.velcurve_pen_grabbed \
 					if self.hover_point_grabbed else self.velcurve_pen_hover)
@@ -325,7 +328,7 @@ class VelocityGraph(_Track):
 			if lovel < hivel else None
 
 	def update_velcurves(self):
-		velcurves = []
+		self.sample.velcurves = []
 		if self.overlaps:
 			self.overlaps.sort(key = lambda overlap: overlap.lovel)
 			lo_overlap = self.overlaps.pop(0) if self.overlaps[0].lovel == self.lovel else None
@@ -338,21 +341,21 @@ class VelocityGraph(_Track):
 			else:
 				mid_overlaps = []
 			if lo_overlap:
-				velcurves.append(Velcurve(self.lovel, 0.0))
-				velcurves.append(Velcurve(lo_overlap.hivel, self.v2a(lo_overlap.hivel)))
+				self.sample.velcurves.append(Velcurve(self.lovel, 0.0))
+				self.sample.velcurves.append(Velcurve(lo_overlap.hivel, self.v2a(lo_overlap.hivel)))
 			else:
-				velcurves.append(Velcurve(self.lovel, self.v2a(self.lovel)))
+				self.sample.velcurves.append(Velcurve(self.lovel, self.v2a(self.lovel)))
 			for mid_overlap in mid_overlaps:
-				velcurves.append(Velcurve(mid_overlap.lovel, self.v2a(mid_overlap.lovel)))
+				self.sample.velcurves.append(Velcurve(mid_overlap.lovel, self.v2a(mid_overlap.lovel)))
 				mid_overlap_center = mid_overlap.lovel + round((mid_overlap.hivel -  mid_overlap.lovel) / 2)
-				velcurves.append(Velcurve(mid_overlap_center, 0.0))
-				velcurves.append(Velcurve(mid_overlap.hivel, self.v2a(mid_overlap.hivel)))
+				self.sample.velcurves.append(Velcurve(mid_overlap_center, 0.0))
+				self.sample.velcurves.append(Velcurve(mid_overlap.hivel, self.v2a(mid_overlap.hivel)))
 			if hi_overlap:
-				velcurves.append(Velcurve(hi_overlap.lovel, self.v2a(hi_overlap.lovel)))
-				velcurves.append(Velcurve(self.hivel, 0.0))
+				self.sample.velcurves.append(Velcurve(hi_overlap.lovel, self.v2a(hi_overlap.lovel)))
+				self.sample.velcurves.append(Velcurve(self.hivel, 0.0))
 			else:
-				velcurves.append(Velcurve(self.hivel, self.v2a(self.hivel)))
-		self.sample.velcurves = velcurves
+				self.sample.velcurves.append(Velcurve(self.hivel, self.v2a(self.hivel)))
+		self.sample.dirty = True
 		self.update()
 
 
@@ -686,7 +689,7 @@ class SamplesWidget(QWidget):
 
 	def velo_graphs(self):
 		"""
-		Returns a list of VelocityGraph
+		Returns a list of VelocityGraph objects.
 		"""
 		# Exclude first row (scale) and last row (pad)
 		return self.grid.column(COL_GRAPH)[1:-1]
@@ -729,9 +732,9 @@ class SamplesWidget(QWidget):
 	def slot_spread(self):
 		tracks = self.velo_graphs()
 		spread = 127 / len(tracks)
-		for i in range(len(tracks)):
-			tracks[i].lovel = round(i * spread)
-			tracks[i].hivel = round((i + 1) * spread)
+		for i, track in enumerate(tracks):
+			track.lovel = round(i * spread)
+			track.hivel = round((i + 1) * spread)
 		self.find_overlaps()
 		self.slot_value_changed()
 

{kitstarter-0.2.2 → kitstarter-0.3.0}/kitstarter/pindb.py

@@ -2,13 +2,21 @@
 #
 #  Copyright 2025 Leon Dionne <ldionne@dridesign.sh.cn>
 #
-import os, logging, re
-from operator import attrgetter
+"""
+Provides PinDatabase class - an abstraction over an sqlite database which keeps
+track of samples on your hard drive and which instrument(s) thay have been
+"pinned" to.
+"""
+import os, logging
 from sqlite3 import connect
 from appdirs import user_config_dir
 
 
 class PinDatabase():
+	"""
+	An abstraction over an sqlite database which keeps track of samples on your
+	hard drive and which instrument(s) thay have been "pinned" to.
+	"""
 
 	instance = None		# Enforce singleton
 	conn = None

{kitstarter-0.2.2 → kitstarter-0.3.0}/kitstarter/starter_kits.py

@@ -6,12 +6,11 @@
 """
 Provides Drumkit SFZ wrapper which allows import / copy operations.
 """
-import logging
 from os.path import abspath, basename
 from collections import namedtuple
 from midi_notes import Note, MIDI_DRUM_IDS, MIDI_DRUM_NAMES
 from sfzen import SFZ
-from sfzen.drumkits import Drumkit, PITCH_GROUPS, pitch_id_tuple, iter_pitch_by_group
+from sfzen.drumkits import PITCH_GROUPS, pitch_id_tuple, iter_pitch_by_group
 
 Velcurve = namedtuple('Velcurve', ['velocity', 'amplitude'])
 
@@ -50,7 +49,7 @@ class StarterKit:
 							starter_sample._tune = opcodes['tune'].value
 						for code, opcode in region.opcodes.items():
 							if code.startswith('amp_velcurve'):
-								starter_sample._velcurves.append(Velcurve(int(code[13:]), float(opcode.value)))
+								starter_sample.velcurves.append(Velcurve(int(code[13:]), float(opcode.value)))
 						instrument.samples[starter_sample.path] = starter_sample
 
 	def samples(self):
@@ -147,6 +146,9 @@ class StarterInstrument:
 
 
 class StarterSample:
+	"""
+	Contains basic sample info which is compiled into an .sfz opcode.
+	"""
 
 	def __init__(self, path, pitch):
 		self.path = abspath(path)
@@ -156,7 +158,7 @@ class StarterSample:
 		self._volume = 0.0
 		self._transpose = 0
 		self._tune = 0
-		self._velcurves = []
+		self.velcurves = []
 		self.dirty = False
 
 	def __str__(self):
@@ -207,15 +209,6 @@ class StarterSample:
 		self._tune = value
 		self.dirty = True
 
-	@property
-	def velcurves(self):
-		return self._velcurves
-
-	@velcurves.setter
-	def velcurves(self, value):
-		self._velcurves = value
-		self.dirty = True
-
 	def write(self, stream):
 		stream.write('<region>\n')
 		stream.write(f'sample={self.path}\n')
@@ -225,7 +218,7 @@ class StarterSample:
 			stream.write(f'lovel={self._lovel}\n')
 		if self._hivel < 127:
 			stream.write(f'hivel={self._hivel}\n')
-		for point in self._velcurves:
+		for point in self.velcurves:
 			stream.write(f'amp_velcurve_{point.velocity}={point.amplitude:.1f}\n')
 		if self._transpose != 0:
 			stream.write(f'transpose={self._transpose}\n')

{kitstarter-0.2.2 → kitstarter-0.3.0}/pyproject.toml

@@ -10,7 +10,7 @@ dependencies = [
 	"soso_qt_extras >= 1.6.0",
 	"conn_jack",
 	"midi_notes",
-	"sfzen >= 1.2.0",
+	"sfzen >= 1.2.0, <= 2.0.0",
 	"liquiphy",
 	"soundfile",
 	"jack_audio_player"
@@ -27,7 +27,7 @@ requires = ["flit_core >=3.2,<4"]
 build-backend = "flit_core.buildapi"
 
 [bumpver]
-current_version = "0.2.2"
+current_version = "0.3.0"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "Bump version {old_version} -> {new_version}"
 commit = true