Skip to content

Commit

Permalink
Merge pull request #98 from anarkiwi/roll
Browse files Browse the repository at this point in the history
separate complex vector roller for offloaded FFT.
  • Loading branch information
rashley-iqt authored Aug 18, 2023
2 parents 7bfa832 + 6ae5292 commit 6e451cc
Show file tree
Hide file tree
Showing 23 changed files with 884 additions and 84 deletions.
3 changes: 2 additions & 1 deletion grc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
install(
FILES iqtlabs_tuneable_test_source.block.yml iqtlabs_retune_fft.block.yml
iqtlabs_write_freq_samples.block.yml iqtlabs_image_inference.block.yml
iqtlabs_vector_to_json.block.yml DESTINATION share/gnuradio/grc/blocks)
iqtlabs_vector_to_json.block.yml
iqtlabs_vector_roll.block.yml DESTINATION share/gnuradio/grc/blocks)
if(Vulkan_FOUND)
install(FILES iqtlabs_vkfft.block.yml DESTINATION share/gnuradio/grc/blocks)
endif()
7 changes: 2 additions & 5 deletions grc/iqtlabs_retune_fft.block.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ documentation: |-
tune_step_hz: increment frequency by this value each retuning step.
tune_step_fft: count at least this many FFT vectors between retuning steps.
skip_tune_step_fft: discard this many FFT vectors before counting (to allow for radio to stabilize after retuning)
fft_roll: if True, the consider the center of the FFT window to be at the beginning of the FFT vector.
fft_min: clip FFT values to this minimum.
fft_max: clip FFT values to this maximum.
sdir: directory to write raw FFT points to.
Expand All @@ -44,12 +43,12 @@ documentation: |-
templates:
imports: from gnuradio import iqtlabs
make: iqtlabs.retune_fft(${tag}, ${vlen}, ${nfft}, ${samp_rate}, ${freq_start}, ${freq_end}, ${tune_step_hz}, ${tune_step_fft}, ${skip_tune_step_fft}, ${fft_roll}, ${fft_min}, ${fft_max}, ${sdir}, ${write_step_fft}, ${bucket_range}, ${tuning_ranges}, ${description}, ${rotate_secs})
make: iqtlabs.retune_fft(${tag}, ${vlen}, ${nfft}, ${samp_rate}, ${freq_start}, ${freq_end}, ${tune_step_hz}, ${tune_step_fft}, ${skip_tune_step_fft}, ${fft_min}, ${fft_max}, ${sdir}, ${write_step_fft}, ${bucket_range}, ${tuning_ranges}, ${description}, ${rotate_secs})

cpp_templates:
includes: ['#include <gnuradio/iqtlabs/retune_fft.h>']
declarations: 'gr::iqtlabs::retune_fft::sptr ${id};'
make: 'this->${id} = gr::iqtlabs::retune_fft::make(${tag}, ${vlen}, ${nfft}, ${samp_rate}, ${freq_start}, ${freq_end}, ${tune_step_hz}, ${tune_step_fft}, ${skip_tune_step_fft}, ${fft_roll} ${fft_min}, ${fft_max}, ${sdir}, ${write_step_fft}, ${bucket_range}, ${tuning_ranges}, ${description}, ${rotate_secs});'
make: 'this->${id} = gr::iqtlabs::retune_fft::make(${tag}, ${vlen}, ${nfft}, ${samp_rate}, ${freq_start}, ${freq_end}, ${tune_step_hz}, ${tune_step_fft}, ${skip_tune_step_fft}, ${fft_min}, ${fft_max}, ${sdir}, ${write_step_fft}, ${bucket_range}, ${tuning_ranges}, ${description}, ${rotate_secs});'
link: ['libgnuradio-iqtlabs.so']

asserts:
Expand Down Expand Up @@ -80,8 +79,6 @@ parameters:
dtype: int
- id: skip_tune_step_fft
dtype: int
- id: fft_roll
dtype: bool
- id: fft_min
dtype: raw
- id: fft_max
Expand Down
45 changes: 45 additions & 0 deletions grc/iqtlabs_vector_roll.block.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
id: iqtlabs_vector_roll
label: vector_roll
category: '[iqtlabs]'
flags: [python, cpp]
documentation:
This block rolls vectors by one half vector size.

input:
vector of complex.
output:
vector of complex, rolled.

parameters:
vlen: length of vector

templates:
imports: from gnuradio import iqtlabs
make: iqtlabs.vector_roll(${vlen})

cpp_templates:
includes: ['#include <gnuradio/iqtlabs/vector_roll.h>']
declarations: 'gr::iqtlabs::vector_roll::sptr ${id};'
make: 'this->${id} = gr::iqtlabs::vector_roll::make(${vlen});'
link: ['libgnuradio-iqtlabs.so']

