aboutsummaryrefslogtreecommitdiffstats
path: root/gr-dtv/lib/atsc/atsc_trellis_encoder_impl.cc
blob: 1152a1764f47f67cf0a1e075df5299b5c72f9f5f (plain) (blame)
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
/* -*- c++ -*- */
/*
 * Copyright 2015 Free Software Foundation, Inc.
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this software; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "atsc_trellis_encoder_impl.h"
#include "gnuradio/dtv/atsc_consts.h"
#include <stdio.h>

namespace gr {
namespace dtv {

static const int DIBITS_PER_BYTE = 4;

#define SEGOF(x) ((x) / ((SEGMENT_SIZE + 1) * DIBITS_PER_BYTE))
#define SYMOF(x) (((x) % ((SEGMENT_SIZE + 1) * DIBITS_PER_BYTE)) - 4)

/* How many separate Trellis encoders / Viterbi decoders run in parallel */
static const int NCODERS = 12;

#define ENCODER_SEG_BUMP 4

/* A Segment sync symbol is an 8VSB +5,-5,-5,+5 sequence that occurs at
   the start of each 207-byte segment (including field sync segments).  */
#define DSEG_SYNC_SYM1 0x06 /* +5 */
#define DSEG_SYNC_SYM2 0x01 /* -5 */
#define DSEG_SYNC_SYM3 0x01 /* -5 */
#define DSEG_SYNC_SYM4 0x06 /* +5 */

/* Shift counts to bit numbers (high order, low order); 9x entries unused */
static const int bit1[8] = { 1, 99, 3, 98, 5, 97, 7, 96 };
static const int bit2[8] = { 0, 99, 2, 98, 4, 97, 6, 96 };

atsc_trellis_encoder::sptr atsc_trellis_encoder::make()
{
    return gnuradio::get_initial_sptr(new atsc_trellis_encoder_impl());
}

atsc_trellis_encoder_impl::atsc_trellis_encoder_impl()
    : gr::sync_block("atsc_trellis_encoder",
                     gr::io_signature::make(1, 1, sizeof(atsc_mpeg_packet_rs_encoded)),
                     gr::io_signature::make(1, 1, sizeof(atsc_data_segment)))
{
    reset();
    debug = false;
    set_output_multiple(NCODERS);
}

atsc_trellis_encoder_impl::~atsc_trellis_encoder_impl() {}

void atsc_trellis_encoder_impl::reset()
{
    for (int i = 0; i < NCODERS; i++) {
        enc[i].reset();
    }
}

void atsc_trellis_encoder_impl::encode(atsc_data_segment out[NCODERS],
                                       const atsc_mpeg_packet_rs_encoded in[NCODERS])
{
    unsigned char out_copy[OUTPUT_SIZE];
    unsigned char in_copy[INPUT_SIZE];

    assert(sizeof(in_copy) == sizeof(in[0].data) * NCODERS);
    assert(sizeof(out_copy) == sizeof(out[0].data) * NCODERS);

    // copy input into contiguous temporary buffer
    for (int i = 0; i < NCODERS; i++) {
        assert(in[i].pli.regular_seg_p());
        plinfo::sanity_check(in[i].pli);
        memcpy(&in_copy[i * INPUT_SIZE / NCODERS],
               &in[i].data[0],
               ATSC_MPEG_RS_ENCODED_LENGTH * sizeof(in_copy[0]));
    }

    memset(out_copy, 0, sizeof(out_copy)); // FIXME, sanity check

    // do the deed...
    encode_helper(out_copy, in_copy);

    // copy output from contiguous temp buffer into final output
    for (int i = 0; i < NCODERS; i++) {
        memcpy(&out[i].data[0],
               &out_copy[i * OUTPUT_SIZE / NCODERS],
               ATSC_DATA_SEGMENT_LENGTH * sizeof(out_copy[0]));

        // copy pipeline info
        out[i].pli = in[i].pli;

        plinfo::sanity_check(out[i].pli);
        assert(out[i].pli.regular_seg_p());
    }
}

/*
 * This code expects contiguous arrays. Use it as is, it computes
 * the correct answer. Maybe someday, when we've run out of better
 * things to do, rework to avoid the copying in encode.
 */
