fix bug with fractional seconds on some locales (SF#1858012: https://sourceforge...
[flac.git] / src / flac / utils.c
1 /* flac - Command-line FLAC encoder/decoder
2  * Copyright (C) 2002,2003,2004,2005,2006,2007,2008  Josh Coalson
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
17  */
18
19 #if HAVE_CONFIG_H
20 #  include <config.h>
21 #endif
22
23 #include "utils.h"
24 #include "FLAC/assert.h"
25 #include "FLAC/metadata.h"
26 #include <math.h>
27 #include <stdarg.h>
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <string.h>
31
32 const char *CHANNEL_MASK_TAG = "WAVEFORMATEXTENSIBLE_CHANNEL_MASK";
33
34 int flac__utils_verbosity_ = 2;
35
36 static FLAC__bool local__parse_uint64_(const char *s, FLAC__uint64 *value)
37 {
38         FLAC__uint64 ret = 0;
39         char c;
40
41         if(*s == '\0')
42                 return false;
43
44         while('\0' != (c = *s++))
45                 if(c >= '0' && c <= '9')
46                         ret = ret * 10 + (c - '0');
47                 else
48                         return false;
49
50         *value = ret;
51         return true;
52 }
53
54 static FLAC__bool local__parse_timecode_(const char *s, double *value)
55 {
56         double ret;
57         unsigned i;
58         char c, *endptr;
59
60         /* parse [0-9][0-9]*: */
61         c = *s++;
62         if(c >= '0' && c <= '9')
63                 i = (c - '0');
64         else
65                 return false;
66         while(':' != (c = *s++)) {
67                 if(c >= '0' && c <= '9')
68                         i = i * 10 + (c - '0');
69                 else
70                         return false;
71         }
72         ret = (double)i * 60.;
73
74         /* parse [0-9]*[.,]?[0-9]* i.e. a sign-less rational number (. or , OK for fractional seconds, to support different locales) */
75         if(strspn(s, "1234567890.,") != strlen(s))
76                 return false;
77         ret += strtod(s, &endptr);
78         if (endptr == s || *endptr)
79                 return false;
80
81         *value = ret;
82         return true;
83 }
84
85 static FLAC__bool local__parse_cue_(const char *s, const char *end, unsigned *track, unsigned *index)
86 {
87         FLAC__bool got_track = false, got_index = false;
88         unsigned t = 0, i = 0;
89         char c;
90
91         while(end? s < end : *s != '\0') {
92                 c = *s++;
93                 if(c >= '0' && c <= '9') {
94                         t = t * 10 + (c - '0');
95                         got_track = true;
96                 }
97                 else if(c == '.')
98                         break;
99                 else
100                         return false;
101         }
102         while(end? s < end : *s != '\0') {
103                 c = *s++;
104                 if(c >= '0' && c <= '9') {
105                         i = i * 10 + (c - '0');
106                         got_index = true;
107                 }
108                 else
109                         return false;
110         }
111         *track = t;
112         *index = i;
113         return got_track && got_index;
114 }
115
116 /*
117  * this only works with sorted cuesheets (the spec strongly recommends but
118  * does not require sorted cuesheets).  but if it's not sorted, picking a
119  * nearest cue point has no significance.
120  */
121 static FLAC__uint64 local__find_closest_cue_(const FLAC__StreamMetadata_CueSheet *cuesheet, unsigned track, unsigned index, FLAC__uint64 total_samples, FLAC__bool look_forward)
122 {
123         int t, i;
124         if(look_forward) {
125                 for(t = 0; t < (int)cuesheet->num_tracks; t++)
126                         for(i = 0; i < (int)cuesheet->tracks[t].num_indices; i++)
127                                 if(cuesheet->tracks[t].number > track || (cuesheet->tracks[t].number == track && cuesheet->tracks[t].indices[i].number >= index))
128                                         return cuesheet->tracks[t].offset + cuesheet->tracks[t].indices[i].offset;
129                 return total_samples;
130         }
131         else {
132                 for(t = (int)cuesheet->num_tracks - 1; t >= 0; t--)
133                         for(i = (int)cuesheet->tracks[t].num_indices - 1; i >= 0; i--)
134                                 if(cuesheet->tracks[t].number < track || (cuesheet->tracks[t].number == track && cuesheet->tracks[t].indices[i].number <= index))
135                                         return cuesheet->tracks[t].offset + cuesheet->tracks[t].indices[i].offset;
136                 return 0;
137         }
138 }
139
140 void flac__utils_printf(FILE *stream, int level, const char *format, ...)
141 {
142         if(flac__utils_verbosity_ >= level) {
143                 va_list args;
144
145                 FLAC__ASSERT(0 != format);
146
147                 va_start(args, format);
148
149                 (void) vfprintf(stream, format, args);
150
151                 va_end(args);
152
153 #ifdef _MSC_VER
154                 if(stream == stderr)
155                         fflush(stream); /* for some reason stderr is buffered in at least some if not all MSC libs */
156 #endif
157         }
158 }
159
160 #ifdef FLAC__VALGRIND_TESTING
161 size_t flac__utils_fwrite(const void *ptr, size_t size, size_t nmemb, FILE *stream)
162 {
163         size_t ret = fwrite(ptr, size, nmemb, stream);
164         if(!ferror(stream))
165                 fflush(stream);
166         return ret;
167 }
168 #endif
169
170 FLAC__bool flac__utils_parse_skip_until_specification(const char *s, utils__SkipUntilSpecification *spec)
171 {
172         FLAC__uint64 val;
173         FLAC__bool is_negative = false;
174
175         FLAC__ASSERT(0 != spec);
176
177         spec->is_relative = false;
178         spec->value_is_samples = true;
179         spec->value.samples = 0;
180
181         if(0 != s) {
182                 if(s[0] == '-') {
183                         is_negative = true;
184                         spec->is_relative = true;
185                         s++;
186                 }
187                 else if(s[0] == '+') {
188                         spec->is_relative = true;
189                         s++;
190                 }
191
192                 if(local__parse_uint64_(s, &val)) {
193                         spec->value_is_samples = true;
194                         spec->value.samples = (FLAC__int64)val;
195                         if(is_negative)
196                                 spec->value.samples = -(spec->value.samples);
197                 }
198                 else {
199                         double d;
200                         if(!local__parse_timecode_(s, &d))
201                                 return false;
202                         spec->value_is_samples = false;
203                         spec->value.seconds = d;
204                         if(is_negative)
205                                 spec->value.seconds = -(spec->value.seconds);
206                 }
207         }
208
209         return true;
210 }
211
212 void flac__utils_canonicalize_skip_until_specification(utils__SkipUntilSpecification *spec, unsigned sample_rate)
213 {
214         FLAC__ASSERT(0 != spec);
215         if(!spec->value_is_samples) {
216                 spec->value.samples = (FLAC__int64)(spec->value.seconds * (double)sample_rate);
217                 spec->value_is_samples = true;
218         }
219 }
220
221 FLAC__bool flac__utils_parse_cue_specification(const char *s, utils__CueSpecification *spec)
222 {
223         const char *start = s, *end = 0;
224
225         FLAC__ASSERT(0 != spec);
226
227         spec->has_start_point = spec->has_end_point = false;
228
229         s = strchr(s, '-');
230
231         if(0 != s) {
232                 if(s == start)
233                         start = 0;
234                 end = s+1;
235                 if(*end == '\0')
236                         end = 0;
237         }
238
239         if(start) {
240                 if(!local__parse_cue_(start, s, &spec->start_track, &spec->start_index))
241                         return false;
242                 spec->has_start_point = true;
243         }
244
245         if(end) {
246                 if(!local__parse_cue_(end, 0, &spec->end_track, &spec->end_index))
247                         return false;
248                 spec->has_end_point = true;
249         }
250
251         return true;
252 }
253
254 void flac__utils_canonicalize_cue_specification(const utils__CueSpecification *cue_spec, const FLAC__StreamMetadata_CueSheet *cuesheet, FLAC__uint64 total_samples, utils__SkipUntilSpecification *skip_spec, utils__SkipUntilSpecification *until_spec)
255 {
256         FLAC__ASSERT(0 != cue_spec);
257         FLAC__ASSERT(0 != cuesheet);
258         FLAC__ASSERT(0 != total_samples);
259         FLAC__ASSERT(0 != skip_spec);
260         FLAC__ASSERT(0 != until_spec);
261
262         skip_spec->is_relative = false;
263         skip_spec->value_is_samples = true;
264
265         until_spec->is_relative = false;
266         until_spec->value_is_samples = true;
267
268         if(cue_spec->has_start_point)
269                 skip_spec->value.samples = local__find_closest_cue_(cuesheet, cue_spec->start_track, cue_spec->start_index, total_samples, /*look_forward=*/false);
270         else
271                 skip_spec->value.samples = 0;
272
273         if(cue_spec->has_end_point)
274                 until_spec->value.samples = local__find_closest_cue_(cuesheet, cue_spec->end_track, cue_spec->end_index, total_samples, /*look_forward=*/true);
275         else
276                 until_spec->value.samples = total_samples;
277 }
278
279 FLAC__bool flac__utils_set_channel_mask_tag(FLAC__StreamMetadata *object, FLAC__uint32 channel_mask)
280 {
281         FLAC__StreamMetadata_VorbisComment_Entry entry = { 0, 0 };
282         char tag[128];
283
284         FLAC__ASSERT(object);
285         FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
286         FLAC__ASSERT(strlen(CHANNEL_MASK_TAG+1+2+16+1) <= sizeof(tag)); /* +1 for =, +2 for 0x, +16 for digits, +1 for NUL */
287         entry.entry = (FLAC__byte*)tag;
288 #if defined _MSC_VER || defined __MINGW32__
289         if((entry.length = _snprintf(tag, sizeof(tag), "%s=0x%04X", CHANNEL_MASK_TAG, (unsigned)channel_mask)) >= sizeof(tag))
290 #else
291         if((entry.length = snprintf(tag, sizeof(tag), "%s=0x%04X", CHANNEL_MASK_TAG, (unsigned)channel_mask)) >= sizeof(tag))
292 #endif
293                 return false;
294         if(!FLAC__metadata_object_vorbiscomment_replace_comment(object, entry, /*all=*/true, /*copy=*/true))
295                 return false;
296         return true;
297 }
298
299 FLAC__bool flac__utils_get_channel_mask_tag(const FLAC__StreamMetadata *object, FLAC__uint32 *channel_mask)
300 {
301         int offset;
302         unsigned val;
303         char *p;
304         FLAC__ASSERT(object);
305         FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
306         if(0 > (offset = FLAC__metadata_object_vorbiscomment_find_entry_from(object, /*offset=*/0, CHANNEL_MASK_TAG)))
307                 return false;
308         if(object->data.vorbis_comment.comments[offset].length < strlen(CHANNEL_MASK_TAG)+4)
309                 return false;
310         if(0 == (p = strchr((const char *)object->data.vorbis_comment.comments[offset].entry, '='))) /* should never happen, but just in case */
311                 return false;
312         if(strncmp(p, "=0x", 3))
313                 return false;
314         if(sscanf(p+3, "%x", &val) != 1)
315                 return false;
316         *channel_mask = val;
317         return true;
318 }