Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unified 25d WFS referencing scheme #143

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Unified 25d WFS referencing scheme #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fe7b242
initial commit for unified 2.5D WFS framework
fs446 Apr 17, 2017
9b9304c
initial driving functions for unified 2.5D WFS framework, needs to be…
fs446 Apr 17, 2017
dab14a1
bugfix: ls xPCS, checked against [Fir17] fig. 9 & 10->ok
fs446 Apr 17, 2017
916fc76
added test script for unified 2.5D WFS, added sound_field_mono_unifie…
fs446 Apr 18, 2017
112b6fd
Added some further referencing schemes, also Fig. 7 of IEEE DOI 10.11…
fs446 Apr 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 154 additions & 0 deletions SFS_monochromatic/driving_function_mono_unified_25d_wfs.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
function [D, xPCS] = driving_function_mono_unified_25d_wfs(x0,xs,dx0,src,f,conf)
%DRIVING_FUNCTION_MONO_UNIFIED_25D_WFS returns the driving signal D for WFS
%
% derived driving_function_mono_wfs(x0,xs,src,f,conf)
%
% Usage: D = driving_function_mono_unified_25d_wfs(x0,xs,dx0,src,f,conf)
%
% Input parameters:
% x0 - position and direction of the secondary source / m [nx6]
% xs - position of virtual source or direction of plane
% wave / m [1x3] or [1x6]
% dx0 - amplitude factor of unified 2.5D WFS framework
% to obtain amplitude correct synthesis at desired
% locations, i.e. along a definable reference curve,
% this is primary source AND x0 dependent,
% one dx0 per one x0, thus [nx1]
% src - source type of the virtual source
% 'pw' - plane wave (xs is the direction of the
% plane wave in this case)
% 'ps' - point source
% 'ls' - line source
% 'fs' - focused source
% f - temporal frequency of the monochromatic source / Hz
% conf - configuration struct (see SFS_config)
%
% Output parameters:
% D - driving function temporal spectrum [nx1]
% xPCS - locations of amplitude correct synthesis [nx3]
%
% References:
% [Sch17] Frank Schultz, Gergely Firtha, Peter Fiala, Sascha Spors (2017):
% "Wave Field Synthesis Driving Functions for Large-Scale Sound
% Reinforcement Using Line Source Arrays." In: Proc. of 142nd Audio Eng.
% Soc. Conv., Berlin, #9722.
%
% [Fir17] Gergely Firtha, Peter Fiala, Frank Schultz, Sascha Spors (2017):
% "Improved Referencing Schemes for 2.5D Wave Field Synthesis Driving
% Functions." In: IEEE/ACM Trans Audio Speech Lang Process,
% 25(5):1117-1127, DOI 10.1109/TASLP.2017.2689245
%
% DRIVING_FUNCTION_MONO_UNIFIED_25D_WFS(x0,xs,dx0,src,f,conf)
% returns the driving signal for
% the given secondary sources and desired source type (src) for the
% given temporal frequency using the unified 2.5D WFS framework
%
% See also: plot_sound_field, sound_field_mono_wfs_25d,
% driving_function_imp_wfs_25d

%*****************************************************************************
% The MIT License (MIT) *
% *
% Copyright (c) 2010-2017 SFS Toolbox Developers *
% *
% Permission is hereby granted, free of charge, to any person obtaining a *
% copy of this software and associated documentation files (the "Software"), *
% to deal in the Software without restriction, including without limitation *
% the rights to use, copy, modify, merge, publish, distribute, sublicense, *
% and/or sell copies of the Software, and to permit persons to whom the *
% Software is furnished to do so, subject to the following conditions: *
% *
% The above copyright notice and this permission notice shall be included in *
% all copies or substantial portions of the Software. *
% *
% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *
% THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *
% FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *
% DEALINGS IN THE SOFTWARE. *
% *
% The SFS Toolbox allows to simulate and investigate sound field synthesis *
% methods like wave field synthesis or higher order ambisonics. *
% *
% http://sfstoolbox.org [email protected] *
%*****************************************************************************


%% ===== Checking of input parameters ==================================
nargmin = 6;
nargmax = 6;
narginchk(nargmin,nargmax);
isargsecondarysource(x0);
isargxs(xs);

%isargdx0(dx0); TBD!!!

isargpositivescalar(f);
isargchar(src);
isargstruct(conf);


%% ===== Computation ====================================================
% Calculate the driving function in temporal-frequency domain

% Secondary source positions and directions
nx0 = x0(:,4:6);
x0 = x0(:,1:3);

% Source position/direction/orientation
xs = repmat(xs,[size(x0,1) 1]);

%%
% unified 2.5D WFS framework driving function, cf. [(1), Sch17], [(47), Fir17]
% get driving signals
omega = 2*pi*f;
c = conf.c;
w_c = omega/c;
pre = -sqrt(8*pi/(1i*w_c));

if strcmp('pw',src)
% === Plane wave ===
% directional derivative [(3)&(4), Sch17]:
nk = bsxfun(@rdivide,xs,vector_norm(xs(:,1:3),2)); % propagating direction of plane wave
dP_dn = (-1i*w_c) .*...
vector_product(nk,nx0,2) .*...
exp(-1i.*w_c.*vector_product(nk,x0,2));

xPCS = x0 + nk.*repmat(dx0,[1,3]); %get the locations/positions of
%amplitude correct synthesis, [(8), Sch17]

