namespace DTS.Common.Classes.DSP
{
    public interface IStreamingFilterProfile
    {
        /// <summary>
        /// the byte/enum value to send to the firmware for this filter type
        /// </summary>
        int EnumValue { get; set; }
        /// <summary>
        /// the display string for this filter
        /// </summary>
        string DisplayString { get; set; }
        /// <summary>
        /// description string for this filter
        /// </summary>
        string DescriptionString { get; set; }
        /// <summary>
        /// any restrictions on what das can use this filter
        /// </summary>
        DASRestriction[] Restrictions { get; set; }
        /// <summary>
        /// if this profile uses a ratio, then the ratio of sps to fC
        /// </summary>
        double Ratio { get; set; }
        /// <summary>
        /// returns the fC given the hardware type and the sample rate
        /// returns null if digital filtering isn't used in this combination
        /// </summary>
        /// <param name="sps"></param>
        /// <param name="hwType"></param>
        /// <returns></returns>
        double GetDSPFilterRate(double sps, string hwType);
    }
}