ASK feature 개발 #85

Modem(MOdulator and DEModulator)
- 의미: 신호를 변・복조 하는 장치. 디지털 신호를 아날로그로 변조하고(modulate), 아날로그 신호를 디지털 신호로 복조(demodulate)한다.
- 파일 경로: euphony/src/main/cpp/core/Modem.h, euphony/src/main/cpp/core/ModemFactory.h
ASK (Amplitude Shift Keying)
- 의미: 디지털 신호 전송에 사용하는 변조 방식 중 하나로, 진폭(높낮이)으로 신호를 구분할 수 있다. 모뎀의 초기 방식이다.
- 파일 경로: euphony/src/main/java/co.euphony/util/EuOption.java
FSK (Frequency Shift Keying)
- 의미: 디지털 변조 방식 중 하나로, 주파수로 신호를 구분한다.
- 파일 경로: euphony/src/main/cpp/core/FSK.h, euphony/src/main/cpp/core/source/FSK.cpp

2 replies

aiclaudev Oct 7, 2021

정리 감사합니다! 해석해보고, 추가할 부분 등이 있으면 코멘트달겠습니다!

Jsueeee Oct 8, 2021

깔끔하네요! 👍

jopopcorn · 2021-10-08T16:35:46Z

jopopcorn
Oct 8, 2021

@euphony-io/euphoria

euphony/src/main/cpp/core/Definitions.h 파일의 37라인을 읽어보시면 0.7.1.6 버전에 ASK 피처가 있다는 주석이 적혀있습니다.
v0.7.1.6 브랜치에서 이전 버전 코드를 확인할 수 있는데, 내부 코드만 잘 살펴보면 피처 개발에 많은 도움이 될 것 같습니다.

modulate 함수 구현은 euphony/euphony/src/main/java/euphony/lib/transmitter/EuCodeMaker.java의 코드를 참고하면 될 것 같습니다.
0.8.0 버전의 FSK 코드와 비슷한 흐름인걸로 보이는데 다른 분들 생각은 어떤지 말씀해주세요!!
demodulate는 코드를 더 읽어봐야 감이 올 것 같습니다 ㅜㅜ

공부하면서 사소하게라도 알게 된 내용이 있다면 코멘트 올려주세요!!

8 replies

designe Oct 10, 2021
Maintainer

@psh2849 맞아요! 0 또는 1이기 때문에 BASE2를 활용하면 좋을 것 같아요 :)

psh2849 Oct 10, 2021

그럼 입력으로 들어온 값을 2진수로 변경시키고 2진수 값들을 하나씩 불러와서 0,1로 구분한 다음에 진폭 변경해주면 되지 않을까요???

designe Oct 10, 2021
Maintainer

0은 amplitude가 없는 경우, 1은 amplitude가 발생하는 경우 1로 판단하면 될 것 같네요!

HACore Oct 10, 2021

저도 유닛테스트로 시작하는게 첫 스타트로 좋아보여요!
euphony/src/main/cpp/tests/FSKTest.cpp의 구조를 참고하면 될것같은데 조금 더 파악해보고 글 작성해보겠습니다..!

jopopcorn Oct 10, 2021

저도 유닛테스트로 시작하는게 첫 스타트로 좋아보여요! euphony/src/main/cpp/tests/FSKTest.cpp의 구조를 참고하면 될것같은데 조금 더 파악해보고 글 작성해보겠습니다..!

넵넵 좋습니다!

hoho00 · 2021-10-10T05:45:55Z

hoho00
Oct 10, 2021

스마트 포인터

잘 모르지만, 얕은 지식으로 떠듬떠듬 적어 봅니다. 추가할 내용 있으시면 추가 해 주세요.

c, c++ 은 포인터를 통해서 직접 memory에 access 합니다. 그렇기 때문에 그리고 malloc이나 new 연산자로 생성된 객체들은 해당 메모리를 직접 해제 해 주지 않으면 사용하지 않는 메모리가 남습니다.(memory leak) 그리고 현재 가르키고 있는 객체를 잘못 생성해 버리면, 포인터 객체가 가르키고 있는 객체가 없어지는 에러가 생기게 됩니다. (dangling pointer) 즉,

메모리에 객체를 만들었는데 그걸 가르키고 있는 포인터가 없어서 사용할 수 없는 메모리 낭비가 생겼다 → memory leak
해당 객체의 메모리를 두개 이상의 포인터가 가르키고 있다가, 가르키고 있는 객체가 해제되어서 남은 포인터가 없는 객체를 가르키고 있다. → dangling pointer

위와 같은 메모리 사용 문제를 스마트 포인터를 사용하면 자동적으로 해결해 주기 때문에, raw pointer를 쓰는 것 보다 raw pointer를 스마트 포인터에 대입해서 사용합니다.

