Add a new API to format midi-note-names with translation: Do Re Mi...
[ardour.git] / libs / ardour / ardour / value_as_string.h
1 /*
2     Copyright (C) 2014 Paul Davis
3     Author: David Robillard
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with this program; if not, write to the Free Software
17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18
19 */
20
21 #ifndef __ardour_value_as_string_h__
22 #define __ardour_value_as_string_h__
23
24 #include <stddef.h>
25
26 #include "ardour/parameter_descriptor.h"
27
28 namespace ARDOUR {
29
30 inline std::string
31 value_as_string(const ARDOUR::ParameterDescriptor& desc,
32                 double                             v)
33 {
34         char buf[32];
35
36         if (desc.scale_points) {
37                 // Check if value is on a scale point
38                 for (ARDOUR::ScalePoints::const_iterator i = desc.scale_points->begin();
39                      i != desc.scale_points->end();
40                      ++i) {
41                         if (i->second == v) {
42                                 return i->first;  // Found it, return scale point label
43                         }
44                 }
45         }
46
47         // Value is not a scale point, print it normally
48         if (desc.unit == ARDOUR::ParameterDescriptor::MIDI_NOTE) {
49                 snprintf(buf, sizeof(buf), "%s", ParameterDescriptor::midi_note_name (rint(v)).c_str());
50         } else if (!desc.print_fmt.empty()) {
51                 snprintf(buf, sizeof(buf), desc.print_fmt.c_str(), v);
52         } else if (desc.integer_step) {
53                 snprintf(buf, sizeof(buf), "%d", (int)v);
54         } else {
55                 snprintf(buf, sizeof(buf), "%.3f", v);
56         }
57         if (desc.print_fmt.empty() && desc.unit == ARDOUR::ParameterDescriptor::DB) {
58                 // TODO: Move proper dB printing from AutomationLine here
59                 return std::string(buf) + " dB";
60         }
61         return buf;
62 }
63
64 inline std::string
65 value_as_string(const ARDOUR::ParameterDescriptor& desc,
66                 const ARDOUR::Variant&             val)
67 {
68         // Only numeric support, for now
69         return value_as_string(desc, val.to_double());
70 }
71
72 }  // namespace ARDOUR
73
74 #endif /* __ardour_value_as_string_h__ */