audiooutputsettings.cpp

Go to the documentation of this file.

/* -*- Mode: c++ -*-
 *
 * Copyright (C) 2010 foobum@gmail.com and jyavenard@gmail.com
 *
 * Licensed under the GPL v2 or a later version at your choosing.
 */
 
#include <algorithm>
#include <array>
#include <vector>
 
#include "libmythbase/mythcorecontext.h"
#include "libmythbase/mythlogging.h"
 
#include "audiooutputsettings.h"
#include "eldutils.h"
 
extern "C" {
#include "libavcodec/defs.h"
#include "libavutil/avutil.h"    // to check version of libavformat
}
 
#define LOC QString("AOS: ")
 
const rate_array AudioOutputSettings::kStdRates
{
    5512, 8000,  11025, 16000, 22050, 32000,  44100,
    48000, 88200, 96000, 176400, 192000
};
 
const format_array AudioOutputSettings::kStdFormats
{
    FORMAT_U8,  FORMAT_S16, FORMAT_S24LSB, FORMAT_S24, FORMAT_S32, FORMAT_FLT
};
 
AudioOutputSettings::AudioOutputSettings(bool invalid) :
    m_invalid(invalid),
    m_srIt(kStdRates.begin()),
    m_sfIt(kStdFormats.begin())
{
}
 
AudioOutputSettings::~AudioOutputSettings()
{
    m_rates.clear();
    m_formats.clear();
    m_channels.clear();
}
 
AudioOutputSettings& AudioOutputSettings::operator=(
    const AudioOutputSettings &rhs)
{
    if (this == &rhs)
        return *this;
    m_rates         = rhs.m_rates;
    m_formats       = rhs.m_formats;
    m_channels      = rhs.m_channels;
    m_passthrough   = rhs.m_passthrough;
    m_features      = rhs.m_features;
    m_invalid       = rhs.m_invalid;
    m_hasEld        = rhs.m_hasEld;
    m_eld           = rhs.m_eld;
    m_srIt          = kStdRates.begin() + (rhs.m_srIt - kStdRates.begin());
    m_sfIt          = kStdFormats.begin() + (rhs.m_sfIt - kStdFormats.begin());
    return *this;
}
 
int AudioOutputSettings::GetNextRate()
{
    if (m_srIt == kStdRates.end())
    {
        m_srIt = kStdRates.begin();
        return 0;
    }
 
    return *m_srIt++;
}
 
void AudioOutputSettings::AddSupportedRate(int rate)
{
    m_rates.push_back(rate);
    LOG(VB_AUDIO, LOG_INFO, LOC +
        QString("Sample rate %1 is supported").arg(rate));
}
 
bool AudioOutputSettings::IsSupportedRate(int rate)
{
    if (m_rates.empty() && rate == 48000)
        return true;
 
#ifdef __cpp_lib_ranges_contains
    return std::ranges::contains(m_rates, rate);
#else
    auto result = std::ranges::find(m_rates, rate);
    return result != m_rates.end();
#endif
}
 
int AudioOutputSettings::BestSupportedRate()
{
    if (m_rates.empty())
        return 48000;
    return m_rates.back();
}
 
int AudioOutputSettings::NearestSupportedRate(int rate)
{
    if (m_rates.empty())
        return 48000;
 
    // Assume rates vector is sorted
    auto it = std::ranges::find_if(m_rates,
                           [rate](const auto entry){ return entry >= rate; } );
    if (it != m_rates.end())
        return *it;
 
    // Not found, so return highest available rate
    return m_rates.back();
}
 
AudioFormat AudioOutputSettings::GetNextFormat()
{
    if (m_sfIt == kStdFormats.end())
    {
        m_sfIt = kStdFormats.begin();
        return FORMAT_NONE;
    }
 
    return *m_sfIt++;
}
 
void AudioOutputSettings::AddSupportedFormat(AudioFormat format)
{
    LOG(VB_AUDIO, LOG_INFO, LOC +
        QString("Format %1 is supported").arg(FormatToString(format)));
    m_formats.push_back(format);
}
 
bool AudioOutputSettings::IsSupportedFormat(AudioFormat format)
{
    if (m_formats.empty() && format == FORMAT_S16)
        return true;
 
#ifdef __cpp_lib_ranges_contains
    return std::ranges::contains(m_formats, format);
#else
    auto result = std::ranges::find(m_formats, format);
    return result != m_formats.end();
#endif
}
 
