aboutsummaryrefslogtreecommitdiffstats
path: root/src/common/Audio/cw.c
blob: 667d45930141bc094a81d744c8b1e41861552508 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Matthias P. Braendli
 *
 * 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.
*/

/* CW and PSK31 generator
 *
 * Concept:
 *
 * +-------------------+                    +----------------+
 * | cw_push_message() | -> cw_msg_queue -> | cw_psk31task() | -> cw_audio_queue
 * +-------------------+                    +----------------+
 *
 * The cw_psk31_fill_buffer() function can be called to fetch audio from the
 * audio_queue
 */

#include "Audio/cw.h"
#include "Core/common.h"
#include "Audio/audio.h"
#include <string.h>

#ifdef SIMULATOR
#include <math.h>
#define arm_cos_f32 cosf
#define arm_sin_f32 sinf
#else
#include "arm_math.h"
#endif

/* Kernel includes. */
#include "FreeRTOS.h"
#include "task.h"
#include "queue.h"
#include "semphr.h"

#define MAX_MESSAGE_LEN 1024
#define MAX_ON_BUFFER_LEN 8192

const uint8_t cw_mapping[60] = { // {{{
    // Read bits from right to left

    0b110101, //+ ASCII 43
    0b110101, //, ASCII 44
    0b1011110, //- ASCII 45

    0b1010101, //., ASCII 46
    0b110110, // / ASCII 47

    0b100000, // 0, ASCII 48
    0b100001, // 1
    0b100011,
    0b100111,
    0b101111,
    0b111111,
    0b111110,
    0b111100,
    0b111000,
    0b110000, // 9, ASCII 57

    // The following are mostly invalid, but
    // required to fill the gap in ASCII between
    // numerals and capital letters
    0b10, // :
    0b10, // ;
    0b10, // <
    0b101110, // =
    0b10, // >
    0b1110011, // ?
    0b1101001, //@

    0b101, // A  ASCII 65
    0b11110,
    0b11010,
    0b1110,
    0b11,
    0b11011,
    0b1100,
    0b11111,
    0b111,
    0b10001,
    0b1010,
    0b11101,
    0b100, //M
    0b110,
    0b1000,
    0b11001,
    0b10100,
    0b1101,
    0b1111,
    0b10,
    0b1011,
    0b10111,
    0b1001,
    0b10110,
    0b10010,
    0b11100, // Z

    0b101010, //Start, ASCII [
    0b1010111, // SK , ASCII '\'
}; //}}}

#if ENABLE_PSK31
/*
 * PSK31 Varicode
 * http://aintel.bi.ehu.es/psk31.html
 */
const char *psk31_varicode[] = { // {{{
    "1010101011",
    "1011011011",
    "1011101101",
    "1101110111",
    "1011101011",
    "1101011111",
    "1011101111",
    "1011111101",
    "1011111111",
    "11101111",
    "11101",
    "1101101111",
    "1011011101",
    "11111",
    "1101110101",
    "1110101011",
    "1011110111",
    "1011110101",
    "1110101101",
    "1110101111",
    "1101011011",
    "1101101011",
    "1101101101",
    "1101010111",
    "1101111011",
    "1101111101",
    "1110110111",
    "1101010101",
    "1101011101",
    "1110111011",
    "1011111011",
    "1101111111",
    "1",
    "111111111",
    "101011111",
    "111110101",
    "111011011",
    "1011010101",
    "1010111011",
    "101111111",
    "11111011",
    "11110111",
    "101101111",
    "111011111",
    "1110101",
    "110101",
    "1010111",
    "110101111",
    "10110111",
    "10111101",
    "11101101",
    "11111111",
    "101110111",
    "101011011",
    "101101011",
    "110101101",
    "110101011",
    "110110111",
    "11110101",
    "110111101",
    "111101101",
    "1010101",
    "111010111",
    "1010101111",
    "1010111101",
    "1111101",
    "11101011",
    "10101101",
    "10110101",
    "1110111",
    "11011011",
    "11111101",
    "101010101",
    "1111111",
    "111111101",
    "101111101",
    "11010111",
    "10111011",
    "11011101",
    "10101011",
    "11010101",
    "111011101",
    "10101111",
    "1101111",
    "1101101",
    "101010111",
    "110110101",
    "101011101",
    "101110101",
    "101111011",
    "1010101101",
    "111110111",
    "111101111",
    "111111011",
    "1010111111",
    "101101101",
    "1011011111",
    "1011",
    "1011111",
    "101111",
    "101101",
    "11",
    "111101",
    "1011011",
    "101011",
    "1101",
    "111101011",
    "10111111",
    "11011",
    "111011",
    "1111",
    "111",
    "111111",
    "110111111",
    "10101",
    "10111",
    "101",
    "110111",
    "1111011",
    "1101011",
    "11011111",
    "1011101",
    "111010101",
    "1010110111",
    "110111011",
    "1010110101",
    "1011010111",
    "1110110101",
}; //}}}
#endif

