LibImportExport::Test::LibsndfileTagger Class Reference

When adding tags, the allocated memory must be preserved until the file is closed. This class handles that, beside the regular file opening and closing. More...

#include <LibsndfileTagger.h>

Collaboration diagram for LibImportExport::Test::LibsndfileTagger:

Public Member Functions
	LibsndfileTagger (double duration=0., const std::string &filename="")
	~LibsndfileTagger ()
	operator bool () const
void	AddAcidizerTags (const Test::AcidizerTags &acidTags)
void	AddDistributorInfo (const std::string &distributor)
SNDFILE &	ReopenInReadMode ()

Private Attributes
const std::string	mFilename
SNDFILE *	mFile
std::unique_ptr< uint8_t[]>	mAcidData
std::unique_ptr< uint8_t[]>	mDistributorData

Detailed Description

When adding tags, the allocated memory must be preserved until the file is closed. This class handles that, beside the regular file opening and closing.

Definition at line 59 of file LibsndfileTagger.h.

Constructor & Destructor Documentation

LibsndfileTagger()

LibImportExport::Test::LibsndfileTagger::LibsndfileTagger	(	double	duration = 0.,
		const std::string &	filename = ""
	)

Definition at line 16 of file LibsndfileTagger.cpp.

    : mFilename { filename.empty() ? std::tmpnam(nullptr) : filename }
{
   SF_INFO sfInfo;
   std::memset(&sfInfo, 0, sizeof(sfInfo));
   sfInfo.samplerate = 44100;
   sfInfo.channels = 1;
   sfInfo.format = SF_FORMAT_WAV | SF_FORMAT_PCM_16;
   sfInfo.sections = 1;
   sfInfo.seekable = 1;
   mFile = sf_open(mFilename.c_str(), SFM_WRITE, &sfInfo);
   assert(mFile != nullptr);
   if (duration > 0)
   {
      // Write zeros using sf_write_float
      sfInfo.frames =
         static_cast<sf_count_t>(std::round(duration * sfInfo.samplerate));
      const auto numItems = sfInfo.channels * sfInfo.frames;
      std::unique_ptr<short[]> zeros { new short[numItems] };
      std::fill(zeros.get(), zeros.get() + numItems, 0);
      const auto written = sf_write_short(mFile, zeros.get(), numItems);
      if (written != numItems)
         throw std::runtime_error("Failed to write audio to file");
   }
}

References mFile, mFilename, and fast_float::round().

Here is the call graph for this function:

~LibsndfileTagger()

LibImportExport::Test::LibsndfileTagger::~LibsndfileTagger

(

)

Definition at line 42 of file LibsndfileTagger.cpp.

{
   sf_close(mFile);
}

References mFile.

Member Function Documentation

AddAcidizerTags()

void LibImportExport::Test::LibsndfileTagger::AddAcidizerTags

(

const Test::AcidizerTags &

acidTags

)

Definition at line 68 of file LibsndfileTagger.cpp.

{
   // Adapted from the ACID chunk readout code in libsndfile and its comment:
   // clang-format off
   /*
   ** The acid chunk goes a little something like this:
   **
   ** 4 bytes          'acid'
   ** 4 bytes (int)     length of chunk starting at next byte
   **
   ** 4 bytes (int)     type of file:
   **        this appears to be a bit mask,however some combinations
   **        are probably impossible and/or qualified as "errors"
   **
   **        0x01 On: One Shot         Off: Loop
   **        0x02 On: Root note is Set Off: No root
   **        0x04 On: Stretch is On,   Off: Strech is OFF
   **        0x08 On: Disk Based       Off: Ram based
   **        0x10 On: ??????????       Off: ????????? (Acidizer puts that ON)
   **
   ** 2 bytes (short)      root note
   **        if type 0x10 is OFF : [C,C#,(...),B] -> [0x30 to 0x3B]
   **        if type 0x10 is ON  : [C,C#,(...),B] -> [0x3C to 0x47]
   **         (both types fit on same MIDI pitch albeit different octaves, so who cares)
   **
   ** 2 bytes (short)      ??? always set to 0x8000
   ** 4 bytes (float)      ??? seems to be always 0
   ** 4 bytes (int)        number of beats
   ** 2 bytes (short)      meter denominator   //always 4 in SF/ACID
   ** 2 bytes (short)      meter numerator     //always 4 in SF/ACID
   **                      //are we sure about the order?? usually its num/denom
   ** 4 bytes (float)      tempo
   **
   */
   // clang-format on
 
   SF_LOOP_INFO loopInfo {};
   loopInfo.bpm = acidTags.bpm.value_or(0.);
   loopInfo.loop_mode = acidTags.isOneShot ? SF_LOOP_NONE : SF_LOOP_FORWARD;
 
   SF_CHUNK_INFO chunk;
   std::memset(&chunk, 0, sizeof(chunk));
   std::snprintf(chunk.id, sizeof(chunk.id), "acid");
   chunk.id_size = 4;
   // All sizes listed above except the first two:
   chunk.datalen = 4 + 2 + 2 + 4 + 4 + 2 + 2 + 4;
   mAcidData = std::make_unique<uint8_t[]>(chunk.datalen);
   std::memset(mAcidData.get(), 0, chunk.datalen);
   chunk.data = mAcidData.get();
 
   // The type has 4 bytes, of which we may only set the 1st bit to 1 if the
   // loop is one-shot:
   if (acidTags.isOneShot)
   {
      auto type = reinterpret_cast<uint32_t*>(mAcidData.get());
      *type |= 0x00000001;
   }
   else if (acidTags.beats.has_value())
   {
      auto numBeats = reinterpret_cast<uint32_t*>(mAcidData.get() + 12);
      *numBeats = *acidTags.beats;
   }
   else
   {
      assert(acidTags.bpm.has_value());
      auto tempo = reinterpret_cast<float*>(mAcidData.get() + 20);
      *tempo = *acidTags.bpm;
   }
 
   // Set the meter denominator 2 bytes to 4:
   auto numerator = reinterpret_cast<uint16_t*>(mAcidData.get() + 16);
   *numerator |= 0x0004;
   auto denominator = reinterpret_cast<uint16_t*>(mAcidData.get() + 18);
   *denominator |= 0x0004;
 
   const auto result = sf_set_chunk(mFile, &chunk);
   assert(result == SF_ERR_NO_ERROR);
}