AudioFormat AudioOutputSettings::BestSupportedFormat()
{
    if (m_formats.empty())
        return FORMAT_S16;
    return m_formats.back();
}
 
int AudioOutputSettings::FormatToBits(AudioFormat format)
{
    switch (format)
    {
        case FORMAT_U8:     return 8;
        case FORMAT_S16:    return 16;
        case FORMAT_S24LSB:
        case FORMAT_S24:    return 24;
        case FORMAT_S32:
        case FORMAT_FLT:    return 32;
        case FORMAT_NONE:
        default:            return -1;
    }
}
 
const char* AudioOutputSettings::FormatToString(AudioFormat format)
{
    switch (format)
    {
        case FORMAT_U8:     return "unsigned 8 bit";
        case FORMAT_S16:    return "signed 16 bit";
        case FORMAT_S24:    return "signed 24 bit MSB";
        case FORMAT_S24LSB: return "signed 24 bit LSB";
        case FORMAT_S32:    return "signed 32 bit";
        case FORMAT_FLT:    return "32 bit floating point";
        case FORMAT_NONE:   return "none";
        default:            return "unknown";
    }
}
 
int AudioOutputSettings::SampleSize(AudioFormat format)
{
    switch (format)
    {
        case FORMAT_U8:     return 1;
        case FORMAT_S16:    return 2;
        case FORMAT_S24:
        case FORMAT_S24LSB:
        case FORMAT_S32:
        case FORMAT_FLT:    return 4;
        case FORMAT_NONE:
        default:            return 0;
    }
}
 
AudioFormat AudioOutputSettings::AVSampleFormatToFormat(AVSampleFormat format, int bits)
{
    switch (av_get_packed_sample_fmt(format))
    {
        case AV_SAMPLE_FMT_U8:      return FORMAT_U8;
        case AV_SAMPLE_FMT_S16:     return FORMAT_S16;
        case AV_SAMPLE_FMT_FLT:     return FORMAT_FLT;
        case AV_SAMPLE_FMT_DBL:     return FORMAT_NONE;
        case AV_SAMPLE_FMT_S32:
            switch (bits)
            {
                case  0:            return FORMAT_S32;
                case 24:            return FORMAT_S24;
                case 32:            return FORMAT_S32;
                default:            return FORMAT_NONE;
            }
        default:                    return FORMAT_NONE;
    }
}
 
AVSampleFormat AudioOutputSettings::FormatToAVSampleFormat(AudioFormat format)
{
    switch (format)
    {
        case FORMAT_U8:             return AV_SAMPLE_FMT_U8;
        case FORMAT_S16:            return AV_SAMPLE_FMT_S16;
        case FORMAT_FLT:            return AV_SAMPLE_FMT_FLT;
        case FORMAT_S32:
        case FORMAT_S24:
        case FORMAT_S24LSB:         return AV_SAMPLE_FMT_S32;
        default:                    return AV_SAMPLE_FMT_NONE;
    }
}
 
void AudioOutputSettings::AddSupportedChannels(int channels)
{
    m_channels.push_back(channels);
    LOG(VB_AUDIO, LOG_INFO, LOC + QString("%1 channel(s) are supported")
            .arg(channels));
}
 
bool AudioOutputSettings::IsSupportedChannels(int channels)
{
    if (m_channels.empty() && channels == 2)
        return true;
 
#ifdef __cpp_lib_ranges_contains
    return std::ranges::contains(m_channels, channels);
#else
    return std::ranges::any_of(m_channels,
                       [channels](const auto entry)
                           { return entry == channels; } );
#endif
}
 
int AudioOutputSettings::BestSupportedChannels()
{
    if (m_channels.empty())
        return 2;
    SortSupportedChannels(); // ensure last element is the best supported channel
    return m_channels.back();
}
 
void AudioOutputSettings::SortSupportedChannels()
{
    if (m_channels.empty())
        return;
    std::ranges::sort(m_channels);
}
 
void AudioOutputSettings::SetBestSupportedChannels(int channels)
{
    if (m_channels.empty())
    {
        m_channels.push_back(channels);
        return;
    }
 
    std::vector<int>tmp;
    std::ranges::copy_if(m_channels,
                 std::back_inserter(tmp),
                 [channels](int value){ return channels > value; } );
    m_channels = tmp;
    m_channels.push_back(channels);
}
 
