t_replaygain_config

#include <replaygain.h>

Public Types
enum	{ source_mode_none, source_mode_track, source_mode_album, source_mode_byPlaybackOrder }
enum	{ processing_mode_none, processing_mode_gain, processing_mode_gain_and_peak, processing_mode_peak }
typedef t_uint32	t_processing_mode
typedef t_uint32	t_source_mode

Public Member Functions
	t_replaygain_config ()
	t_replaygain_config (t_source_mode p_source_mode, t_processing_mode p_processing_mode, float p_preamp_without_rg, float p_preamp_with_rg)
void	format_name (pfc::string_base &p_out) const
bool	is_active () const
bool	operator!= (const t_replaygain_config &other) const
bool	operator== (const t_replaygain_config &other) const
audio_sample	query_scale (const file_info &info) const
audio_sample	query_scale (const metadb_handle_ptr &info) const
audio_sample	query_scale (const replaygain_info &info) const
void	reset ()

Static Public Member Functions
static bool	equals (const t_replaygain_config &v1, const t_replaygain_config &v2)

Data Fields
float	m_preamp_with_rg
float	m_preamp_without_rg
t_processing_mode	m_processing_mode
t_source_mode	m_source_mode

Detailed Description

Structure storing ReplayGain configuration: album/track source data modes, gain/peak processing modes and preamp values.

Definition at line 2 of file replaygain.h.

Member Typedef Documentation

typedef t_uint32 t_replaygain_config::t_processing_mode

Definition at line 13 of file replaygain.h.

typedef t_uint32 t_replaygain_config::t_source_mode

Definition at line 13 of file replaygain.h.

Member Enumeration Documentation

anonymous enum

Enumerator
source_mode_none
source_mode_track
source_mode_album
source_mode_byPlaybackOrder

Definition at line 4 of file replaygain.h.

           {
        source_mode_none,
        source_mode_track,
        source_mode_album, 
        // New in 1.3.8
        // SPECIAL MODE valid only for playback settings; if set, track gain will be used for random & shuffle-tracks modes, album for shuffle albums & ordered playback.
        source_mode_byPlaybackOrder 
    };

anonymous enum

Enumerator
processing_mode_none
processing_mode_gain
processing_mode_gain_and_peak
processing_mode_peak

Definition at line 12 of file replaygain.h.

{processing_mode_none,processing_mode_gain,processing_mode_gain_and_peak,processing_mode_peak};

Constructor & Destructor Documentation

t_replaygain_config::t_replaygain_config ( )

inline

Definition at line 15 of file replaygain.h.

{reset();}

t_replaygain_config::t_replaygain_config ( t_source_mode  p_source_mode, t_processing_mode  p_processing_mode, float  p_preamp_without_rg, float  p_preamp_with_rg  )

inline

Definition at line 16 of file replaygain.h.

        : m_source_mode(p_source_mode), m_processing_mode(p_processing_mode), m_preamp_without_rg(p_preamp_without_rg), m_preamp_with_rg(p_preamp_with_rg) {}

Member Function Documentation

static bool t_replaygain_config::equals ( const t_replaygain_config &  v1, const t_replaygain_config &  v2  )

inlinestatic

Definition at line 32 of file replaygain.h.

                                                                                       {
        return v1.m_source_mode == v2.m_source_mode && v1.m_processing_mode == v2.m_processing_mode && v1.m_preamp_without_rg == v2.m_preamp_without_rg && v1.m_preamp_with_rg == v2.m_preamp_with_rg;
    }

void t_replaygain_config::format_name

(

pfc::string_base &

p_out

)

const

Definition at line 100 of file replaygain.cpp.

{
    switch(m_processing_mode)
    {
    case processing_mode_none:
        p_out = "None.";
        break;
    case processing_mode_gain:
        switch(m_source_mode)
        {
        case source_mode_none:
            if (m_preamp_without_rg == 0) p_out = "None."; 
            else p_out = PFC_string_formatter() << "Preamp : " << format_dbdelta(m_preamp_without_rg);
            break;
        case source_mode_track:
            {
                pfc::string_formatter fmt;
                fmt << "Apply track gain";
                if (m_preamp_without_rg != 0 || m_preamp_with_rg != 0) fmt << ", with preamp";
                fmt << ".";
                p_out = fmt;
            }
            break;
        case source_mode_album:
            {
                pfc::string_formatter fmt;
                fmt << "Apply album gain";
                if (m_preamp_without_rg != 0 || m_preamp_with_rg != 0) fmt << ", with preamp";
                fmt << ".";
                p_out = fmt;
            }
            break;
        };
        break;
    case processing_mode_gain_and_peak:
        switch(m_source_mode)
        {
        case source_mode_none:
            if (m_preamp_without_rg >= 0) p_out = "None.";
            else p_out = PFC_string_formatter() << "Preamp : " << format_dbdelta(m_preamp_without_rg);
            break;
        case source_mode_track:
            {
                pfc::string_formatter fmt;
                fmt << "Apply track gain";
                if (m_preamp_without_rg != 0 || m_preamp_with_rg != 0) fmt << ", with preamp";
                fmt << ", prevent clipping according to track peak.";
                p_out = fmt;
            }
            break;
        case source_mode_album:
            {
                pfc::string_formatter fmt;
                fmt << "Apply album gain";
                if (m_preamp_without_rg != 0 || m_preamp_with_rg != 0) fmt << ", with preamp";
                fmt << ", prevent clipping according to album peak.";
                p_out = fmt;
            }
            break;
        };
        break;
    case processing_mode_peak:
        switch(m_source_mode)
        {
        case source_mode_none:
            p_out = "None.";
            break;
        case source_mode_track:
            p_out = "Prevent clipping according to track peak.";
            break;
        case source_mode_album:
            p_out = "Prevent clipping according to album peak.";
            break;
        };
        break;
    }
}

