From 8940b42ff7b996ce9ca66499454f52b17761b72c Mon Sep 17 00:00:00 2001
From: Marlon Schumacher <schumacher@hfm-karlsruhe.de>
Date: Tue, 11 Mar 2025 16:57:13 +0100
Subject: [PATCH] chore: some cleanups and cosmetic changes
---
sources/classes/sox-hoaencode.lisp | 41 ++++++++++++++++++++++++++++++-----------
1 files changed, 30 insertions(+), 11 deletions(-)
diff --git a/sources/classes/sox-hoaencode.lisp b/sources/classes/sox-hoaencode.lisp
index def1f08..7d2761d 100644
--- a/sources/classes/sox-hoaencode.lisp
+++ b/sources/classes/sox-hoaencode.lisp
@@ -1,19 +1,39 @@
+;*************************************************************************
+; OM-SoX, (c) 2011-2025 Marlon Schumacher (CIRMMT/McGill, HfM Karlsruhe) *
+; http://sourceforge.net/projects/omsox/ *
+; *
+; Multichannel Audio Manipulation and Functional Batch Processing. *
+; DSP based on SoX - (c) C.Bagwell and Contributors *
+; http://sox.sourceforge.net/ *
+;*************************************************************************
+;
+;This program is free software; you can redistribute it and/or
+;modify it under the terms of the GNU General Public License
+;as published by the Free Software Foundation; either version 2
+;of the License, or (at your option) any later version.
+;
+;See file LICENSE for further informations on licensing terms.
+;
+;This program is distributed in the hope that it will be useful,
+;but WITHOUT ANY WARRANTY; without even the implied warranty of
+;MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;GNU General Public License for more details.
+;
+;You should have received a copy of the GNU General Public License
+;along with this program; if not, write to the Free Software
+;Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,10 USA.
+
;Authors:
; A. Nguyen, 2025
; M. Schumacher, 2025
-; Design limitations:
-; 1) Sounds must have identical sample rate; otherwise, SoX fails silently, literally.
-
-; Questions:
-; 1) Is there a built-in (flatten lst)-function? Yes, om:flat
-; 2) Implement up to which order? <=> CLI issues to be expected (e.g., maximum command character length)? max character length for CLI should be changeable
(in-package :om)
;;; SOX-HOAENCODE ========================
-; Util
+; Utility functions
+
(defun flatten (structure)
(cond
((null structure)
@@ -36,7 +56,7 @@
)
)
-; ### Ambisonics ###
+; ### Ambisonics Formulas ###
(defun sox-hoaencode-sn3d-factor (order degree)
"This is a placeholder for documentation"
@@ -203,9 +223,6 @@
(sox-hoaencode-elevation-factor order degree elevation_deg)))
)
-; (sox-hoaencode-gain-single-component 1 1 45 0)
-; @AN: what is the difference between "order" and "degree"?
-
(defun sox-hoaencode-gains-by-order (order azimuth_deg elevation_deg)
"Returns the gain values for all components at a specific order"
@@ -221,6 +238,8 @@
(sox-hoaencode-gains-by-order ord azimuth_deg elevation_deg)))))
+; ####### SoX-HOAENCODE class ##########
+
(defclass! sox-hoaencode (sox-input)
(
(gains :accessor gains :initarg :gains :initform nil :documentation *sox-gain-doc*)
--
Gitblit v1.9.1