void AudioOutputSettings::setFeature(bool val, int arg)
{
    if (val)
        m_features |= arg;
    else
        m_features &= ~arg;
};
 
void AudioOutputSettings::setFeature(bool val, DigitalFeature arg)
{
    setFeature(val, (int) arg);
};
 
AudioOutputSettings* AudioOutputSettings::GetCleaned(bool newcopy)
{
    AudioOutputSettings* aosettings = this;
 
    if (newcopy)
    {
        aosettings = new AudioOutputSettings;
        *aosettings = *this;
    }
 
    if (m_invalid)
        return aosettings;
 
    if (BestSupportedPCMChannelsELD() > 2)
    {
        aosettings->setFeature(FEATURE_LPCM);
    }
 
    if (IsSupportedFormat(FORMAT_S16))
    {
        // E-AC3 is transferred as stereo PCM at 4 times the rates
        // assume all amplifier supporting E-AC3 also supports 7.1 LPCM
        // as it's mandatory under the bluray standard
//#if LIBAVFORMAT_VERSION_INT > AV_VERSION_INT( 52, 83, 0 )
        if (m_passthrough >= 0 && IsSupportedChannels(8) &&
            IsSupportedRate(192000))
            aosettings->setFeature(FEATURE_TRUEHD | FEATURE_DTSHD |
                                   FEATURE_EAC3);
//#endif
        if (m_passthrough >= 0)
        {
            if (BestSupportedChannels() == 2)
            {
                LOG(VB_AUDIO, LOG_INFO, LOC + "may be AC3 or DTS capable");
                aosettings->AddSupportedChannels(6);
            }
            aosettings->setFeature(FEATURE_AC3 | FEATURE_DTS);
        }
    }
    else
    {
        // Can't do digital passthrough without 16 bits audio
        aosettings->setPassthrough(-1);
        aosettings->setFeature(false,
                               FEATURE_AC3 | FEATURE_DTS |
                               FEATURE_EAC3 | FEATURE_TRUEHD | FEATURE_DTSHD);
    }
 
    return aosettings;
}
 
AudioOutputSettings* AudioOutputSettings::GetUsers(bool newcopy)
{
    AudioOutputSettings* aosettings = this;
 
    if (newcopy)
        aosettings = GetCleaned(newcopy);
 
    if (aosettings->m_invalid)
        return aosettings;
 
    int cur_channels = gCoreContext->GetNumSetting("MaxChannels", 2);
    int max_channels = aosettings->BestSupportedChannels();
 
    bool bAC3  = aosettings->canFeature(FEATURE_AC3) &&
        gCoreContext->GetBoolSetting("AC3PassThru", false);
 
    bool bDTS  = aosettings->canFeature(FEATURE_DTS) &&
        gCoreContext->GetBoolSetting("DTSPassThru", false);
 
    bool bLPCM = aosettings->canFeature(FEATURE_LPCM) &&
        !gCoreContext->GetBoolSetting("StereoPCM", false);
 
    bool bEAC3 = aosettings->canFeature(FEATURE_EAC3) &&
        gCoreContext->GetBoolSetting("EAC3PassThru", false) &&
        !gCoreContext->GetBoolSetting("Audio48kOverride", false);
 
        // TrueHD requires HBR support.
    bool bTRUEHD = aosettings->canFeature(FEATURE_TRUEHD) &&
        gCoreContext->GetBoolSetting("TrueHDPassThru", false) &&
        !gCoreContext->GetBoolSetting("Audio48kOverride", false) &&
        gCoreContext->GetBoolSetting("HBRPassthru", true);
 
    bool bDTSHD = aosettings->canFeature(FEATURE_DTSHD) &&
        gCoreContext->GetBoolSetting("DTSHDPassThru", false) &&
        !gCoreContext->GetBoolSetting("Audio48kOverride", false);
 
    if (max_channels > 2 && !bLPCM)
        max_channels = 2;
    if (max_channels == 2 && (bAC3 || bDTS))
        max_channels = 6;
 
    cur_channels = std::min(cur_channels, max_channels);
 
    aosettings->SetBestSupportedChannels(cur_channels);
    aosettings->setFeature(bAC3, FEATURE_AC3);
    aosettings->setFeature(bDTS, FEATURE_DTS);
    aosettings->setFeature(bLPCM, FEATURE_LPCM);
    aosettings->setFeature(bEAC3, FEATURE_EAC3);
    aosettings->setFeature(bTRUEHD, FEATURE_TRUEHD);
    aosettings->setFeature(bDTSHD, FEATURE_DTSHD);
 
    return aosettings;
}
 
