Skip to content

Commit

Permalink
URL and License updates (#503)
Browse files Browse the repository at this point in the history
* Pull in GPLv2 from https://github.com/microtony/RTLSDR-Airband/
* Update repo URLs
* make this a #minor release
  • Loading branch information
charlie-foxtrot authored Mar 10, 2025
1 parent 4845a52 commit 21a8caf
Show file tree
Hide file tree
Showing 52 changed files with 413 additions and 976 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Questions & Help
url: https://github.com/charlie-foxtrot/RTLSDR-Airband/discussions/categories/q-a
url: https://github.com/rtl-airband/RTLSDR-Airband/discussions/categories/q-a
about: Please ask and answer questions here.
5 changes: 5 additions & 0 deletions .github/workflows/build_docker_containers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ on:
jobs:
build_docker_containers:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
attestations: write
id-token: write
steps:
- name: Runner Info
run: printenv | sort
Expand Down
759 changes: 85 additions & 674 deletions LICENSE

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ This file will no longer be updated with each release, for changes between relea

Version 5.0.0 (Jan 21, 2024):

* NOTE: Going forward a release tag will be automatically created on each merge to `main`, and changes will not be reflected in this file. For changes between versions see the repo's [release history](https://github.com/charlie-foxtrot/RTLSDR-Airband/releases).
* NOTE: Going forward a release tag will be automatically created on each merge to `main`, and changes will not be reflected in this file. For changes between versions see the repo's [release history](https://github.com/rtl-airband/RTLSDR-Airband/releases).
* NOTE: Going forward PRs will be opened directly against `main` and the `unstable` branch will no longer be used.
* NOTE: This repo has significantly diverged from the original project [microtony/RTLSDR-Airband](https://github.com/microtony/RTLSDR-Airband) so it has been been detached (ie no longer a fork).

* Changes in this release, see [#444](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/444):
* Changes in this release, see [#444](https://github.com/rtl-airband/RTLSDR-Airband/pull/444):
* build and publish docker containers
* changes to supported `cmake` platforms:
* depreciate `rpiv1`, `armv7-generic`, and `armv8-generic` and build platforms
Expand All @@ -22,23 +22,23 @@ Version 5.0.0 (Jan 21, 2024):
Version 4.2.0 (Oct 13, 2023):

* Changes in this release:
* Add support for building with libshout v2.4.6, see [#382](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/382) and [#422](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/422)
* Add error checking for lowpass <= highpass, see [#399](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/399) and [#412](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/412)
* Remove limit on count of mixer inputs (thanks @cdknox), see [#408](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/408)
* Add `dated_subdirectories` config option for output files (thanks, @marcin-osowski), see [#413](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/413)
* Add support for building with libshout v2.4.6, see [#382](https://github.com/rtl-airband/RTLSDR-Airband/pull/382) and [#422](https://github.com/rtl-airband/RTLSDR-Airband/pull/422)
* Add error checking for lowpass <= highpass, see [#399](https://github.com/rtl-airband/RTLSDR-Airband/pull/399) and [#412](https://github.com/rtl-airband/RTLSDR-Airband/pull/412)
* Remove limit on count of mixer inputs (thanks @cdknox), see [#408](https://github.com/rtl-airband/RTLSDR-Airband/pull/408)
* Add `dated_subdirectories` config option for output files (thanks, @marcin-osowski), see [#413](https://github.com/rtl-airband/RTLSDR-Airband/pull/413)

Version 4.1.1 (May 1, 2023):

* Changes in this release:
* Fix build issues when using VideoCore GPU, see [#378](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/378)
* Fix build issues when using VideoCore GPU, see [#378](https://github.com/rtl-airband/RTLSDR-Airband/pull/378)

Version 4.1.0 (April 23, 2023):

* Changes in this release:
* Add `channel_dbfs_noise_level` and `channel_dbfs_signal_level` to the stats file, see [#355](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/355)
* Add squelch support for CTCSS, add `channel_ctcss_counter` and `channel_no_ctcss_counter` to the stats file, see [#368](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/368)
* Support `ampfactor` on a per-channel basis (in addition to mixer inputs), see [#369](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/369)
* Fix config error messages, see [#371](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/371)
* Add `channel_dbfs_noise_level` and `channel_dbfs_signal_level` to the stats file, see [#355](https://github.com/rtl-airband/RTLSDR-Airband/pull/355)
* Add squelch support for CTCSS, add `channel_ctcss_counter` and `channel_no_ctcss_counter` to the stats file, see [#368](https://github.com/rtl-airband/RTLSDR-Airband/pull/368)
* Support `ampfactor` on a per-channel basis (in addition to mixer inputs), see [#369](https://github.com/rtl-airband/RTLSDR-Airband/pull/369)
* Fix config error messages, see [#371](https://github.com/rtl-airband/RTLSDR-Airband/pull/371)
* Multiple CI / workflow improvements, including:
* Addition of Dockerfiles and shell scripts for multiple build environments
* Addition of vscode devcontainer configuration
Expand All @@ -48,14 +48,14 @@ Version 4.1.0 (April 23, 2023):
Version 4.0.3 (Jan 10, 2023):

* Changes in this release:
* Add `channel_squelch_level` to stats file, see [#332](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/332)
* Add `channel_squelch_level` to stats file, see [#332](https://github.com/rtl-airband/RTLSDR-Airband/pull/332)
* Support "default" values in lists for `squelch_snr_threshold` and `notch_q`,
see [#334](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/334)
* Set cmake `ENABLE_EXPORTS` property, see [#339](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/339)
see [#334](https://github.com/rtl-airband/RTLSDR-Airband/pull/334)
* Set cmake `ENABLE_EXPORTS` property, see [#339](https://github.com/rtl-airband/RTLSDR-Airband/pull/339)

* Other items to note:
* Repo maintainer has changed, see [#342](https://github.com/charlie-foxtrot/RTLSDR-Airband/discussions/342)
* Repo URL has moved to https://github.com/charlie-foxtrot/RTLSDR-Airband
* Repo maintainer has changed, see [#342](https://github.com/rtl-airband/RTLSDR-Airband/discussions/342)
* Repo URL has moved to https://github.com/rtl-airband/RTLSDR-Airband
* Default branch / Top of Tree has been renamed to `main`

Version 4.0.2 (Dec 26, 2021):
Expand Down Expand Up @@ -207,7 +207,7 @@ Version 3.0.0 (Feb 10, 2018):
* Frequencies in the config can now be expressed in Hz, kHz, MHz or GHz
for improved readability.
* Lots of bugfixes.
* Rewritten documentation on [Github Wiki](https://github.com/szpajder/RTLSDR-Airband/wiki).
* Rewritten documentation on [Github Wiki](https://github.com/rtl-airband/RTLSDR-Airband/wiki).

Version 2.4.0 (Oct 15, 2017):

Expand Down
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# RTLSDR-Airband

![main](https://github.com/charlie-foxtrot/RTLSDR-Airband/actions/workflows/ci_build.yml/badge.svg?branch=main)
![main](https://github.com/charlie-foxtrot/RTLSDR-Airband/actions/workflows/platform_build.yml/badge.svg?branch=main)
![main](https://github.com/charlie-foxtrot/RTLSDR-Airband/actions/workflows/build_docker_containers.yml/badge.svg?branch=main)
![main](https://github.com/charlie-foxtrot/RTLSDR-Airband/actions/workflows/code_formatting.yml/badge.svg?branch=main)
![main](https://github.com/rtl-airband/RTLSDR-Airband/actions/workflows/ci_build.yml/badge.svg?branch=main)
![main](https://github.com/rtl-airband/RTLSDR-Airband/actions/workflows/platform_build.yml/badge.svg?branch=main)
![main](https://github.com/rtl-airband/RTLSDR-Airband/actions/workflows/build_docker_containers.yml/badge.svg?branch=main)
![main](https://github.com/rtl-airband/RTLSDR-Airband/actions/workflows/code_formatting.yml/badge.svg?branch=main)

NOTE: Changes as of v5.0.0:
Changes as of v5.1.0:
- License is now GPLv2 [#503](https://github.com/rtl-airband/RTLSDR-Airband/discussions/503)

NOTE: Repo URL has moved to https://github.com/rtl-airband/RTLSDR-Airband see [#502](https://github.com/rtl-airband/RTLSDR-Airband/discussions/502) for info

Changes as of v5.0.0:
- PRs will be opened directly against `main` and the `unstable` branch will no longer be used
- Version tags will be automatically created on each merge to `main`
- A release will be created on each `major` or `minor` version tag but not `minor` tags
- Checking out `main` is recommended over using a release artifact to stay on the latest version
- This repo has significantly diverged from the original project [microtony/RTLSDR-Airband](https://github.com/microtony/RTLSDR-Airband) so it has been been detached (ie no longer a fork).
- Specific build support for `rpiv1`, `armv7-generic`, and `armv8-generic` have been deprecated for the new default `native`, see [#447](https://github.com/charlie-foxtrot/RTLSDR-Airband/discussions/447)
- Specific build support for `rpiv1`, `armv7-generic`, and `armv8-generic` have been deprecated for the new default `native`, see [#447](https://github.com/rtl-airband/RTLSDR-Airband/discussions/447)

NOTE: Repo URL has moved to https://github.com/charlie-foxtrot/RTLSDR-Airband see [#342](https://github.com/charlie-foxtrot/RTLSDR-Airband/discussions/342) for info

## Overview

Expand All @@ -26,7 +30,7 @@ radios are now supported as well.

## Documentation

User's manual is now on the [wiki](https://github.com/charlie-foxtrot/RTLSDR-Airband/wiki).
User's manual is now on the [wiki](https://github.com/rtl-airband/RTLSDR-Airband/wiki).

## Credits and thanks

Expand All @@ -41,24 +45,24 @@ of RTLSDR-Airband. Special thanks go to:

## License

Copyright (C) 2022-2024 charlie-foxtrot
Copyright (C) 2022-2025 charlie-foxtrot

Copyright (C) 2015-2022 Tomasz Lemiech <[email protected]>

Based on original work by Wong Man Hang <[email protected]>

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 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 2
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/>.
along with this program; if not, see <https://www.gnu.org/licenses/>.

## Open Source Licenses of bundled code

Expand Down
2 changes: 1 addition & 1 deletion config/basic_multichannel.conf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This is a minimalistic configuration file for RTLSDR-Airband.
# Just a single RTL dongle with two AM channels in multichannel mode.
# Each channel is sent to a single Icecast output.
# Refer to https://github.com/charlie-foxtrot/RTLSDR-Airband/wiki
# Refer to https://github.com/rtl-airband/RTLSDR-Airband/wiki
# for description of keywords and config syntax.

devices:
Expand Down
2 changes: 1 addition & 1 deletion config/basic_scanning.conf
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scanning mode example
# Single dongle, three frequencies, output to Icecast server and to a file.
# Refer to https://github.com/charlie-foxtrot/RTLSDR-Airband/wiki
# Refer to https://github.com/rtl-airband/RTLSDR-Airband/wiki
# for description of keywords and config syntax.

devices:
Expand Down
2 changes: 1 addition & 1 deletion config/mixers.conf
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# - channel 1 goes to mixer1 (full right)
# - channel 2 goes to mixer2 (85% left, volume set to 200%)
#
# Refer to https://github.com/charlie-foxtrot/RTLSDR-Airband/wiki
# Refer to https://github.com/rtl-airband/RTLSDR-Airband/wiki
# for description of keywords and config syntax.
mixers: {
mixer1: {
Expand Down
2 changes: 1 addition & 1 deletion config/two_dongles_multiple_outputs.conf
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# indexes, because the latter can change when devices are
# reconnected into different USB ports.
#
# Refer to https://github.com/charlie-foxtrot/RTLSDR-Airband/wiki
# Refer to https://github.com/rtl-airband/RTLSDR-Airband/wiki
# for description of keywords and config syntax.

devices:
Expand Down
2 changes: 1 addition & 1 deletion init.d/rtl_airband.service
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[Unit]
Description=SDR AM/NFM demodulator
Documentation=https://github.com/charlie-foxtrot/RTLSDR-Airband/wiki
Documentation=https://github.com/rtl-airband/RTLSDR-Airband/wiki
Wants=network.target
After=network.target

Expand Down
2 changes: 1 addition & 1 deletion src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ set(WITH_BCM_VC FALSE)

# error out on depricated PLATFORM values
if(PLATFORM STREQUAL "rpiv1" OR PLATFORM STREQUAL "armv7-generic" OR PLATFORM STREQUAL "armv8-generic")
message(FATAL_ERROR "platform '${PLATFORM}' has been deprecated, see https://github.com/charlie-foxtrot/RTLSDR-Airband/discussions/447")
message(FATAL_ERROR "platform '${PLATFORM}' has been deprecated, see https://github.com/rtl-airband/RTLSDR-Airband/discussions/447")
# rpiv2 - Raspberry Pi 2 or Raspberry Pi 3 using Broadcom VideoCore IV GPU for FFT
# NOTE: use 'native' to not use the GPU for FFT
elseif(PLATFORM STREQUAL "rpiv2")
Expand Down
12 changes: 6 additions & 6 deletions src/config.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@
*
* Copyright (c) 2015-2021 Tomasz Lemiech <[email protected]>
*
* 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 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 2
* 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
* 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/>.
* along with this program; if not, see <https://www.gnu.org/licenses/>.
*/

#include <assert.h>
Expand Down
12 changes: 6 additions & 6 deletions src/config.h.in
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@
*
* Copyright (c) 2015-2021 Tomasz Lemiech <[email protected]>
*
* 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 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 2
* 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
* 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/>.
* along with this program; if not, see <https://www.gnu.org/licenses/>.
*/

#ifndef _CONFIG_H
Expand Down
12 changes: 6 additions & 6 deletions src/ctcss.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@
*
* Copyright (C) 2022-2023 charlie-foxtrot
*
* 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 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 2
* 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
* 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/>.
* along with this program; if not, see <https://www.gnu.org/licenses/>.
*/

#include <math.h> // M_PI
Expand Down
12 changes: 6 additions & 6 deletions src/ctcss.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@
*
* Copyright (C) 2022-2023 charlie-foxtrot
*
* 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 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 2
* 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
* 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/>.
* along with this program; if not, see <https://www.gnu.org/licenses/>.
*/

#ifndef _CTCSS_H
Expand Down
12 changes: 6 additions & 6 deletions src/filters.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@
*
* Copyright (C) 2022-2023 charlie-foxtrot
*
* 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 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 2
* 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
* 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/>.
* along with this program; if not, see <https://www.gnu.org/licenses/>.
*/

#include "logging.h" // debug_print()
Expand Down
12 changes: 6 additions & 6 deletions src/filters.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@
*
* Copyright (C) 2022-2023 charlie-foxtrot
*
* 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 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 2
* 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
* 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/>.
* along with this program; if not, see <https://www.gnu.org/licenses/>.
*/

#ifndef _FILTERS_H
Expand Down
Loading

0 comments on commit 21a8caf

Please sign in to comment.