audio_requirements.hpp

Go to the documentation of this file.

/**
 * @file audio_requirements.hpp
 * @brief Audio driver requirements validator
 * @ingroup validation
 *
 * Validates that audio drivers provide required functionality using the
 * method detection system. This is the core audio contract enforcement
 * for Sound Byte Libs drivers.
 *
 * ## Audio Driver Contract
 *
 * Every Sound Byte Libs audio driver MUST implement these methods:
 * - `init()` - Initialize with default settings
 * - `init(const AudioConfig&)` - Initialize with custom settings
 * - `set_callback(AudioCallback)` - Register processing callback
 * - `start()` - Begin audio streaming
 * - `stop()` - Stop audio streaming
 *
 * ## Validation Usage
 *
 * Add validation at the bottom of driver sai.hpp (or i2s.hpp, etc.):
 * ```cpp
 * #include <sbl/validation/audio_requirements.hpp>
 * static_assert(sbl::validation::audio_driver_valid<sbl::driver::Sai>,
 *               "SAI driver missing required audio methods");
 * ```
 *
 * @see method_detection.hpp
 */
 
#ifndef SBL_VALIDATION_AUDIO_REQUIREMENTS_HPP_
#define SBL_VALIDATION_AUDIO_REQUIREMENTS_HPP_
 
#include "method_detection.hpp"
 
namespace sbl {
namespace validation {
 
/**
 * @brief Audio driver requirements validator
 *
 * Validates that audio drivers provide all required methods.
 */
template<typename AudioDriver>
class AudioDriverRequirements {
public:
    static constexpr bool validate() {
        static_assert(has_audio_init<AudioDriver>::value,
                      "SBL ERROR: Audio driver missing init() method.\n"
                      "Required: static init() (void or bool)");
 
        static_assert(has_audio_init_config<AudioDriver>::value,
                      "SBL ERROR: Audio driver missing init(const AudioConfig&) method.\n"
                      "Required: static init(const sbl::hal::audio::AudioConfig&) (void or bool)");
 
        static_assert(has_audio_set_callback<AudioDriver>::value,
                      "SBL ERROR: Audio driver missing set_callback() method.\n"
                      "Required: static void set_callback(sbl::hal::audio::AudioCallback)");
 
        static_assert(has_audio_start<AudioDriver>::value,
                      "SBL ERROR: Audio driver missing start() method.\n"
                      "Required: static void start()");
 
        static_assert(has_audio_stop<AudioDriver>::value,
                      "SBL ERROR: Audio driver missing stop() method.\n"
                      "Required: static void stop()");
 
        return true;
    }
};
 
/**
 * @brief Helper to validate an audio driver implementation
 *
 * Usage:
 * ```cpp
 * static_assert(sbl::validation::audio_driver_valid<MyAudioDriver>,
 *               "Audio driver incomplete");
 * ```
 */
template<typename AudioDriver>
constexpr bool audio_driver_valid = AudioDriverRequirements<AudioDriver>::validate();
 
} // namespace validation
} // namespace sbl
 
#endif // SBL_VALIDATION_AUDIO_REQUIREMENTS_HPP_