asserts:
- ${ vlen > 0 }

parameters:
- id: vlen
dtype: int

inputs:
- label: input
domain: stream
dtype: complex
vlen: ${ vlen }

outputs:
- label: output
domain: stream
dtype: complex
vlen: ${ vlen }

file_format: 1
1 change: 1 addition & 0 deletions include/gnuradio/iqtlabs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ install(
image_inference.h
vector_to_json.h
vkfft.h
vector_roll.h
DESTINATION include/gnuradio/iqtlabs)
6 changes: 3 additions & 3 deletions include/gnuradio/iqtlabs/retune_fft.h
Original file line number Diff line number Diff line change
Expand Up @@ -231,9 +231,9 @@ class IQTLABS_API retune_fft : virtual public gr::block {
static sptr make(const std::string &tag, int vlen, int nfft,
uint64_t samp_rate, uint64_t freq_start, uint64_t freq_end,
int tune_step_hz, int tune_step_fft, int skip_tune_step_fft,
bool fft_roll, double fft_min, double fft_max,
const std::string &sdir, uint64_t write_step_fft,
double bucket_range, const std::string &tuning_ranges,
double fft_min, double fft_max, const std::string &sdir,
uint64_t write_step_fft, double bucket_range,
const std::string &tuning_ranges,
const std::string &description, uint64_t rotate_secs);
};

Expand Down
237 changes: 237 additions & 0 deletions include/gnuradio/iqtlabs/vector_roll.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,237 @@
/* -*- c++ -*- */
/* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "[]"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright [yyyy] [name of copyright owner]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#ifndef INCLUDED_IQTLABS_VECTOR_ROLL_H
#define INCLUDED_IQTLABS_VECTOR_ROLL_H

#include <gnuradio/iqtlabs/api.h>
#include <gnuradio/sync_block.h>

namespace gr {
namespace iqtlabs {

/*!
* \brief <+description of block+>
* \ingroup iqtlabs
*
*/
class IQTLABS_API vector_roll : virtual public gr::sync_block {
public:
typedef std::shared_ptr<vector_roll> sptr;

/*!
* \brief Return a shared_ptr to a new instance of iqtlabs::vector_roll.
*
* To avoid accidental use of raw pointers, iqtlabs::vector_roll's
* constructor is in a private implementation
* class. iqtlabs::vector_roll::make is the public interface for
* creating new instances.
*/
static sptr make(std::size_t vlen);
};

} // namespace iqtlabs
} // namespace gr

#endif /* INCLUDED_IQTLABS_VECTOR_ROLL_H */
8 changes: 4 additions & 4 deletions include/gnuradio/iqtlabs/vkfft.h
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,8 @@
* limitations under the License.
*/

#ifndef INCLUDED_IQTLABS_TUNEABLE_TEST_SOURCE_H
#define INCLUDED_IQTLABS_TUNEABLE_TEST_SOURCE_H
#ifndef INCLUDED_IQTLABS_VKFFT_H
#define INCLUDED_IQTLABS_VKFFT_H

#include <gnuradio/iqtlabs/api.h>
#include <gnuradio/sync_block.h>
Expand All @@ -229,10 +229,10 @@ class IQTLABS_API vkfft : virtual public gr::sync_block {
* class. iqtlabs::vkfft::make is the public interface for
* creating new instances.
*/
static sptr make(int vlen, int nfft);
static sptr make(std::size_t vlen, std::size_t nfft);
};

} // namespace iqtlabs
} // namespace gr

#endif /* INCLUDED_IQTLABS_TUNEABLE_TEST_SOURCE_H */
#endif /* INCLUDED_IQTLABS_VKFFT_H */
11 changes: 6 additions & 5 deletions lib/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ if(Vulkan_FOUND)
)
endif()

if(Vulkan_FOUND)
list(APPEND iqtlabs_sources libvkfft.cc vkfft_impl.cc)
endif()

list(
APPEND
iqtlabs_sources
Expand All @@ -42,11 +46,8 @@ list(
retune_fft_impl.cc
tuneable_test_source_impl.cc
write_freq_samples_impl.cc
vector_to_json_impl.cc)

if(Vulkan_FOUND)
list(APPEND iqtlabs_sources libvkfft.cc vkfft_impl.cc)
endif()
vector_to_json_impl.cc
vector_roll_impl.cc)

set(iqtlabs_sources
"${iqtlabs_sources}"
Expand Down
Loading

0 comments on commit 6e451cc

Please sign in to comment.