diff options
author | Jason A. Donenfeld <Jason@zx2c4.com> | 2016-01-04 21:35:41 +0100 |
---|---|---|
committer | Jason A. Donenfeld <Jason@zx2c4.com> | 2016-01-04 22:28:29 +0100 |
commit | ee098a9db6c2984fe91245422d93f16def55c851 (patch) | |
tree | 2e0480d32c882defacc04348ed73c1bdcc20bdbf | |
download | gr-scan-ee098a9db6c2984fe91245422d93f16def55c851.tar.xz gr-scan-ee098a9db6c2984fe91245422d93f16def55c851.zip |
Initial import20160104
-rw-r--r-- | COPYING | 674 | ||||
-rw-r--r-- | Makefile | 39 | ||||
-rw-r--r-- | README.md | 26 | ||||
-rw-r--r-- | arguments.hpp | 220 | ||||
-rw-r--r-- | main.cpp | 44 | ||||
-rw-r--r-- | scanner_sink.hpp | 286 | ||||
-rw-r--r-- | topblock.hpp | 104 |
7 files changed, 1393 insertions, 0 deletions
@@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + 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 <http://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<http://www.gnu.org/licenses/>. + + 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 +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..cdb9d22 --- /dev/null +++ b/Makefile @@ -0,0 +1,39 @@ +# +# gr-scan - A GNU Radio signal scanner +# Copyright (C) 2015 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved. +# Copyright (C) 2012 Nicholas Tomlinson +# +# 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 <http://www.gnu.org/licenses/>. +# + +VERSION = 20160104 +CXXFLAGS ?= -O3 -march=native -fomit-frame-pointer +CXXFLAGS +=-DVERSION="\"gr-scan $(VERSION)\"" -Wall +LDLIBS = -lgnuradio-filter -lgnuradio-blocks -lgnuradio-pmt -lgnuradio-fft -lgnuradio-runtime -lgnuradio-osmosdr -lboost_system + +PREFIX ?= /usr +DESTDIR ?= +BINDIR ?= $(PREFIX)/bin +LIBDIR ?= $(PREFIX)/lib +MANDIR ?= $(PREFIX)/share/man + +all: gr-scan + +gr-scan: *.cpp *.hpp + $(CXX) $(CPPFLAGS) $(CXXFLAGS) *.cpp -o gr-scan $(LDLIBS) $(LDFLAGS) +clean: + rm -f gr-scan + +install: gr-scan + @install -v -d "$(DESTDIR)$(BINDIR)" && install -s -m 0755 -v gr-scan "$(DESTDIR)$(BINDIR)/gr-scan" diff --git a/README.md b/README.md new file mode 100644 index 0000000..88c0468 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +gr-scan +======= + +Fast radio spectrum scanner based on SDR and GnuRadio. + +Tune to frequencies in specified range and tri fing peak in frequency power spectrum. +Print frequency and bandwidth of found peaks. + +### Example + + $ sudo ./gr-scan -x 458 -y 462 -o toto.csv + [...] + 00:00:01: Finished scanning 457.000000 MHz - 459.000000 MHz + 00:00:02: Finished scanning 457.500000 MHz - 459.500000 MHz + 00:00:03: Finished scanning 458.000000 MHz - 460.000000 MHz + 00:00:04: Finished scanning 458.500000 MHz - 460.500000 MHz + 00:00:05: Finished scanning 459.000000 MHz - 461.000000 MHz + [+] 00:00:05: Found signal: at 460.796500 MHz of width 21.000000 kHz, peak power -74.304337 dB (difference 4.142212 dB) + 00:00:06: Finished scanning 459.500000 MHz - 461.500000 MHz + 00:00:07: Finished scanning 460.000000 MHz - 462.000000 MHz + 00:00:08: Finished scanning 460.500000 MHz - 462.500000 MHz + 00:00:09: Finished scanning 461.000000 MHz - 463.000000 MHz + + $ cat toto.csv + time,frequency_mhz,width_khz,peak,diff + 20151222_032034,460.796509,21.000000,-74.304337,4.142212 diff --git a/arguments.hpp b/arguments.hpp new file mode 100644 index 0000000..adc818e --- /dev/null +++ b/arguments.hpp @@ -0,0 +1,220 @@ +/* + gr-scan - A GNU Radio signal scanner + Copyright (C) 2015 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved. + Copyright (C) 2012 Nicholas Tomlinson + + 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 <http://www.gnu.org/licenses/>. +*/ + +#include <stdlib.h> +#include <argp.h> +#include <string> + +class Arguments +{ +public: + Arguments(int argc, char **argv) : + avg_size(1000), + bandwidth1(25000.0), + bandwidth2(-1.0), + spread(50000.0), + threshold(3.0), + centre_freq_1(87000000.0), + centre_freq_2(108000000.0), + sample_rate(2000000.0), + fft_width(1000.0), + step(-1.0), + ptime(1.0) + { + argp_parse (&argp_i, argc, argv, 0, 0, this); + } + + unsigned int get_avg_size() + { + return avg_size; + } + + double get_bandwidth1() + { + return bandwidth1; + } + + double get_bandwidth2() + { + if (bandwidth2 < 0.0)/* User did not specify a coarse band */ + return bandwidth1 * 8.0; /* I've found this to be a good choice for the coarse band */ + else + return bandwidth2; /* If the user specified a bandwidth for this, use it */ + } + + double get_spread() + { + return spread; + } + + double get_threshold() + { + return threshold; + } + + double get_centre_freq_1() + { + return centre_freq_1; + } + + double get_centre_freq_2() + { + return centre_freq_2; + } + + double get_sample_rate() + { + return sample_rate; + } + + double get_fft_width() + { + return fft_width; + } + + double get_step() + { + if (step < 0.0) + return sample_rate / 4.0; // I've found this to be a good choice (slightly faster might be / 3.0) + else + return step; + } + + double get_time() + { + return ptime; + } + + std::string get_outcsv() + { + return outcsv; + } + +private: + static error_t s_parse_opt(int key, char *arg, struct argp_state *state) + { + Arguments *arguments = static_cast<Arguments *>(state->input); + return arguments->parse_opt(key, arg, state); + } + + error_t parse_opt(int key, char *arg, struct argp_state *state) + { + switch (key) + { + case 'a': + avg_size = atoi(arg); + break; + case 'f': + bandwidth1 = atof(arg) * 1000.0; //kHz + break; + case 'c': + bandwidth2 = atof(arg) * 1000.0; //kHz + break; + case 's': + spread = atof(arg) * 1000.0; //kHz + break; + case 't': + threshold = atof(arg); + break; + case 'x': + centre_freq_1 = atof(arg) * 1000000.0; //MHz + break; + case 'y': + centre_freq_2 = atof(arg) * 1000000.0; //MHz + break; + case 'r': + sample_rate = atof(arg) * 1000000.0; //MSamples/s + break; + case 'w': + fft_width = atoi(arg); + break; + case 'z': + step = atof(arg) * 1000000.0; //MHz + break; + case 'p': + ptime = atof(arg); + break; + case 'o': + outcsv = std::string(arg); + break; + case ARGP_KEY_ARG: + if (state->arg_num > 0) + argp_usage(state); + break; + case ARGP_KEY_END: + break; + default: + return ARGP_ERR_UNKNOWN; + } + return 0; + } + + static argp_option options[]; + static argp argp_i; + + unsigned int avg_size; + double bandwidth1; + double bandwidth2; + double spread; + double threshold; + double centre_freq_1; + double centre_freq_2; + double sample_rate; + double fft_width; + double step; + double ptime; + std::string outcsv; +}; + +argp_option Arguments::options[] = { + {"average", 'a', "COUNT", 0, "Average over COUNT samples (default: 1000)"}, + {"fine-bandwidth", 'f', "FREQ", 0, "Bandwidth of the fine window in kHz (default: 25)"}, + {"coarse-bandwidth", 'c', "FREQ", 0, "Bandwidth of the coarse window in kHz (default: fine-bandwidth * 8)"}, + {"spread", 's', "FREQ", 0, "Minimum frequency between detected signals in kHz (default: 50)"}, + {"threshold", 't', "POWER", 0, "Threshold for the difference between the coarse and fine filtered signals in dB (default: 3)"}, + {"start-frequency", 'x', "FREQ", 0, "Start frequency in MHz (default: 87)"}, + {"end-frequency", 'y', "FREQ", 0, "End frequency in MHz (default: 108)"}, + {"sample-rate", 'r', "RATE", 0, "Samplerate in Msamples/s (default: 2)"}, + {"fft-width", 'w', "COUNT", 0, "Width of FFT in samples (default: 1000)"}, + {"step", 'z', "FREQ", 0, "Increment step in MHz (default: sample_rate / 4)"}, + {"time", 'p', "TIME", 0, "Time in seconds to scan on each frequency (default: 1)"}, + {"output-csv", 'o', "OUTCSV", 0, "Output results to CSV file (default: [none])"}, + {0} +}; + +argp Arguments::argp_i = {options, s_parse_opt, 0, 0}; + +const char *argp_program_bug_address = "Jason@zx2c4.com"; +const char *argp_program_version = + "gr-scan " VERSION " - A GNU Radio signal scanner\n" + "Copyright (C) 2015 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.\n" + "Copyright (C) 2012 Nicholas Tomlinson\n" + "\n" + "This program is free software: you can redistribute it and/or modify\n" + "it under the terms of the GNU General Public License as published by\n" + "the Free Software Foundation, either version 3 of the License, or\n" + "(at your option) any later version.\n" + "\n" + "This program is distributed in the hope that it will be useful,\n" + "but WITHOUT ANY WARRANTY; without even the implied warranty of\n" + "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" + "GNU General Public License for more details.\n" + "\n" + "You should have received a copy of the GNU General Public License\n" + "along with this program. If not, see <http://www.gnu.org/licenses/>."; diff --git a/main.cpp b/main.cpp new file mode 100644 index 0000000..a6f3438 --- /dev/null +++ b/main.cpp @@ -0,0 +1,44 @@ +/* + gr-scan - A GNU Radio signal scanner + Copyright (C) 2015 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved. + Copyright (C) 2012 Nicholas Tomlinson + + 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 <http://www.gnu.org/licenses/>. +*/ + + +#include <cstdio> + +#include "arguments.hpp" +#include "topblock.hpp" + +int main(int argc, char **argv) +{ + Arguments arguments(argc, argv); + + TopBlock top_block(arguments.get_centre_freq_1(), + arguments.get_centre_freq_2(), + arguments.get_sample_rate(), + arguments.get_fft_width(), + arguments.get_bandwidth1(), + arguments.get_bandwidth2(), + arguments.get_step(), + arguments.get_avg_size(), + arguments.get_spread(), + arguments.get_threshold(), + arguments.get_time(), + arguments.get_outcsv()); + top_block.run(); + return 0; //actually, we never get here because of the rude way in which we end the scan +} diff --git a/scanner_sink.hpp b/scanner_sink.hpp new file mode 100644 index 0000000..20be479 --- /dev/null +++ b/scanner_sink.hpp @@ -0,0 +1,286 @@ +/* + gr-scan - A GNU Radio signal scanner + Copyright (C) 2015 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved. + Copyright (C) 2012 Nicholas Tomlinson + + 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 <http://www.gnu.org/licenses/>. +*/ + +#include <ctime> +#include <set> +#include <utility> + +#include <boost/shared_ptr.hpp> + +#include <gnuradio/block.h> +#include <gnuradio/io_signature.h> +#include <osmosdr/source.h> + + +class scanner_sink : public gr::block +{ +public: + scanner_sink(osmosdr::source::sptr source, unsigned int vector_length, double centre_freq_1, + double centre_freq_2, double bandwidth0, double bandwidth1, double bandwidth2, + double step, unsigned int avg_size, double spread, double threshold, double ptime, + const std::string &outcsv) : + gr::block("scanner_sink", + gr::io_signature::make(1, 1, sizeof (float) * vector_length), + gr::io_signature::make(0, 0, 0)), + m_source(source), //We need the source in order to be able to control it + m_buffer(new float[vector_length]), //buffer into which we accumulate the total for averaging + m_vector_length(vector_length), //size of the FFT + m_count(0), //number of FFTs totalled in the buffer + m_wait_count(0), //number of times we've listenned on this frequency + m_avg_size(avg_size), //the number of FFTs we should average over + m_step(step), //the amount by which the frequency shold be incremented + m_centre_freq_1(centre_freq_1), //start frequency (and then current frequency) + m_centre_freq_2(centre_freq_2), //end frequency + m_bandwidth0(bandwidth0), //samples per second + m_bandwidth1(bandwidth1), //fine window (band)width + m_bandwidth2(bandwidth2), //coarse window (band)width + m_threshold(threshold), //threshold in dB for discovery + m_spread(spread), //minumum distance between radio signals (overlapping scans might produce slightly different frequencies) + m_time(ptime), //the amount of time to listen on the same frequency for + m_start_time(time(0)), //the start time of the scan (useful for logging/reporting/monitoring) + m_outcsv(NULL) + { + ZeroBuffer(); + if (!outcsv.empty()) { + bool write_csv_header = access(outcsv.c_str(), F_OK) == -1; + m_outcsv = fopen(outcsv.c_str(), "a+"); + if (!m_outcsv) { + fprintf(stderr, "[-] Error opening output CSV file %s\n", outcsv.c_str()); + exit(1); + } + if (write_csv_header) { + fprintf(m_outcsv, "time,frequency_mhz,width_khz,peak,diff\n"); + fflush(m_outcsv); + } + } + } + + virtual ~scanner_sink() + { + delete []m_buffer; //delete the buffer + if (m_outcsv) + fclose(m_outcsv); + } + +private: + virtual int general_work(int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items) + { + for (int i = 0; i < ninput_items[0]; ++i) + ProcessVector(static_cast<const float *>(input_items[0]) + i * m_vector_length); + + consume_each(ninput_items[0]); + return 0; + } + + void ProcessVector(const float *input) + { + //Add the FFT to the total + for (unsigned int i = 0; i < m_vector_length; ++i) + m_buffer[i] += input[i]; + ++m_count; //increment the total + + if (m_avg_size != m_count) + return; //we haven't yet averaged over the number we intended to + + + double freqs[m_vector_length]; //for convenience + float bands0[m_vector_length]; //bands in order of frequency + float bands1[m_vector_length]; //fine window bands + float bands2[m_vector_length]; //coarse window bands + + Rearrange(bands0, freqs, m_centre_freq_1, m_bandwidth0); //organise the buffer into a convenient order (saves to bands0) + GetBands(bands0, bands1, m_bandwidth1); //apply the fine window (saves to bands1) + GetBands(bands0, bands2, m_bandwidth2); //apply the coarse window (saves to bands2) + PrintSignals(freqs, bands1, bands2); + + m_count = 0; //next time, we're starting from scratch - so note this + ZeroBuffer(); //get ready to start again + + ++m_wait_count; //we've just done another listen + if (m_time / (m_bandwidth0 / static_cast<double>(m_vector_length * m_avg_size)) <= m_wait_count) { //if we should move to the next frequency + for (;;) { //keep moving to the next frequency until we get to one we can listen on (copes with holes in the tunable range) + if (m_centre_freq_2 <= m_centre_freq_1) { //we reached the end! + //do something to end the scan + fprintf(stderr, "[*] Finished scanning\n"); //say we're exiting + exit(0); //TODO: This probably isn't the right thing, but it'll do for now + } + + m_centre_freq_1 += m_step; //calculate the frequency we should change to + double actual = m_source->set_center_freq(m_centre_freq_1); //change frequency + if ((m_centre_freq_1 - actual < 10.0) && (actual - m_centre_freq_1 < 10.0)) //success + break; //so stop changing frequency + } + m_wait_count = 0; //new frequency - we've listened 0 times on it + } + } + + void PrintSignals(double *freqs, float *bands1, float *bands2) + { + /* Calculate the current time after start */ + unsigned int t = time(NULL) - m_start_time; + unsigned int hours = t / 3600; + unsigned int minutes = (t % 3600) / 60; + unsigned int seconds = t % 60; + + //Print that we finished scanning something + fprintf(stderr, "%02u:%02u:%02u: Finished scanning %f MHz - %f MHz\n", + hours, minutes, seconds, (m_centre_freq_1 - m_bandwidth0 / 2.0) / 1000000.0, (m_centre_freq_1 + m_bandwidth0 / 2.0) / 1000000.0); + + /* Calculate the differences between the fine and coarse window bands */ + float diffs[m_vector_length]; + for (unsigned int i = 0; i < m_vector_length; ++i) + diffs[i] = bands1[i] - bands2[i]; + + /* Look through to find signals */ + //start with no signal found (note: diffs[0] should always be very negative because of the way the windowing function works) + bool sig = false; + unsigned int peak = 0; + for (unsigned int i = 0; i < m_vector_length; ++i) { + if (sig) { //we're already in a signal + if (diffs[peak] < diffs[i]) //we found a rough end to the signal + peak = i; + + if (diffs[i] < m_threshold) { //we're transitionning to the end + /* look for the "start" of the signal */ + unsigned int min = peak; //scan outwards for the minimum + while ((diffs[min] > diffs[peak] - 3.0) && (min > 0)){ //while the signal is still more than half power + min--; + } + + /* look for the "end" */ + unsigned int max = peak; + while ((diffs[max] > diffs[peak] - 3.0) && (max < m_vector_length - 1)) + max++; + sig = false; //we're now in no signal state + + /* Print the signal if it's a genuine hit */ + if (TrySignal(freqs[max], freqs[min])) { + fprintf(stderr, "[+] %02u:%02u:%02u: Found signal: at %f MHz of width %f kHz, peak power %f dB (difference %f dB)\n", + hours, minutes, seconds, (freqs[max] + freqs[min]) / 2000000.0, (freqs[max] - freqs[min])/1000.0, bands1[peak], diffs[peak]); + WriteCSV((freqs[max] + freqs[min]) / 2000000.0, + (freqs[max] - freqs[min])/1000.0, + bands1[peak], diffs[peak]); + } + } + } + else if (diffs[i] >= m_threshold) { //we found a signal! + peak = i; + sig = true; + } + } + } + + bool TrySignal(double min, double max) + { + double mid = (min + max) / 2.0; //calculate the midpoint of the signal + + /* check to see if the signal is too close to the centre frequency (a signal often erroniously appears there) */ + if ((mid - m_centre_freq_1 < m_spread) && (m_centre_freq_1 - mid < m_spread)) + return false; //if so, this is not a genuine hit + + /* check to see if the signal is close to any other (the same signal often appears with a slightly different centre frequency) */ + BOOST_FOREACH (double signal, m_signals){ + if ((mid - signal < m_spread) && (signal - mid < m_spread)) //tpo close + return false; //if so, this is not a genuine hit + } + + /* Genuine hit!:D */ + m_signals.insert(mid); //add to the set of signals + return true; //genuine hit + } + + void Rearrange(float *bands, double *freqs, double centre, double bandwidth) + { + double samplewidth = bandwidth/(double)m_vector_length; + for (unsigned int i = 0; i < m_vector_length; ++i) { + /* FFT is arranged starting at 0 Hz at the start, rather than in the middle */ + if (i < m_vector_length / 2) //lower half of the fft + bands[i + m_vector_length / 2] = m_buffer[i] / static_cast<float>(m_avg_size); + else //upper half of the fft + bands[i - m_vector_length / 2] = m_buffer[i] / static_cast<float>(m_avg_size); + + freqs[i] = centre + i * samplewidth - bandwidth / 2.0; //calculate the frequency of this sample + } + } + + void GetBands(float *powers, float *bands, unsigned int bandwidth) + { + double samplewidth = m_bandwidth0 / static_cast<double>(m_vector_length); //the width in Hz of each sample + unsigned int bandwidth_samples = bandwidth / samplewidth; //the number of samples in our window + for (unsigned int i = 0; i < m_vector_length; ++i) //we're averaging, so start with 0 + bands[i] = 0.0; + + for (unsigned int i = 0; i < m_vector_length; ++i){ //over the entire FFT + //make the buffer contains the entire window + if ((i >= bandwidth_samples / 2) && (i < m_vector_length + bandwidth_samples / 2 - bandwidth_samples)){ + for (unsigned int j = 0; j < bandwidth_samples; ++j) //iterate over the window for averaging + bands[i + j - bandwidth_samples / 2] += powers[i] / static_cast<float>(bandwidth_samples); //add this sample to the bands + } + } + } + + void ZeroBuffer() + { + /* writes zeros to m_buffer */ + for (unsigned int i = 0; i < m_vector_length; ++i) + m_buffer[i] = 0.0; + } + + void WriteCSV(float freq, float width, float peak, float diff) + { + time_t timer; + struct tm *tm_info; + char buf[26]; + + if (!m_outcsv) + return; + + time(&timer); + tm_info = localtime(&timer); + strftime(buf, sizeof(buf), "%Y%m%d_%H%M%S", tm_info); + fprintf(m_outcsv, "%s,%f,%f,%f,%f\n", buf, freq, width, peak, diff); + fflush(m_outcsv); + } + + std::set<double> m_signals; + osmosdr::source::sptr m_source; + float *m_buffer; + unsigned int m_vector_length; + unsigned int m_count; + unsigned int m_wait_count; + unsigned int m_avg_size; + double m_step; + double m_centre_freq_1; + double m_centre_freq_2; + double m_bandwidth0; + double m_bandwidth1; + double m_bandwidth2; + double m_threshold; + double m_spread; + double m_time; + time_t m_start_time; + FILE *m_outcsv; +}; + +/* Shared pointer thing gnuradio is fond of */ +typedef boost::shared_ptr<scanner_sink> scanner_sink_sptr; +scanner_sink_sptr make_scanner_sink(osmosdr::source::sptr source, unsigned int vector_length, double centre_freq_1, double centre_freq_2, double bandwidth0, double bandwidth1, double bandwidth2, double step, unsigned int avg_size, double spread, double threshold, double ptime, const std::string &outcsv) +{ + return boost::shared_ptr<scanner_sink>(new scanner_sink(source, vector_length, centre_freq_1, centre_freq_2, bandwidth0, bandwidth1, bandwidth2, step, avg_size, spread, threshold, ptime, outcsv)); +} diff --git a/topblock.hpp b/topblock.hpp new file mode 100644 index 0000000..33e9484 --- /dev/null +++ b/topblock.hpp @@ -0,0 +1,104 @@ +/* + gr-scan - A GNU Radio signal scanner + Copyright (C) 2015 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved. + Copyright (C) 2012 Nicholas Tomlinson + + 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 <http://www.gnu.org/licenses/>. +*/ + + +#include <cmath> +#include <stdint.h> + +#include <gnuradio/top_block.h> +#include <osmosdr/source.h> +#include <gnuradio/blocks/stream_to_vector.h> +#include <gnuradio/fft/fft_vcc.h> +#include <gnuradio/blocks/complex_to_mag_squared.h> +#include <gnuradio/filter/single_pole_iir_filter_ff.h> +#include <gnuradio/blocks/nlog10_ff.h> +#include "scanner_sink.hpp" + +class TopBlock : public gr::top_block +{ +public: + TopBlock(double centre_freq_1, double centre_freq_2, double sample_rate, + double fft_width, double bandwidth1, double bandwidth2, + double step, unsigned int avg_size, double spread, + double threshold, double ptime, const std::string &outcsv) : + gr::top_block("Top Block"), + vector_length(sample_rate / fft_width), + window(GetWindow(vector_length)), + source(osmosdr::source::make()), /* OsmoSDR Source */ + stv(gr::blocks::stream_to_vector::make(sizeof(float) * 2, vector_length)), /* Stream to vector */ + /* Based on the logpwrfft (a block implemented in python) */ + fft(gr::fft::fft_vcc::make(vector_length, true, window, false, 1)), + ctf(gr::blocks::complex_to_mag_squared::make(vector_length)), + iir(gr::filter::single_pole_iir_filter_ff::make(1.0, vector_length)), + lg(gr::blocks::nlog10_ff::make(10, vector_length, -20 * std::log10(float(vector_length)) -10 * std::log10(float(GetWindowPower() / vector_length)))), + /* Sink - this does most of the interesting work */ + sink(make_scanner_sink(source, vector_length, centre_freq_1, centre_freq_2, sample_rate, bandwidth1, bandwidth2, step, avg_size, spread, threshold, ptime, outcsv)) + { + /* Set up the OsmoSDR Source */ + source->set_sample_rate(sample_rate); + source->set_center_freq(centre_freq_1); + source->set_freq_corr(0.0); + source->set_gain_mode(false); + source->set_gain(10.0); + source->set_if_gain(20.0); + + /* Set up the connections */ + connect(source, 0, stv, 0); + connect(stv, 0, fft, 0); + connect(fft, 0, ctf, 0); + connect(ctf, 0, iir, 0); + connect(iir, 0, lg, 0); + connect(lg, 0, sink, 0); + } + +private: + /* http://en.wikipedia.org/w/index.php?title=Window_function&oldid=508445914 */ + std::vector<float> GetWindow(size_t n) + { + std::vector<float> w; + w.resize(n); + + double a = 0.16; + double a0 = (1.0 - a)/2.0; + double a1 = 0.5; + double a2 = a/2.0; + + for (unsigned int i = 0; i < n; ++i) + w[i] = a0 - a1 * ::cos((2.0 * 3.14159 * static_cast<double>(i))/static_cast<double>(n - 1)) + a2 * ::cos((4.0 * 3.14159 * static_cast<double>(i))/static_cast<double>(n - 1)); + return w; + } + + double GetWindowPower() + { + double total = 0.0; + BOOST_FOREACH (double d, window) + total += d * d; + return total; + } + + size_t vector_length; + std::vector<float> window; + osmosdr::source::sptr source; + gr::blocks::stream_to_vector::sptr stv; + gr::fft::fft_vcc::sptr fft; + gr::blocks::complex_to_mag_squared::sptr ctf; + gr::filter::single_pole_iir_filter_ff::sptr iir; + gr::blocks::nlog10_ff::sptr lg; + scanner_sink_sptr sink; +}; |