replaygain_info

#include <file_info.h>

Public Types
enum	{ text_buffer_size = 16 }
enum	{ peak_invalid = -1, gain_invalid = -1000 }
typedef char	t_text_buffer[text_buffer_size]

Public Member Functions
bool	format_album_gain (char p_buffer[text_buffer_size]) const
bool	format_album_peak (char p_buffer[text_buffer_size]) const
bool	format_track_gain (char p_buffer[text_buffer_size]) const
bool	format_track_peak (char p_buffer[text_buffer_size]) const
t_size	get_value_count ()
bool	is_album_gain_present () const
bool	is_album_peak_present () const
bool	is_track_gain_present () const
bool	is_track_peak_present () const
void	remove_album_gain ()
void	remove_album_peak ()
void	remove_track_gain ()
void	remove_track_peak ()
void	reset ()
void	set_album_gain_text (const char *p_text, t_size p_text_len=pfc_infinite)
void	set_album_peak_text (const char *p_text, t_size p_text_len=pfc_infinite)
bool	set_from_meta (const char *p_name, const char *p_value)
bool	set_from_meta_ex (const char *p_name, t_size p_name_len, const char *p_value, t_size p_value_len)
void	set_track_gain_text (const char *p_text, t_size p_text_len=pfc_infinite)
void	set_track_peak_text (const char *p_text, t_size p_text_len=pfc_infinite)

Static Public Member Functions
static bool	g_equal (const replaygain_info &item1, const replaygain_info &item2)
static bool	g_format_gain (float p_value, char p_buffer[text_buffer_size])
static bool	g_format_peak (float p_value, char p_buffer[text_buffer_size])
static bool	g_is_meta_replaygain (const char *p_name, t_size p_name_len=pfc_infinite)
static replaygain_info	g_merge (replaygain_info r1, replaygain_info r2)

Data Fields
float	m_album_gain
float	m_album_peak
float	m_track_gain
float	m_track_peak

Detailed Description

Structure containing ReplayGain scan results from some playable object, also providing various helper methods to manipulate those results.

Definition at line 2 of file file_info.h.

Member Typedef Documentation

typedef char replaygain_info::t_text_buffer[text_buffer_size]

Definition at line 8 of file file_info.h.

Member Enumeration Documentation

anonymous enum

Enumerator
text_buffer_size

Definition at line 7 of file file_info.h.

{text_buffer_size = 16 };

anonymous enum

Enumerator
peak_invalid
gain_invalid

Definition at line 10 of file file_info.h.

{ peak_invalid = -1, gain_invalid = -1000 };

Member Function Documentation

bool replaygain_info::format_album_gain ( char  p_buffer[text_buffer_size] ) const

inline

Definition at line 15 of file file_info.h.

{return g_format_gain(m_album_gain,p_buffer);}

bool replaygain_info::format_album_peak ( char  p_buffer[text_buffer_size] ) const

inline

Definition at line 17 of file file_info.h.

{return g_format_peak(m_album_peak,p_buffer);}

bool replaygain_info::format_track_gain ( char  p_buffer[text_buffer_size] ) const

inline

Definition at line 16 of file file_info.h.

{return g_format_gain(m_track_gain,p_buffer);}

bool replaygain_info::format_track_peak ( char  p_buffer[text_buffer_size] ) const

inline

Definition at line 18 of file file_info.h.

{return g_format_peak(m_track_peak,p_buffer);}

bool replaygain_info::g_equal ( const replaygain_info &  item1, const replaygain_info &  item2  )

static

Definition at line 355 of file file_info.cpp.

{
    return  item1.m_album_gain == item2.m_album_gain &&
            item1.m_track_gain == item2.m_track_gain &&
            item1.m_album_peak == item2.m_album_peak &&
            item1.m_track_peak == item2.m_track_peak;
}

bool replaygain_info::g_format_gain ( float  p_value, char  p_buffer[text_buffer_size]  )

static

Definition at line 9 of file replaygain_info.cpp.

{
    RG_FPU();
    if (p_value == gain_invalid)
    {
        p_buffer[0] = 0;
        return false;
    }
    else
    {
        pfc::float_to_string(p_buffer,text_buffer_size - 4,p_value,2,true);
        strcat(p_buffer," dB");
        return true;
    }
}

bool replaygain_info::g_format_peak ( float  p_value, char  p_buffer[text_buffer_size]  )

static

Definition at line 25 of file replaygain_info.cpp.

{
    RG_FPU();
    if (p_value == peak_invalid)
    {
        p_buffer[0] = 0;
        return false;
    }
    else
    {
        pfc::float_to_string(p_buffer,text_buffer_size,p_value,6,false);
        return true;
    }
}

bool replaygain_info::g_is_meta_replaygain ( const char *  p_name, t_size  p_name_len = pfc_infinite  )

static

Definition at line 50 of file replaygain_info.cpp.

{
    return 
        stricmp_utf8_ex(p_name,p_name_len,meta_album_gain,~0) == 0 ||
        stricmp_utf8_ex(p_name,p_name_len,meta_album_peak,~0) == 0 ||
        stricmp_utf8_ex(p_name,p_name_len,meta_track_gain,~0) == 0 ||
        stricmp_utf8_ex(p_name,p_name_len,meta_track_peak,~0) == 0;
}

replaygain_info replaygain_info::g_merge ( replaygain_info  r1, replaygain_info  r2  )

static

Definition at line 134 of file replaygain_info.cpp.

