musix 0.3.3

Music player library for esoteric audio formats (music from C64,Amiga etc)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

/**
 * @ingroup   sc68_lib
 * @file      conf68.h
 * @author    Benjamin Gerard
 * @date      1999/07/27
 * @brief     configuration file.
 *
 */

/* $Id: conf68.h 102 2009-03-14 17:21:58Z benjihan $ */

/* Copyright (C) 1998-2009 Benjamin Gerard */

#ifndef _API68_CONF68_H_
#define _API68_CONF68_H_

#ifndef SC68_EXTERN
# ifdef __cplusplus
#  define SC68_EXTERN extern "C"
# else
#  define SC68_EXTERN
# endif
#endif

/** @defgroup  sc68_conf  configuration file
 *  @ingroup   sc68_lib
 *
 *  This module prodives functions to access sc68 configuration file.
 *
 *  @{
 */

/** Config entry types. */
enum _config68_type_e {
  CONFIG68_UND=0,  /**< Value is not set.     */
  CONFIG68_INT,    /**< Value is an integer.  */
  CONFIG68_STR,    /**< Value is a string.    */
  CONFIG68_ERR=-1  /**< Reserved for errors.  */
};

typedef enum _config68_type_e config68_type_t;

/** Config. */
typedef struct _config68_s config68_t;

SC68_EXTERN
/** Check and correct config values.
 */
int config68_valid(config68_t * conf);

/** Get index of named config entry.
 *
 *  @param  conf  config.
 *  @param  name  name of entry.
 *
 *  @return index
 *  @retval -1 error
 */
int config68_get_idx(const config68_t * conf,
                     const char * name);

SC68_EXTERN
/** Get type and range of a config entry.
 *
 *  @param  conf  config.
 *  @param  idx   index.
 *  @param  min   store min value (0 ignore).
 *  @param  max   store max value (0 ignore).
 *  @param  def   store default value (0 ignore).
 *
 *  @return type of config entry
 *  @retval CONFIG68_ERROR on error
 */
config68_type_t config68_range(const config68_t * conf, int idx,
                               int * min, int * max, int * def);

SC68_EXTERN
/** Get value of a config entry.
 *
 *  @param  conf  config.
 *  @param  v     input: pointer to index; output: integer value or unmodified.
 *  @param  name  input: pointer to name; output: string value or unmodified.
 *
 *  @return type of config entry
 *  @retval CONFIG68_ERROR on error
 */
config68_type_t config68_get(const config68_t * conf,
                             int * v,
                             const char ** name);

SC68_EXTERN
/** Set value of a config entry.
 *
 *  @param  conf  config.
 *  @param  idx   index of config entry used only if name not found.
 *  @param  name  pointer to name (0:use idx).
 *  @param  v     value used to set CONFIG68_INT entry.
 *  @param  s     value used to set CONFIG68_STRING entry.
 *
 *  @return type of config entry
 *  @retval CONFIG68_ERROR on error
 */
config68_type_t config68_set(config68_t * conf,
                             int idx,
                             const char * name,
                             int v,
                             const char * s);

SC68_EXTERN
/** Load config from file.
 */
int config68_load(config68_t * conf);

SC68_EXTERN
/** Save config into file.
 */
int config68_save(config68_t * conf);

SC68_EXTERN
/** Fill config struct with default value.
 */
int config68_default(config68_t * conf);

SC68_EXTERN
/** Create config. */
config68_t * config68_create(int size);

SC68_EXTERN
/** Destroy config. */
void config68_destroy(config68_t * conf);

SC68_EXTERN
/** library init. */
int config68_init(void);

SC68_EXTERN
/** library shutdown. */
void config68_shutdown();

/**
 *  @}
 */

#endif /* #ifndef _API68_CONF68_H_ */