xref: /aosp_15_r20/external/flac/src/flac/utils.h (revision 600f14f40d737144c998e2ec7a483122d3776fbc)
1 /* flac - Command-line FLAC encoder/decoder
2  * Copyright (C) 2002-2009  Josh Coalson
3  * Copyright (C) 2011-2023  Xiph.Org Foundation
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (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 along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 #ifndef flac__utils_h
21 #define flac__utils_h
22 
23 #ifdef HAVE_CONFIG_H
24 #  include <config.h>
25 #endif
26 
27 #include "FLAC/ordinals.h"
28 #include "FLAC/format.h" /* for FLAC__StreamMetadata_CueSheet */
29 #include <stdio.h> /* for FILE */
30 
31 typedef enum { FORMAT_RAW, FORMAT_WAVE, FORMAT_WAVE64, FORMAT_RF64, FORMAT_AIFF, FORMAT_AIFF_C, FORMAT_FLAC, FORMAT_OGGFLAC } FileFormat;
32 static const char * const FileFormatString[] = { " raw", " WAVE", " Wave64", "n RF64", "n AIFF", "n AIFF-C", " FLAC", "n Ogg FLAC" };
33 
34 typedef enum { SUBFORMAT_UNSPECIFIED = 0, SUBFORMAT_WAVE_PCM, SUBFORMAT_WAVE_EXTENSIBLE, SUBFORMAT_AIFF_C_NONE, SUBFORMAT_AIFF_C_SOWT } FileSubFormat;
35 
36 
37 typedef struct {
38 	FLAC__bool is_relative; /* i.e. specification string started with + or - */
39 	FLAC__bool value_is_samples;
40 	union {
41 		double seconds;
42 		FLAC__int64 samples;
43 	} value;
44 } utils__SkipUntilSpecification;
45 
46 typedef struct {
47 	FLAC__bool has_start_point, has_end_point;
48 	unsigned start_track, start_index;
49 	unsigned end_track, end_index;
50 } utils__CueSpecification;
51 
52 #ifdef FLAC__VALGRIND_TESTING
53 size_t flac__utils_fwrite(const void *ptr, size_t size, size_t nmemb, FILE *stream);
54 #else
55 #define flac__utils_fwrite fwrite
56 #endif
57 
58 extern int flac__utils_verbosity_;
59 void flac__utils_printf(FILE *stream, int level, const char *format, ...);
60 
61 int get_console_width(void);
62 size_t strlen_console(const char *text);
63 void stats_new_file(void);
64 void stats_clear(void);
65 void stats_print_name(int level, const char *name);
66 void stats_print_info(int level, const char *format, ...);
67 
68 FLAC__bool flac__utils_parse_skip_until_specification(const char *s, utils__SkipUntilSpecification *spec);
69 FLAC__bool flac__utils_canonicalize_skip_until_specification(utils__SkipUntilSpecification *spec, uint32_t sample_rate);
70 
71 FLAC__bool flac__utils_parse_cue_specification(const char *s, utils__CueSpecification *spec);
72 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);
73 
74 FLAC__bool flac__utils_set_channel_mask_tag(FLAC__StreamMetadata *object, FLAC__uint32 channel_mask);
75 FLAC__bool flac__utils_get_channel_mask_tag(const FLAC__StreamMetadata *object, FLAC__uint32 *channel_mask);
76 
77 #endif
78