From eb7e709b7aff162cc7c8f9b8004089846839ffbe Mon Sep 17 00:00:00 2001 From: Josh Blum Date: Wed, 17 Feb 2010 00:41:38 -0800 Subject: moved host code into host directory for clean (unambiguous) top level --- host/lib/gain_handler.cpp | 167 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 167 insertions(+) create mode 100644 host/lib/gain_handler.cpp (limited to 'host/lib/gain_handler.cpp') diff --git a/host/lib/gain_handler.cpp b/host/lib/gain_handler.cpp new file mode 100644 index 000000000..b03d5bda2 --- /dev/null +++ b/host/lib/gain_handler.cpp @@ -0,0 +1,167 @@ +// +// Copyright 2010 Ettus Research LLC +// +// 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 3 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, see . +// + +#include +#include +#include +#include +#include +#include + +using namespace uhd; + +/*********************************************************************** + * Helper functions and macros + **********************************************************************/ +#define GET_PROP_NAMES() \ + wax::cast((*_wax_obj_ptr)[_gain_names_prop]) + +/*! + * Helper function to simplify getting a named gain (also min, max, step). + */ +static gain_t get_named_gain(wax::obj *wax_obj_ptr, wax::obj prop, std::string name){ + return wax::cast((*wax_obj_ptr)[named_prop_t(prop, name)]); +} + +/*********************************************************************** + * Class methods of gain handler + **********************************************************************/ +gain_handler::~gain_handler(void){ + /* NOP */ +} + +void gain_handler::_check_key(const wax::obj &key_){ + wax::obj key; std::string name; + boost::tie(key, name) = extract_named_prop(key_); + + try{ + //only handle non wildcard names + ASSERT_THROW(name != ""); + + //only handle these gain props + ASSERT_THROW( + _is_equal(key, _gain_prop) or + _is_equal(key, _gain_min_prop) or + _is_equal(key, _gain_max_prop) or + _is_equal(key, _gain_step_prop) + ); + + //check that the name is allowed + prop_names_t prop_names = GET_PROP_NAMES(); + ASSERT_THROW(not std::has(prop_names.begin(), prop_names.end(), name)); + + //if we get here, throw an exception + throw std::invalid_argument(str( + boost::format("Unknown gain name %s") % name + )); + } + catch(const std::assert_error &){} +} + +static gain_t gain_max(gain_t a, gain_t b){ + return std::max(a, b); +} +static gain_t gain_sum(gain_t a, gain_t b){ + return std::sum(a, b); +} + +bool gain_handler::intercept_get(const wax::obj &key, wax::obj &val){ + _check_key(key); //verify the key + + std::vector gain_props = boost::assign::list_of + (_gain_prop)(_gain_min_prop)(_gain_max_prop)(_gain_step_prop); + + /*! + * Handle getting overall gains when a name is not specified. + * For the gain props below, set the overall value and return true. + */ + BOOST_FOREACH(wax::obj prop_key, gain_props){ + if (_is_equal(key, prop_key)){ + //form the gains vector from the props vector + prop_names_t prop_names = GET_PROP_NAMES(); + std::vector gains(prop_names.size()); + std::transform( + prop_names.begin(), prop_names.end(), gains.begin(), + boost::bind(get_named_gain, _wax_obj_ptr, key, _1) + ); + + //reduce across the gain vector + if (_is_equal(key, _gain_step_prop)){ + val = std::reduce(gains.begin(), gains.end(), gain_max); + } + else{ + val = std::reduce(gains.begin(), gains.end(), gain_sum); + } + return true; + } + } + + return false; +} + +bool gain_handler::intercept_set(const wax::obj &key_, const wax::obj &val){ + _check_key(key_); //verify the key + + wax::obj key; std::string name; + boost::tie(key, name) = extract_named_prop(key_); + + /*! + * Verify that a named gain component is in range. + */ + try{ + //only handle the gain props + ASSERT_THROW(_is_equal(key, _gain_prop)); + + //check that the gain is in range + gain_t gain = wax::cast(val); + gain_t gain_min = get_named_gain(_wax_obj_ptr, _gain_min_prop, name); + gain_t gain_max = get_named_gain(_wax_obj_ptr, _gain_max_prop, name); + ASSERT_THROW(gain > gain_max or gain < gain_min); + + //if we get here, throw an exception + throw std::range_error(str( + boost::format("gain %s is out of range of (%f, %f)") % name % gain_min % gain_max + )); + } + catch(const std::assert_error &){} + + /*! + * Handle setting the overall gain. + */ + if (_is_equal(key, _gain_prop) and name == ""){ + gain_t gain = wax::cast(val); + prop_names_t prop_names = GET_PROP_NAMES(); + BOOST_FOREACH(std::string name, prop_names){ + //get the min, max, step for this gain name + gain_t gain_min = get_named_gain(_wax_obj_ptr, _gain_min_prop, name); + gain_t gain_max = get_named_gain(_wax_obj_ptr, _gain_max_prop, name); + gain_t gain_step = get_named_gain(_wax_obj_ptr, _gain_step_prop, name); + + //clip g to be within the allowed range + gain_t g = std::min(std::max(gain, gain_min), gain_max); + //set g to be a multiple of the step size + g -= fmod(g, gain_step); + //set g to be the new gain + (*_wax_obj_ptr)[named_prop_t(_gain_prop, name)] = g; + //subtract g out of the total gain left to apply + gain -= g; + } + return true; + } + + return false; +} -- cgit v1.2.3