Several enhancements to gr-trellis and gnuradio-examples/python/channel-coding:
[debian/gnuradio] / gnuradio-examples / python / channel-coding / test_sccc_turbo.py
1 #!/usr/bin/env python
2
3 from gnuradio import gr
4 from gnuradio import audio
5 from gnuradio import trellis
6 from gnuradio import eng_notation
7 import math
8 import sys
9 import random
10 import fsm_utils
11
12
13
14 def make_rx(fg,fo,fi,dimensionality,constellation,K,interleaver,IT,Es,N0,type):
15     metrics_in = trellis.metrics_f(fi.O(),dimensionality,constellation,trellis.TRELLIS_EUCLIDEAN) # data preprocessing to generate metrics for innner Viterbi
16     scale = gr.multiply_const_ff(1.0/N0)
17     gnd = gr.vector_source_f([0],True);
18
19     inter=[]
20     deinter=[]
21     siso_in=[]
22     siso_out=[]
23
24     for it in range(IT-1):
25       inter.append( trellis.permutation(interleaver.K(),interleaver.INTER(),fi.I(),gr.sizeof_float) )
26       siso_in.append( trellis.siso_f(fi,K,0,3,True,False,type) )
27       deinter.append( trellis.permutation(interleaver.K(),interleaver.DEINTER(),fi.I(),gr.sizeof_float) )
28       siso_out.append( trellis.siso_f(fo,K,0,3,False,True,type) )
29       fg.connect (inter[it],(siso_in[it],0))
30       fg.connect (gnd,(siso_out[it],0))
31       fg.connect (siso_in[it],deinter[it],(siso_out[it],1))
32
33     inter.append( trellis.permutation(interleaver.K(),interleaver.INTER(),fi.I(),gr.sizeof_float) )
34     siso_in.append( trellis.siso_f(fi,K,0,-1,True,False,type) )
35     deinter.append( trellis.permutation(interleaver.K(),interleaver.DEINTER(),fi.I(),gr.sizeof_float) )
36     siso_out.append( trellis.viterbi_s(fo,K,0,-1) )
37     fg.connect (inter[IT-1],(siso_in[IT-1],0))
38     fg.connect (siso_in[IT-1],deinter[IT-1],siso_out[IT-1])
39
40     # connect first stage
41     fg.connect (gnd,inter[0])
42     fg.connect (metrics_in,scale)
43     fg.connect (scale,(siso_in[0],1))
44     for it in range(IT-1):
45       fg.connect (siso_out[it],inter[it+1])
46       fg.connect (metrics_in,(siso_in[it+1],1))
47     return (metrics_in,siso_out[IT-1])
48
49
50 def run_test (fo,fi,interleaver,Kb,bitspersymbol,K,dimensionality,constellation,Es,N0,IT,seed):
51     fg = gr.flow_graph ()
52
53
54     # TX
55     src = gr.lfsr_32k_source_s()
56     src_head = gr.head (gr.sizeof_short,Kb/16) # packet size in shorts
57     s2fsmi = gr.packed_to_unpacked_ss(bitspersymbol,gr.GR_MSB_FIRST) # unpack shorts to symbols compatible with the outer FSM input cardinality
58     enc_out = trellis.encoder_ss(fo,0) # initial state = 0
59     inter = trellis.permutation(interleaver.K(),interleaver.INTER(),1,gr.sizeof_short)
60     enc_in = trellis.encoder_ss(fi,0) # initial state = 0
61     mod = gr.chunks_to_symbols_sf(constellation,dimensionality)
62
63     # CHANNEL
64     add = gr.add_ff()
65     noise = gr.noise_source_f(gr.GR_GAUSSIAN,math.sqrt(N0/2),seed)
66
67     # RX
68     (head,tail) = make_rx(fg,fo,fi,dimensionality,constellation,K,interleaver,IT,Es,N0,trellis.TRELLIS_MIN_SUM)
69     #(head,tail) = make_rx(fg,fo,fi,dimensionality,constellation,K,interleaver,IT,Es,N0,trellis.TRELLIS_SUM_PRODUCT)
70     fsmi2s = gr.unpacked_to_packed_ss(bitspersymbol,gr.GR_MSB_FIRST) # pack FSM input symbols to shorts
71     dst = gr.check_lfsr_32k_s()
72     
73     fg.connect (src,src_head,s2fsmi,enc_out,inter,enc_in,mod)
74     fg.connect (mod,(add,0))
75     fg.connect (noise,(add,1))
76     fg.connect (add,head)
77     fg.connect (tail,fsmi2s,dst)
78
79     fg.run()
80  
81     #print enc_out.ST(), enc_in.ST()
82     
83     ntotal = dst.ntotal ()
84     nright = dst.nright ()
85     runlength = dst.runlength ()
86     return (ntotal,ntotal-nright)
87
88
89 def main(args):
90     nargs = len (args)
91     if nargs == 4:
92         fname_out=args[0]
93         fname_in=args[1]
94         esn0_db=float(args[2]) # Es/No in dB
95         rep=int(args[3]) # number of times the experiment is run to collect enough errors
96     else:
97         sys.stderr.write ('usage: test_tcm.py fsm_name_out fsm_fname_in Es/No_db  repetitions\n')
98         sys.exit (1)
99
100     # system parameters
101     Kb=1024*16  # packet size in bits (make it multiple of 16 so it can be packed in a short)
102     fo=trellis.fsm(fname_out) # get the outer FSM specification from a file
103     fi=trellis.fsm(fname_in) # get the innner FSM specification from a file
104     bitspersymbol = int(round(math.log(fo.I())/math.log(2))) # bits per FSM input symbol
105     if fo.O() != fi.I():
106         sys.stderr.write ('Incompatible cardinality between outer and inner FSM.\n')
107         sys.exit (1)
108     K=Kb/bitspersymbol # packet size in trellis steps
109     interleaver=trellis.interleaver(K,666) # construct a random interleaver
110     modulation = fsm_utils.psk8 # see fsm_utlis.py for available predefined modulations
111     dimensionality = modulation[0]
112     constellation = modulation[1] 
113     if len(constellation)/dimensionality != fi.O():
114         sys.stderr.write ('Incompatible FSM output cardinality and modulation size.\n')
115         sys.exit (1)
116     # calculate average symbol energy
117     Es = 0
118     for i in range(len(constellation)):
119         Es = Es + constellation[i]**2
120     Es = Es / (len(constellation)/dimensionality)
121     N0=Es/pow(10.0,esn0_db/10.0); # calculate noise variance
122     IT = 3 # number of turbo iterations
123     
124     tot_s=0 # total number of transmitted shorts
125     terr_s=0 # total number of shorts in error
126     terr_p=0 # total number of packets in error
127     for i in range(rep):
128         (s,e)=run_test(fo,fi,interleaver,Kb,bitspersymbol,K,dimensionality,constellation,Es,N0,IT,-long(666+i)) # run experiment with different seed to get different noise realizations
129         tot_s=tot_s+s
130         terr_s=terr_s+e
131         terr_p=terr_p+(terr_s!=0)
132         if ((i+1)%10==0): # display progress
133             print i+1,terr_p, '%.2e' % ((1.0*terr_p)/(i+1)),tot_s,terr_s, '%.2e' % ((1.0*terr_s)/tot_s)
134     # estimate of the (short or bit) error rate
135     print rep,terr_p, '%.2e' % ((1.0*terr_p)/(i+1)),tot_s,terr_s, '%.2e' % ((1.0*terr_s)/tot_s)
136
137
138 if __name__ == '__main__':
139     main (sys.argv[1:])