From 3c36efb7ea5dd8cccd9bcc47f4f6e71ee4cfcbb2 Mon Sep 17 00:00:00 2001
From: Marlon Schumacher <schumacher@hfm-karlsruhe.de>
Date: Wed, 05 Mar 2025 23:03:24 +0100
Subject: [PATCH] chore: more linting for sox-hoaencode class
---
sources/classes/sox-hoaencode.lisp | 22 +++++++++++++++-------
1 files changed, 15 insertions(+), 7 deletions(-)
diff --git a/sources/classes/sox-hoaencode.lisp b/sources/classes/sox-hoaencode.lisp
index cdefebe..c916b79 100644
--- a/sources/classes/sox-hoaencode.lisp
+++ b/sources/classes/sox-hoaencode.lisp
@@ -1,4 +1,6 @@
-;Authors: A. Nguyen, 2025.
+;Authors:
+; A. Nguyen, 2025
+; M. Schumacher, 2025
; Design limitations:
; 1) Sounds must have identical sample rate; otherwise, SoX fails silently, literally.
@@ -36,7 +38,8 @@
; ### Ambisonics ###
-(defun sox-hoaencode-sn3d-factor (order degree) ; andere Nomenklatur, "degree" w�re besser "order" um Verwechslung mit Winkeln zu vermeiden
+(defun sox-hoaencode-sn3d-factor (order degree)
+"This is a placeholder for documentation"
(ecase order
(0 1)
(1 1)
@@ -58,6 +61,7 @@
)
(defun sox-hoaencode-azimuth-factor (degree theta_deg)
+"This is a placeholder for documentation"
(let*
(
(theta (sox-hoaencode-deg-to-rad theta_deg))
@@ -70,6 +74,7 @@
)
(defun sox-hoaencode-elevation-factor (order degree phi_deg)
+"This is a placeholder for documentation"
(let*
(
(phi (sox-hoaencode-deg-to-rad phi_deg))
@@ -99,6 +104,7 @@
; #### Utility functions ####
+#|
(defun sox-hoaencode-auto-convert-positions (positions)
"Ensures that positions are given as '((azimuth elevation) ...) (in degrees), i.e.
1) if list of list of three values, input is assumed to be '(x y z) coordinates and will be transformed to '(azimuth elevation) coordinates (in the navigational spherical coordinate system).
@@ -130,7 +136,7 @@
(t (error "Positions must consist of lists of length 2 (ae) or 3 (xyz)."))
))
(t (error "Positions must be of type 3dc or list."))))
-
+|#
; ####### High-level API ##########
@@ -172,11 +178,13 @@
(defclass! sox-hoaencode (sox-input)
(
- (positions :accessor positions :initarg :positions :initform nil :documentation *sox-hoaencode-positions-doc*)
- (order :accessor order :initarg :order :initform nil :documentation *sox-hoaencode-order-doc*)
+ (gain :accessor gain :initarg :gain :initform 0 :documentation "gain value in dB (decibel)")
+ (azimuth :accessor azimuth :initarg :azimuth :initform 0 :documentation "azimuth angle in degrees")
+ (elevation :accessor elevation :initarg :elevation :initform 0 :documentation "elevation angle in degrees")
+ (order :accessor order :initarg :order :initform 3 :documentation *sox-hoaencode-order-doc*)
)
(:icon 100)
- (:documentation "Sox-hoaencode transforms <sound> into a <order>-th ambisonic (HOA) signal at <positions>.
+ (:documentation "Sox-hoaencode encodes <sound> into a <order>-th ambisonic (HOA) signal at <positions>.
The signal follows the ambiX convention, i.e. it uses SN3D normalization and ACN channel ordering. The resulting file has (<order>+1)^2 channels (order 0: 1 channel, order 1: 4 channels, order 2: 9 channels, order 3: 16 channels, ...).")
)
@@ -184,7 +192,7 @@
(defmethod initialize-instance :after ((self sox-hoaencode) &rest l)
(declare (ignore l))
(when (sound self)
- (sox-init-sound self 'list)
+ (sox-init-sound self 'atom)
)
)
--
Gitblit v1.9.1