diff --git a/grc/CMakeLists.txt b/grc/CMakeLists.txt index 1077b5f..b075090 100644 --- a/grc/CMakeLists.txt +++ b/grc/CMakeLists.txt @@ -31,6 +31,7 @@ list(APPEND enabled_blocks satnogs_block_tree.xml satnogs_ax25_decoder_bm.xml satnogs_ax25_encoder_mb.xml + satnogs_ax25_decoder.xml satnogs_ccsds_rs_decoder_mm.xml satnogs_decoder_8b10b.xml satnogs_fox_telem_mm.xml diff --git a/grc/satnogs_ax25_decoder.xml b/grc/satnogs_ax25_decoder.xml new file mode 100644 index 0000000..268c1de --- /dev/null +++ b/grc/satnogs_ax25_decoder.xml @@ -0,0 +1,80 @@ + + + AX.25 Decoder Definition + variable_ax25_decoder + import satnogs + self.$(id) = $(id) = satnogs.ax25_decoder_make($addr, $ssid, $promisc, $descrambling, $crc_check, $frame_len) + satnogs.ax25_decoder_make($addr, $ssid, $promisc, $descrambling, $crc_check, $frame_len) + + + Ignore Me + value + 'ok' + raw + all + + + + Receiver Callsign + addr + 'GND' + string + + + + Receiver SSID + ssid + 0 + int + + + + + Promiscuous mode + promisc + enum + + + + + + G3RUH descrambling + descrambling + enum + + + + + + Perform CRC + crc_check + enum + + + + + + Maximum Frame Length + frame_len + 512 + int + + \ No newline at end of file diff --git a/grc/satnogs_block_tree.xml b/grc/satnogs_block_tree.xml index b9bc906..c95c080 100644 --- a/grc/satnogs_block_tree.xml +++ b/grc/satnogs_block_tree.xml @@ -1,5 +1,9 @@ [SatNOGS] + + Decoders + variable_ax25_decoder + Satellites diff --git a/include/satnogs/CMakeLists.txt b/include/satnogs/CMakeLists.txt index e6f543e..eebaf1e 100644 --- a/include/satnogs/CMakeLists.txt +++ b/include/satnogs/CMakeLists.txt @@ -33,6 +33,7 @@ list(APPEND HEADER_FILES config.h convolutional_deinterleaver.h log.h + metadata.h morse_tree.h morse.h morse_decoder.h @@ -61,14 +62,6 @@ list(APPEND HEADER_FILES noaa_apt_sink.h frame_file_sink.h iq_sink.h -) - -if(${INCLUDE_DEBUG_BLOCKS}) - list(APPEND HEADER_FILES ${DEBUG_HEADER_FILES}) -endif() - -install(FILES - ${HEADER_FILES} quad_demod_filter_ff.h decoder_8b10b.h ccsds_rs_decoder_mm.h @@ -77,5 +70,15 @@ install(FILES lrpt_decoder.h frame_acquisition.h shift_reg.h - golay24.h DESTINATION include/satnogs + golay24.h + ax25_decoder.h +) + +if(${INCLUDE_DEBUG_BLOCKS}) + list(APPEND HEADER_FILES ${DEBUG_HEADER_FILES}) +endif() + +install(FILES + ${HEADER_FILES} + DESTINATION include/satnogs ) \ No newline at end of file diff --git a/include/satnogs/ax25_decoder.h b/include/satnogs/ax25_decoder.h new file mode 100644 index 0000000..0735ef5 --- /dev/null +++ b/include/satnogs/ax25_decoder.h @@ -0,0 +1,165 @@ +/* -*- c++ -*- */ +/* + * gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module + * + * Copyright (C) 2019, Libre Space Foundation + * + * This program 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 of the License, or + * (at your option) any later version. + * + * This program 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 program. If not, see . + */ + +#ifndef INCLUDED_SATNOGS_AX25_DECODER_H +#define INCLUDED_SATNOGS_AX25_DECODER_H + +#include +#include +#include + +#include + +namespace gr +{ +namespace satnogs +{ + +/*! + * \brief AX.25 decoder that supports the legacy hardware radios. + * + * This block takes as input a quadrature demodulated bit stream. + * Each byte should contains only one bit of information at the LSB. + * + * The block will try to find an AX.25 frame. If the frame pass the + * CRC check then a blob PMT message is produced at the message output + * indicated with name 'out'. Otherwise if the frame did not pass the + * CRC check or the size was invalid, a blob PMT message is generated at + * the output port with the name 'fail'. This will help to recover at least + * some bytes from a corrupted message. + * + * The block also supports destination callsign check. Only frames with + * the right destination Callsign will be accepted. This feature can be + * disabled using the promisc parameter. + * + * \ingroup satnogs + * + */ +class SATNOGS_API ax25_decoder : public decoder +{ +public: + + /** + * The decoder take as input a quadrature demodulated bit stream. + * Each byte should contains only one bit of information at the LSB. + * + * The decoder will try to find an AX.25 frame. If the frame pass the + * CRC check then at the metadata the CRC_VALID option will be set to true, + * otherwise to false. CRC invalid frames are meaningful because only one + * bit of error can cause the entire frame to fail. This will help to recover + * at least some bytes from a corrupted message. + * + * The decoder also supports destination callsign check. Only frames with + * the right destination Callsign will be accepted. This feature can be + * disabled using the promisc parameter. + * @param addr the Callsign of the receiver + * @param ssid the SSID of the receiver + * @param promisc if set to yes, the Callsign check is disabled + * @param descramble if set to yes, the data will be descrambled prior + * decoding using the G3RUH self-synchronizing descrambler. + * @param max_frame_len the maximum allowed frame length + * + * @return a shared pointer of the decoder instance + */ + static decoder::decoder_sptr + make (const std::string &addr, uint8_t ssid, bool promisc = false, + bool descramble = true, bool crc_check = true, + size_t max_frame_len = 512); + + /** + * The decoder take as input a quadrature demodulated bit stream. + * Each byte should contains only one bit of information at the LSB. + * + * The decoder will try to find an AX.25 frame. If the frame pass the + * CRC check then at the metadata the CRC_VALID option will be set to true, + * otherwise to false. CRC invalid frames are meaningful because only one + * bit of error can cause the entire frame to fail. This will help to recover + * at least some bytes from a corrupted message. + * + * The decoder also supports destination callsign check. Only frames with + * the right destination Callsign will be accepted. This feature can be + * disabled using the promisc parameter. + * @param addr the Callsign of the receiver + * @param ssid the SSID of the receiver + * @param promisc if set to yes, the Callsign check is disabled + * @param descramble if set to yes, the data will be descrambled prior + * decoding using the G3RUH self-synchronizing descrambler. + * @param max_frame_len the maximum allowed frame length + */ + ax25_decoder (const std::string &addr, uint8_t ssid, bool promisc = false, + bool descramble = true, bool crc_check = true, + size_t max_frame_len = 512); + + ~ax25_decoder (); + + decoder_status_t + decode (const void *in, int len); + + void + reset (); +private: + + typedef enum + { + NO_SYNC, IN_SYNC, DECODING + } decoding_state_t; + + /** + * If this flag is set, the decoder operates in promiscuous mode and + * forwards all successfully decoded frames + */ + const bool d_promisc; + const bool d_descramble; + const bool d_crc_check; + const size_t d_max_frame_len; + decoding_state_t d_state; + uint8_t d_shift_reg; + uint8_t d_dec_b; + uint8_t d_prev_bit_nrzi; + size_t d_received_bytes; + size_t d_decoded_bits; + digital::lfsr d_lfsr; + uint8_t *d_frame_buffer; + std::deque d_bitstream; + size_t d_start_idx; + + void + reset_state (); + void + enter_sync_state (); + void + enter_decoding_state (); + bool + enter_frame_end (decoder_status_t& status); + + bool + _decode (decoder_status_t& status); + + inline void + decode_1b (uint8_t in); + bool + frame_check (); +}; + +} // namespace satnogs +} // namespace gr + +#endif /* INCLUDED_SATNOGS_AX25_DECODER_H */ + diff --git a/include/satnogs/decoder.h b/include/satnogs/decoder.h index a1e7c37..18110e2 100644 --- a/include/satnogs/decoder.h +++ b/include/satnogs/decoder.h @@ -39,14 +39,14 @@ class decoder_status public: bool packed; /**< Indicates if the output is packed bits or unpacked */ int consumed; /**< The number of input items consumed */ - ssize_t decoded_bits; /**< The number of the decoded bits. */ - pmt::pmt_t metadata; /**< Metadata for the decoded frame */ + bool decode_success; /**< Indicated if there was a successful decoding */ + pmt::pmt_t data; /**< a dictionary with the PDU with of decoded data and the corresponding metadata for the decoded frame */ decoder_status () : packed(false), consumed(0), - decoded_bits(-1), - metadata(pmt::PMT_NIL) + decode_success(false), + data(pmt::make_dict()) { } }; @@ -97,7 +97,7 @@ public: * If an error occurred an appropriate negative error code is returned */ virtual decoder_status_t - decode (uint8_t *out, const void *in, int len) = 0; + decode (const void *in, int len) = 0; /** diff --git a/include/satnogs/metadata.h b/include/satnogs/metadata.h new file mode 100644 index 0000000..a6343c8 --- /dev/null +++ b/include/satnogs/metadata.h @@ -0,0 +1,50 @@ +/* -*- c++ -*- */ +/* + * gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module + * + * Copyright (C) 2019, Libre Space Foundation + * + * This program 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 of the License, or + * (at your option) any later version. + * + * This program 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 program. If not, see . + */ + +#ifndef INCLUDE_SATNOGS_METADATA_H_ +#define INCLUDE_SATNOGS_METADATA_H_ + +#include + +namespace gr { + +namespace satnogs { + + +class metadata +{ +public: + typedef enum { + PDU, + CRC_VALID, + FREQ_OFFSET, + CORRECTED_BITS + } key_t; + + static std::string + value(const key_t& k); +}; + +} // namespace satnogs + +} // namespace gr + + +#endif /* INCLUDE_SATNOGS_METADATA_H_ */ diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt index ac617bc..bd928eb 100644 --- a/lib/CMakeLists.txt +++ b/lib/CMakeLists.txt @@ -41,6 +41,7 @@ list(APPEND satnogs_debug_sources cw_encoder_impl.cc ) list(APPEND satnogs_sources + metadata.cc morse_tree.cc morse_decoder_impl.cc multi_format_msg_sink_impl.cc @@ -76,7 +77,8 @@ list(APPEND satnogs_sources lrpt_decoder_impl.cc frame_acquisition_impl.cc shift_reg.cc - golay24.cc) + golay24.cc + ax25_decoder.cc) if(${INCLUDE_DEBUG_BLOCKS}) list(APPEND satnogs_sources ${satnogs_debug_sources}) @@ -128,6 +130,7 @@ list(APPEND test_satnogs_sources ${CMAKE_CURRENT_SOURCE_DIR}/qa_golay24.cc ${CMAKE_CURRENT_SOURCE_DIR}/test_satnogs.cc ${CMAKE_CURRENT_SOURCE_DIR}/qa_satnogs.cc + ${CMAKE_CURRENT_SOURCE_DIR}/qa_ax25_decoder.cc ) add_executable(test-satnogs ${test_satnogs_sources}) diff --git a/lib/ax25_decoder.cc b/lib/ax25_decoder.cc new file mode 100644 index 0000000..6d79e7a --- /dev/null +++ b/lib/ax25_decoder.cc @@ -0,0 +1,319 @@ +/* -*- c++ -*- */ +/* + * gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module + * + * Copyright (C) 2019, Libre Space Foundation + * + * This program 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 of the License, or + * (at your option) any later version. + * + * This program 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 program. If not, see . + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include +#include +#include +#include + +namespace gr +{ +namespace satnogs +{ + +decoder::decoder_sptr +ax25_decoder::make (const std::string &addr, uint8_t ssid, bool promisc, + bool descramble, bool crc_check, size_t max_frame_len) +{ + return decoder::decoder_sptr ( + new ax25_decoder (addr, ssid, promisc, descramble, crc_check, + max_frame_len)); +} + +ax25_decoder::ax25_decoder (const std::string &addr, uint8_t ssid, bool promisc, + bool descramble, bool crc_check, size_t max_frame_len) : + decoder (sizeof(uint8_t), 2 * max_frame_len * 8), + d_promisc (promisc), + d_descramble (descramble), + d_crc_check(crc_check), + d_max_frame_len (max_frame_len), + d_state (NO_SYNC), + d_shift_reg (0x0), + d_dec_b (0x0), + d_prev_bit_nrzi (0), + d_received_bytes (0), + d_decoded_bits (0), + d_lfsr (0x21, 0x0, 16), + d_frame_buffer ( + new uint8_t[max_frame_len + AX25_MAX_ADDR_LEN + AX25_MAX_CTRL_LEN + + sizeof(uint16_t)]), + d_start_idx (0) +{ +} + +decoder_status_t +ax25_decoder::decode (const void *in, int len) +{ + const uint8_t *input = (const uint8_t *) in; + decoder_status_t status; + if (d_descramble) { + for (int i = 0; i < len; i++) { + /* Perform NRZI decoding */ + uint8_t b = (~((input[i] - d_prev_bit_nrzi) % 2)) & 0x1; + d_prev_bit_nrzi = input[i]; + b = d_lfsr.next_bit_descramble (b); + d_bitstream.push_back (b); + } + } + else { + for (int i = 0; i < len; i++) { + /* Perform NRZI decoding */ + uint8_t b = (~((input[i] - d_prev_bit_nrzi) % 2)) & 0x1; + d_prev_bit_nrzi = input[i]; + d_bitstream.push_back (b); + } + } + /* + * The decoder always consumes all the available input bits and stores them + * internally + */ + _decode(status); + status.consumed = len; + return status; +} + +void +ax25_decoder::reset () +{ + reset_state(); +} + +bool +ax25_decoder::_decode (decoder_status_t& status) +{ + while (1) { + bool cont = false; + switch (d_state) + { + case NO_SYNC: + for (size_t i = 0; i < d_bitstream.size (); i++) { + decode_1b (d_bitstream[i]); + if (d_shift_reg == AX25_SYNC_FLAG) { + d_bitstream.erase (d_bitstream.begin (), + d_bitstream.begin () + i + 1); + enter_sync_state (); + d_start_idx = 0; + cont = true; + break; + } + } + if(cont) { + continue; + } + d_bitstream.clear (); + return false; + case IN_SYNC: + /* + * Most of the transmitters repeat several times the AX.25 SYNC + * In case of G3RUH this is mandatory to allow the self synchronizing + * scrambler to settle + */ + for (size_t i = d_start_idx; i < d_bitstream.size (); i++) { + decode_1b (d_bitstream[i]); + d_decoded_bits++; + if (d_decoded_bits == 8) { + /* Perhaps we are in frame! */ + if (d_shift_reg != AX25_SYNC_FLAG) { + d_start_idx = i + 1; + enter_decoding_state (); + cont = true; + break; + } + d_decoded_bits = 0; + } + } + if(cont) { + continue; + } + d_start_idx = d_bitstream.size (); + return false; + case DECODING: + for (size_t i = d_start_idx; i < d_bitstream.size (); i++) { + decode_1b (d_bitstream[i]); + if (d_shift_reg == AX25_SYNC_FLAG) { + LOG_DEBUG("Found frame end"); + if (enter_frame_end (status)) { + d_bitstream.erase (d_bitstream.begin (), + d_bitstream.begin () + i + 1); + d_start_idx = d_bitstream.size (); + return true; + } + cont = true; + break; + } + else if ((d_shift_reg & 0xfc) == 0x7c) { + /*This was a stuffed bit */ + d_dec_b <<= 1; + } + else if ((d_shift_reg & 0xfe) == 0xfe) { + LOG_DEBUG("Invalid shift register value %u", d_received_bytes); + reset_state (); + cont = true; + break; + } + else { + d_decoded_bits++; + if (d_decoded_bits == 8) { + d_frame_buffer[d_received_bytes++] = d_dec_b; + d_decoded_bits = 0; + + /*Check if the frame limit was reached */ + if (d_received_bytes >= d_max_frame_len) { + LOG_DEBUG("Wrong size"); + reset_state (); + cont = true; + break; + } + } + } + } + if(cont) { + continue; + } + d_start_idx = d_bitstream.size (); + return false; + default: + LOG_ERROR("Invalid decoding state"); + reset_state (); + return false; + } + } +} + + +ax25_decoder::~ax25_decoder () +{ + delete[] d_frame_buffer; +} + +void +ax25_decoder::reset_state () +{ + d_state = NO_SYNC; + d_dec_b = 0x0; + d_shift_reg = 0x0; + d_decoded_bits = 0; + d_received_bytes = 0; +} + +void +ax25_decoder::enter_sync_state () +{ + d_state = IN_SYNC; + d_dec_b = 0x0; + d_shift_reg = 0x0; + d_decoded_bits = 0; + d_received_bytes = 0; +} + +void +ax25_decoder::enter_decoding_state () +{ + uint8_t tmp; + d_state = DECODING; + d_decoded_bits = 0; + d_received_bytes = 0; + + /* + * Due to the possibility of bit stuffing on the first byte some special + * handling is necessary + */ + if ((d_shift_reg & 0xfc) == 0x7c) { + /*This was a stuffed bit */ + d_dec_b <<= 1; + d_decoded_bits = 7; + } + else { + d_frame_buffer[0] = d_dec_b; + d_decoded_bits = 0; + d_received_bytes = 1; + } +} + +bool +ax25_decoder::enter_frame_end (decoder_status_t& status) +{ + uint16_t fcs; + uint16_t recv_fcs = 0x0; + + /* First check if the size of the frame is valid */ + if (d_received_bytes < AX25_MIN_ADDR_LEN + sizeof(uint16_t)) { + reset_state (); + return false; + } + + /* + * Check if the frame is correct using the FCS field + * Using this field also try to correct up to 2 error bits + */ + if (frame_check ()) { + pmt::dict_add(status.data, + pmt::mp(metadata::value(metadata::PDU)), + pmt::make_blob (d_frame_buffer, d_received_bytes - sizeof(uint16_t))); + status.decode_success = true; + reset_state (); + return true; + } + else if(!d_crc_check){ + pmt::dict_add(status.data, + pmt::mp(metadata::value(metadata::PDU)), + pmt::make_blob (d_frame_buffer, d_received_bytes - sizeof(uint16_t))); + status.decode_success = true; + LOG_DEBUG("Wrong crc"); + reset_state (); + return false; + } + return false; +} + + +inline void +ax25_decoder::decode_1b (uint8_t in) +{ + + /* In AX.25 the LS bit is sent first */ + d_shift_reg = (d_shift_reg >> 1) | (in << 7); + d_dec_b = (d_dec_b >> 1) | (in << 7); +} + +bool +ax25_decoder::frame_check () +{ + uint16_t fcs; + uint16_t recv_fcs = 0x0; + uint8_t orig_byte; + + /* Check if the frame is correct using the FCS field */ + fcs = ax25_fcs (d_frame_buffer, d_received_bytes - sizeof(uint16_t)); + recv_fcs = (((uint16_t) d_frame_buffer[d_received_bytes - 1]) << 8) + | d_frame_buffer[d_received_bytes - 2]; + if (fcs == recv_fcs) { + return true; + } + return false; +} + +} /* namespace satnogs */ +} /* namespace gr */ + diff --git a/lib/frame_decoder_impl.cc b/lib/frame_decoder_impl.cc index 848315d..c9e31c2 100644 --- a/lib/frame_decoder_impl.cc +++ b/lib/frame_decoder_impl.cc @@ -49,14 +49,12 @@ frame_decoder_impl::frame_decoder_impl (decoder::decoder_sptr decoder_object, { if (input_size != decoder_object->sizeof_input_item ()) { throw std::invalid_argument ( - "Size mismatch between the block input and the decoder"); + "frame_decoder: Size mismatch between the block input and the decoder"); } message_port_register_in (pmt::mp ("reset")); message_port_register_out (pmt::mp ("out")); - d_frame = new uint8_t[decoder_object->max_frame_len () * 8]; - set_msg_handler (pmt::mp ("reset"), boost::bind (&frame_decoder_impl::reset, this, _1)); } @@ -80,21 +78,10 @@ frame_decoder_impl::work (int noutput_items, gr_vector_void_star &output_items) { const void *in = input_items[0]; - pmt::pmt_t res = pmt::make_dict(); - decoder_status_t status = d_decoder->decode (d_frame, in, noutput_items); - if (status.decoded_bits > 0) { - if (status.packed) { - res = pmt::dict_add(res, pmt::mp("pdu"), - pmt::make_blob (d_frame, (size_t)status.decoded_bits / 8)); - } - else { - res = pmt::dict_add ( - res, pmt::mp ("pdu"), - pmt::make_blob (d_frame, (size_t) status.decoded_bits)); - } - res = pmt::dict_add (res, pmt::mp ("metadata"), status.metadata); - message_port_pub (pmt::mp ("out"), res); + decoder_status_t status = d_decoder->decode (in, noutput_items); + if (status.decode_success) { + message_port_pub (pmt::mp ("out"), status.data); } // Tell runtime system how many output items we produced. diff --git a/lib/frame_decoder_impl.h b/lib/frame_decoder_impl.h index fe04937..1451365 100644 --- a/lib/frame_decoder_impl.h +++ b/lib/frame_decoder_impl.h @@ -43,7 +43,6 @@ public: private: decoder::decoder_sptr d_decoder; - uint8_t *d_frame; void reset(pmt::pmt_t m); diff --git a/lib/metadata.cc b/lib/metadata.cc new file mode 100644 index 0000000..a747b80 --- /dev/null +++ b/lib/metadata.cc @@ -0,0 +1,46 @@ +/* -*- c++ -*- */ +/* + * gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module + * + * Copyright (C) 2019, Libre Space Foundation + * + * This program 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 of the License, or + * (at your option) any later version. + * + * This program 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 program. If not, see . + */ + +#include +#include +namespace gr { + +namespace satnogs { + +std::string +metadata::value(const key_t& k) +{ + switch(k) { + case PDU: + return "PDU"; + case CRC_VALID: + return "CRC_VALID"; + case FREQ_OFFSET: + return "FREQ_OFFSET"; + case CORRECTED_BITS: + return "CORRECTED_BITS"; + default: + throw std::invalid_argument("metadata: invalid key"); + } +} + +} // namespace satnogs + +} // namespace gr diff --git a/lib/qa_ax25_decoder.cc b/lib/qa_ax25_decoder.cc new file mode 100644 index 0000000..5036d3b --- /dev/null +++ b/lib/qa_ax25_decoder.cc @@ -0,0 +1,695 @@ +/* -*- c++ -*- */ +/* GNU GENERAL PUBLIC LICENSE + * Version 3, 29 June 2007 + * + * Copyright (C) 2007 Free Software Foundation, Inc. + * Everyone is permitted to copy and distribute verbatim copies + * of this license document, but changing it is not allowed. + * + * Preamble + * + * The GNU General Public License is a free, copyleft license for + * software and other kinds of works. + * + * The licenses for most software and other practical works are designed + * to take away your freedom to share and change the works. By contrast, + * the GNU General Public License is intended to guarantee your freedom to + * share and change all versions of a program--to make sure it remains free + * software for all its users. We, the Free Software Foundation, use the + * GNU General Public License for most of our software; it applies also to + * any other work released this way by its authors. You can apply it to + * your programs, too. + * + * When we speak of free software, we are referring to freedom, not + * price. Our General Public Licenses are designed to make sure that you + * have the freedom to distribute copies of free software (and charge for + * them if you wish), that you receive source code or can get it if you + * want it, that you can change the software or use pieces of it in new + * free programs, and that you know you can do these things. + * + * To protect your rights, we need to prevent others from denying you + * these rights or asking you to surrender the rights. Therefore, you have + * certain responsibilities if you distribute copies of the software, or if + * you modify it: responsibilities to respect the freedom of others. + * + * For example, if you distribute copies of such a program, whether + * gratis or for a fee, you must pass on to the recipients the same + * freedoms that you received. You must make sure that they, too, receive + * or can get the source code. And you must show them these terms so they + * know their rights. + * + * Developers that use the GNU GPL protect your rights with two steps: + * (1) assert copyright on the software, and (2) offer you this License + * giving you legal permission to copy, distribute and/or modify it. + * + * For the developers' and authors' protection, the GPL clearly explains + * that there is no warranty for this free software. For both users' and + * authors' sake, the GPL requires that modified versions be marked as + * changed, so that their problems will not be attributed erroneously to + * authors of previous versions. + * + * Some devices are designed to deny users access to install or run + * modified versions of the software inside them, although the manufacturer + * can do so. This is fundamentally incompatible with the aim of + * protecting users' freedom to change the software. The systematic + * pattern of such abuse occurs in the area of products for individuals to + * use, which is precisely where it is most unacceptable. Therefore, we + * have designed this version of the GPL to prohibit the practice for those + * products. If such problems arise substantially in other domains, we + * stand ready to extend this provision to those domains in future versions + * of the GPL, as needed to protect the freedom of users. + * + * Finally, every program is threatened constantly by software patents. + * States should not allow patents to restrict development and use of + * software on general-purpose computers, but in those that do, we wish to + * avoid the special danger that patents applied to a free program could + * make it effectively proprietary. To prevent this, the GPL assures that + * patents cannot be used to render the program non-free. + * + * The precise terms and conditions for copying, distribution and + * modification follow. + * + * TERMS AND CONDITIONS + * + * 0. Definitions. + * + * "This License" refers to version 3 of the GNU General Public License. + * + * "Copyright" also means copyright-like laws that apply to other kinds of + * works, such as semiconductor masks. + * + * "The Program" refers to any copyrightable work licensed under this + * License. Each licensee is addressed as "you". "Licensees" and + * "recipients" may be individuals or organizations. + * + * To "modify" a work means to copy from or adapt all or part of the work + * in a fashion requiring copyright permission, other than the making of an + * exact copy. The resulting work is called a "modified version" of the + * earlier work or a work "based on" the earlier work. + * + * A "covered work" means either the unmodified Program or a work based + * on the Program. + * + * To "propagate" a work means to do anything with it that, without + * permission, would make you directly or secondarily liable for + * infringement under applicable copyright law, except executing it on a + * computer or modifying a private copy. Propagation includes copying, + * distribution (with or without modification), making available to the + * public, and in some countries other activities as well. + * + * To "convey" a work means any kind of propagation that enables other + * parties to make or receive copies. Mere interaction with a user through + * a computer network, with no transfer of a copy, is not conveying. + * + * An interactive user interface displays "Appropriate Legal Notices" + * to the extent that it includes a convenient and prominently visible + * feature that (1) displays an appropriate copyright notice, and (2) + * tells the user that there is no warranty for the work (except to the + * extent that warranties are provided), that licensees may convey the + * work under this License, and how to view a copy of this License. If + * the interface presents a list of user commands or options, such as a + * menu, a prominent item in the list meets this criterion. + * + * 1. Source Code. + * + * The "source code" for a work means the preferred form of the work + * for making modifications to it. "Object code" means any non-source + * form of a work. + * + * A "Standard Interface" means an interface that either is an official + * standard defined by a recognized standards body, or, in the case of + * interfaces specified for a particular programming language, one that + * is widely used among developers working in that language. + * + * The "System Libraries" of an executable work include anything, other + * than the work as a whole, that (a) is included in the normal form of + * packaging a Major Component, but which is not part of that Major + * Component, and (b) serves only to enable use of the work with that + * Major Component, or to implement a Standard Interface for which an + * implementation is available to the public in source code form. A + * "Major Component", in this context, means a major essential component + * (kernel, window system, and so on) of the specific operating system + * (if any) on which the executable work runs, or a compiler used to + * produce the work, or an object code interpreter used to run it. + * + * The "Corresponding Source" for a work in object code form means all + * the source code needed to generate, install, and (for an executable + * work) run the object code and to modify the work, including scripts to + * control those activities. However, it does not include the work's + * System Libraries, or general-purpose tools or generally available free + * programs which are used unmodified in performing those activities but + * which are not part of the work. For example, Corresponding Source + * includes interface definition files associated with source files for + * the work, and the source code for shared libraries and dynamically + * linked subprograms that the work is specifically designed to require, + * such as by intimate data communication or control flow between those + * subprograms and other parts of the work. + * + * The Corresponding Source need not include anything that users + * can regenerate automatically from other parts of the Corresponding + * Source. + * + * The Corresponding Source for a work in source code form is that + * same work. + * + * 2. Basic Permissions. + * + * All rights granted under this License are granted for the term of + * copyright on the Program, and are irrevocable provided the stated + * conditions are met. This License explicitly affirms your unlimited + * permission to run the unmodified Program. The output from running a + * covered work is covered by this License only if the output, given its + * content, constitutes a covered work. This License acknowledges your + * rights of fair use or other equivalent, as provided by copyright law. + * + * You may make, run and propagate covered works that you do not + * convey, without conditions so long as your license otherwise remains + * in force. You may convey covered works to others for the sole purpose + * of having them make modifications exclusively for you, or provide you + * with facilities for running those works, provided that you comply with + * the terms of this License in conveying all material for which you do + * not control copyright. Those thus making or running the covered works + * for you must do so exclusively on your behalf, under your direction + * and control, on terms that prohibit them from making any copies of + * your copyrighted material outside their relationship with you. + * + * Conveying under any other circumstances is permitted solely under + * the conditions stated below. Sublicensing is not allowed; section 10 + * makes it unnecessary. + * + * 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + * + * No covered work shall be deemed part of an effective technological + * measure under any applicable law fulfilling obligations under article + * 11 of the WIPO copyright treaty adopted on 20 December 1996, or + * similar laws prohibiting or restricting circumvention of such + * measures. + * + * When you convey a covered work, you waive any legal power to forbid + * circumvention of technological measures to the extent such circumvention + * is effected by exercising rights under this License with respect to + * the covered work, and you disclaim any intention to limit operation or + * modification of the work as a means of enforcing, against the work's + * users, your or third parties' legal rights to forbid circumvention of + * technological measures. + * + * 4. Conveying Verbatim Copies. + * + * You may convey verbatim copies of the Program's source code as you + * receive it, in any medium, provided that you conspicuously and + * appropriately publish on each copy an appropriate copyright notice; + * keep intact all notices stating that this License and any + * non-permissive terms added in accord with section 7 apply to the code; + * keep intact all notices of the absence of any warranty; and give all + * recipients a copy of this License along with the Program. + * + * You may charge any price or no price for each copy that you convey, + * and you may offer support or warranty protection for a fee. + * + * 5. Conveying Modified Source Versions. + * + * You may convey a work based on the Program, or the modifications to + * produce it from the Program, in the form of source code under the + * terms of section 4, provided that you also meet all of these conditions: + * + * a) The work must carry prominent notices stating that you modified + * it, and giving a relevant date. + * + * b) The work must carry prominent notices stating that it is + * released under this License and any conditions added under section + * 7. This requirement modifies the requirement in section 4 to + * "keep intact all notices". + * + * c) You must license the entire work, as a whole, under this + * License to anyone who comes into possession of a copy. This + * License will therefore apply, along with any applicable section 7 + * additional terms, to the whole of the work, and all its parts, + * regardless of how they are packaged. This License gives no + * permission to license the work in any other way, but it does not + * invalidate such permission if you have separately received it. + * + * d) If the work has interactive user interfaces, each must display + * Appropriate Legal Notices; however, if the Program has interactive + * interfaces that do not display Appropriate Legal Notices, your + * work need not make them do so. + * + * A compilation of a covered work with other separate and independent + * works, which are not by their nature extensions of the covered work, + * and which are not combined with it such as to form a larger program, + * in or on a volume of a storage or distribution medium, is called an + * "aggregate" if the compilation and its resulting copyright are not + * used to limit the access or legal rights of the compilation's users + * beyond what the individual works permit. Inclusion of a covered work + * in an aggregate does not cause this License to apply to the other + * parts of the aggregate. + * + * 6. Conveying Non-Source Forms. + * + * You may convey a covered work in object code form under the terms + * of sections 4 and 5, provided that you also convey the + * machine-readable Corresponding Source under the terms of this License, + * in one of these ways: + * + * a) Convey the object code in, or embodied in, a physical product + * (including a physical distribution medium), accompanied by the + * Corresponding Source fixed on a durable physical medium + * customarily used for software interchange. + * + * b) Convey the object code in, or embodied in, a physical product + * (including a physical distribution medium), accompanied by a + * written offer, valid for at least three years and valid for as + * long as you offer spare parts or customer support for that product + * model, to give anyone who possesses the object code either (1) a + * copy of the Corresponding Source for all the software in the + * product that is covered by this License, on a durable physical + * medium customarily used for software interchange, for a price no + * more than your reasonable cost of physically performing this + * conveying of source, or (2) access to copy the + * Corresponding Source from a network server at no charge. + * + * c) Convey individual copies of the object code with a copy of the + * written offer to provide the Corresponding Source. This + * alternative is allowed only occasionally and noncommercially, and + * only if you received the object code with such an offer, in accord + * with subsection 6b. + * + * d) Convey the object code by offering access from a designated + * place (gratis or for a charge), and offer equivalent access to the + * Corresponding Source in the same way through the same place at no + * further charge. You need not require recipients to copy the + * Corresponding Source along with the object code. If the place to + * copy the object code is a network server, the Corresponding Source + * may be on a different server (operated by you or a third party) + * that supports equivalent copying facilities, provided you maintain + * clear directions next to the object code saying where to find the + * Corresponding Source. Regardless of what server hosts the + * Corresponding Source, you remain obligated to ensure that it is + * available for as long as needed to satisfy these requirements. + * + * e) Convey the object code using peer-to-peer transmission, provided + * you inform other peers where the object code and Corresponding + * Source of the work are being offered to the general public at no + * charge under subsection 6d. + * + * A separable portion of the object code, whose source code is excluded + * from the Corresponding Source as a System Library, need not be + * included in conveying the object code work. + * + * A "User Product" is either (1) a "consumer product", which means any + * tangible personal property which is normally used for personal, family, + * or household purposes, or (2) anything designed or sold for incorporation + * into a dwelling. In determining whether a product is a consumer product, + * doubtful cases shall be resolved in favor of coverage. For a particular + * product received by a particular user, "normally used" refers to a + * typical or common use of that class of product, regardless of the status + * of the particular user or of the way in which the particular user + * actually uses, or expects or is expected to use, the product. A product + * is a consumer product regardless of whether the product has substantial + * commercial, industrial or non-consumer uses, unless such uses represent + * the only significant mode of use of the product. + * + * "Installation Information" for a User Product means any methods, + * procedures, authorization keys, or other information required to install + * and execute modified versions of a covered work in that User Product from + * a modified version of its Corresponding Source. The information must + * suffice to ensure that the continued functioning of the modified object + * code is in no case prevented or interfered with solely because + * modification has been made. + * + * If you convey an object code work under this section in, or with, or + * specifically for use in, a User Product, and the conveying occurs as + * part of a transaction in which the right of possession and use of the + * User Product is transferred to the recipient in perpetuity or for a + * fixed term (regardless of how the transaction is characterized), the + * Corresponding Source conveyed under this section must be accompanied + * by the Installation Information. But this requirement does not apply + * if neither you nor any third party retains the ability to install + * modified object code on the User Product (for example, the work has + * been installed in ROM). + * + * The requirement to provide Installation Information does not include a + * requirement to continue to provide support service, warranty, or updates + * for a work that has been modified or installed by the recipient, or for + * the User Product in which it has been modified or installed. Access to a + * network may be denied when the modification itself materially and + * adversely affects the operation of the network or violates the rules and + * protocols for communication across the network. + * + * Corresponding Source conveyed, and Installation Information provided, + * in accord with this section must be in a format that is publicly + * documented (and with an implementation available to the public in + * source code form), and must require no special password or key for + * unpacking, reading or copying. + * + * 7. Additional Terms. + * + * "Additional permissions" are terms that supplement the terms of this + * License by making exceptions from one or more of its conditions. + * Additional permissions that are applicable to the entire Program shall + * be treated as though they were included in this License, to the extent + * that they are valid under applicable law. If additional permissions + * apply only to part of the Program, that part may be used separately + * under those permissions, but the entire Program remains governed by + * this License without regard to the additional permissions. + * + * When you convey a copy of a covered work, you may at your option + * remove any additional permissions from that copy, or from any part of + * it. (Additional permissions may be written to require their own + * removal in certain cases when you modify the work.) You may place + * additional permissions on material, added by you to a covered work, + * for which you have or can give appropriate copyright permission. + * + * Notwithstanding any other provision of this License, for material you + * add to a covered work, you may (if authorized by the copyright holders of + * that material) supplement the terms of this License with terms: + * + * a) Disclaiming warranty or limiting liability differently from the + * terms of sections 15 and 16 of this License; or + * + * b) Requiring preservation of specified reasonable legal notices or + * author attributions in that material or in the Appropriate Legal + * Notices displayed by works containing it; or + * + * c) Prohibiting misrepresentation of the origin of that material, or + * requiring that modified versions of such material be marked in + * reasonable ways as different from the original version; or + * + * d) Limiting the use for publicity purposes of names of licensors or + * authors of the material; or + * + * e) Declining to grant rights under trademark law for use of some + * trade names, trademarks, or service marks; or + * + * f) Requiring indemnification of licensors and authors of that + * material by anyone who conveys the material (or modified versions of + * it) with contractual assumptions of liability to the recipient, for + * any liability that these contractual assumptions directly impose on + * those licensors and authors. + * + * All other non-permissive additional terms are considered "further + * restrictions" within the meaning of section 10. If the Program as you + * received it, or any part of it, contains a notice stating that it is + * governed by this License along with a term that is a further + * restriction, you may remove that term. If a license document contains + * a further restriction but permits relicensing or conveying under this + * License, you may add to a covered work material governed by the terms + * of that license document, provided that the further restriction does + * not survive such relicensing or conveying. + * + * If you add terms to a covered work in accord with this section, you + * must place, in the relevant source files, a statement of the + * additional terms that apply to those files, or a notice indicating + * where to find the applicable terms. + * + * Additional terms, permissive or non-permissive, may be stated in the + * form of a separately written license, or stated as exceptions; + * the above requirements apply either way. + * + * 8. Termination. + * + * You may not propagate or modify a covered work except as expressly + * provided under this License. Any attempt otherwise to propagate or + * modify it is void, and will automatically terminate your rights under + * this License (including any patent licenses granted under the third + * paragraph of section 11). + * + * However, if you cease all violation of this License, then your + * license from a particular copyright holder is reinstated (a) + * provisionally, unless and until the copyright holder explicitly and + * finally terminates your license, and (b) permanently, if the copyright + * holder fails to notify you of the violation by some reasonable means + * prior to 60 days after the cessation. + * + * Moreover, your license from a particular copyright holder is + * reinstated permanently if the copyright holder notifies you of the + * violation by some reasonable means, this is the first time you have + * received notice of violation of this License (for any work) from that + * copyright holder, and you cure the violation prior to 30 days after + * your receipt of the notice. + * + * Termination of your rights under this section does not terminate the + * licenses of parties who have received copies or rights from you under + * this License. If your rights have been terminated and not permanently + * reinstated, you do not qualify to receive new licenses for the same + * material under section 10. + * + * 9. Acceptance Not Required for Having Copies. + * + * You are not required to accept this License in order to receive or + * run a copy of the Program. Ancillary propagation of a covered work + * occurring solely as a consequence of using peer-to-peer transmission + * to receive a copy likewise does not require acceptance. However, + * nothing other than this License grants you permission to propagate or + * modify any covered work. These actions infringe copyright if you do + * not accept this License. Therefore, by modifying or propagating a + * covered work, you indicate your acceptance of this License to do so. + * + * 10. Automatic Licensing of Downstream Recipients. + * + * Each time you convey a covered work, the recipient automatically + * receives a license from the original licensors, to run, modify and + * propagate that work, subject to this License. You are not responsible + * for enforcing compliance by third parties with this License. + * + * An "entity transaction" is a transaction transferring control of an + * organization, or substantially all assets of one, or subdividing an + * organization, or merging organizations. If propagation of a covered + * work results from an entity transaction, each party to that + * transaction who receives a copy of the work also receives whatever + * licenses to the work the party's predecessor in interest had or could + * give under the previous paragraph, plus a right to possession of the + * Corresponding Source of the work from the predecessor in interest, if + * the predecessor has it or can get it with reasonable efforts. + * + * You may not impose any further restrictions on the exercise of the + * rights granted or affirmed under this License. For example, you may + * not impose a license fee, royalty, or other charge for exercise of + * rights granted under this License, and you may not initiate litigation + * (including a cross-claim or counterclaim in a lawsuit) alleging that + * any patent claim is infringed by making, using, selling, offering for + * sale, or importing the Program or any portion of it. + * + * 11. Patents. + * + * A "contributor" is a copyright holder who authorizes use under this + * License of the Program or a work on which the Program is based. The + * work thus licensed is called the contributor's "contributor version". + * + * A contributor's "essential patent claims" are all patent claims + * owned or controlled by the contributor, whether already acquired or + * hereafter acquired, that would be infringed by some manner, permitted + * by this License, of making, using, or selling its contributor version, + * but do not include claims that would be infringed only as a + * consequence of further modification of the contributor version. For + * purposes of this definition, "control" includes the right to grant + * patent sublicenses in a manner consistent with the requirements of + * this License. + * + * Each contributor grants you a non-exclusive, worldwide, royalty-free + * patent license under the contributor's essential patent claims, to + * make, use, sell, offer for sale, import and otherwise run, modify and + * propagate the contents of its contributor version. + * + * In the following three paragraphs, a "patent license" is any express + * agreement or commitment, however denominated, not to enforce a patent + * (such as an express permission to practice a patent or covenant not to + * sue for patent infringement). To "grant" such a patent license to a + * party means to make such an agreement or commitment not to enforce a + * patent against the party. + * + * If you convey a covered work, knowingly relying on a patent license, + * and the Corresponding Source of the work is not available for anyone + * to copy, free of charge and under the terms of this License, through a + * publicly available network server or other readily accessible means, + * then you must either (1) cause the Corresponding Source to be so + * available, or (2) arrange to deprive yourself of the benefit of the + * patent license for this particular work, or (3) arrange, in a manner + * consistent with the requirements of this License, to extend the patent + * license to downstream recipients. "Knowingly relying" means you have + * actual knowledge that, but for the patent license, your conveying the + * covered work in a country, or your recipient's use of the covered work + * in a country, would infringe one or more identifiable patents in that + * country that you have reason to believe are valid. + * + * If, pursuant to or in connection with a single transaction or + * arrangement, you convey, or propagate by procuring conveyance of, a + * covered work, and grant a patent license to some of the parties + * receiving the covered work authorizing them to use, propagate, modify + * or convey a specific copy of the covered work, then the patent license + * you grant is automatically extended to all recipients of the covered + * work and works based on it. + * + * A patent license is "discriminatory" if it does not include within + * the scope of its coverage, prohibits the exercise of, or is + * conditioned on the non-exercise of one or more of the rights that are + * specifically granted under this License. You may not convey a covered + * work if you are a party to an arrangement with a third party that is + * in the business of distributing software, under which you make payment + * to the third party based on the extent of your activity of conveying + * the work, and under which the third party grants, to any of the + * parties who would receive the covered work from you, a discriminatory + * patent license (a) in connection with copies of the covered work + * conveyed by you (or copies made from those copies), or (b) primarily + * for and in connection with specific products or compilations that + * contain the covered work, unless you entered into that arrangement, + * or that patent license was granted, prior to 28 March 2007. + * + * Nothing in this License shall be construed as excluding or limiting + * any implied license or other defenses to infringement that may + * otherwise be available to you under applicable patent law. + * + * 12. No Surrender of Others' Freedom. + * + * If conditions are imposed on you (whether by court order, agreement or + * otherwise) that contradict the conditions of this License, they do not + * excuse you from the conditions of this License. If you cannot convey a + * covered work so as to satisfy simultaneously your obligations under this + * License and any other pertinent obligations, then as a consequence you may + * not convey it at all. For example, if you agree to terms that obligate you + * to collect a royalty for further conveying from those to whom you convey + * the Program, the only way you could satisfy both those terms and this + * License would be to refrain entirely from conveying the Program. + * + * 13. Use with the GNU Affero General Public License. + * + * Notwithstanding any other provision of this License, you have + * permission to link or combine any covered work with a work licensed + * under version 3 of the GNU Affero General Public License into a single + * combined work, and to convey the resulting work. The terms of this + * License will continue to apply to the part which is the covered work, + * but the special requirements of the GNU Affero General Public License, + * section 13, concerning interaction through a network will apply to the + * combination as such. + * + * 14. Revised Versions of this License. + * + * The Free Software Foundation may publish revised and/or new versions of + * the GNU General Public License from time to time. Such new versions will + * be similar in spirit to the present version, but may differ in detail to + * address new problems or concerns. + * + * Each version is given a distinguishing version number. If the + * Program specifies that a certain numbered version of the GNU General + * Public License "or any later version" applies to it, you have the + * option of following the terms and conditions either of that numbered + * version or of any later version published by the Free Software + * Foundation. If the Program does not specify a version number of the + * GNU General Public License, you may choose any version ever published + * by the Free Software Foundation. + * + * If the Program specifies that a proxy can decide which future + * versions of the GNU General Public License can be used, that proxy's + * public statement of acceptance of a version permanently authorizes you + * to choose that version for the Program. + * + * Later license versions may give you additional or different + * permissions. However, no additional obligations are imposed on any + * author or copyright holder as a result of your choosing to follow a + * later version. + * + * 15. Disclaimer of Warranty. + * + * THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY + * APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT + * HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY + * OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, + * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM + * IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF + * ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + * + * 16. Limitation of Liability. + * + * IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING + * WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS + * THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY + * GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE + * USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF + * DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD + * PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), + * EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGES. + * + * 17. Interpretation of Sections 15 and 16. + * + * If the disclaimer of warranty and limitation of liability provided + * above cannot be given local legal effect according to their terms, + * reviewing courts shall apply local law that most closely approximates + * an absolute waiver of all civil liability in connection with the + * Program, unless a warranty or assumption of liability accompanies a + * copy of the Program in return for a fee. + * + * END OF TERMS AND CONDITIONS + * + * How to Apply These Terms to Your New Programs + * + * If you develop a new program, and you want it to be of the greatest + * possible use to the public, the best way to achieve this is to make it + * free software which everyone can redistribute and change under these terms. + * + * To do so, attach the following notices to the program. It is safest + * to attach them to the start of each source file to most effectively + * state the exclusion of warranty; and each file should have at least + * the "copyright" line and a pointer to where the full notice is found. + * + * {one line to give the program's name and a brief idea of what it does.} + * Copyright (C) {year} {name of author} + * + * This program 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 of the License, or + * (at your option) any later version. + * + * This program 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 program. If not, see . + * + * Also add information on how to contact you by electronic and paper mail. + * + * If the program does terminal interaction, make it output a short + * notice like this when it starts in an interactive mode: + * + * {project} Copyright (C) {year} {fullname} + * This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + * This is free software, and you are welcome to redistribute it + * under certain conditions; type `show c' for details. + * + * The hypothetical commands `show w' and `show c' should show the appropriate + * parts of the General Public License. Of course, your program's commands + * might be different; for a GUI interface, you would use an "about box". + * + * You should also get your employer (if you work as a programmer) or school, + * if any, to sign a "copyright disclaimer" for the program, if necessary. + * For more information on this, and how to apply and follow the GNU GPL, see + * . + * + * The GNU General Public License does not permit incorporating your program + * into proprietary programs. If your program is a subroutine library, you + * may consider it more useful to permit linking proprietary applications with + * the library. If this is what you want to do, use the GNU Lesser General + * Public License instead of this License. But first, please read + * . + */ + + +#include +#include +#include "qa_ax25_decoder.h" +#include + +namespace gr { + namespace satnogs { + + void + qa_ax25_decoder::t1() + { + // Put test here + } + + } /* namespace satnogs */ +} /* namespace gr */ + diff --git a/lib/qa_ax25_decoder.h b/lib/qa_ax25_decoder.h new file mode 100644 index 0000000..7b7abc6 --- /dev/null +++ b/lib/qa_ax25_decoder.h @@ -0,0 +1,703 @@ +/* -*- c++ -*- */ +/* GNU GENERAL PUBLIC LICENSE + * Version 3, 29 June 2007 + * + * Copyright (C) 2007 Free Software Foundation, Inc. + * Everyone is permitted to copy and distribute verbatim copies + * of this license document, but changing it is not allowed. + * + * Preamble + * + * The GNU General Public License is a free, copyleft license for + * software and other kinds of works. + * + * The licenses for most software and other practical works are designed + * to take away your freedom to share and change the works. By contrast, + * the GNU General Public License is intended to guarantee your freedom to + * share and change all versions of a program--to make sure it remains free + * software for all its users. We, the Free Software Foundation, use the + * GNU General Public License for most of our software; it applies also to + * any other work released this way by its authors. You can apply it to + * your programs, too. + * + * When we speak of free software, we are referring to freedom, not + * price. Our General Public Licenses are designed to make sure that you + * have the freedom to distribute copies of free software (and charge for + * them if you wish), that you receive source code or can get it if you + * want it, that you can change the software or use pieces of it in new + * free programs, and that you know you can do these things. + * + * To protect your rights, we need to prevent others from denying you + * these rights or asking you to surrender the rights. Therefore, you have + * certain responsibilities if you distribute copies of the software, or if + * you modify it: responsibilities to respect the freedom of others. + * + * For example, if you distribute copies of such a program, whether + * gratis or for a fee, you must pass on to the recipients the same + * freedoms that you received. You must make sure that they, too, receive + * or can get the source code. And you must show them these terms so they + * know their rights. + * + * Developers that use the GNU GPL protect your rights with two steps: + * (1) assert copyright on the software, and (2) offer you this License + * giving you legal permission to copy, distribute and/or modify it. + * + * For the developers' and authors' protection, the GPL clearly explains + * that there is no warranty for this free software. For both users' and + * authors' sake, the GPL requires that modified versions be marked as + * changed, so that their problems will not be attributed erroneously to + * authors of previous versions. + * + * Some devices are designed to deny users access to install or run + * modified versions of the software inside them, although the manufacturer + * can do so. This is fundamentally incompatible with the aim of + * protecting users' freedom to change the software. The systematic + * pattern of such abuse occurs in the area of products for individuals to + * use, which is precisely where it is most unacceptable. Therefore, we + * have designed this version of the GPL to prohibit the practice for those + * products. If such problems arise substantially in other domains, we + * stand ready to extend this provision to those domains in future versions + * of the GPL, as needed to protect the freedom of users. + * + * Finally, every program is threatened constantly by software patents. + * States should not allow patents to restrict development and use of + * software on general-purpose computers, but in those that do, we wish to + * avoid the special danger that patents applied to a free program could + * make it effectively proprietary. To prevent this, the GPL assures that + * patents cannot be used to render the program non-free. + * + * The precise terms and conditions for copying, distribution and + * modification follow. + * + * TERMS AND CONDITIONS + * + * 0. Definitions. + * + * "This License" refers to version 3 of the GNU General Public License. + * + * "Copyright" also means copyright-like laws that apply to other kinds of + * works, such as semiconductor masks. + * + * "The Program" refers to any copyrightable work licensed under this + * License. Each licensee is addressed as "you". "Licensees" and + * "recipients" may be individuals or organizations. + * + * To "modify" a work means to copy from or adapt all or part of the work + * in a fashion requiring copyright permission, other than the making of an + * exact copy. The resulting work is called a "modified version" of the + * earlier work or a work "based on" the earlier work. + * + * A "covered work" means either the unmodified Program or a work based + * on the Program. + * + * To "propagate" a work means to do anything with it that, without + * permission, would make you directly or secondarily liable for + * infringement under applicable copyright law, except executing it on a + * computer or modifying a private copy. Propagation includes copying, + * distribution (with or without modification), making available to the + * public, and in some countries other activities as well. + * + * To "convey" a work means any kind of propagation that enables other + * parties to make or receive copies. Mere interaction with a user through + * a computer network, with no transfer of a copy, is not conveying. + * + * An interactive user interface displays "Appropriate Legal Notices" + * to the extent that it includes a convenient and prominently visible + * feature that (1) displays an appropriate copyright notice, and (2) + * tells the user that there is no warranty for the work (except to the + * extent that warranties are provided), that licensees may convey the + * work under this License, and how to view a copy of this License. If + * the interface presents a list of user commands or options, such as a + * menu, a prominent item in the list meets this criterion. + * + * 1. Source Code. + * + * The "source code" for a work means the preferred form of the work + * for making modifications to it. "Object code" means any non-source + * form of a work. + * + * A "Standard Interface" means an interface that either is an official + * standard defined by a recognized standards body, or, in the case of + * interfaces specified for a particular programming language, one that + * is widely used among developers working in that language. + * + * The "System Libraries" of an executable work include anything, other + * than the work as a whole, that (a) is included in the normal form of + * packaging a Major Component, but which is not part of that Major + * Component, and (b) serves only to enable use of the work with that + * Major Component, or to implement a Standard Interface for which an + * implementation is available to the public in source code form. A + * "Major Component", in this context, means a major essential component + * (kernel, window system, and so on) of the specific operating system + * (if any) on which the executable work runs, or a compiler used to + * produce the work, or an object code interpreter used to run it. + * + * The "Corresponding Source" for a work in object code form means all + * the source code needed to generate, install, and (for an executable + * work) run the object code and to modify the work, including scripts to + * control those activities. However, it does not include the work's + * System Libraries, or general-purpose tools or generally available free + * programs which are used unmodified in performing those activities but + * which are not part of the work. For example, Corresponding Source + * includes interface definition files associated with source files for + * the work, and the source code for shared libraries and dynamically + * linked subprograms that the work is specifically designed to require, + * such as by intimate data communication or control flow between those + * subprograms and other parts of the work. + * + * The Corresponding Source need not include anything that users + * can regenerate automatically from other parts of the Corresponding + * Source. + * + * The Corresponding Source for a work in source code form is that + * same work. + * + * 2. Basic Permissions. + * + * All rights granted under this License are granted for the term of + * copyright on the Program, and are irrevocable provided the stated + * conditions are met. This License explicitly affirms your unlimited + * permission to run the unmodified Program. The output from running a + * covered work is covered by this License only if the output, given its + * content, constitutes a covered work. This License acknowledges your + * rights of fair use or other equivalent, as provided by copyright law. + * + * You may make, run and propagate covered works that you do not + * convey, without conditions so long as your license otherwise remains + * in force. You may convey covered works to others for the sole purpose + * of having them make modifications exclusively for you, or provide you + * with facilities for running those works, provided that you comply with + * the terms of this License in conveying all material for which you do + * not control copyright. Those thus making or running the covered works + * for you must do so exclusively on your behalf, under your direction + * and control, on terms that prohibit them from making any copies of + * your copyrighted material outside their relationship with you. + * + * Conveying under any other circumstances is permitted solely under + * the conditions stated below. Sublicensing is not allowed; section 10 + * makes it unnecessary. + * + * 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + * + * No covered work shall be deemed part of an effective technological + * measure under any applicable law fulfilling obligations under article + * 11 of the WIPO copyright treaty adopted on 20 December 1996, or + * similar laws prohibiting or restricting circumvention of such + * measures. + * + * When you convey a covered work, you waive any legal power to forbid + * circumvention of technological measures to the extent such circumvention + * is effected by exercising rights under this License with respect to + * the covered work, and you disclaim any intention to limit operation or + * modification of the work as a means of enforcing, against the work's + * users, your or third parties' legal rights to forbid circumvention of + * technological measures. + * + * 4. Conveying Verbatim Copies. + * + * You may convey verbatim copies of the Program's source code as you + * receive it, in any medium, provided that you conspicuously and + * appropriately publish on each copy an appropriate copyright notice; + * keep intact all notices stating that this License and any + * non-permissive terms added in accord with section 7 apply to the code; + * keep intact all notices of the absence of any warranty; and give all + * recipients a copy of this License along with the Program. + * + * You may charge any price or no price for each copy that you convey, + * and you may offer support or warranty protection for a fee. + * + * 5. Conveying Modified Source Versions. + * + * You may convey a work based on the Program, or the modifications to + * produce it from the Program, in the form of source code under the + * terms of section 4, provided that you also meet all of these conditions: + * + * a) The work must carry prominent notices stating that you modified + * it, and giving a relevant date. + * + * b) The work must carry prominent notices stating that it is + * released under this License and any conditions added under section + * 7. This requirement modifies the requirement in section 4 to + * "keep intact all notices". + * + * c) You must license the entire work, as a whole, under this + * License to anyone who comes into possession of a copy. This + * License will therefore apply, along with any applicable section 7 + * additional terms, to the whole of the work, and all its parts, + * regardless of how they are packaged. This License gives no + * permission to license the work in any other way, but it does not + * invalidate such permission if you have separately received it. + * + * d) If the work has interactive user interfaces, each must display + * Appropriate Legal Notices; however, if the Program has interactive + * interfaces that do not display Appropriate Legal Notices, your + * work need not make them do so. + * + * A compilation of a covered work with other separate and independent + * works, which are not by their nature extensions of the covered work, + * and which are not combined with it such as to form a larger program, + * in or on a volume of a storage or distribution medium, is called an + * "aggregate" if the compilation and its resulting copyright are not + * used to limit the access or legal rights of the compilation's users + * beyond what the individual works permit. Inclusion of a covered work + * in an aggregate does not cause this License to apply to the other + * parts of the aggregate. + * + * 6. Conveying Non-Source Forms. + * + * You may convey a covered work in object code form under the terms + * of sections 4 and 5, provided that you also convey the + * machine-readable Corresponding Source under the terms of this License, + * in one of these ways: + * + * a) Convey the object code in, or embodied in, a physical product + * (including a physical distribution medium), accompanied by the + * Corresponding Source fixed on a durable physical medium + * customarily used for software interchange. + * + * b) Convey the object code in, or embodied in, a physical product + * (including a physical distribution medium), accompanied by a + * written offer, valid for at least three years and valid for as + * long as you offer spare parts or customer support for that product + * model, to give anyone who possesses the object code either (1) a + * copy of the Corresponding Source for all the software in the + * product that is covered by this License, on a durable physical + * medium customarily used for software interchange, for a price no + * more than your reasonable cost of physically performing this + * conveying of source, or (2) access to copy the + * Corresponding Source from a network server at no charge. + * + * c) Convey individual copies of the object code with a copy of the + * written offer to provide the Corresponding Source. This + * alternative is allowed only occasionally and noncommercially, and + * only if you received the object code with such an offer, in accord + * with subsection 6b. + * + * d) Convey the object code by offering access from a designated + * place (gratis or for a charge), and offer equivalent access to the + * Corresponding Source in the same way through the same place at no + * further charge. You need not require recipients to copy the + * Corresponding Source along with the object code. If the place to + * copy the object code is a network server, the Corresponding Source + * may be on a different server (operated by you or a third party) + * that supports equivalent copying facilities, provided you maintain + * clear directions next to the object code saying where to find the + * Corresponding Source. Regardless of what server hosts the + * Corresponding Source, you remain obligated to ensure that it is + * available for as long as needed to satisfy these requirements. + * + * e) Convey the object code using peer-to-peer transmission, provided + * you inform other peers where the object code and Corresponding + * Source of the work are being offered to the general public at no + * charge under subsection 6d. + * + * A separable portion of the object code, whose source code is excluded + * from the Corresponding Source as a System Library, need not be + * included in conveying the object code work. + * + * A "User Product" is either (1) a "consumer product", which means any + * tangible personal property which is normally used for personal, family, + * or household purposes, or (2) anything designed or sold for incorporation + * into a dwelling. In determining whether a product is a consumer product, + * doubtful cases shall be resolved in favor of coverage. For a particular + * product received by a particular user, "normally used" refers to a + * typical or common use of that class of product, regardless of the status + * of the particular user or of the way in which the particular user + * actually uses, or expects or is expected to use, the product. A product + * is a consumer product regardless of whether the product has substantial + * commercial, industrial or non-consumer uses, unless such uses represent + * the only significant mode of use of the product. + * + * "Installation Information" for a User Product means any methods, + * procedures, authorization keys, or other information required to install + * and execute modified versions of a covered work in that User Product from + * a modified version of its Corresponding Source. The information must + * suffice to ensure that the continued functioning of the modified object + * code is in no case prevented or interfered with solely because + * modification has been made. + * + * If you convey an object code work under this section in, or with, or + * specifically for use in, a User Product, and the conveying occurs as + * part of a transaction in which the right of possession and use of the + * User Product is transferred to the recipient in perpetuity or for a + * fixed term (regardless of how the transaction is characterized), the + * Corresponding Source conveyed under this section must be accompanied + * by the Installation Information. But this requirement does not apply + * if neither you nor any third party retains the ability to install + * modified object code on the User Product (for example, the work has + * been installed in ROM). + * + * The requirement to provide Installation Information does not include a + * requirement to continue to provide support service, warranty, or updates + * for a work that has been modified or installed by the recipient, or for + * the User Product in which it has been modified or installed. Access to a + * network may be denied when the modification itself materially and + * adversely affects the operation of the network or violates the rules and + * protocols for communication across the network. + * + * Corresponding Source conveyed, and Installation Information provided, + * in accord with this section must be in a format that is publicly + * documented (and with an implementation available to the public in + * source code form), and must require no special password or key for + * unpacking, reading or copying. + * + * 7. Additional Terms. + * + * "Additional permissions" are terms that supplement the terms of this + * License by making exceptions from one or more of its conditions. + * Additional permissions that are applicable to the entire Program shall + * be treated as though they were included in this License, to the extent + * that they are valid under applicable law. If additional permissions + * apply only to part of the Program, that part may be used separately + * under those permissions, but the entire Program remains governed by + * this License without regard to the additional permissions. + * + * When you convey a copy of a covered work, you may at your option + * remove any additional permissions from that copy, or from any part of + * it. (Additional permissions may be written to require their own + * removal in certain cases when you modify the work.) You may place + * additional permissions on material, added by you to a covered work, + * for which you have or can give appropriate copyright permission. + * + * Notwithstanding any other provision of this License, for material you + * add to a covered work, you may (if authorized by the copyright holders of + * that material) supplement the terms of this License with terms: + * + * a) Disclaiming warranty or limiting liability differently from the + * terms of sections 15 and 16 of this License; or + * + * b) Requiring preservation of specified reasonable legal notices or + * author attributions in that material or in the Appropriate Legal + * Notices displayed by works containing it; or + * + * c) Prohibiting misrepresentation of the origin of that material, or + * requiring that modified versions of such material be marked in + * reasonable ways as different from the original version; or + * + * d) Limiting the use for publicity purposes of names of licensors or + * authors of the material; or + * + * e) Declining to grant rights under trademark law for use of some + * trade names, trademarks, or service marks; or + * + * f) Requiring indemnification of licensors and authors of that + * material by anyone who conveys the material (or modified versions of + * it) with contractual assumptions of liability to the recipient, for + * any liability that these contractual assumptions directly impose on + * those licensors and authors. + * + * All other non-permissive additional terms are considered "further + * restrictions" within the meaning of section 10. If the Program as you + * received it, or any part of it, contains a notice stating that it is + * governed by this License along with a term that is a further + * restriction, you may remove that term. If a license document contains + * a further restriction but permits relicensing or conveying under this + * License, you may add to a covered work material governed by the terms + * of that license document, provided that the further restriction does + * not survive such relicensing or conveying. + * + * If you add terms to a covered work in accord with this section, you + * must place, in the relevant source files, a statement of the + * additional terms that apply to those files, or a notice indicating + * where to find the applicable terms. + * + * Additional terms, permissive or non-permissive, may be stated in the + * form of a separately written license, or stated as exceptions; + * the above requirements apply either way. + * + * 8. Termination. + * + * You may not propagate or modify a covered work except as expressly + * provided under this License. Any attempt otherwise to propagate or + * modify it is void, and will automatically terminate your rights under + * this License (including any patent licenses granted under the third + * paragraph of section 11). + * + * However, if you cease all violation of this License, then your + * license from a particular copyright holder is reinstated (a) + * provisionally, unless and until the copyright holder explicitly and + * finally terminates your license, and (b) permanently, if the copyright + * holder fails to notify you of the violation by some reasonable means + * prior to 60 days after the cessation. + * + * Moreover, your license from a particular copyright holder is + * reinstated permanently if the copyright holder notifies you of the + * violation by some reasonable means, this is the first time you have + * received notice of violation of this License (for any work) from that + * copyright holder, and you cure the violation prior to 30 days after + * your receipt of the notice. + * + * Termination of your rights under this section does not terminate the + * licenses of parties who have received copies or rights from you under + * this License. If your rights have been terminated and not permanently + * reinstated, you do not qualify to receive new licenses for the same + * material under section 10. + * + * 9. Acceptance Not Required for Having Copies. + * + * You are not required to accept this License in order to receive or + * run a copy of the Program. Ancillary propagation of a covered work + * occurring solely as a consequence of using peer-to-peer transmission + * to receive a copy likewise does not require acceptance. However, + * nothing other than this License grants you permission to propagate or + * modify any covered work. These actions infringe copyright if you do + * not accept this License. Therefore, by modifying or propagating a + * covered work, you indicate your acceptance of this License to do so. + * + * 10. Automatic Licensing of Downstream Recipients. + * + * Each time you convey a covered work, the recipient automatically + * receives a license from the original licensors, to run, modify and + * propagate that work, subject to this License. You are not responsible + * for enforcing compliance by third parties with this License. + * + * An "entity transaction" is a transaction transferring control of an + * organization, or substantially all assets of one, or subdividing an + * organization, or merging organizations. If propagation of a covered + * work results from an entity transaction, each party to that + * transaction who receives a copy of the work also receives whatever + * licenses to the work the party's predecessor in interest had or could + * give under the previous paragraph, plus a right to possession of the + * Corresponding Source of the work from the predecessor in interest, if + * the predecessor has it or can get it with reasonable efforts. + * + * You may not impose any further restrictions on the exercise of the + * rights granted or affirmed under this License. For example, you may + * not impose a license fee, royalty, or other charge for exercise of + * rights granted under this License, and you may not initiate litigation + * (including a cross-claim or counterclaim in a lawsuit) alleging that + * any patent claim is infringed by making, using, selling, offering for + * sale, or importing the Program or any portion of it. + * + * 11. Patents. + * + * A "contributor" is a copyright holder who authorizes use under this + * License of the Program or a work on which the Program is based. The + * work thus licensed is called the contributor's "contributor version". + * + * A contributor's "essential patent claims" are all patent claims + * owned or controlled by the contributor, whether already acquired or + * hereafter acquired, that would be infringed by some manner, permitted + * by this License, of making, using, or selling its contributor version, + * but do not include claims that would be infringed only as a + * consequence of further modification of the contributor version. For + * purposes of this definition, "control" includes the right to grant + * patent sublicenses in a manner consistent with the requirements of + * this License. + * + * Each contributor grants you a non-exclusive, worldwide, royalty-free + * patent license under the contributor's essential patent claims, to + * make, use, sell, offer for sale, import and otherwise run, modify and + * propagate the contents of its contributor version. + * + * In the following three paragraphs, a "patent license" is any express + * agreement or commitment, however denominated, not to enforce a patent + * (such as an express permission to practice a patent or covenant not to + * sue for patent infringement). To "grant" such a patent license to a + * party means to make such an agreement or commitment not to enforce a + * patent against the party. + * + * If you convey a covered work, knowingly relying on a patent license, + * and the Corresponding Source of the work is not available for anyone + * to copy, free of charge and under the terms of this License, through a + * publicly available network server or other readily accessible means, + * then you must either (1) cause the Corresponding Source to be so + * available, or (2) arrange to deprive yourself of the benefit of the + * patent license for this particular work, or (3) arrange, in a manner + * consistent with the requirements of this License, to extend the patent + * license to downstream recipients. "Knowingly relying" means you have + * actual knowledge that, but for the patent license, your conveying the + * covered work in a country, or your recipient's use of the covered work + * in a country, would infringe one or more identifiable patents in that + * country that you have reason to believe are valid. + * + * If, pursuant to or in connection with a single transaction or + * arrangement, you convey, or propagate by procuring conveyance of, a + * covered work, and grant a patent license to some of the parties + * receiving the covered work authorizing them to use, propagate, modify + * or convey a specific copy of the covered work, then the patent license + * you grant is automatically extended to all recipients of the covered + * work and works based on it. + * + * A patent license is "discriminatory" if it does not include within + * the scope of its coverage, prohibits the exercise of, or is + * conditioned on the non-exercise of one or more of the rights that are + * specifically granted under this License. You may not convey a covered + * work if you are a party to an arrangement with a third party that is + * in the business of distributing software, under which you make payment + * to the third party based on the extent of your activity of conveying + * the work, and under which the third party grants, to any of the + * parties who would receive the covered work from you, a discriminatory + * patent license (a) in connection with copies of the covered work + * conveyed by you (or copies made from those copies), or (b) primarily + * for and in connection with specific products or compilations that + * contain the covered work, unless you entered into that arrangement, + * or that patent license was granted, prior to 28 March 2007. + * + * Nothing in this License shall be construed as excluding or limiting + * any implied license or other defenses to infringement that may + * otherwise be available to you under applicable patent law. + * + * 12. No Surrender of Others' Freedom. + * + * If conditions are imposed on you (whether by court order, agreement or + * otherwise) that contradict the conditions of this License, they do not + * excuse you from the conditions of this License. If you cannot convey a + * covered work so as to satisfy simultaneously your obligations under this + * License and any other pertinent obligations, then as a consequence you may + * not convey it at all. For example, if you agree to terms that obligate you + * to collect a royalty for further conveying from those to whom you convey + * the Program, the only way you could satisfy both those terms and this + * License would be to refrain entirely from conveying the Program. + * + * 13. Use with the GNU Affero General Public License. + * + * Notwithstanding any other provision of this License, you have + * permission to link or combine any covered work with a work licensed + * under version 3 of the GNU Affero General Public License into a single + * combined work, and to convey the resulting work. The terms of this + * License will continue to apply to the part which is the covered work, + * but the special requirements of the GNU Affero General Public License, + * section 13, concerning interaction through a network will apply to the + * combination as such. + * + * 14. Revised Versions of this License. + * + * The Free Software Foundation may publish revised and/or new versions of + * the GNU General Public License from time to time. Such new versions will + * be similar in spirit to the present version, but may differ in detail to + * address new problems or concerns. + * + * Each version is given a distinguishing version number. If the + * Program specifies that a certain numbered version of the GNU General + * Public License "or any later version" applies to it, you have the + * option of following the terms and conditions either of that numbered + * version or of any later version published by the Free Software + * Foundation. If the Program does not specify a version number of the + * GNU General Public License, you may choose any version ever published + * by the Free Software Foundation. + * + * If the Program specifies that a proxy can decide which future + * versions of the GNU General Public License can be used, that proxy's + * public statement of acceptance of a version permanently authorizes you + * to choose that version for the Program. + * + * Later license versions may give you additional or different + * permissions. However, no additional obligations are imposed on any + * author or copyright holder as a result of your choosing to follow a + * later version. + * + * 15. Disclaimer of Warranty. + * + * THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY + * APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT + * HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY + * OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, + * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM + * IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF + * ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + * + * 16. Limitation of Liability. + * + * IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING + * WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS + * THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY + * GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE + * USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF + * DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD + * PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), + * EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGES. + * + * 17. Interpretation of Sections 15 and 16. + * + * If the disclaimer of warranty and limitation of liability provided + * above cannot be given local legal effect according to their terms, + * reviewing courts shall apply local law that most closely approximates + * an absolute waiver of all civil liability in connection with the + * Program, unless a warranty or assumption of liability accompanies a + * copy of the Program in return for a fee. + * + * END OF TERMS AND CONDITIONS + * + * How to Apply These Terms to Your New Programs + * + * If you develop a new program, and you want it to be of the greatest + * possible use to the public, the best way to achieve this is to make it + * free software which everyone can redistribute and change under these terms. + * + * To do so, attach the following notices to the program. It is safest + * to attach them to the start of each source file to most effectively + * state the exclusion of warranty; and each file should have at least + * the "copyright" line and a pointer to where the full notice is found. + * + * {one line to give the program's name and a brief idea of what it does.} + * Copyright (C) {year} {name of author} + * + * This program 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 of the License, or + * (at your option) any later version. + * + * This program 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 program. If not, see . + * + * Also add information on how to contact you by electronic and paper mail. + * + * If the program does terminal interaction, make it output a short + * notice like this when it starts in an interactive mode: + * + * {project} Copyright (C) {year} {fullname} + * This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + * This is free software, and you are welcome to redistribute it + * under certain conditions; type `show c' for details. + * + * The hypothetical commands `show w' and `show c' should show the appropriate + * parts of the General Public License. Of course, your program's commands + * might be different; for a GUI interface, you would use an "about box". + * + * You should also get your employer (if you work as a programmer) or school, + * if any, to sign a "copyright disclaimer" for the program, if necessary. + * For more information on this, and how to apply and follow the GNU GPL, see + * . + * + * The GNU General Public License does not permit incorporating your program + * into proprietary programs. If your program is a subroutine library, you + * may consider it more useful to permit linking proprietary applications with + * the library. If this is what you want to do, use the GNU Lesser General + * Public License instead of this License. But first, please read + * . + */ + + +#ifndef _QA_AX25_DECODER_H_ +#define _QA_AX25_DECODER_H_ + +#include +#include + +namespace gr { + namespace satnogs { + + class qa_ax25_decoder : public CppUnit::TestCase + { + public: + CPPUNIT_TEST_SUITE(qa_ax25_decoder); + CPPUNIT_TEST(t1); + CPPUNIT_TEST_SUITE_END(); + + private: + void t1(); + }; + + } /* namespace satnogs */ +} /* namespace gr */ + +#endif /* _QA_AX25_DECODER_H_ */ + diff --git a/lib/qa_satnogs.cc b/lib/qa_satnogs.cc index 8ccfee9..314678e 100644 --- a/lib/qa_satnogs.cc +++ b/lib/qa_satnogs.cc @@ -20,11 +20,13 @@ #include "qa_satnogs.h" #include "qa_golay24.h" +#include "qa_ax25_decoder.h" CppUnit::TestSuite * qa_satnogs::suite() { CppUnit::TestSuite *s = new CppUnit::TestSuite("satnogs"); s->addTest(gr::satnogs::qa_golay24::suite()); + s->addTest(gr::satnogs::qa_ax25_decoder::suite()); return s; } diff --git a/swig/satnogs_swig0.i b/swig/satnogs_swig0.i index eb031c9..cf989bc 100644 --- a/swig/satnogs_swig0.i +++ b/swig/satnogs_swig0.i @@ -14,6 +14,7 @@ %template(decoder_sptr) boost::shared_ptr; %{ +#include "satnogs/ax25_decoder.h" #include "satnogs/morse_tree.h" #include "satnogs/morse_decoder.h" #include "satnogs/multi_format_msg_sink.h" @@ -50,6 +51,7 @@ %include "satnogs/morse_tree.h" %include "satnogs/decoder.h" +%include "satnogs/ax25_decoder.h" %include "satnogs/morse_decoder.h" GR_SWIG_BLOCK_MAGIC2(satnogs, morse_decoder);