lorak-mmk/echoconnect

Library & GUI program to transfer data between computers using sound.

echoconnect's Issues

Implementacja klasy Config aplikacji

Dokumentacja w kodzie: kod Hamminga

Dokumentacja poza kodem: pakiety

Implementacja i testy: protokół

Dokumentacja poza kodem: sender

Errory przy destrukcji AudioStream

Destroying AudioStream
Stopping stream from thread AudioStreamSignalsAndSlots(0x7f2bf002cbc0)
QObject::killTimer: Timers cannot be stopped from another thread
State changed signal received. New state:  StoppedState
QObject::~QObject: Timers cannot be stopped from another thread
Destroying AudioStream
Stopping stream from thread AudioStreamSignalsAndSlots(0x563d7836e940)
QObject::killTimer: Timers cannot be stopped from another thread
State changed signal received. New state:  StoppedState
QObject::~QObject: Timers cannot be stopped from another thread

Przygotować szkielet projektu

By pracować nad innymi rzeczami potrzeba samego szkieletu który da się kompilować i dalej nad nim pracować

• Struktura folderów
• Pliki CMake
• Budowanie dokumentacji
• Określenie wersjonowania
• Puszczanie testów
• clang-format
• clang-tidy

Implementacja Actions: Settings

Opracowanie wymagań dla CLI i GUI aplikacji

Dokumentacje itp

• Określenie wersjonowania
• Konwencja nazw i ogólnie stylu kodowania

Dokumentacja poza kodem: receiver

Testy: QT rzeczy

Przygotowanie CI dla Windowsa i MacOS

Implementacja Actions: SendText, ReceiveText

Przygotować testy do sprintu 1

Dokumentacja w kodzie: receiver

Testy: sender

Implementacja Action: Calibration

Przygotowanie CI

• Zsetupować github actions
• Osobny branch release

Prezentacja sprintu

Ulepszanie poprawności i szybkości transmisji przez dźwięk

Implementacja generowania struktury oraz funckji main aplikacji

Useful links

Transmission:
https://en.wikipedia.org/wiki/Ethernet_frame

QT:
https://doc.qt.io/qt-5/qaudioinput.html
https://doc.qt.io/qt-5/qaudiooutput.html
https://doc.qt.io/qt-5/qcoreapplication.html
https://doc.qt.io/qt-5/qobject.html

QT intro:
https://wiki.qt.io/Qt_for_Beginners

Dokumentacja poza kodem: protokół

Opracowanie wymagań dla modelu parowania urządzeń i autoryzacji

Dokumentacja aplikacji

Implementacja i testy: kalibracja połączenia

Testy: receiver

Naprawienie problemu z PulseAudio

Implementacja Actions: SendFile, ReceiveFile

Implementacja klas View, Action oraz Menu

Poprawki sendWait i powiązanych

Ujednolicenie kodu, wprowadzenie style guide

Dokumentacja w kodzie: kalibracja

Obsługa mikrofonu i głośników i inne interakcje z QT

Trzeba ogarnąć jak ładnie opakować obsługę mikrofonu i głośników, tak by blackboxowo pisać na tej podstawie kod do przesyłania danych.

• Ogarnąć odpowiednie interfejsy QT
• Udokumentować początkowy interfejs dla uzytkownika bilbioteki (może ulec zmianie)
• Przemysleć strukturę kodu i opisać
• Zaklepać tego blackboxa by można było realizowac inne zadania
• QT w shared library (event loop itp)

Dokumentacja poza kodem: kod Hamminga

Implementacja parsowania opcji wywoływania aplikacji

Dokumentacja poza kodem: biblioteka (echo*)

Poprawki waitForState

Implementacja generacji okna do wprowadzania argumentów

Przygotować i udokumentować kodowanie transmisji

Opracowanie wymagań dla protokołu transmisji

Wymagania do protokołu transmisji:

• P2P - Brak węzłów pośredniczących, brak routingu.
• Transmisja podzielona na pakiety.
• Korekcja błędów - sumy konrolne CRC pakietów, retransmisje przy błędach.
• Pakiety docierają w kolejności wysłania, poprawne albo wcale (a'la TCP)
• Brak gwarancji działania gdy więcej niż 1 nadawca korzysta z tych samych lub zbliżonych częstotliwości - innymi słowy łatwy do zakłócenia.
• Połączeniowy. Przy nawiązaniu połączenia 1 strona nasłuchuje, druga nadaje - brak autonegocjacji kto jest kto.
• Możliwe w przyszłości lecz nie wymagane: auto negocjacja sposobu transmisji (zmienne częstotliwości albo zmienne amplitudy ew oba naraz) oraz parametry (liczba częstotliwości/amplitud), co umożliwia autonegocjację szybkości połączenia.

Obsługa broadcast:

• Wysyłanie pakietów bez sprecyzowanego odbiorcy
• Brak retransmisji
• Odbiór bez sprecyzowanego nadawcy
• Brak autonegocjacji

Przygotować i udokumentować dekodowanie transmisji

Prezentacja sprintu i projektu

README.md w wersji po angielsku

Wrzucić linki do prezentacji do SPRINTS.md

Dokumentacja w kodzie: protokół

Dokumentacja poza kodem: kalibracja

Prezentacja sprintu

Przerobienie rozwiązania z EchoRawConnectionImpl na ładniejsze