elseif strcmp('ps',src)
% === Point source ===
% directional derivative [(15)&(16), Sch17]
r = vector_norm(x0-xs,2); % r = |x0-xs|
dP_dn = (-1i*w_c) .*...
(vector_product(x0-xs,nx0,2)./r) .*...
(exp(-1i.*w_c.*r)./(4*pi*r));

xPCS = x0 + (x0-xs) .* repmat(dx0./(r-dx0),[1,3]); %get the locations
%/positions of amplitude correct synthesis, [(20), Sch17],
%[(33)&(34), Fir17]

elseif strcmp('ls',src)
% === Line source ===
% directional derivative [(10), Sch17]
r = vector_norm(x0-xs,2); % r = |x0-xs|
dP_dn = (1i*w_c)/4 .*...
(vector_product(x0-xs,nx0,2)./r) .*...
besselh(1,2,w_c.*r);

xPCS = x0 + ((x0-xs)./repmat(r,[1,3])).*repmat(dx0,[1,3]); %get the locations/
%positions of amplitude correct synthesis, [(14), Sch17]

elseif strcmp('fs',src)
% === Focused source ===
error('%s: %s is not implemented yet.',upper(mfilename),src);
else
error('%s: %s is not a known source type.',upper(mfilename),src);
end
% put all together for driving function
D = pre .* sqrt(dx0) .* dP_dn;

end
108 changes: 108 additions & 0 deletions SFS_monochromatic/sound_field_mono_unified_25d_wfs.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
function varargout = sound_field_mono_unified_25d_wfs(X,Y,Z,xs,src,f,conf,dx0)
%SOUND_FIELD_MONO_UNIFIED_25D_WFS simulates a sound field for unified 2.5D WFS
%
% Usage: [P,x,y,z,x0] = sound_field_mono_wfs(X,Y,Z,xs,src,f,conf)
%
% Input parameters:
% X - x-axis / m; single value or [xmin,xmax] or nD-array
% Y - y-axis / m; single value or [ymin,ymax] or nD-array
% Z - z-axis / m; single value or [zmin,zmax] or nD-array
% xs - position of virtual source / m
% src - source type of the virtual source
% 'pw' - plane wave (xs is the direction of the
% plane wave in this case)
% 'ps' - point source
% 'fs' - focused source
% f - monochromatic frequency / Hz
% conf - configuration struct (see SFS_config)
% dx0 - amplitude factor of unified 2.5D WFS framework
% (i.e. the referencing function)
% to obtain amplitude correct synthesis at desired
% locations, i.e. along a definable reference curve,
% this is primary source AND x0 dependent,
% one dx0 per one x0
%
% Output parameters:
% P - simulated sound field
% x - corresponding x values / m
% y - corresponding y values / m
% z - corresponding z values / m
% x0 - active secondary sources / m
% xPCS - positions/locations of amplitude correct synthesis
% i.e. the reference curve
% SOUND_FIELD_MONO_UNIFIED_25D_WFS(X,Y,Z,xs,src,f,conf,dx0) simulates a monochromatic sound
% field for the given source type (src) synthesized with wave field synthesis.
%
% driving_function_mono_unified_25d_wfs() is used for driving
% functions
%
% To plot the result use:
% plot_sound_field(P,X,Y,Z,x0,conf);
% or simple call the function without output argument:
% sound_field_mono_wfs(X,Y,Z,xs,src,f,conf)
%
% See also: plot_sound_field, sound_field_imp_wfs, driving_function_mono_wfs

%*****************************************************************************
% The MIT License (MIT) *
% *
% Copyright (c) 2010-2017 SFS Toolbox Developers *
% *
% Permission is hereby granted, free of charge, to any person obtaining a *
% copy of this software and associated documentation files (the "Software"), *
% to deal in the Software without restriction, including without limitation *
% the rights to use, copy, modify, merge, publish, distribute, sublicense, *
% and/or sell copies of the Software, and to permit persons to whom the *
% Software is furnished to do so, subject to the following conditions: *
% *
% The above copyright notice and this permission notice shall be included in *
% all copies or substantial portions of the Software. *
% *
% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *
% THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *
% FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *
% DEALINGS IN THE SOFTWARE. *
% *
% The SFS Toolbox allows to simulate and investigate sound field synthesis *
% methods like wave field synthesis or higher order ambisonics. *
% *
% http://sfstoolbox.org [email protected] *
%*****************************************************************************


%% ===== Checking of input parameters ==================================
nargmin = 8;
nargmax = 8;
narginchk(nargmin,nargmax);
isargxs(xs);
isargpositivescalar(f);
isargchar(src);
isargstruct(conf);


%% ===== Configuration ==================================================
if strcmp('2D',conf.dimension)
greens_function = 'ls';
else
greens_function = 'ps';
end


%% ===== Computation ====================================================
% Get the position of the loudspeakers and its activity
x0 = secondary_source_positions(conf);
x0 = secondary_source_selection(x0,xs,src);
x0 = secondary_source_tapering(x0,conf);

%%
% Driving function
[D, xPCS] = driving_function_mono_unified_25d_wfs(x0,xs,dx0,src,f,conf);
% Wave field
[varargout{1:min(nargout,4)}] = ...
sound_field_mono(X,Y,Z,x0,greens_function,D,f,conf);
% Return secondary sources if desired
if nargout==5, varargout{5}=x0; end
if nargout==6, varargout{5}=x0; varargout{6}=xPCS; end
Loading