// Function to display message in GUI
void cw_message_sent(const char* str);

struct cw_message_s {
    char          message[MAX_MESSAGE_LEN];
    size_t        message_len;

    int           freq;

    // If dit_duration is 0, the message is sent in PSK31
    int           dit_duration;
};

// The queue contains above structs
QueueHandle_t cw_msg_queue;

// Queue that contains audio data
QueueHandle_t cw_audio_queue;
static int    cw_psk31_samplerate;

static int    cw_transmit_ongoing;

static void cw_psk31_task(void *pvParameters);

void cw_psk31_init(unsigned int samplerate)
{
    cw_psk31_samplerate = samplerate;
    cw_transmit_ongoing = 0;

    cw_msg_queue = xQueueCreate(10, sizeof(struct cw_message_s));
    if (cw_msg_queue == 0) {
        while(1); /* fatal error */
    }

    cw_audio_queue = xQueueCreate(1, AUDIO_BUF_LEN * sizeof(int16_t));
    if (cw_audio_queue == 0) {
        while(1); /* fatal error */
    }

    xTaskCreate(
            cw_psk31_task,
            "CWPSKTask",
            8*configMINIMAL_STACK_SIZE,
            (void*) NULL,
            tskIDLE_PRIORITY + 3UL,
            NULL);
}

/* Parse one CW letter/symbol, and fill in the on_buffer.
 * Returns number of uint8_t written.
 */
size_t cw_symbol(uint8_t sym, uint8_t *on_buffer, size_t on_buffer_size)
{
    uint8_t p = 0;
    uint8_t val = cw_mapping[sym];
    size_t pos = 0;

    while((val >> p) != 0b1) {

        if (((val >> p) & 0b1) == 0b1) {
            if (pos + 2 < on_buffer_size) {
                // tone(1)
                on_buffer[pos++] = 1;

                // silence(1)
                on_buffer[pos++] = 0;
            }
        }
        else {
            if (pos + 4 < on_buffer_size) {
                // tone(3)
                on_buffer[pos++] = 1;
                on_buffer[pos++] = 1;
                on_buffer[pos++] = 1;

                // silence(1)
                on_buffer[pos++] = 0;
            }
        }

        p++;
    }

    // silence(2)
    if (pos + 2 < on_buffer_size) {
        for (int i = 0; i < 2; i++) {
            on_buffer[pos++] = 0;
        }
    }

    return pos;
}

