Update README.md

main
Joshua Jerred 2023-03-13 16:54:19 -06:00 zatwierdzone przez GitHub
rodzic 3adfe6b24c
commit 48bae4ce51
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 12 dodań i 8 usunięć

Wyświetl plik

@ -4,7 +4,9 @@ Currently in development but it's functional. Will be used with the MWAV library
A simple library for manipulating images into common SSTV image formats using Magick++.
# Convert an image to the size specified by the SSTV mode and add a call sign
## Examples
### Convert an image to the size specified by the SSTV mode and add a call sign
```cpp
SstvImage image(SstvImage::Mode::ROBOT_36_COLOR, "test1.png");
image.AddCallSign("N0CALL");
@ -14,7 +16,7 @@ test1.png | converted_test1.png
:-------------------------:|:-------------------------:
<img src="https://user-images.githubusercontent.com/19292194/224849070-d1468c89-010d-46bd-af68-72c0e7516e87.png" width="450"> | <img src="https://user-images.githubusercontent.com/19292194/224849046-d80b2945-028a-4301-9520-3f03c7a88681.png" width="300">
# Get RGB values of specific pixels
### Get RGB values of specific pixels
```cpp
SstvImage image(SstvImage::Mode::ROBOT_36_COLOR, "example/test1.png");
/*
@ -27,17 +29,19 @@ test1.png | converted_test1.png
pixel = image.GetPixel(128, 91, pixel); // Get Pixel returns false if the pixel is out of bounds
std::cout << (int)pixel.r << " " << (int)pixel.g << " " << (int)pixel.b << std::endl;
// 0 191 0
// This will output "0 191 0"
```
***
## Current Functionality
Basic Features:
- Overlay call sign and ~~message text~~
- Convert the image to the proper color space
- Get the values for individual pixels
- ~~Add Data to the image~~
***
Supported SSTV Image Formats:
- Robot24
- Robot36
@ -54,6 +58,6 @@ Magick++ (7.1) with ``libjpeg62-dev``, ``libpng-dev``, ``libfreetype6-dev`` is r
Example Image Sources:
|Image File|Source|License|
|:--------:|:----:|:-----:|
|`example/test1.png`|[Wikipedia](https://en.wikipedia.org/wiki/File:Philips_PM5544.svg)|GNU 1.2|
|`example/test2.png`|[Wikipedia](https://en.wikipedia.org/wiki/File:TwibrightLinksTestCard.png)|GNU 1.2|
|`example/test3.jpg`|[Wikipedia](https://en.wikipedia.org/wiki/File:SMPTE_Color_Bars.svg)|Public Domain|
|``example/test1.png``|[Wikipedia](https://en.wikipedia.org/wiki/File:Philips_PM5544.svg)|GNU 1.2|
|``example/test2.png``|[Wikipedia](https://en.wikipedia.org/wiki/File:TwibrightLinksTestCard.png)|GNU 1.2|
|``example/test3.jpg``|[Wikipedia](https://en.wikipedia.org/wiki/File:SMPTE_Color_Bars.svg)|Public Domain|