value_as_string.h

Go to the documentation of this file.

/*
    Copyright (C) 2014 Paul Davis
    Author: David Robillard

    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., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_value_as_string_h__
#define __ardour_value_as_string_h__

#include <stddef.h>

#include "ardour/parameter_descriptor.h"

namespace ARDOUR {

inline std::string
value_as_string(const ARDOUR::ParameterDescriptor& desc,
                double                             v)
{
        char buf[32];

        if (desc.scale_points) {
                // Check if value is on a scale point
                for (ARDOUR::ScalePoints::const_iterator i = desc.scale_points->begin();
                     i != desc.scale_points->end();
                     ++i) {
                        if (i->second == v) {
                                return i->first;  // Found it, return scale point label
                        }
                }
        }

        // Value is not a scale point, print it normally
        if (desc.unit == ARDOUR::ParameterDescriptor::MIDI_NOTE) {
                if (v >= 0 && v <= 127) {
                        const int         num          = rint(v);
                        static const char names[12][3] = {
                                "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B"
                        };
                        snprintf(buf, sizeof(buf), "%s %d", names[num % 12], (num / 12) - 2);
                } else {
                        // Odd, invalid range, just print the number
                        snprintf(buf, sizeof(buf), "%.0f", v);
                }
        } else if (!desc.print_fmt.empty()) {
                snprintf(buf, sizeof(buf), desc.print_fmt.c_str(), v);
        } else if (desc.integer_step) {
                snprintf(buf, sizeof(buf), "%d", (int)v);
        } else {
                snprintf(buf, sizeof(buf), "%.3f", v);
        }
        if (desc.print_fmt.empty() && desc.unit == ARDOUR::ParameterDescriptor::DB) {
                // TODO: Move proper dB printing from AutomationLine here
                return std::string(buf) + " dB";
        }
        return buf;
}

inline std::string
value_as_string(const ARDOUR::ParameterDescriptor& desc,
                const ARDOUR::Variant&             val)
{
        // Only numeric support, for now
        return value_as_string(desc, val.to_double());
}

}  // namespace ARDOUR

#endif /* __ardour_value_as_string_h__ */