AudioFormat.hxx

Go to the documentation of this file.

/*
 * Copyright 2003-2017 The Music Player Daemon Project
 * http://www.musicpd.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef MPD_AUDIO_FORMAT_HXX
#define MPD_AUDIO_FORMAT_HXX

#include "pcm/SampleFormat.hxx"
#include "Compiler.h"

#include <stdint.h>
#include <stddef.h>

template<size_t CAPACITY> class StringBuffer;

static constexpr unsigned MAX_CHANNELS = 8;

struct AudioFormat {
        uint32_t sample_rate;

        SampleFormat format;

        uint8_t channels;

        AudioFormat() = default;

        constexpr AudioFormat(uint32_t _sample_rate,
                              SampleFormat _format, uint8_t _channels)
                :sample_rate(_sample_rate),
                 format(_format), channels(_channels) {}

        static constexpr AudioFormat Undefined() {
                return AudioFormat(0, SampleFormat::UNDEFINED,0);
        }

        void Clear() {
                sample_rate = 0;
                format = SampleFormat::UNDEFINED;
                channels = 0;
        }

        constexpr bool IsDefined() const {
                return sample_rate != 0;
        }

        constexpr bool IsFullyDefined() const {
                return sample_rate != 0 && format != SampleFormat::UNDEFINED &&
                        channels != 0;
        }

        constexpr bool IsMaskDefined() const {
                return sample_rate != 0 || format != SampleFormat::UNDEFINED ||
                        channels != 0;
        }

        bool IsValid() const;
        bool IsMaskValid() const;

        constexpr bool operator==(const AudioFormat other) const {
                return sample_rate == other.sample_rate &&
                        format == other.format &&
                        channels == other.channels;
        }

        constexpr bool operator!=(const AudioFormat other) const {
                return !(*this == other);
        }

        void ApplyMask(AudioFormat mask) noexcept;

        gcc_pure
        AudioFormat WithMask(AudioFormat mask) const noexcept {
                AudioFormat result = *this;
                result.ApplyMask(mask);
                return result;
        }

        unsigned GetSampleSize() const;

        unsigned GetFrameSize() const;

        double GetTimeToSize() const;
};

static constexpr inline bool
audio_valid_sample_rate(unsigned sample_rate)
{
        return sample_rate > 0 && sample_rate < (1 << 30);
}

static constexpr inline bool
audio_valid_channel_count(unsigned channels)
{
        return channels >= 1 && channels <= MAX_CHANNELS;
}

inline bool
AudioFormat::IsValid() const
{
        return audio_valid_sample_rate(sample_rate) &&
                audio_valid_sample_format(format) &&
                audio_valid_channel_count(channels);
}

inline bool
AudioFormat::IsMaskValid() const
{
        return (sample_rate == 0 ||
                audio_valid_sample_rate(sample_rate)) &&
                (format == SampleFormat::UNDEFINED ||
                 audio_valid_sample_format(format)) &&
                (channels == 0 || audio_valid_channel_count(channels));
}

inline unsigned
AudioFormat::GetSampleSize() const
{
        return sample_format_size(format);
}

inline unsigned
AudioFormat::GetFrameSize() const
{
        return GetSampleSize() * channels;
}

inline double
AudioFormat::GetTimeToSize() const
{
        return sample_rate * GetFrameSize();
}

gcc_const
StringBuffer<24>
ToString(AudioFormat af) noexcept;

#endif