Const correctness for output_dyn_value and unify some identical constants
[kugel-rb.git] / apps / misc.h
blob35972301cce7185e4ebaad1c92807b1d03b7d007
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2002 by Daniel Stenberg
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
21 #ifndef MISC_H
22 #define MISC_H
24 #include <stdbool.h>
25 #include <inttypes.h>
26 #include "config.h"
27 #include "system.h"
29 extern const unsigned char * const byte_units[];
30 extern const unsigned char * const * const kbyte_units;
32 /* Format a large-range value for output, using the appropriate unit so that
33 * the displayed value is in the range 1 <= display < 1000 (1024 for "binary"
34 * units) if possible, and 3 significant digits are shown. If a buffer is
35 * given, the result is snprintf()'d into that buffer, otherwise the result is
36 * voiced.*/
37 char *output_dyn_value(char *buf, int buf_size, int value,
38 const unsigned char * const *units, bool bin_scale);
40 /* Format time into buf.
42 * buf - buffer to format to.
43 * buf_size - size of buffer.
44 * t - time to format, in milliseconds.
46 void format_time(char* buf, int buf_size, long t);
48 /* Ask the user if they really want to erase the current dynamic playlist
49 * returns true if the playlist should be replaced */
50 bool warn_on_pl_erase(void);
52 /* Read (up to) a line of text from fd into buffer and return number of bytes
53 * read (which may be larger than the number of bytes stored in buffer). If
54 * an error occurs, -1 is returned (and buffer contains whatever could be
55 * read). A line is terminated by a LF char. Neither LF nor CR chars are
56 * stored in buffer.
58 int read_line(int fd, char* buffer, int buffer_size);
59 int fast_readline(int fd, char *buf, int buf_size, void *parameters,
60 int (*callback)(int n, const char *buf, void *parameters));
62 bool settings_parseline(char* line, char** name, char** value);
63 long default_event_handler_ex(long event, void (*callback)(void *), void *parameter);
64 long default_event_handler(long event);
65 bool list_stop_handler(void);
66 void car_adapter_mode_init(void);
67 extern int show_logo(void);
69 #if CONFIG_CODEC == SWCODEC
70 /* Return current ReplayGain mode a file should have (REPLAYGAIN_TRACK or
71 * REPLAYGAIN_ALBUM) if ReplayGain processing is enabled, or -1 if no
72 * information present.
74 int get_replaygain_mode(bool have_track_gain, bool have_album_gain);
75 #endif
77 int open_utf8(const char* pathname, int flags);
79 #ifdef BOOTFILE
80 #if !defined(USB_NONE) && !defined(USB_HANDLED_BY_OF)
81 void check_bootfile(bool do_rolo);
82 #endif
83 #endif
85 /* check range, set volume and save settings */
86 void setvol(void);
88 #ifdef HAVE_LCD_COLOR
89 int hex_to_rgb(const char* hex, int* color);
90 #endif
92 char* strrsplt(char* str, int c);
93 char* skip_whitespace(char* const str);
94 bool file_exists(const char *file);
95 bool dir_exists(const char *path);
98 * removes the extension of filename (if it doesn't start with a .)
99 * puts the result in buffer
101 char *strip_extension(char* buffer, int buffer_size, const char *filename);
103 /* A simplified scanf */
105 * Checks whether the value at position 'position' was really read
106 * during a call to 'parse_list'
107 * - position: 0-based number of the value
108 * - valid_vals: value after the call to 'parse_list'
110 #define LIST_VALUE_PARSED(setvals, position) ((setvals) & BIT_N(position))
111 const char* parse_list(const char *fmt, uint32_t *set_vals,
112 const char sep, const char* str, ...);
114 #endif /* MISC_H */