euphony 라이브러리에서도 두가지의 스마트 포인터가 사용되더라구요.

shared_pointer, unique_pointer

스마트 포인터 덕분에 코드내에 따로 destruct 하는 부분도 보이지 않구요.

일단 unique포인터에 대해 알아보겠습니다.

unique_pointer

간단하게 말씀드리자면, 하나의 객체에 하나의 포인터만 대입 할 수 있다 입니다. move를 통해 소유권을 이전할 수 있지만, 복사할 수 없습니다. memory leak를 예방 할 수 있겠네요. 왜냐하면 메모리 누수 같은 경우에는 하나의 객체에 여러가지 포인터를 참조하다가 하나의 포인터에서 해제 명령을 내리는 경우 발생 하는데, unique_pointer를 사용하면 하나의 객체에 하나의 포인터만 적용할 수 있기 때문에 memory leak가 발생하는 경우는 없겠네요.

euphony 코드를 볼게요

private:
	std::unique_ptr<FFTModel> fftModel

FFTModel의 경우에는 하나의 객체를 생성하면 여러 포인터가 가르킬 일 없으니까 unique포인터로 지정 해 둔 모습을 보입니다.

fft = std::make_unique<FFTProcessor>(inputFFTSize, inputSampleRate);

test code 내에서 테스트 객체를 생성할 때도 make_unique함수를 사용해 unique 포인터를 생성하는 것을 알 수 있습니다. 유니크 포인터로 객체를 생성하면 매모리 해제 또한 자동으로 해 주기 때문에 그 이점때문에 스마트 포인터를 쓰려면 그냥 유니크 포인터로 객체를 생성하면 됩니다.

shared_pointer

이것은 하나의 객체에 여러개의 포인터를 가르킬 수 있지만, shared_pointer자체에서 객체에 가르키는 pointer의 수를 세기 때문에 객체를 가르키는 pointer의 수가 0가 되면 해당 객체를 해제 합니다. dangling pointer를 예방 할 수 있겠네요.

std::shared_ptr<Packet> demodulate(const WaveList& waveList);

Packet의 벡터, 즉 HexVector 같은 경우 하나의 객체가 여러개의 포인터를 가르켜야 할 일이 있는 것 같습니다. 그래서 shared_pointer를 쓴 것 같습니다.

3 replies

designe Oct 10, 2021
Maintainer

@hoho00 좋네요! 이거 discussion 분기해서 공유해도 좋을 것 같습니다.

hoho00 Oct 10, 2021

넵!!

psh2849 Oct 10, 2021

감사합니다!

jopopcorn · 2021-10-10T13:41:48Z

jopopcorn
Oct 10, 2021

@euphony-io/euphoria
생각해본 ASK 변조 로직의 흐름인데 이렇게 구현하면 괜찮을까요? 더 좋은 방법이 있다면 말씀해주세요!

입력 받은 문자열 source의 HexVector을 만든다. (ASCIICharset().encode(source);)
HexVector로 변환한 값을 Base2 타입의 패킷으로 만든다. (new Packet(BaseType::BASE2, hexVector);)
WaveList FSK::modulate(Packet* packet) 함수에서 return this->modulate(packet->toString());를 수행하여 패킷을 문자열로 바꾸고 변조를 시작한다.
WaveList ASK::modulate(std::string code) 함수에서 'S', '0', '1'에 따른 아날로그 음파를 생성한다.

3 replies

jopopcorn Oct 10, 2021

0과 1로만 이루어졌대도 음파를 n번 혹은 무한대로 생성하려면 패킷이 필요할 것 같아서 이런 흐름으로 생각해봤습니다!
만약 패킷이 없어도 괜찮다면 어떤식으로 구별할 수 있는지도 궁금하네요..

그리고 16진수에서 2진수로 변환하면 0과 1로만 이루어졌기 때문에 Base2Exception은 없어도 괜찮은걸까요??..
혼자 구현을 시도해보다가 궁금해서 추가로 질문(?) 남깁니다!

psh2849 Oct 10, 2021

넵 맞는 것 같습니다! 혹시 테스트 케이스는 생각해보셨나요??

jopopcorn Oct 10, 2021

넵 맞는 것 같습니다! 혹시 테스트 케이스는 생각해보셨나요??

gtest에서 사용하는 메서드들이 뭘 의미하는지 찾아보고 FSK랑 다른 테스트코드 참고하느라 아직 제대로 작성하지는 않았습니다!

jopopcorn · 2021-10-10T16:09:00Z

jopopcorn
Oct 10, 2021

유포니 라이브러리 내의 여러 gtest 코드들을 읽어보고 자주 보이는 명령어, 기능들을 간단하게 정리해보았습니다.
gtest 레퍼런스와 블로그 포스팅을 참고하여 정리했으니 테스트 코드 작성하는데 참고하시면 좋을 것 같습니다!

