see changes in readme.md (09.04.26)

This commit is contained in:
2026-04-09 14:30:20 +02:00
parent f050cad853
commit aa67aa0e07
12 changed files with 96267 additions and 43 deletions

View File

@@ -1,6 +1,6 @@
# sstv e36 encoder
This is a SSTV "encoder", currently it is in work, but it has some modes already:
This is a SSTV "encoder", currently it is in work, but it has some modes already: (update of 09.04.26 - We now have a component with miniaudio which is able to stream in live microphone data)
Future plans for a decoder have been made. I do not plan to do any decoding
soon. Wayy to much of a workload, high cortisol!
@@ -19,9 +19,14 @@ soon. Wayy to much of a workload, high cortisol!
Written in _pure_ **C** with some _Makefiles_ to pull it together
## License:
## Changes:
This project is distributed under the MiT License!
- 09.04.26
- Added Audio stream provider ([.c](/src/decoder/provider/audio_in_provider.c), [.h](/include/decoder/provider/audio_in_provider.h), [test](/src/decoder/test/audio_in_provider_test.c))
- Added Licenses to [third party](/third_party/license/)
- Added a few things to the [gitignore](.gitignore)
- Added new [AP_TEST](/include/decoder/provider/audio_in_provider.h) to [Makefile](Makefile)
- Added [miniaudio.h](https://miniaud.io/)
### For developing or adding to the source code:
@@ -69,8 +74,6 @@ In you C File:
#include "decoder/modes/martin.h" // for example
```
If you add a new module, you may add to the Makefile. as a -I CFLAG!
#### C Files:
For a real implementation this stub below would make 0 sense,
@@ -104,33 +107,13 @@ References:
If you have the balls to define a new Mode, then refer to the Dayton Papers!
And when your done make this [Table](#support-table) complete!
### Our License:
#### MIT :
```
Copyright 2026 , rattatwinko
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
#### Defining Stuff in the Makefile:
#### For stb_image.h:
```
ALTERNATIVE A - MIT License
Copyright (c) 2017 Sean Barrett
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
If you were to add new Modules then add them to the makefile.
As a Example are our CFLAGS. which define which include directories to use! Currently it is just include and third_party (for stbi)
### Licensing:
All Third-Party Licenses are available under *[./third_party/license/](./third_party/license/)*
Our Licenses is a MIT License is available under [*./LICENSE*](./LICENSE)