Skip to content

Commit

Permalink
Avoid raw pointers in uhjdecoder/uhjencoder
Browse files Browse the repository at this point in the history
  • Loading branch information
@kcat
kcat committed Mar 21, 2024
1 parent 4a74b22 commit a8ead85
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 92 deletions.
104 changes: 58 additions & 46 deletions utils/uhjdecoder.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,26 @@

#include "config.h"

#include <algorithm>
#include <array>
#include <cassert>
#include <cerrno>
#include <complex>
#include <cstddef>
#include <cstdio>
#include <cstring>
#include <memory>
#include <string>
#include <string_view>
#include <system_error>
#include <utility>
#include <vector>

#include "albit.h"
#include "alcomplex.h"
#include "almalloc.h"
#include "alnumbers.h"
#include "alspan.h"
#include "alstring.h"
#include "vector.h"
#include "opthelpers.h"
#include "phase_shifter.h"
Expand All @@ -48,6 +53,8 @@
#include "win_main_utf8.h"


namespace {

struct FileDeleter {
void operator()(gsl::owner<FILE*> file) { fclose(file); }
};
Expand Down Expand Up @@ -85,23 +92,15 @@ void fwrite32le(uint val, FILE *f)
fwrite(data.data(), 1, data.size(), f);
}

template<al::endian = al::endian::native>
byte4 f32AsLEBytes(const float &value) = delete;

template<>
byte4 f32AsLEBytes<al::endian::little>(const float &value)
{
byte4 ret{};
std::memcpy(ret.data(), &value, 4);
return ret;
}
template<>
byte4 f32AsLEBytes<al::endian::big>(const float &value)
byte4 f32AsLEBytes(const float &value)
{
byte4 ret{};
std::memcpy(ret.data(), &value, 4);
std::swap(ret[0], ret[3]);
std::swap(ret[1], ret[2]);
if constexpr(al::endian::native == al::endian::big)
{
std::swap(ret[0], ret[3]);
std::swap(ret[1], ret[2]);
}
return ret;
}