{
    replaygain_info ret = r1;
    if (!ret.is_album_gain_present()) ret.m_album_gain = r2.m_album_gain;
    if (!ret.is_album_peak_present()) ret.m_album_peak = r2.m_album_peak;
    if (!ret.is_track_gain_present()) ret.m_track_gain = r2.m_track_gain;
    if (!ret.is_track_peak_present()) ret.m_track_peak = r2.m_track_peak;
    return ret;
}

t_size replaygain_info::get_value_count

(

)

Definition at line 88 of file replaygain_info.cpp.

{
    t_size ret = 0;
    if (is_album_gain_present()) ret++;
    if (is_album_peak_present()) ret++;
    if (is_track_gain_present()) ret++;
    if (is_track_peak_present()) ret++;
    return ret;
}

bool replaygain_info::is_album_gain_present ( ) const

inline

Definition at line 29 of file file_info.h.

{return m_album_gain != gain_invalid;}

bool replaygain_info::is_album_peak_present ( ) const

inline

Definition at line 31 of file file_info.h.

{return m_album_peak != peak_invalid;}

bool replaygain_info::is_track_gain_present ( ) const

inline

Definition at line 30 of file file_info.h.

{return m_track_gain != gain_invalid;}

bool replaygain_info::is_track_peak_present ( ) const

inline

Definition at line 32 of file file_info.h.

{return m_track_peak != peak_invalid;}

void replaygain_info::remove_album_gain ( )

inline

Definition at line 34 of file file_info.h.

{m_album_gain = gain_invalid;}

void replaygain_info::remove_album_peak ( )

inline

Definition at line 36 of file file_info.h.

{m_album_peak = peak_invalid;}

void replaygain_info::remove_track_gain ( )

inline

Definition at line 35 of file file_info.h.

{m_track_gain = gain_invalid;}

void replaygain_info::remove_track_peak ( )

inline

Definition at line 37 of file file_info.h.

{m_track_peak = peak_invalid;}

void replaygain_info::reset

(

)

Definition at line 40 of file replaygain_info.cpp.

{
    m_album_gain = gain_invalid;
    m_track_gain = gain_invalid;
    m_album_peak = peak_invalid;
    m_track_peak = peak_invalid;
}

void replaygain_info::set_album_gain_text	(	const char *	p_text,
		t_size	p_text_len = pfc_infinite
	)

Definition at line 98 of file replaygain_info.cpp.

{
    RG_FPU();
    if (p_text != 0 && p_text_len > 0 && *p_text != 0)
        m_album_gain = (float)pfc::string_to_float(p_text,p_text_len);
    else
        remove_album_gain();
}

void replaygain_info::set_album_peak_text	(	const char *	p_text,
		t_size	p_text_len = pfc_infinite
	)

Definition at line 116 of file replaygain_info.cpp.

{
    RG_FPU();
    if (p_text != 0 && p_text_len > 0 && *p_text != 0)
        m_album_peak = (float)pfc::string_to_float(p_text,p_text_len);
    else
        remove_album_peak();
}

bool replaygain_info::set_from_meta ( const char *  p_name, const char *  p_value  )

inline

Definition at line 27 of file file_info.h.

{return set_from_meta_ex(p_name,pfc_infinite,p_value,pfc_infinite);}

bool replaygain_info::set_from_meta_ex	(	const char *	p_name,
		t_size	p_name_len,
		const char *	p_value,
		t_size	p_value_len
	)

Definition at line 59 of file replaygain_info.cpp.

{
    RG_FPU();
    if (stricmp_utf8_ex(p_name,p_name_len,meta_album_gain,~0) == 0)
    {
        m_album_gain = (float)pfc::string_to_float(p_value,p_value_len);
        return true;
    }
    else if (stricmp_utf8_ex(p_name,p_name_len,meta_album_peak,~0) == 0)
    {
        m_album_peak = (float)pfc::string_to_float(p_value,p_value_len);
        if (m_album_peak < 0) m_album_peak = 0;
        return true;
    }
    else if (stricmp_utf8_ex(p_name,p_name_len,meta_track_gain,~0) == 0)
    {
        m_track_gain = (float)pfc::string_to_float(p_value,p_value_len);
        return true;
    }
    else if (stricmp_utf8_ex(p_name,p_name_len,meta_track_peak,~0) == 0)
    {
        m_track_peak = (float)pfc::string_to_float(p_value,p_value_len);
        if (m_track_peak < 0) m_track_peak = 0;
        return true;
    }
    else return false;
}

void replaygain_info::set_track_gain_text	(	const char *	p_text,
		t_size	p_text_len = pfc_infinite
	)

Definition at line 107 of file replaygain_info.cpp.

{
    RG_FPU();
    if (p_text != 0 && p_text_len > 0 && *p_text != 0)
        m_track_gain = (float)pfc::string_to_float(p_text,p_text_len);
    else
        remove_track_gain();
}

void replaygain_info::set_track_peak_text	(	const char *	p_text,
		t_size	p_text_len = pfc_infinite
	)

Definition at line 125 of file replaygain_info.cpp.

{
    RG_FPU();
    if (p_text != 0 && p_text_len > 0 && *p_text != 0)
        m_track_peak = (float)pfc::string_to_float(p_text,p_text_len);
    else
        remove_track_peak();
}

Field Documentation

float replaygain_info::m_album_gain

Definition at line 4 of file file_info.h.

float replaygain_info::m_album_peak

Definition at line 5 of file file_info.h.

float replaygain_info::m_track_gain

Definition at line 4 of file file_info.h.

float replaygain_info::m_track_peak

Definition at line 5 of file file_info.h.

---

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

• foobar2000/SDK/file_info.h
• foobar2000/SDK/file_info.cpp
• foobar2000/SDK/replaygain_info.cpp