// Transmit a string in morse code or PSK31.
// Supported range for CW:
// All ASCII between '+' and '\', which includes
// numerals and capital letters.
// Distinction between CW and PSK31 is done on dit_duration==0
int cw_psk31_push_message(const char* text, int dit_duration, int frequency)
{
    const int text_len = strlen(text);

    if (strlen(text) > MAX_MESSAGE_LEN) {
        return 0;
    }

    struct cw_message_s msg;
    for (int i = 0; i < MAX_MESSAGE_LEN; i++) {
        if (i < text_len) {
            msg.message[i] = text[i];
        }
        else {
            msg.message[i] = '\0';
        }
    }
    msg.message_len = text_len;
    msg.freq = frequency;
    msg.dit_duration = dit_duration;

    xQueueSendToBack(cw_msg_queue, &msg, portMAX_DELAY); /* Send Message */

    cw_message_sent(msg.message);

    return 1;
}

/* Parse the message and fill the on_buffer with CW on/CW off information.
 * Returns the number of on/off bits written.
 */
static size_t cw_text_to_on_buffer(const char *msg, uint8_t *on_buffer, size_t on_buffer_size)
{
    size_t pos = 0;
    const char* sym = msg;
    do {
        if (*sym < '+' || *sym > '\\') {
            if (pos + 3 < on_buffer_size) {
                for (int i = 0; i < 3; i++) {
                    on_buffer[pos++] = 0;
                }
            }
        }
        else {
            pos += cw_symbol(*sym - '+', on_buffer + pos, on_buffer_size - pos);
        }
        sym++;
    } while (*sym != '\0');

    return pos;
}


#if ENABLE_PSK31
/*
 * Turn a null terminated ASCII string into a uint8_t buffer
 * of 0 and 1 representing the PSK31 varicode for the input.
 *
 * outstr must be at least size 20 + strlen(instr)*12 + 20 to accomodate
 * the header and tail.
 *
 * Returns number of bytes written.
 */
static size_t psk31_text_to_phase_buffer(const char* instr, uint8_t* outbits)
{
    int i=0, j, k;

    /* Header of 0s */
    for (j=0; j < 20; j++) {
        outbits[i++] = 0;
    }

    /* Encode the message, with 00 between letters */
    for (j=0; j < strlen(instr); j++) {
        const char* varicode_bits = psk31_varicode[(int)instr[j]];
        for(k=0; k < strlen(varicode_bits); k++) {
            outbits[i++] = (varicode_bits[k] == '1') ? 1 : 0;
        }
        outbits[i++] = 0;
        outbits[i++] = 0;
    }

    /* Tail of 0s */
    for (j=0; j < 20; j++) {
        outbits[i++] = 0;
    }

    return i;
}
#endif


size_t cw_psk31_fill_buffer(int16_t *buf, size_t bufsize)
{
    if (xQueueReceiveFromISR(cw_audio_queue, buf, NULL)) {
        return bufsize;
    }
    else {
        return 0;
    }
}

static int16_t cw_audio_buf[AUDIO_BUF_LEN];
static uint8_t cw_psk31_buffer[MAX_ON_BUFFER_LEN];
static struct cw_message_s cw_fill_msg_current;

// Routine to generate CW audio
static float cw_generate_audio_ampl = 0.0f;
static float cw_generate_audio_nco = 0.0f;
static int16_t cw_generate_audio(float omega, int i, int __attribute__ ((unused))t)
{
    int16_t s = 0;
    // Remove clicks from CW
    if (cw_psk31_buffer[i]) {
        const float remaining = 32768.0f - cw_generate_audio_ampl;
        cw_generate_audio_ampl += remaining / 64.0f;
    }
    else {
        cw_generate_audio_ampl -= cw_generate_audio_ampl / 64.0f;

        if (cw_generate_audio_ampl < 0) {
            cw_generate_audio_ampl = 0;
        }
    }

    cw_generate_audio_nco += omega;
    if (cw_generate_audio_nco > FLOAT_PI) {
        cw_generate_audio_nco -= 2.0f * FLOAT_PI;
    }

    s = cw_generate_audio_ampl * arm_sin_f32(cw_generate_audio_nco);
    return s;
}