void atsc_trellis_encoder_impl::encode_helper(unsigned char output[OUTPUT_SIZE],
                                              const unsigned char input[INPUT_SIZE])
{
    int i;
    int encoder;
    unsigned char trellis_buffer[NCODERS];
    int trellis_wherefrom[NCODERS];
    unsigned char *out, *next_out_seg;
    int chunk;
    int shift;
    unsigned char dibit;
    unsigned char symbol;
    int skip_encoder_bump;

    /* FIXME, we may want special processing here for a flag
     * byte to keep track of which part of the field we're in?
     */

    encoder = NCODERS - ENCODER_SEG_BUMP;
    skip_encoder_bump = 0;
    out = output;
    next_out_seg = out;

    for (chunk = 0; chunk < INPUT_SIZE; chunk += NCODERS) {
        /* Load a new chunk of bytes into the Trellis encoder buffers.
         * They get loaded in an order that depends on where we are in
         * the segment sync progress (sigh).
         * GRR! When the chunk reload happens at the same time as the
         * segment boundary, we should bump the encoder NOW for the reload,
         * rather than LATER during the bitshift transition!!!
         */
        if (out >= next_out_seg) {
            encoder = (encoder + ENCODER_SEG_BUMP) % NCODERS;
            skip_encoder_bump = 1;
        }

        for (i = 0; i < NCODERS; i++) {
            /* for debug */
            trellis_wherefrom[encoder] = chunk + i;
            trellis_buffer[encoder] = input[chunk + i];
            encoder++;
            if (encoder >= NCODERS) {
                encoder = 0;
            }
        }

        for (shift = 6; shift >= 0; shift -= 2) {
            /* Segment boundaries happen to occur on some bitshift transitions. */
            if (out >= next_out_seg) {
                /* Segment transition. Output a data segment sync symbol,
                 * and mess with the trellis encoder mux.
                 */
                *out++ = DSEG_SYNC_SYM1;
                *out++ = DSEG_SYNC_SYM2;
                *out++ = DSEG_SYNC_SYM3;
                *out++ = DSEG_SYNC_SYM4;
                if (debug) {
                    printf("SYNC SYNC SYNC SYNC\n");
                }

                next_out_seg = out + (SEGMENT_SIZE * DIBITS_PER_BYTE);

                if (!skip_encoder_bump) {
                    encoder = (encoder + ENCODER_SEG_BUMP) % NCODERS;
                }
                skip_encoder_bump = 0;
            }

            /* Now run each of the 12 Trellis encoders to spit out 12 symbols.
             * Each encoder takes input from the same byte of the chunk, but
             * the outputs of the encoders come out in various orders.
             * NOPE -- this is false. The encoders take input from various
             * bytes of the chunk (which changes at segment sync time), AND
             * they also come out in various orders. You really do have to
             * keep separate track of: the input bytes, the encoders, and
             * the output bytes -- because they're all moving with respect
             * to each other!!!
             */
            for (i = 0; i < NCODERS; i++) {
                dibit = 0x03 & (trellis_buffer[encoder] >> shift);
                if (debug) {
                    printf("Seg %ld Symb %3ld Trell %2d Byte %6d Bits %d-%d = dibit %d ",
                           (long)SEGOF(out - output),
                           (long)SYMOF(out - output),
                           encoder,
                           trellis_wherefrom[encoder],
                           bit1[shift],
                           bit2[shift],
                           dibit);
                }

                symbol = enc[encoder].encode(dibit);
                *out++ = symbol;
                encoder++;
                if (encoder >= NCODERS) {
                    encoder = 0;
                }
                if (debug) {
                    printf("sym %d\n", symbol);
                }

            } /* Encoders */
        }     /* Bit shifts */
    }         /* Chunks */

    /* Check up on ourselves */
    assert(0 == (INPUT_SIZE * DIBITS_PER_BYTE) % NCODERS);
    assert(OUTPUT_SIZE == out - output);
    assert(NCODERS - ENCODER_SEG_BUMP == encoder);
}

int atsc_trellis_encoder_impl::work(int noutput_items,
                                    gr_vector_const_void_star& input_items,
                                    gr_vector_void_star& output_items)
{
    const atsc_mpeg_packet_rs_encoded* in =
        (const atsc_mpeg_packet_rs_encoded*)input_items[0];
    atsc_data_segment* out = (atsc_data_segment*)output_items[0];

    for (int i = 0; i < noutput_items; i += NCODERS) {
        encode(&out[i], &in[i]);
    }

    // Tell runtime system how many output items we produced.
    return noutput_items;
}

} /* namespace dtv */
} /* namespace gr */