ffi-shout 0.1.0

data/lib/shout/native/handle.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Shout
+  module Native
+    # An owned shout_t handle, as returned by Native.shout_new. It is released
+    # with shout_free when it is garbage collected.
+    class Handle < FFI::AutoPointer
+      def self.release(ptr)
+        Native.shout_free(ptr)
+      end
+
+      # Called by FFI to wrap the pointer that shout_new returns.
+      def self.from_native(ptr, ctx)
+        raise MallocError, "Unable to allocate shout_t structure" if ptr.null?
+
+        super
+      end
+    end
+  end
+end

data/lib/shout/native/metadata_handle.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Shout
+  module Native
+    # An owned shout_metadata_t handle, as returned by
+    # Native.shout_metadata_new. It is released with shout_metadata_free when
+    # it is garbage collected.
+    class MetadataHandle < FFI::AutoPointer
+      def self.release(ptr)
+        Native.shout_metadata_free(ptr)
+      end
+
+      # Called by FFI to wrap the pointer that shout_metadata_new returns.
+      def self.from_native(ptr, ctx)
+        raise MallocError, "Unable to allocate shout_metadata_t structure" if ptr.null?
+
+        super
+      end
+    end
+  end
+end

data/lib/shout/native.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "shout/constants"
+require "shout/library_version"
+
+module Shout
+  # The libshout bindings: an FFI::Library with every function in shout.h.
+  module Native
+    extend FFI::Library
+
+    ffi_lib ["shout", "libshout.so.3", "libshout.so"]
+
+    # Attached first, so the version check below can run before the other
+    # functions: attaching a function that an older libshout lacks would fail
+    # with an unclear FFI::NotFoundError.
+    attach_function :shout_version, %i[pointer pointer pointer], :string
+    LibraryVersion.ensure_supported!
+  end
+end
+
+require "shout/native/enums"
+require "shout/native/handle"
+require "shout/native/metadata_handle"
+require "shout/native/functions"

data/lib/shout/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Shout
+  VERSION = "0.1.0"
+end

data/lib/shout.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "ffi"
+require "shout/version"
+require "shout/constants"
+require "shout/error"
+require "shout/native"
+require "shout/delegation"
+require "shout/configuration"
+require "shout/metadata"
+require "shout/http_metadata"
+require "shout/connection"
+
+# Ruby bindings for libshout, the streaming library for Icecast. Start with
+# Shout::Connection; the raw libshout functions live in Shout::Native.
+module Shout
+  Native.shout_init
+
+  # The version of the loaded libshout library.
+  def self.version
+    LibraryVersion.new
+  end
+
+  def self.new(**, &)
+    Connection.new(**, &)
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: ffi-shout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roel van Dijk
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: Ruby FFI wrapper around libshout for streaming to Icecast servers.
+email:
+- roel@rustradio.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/ffi-shout.rb
+- lib/shout.rb
+- lib/shout/configuration.rb
+- lib/shout/connection.rb
+- lib/shout/constants.rb
+- lib/shout/delegation.rb
+- lib/shout/error.rb
+- lib/shout/http_metadata.rb
+- lib/shout/library_version.rb
+- lib/shout/metadata.rb
+- lib/shout/native.rb
+- lib/shout/native/enums.rb
+- lib/shout/native/functions.rb
+- lib/shout/native/handle.rb
+- lib/shout/native/metadata_handle.rb
+- lib/shout/version.rb
+homepage: https://github.com/rdvdijk/ffi-shout
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/rdvdijk/ffi-shout
+  bug_tracker_uri: https://github.com/rdvdijk/ffi-shout/issues
+  changelog_uri: https://github.com/rdvdijk/ffi-shout/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.23
+specification_version: 4
+summary: Easily connect and stream audio/metadata to Icecast using libshout.
+test_files: []