int AudioOutputSettings::GetMaxHDRate() const
{
    if (!canFeature(FEATURE_DTSHD))
        return 0;
 
        // If no HBR or no LPCM, limit bitrate to 6.144Mbit/s
    if (!gCoreContext->GetBoolSetting("HBRPassthru", true) ||
        !canFeature(FEATURE_LPCM))
    {
        return 192000;  // E-AC3/DTS-HD High Res: 192k, 16 bits, 2 ch
    }
    return 768000;      // TrueHD or DTS-HD MA: 192k, 16 bits, 8 ch
}
 
struct featureStruct
{
    const DigitalFeature flag;
    const std::string name;
};
static const std::array<featureStruct,7> feature {{
    { .flag=FEATURE_AC3,    .name="AC3"},
    { .flag=FEATURE_DTS,    .name="DTS"},
    { .flag=FEATURE_LPCM,   .name="LPCM"},
    { .flag=FEATURE_EAC3,   .name="EAC3"},
    { .flag=FEATURE_TRUEHD, .name="TRUEHD"},
    { .flag=FEATURE_DTSHD,  .name="DTSHD"},
    { .flag=FEATURE_AAC,    .name="AAC"},
}};
 
QString AudioOutputSettings::FeaturesToString(DigitalFeature arg)
{
    QStringList tmp;
    // cppcheck-suppress unassignedVariable
    for (const auto & [flag, name] : feature)
    {
        if (arg & flag)
            tmp += QString::fromStdString(name);
    }
    return tmp.join(",");
}
 
QString AudioOutputSettings::GetPassthroughParams(int codec, int codec_profile,
                                               int &samplerate,
                                               int &channels,
                                               bool canDTSHDMA)
{
    QString log;
 
    channels = 2;
 
    switch (codec)
    {
        case AV_CODEC_ID_AC3:
            log = "AC3";
            break;
        case AV_CODEC_ID_EAC3:
            samplerate = samplerate * 4;
            log = "Dolby Digital Plus (E-AC3)";
            break;
        case AV_CODEC_ID_DTS:
            switch(codec_profile)
            {
                case AV_PROFILE_DTS_ES:
                    log = "DTS-ES";
                    break;
                case AV_PROFILE_DTS_96_24:
                    log = "DTS 96/24";
                    break;
                case AV_PROFILE_DTS_HD_HRA:
                    samplerate = 192000;
                    log = "DTS-HD High-Res";
                    break;
                case AV_PROFILE_DTS_HD_MA:
                    samplerate = 192000;
                    if (canDTSHDMA)
                    {
                        log = "DTS-HD MA";
                        channels = 8;
                    }
                    else
                    {
                        log = "DTS-HD High-Res";
                    }
                    break;
                case AV_PROFILE_DTS:
                default:
                    log = "DTS Core";
                    break;
            }
            break;
        case AV_CODEC_ID_TRUEHD:
            channels = 8;
            log = "TrueHD";
            switch(samplerate)
            {
                case 48000:
                case 96000:
                case 192000:
                    samplerate = 192000;
                    break;
                case 44100:
                case 88200:
                case 176400:
                    samplerate = 176400;
                    break;
                default:
                    log = "TrueHD: Unsupported samplerate";
                    break;
            }
            break;
        default:
            break;
    }
    return log;
}
 
bool AudioOutputSettings::hasValidELD()
{
    return m_hasEld && m_eld.isValid();
};
 
bool AudioOutputSettings::hasELD() const
{
    return m_hasEld;
};
 
void AudioOutputSettings::setELD(QByteArray *ba)
{
    m_hasEld = true;
    m_eld = eld(ba->constData(), ba->size());
    m_eld.show();
}
 
int AudioOutputSettings::BestSupportedChannelsELD()
{
    int chan = AudioOutputSettings::BestSupportedChannels();
    if (!hasValidELD())
        return chan;
    int eldc = m_eld.maxChannels();
    return eldc < chan ? eldc : chan;
}
 
int AudioOutputSettings::BestSupportedPCMChannelsELD()
{
    int chan = AudioOutputSettings::BestSupportedChannels();
    if (!hasValidELD())
        return chan;
    int eldc = m_eld.maxLPCMChannels();
    return eldc < chan ? eldc : chan;
}