Skip to content

Commit 166df24

Browse files
committed
README
1 parent cb3401e commit 166df24

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,30 @@ cmake ..
6464
make
6565
```
6666

67+
## Parameters
68+
69+
The decoder needs to allocate a buffer for storing a frame and for holding the decoded data. The following default values have been defined:
70+
71+
```
72+
#define MP3_MAX_OUTPUT_SIZE 1024 * 5
73+
#define MP3_MAX_FRAME_SIZE 1600
74+
#define AAC_MAX_OUTPUT_SIZE 1024 * 3
75+
#define AAC_MAX_FRAME_SIZE 2100
76+
```
77+
78+
These values are working in most of the cases, but in some exceptional cases you might need to increase these values e.g. to
79+
```
80+
#define MP3_MAX_OUTPUT_SIZE 2048 * 5
81+
#define MP3_MAX_FRAME_SIZE 3200
82+
```
83+
84+
Alternatively you can set the values in your sketch by calling the following methods:
85+
```
86+
setMaxPWMSize(int size)
87+
setMaxFrameSize(int size)
88+
```
89+
90+
6791
## Documentation
6892

6993
- The [Class Documentation can be found here](https://pschatzmann.github.io/arduino-libhelix/html/annotated.html)

0 commit comments

Comments
 (0)