Method getDescription

choc/audio/choc_AudioFileFormat.h:387–428

==============================================================================

//==============================================================================
inline std::string AudioFileProperties::getDescription() const
{
    std::string desc;

    if (! formatName.empty())
        desc += "Format: " + formatName + "\n";

    if (sampleRate > 0)
        desc += "Rate: " + std::to_string (static_cast<uint32_t> (sampleRate)) + "Hz\n";

    if (bitDepth != BitDepth::unknown)
        desc += "Bit depth: " + std::string (getBitDepthDescription (bitDepth)) + "\n";

    desc += "Frame count: " + std::to_string (numFrames) + "\n";

    if (sampleRate > 0)
    {
        auto millisecs = (numFrames * 1000u) / static_cast<uint64_t> (sampleRate);
        desc += "Length: " + choc::text::getDurationDescription (std::chrono::milliseconds (millisecs)) + "\n";
    }

    if (numChannels != 0)
        desc += "Channels: " + std::to_string (numChannels) + "\n";

    if (! speakers.empty())
    {
        std::vector<std::string> names;

        for (auto& s : speakers)
            names.push_back (std::string (getSpeakerName (s)));

        desc += "Speakers: " + choc::text::joinStrings (names, ", ") + "\n";
    }

    if (! quality.empty())
        desc += "Quality: " + quality + "\n";

    if (! metadata.isVoid())
        desc += "Metadata: " + choc::json::toString (metadata, true) + "\n";

    return desc;
}

inline AudioFileFormat::AudioFileFormat() = default;
inline AudioFileFormat::~AudioFileFormat() = default;