Expand All @@ -126,9 +125,9 @@ struct UhjDecoder {

alignas(16) std::array<float,BufferLineSize + sFilterDelay*2> mTemp{};

void decode(const float *RESTRICT InSamples, const std::size_t InChannels,
void decode(const al::span<const float> InSamples, const std::size_t InChannels,
const al::span<FloatBufferLine> OutSamples, const std::size_t SamplesToDo);
void decode2(const float *RESTRICT InSamples, const al::span<FloatBufferLine> OutSamples,
void decode2(const al::span<const float> InSamples, const al::span<FloatBufferLine> OutSamples,
const std::size_t SamplesToDo);
};

Expand Down Expand Up @@ -208,14 +207,14 @@ const PhaseShifterT<UhjDecoder::sFilterDelay*2> PShift{};
*
* Not halving produces a result matching the original input.
*/
void UhjDecoder::decode(const float *RESTRICT InSamples, const std::size_t InChannels,
void UhjDecoder::decode(const al::span<const float> InSamples, const std::size_t InChannels,
const al::span<FloatBufferLine> OutSamples, const std::size_t SamplesToDo)
{
ASSUME(SamplesToDo > 0);

float *woutput{OutSamples[0].data()};
float *xoutput{OutSamples[1].data()};
float *youtput{OutSamples[2].data()};
auto woutput = al::span{OutSamples[0]};
auto xoutput = al::span{OutSamples[1]};
auto youtput = al::span{OutSamples[2]};

/* Add a delay to the input channels, to align it with the all-passed
* signal.
Expand Down Expand Up @@ -247,7 +246,7 @@ void UhjDecoder::decode(const float *RESTRICT InSamples, const std::size_t InCha
std::transform(mD.cbegin(), mD.cbegin()+SamplesToDo+sFilterDelay, mT.cbegin(), tmpiter,
[](const float d, const float t) noexcept { return 0.828331f*d + 0.767820f*t; });
std::copy_n(mTemp.cbegin()+SamplesToDo, mDTHistory.size(), mDTHistory.begin());
PShift.process({xoutput, SamplesToDo}, mTemp.data());
PShift.process(xoutput.first(SamplesToDo), mTemp.data());

for(std::size_t i{0};i < SamplesToDo;++i)
{
Expand All @@ -261,7 +260,7 @@ void UhjDecoder::decode(const float *RESTRICT InSamples, const std::size_t InCha
tmpiter = std::copy(mSHistory.cbegin(), mSHistory.cend(), mTemp.begin());
std::copy_n(mS.cbegin(), SamplesToDo+sFilterDelay, tmpiter);
std::copy_n(mTemp.cbegin()+SamplesToDo, mSHistory.size(), mSHistory.begin());
PShift.process({youtput, SamplesToDo}, mTemp.data());
PShift.process(youtput.first(SamplesToDo), mTemp.data());

for(std::size_t i{0};i < SamplesToDo;++i)
{
Expand All @@ -271,7 +270,7 @@ void UhjDecoder::decode(const float *RESTRICT InSamples, const std::size_t InCha

if(OutSamples.size() > 3)
{
float *zoutput{OutSamples[3].data()};
auto zoutput = al::span{OutSamples[3]};
/* Z = 1.023332*Q */
for(std::size_t i{0};i < SamplesToDo;++i)
zoutput[i] = 1.023332f*mQ[i];
Expand Down Expand Up @@ -302,14 +301,14 @@ void UhjDecoder::decode(const float *RESTRICT InSamples, const std::size_t InCha
* NOTE: As above, S and D should not be halved. The only consequence of
* halving here is merely a -6dB reduction in output, but it's still incorrect.
*/
void UhjDecoder::decode2(const float *RESTRICT InSamples,
void UhjDecoder::decode2(const al::span<const float> InSamples,
const al::span<FloatBufferLine> OutSamples, const std::size_t SamplesToDo)
{
ASSUME(SamplesToDo > 0);

float *woutput{OutSamples[0].data()};
float *xoutput{OutSamples[1].data()};
float *youtput{OutSamples[2].data()};
auto woutput = al::span{OutSamples[0]};
auto xoutput = al::span{OutSamples[1]};
auto youtput = al::span{OutSamples[2]};

/* S = Left + Right */
for(std::size_t i{0};i < SamplesToDo;++i)
Expand All @@ -323,7 +322,7 @@ void UhjDecoder::decode2(const float *RESTRICT InSamples,
auto tmpiter = std::copy(mDTHistory.cbegin(), mDTHistory.cend(), mTemp.begin());
std::copy_n(mD.cbegin(), SamplesToDo+sFilterDelay, tmpiter);
std::copy_n(mTemp.cbegin()+SamplesToDo, mDTHistory.size(), mDTHistory.begin());
PShift.process({xoutput, SamplesToDo}, mTemp.data());
PShift.process(xoutput.first(SamplesToDo), mTemp.data());

for(std::size_t i{0};i < SamplesToDo;++i)
{
Expand All @@ -337,7 +336,7 @@ void UhjDecoder::decode2(const float *RESTRICT InSamples,
tmpiter = std::copy(mSHistory.cbegin(), mSHistory.cend(), mTemp.begin());
std::copy_n(mS.cbegin(), SamplesToDo+sFilterDelay, tmpiter);
std::copy_n(mTemp.cbegin()+SamplesToDo, mSHistory.size(), mSHistory.begin());
PShift.process({youtput, SamplesToDo}, mTemp.data());
PShift.process(youtput.first(SamplesToDo), mTemp.data());

for(std::size_t i{0};i < SamplesToDo;++i)
{
Expand All @@ -350,47 +349,48 @@ void UhjDecoder::decode2(const float *RESTRICT InSamples,
}


int main(int argc, char **argv)
int main(al::span<std::string_view> args)
{
if(argc < 2 || std::strcmp(argv[1], "-h") == 0 || std::strcmp(argv[1], "--help") == 0)
if(args.size() < 2 || args[1] == "-h" || args[1] == "--help")
{
printf("Usage: %s <[options] filename.wav...>\n\n"
printf("Usage: %.*s <[options] filename.wav...>\n\n"
" Options:\n"
" --general Use the general equations for 2-channel UHJ (default).\n"
" --alternative Use the alternative equations for 2-channel UHJ.\n"
"\n"
"Note: When decoding 2-channel UHJ to an .amb file, the result should not use\n"
"the normal B-Format shelf filters! Only 3- and 4-channel UHJ can accurately\n"
"reconstruct the original B-Format signal.",
argv[0]);
al::sizei(args[0]), args[0].data());
return 1;
}

std::size_t num_files{0}, num_decoded{0};
bool use_general{true};
for(int fidx{1};fidx < argc;++fidx)
for(size_t fidx{1};fidx < args.size();++fidx)
{
if(std::strcmp(argv[fidx], "--general") == 0)
if(args[fidx] == "--general")
{
use_general = true;
continue;
}
if(std::strcmp(argv[fidx], "--alternative") == 0)
if(args[fidx] == "--alternative")
{
use_general = false;
continue;
}
++num_files;
SF_INFO ininfo{};
SndFilePtr infile{sf_open(argv[fidx], SFM_READ, &ininfo)};
SndFilePtr infile{sf_open(std::string{args[fidx]}.c_str(), SFM_READ, &ininfo)};
if(!infile)
{
fprintf(stderr, "Failed to open %s\n", argv[fidx]);
fprintf(stderr, "Failed to open %.*s\n", al::sizei(args[fidx]), args[fidx].data());
continue;
}
if(sf_command(infile.get(), SFC_WAVEX_GET_AMBISONIC, nullptr, 0) == SF_AMBISONIC_B_FORMAT)
{
fprintf(stderr, "%s is already B-Format\n", argv[fidx]);
fprintf(stderr, "%.*s is already B-Format\n", al::sizei(args[fidx]),
args[fidx].data());
continue;
}
uint outchans{};
Expand All @@ -400,13 +400,15 @@ int main(int argc, char **argv)
outchans = static_cast<uint>(ininfo.channels);
else
{
fprintf(stderr, "%s is not a 2-, 3-, or 4-channel file\n", argv[fidx]);
fprintf(stderr, "%.*s is not a 2-, 3-, or 4-channel file\n", al::sizei(args[fidx]),
args[fidx].data());
continue;
}
printf("Converting %s from %d-channel UHJ%s...\n", argv[fidx], ininfo.channels,
printf("Converting %.*s from %d-channel UHJ%s...\n", al::sizei(args[fidx]),
args[fidx].data(), ininfo.channels,
(ininfo.channels == 2) ? use_general ? " (general)" : " (alternative)" : "");

std::string outname{argv[fidx]};
std::string outname{args[fidx]};
auto lastslash = outname.find_last_of('/');
if(lastslash != std::string::npos)
outname.erase(0, lastslash+1);
Expand Down Expand Up @@ -481,16 +483,16 @@ int main(int argc, char **argv)
if(sgot < BufferLineSize)
{
const sf_count_t remaining{std::min(BufferLineSize - sgot, LeadOut)};
std::fill_n(inmem.data() + sgot*ininfo.channels, remaining*ininfo.channels, 0.0f);
std::fill_n(inmem.begin() + sgot*ininfo.channels, remaining*ininfo.channels, 0.0f);
sgot += remaining;
LeadOut -= remaining;
}

auto got = static_cast<std::size_t>(sgot);
if(ininfo.channels > 2 || use_general)
decoder->decode(inmem.data(), static_cast<uint>(ininfo.channels), decmem, got);
decoder->decode(inmem, static_cast<uint>(ininfo.channels), decmem, got);
else
decoder->decode2(inmem.data(), decmem, got);
decoder->decode2(inmem, decmem, got);
if(LeadIn >= got)
{
LeadIn -= got;
Expand Down Expand Up @@ -536,3 +538,13 @@ int main(int argc, char **argv)
printf("Decoded %zu file%s\n", num_decoded, (num_decoded==1)?"":"s");
return 0;
}

} /* namespace */

int main(int argc, char *argv[])
{
assert(argc >= 0);
auto args = std::vector<std::string_view>(static_cast<unsigned int>(argc));
std::copy_n(argv, args.size(), args.begin());
return main(al::span{args});
}
Loading

0 comments on commit a8ead85

Please sign in to comment.