Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | # -*- coding: utf-8 -*- |
| 3 | # @file |
Piotr Krysik | a6268a5 | 2017-08-23 16:02:19 +0200 | [diff] [blame] | 4 | # @author (C) 2015 by Roman Khassraf <rkhassraf@gmail.com> |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 5 | # @section LICENSE |
| 6 | # |
| 7 | # Gr-gsm is free software; you can redistribute it and/or modify |
| 8 | # it under the terms of the GNU General Public License as published by |
| 9 | # the Free Software Foundation; either version 3, or (at your option) |
| 10 | # any later version. |
| 11 | # |
| 12 | # Gr-gsm is distributed in the hope that it will be useful, |
| 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | # GNU General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU General Public License |
| 18 | # along with gr-gsm; see the file COPYING. If not, write to |
| 19 | # the Free Software Foundation, Inc., 51 Franklin Street, |
| 20 | # Boston, MA 02110-1301, USA. |
| 21 | # |
| 22 | # |
| 23 | |
| 24 | from gnuradio import blocks |
| 25 | from gnuradio import eng_notation |
| 26 | from gnuradio import gr |
| 27 | from gnuradio.eng_option import eng_option |
| 28 | from optparse import OptionParser, OptionGroup |
| 29 | import collections |
| 30 | import grgsm |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 31 | import pmt |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 32 | import socket |
| 33 | |
| 34 | |
Piotr Krysik | 3e192c4 | 2016-02-13 07:31:51 +0100 | [diff] [blame] | 35 | class grgsm_decoder(gr.top_block): |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 36 | |
| 37 | def __init__(self, timeslot=0, subslot=None, chan_mode='BCCH', |
| 38 | burst_file=None, |
Piotr Krysik | 231aca7 | 2016-07-17 10:44:43 +0200 | [diff] [blame] | 39 | cfile=None, fc=None, samp_rate=2e6, |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 40 | a5=1, a5_kc=None, |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 41 | speech_file=None, speech_codec=None, |
Roman Khassraf | c0addfb | 2016-09-27 20:11:42 +0200 | [diff] [blame] | 42 | enable_voice_boundary_detection=False, |
Piotr Krysik | 0679ceb | 2016-04-29 11:16:22 +0200 | [diff] [blame] | 43 | verbose=False, |
Piotr Krysik | 231aca7 | 2016-07-17 10:44:43 +0200 | [diff] [blame] | 44 | print_bursts=False, ppm=0): |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 45 | |
Piotr Krysik | 3e192c4 | 2016-02-13 07:31:51 +0100 | [diff] [blame] | 46 | gr.top_block.__init__(self, "Gr-gsm Decode") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 47 | |
| 48 | ################################################## |
| 49 | # Parameters |
| 50 | ################################################## |
| 51 | self.timeslot = timeslot |
| 52 | self.subslot = subslot |
| 53 | self.chan_mode = chan_mode |
| 54 | self.burst_file = burst_file |
| 55 | self.cfile = cfile |
| 56 | self.fc = fc |
| 57 | self.samp_rate = samp_rate |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 58 | self.a5 = a5 |
| 59 | self.kc = a5_kc |
| 60 | if len(a5_kc) < 8: |
| 61 | self.kc = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00] |
| 62 | self.speech_file = speech_file |
| 63 | self.speech_codec = speech_codec |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 64 | self.verbose = verbose |
Piotr Krysik | 0679ceb | 2016-04-29 11:16:22 +0200 | [diff] [blame] | 65 | self.print_bursts = print_bursts |
Roman Khassraf | c0addfb | 2016-09-27 20:11:42 +0200 | [diff] [blame] | 66 | self.enable_voice_boundary_detection = enable_voice_boundary_detection |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 67 | |
| 68 | ################################################## |
| 69 | # Blocks |
| 70 | ################################################## |
| 71 | |
| 72 | if self.burst_file: |
| 73 | self.burst_file_source = grgsm.burst_file_source(burst_file) |
| 74 | elif self.cfile: |
| 75 | self.file_source = blocks.file_source(gr.sizeof_gr_complex*1, self.cfile, False) |
| 76 | self.receiver = grgsm.receiver(4, ([0]), ([])) |
Piotr Krysik | 8040e01 | 2016-03-08 21:42:11 +0100 | [diff] [blame] | 77 | if self.fc is not None: |
Piotr Krysik | 231aca7 | 2016-07-17 10:44:43 +0200 | [diff] [blame] | 78 | self.input_adapter = grgsm.gsm_input(ppm=ppm, osr=4, fc=self.fc, samp_rate_in=samp_rate) |
Piotr Krysik | 388bc0d | 2016-07-15 14:17:05 +0200 | [diff] [blame] | 79 | self.offset_control = grgsm.clock_offset_control(self.fc, self.samp_rate) |
Piotr Krysik | 8040e01 | 2016-03-08 21:42:11 +0100 | [diff] [blame] | 80 | else: |
Piotr Krysik | 231aca7 | 2016-07-17 10:44:43 +0200 | [diff] [blame] | 81 | self.input_adapter = grgsm.gsm_input(ppm=ppm, osr=4, samp_rate_in=samp_rate) |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 82 | |
| 83 | self.dummy_burst_filter = grgsm.dummy_burst_filter() |
| 84 | self.timeslot_filter = grgsm.burst_timeslot_filter(self.timeslot) |
| 85 | |
| 86 | self.subslot_filter = None |
| 87 | if self.chan_mode == 'BCCH_SDCCH4' and self.subslot is not None: |
| 88 | self.subslot_filter = grgsm.burst_sdcch_subslot_filter(grgsm.SS_FILTER_SDCCH4, self.subslot) |
| 89 | elif self.chan_mode == 'SDCCH8' and self.subslot is not None: |
| 90 | self.subslot_filter = grgsm.burst_sdcch_subslot_filter(grgsm.SS_FILTER_SDCCH8, self.subslot) |
| 91 | |
| 92 | if self.chan_mode == 'BCCH': |
Piotr Krysik | 773a194 | 2016-05-20 12:45:54 +0200 | [diff] [blame] | 93 | self.bcch_demapper = grgsm.gsm_bcch_ccch_demapper(self.timeslot) |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 94 | elif self.chan_mode == 'BCCH_SDCCH4': |
Piotr Krysik | 773a194 | 2016-05-20 12:45:54 +0200 | [diff] [blame] | 95 | self.bcch_sdcch4_demapper = grgsm.gsm_bcch_ccch_sdcch4_demapper(self.timeslot) |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 96 | elif self.chan_mode == 'SDCCH8': |
Piotr Krysik | 773a194 | 2016-05-20 12:45:54 +0200 | [diff] [blame] | 97 | self.sdcch8_demapper = grgsm.gsm_sdcch8_demapper(self.timeslot) |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 98 | elif self.chan_mode == 'TCHF': |
| 99 | self.tch_f_demapper = grgsm.tch_f_chans_demapper(self.timeslot) |
Roman Khassraf | c0addfb | 2016-09-27 20:11:42 +0200 | [diff] [blame] | 100 | self.tch_f_decoder = grgsm.tch_f_decoder(speech_codec, enable_voice_boundary_detection) |
Piotr Krysik | 2779172 | 2016-07-20 08:12:23 +0200 | [diff] [blame] | 101 | self.tch_f_pdu_to_tagged_stream = blocks.pdu_to_tagged_stream(blocks.byte_t, "packet_len") |
| 102 | self.tch_f_file_sink = blocks.file_sink(gr.sizeof_char*1, speech_file, False) |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 103 | |
| 104 | if self.kc != [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]: |
| 105 | self.decryption = grgsm.decryption(self.kc, self.a5) |
| 106 | self.cch_decoder_decrypted = grgsm.control_channels_decoder() |
| 107 | if self.chan_mode == 'TCHF': |
| 108 | self.decryption_tch_sacch = grgsm.decryption(self.kc, self.a5) |
| 109 | |
| 110 | self.cch_decoder = grgsm.control_channels_decoder() |
| 111 | |
Piotr Krysik | beb36f4 | 2016-06-09 13:58:52 +0200 | [diff] [blame] | 112 | self.socket_pdu_server = blocks.socket_pdu("UDP_SERVER", "127.0.0.1", "4729", 10000) #added in order to avoid generating ICMP messages |
Piotr Krysik | 72a1617 | 2016-02-22 14:30:02 +0100 | [diff] [blame] | 113 | self.socket_pdu = blocks.socket_pdu("UDP_CLIENT", "127.0.0.1", "4729", 10000) |
Piotr Krysik | beb36f4 | 2016-06-09 13:58:52 +0200 | [diff] [blame] | 114 | |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 115 | if self.verbose: |
| 116 | self.message_printer = grgsm.message_printer(pmt.intern(""), True, True, False) |
| 117 | |
Piotr Krysik | 0679ceb | 2016-04-29 11:16:22 +0200 | [diff] [blame] | 118 | if self.print_bursts: |
Piotr Krysik | 7685bc0 | 2016-04-29 12:09:01 +0200 | [diff] [blame] | 119 | self.bursts_printer = grgsm.bursts_printer(pmt.intern(""), True, True, True, True) |
Piotr Krysik | 0679ceb | 2016-04-29 11:16:22 +0200 | [diff] [blame] | 120 | |
| 121 | |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 122 | |
| 123 | ################################################## |
| 124 | # Asynch Message Connections |
| 125 | ################################################## |
| 126 | |
| 127 | if self.burst_file: |
| 128 | self.msg_connect(self.burst_file_source, "out", self.dummy_burst_filter, "in") |
| 129 | elif self.cfile: |
| 130 | self.connect((self.file_source, 0), (self.input_adapter, 0)) |
| 131 | self.connect((self.input_adapter, 0), (self.receiver, 0)) |
Piotr Krysik | 8040e01 | 2016-03-08 21:42:11 +0100 | [diff] [blame] | 132 | if self.fc is not None: |
Piotr Krysik | 6577ec2 | 2016-07-15 13:21:09 +0200 | [diff] [blame] | 133 | self.msg_connect(self.offset_control, "ctrl", self.input_adapter, "ctrl_in") |
Piotr Krysik | 8040e01 | 2016-03-08 21:42:11 +0100 | [diff] [blame] | 134 | self.msg_connect(self.receiver, "measurements", self.offset_control, "measurements") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 135 | self.msg_connect(self.receiver, "C0", self.dummy_burst_filter, "in") |
| 136 | |
| 137 | self.msg_connect(self.dummy_burst_filter, "out", self.timeslot_filter, "in") |
Piotr Krysik | 0679ceb | 2016-04-29 11:16:22 +0200 | [diff] [blame] | 138 | if self.print_bursts: |
| 139 | self.msg_connect(self.timeslot_filter, "out", self.bursts_printer, 'bursts') |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 140 | |
| 141 | if (self.chan_mode == 'BCCH_SDCCH4' or self.chan_mode == 'SDCCH8') and self.subslot_filter is not None: |
| 142 | self.msg_connect(self.timeslot_filter, "out", self.subslot_filter, "in") |
| 143 | |
| 144 | if self.chan_mode == 'BCCH': |
| 145 | if self.subslot_filter is not None: |
| 146 | self.msg_connect(self.subslot_filter, "out", self.bcch_demapper, "bursts") |
| 147 | else: |
| 148 | self.msg_connect(self.timeslot_filter, "out", self.bcch_demapper, "bursts") |
| 149 | |
| 150 | self.msg_connect(self.bcch_demapper, "bursts", self.cch_decoder, "bursts") |
| 151 | self.msg_connect(self.cch_decoder, "msgs", self.socket_pdu, "pdus") |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 152 | if self.verbose: |
| 153 | self.msg_connect(self.cch_decoder, "msgs", self.message_printer, "msgs") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 154 | |
| 155 | elif self.chan_mode == 'BCCH_SDCCH4': |
| 156 | if self.subslot_filter is not None: |
| 157 | self.msg_connect(self.subslot_filter, "out", self.bcch_sdcch4_demapper, "bursts") |
| 158 | else: |
| 159 | self.msg_connect(self.timeslot_filter, "out", self.bcch_sdcch4_demapper, "bursts") |
| 160 | |
| 161 | if self.kc != [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]: |
| 162 | self.msg_connect(self.bcch_sdcch4_demapper, "bursts", self.decryption, "bursts") |
| 163 | self.msg_connect(self.decryption, "bursts", self.cch_decoder_decrypted, "bursts") |
| 164 | self.msg_connect(self.cch_decoder_decrypted, "msgs", self.socket_pdu, "pdus") |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 165 | if self.verbose: |
| 166 | self.msg_connect(self.cch_decoder_decrypted, "msgs", self.message_printer, "msgs") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 167 | |
| 168 | self.msg_connect(self.bcch_sdcch4_demapper, "bursts", self.cch_decoder, "bursts") |
| 169 | self.msg_connect(self.cch_decoder, "msgs", self.socket_pdu, "pdus") |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 170 | if self.verbose: |
| 171 | self.msg_connect(self.cch_decoder, "msgs", self.message_printer, "msgs") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 172 | |
| 173 | elif self.chan_mode == 'SDCCH8': |
| 174 | if self.subslot_filter is not None: |
| 175 | self.msg_connect(self.subslot_filter, "out", self.sdcch8_demapper, "bursts") |
| 176 | else: |
| 177 | self.msg_connect(self.timeslot_filter, "out", self.sdcch8_demapper, "bursts") |
| 178 | |
| 179 | if self.kc != [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]: |
| 180 | self.msg_connect(self.sdcch8_demapper, "bursts", self.decryption, "bursts") |
| 181 | self.msg_connect(self.decryption, "bursts", self.cch_decoder_decrypted, "bursts") |
| 182 | self.msg_connect(self.cch_decoder_decrypted, "msgs", self.socket_pdu, "pdus") |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 183 | if self.verbose: |
| 184 | self.msg_connect(self.cch_decoder_decrypted, "msgs", self.message_printer, "msgs") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 185 | |
| 186 | self.msg_connect(self.sdcch8_demapper, "bursts", self.cch_decoder, "bursts") |
| 187 | self.msg_connect(self.cch_decoder, "msgs", self.socket_pdu, "pdus") |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 188 | if self.verbose: |
| 189 | self.msg_connect(self.cch_decoder, "msgs", self.message_printer, "msgs") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 190 | |
| 191 | elif self.chan_mode == 'TCHF': |
| 192 | self.msg_connect(self.timeslot_filter, "out", self.tch_f_demapper, "bursts") |
| 193 | if self.kc != [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]: |
| 194 | self.msg_connect(self.tch_f_demapper, "acch_bursts", self.decryption_tch_sacch, "bursts") |
| 195 | self.msg_connect(self.tch_f_demapper, "tch_bursts", self.decryption, "bursts") |
| 196 | |
| 197 | self.msg_connect(self.decryption_tch_sacch, "bursts", self.cch_decoder, "bursts") |
| 198 | self.msg_connect(self.decryption, "bursts", self.tch_f_decoder, "bursts") |
| 199 | else: |
| 200 | self.msg_connect(self.tch_f_demapper, "acch_bursts", self.cch_decoder, "bursts") |
| 201 | self.msg_connect(self.tch_f_demapper, "tch_bursts", self.tch_f_decoder, "bursts") |
| 202 | |
| 203 | self.msg_connect(self.tch_f_decoder, "msgs", self.socket_pdu, "pdus") |
| 204 | self.msg_connect(self.cch_decoder, "msgs", self.socket_pdu, "pdus") |
Piotr Krysik | 2779172 | 2016-07-20 08:12:23 +0200 | [diff] [blame] | 205 | self.msg_connect(self.tch_f_decoder, "voice", self.tch_f_pdu_to_tagged_stream, "pdus") |
| 206 | self.connect((self.tch_f_pdu_to_tagged_stream, 0), (self.tch_f_file_sink, 0)) |
| 207 | |
| 208 | |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 209 | if self.verbose: |
| 210 | self.msg_connect(self.tch_f_decoder, "msgs", self.message_printer, "msgs") |
| 211 | self.msg_connect(self.cch_decoder, "msgs", self.message_printer, "msgs") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 212 | |
| 213 | |
| 214 | if __name__ == '__main__': |
| 215 | |
| 216 | # List of channel configurations |
| 217 | channel_modes = ['BCCH', 'BCCH_SDCCH4', 'SDCCH8', 'TCHF'] |
| 218 | |
| 219 | # mapping options to grgsm's enums |
| 220 | tch_codecs = collections.OrderedDict([ |
| 221 | ('FR', grgsm.TCH_FS), |
| 222 | ('EFR', grgsm.TCH_EFR), |
| 223 | ('AMR12.2', grgsm.TCH_AFS12_2), |
| 224 | ('AMR10.2', grgsm.TCH_AFS10_2), |
| 225 | ('AMR7.95', grgsm.TCH_AFS7_95), |
| 226 | ('AMR7.4', grgsm.TCH_AFS7_4), |
| 227 | ('AMR6.7', grgsm.TCH_AFS6_7), |
| 228 | ('AMR5.9', grgsm.TCH_AFS5_9), |
| 229 | ('AMR5.15', grgsm.TCH_AFS5_15), |
| 230 | ('AMR4.75', grgsm.TCH_AFS4_75) |
| 231 | ]) |
| 232 | |
| 233 | kc = [] |
| 234 | |
| 235 | parser = OptionParser(option_class=eng_option, usage="%prog: [options]") |
| 236 | |
| 237 | def kc_callback(option, opt_str, value, parser): |
| 238 | |
| 239 | """ Callback function that parses Kc """ |
| 240 | |
| 241 | # format 0x12,0x34,0x56,0x78,0x90,0xAB,0xCD,0xEF |
| 242 | if ',' in value: |
| 243 | value_str = value.split(',') |
| 244 | |
| 245 | for s in value_str: |
| 246 | val = int(s, 16) |
| 247 | if val < 0 or val > 255: |
| 248 | parser.error("Invalid Kc % s\n" % s) |
| 249 | kc.append(val) |
| 250 | if len(kc) != 8: |
| 251 | parser.error("Invalid Kc length") |
| 252 | # format: 1234567890ABCDEF |
| 253 | elif len(value) == 16: |
| 254 | for i in range(8): |
| 255 | s = value[2*i: 2*i + 2] |
| 256 | val = int(s, 16) |
| 257 | if val < 0 or val > 255: |
| 258 | parser.error("Invalid Kc % s\n" % s) |
| 259 | kc.append(val) |
| 260 | else: |
| 261 | parser.error("Invalid Kc format") |
| 262 | |
| 263 | # define options |
| 264 | parser.add_option("-m", "--mode", dest="chan_mode", default='BCCH', |
| 265 | type='choice', choices=channel_modes, |
| 266 | help="Channel mode. Valid options are 'BCCH' (Non-combined C0), " |
| 267 | "'BCCH_SDCCH4'(Combined C0), 'SDCCH8' (Stand-alone control channel) " |
| 268 | "and 'TCHF' (Traffic Channel, Full rate) ") |
| 269 | parser.add_option("-t", "--timeslot", dest="timeslot", type="intx", default=0, |
| 270 | help="Timeslot to decode [default=%default]") |
| 271 | parser.add_option("-u", "--subslot", dest="subslot", type="intx", |
| 272 | help="Subslot to decode. Use in combination with channel type BCCH_SDCCH4 and SDCCH8") |
| 273 | parser.add_option("-b", "--burst-file", dest="burst_file", help="Input file (bursts)") |
| 274 | parser.add_option("-c", "--cfile", dest="cfile", help="Input file (cfile)") |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 275 | parser.add_option("-v", "--verbose", action="store_true", |
| 276 | help="If set, the decoded messages (with frame number and count) are printed to stdout") |
Piotr Krysik | 0679ceb | 2016-04-29 11:16:22 +0200 | [diff] [blame] | 277 | parser.add_option("-p", "--print-bursts", action="store_true", |
| 278 | help="If set, the raw bursts (with frame number and count) are printed to stdout") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 279 | |
| 280 | # group cfile options together |
| 281 | cfile_options = OptionGroup( |
| 282 | parser, 'Cfile Options', 'Options for decoding cfile input.', |
| 283 | ) |
| 284 | cfile_options.add_option("-f", "--fc", dest="fc", type="eng_float", |
Piotr Krysik | 231aca7 | 2016-07-17 10:44:43 +0200 | [diff] [blame] | 285 | help="Frequency of cfile capture") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 286 | cfile_options.add_option("-a", "--arfcn", dest="arfcn", type="intx", |
| 287 | help="Set ARFCN instead of frequency. " |
| 288 | "In some cases you may have to provide the GSM band also") |
| 289 | cfile_options.add_option("--band", dest="band", |
| 290 | help="Specify the GSM band for the frequency.\nAvailable bands are: " |
| 291 | + ", ".join(grgsm.arfcn.get_bands()) + "." |
| 292 | + "If no band is specified, it will be determined automatically, defaulting to 0.") |
| 293 | cfile_options.add_option("-s", "--samp-rate", dest="samp_rate", type="eng_float", |
Piotr Krysik | 13d9e7a | 2016-04-24 15:23:15 +0200 | [diff] [blame] | 294 | default=eng_notation.num_to_str(1e6), |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 295 | help="Sample rate of cfile capture [default=%default]") |
Piotr Krysik | 231aca7 | 2016-07-17 10:44:43 +0200 | [diff] [blame] | 296 | cfile_options.add_option("--ppm", dest="ppm", type="float", default=0, |
| 297 | help="Set frequency offset correction [default=%default]") |
| 298 | |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 299 | parser.add_option_group(cfile_options) |
| 300 | |
| 301 | # group decryption options |
| 302 | decryption_options = OptionGroup( |
| 303 | parser, 'Decryption Options', 'Options for setting the A5 decryption parameters.', |
| 304 | ) |
| 305 | decryption_options.add_option("-e", "--a5", dest="a5", type="intx", default=1, |
| 306 | help="A5 version [default=%default]. A5 versions 1 - 3 supported") |
| 307 | decryption_options.add_option("-k", "--kc", action="callback", callback=kc_callback, type="string", |
| 308 | help="A5 session key Kc. Valid formats are " |
| 309 | "'0x12,0x34,0x56,0x78,0x90,0xAB,0xCD,0xEF' and '1234567890ABCDEF'") |
| 310 | parser.add_option_group(decryption_options) |
| 311 | |
| 312 | # group TCH options |
| 313 | tch_options = OptionGroup( |
| 314 | parser, 'TCH Options', 'Options for setting Traffic channel decoding parameters.', |
| 315 | ) |
| 316 | tch_options.add_option("-d", "--speech-codec", dest="speech_codec", default='FR', |
| 317 | type='choice', choices=tch_codecs.keys(), |
| 318 | help="TCH-F speech codec [default=%default]. " |
| 319 | "Valid options are " + ", ".join(tch_codecs.keys())) |
| 320 | tch_options.add_option("-o", "--output-tch", dest="speech_output_file", default="/tmp/speech.au.gsm", |
| 321 | help="TCH/F speech output file [default=%default].") |
Piotr Krysik | 2770fc4 | 2017-07-23 22:05:10 +0200 | [diff] [blame] | 322 | tch_options.add_option("--voice-boundary", dest="enable_voice_boundary_detection", action="store_true", default=False, |
Roman Khassraf | c0addfb | 2016-09-27 20:11:42 +0200 | [diff] [blame] | 323 | help="Enable voice boundary detection for traffic channels. This can help reduce noice in the output.") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 324 | parser.add_option_group(tch_options) |
| 325 | |
| 326 | # parse |
| 327 | (options, args) = parser.parse_args() |
| 328 | |
| 329 | # some verifications |
| 330 | if (options.cfile is None and options.burst_file is None) or \ |
| 331 | (options.cfile is not None and options.burst_file is not None): |
| 332 | parser.error("Please provide a cfile or a burst file (but not both) as input\n") |
| 333 | |
| 334 | if options.timeslot < 0 or options.timeslot > 7: |
| 335 | parser.error("Invalid timeslot. Must be a in range 0-7\n") |
| 336 | |
| 337 | if options.subslot is not None and (options.subslot < 0 or options.subslot > 7): |
| 338 | parser.error("Invalid subslot. Must be a in range 0-7\n") |
| 339 | |
| 340 | if options.a5 < 0 or options.a5 > 3: |
| 341 | parser.error("Invalid A5 version\n") |
| 342 | |
Piotr Krysik | 231aca7 | 2016-07-17 10:44:43 +0200 | [diff] [blame] | 343 | if options.cfile and (options.fc is None and options.arfcn is None): |
Piotr Krysik | 8040e01 | 2016-03-08 21:42:11 +0100 | [diff] [blame] | 344 | print("You haven't provided a frequency or an ARFCN - working without automatic frequency offset correction.\n") |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 345 | |
| 346 | # handle frequency / arfcn input |
Piotr Krysik | 231aca7 | 2016-07-17 10:44:43 +0200 | [diff] [blame] | 347 | arfcn = None |
| 348 | fc = None |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 349 | if options.arfcn: |
| 350 | if options.band: |
| 351 | if options.band not in grgsm.arfcn.get_bands(): |
| 352 | parser.error("Invalid GSM band\n") |
| 353 | elif not grgsm.arfcn.is_valid_arfcn(options.arfcn, options.band): |
| 354 | parser.error("ARFCN is not valid in the specified band\n") |
| 355 | else: |
| 356 | arfcn = options.arfcn |
| 357 | fc = grgsm.arfcn.arfcn2downlink(arfcn, options.band) |
| 358 | else: |
| 359 | arfcn = options.arfcn |
| 360 | for band in grgsm.arfcn.get_bands(): |
| 361 | if grgsm.arfcn.is_valid_arfcn(arfcn, band): |
| 362 | fc = grgsm.arfcn.arfcn2downlink(arfcn, band) |
| 363 | break |
| 364 | elif options.fc: |
| 365 | fc = options.fc |
| 366 | if options.band: |
| 367 | if options.band not in grgsm.arfcn.get_bands(): |
| 368 | parser.error("Invalid GSM band\n") |
| 369 | elif not grgsm.arfcn.is_valid_downlink(options.fc, options.band): |
| 370 | parser.error("Frequency is not valid in the specified band\n") |
| 371 | else: |
| 372 | arfcn = grgsm.arfcn.downlink2arfcn(options.fc, options.band) |
| 373 | else: |
| 374 | for band in grgsm.arfcn.get_bands(): |
| 375 | if grgsm.arfcn.is_valid_downlink(options.fc, band): |
| 376 | arfcn = grgsm.arfcn.downlink2arfcn(options.fc, band) |
| 377 | break |
| 378 | |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 379 | # instanciate decoder |
Piotr Krysik | 3e192c4 | 2016-02-13 07:31:51 +0100 | [diff] [blame] | 380 | tb = grgsm_decoder(timeslot=options.timeslot, subslot=options.subslot, chan_mode=options.chan_mode, |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 381 | burst_file=options.burst_file, |
Piotr Krysik | 8040e01 | 2016-03-08 21:42:11 +0100 | [diff] [blame] | 382 | cfile=options.cfile, fc=fc, samp_rate=options.samp_rate, |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 383 | a5=options.a5, a5_kc=kc, |
Roman Khassraf | 262b53d | 2015-09-13 12:14:26 +0200 | [diff] [blame] | 384 | speech_file=options.speech_output_file, speech_codec=tch_codecs.get(options.speech_codec), |
Roman Khassraf | c0addfb | 2016-09-27 20:11:42 +0200 | [diff] [blame] | 385 | enable_voice_boundary_detection=options.enable_voice_boundary_detection, |
Piotr Krysik | 0679ceb | 2016-04-29 11:16:22 +0200 | [diff] [blame] | 386 | verbose=options.verbose, |
Piotr Krysik | 196982b | 2016-07-17 10:43:00 +0200 | [diff] [blame] | 387 | print_bursts=options.print_bursts, ppm=options.ppm) |
Roman Khassraf | 2b1ebf1 | 2015-08-29 17:43:43 +0200 | [diff] [blame] | 388 | |
| 389 | # run |
| 390 | tb.start() |
| 391 | tb.wait() |
| 392 | |