bool t_replaygain_config::is_active

(

)

const

Definition at line 178 of file replaygain.cpp.

{
    switch(m_processing_mode)
    {
    case processing_mode_none:
        return false;
    case processing_mode_gain:
        switch(m_source_mode)
        {
        case source_mode_none:
            return m_preamp_without_rg != 0;
        case source_mode_track:
            return true;
        case source_mode_album:
            return true;
        };
        return false;
    case processing_mode_gain_and_peak:
        switch(m_source_mode)
        {
        case source_mode_none:
            return m_preamp_without_rg < 0;
        case source_mode_track:
            return true;
        case source_mode_album:
            return true;
        };
        return false;
    case processing_mode_peak:
        switch(m_source_mode)
        {
        case source_mode_none:
            return false;
        case source_mode_track:
            return true;
        case source_mode_album:
            return true;
        };
        return false;
    default:
        return false;
    }
}

bool t_replaygain_config::operator!= ( const t_replaygain_config &  other ) const

inline

Definition at line 36 of file replaygain.h.

{return !equals(*this, other);}

bool t_replaygain_config::operator== ( const t_replaygain_config &  other ) const

inline

Definition at line 35 of file replaygain.h.

{return equals(*this, other);}

audio_sample t_replaygain_config::query_scale

(

const file_info &

info

)

const

Definition at line 11 of file replaygain.cpp.

{
    return query_scale(info.get_replaygain());
}

audio_sample t_replaygain_config::query_scale

(

const metadb_handle_ptr &

info

)

const

Definition at line 61 of file replaygain.cpp.

{
    return query_scale(p_object->get_async_info_ref()->info());
}

audio_sample t_replaygain_config::query_scale

(

const replaygain_info &

info

)

const

Definition at line 16 of file replaygain.cpp.

                                                                                {
    const audio_sample peak_margin = 1.0;//used to be 0.999 but it must not trigger on lossless

    audio_sample peak = peak_margin;
    audio_sample gain = 0;

    bool have_rg_gain = false, have_rg_peak = false;

    if (m_source_mode == source_mode_track || m_source_mode == source_mode_album)
    {
        float gain_select = replaygain_info::gain_invalid, peak_select = replaygain_info::peak_invalid;
        if (m_source_mode == source_mode_track)
        {
            if (info.is_track_gain_present()) {gain = info.m_track_gain; have_rg_gain = true; }
            else if (info.is_album_gain_present()) {gain = info.m_album_gain; have_rg_gain = true; }
            if (info.is_track_peak_present()) {peak = info.m_track_peak; have_rg_peak = true; }
            else if (info.is_album_peak_present()) {peak = info.m_album_peak; have_rg_peak = true; }
        }
        else
        {
            if (info.is_album_gain_present()) {gain = info.m_album_gain; have_rg_gain = true; }
            else if (info.is_track_gain_present()) {gain = info.m_track_gain; have_rg_gain = true; }
            if (info.is_album_peak_present()) {peak = info.m_album_peak; have_rg_peak = true; }
            else if (info.is_track_peak_present()) {peak = info.m_track_peak; have_rg_peak = true; }
        }
    }

    gain += have_rg_gain ? m_preamp_with_rg : m_preamp_without_rg;

    audio_sample scale = 1.0;

    if (m_processing_mode == processing_mode_gain || m_processing_mode == processing_mode_gain_and_peak)
    {
        scale *= audio_math::gain_to_scale(gain);
    }

    if (m_processing_mode == processing_mode_peak || m_processing_mode == processing_mode_gain_and_peak)
    {
        if (scale * peak > peak_margin)
            scale = (audio_sample)(peak_margin / peak);
    }

    return scale;
}

void t_replaygain_config::reset

(

)

Definition at line 3 of file replaygain.cpp.

{
    m_source_mode = source_mode_none;
    m_processing_mode = processing_mode_none;
    m_preamp_without_rg = 0;
    m_preamp_with_rg = 0;
}

Field Documentation

float t_replaygain_config::m_preamp_with_rg

Definition at line 22 of file replaygain.h.

float t_replaygain_config::m_preamp_without_rg

Definition at line 22 of file replaygain.h.

t_processing_mode t_replaygain_config::m_processing_mode

Definition at line 21 of file replaygain.h.

t_source_mode t_replaygain_config::m_source_mode

Definition at line 20 of file replaygain.h.

---

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

• foobar2000/SDK/replaygain.h
• foobar2000/SDK/replaygain.cpp