XX 클래스마다 이름을 다르게 짓는 것을 생각해서 임의로 넣은 것이고, 명령어 뒤에 오는 X는 그 뒤에 들어오는 다양한 기능들이 있다는 것을 표시한 것입니다!
유포니 라이브러리의 gtest 파일을 열어보면서 확인하시면 더 이해가 잘될 것 같습니다!

class XXTestFixture : public ::testing::TestWithParam
-> 값 매개변수 테스트를 만들기 위해 픽스처 클래스를 정의함.

ASSERT_X: 어설션이 실패할 경우 프로그램 실행을 중단함
EXPECT_X: 테스트 케이스에 실패해도 프로그램을 계속 실행함

EXPECT_EQ: 두 값이 같기를 기대하는 메서드
ASSERT_TRUE: 항상 true인 조건을 기대하는 메서드
ASSERT_NE: 두 값이 일치하지 않기를 기대하는 메서드

TEST_P: 테스트 픽스처 클래스에서 사용하는 테스트 패턴을 정의함. 테스트 픽스처 클래스를 의미하는 TestName과, 테스트 수트를 의미하는 TestFixtureName을 매개변수로 지정함. 이 안에서 ASSERT_X, EXPECT_X와 같은 명령문을 활용할 수 있음

TEST_P(TestFixtureName, TestName) {
  ... statements ...
}

INSTANTIATE_TEST_SUITE_P: 테스트 케이스인 TestParamType들을 선언하고 테스트를 확인하도록 함

2 replies

psh2849 Oct 10, 2021

테스트 케이스를 어떻게 짜야될지 모르겠네요 ㅠㅠ

TestParamType("0", 0, 0),

앞엔 2진수 값이 들어가야 할 것 같고, 결과는 0 또는 1로 출력해줘야할까요..?

jopopcorn Oct 10, 2021

테스트 케이스를 어떻게 짜야될지 모르겠네요 ㅠㅠ
TestParamType("0", 0, 0),
앞엔 2진수 값이 들어가야 할 것 같고, 결과는 0 또는 1로 출력해줘야할까요..?

FSK에서는 입력받은 문자열, 기대하는 문자열 길이, 기대하는 주파수 인덱스가 들어가더라고요!
제 생각에는 ASK에서는 첫째 둘째 매개변수는 그대로 하고, 세번째 매개변수에는 기대하는 진폭(0,1) 아니면 입력받은 문자열에 대한 이진값들이 필요하지 않을까요..??

ycs1m1yk · 2021-10-10T17:36:24Z

ycs1m1yk
Oct 10, 2021

FSK 테스트코드에서 테스트 패턴을 정의하는 TEST_P 부분을 살펴봅시다.

euphony/euphony/src/main/cpp/tests/FSKTest.cpp

Lines 32 to 47 in c1bb8f4

    
           TEST_P(FSKTestFixture, FSKModulationString2StringTest) 
        
           { 
        
               createFSK(); 
        
               string inputCode; 
        
               int expectedCodeLength; 
        
               int expectedFreqIndex; 
        
               std::tie(inputCode, expectedCodeLength, expectedFreqIndex) = GetParam(); 
        
               auto modulateFSK = fsk->modulate(inputCode); 
        
               EXPECT_EQ(modulateFSK.size(), expectedCodeLength); 
        
               auto demodulateResult = fsk->demodulate(modulateFSK); 
        
               EXPECT_EQ(inputCode, demodulateResult->getPayloadStr()); 
        
           }

테스트 파라미터 형식과 작성

std::tie(inputCode, expectedCodeLength, expectedFreqIndex) = GetParam();

위와 같이 파라미터를 받아서 테스트하는것을 알 수 있습니다.

따라서 테스트케이스도 아래와 같이 작성하면됩니다.

TestParamtype(inputCode, expectedCodeLength, expectedFreqIndex)

무엇을 테스트하는가?

TEST_P 에서는 2개의 EXPECT_EQ 메서드로 테스트가 이루어집니다.

auto modulateFSK = fsk->modulate(inputCode);
    EXPECT_EQ(modulateFSK.size(), expectedCodeLength);

auto demodulateResult = fsk->demodulate(modulateFSK);
    EXPECT_EQ(inputCode, demodulateResult->getPayloadStr());

3번째 파라미터인 expectedFreqIndex 에 대한 테스트는 수행되지 않고 있습니다.

실제 테스트케이스 예시

euphony/euphony/src/main/cpp/tests/FSKTest.cpp

Line 65 in c1bb8f4

TestParamType("0", 1, 0),

FSKTest.cpp의 첫번째 테스트 케이스입니다.