#if ENABLE_PSK31
static float psk31_generate_audio_nco = 0.0f;
static int   psk31_current_psk_phase = 1;
static int16_t psk31_generate_audio(float omega, int i, int t, int samples_per_symbol)
{
    int16_t s = 0;
    const float base_ampl = 20000.0f;
    float psk31_generate_audio_ampl = 0.0f;

    if (cw_psk31_buffer[i] == 1) {
        psk31_generate_audio_ampl = base_ampl;
    }
    else {
        psk31_generate_audio_ampl = base_ampl * arm_cos_f32(
                FLOAT_PI*(float)t/(float)samples_per_symbol);
    }

    psk31_generate_audio_nco += omega;
    if (psk31_generate_audio_nco > FLOAT_PI) {
        psk31_generate_audio_nco -= 2.0f * FLOAT_PI;
    }

    s = psk31_generate_audio_ampl *
        arm_sin_f32(psk31_generate_audio_nco +
            (psk31_current_psk_phase == 1 ? 0.0f : FLOAT_PI));

    return s;
}
#endif

static void cw_psk31_task(void __attribute__ ((unused))*pvParameters)
{
    int     buf_pos = 0;

    while (1) {
        int status = xQueueReceive(cw_msg_queue, &cw_fill_msg_current, portMAX_DELAY);
        if (status == pdTRUE) {

            size_t cw_psk31_buffer_len = 0;

            cw_transmit_ongoing = 1;

            if (cw_fill_msg_current.dit_duration) {
                cw_psk31_buffer_len = cw_text_to_on_buffer(
                        cw_fill_msg_current.message,
                        cw_psk31_buffer,
                        MAX_ON_BUFFER_LEN);

            }
#if ENABLE_PSK31
            else {
                cw_psk31_buffer_len = psk31_text_to_phase_buffer(
                        cw_fill_msg_current.message,
                        cw_psk31_buffer);
            }
#endif

            // Angular frequency of NCO
            const float omega = 2.0f * FLOAT_PI * cw_fill_msg_current.freq /
                (float)cw_psk31_samplerate;

            const int samples_per_symbol = (cw_fill_msg_current.dit_duration != 0) ?
                (cw_psk31_samplerate * cw_fill_msg_current.dit_duration) / 1000 :
                /* BPSK31 is at 31.25 symbols per second. */
                 cw_psk31_samplerate * 100 / 3125;

#if ENABLE_PSK31
            psk31_current_psk_phase = 1;
#endif

            for (int i = 0; i < cw_psk31_buffer_len; i++) {
                for (int t = 0; t < samples_per_symbol; t++) {
#if ENABLE_PSK31
                    int16_t s = (cw_fill_msg_current.dit_duration != 0) ?
                        cw_generate_audio(omega, i, t) :
                        psk31_generate_audio(omega, i, t, samples_per_symbol);
#else
                    int16_t s = cw_generate_audio(omega, i, t);
#endif

                    // Stereo
                    for (int channel = 0; channel < 2; channel++) {
                        if (buf_pos == AUDIO_BUF_LEN) {
                            // It should take AUDIO_BUF_LEN/cw_psk31_samplerate seconds to send one buffer.
                            // If it takes more than 4 times as long, we think there is a problem.
                            const TickType_t reasonable_delay = pdMS_TO_TICKS(4000 * AUDIO_BUF_LEN / cw_psk31_samplerate);
                            if (xQueueSendToBack(cw_audio_queue, &cw_audio_buf, reasonable_delay) != pdTRUE) {
                                trigger_fault(FAULT_SOURCE_CW_AUDIO_QUEUE);
                            }
                            buf_pos = 0;
                        }
                        cw_audio_buf[buf_pos++] = s;
                    }

                }

#if ENABLE_PSK31
                if (cw_psk31_buffer[i] == 0) {
                    psk31_current_psk_phase *= -1;
                }
#endif
            }

            // We have completed this message

            cw_transmit_ongoing = 0;
        }
    }
}

int cw_psk31_busy(void)
{
    return cw_transmit_ongoing;
}