audio_stream_format.hpp

// Copyright Take Vos 2021-2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
 
#pragma once
 
#include "pcm_format.hpp"
#include "speaker_mapping.hpp"
#include "../macros.hpp"
#include <bit>
#include <array>
 
hi_export_module(hikogui.audio.audio_stream_format);
 
namespace hi { inline namespace v1 {
 
hi_export constexpr auto common_sample_rates = std::array{
    uint32_t{8000},
    uint32_t{16000},
    uint32_t{32000},
    uint32_t{44100},
    uint32_t{47952},
    uint32_t{48000},
    uint32_t{48048},
    uint32_t{88200},
    uint32_t{95904},
    uint32_t{96000},
    uint32_t{96096},
    uint32_t{176400},
    uint32_t{191808},
    uint32_t{192000},
    uint32_t{192192},
    uint32_t{352800},
    uint32_t{383616},
    uint32_t{384000},
    uint32_t{384384}};
 
hi_export struct audio_stream_format {
    pcm_format format = {};
    uint32_t sample_rate = 0;
    uint16_t num_channels = 0;
    hi::speaker_mapping speaker_mapping = hi::speaker_mapping::none;
 
    constexpr audio_stream_format() noexcept = default;
    constexpr audio_stream_format(audio_stream_format const &) noexcept = default;
    constexpr audio_stream_format(audio_stream_format &&) noexcept = default;
    constexpr audio_stream_format &operator=(audio_stream_format const &) noexcept = default;
    constexpr audio_stream_format &operator=(audio_stream_format &&) noexcept = default;
 
    [[nodiscard]] constexpr audio_stream_format(
        pcm_format format,
        uint32_t sample_rate,
        uint16_t num_channels,
        hi::speaker_mapping speaker_mapping = hi::speaker_mapping::none) noexcept :
        format(format), sample_rate(sample_rate), num_channels(num_channels), speaker_mapping(speaker_mapping)
    {
    }
 
    [[nodiscard]] constexpr bool empty() const noexcept
    {
        return format.empty();
    }
 
    constexpr explicit operator bool() const noexcept
    {
        return not empty();
    }
 
    [[nodiscard]] constexpr bool holds_invariant() const noexcept
    {
        if (popcount(speaker_mapping) != 0 and num_channels != popcount(speaker_mapping)) {
            return false;
        }
        return true;
    }
};
 
}} // namespace hi::inline v1