첫번째 파라미터 "0"은 string타입의 inputCode이며 demodulateResult->getPayloadStr()과 비교됩니다.
두번째 파라미터 1 은 expectedCodeLength이며 modulateFSK.size()와 비교됩니다.
string "0"의 길이가 1이죠.
세번째 파라미터 0은 expectedFreqIndex입니다. TEST_P에서 이에대한 테스트 메서드가 정의돼있지 않습니다. 실제로 이 값을 임의로 바꾸어서 빌드해도 gtest는 통과됩니다.

ASK의 테스트케이스

TestParamtype("0", 1, 0),
TestParamtype("1", 1, 1),
TestParamtype("01", 2, 0),
TestParamtype("1101", 4, 0),
TestParamtype("1010111000", 10, 0)

위와 같이 첫번째에는 0이나1 문자로 이루어진 inputCode, 두번째에는 inputCode의 길이를 넣어주면됩니다. 세번째 파라미터는 무시해도 좋습니다. 일단 임의의 값을 넣어놓으면 될것입니다.

혹은, TEST_P에서

euphony/euphony/src/main/cpp/tests/FSKTest.cpp

Line 40 in c1bb8f4

std::tie(inputCode, expectedCodeLength, expectedFreqIndex) = GetParam();

위 라인을 다음과 같이 수정합니다.

std::tie(inputCode, expectedCodeLength) = GetParam();

그리고 테스트케이스를

TestParamtype("0", 1),
TestParamtype("11", 2)

위와 같이 작성하면 될 것입니다.

3 replies

ycs1m1yk · 2021-10-10T18:01:14Z

ycs1m1yk
Oct 10, 2021

Amplitude를 어떻게 설정할까요?

FSK에서는...

euphony/euphony/src/main/cpp/core/source/FSK.cpp

Lines 19 to 34 in c1bb8f4

    
           WaveList FSK::modulate(string code) { 
        
               vector<shared_ptr<Wave>> result; 
        
               for (char c : code ) { 
        
                   switch(c) { 
        
                       case 'S': 
        
                           result.push_back( 
        
                                   Wave::create() 
        
                                           .vibratesAt(kStartSignalFrequency) 
        
                                           .setSize(kBufferSize) 
        
                                           .setCrossfade(BOTH) 
        
                                           .build() 
        
                           ); 
        
                           break; 
        
                       case '0': case '1': case '2':

FSK클래스의 modulate 메서드의 일부분입니다.

파라미터 string code를 받아서

for (char c : code )

code의 문자마다 char c로 for문이 돌아갑니다.

하나의 문자 c마다 하나의 Wave가 생성됩니다.

c의 값에 따라서 case문으로 분기하고 .vibratesAt() 메서드로 frequency값을 설정합니다. (Frequency Shift)

Amplitude 속성은 어디에?

ASK도 FSK처럼 modulate 메서드안에서 문자에 따라서 amplitude를 설정하면 되겠죠?

euphony/euphony/src/main/cpp/core/Wave.h

Lines 40 to 49 in c1bb8f4

    
           private: 
        
               friend class WaveBuilder; 
        
               int mHz; 
        
               int mSize; 
        
               CrossfadeType crossfadeType; 
        
               std::vector<float> mSource; 
        
               float mPhase = 0.0; 
        
               std::atomic<double> mPhaseIncrement{0.0}; 
        
               void updatePhaseIncrement(int hz);

그런데 Wave.h를 살펴보면 진폭에 관한 속성이 정의돼있지 않습니다.

그냥 mAplitude 속성을 추가하면 되는걸까요?

참고

유포니 프로젝트내에서 amplitude 키워드를 검색해보면

EuPIOscillator와 Oscillator에서는 진폭을 다루고있네요.

근데 Wave클래스와는 연결점이 없는것 같습니다. ASK를 개발하는데 상관이 있는지 모르겠네요.

0 replies

kuro11pow2 · 2021-10-10T20:17:37Z

kuro11pow2
Oct 10, 2021

너무 길어져서 새로운 discussion으로 분리했습니다!

FSK, Wave, Packet 그리고 ASK 짧은? 요약

0 replies

ASK feature 개발 #85

Replies: 12 comments · 22 replies

designe Oct 10, 2021 Maintainer

designe Oct 10, 2021 Maintainer

스마트 포인터

unique_pointer

shared_pointer

designe Oct 10, 2021 Maintainer

테스트 파라미터 형식과 작성

무엇을 테스트하는가?

실제 테스트케이스 예시

ASK의 테스트케이스

Amplitude를 어떻게 설정할까요?

FSK에서는...

Amplitude 속성은 어디에?

참고

Replies: 12 comments 22 replies

designe Oct 10, 2021
Maintainer

designe Oct 10, 2021
Maintainer

designe Oct 10, 2021
Maintainer