References LibImportExport::Test::AcidizerTags::beats, LibFileFormats::AcidizerTags::bpm, LibFileFormats::AcidizerTags::isOneShot, mAcidData, and mFile.

Referenced by LibImportExport::TEST_CASE().

Here is the caller graph for this function:

AddDistributorInfo()

void LibImportExport::Test::LibsndfileTagger::AddDistributorInfo

(

const std::string &

distributor

)

Definition at line 147 of file LibsndfileTagger.cpp.

{
   const uint32_t distributorSize = distributor.size();
   // Why we didn't use `auto` the line above:
   static_assert(sizeof(distributorSize) == 4);
   SF_CHUNK_INFO chunk;
   std::snprintf(chunk.id, sizeof(chunk.id), "LIST");
   chunk.id_size = 4;
   constexpr std::array<char, 4> listTypeID = { 'I', 'N', 'F', 'O' };
   constexpr std::array<char, 4> distributorTypeID = { 'I', 'D', 'S', 'T' };
   chunk.datalen = sizeof(listTypeID) + sizeof(distributorTypeID) +
                   sizeof(distributorSize) + distributorSize;
   // A trick taken from libsndfile's source code, probably to ensure that
   // the rest of the data stays word-aligned:
   while (chunk.datalen & 3)
      ++chunk.datalen;
   mDistributorData = std::make_unique<uint8_t[]>(chunk.datalen);
   chunk.data = mDistributorData.get();
   auto data = mDistributorData.get();
   std::memset(chunk.data, 0, chunk.datalen);
   auto pos = 0;
 
   std::memcpy(data + pos, listTypeID.data(), sizeof(listTypeID));
 
   pos += sizeof(listTypeID);
   std::memcpy(data + pos, distributorTypeID.data(), sizeof(distributorTypeID));
 
   pos += sizeof(distributorTypeID);
   std::memcpy(data + pos, &distributorSize, sizeof(distributorSize));
 
   pos += sizeof(distributorSize);
   std::memcpy(data + pos, distributor.data(), distributorSize);
 
   const auto result = sf_set_chunk(mFile, &chunk);
   assert(result == SF_ERR_NO_ERROR);
}

References mDistributorData, and mFile.

Referenced by LibImportExport::TEST_CASE().

Here is the caller graph for this function:

operator bool()

LibImportExport::Test::LibsndfileTagger::operator bool

(

)

const

Definition at line 47 of file LibsndfileTagger.cpp.

{
   return mFile != nullptr;
}

ReopenInReadMode()

SNDFILE & LibImportExport::Test::LibsndfileTagger::ReopenInReadMode

(

)

Definition at line 52 of file LibsndfileTagger.cpp.

{
   if (!mFile)
      throw std::runtime_error("File is not open");
 
   sf_close(mFile);
   mDistributorData.reset();
   mAcidData.reset();
 
   SF_INFO sfInfo;
   mFile = sf_open(mFilename.c_str(), SFM_READ, &sfInfo);
   if (!mFile)
      throw std::runtime_error("Failed to re-open file");
   return *mFile;
}

References mAcidData, mDistributorData, mFile, and mFilename.

Referenced by LibImportExport::TEST_CASE().

Here is the caller graph for this function:

Member Data Documentation

mAcidData

std::unique_ptr<uint8_t[]> LibImportExport::Test::LibsndfileTagger::mAcidData

private

Definition at line 73 of file LibsndfileTagger.h.

Referenced by AddAcidizerTags(), and ReopenInReadMode().

mDistributorData

std::unique_ptr<uint8_t[]> LibImportExport::Test::LibsndfileTagger::mDistributorData

private

Definition at line 74 of file LibsndfileTagger.h.

Referenced by AddDistributorInfo(), and ReopenInReadMode().

mFile

SNDFILE* LibImportExport::Test::LibsndfileTagger::mFile

private

Definition at line 72 of file LibsndfileTagger.h.

Referenced by AddAcidizerTags(), AddDistributorInfo(), LibsndfileTagger(), ReopenInReadMode(), and ~LibsndfileTagger().

mFilename

const std::string LibImportExport::Test::LibsndfileTagger::mFilename

private

Definition at line 71 of file LibsndfileTagger.h.

Referenced by LibsndfileTagger(), and ReopenInReadMode().

---

The documentation for this class was generated from the following files:

• LibsndfileTagger.h
• LibsndfileTagger.cpp