radio 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,202 @@
+#!text
+                                 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.

data/README.md

@@ -1 +1,67 @@
-Amateur radio software
+# Twenty-First Century Amateur Radio
+
+An http server for interactive digital signal processing.
+The mission is to find a solution that enables development of radios
+using open and accessible technologies such as HTML and Javascript.
+
+## Status
+
+ * HTTP Server: Working
+ * Spectrum Analyzer: Working
+ * Rig Control: current WIP
+ * PSK31: LPCM only, next WIP
+ * SSB: Not Started
+ * CW: Not Started
+ * User Interface: experimental, please contribute
+ * More drivers: always a WIP, please contribute
+
+## Installation
+
+Please use the wiki for verbose install directions: https://github.com/ham21/radio/wiki
+
+### Dependencies
+
+Ubuntu and Debian:
+
+    sudo apt-get install alsa-base libusb-1.0 build-essential libfftw3-dev libz-dev libssl-dev libreadline-dev
+    sudo usermod -a -G audio your_username
+    
+Apple OSX using ports:
+
+    port install fftw-3 libusb
+
+Apple OSX using homebrew:
+
+    brew install fftw libusb
+    
+Windows does not have dependencies; begin with Ruby install.
+    
+### Ruby
+
+This project requires Ruby 1.9. If your OS came with Ruby, it's likely 1.8
+and not suitable. Your choice to install Ruby 1.9 directly or with the rvm
+tool. Rubinius should work in 1.9 mode but JRuby will not.
+
+http://www.ruby-lang.org/
+or
+http://beginrescueend.com/rvm/install/
+
+### Ruby Gems
+
+Install the radio software and operating system specifics for Ruby.
+
+Linux:
+
+    gem install radio alsa
+
+Apple OSX:
+
+    gem install radio coreaudio
+    
+Windows:
+
+    gem install radio win32-sound
+
+## Operation
+
+Execute ```radio-server``` then open your web browser to http://localhost:7373/

data/bin/radio-server

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+local_filename = File.expand_path '../lib/radio', File.dirname(__FILE__)
+if File.exist? local_filename + '.rb'
+  require local_filename
+else
+  require 'radio'
+end
+Radio.start

data/lib/radio.rb

@@ -1,5 +1,26 @@
+# Copyright 2012 The ham21/radio Authors
+#
+# 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.
+
+
+require 'fftw3'
+require 'thin'
+
+# Suffer load order here
 %w{
-  radio/psk31/*.rb
+  radio/rig/*.rb
+  radio/*.rb
+  radio/**/*.rb
 }.each do |glob|
   Dir.glob(File.expand_path(glob, File.dirname(__FILE__))).each do |filename|
     require filename
@@ -11,4 +32,23 @@ class Radio
   PI = Math::PI.freeze
   PI2 = (8.0 * Math.atan(1.0)).freeze
   
+  def self.start
+    
+    app = Rack::Builder.new do
+      use Rack::CommonLogger
+      use Rack::ShowExceptions
+      use Rack::Lint
+      run @radio = Radio::HTTP::Server.new
+      # Thin threading model
+      def deferred? env
+        @radio.deferred? env
+      end
+    end
+    
+    EventMachine.run {
+      Rack::Handler::Thin.run app, :Port => 7373, :Host => '0.0.0.0'
+    }
+
+  end
+
 end

data/lib/radio/controls/null.rb

@@ -0,0 +1,32 @@
+# Copyright 2012 The ham21/radio Authors
+#
+# 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.
+
+
+class Radio
+  module Controls
+    class Null
+    
+      attr_accessor :lo
+      
+      def initialize
+        @lo = 0.0
+      end
+
+      def stop
+        #noop
+      end
+
+    end
+  end
+end

data/lib/radio/controls/si570avr.rb

@@ -0,0 +1,77 @@
+# Copyright 2012 The ham21/radio Authors
+#
+# 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.
+
+require 'libusb'
+
+class Radio
+  module Controls
+
+    # Support for Silicon Labs Si570 using Atmel AVR USB device.
+    # see: http://pe0fko.nl/SR-V9-Si570/
+    # For SoftRock KB9YIG radio kits et al.
+    class Si570AVR
+    
+      RT_IN = LIBUSB::REQUEST_TYPE_VENDOR | LIBUSB::RECIPIENT_DEVICE | LIBUSB::ENDPOINT_IN
+      RT_OUT = LIBUSB::REQUEST_TYPE_VENDOR | LIBUSB::RECIPIENT_DEVICE | LIBUSB::ENDPOINT_OUT
+      DWELL = 0.1 #seconds
+
+      def initialize options={}
+        @divisor = options.delete(:divisor) || 4
+        index = options.delete(:index) || 0
+        @options = options
+        if options.empty?
+          @options[:idVendor] ||= 0x16c0
+          @options[:idProduct] ||= 0x05dc
+        end
+        @device = LIBUSB::Context.new.devices(options)[index]
+        raise 'USB Device Not Found' unless @device
+      end
+  
+      def lo= freq
+        data = [freq * (1<<21) * @divisor].pack('L')
+        @device.open do |handle|
+          handle.claim_interface(0)
+          handle.control_transfer(
+            :bmRequestType => RT_OUT, :bRequest => 0x32, 
+            :wValue => 0, :wIndex => 0, :dataOut => data
+          )
+          handle.release_interface(0)
+        end
+        @lo = nil
+      end
+  
+      def lo
+        return @lo if @lo and Time.now < @lo_expires
+        data = nil
+        @device.open do |handle|
+          handle.claim_interface 0
+          data = handle.control_transfer(
+            :bmRequestType => RT_IN, :bRequest => 0x3a, 
+            :wValue => 0, :wIndex => 0, :dataIn => 4
+          )
+          handle.release_interface 0
+        end
+        @lo_expires = Time.now + DWELL
+        @lo = (data.unpack('L')[0].to_f / (1<<21) / @divisor).round 6
+      end
+    
+      def stop
+        #noop
+      end
+
+    end
+  end
+    
+end
+

data/lib/radio/filter.rb

@@ -0,0 +1,69 @@
+# Copyright 2012 The ham21/radio Authors
+#
+# 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.
+
+
+class Radio
+  
+  # This generic Filter class will optimize by replacing its #call
+  # with an optimized version from a module.  The type of data
+  # and initializer options determine the module name to load.
+  class Filter
+
+    # Filters are built with mixing first and fir last.
+    # Chain multiple filters to get other effects.
+    # Make sure unused options don't test true.
+    # Filter.new(:mix => phase_inc, :decimate => int, :fir => array)
+    def initialize options
+      @options = options
+    end
+
+    # The first call with data is when we decide which module is optimal.
+    def call data, &block
+      mod_name = 'Each'
+      if Enumerable === data
+        first = data.first
+      elsif NArray === data
+        first = data[0]
+      else
+        first = data
+        mod_name = ''
+      end
+      if Complex === first
+        mod_name = 'Complex' + mod_name
+      elsif Float === first
+        mod_name = 'Float' + mod_name
+      else
+        raise "Unknown data type: #{first.class}"
+      end
+      mod_name += 'Mix' if @options[:mix]
+      mod_name += 'Decimate' if @options[:decimate]
+      mod_name += 'Fir' if @options[:fir]
+      this_call = method :call
+      extend eval mod_name
+      if this_call == method(:call)
+        raise "#{mod_name} must override #call(data)"
+      end
+      setup data
+      call data, &block
+    end
+    
+    # implement in modules, if you desire.
+    # have everything call super, this will catch.
+    def setup data
+      # noop
+    end
+    
+  end
+end
+