beeps 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ee41e529e2fef19d549eaafc03a59d77bda6b457b3d918c9f5c35fcf929ef73
-  data.tar.gz: d630e5ae0784e1cb5a68a925cbed99674166d8acad08569e46f7021dc564412e
+  metadata.gz: fef183d5b385e0ac3007dd66f7a452940e2c62ad55fb16ce5d12d20dc8dcbf30
+  data.tar.gz: 78837bb17ed3785fd6bd4085dc2ea3c4289ecd74c4f1cd3db67b539815503149
 SHA512:
-  metadata.gz: 7dacf730d824d5cbc175ca6d3c9e4dc39aa69f7b30cc4e270240aa3ab9f0a820a07119146f1d0d55cc0487771d71f9da7cc6435760f6e5ebd40edd3f585756fa
-  data.tar.gz: e981523810d79702c73f154a96877dd3cf8d7c05683a5df2f4d6717359670829325bd439ae6374b1f291fbdf871f36e83ee2d112fd5abfeeac75f11855ee8719
+  metadata.gz: 180665f71bf309872fde63eba13765cab167ac5359c058cab282b354a7aa9082781826eddf03d6625fb1ae46401254e9c0504886d23fd330f8f4a61f85f4c43c
+  data.tar.gz: 7b0178557895cc5e48ad1b9ce90f3a4e4dca91af297ebc6a038719e7498c75b9f46cf6d96aa0ec48ef2a1fc9281c3ac83653ba21b538a190310948a5a2e77014

data/.doc/ext/beeps/mixer.cpp

@@ -0,0 +1,85 @@
+#include "beeps/ruby/filter.h"
+
+
+#include "beeps/ruby/processor.h"
+#include "defs.h"
+
+
+RUCY_DEFINE_WRAPPER_VALUE_FROM_TO(BEEPS_EXPORT, Beeps::Mixer)
+
+#define THIS  to<Beeps::Mixer*>(self)
+
+#define CHECK RUCY_CHECK_OBJ(Beeps::Mixer, self)
+
+
+static
+VALUE alloc(VALUE klass)
+{
+	return value(new Beeps::RubyProcessor<Beeps::Mixer>, klass);
+}
+
+static
+VALUE add_input(VALUE self, VALUE inputs)
+{
+	CHECK;
+
+	const Value* array = inputs.as_array();
+	size_t size        = inputs.size();
+
+	for (size_t i = 0; i < size; ++i)
+		THIS->add_input(to<Beeps::Processor*>(array[i]));
+	return inputs;
+}
+
+static
+VALUE remove_input(VALUE self, VALUE inputs)
+{
+	CHECK;
+
+	const Value* array = inputs.as_array();
+	size_t size        = inputs.size();
+
+	for (size_t i = 0; i < size; ++i)
+		THIS->remove_input(to<Beeps::Processor*>(array[i]));
+	return inputs;
+}
+
+static
+VALUE each_input(VALUE self)
+{
+	CHECK;
+
+	Value ret;
+	for (auto& input : *THIS)
+		ret = rb_yield(value(input.get()));
+	return ret;
+}
+
+
+static Class cMixer;
+
+void
+Init_beeps_mixer ()
+{
+	Module mBeeps = rb_define_module("Beeps");
+
+	cMixer = mBeeps.define_class("Mixer", Beeps::processor_class());
+	rb_define_alloc_func(cMixer, alloc);
+	cMixer.define_method(   "add_input!",    add_input);
+	cMixer.define_method("remove_input!", remove_input);
+	cMixer.define_method(  "each_input!",   each_input);
+}
+
+
+namespace Beeps
+{
+
+
+	Class
+	mixer_class ()
+	{
+		return cMixer;
+	}
+
+
+}// Beeps

data/.doc/ext/beeps/native.cpp

@@ -14,6 +14,7 @@ void Init_beeps_file_in ();
 void Init_beeps_mic_in ();
 
 void Init_beeps_gain ();
+void Init_beeps_mixer ();
 void Init_beeps_envelope ();
 void Init_beeps_time_stretch ();
 void Init_beeps_pitch_shift ();
@@ -44,6 +45,7 @@ extern "C" void
 	Init_beeps_mic_in();
 
 	Init_beeps_gain();
+	Init_beeps_mixer();
 	Init_beeps_envelope();
 	Init_beeps_time_stretch();
 	Init_beeps_pitch_shift();

data/.doc/ext/beeps/oscillator.cpp

@@ -35,6 +35,37 @@ VALUE get_type(VALUE self)
 	return value(THIS->type());
 }
 
+static
+VALUE set_samples(VALUE self, VALUE samples)
+{
+	CHECK;
+
+	Value* array = samples.as_array();
+	size_t size  = samples.size();
+
+	std::vector<float> floats;
+	floats.reserve(size);
+	for (size_t i = 0; i < size; ++i)
+		floats.push_back(to<float>(array[i]));
+
+	THIS->set_samples(&floats[0], floats.size());
+}
+
+static
+VALUE each_sample(VALUE self)
+{
+	CHECK;
+
+	const float* floats = THIS->samples();
+	size_t size         = THIS->nsamples();
+	if (!floats || size == 0) return Qnil;
+
+	Value ret;
+	for (size_t i = 0; i < size; ++i)
+		ret = rb_yield(value(floats[i]));
+	return ret;
+}
+
 static
 VALUE set_frequency(VALUE self, VALUE frequency)
 {
@@ -52,6 +83,23 @@ VALUE get_frequency(VALUE self)
 	return value(THIS->frequency());
 }
 
+static
+VALUE set_phase(VALUE self, VALUE phase)
+{
+	CHECK;
+
+	THIS->set_phase(to<float>(phase));
+	return phase;
+}
+
+static
+VALUE get_phase(VALUE self)
+{
+	CHECK;
+
+	return value(THIS->phase());
+}
+
 
 static Class cOscillator;
 
@@ -64,14 +112,20 @@ Init_beeps_oscillator ()
 	rb_define_alloc_func(cOscillator, alloc);
 	rb_define_method(cOscillator, "type=", RUBY_METHOD_FUNC(set_type), 1);
 	rb_define_method(cOscillator, "type", RUBY_METHOD_FUNC(get_type), 0);
+	rb_define_method(cOscillator, "samples=", RUBY_METHOD_FUNC(set_samples), 1);
+	cOscillator.define_method("each_sample!", each_sample);
 	rb_define_method(cOscillator, "frequency=", RUBY_METHOD_FUNC(set_frequency), 1);
 	rb_define_method(cOscillator, "frequency", RUBY_METHOD_FUNC(get_frequency), 0);
+	rb_define_method(cOscillator, "phase=", RUBY_METHOD_FUNC(set_phase), 1);
+	rb_define_method(cOscillator, "phase", RUBY_METHOD_FUNC(get_phase), 0);
 
 	cOscillator.define_const("TYPE_NONE", Beeps::Oscillator::TYPE_NONE);
 	cOscillator.define_const("SINE",      Beeps::Oscillator::SINE);
 	cOscillator.define_const("TRIANGLE",  Beeps::Oscillator::TRIANGLE);
 	cOscillator.define_const("SQUARE",    Beeps::Oscillator::SQUARE);
 	cOscillator.define_const("SAWTOOTH",  Beeps::Oscillator::SAWTOOTH);
+	cOscillator.define_const("NOISE",     Beeps::Oscillator::NOISE);
+	cOscillator.define_const("SAMPLES",   Beeps::Oscillator::SAMPLES);
 }
 
 

data/.doc/ext/beeps/processor.cpp

@@ -11,6 +11,8 @@ RUCY_DEFINE_WRAPPER_VALUE_FROM_TO(BEEPS_EXPORT, Beeps::Processor)
 
 #define CHECK RUCY_CHECK_OBJ(Beeps::Processor, self)
 
+#define CALL(fun) RUCY_CALL_SUPER(THIS, fun)
+
 
 static
 VALUE alloc(VALUE klass)
@@ -44,6 +46,13 @@ VALUE get_input(VALUE self)
 	return value(THIS->input());
 }
 
+static
+VALUE on_start(VALUE self)
+{
+	CHECK;
+	CALL(on_start());
+}
+
 
 static Class cProcessor;
 
@@ -57,6 +66,7 @@ Init_beeps_processor ()
 	rb_define_method(cProcessor, "reset", RUBY_METHOD_FUNC(reset), 0);
 	rb_define_method(cProcessor, "input=", RUBY_METHOD_FUNC(set_input), 1);
 	rb_define_method(cProcessor, "input", RUBY_METHOD_FUNC(get_input), 0);
+	rb_define_method(cProcessor, "on_start", RUBY_METHOD_FUNC(on_start), 0);
 }
 
 

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+## Pull Requests Not Accepted 🚫
+
+Thank you for your interest in contributing!
+However, this repository does not accept pull requests directly.
+
+### Where to Contribute?
+
+Please submit your changes to the [xord/all](https://github.com/xord/all) monorepo, which serves as the primary repository for all our main libraries.
+
+For more details, please refer to our [contribution guidelines](../CONTRIBUTING.md).
+
+Thanks for your understanding! 🙌

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contribution Guide
+
+Thank you for your interest in contributing!
+However, this repository does not accept pull requests.
+Instead, please submit your changes to the [xord/all](https://github.com/xord/all) monorepo, which serves as the primary repository for all our main libraries.
+
+For any questions, feel free to open an issue.

data/ChangeLog.md

@@ -1,6 +1,35 @@
 # beeps ChangeLog
 
 
+## [v0.3.5] - 2025-03-24
+
+- Add PULL_REQUEST_TEMPLATE.md
+- Add CONTRIBUTING.md
+
+
+## [v0.3.4] - 2025-03-07
+
+- Add Mixer class
+- Add Processor#add_input
+- Add Processor#on_start
+- Add new oscillator type NOISE
+- Add new oscillator type SAMPLES, and add Oscillator#samples=
+- Add Oscillator#phase/phase=
+- Add 'openal' to msys2_mingw_dependencies
+
+- Processor.new can take inputs
+- Processor#<< returns self
+- Square and sawtooth oscillators discard the first some amount of samples
+- Oscillator::set_type() takes over the phase value
+- Noise oscillator can take frequency parameter
+- Gain#initialize can take param for gain
+- Envelop's default attack, decay, and release time are changed from 0.01 to 0.005
+- Envelop#initialize can take attack, decay, sustain, and release params
+- The attack and release can be canceled by passing 0 to the attack_time and release_time of the Envelope
+
+- Temporarily delete Processor#<< to review specifications
+
+
 ## [v0.3.3] - 2025-01-23
 
 - Update dependencies

data/README.md

@@ -1,4 +1,47 @@
+# Beeps - Plays beep sound
 
-# Beeps - Plays beep sound.
+![License](https://img.shields.io/github/license/xord/beeps)
+![Build Status](https://github.com/xord/beeps/actions/workflows/test.yml/badge.svg)
+![Gem Version](https://badge.fury.io/rb/beeps.svg)
 
- by xordog@gmail.com
+## ⚠️  Notice
+
+This repository is a read-only mirror of our monorepo.
+We do not accept pull requests or direct contributions here.
+
+### 🔄 Where to Contribute?
+
+All development happens in our [xord/all](https://github.com/xord/all) monorepo, which contains all our main libraries.
+If you'd like to contribute, please submit your changes there.
+
+For more details, check out our [Contribution Guidelines](./CONTRIBUTING.md).
+
+Thanks for your support! 🙌
+
+## 🚀 About
+
+**Beeps** is a simple utility that plays a beep sound.
+
+It is designed to be lightweight and easy to use, making it perfect for adding audible notifications to your scripts or applications.
+
+## 📦 Installation
+
+Add this line to your Gemfile:
+```ruby
+$ gem 'beeps'
+```
+
+Then, install gem:
+```bash
+$ bundle install
+```
+
+Or install it directly:
+```bash
+$ gem install beeps
+```
+
+## 📜 License
+
+**Beeps** is licensed under the MIT License.
+See the [LICENSE](./LICENSE) file for details.

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.5

data/beeps.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |s|
   s.platform              = Gem::Platform::RUBY
   s.required_ruby_version = '>= 3.0.0'
 
-  s.add_dependency 'xot',  '~> 0.3.3', '>= 0.3.3'
-  s.add_dependency 'rucy', '~> 0.3.3', '>= 0.3.3'
+  s.add_dependency 'xot',  '~> 0.3.5', '>= 0.3.5'
+  s.add_dependency 'rucy', '~> 0.3.5', '>= 0.3.5'
 
   s.files            = `git ls-files`.split $/
   s.executables      = s.files.grep(%r{^bin/}) {|f| File.basename f}
@@ -34,5 +34,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = rdocs.to_a
   s.has_rdoc         = true
 
+  s.metadata['msys2_mingw_dependencies'] = 'openal'
+
   s.extensions << 'Rakefile'
 end

data/ext/beeps/mixer.cpp

@@ -0,0 +1,89 @@
+#include "beeps/ruby/filter.h"
+
+
+#include "beeps/ruby/processor.h"
+#include "defs.h"
+
+
+RUCY_DEFINE_WRAPPER_VALUE_FROM_TO(BEEPS_EXPORT, Beeps::Mixer)
+
+#define THIS  to<Beeps::Mixer*>(self)
+
+#define CHECK RUCY_CHECK_OBJ(Beeps::Mixer, self)
+
+
+static
+RUCY_DEF_ALLOC(alloc, klass)
+{
+	return value(new Beeps::RubyProcessor<Beeps::Mixer>, klass);
+}
+RUCY_END
+
+static
+RUCY_DEF1(add_input, inputs)
+{
+	CHECK;
+
+	const Value* array = inputs.as_array();
+	size_t size        = inputs.size();
+
+	for (size_t i = 0; i < size; ++i)
+		THIS->add_input(to<Beeps::Processor*>(array[i]));
+	return inputs;
+}
+RUCY_END
+
+static
+RUCY_DEF1(remove_input, inputs)
+{
+	CHECK;
+
+	const Value* array = inputs.as_array();
+	size_t size        = inputs.size();
+
+	for (size_t i = 0; i < size; ++i)
+		THIS->remove_input(to<Beeps::Processor*>(array[i]));
+	return inputs;
+}
+RUCY_END
+
+static
+RUCY_DEF0(each_input)
+{
+	CHECK;
+
+	Value ret;
+	for (auto& input : *THIS)
+		ret = rb_yield(value(input.get()));
+	return ret;
+}
+RUCY_END
+
+
+static Class cMixer;
+
+void
+Init_beeps_mixer ()
+{
+	Module mBeeps = define_module("Beeps");
+
+	cMixer = mBeeps.define_class("Mixer", Beeps::processor_class());
+	cMixer.define_alloc_func(alloc);
+	cMixer.define_method(   "add_input!",    add_input);
+	cMixer.define_method("remove_input!", remove_input);
+	cMixer.define_method(  "each_input!",   each_input);
+}
+
+
+namespace Beeps
+{
+
+
+	Class
+	mixer_class ()
+	{
+		return cMixer;
+	}
+
+
+}// Beeps

data/ext/beeps/native.cpp

@@ -14,6 +14,7 @@ void Init_beeps_file_in ();
 void Init_beeps_mic_in ();
 
 void Init_beeps_gain ();
+void Init_beeps_mixer ();
 void Init_beeps_envelope ();
 void Init_beeps_time_stretch ();
 void Init_beeps_pitch_shift ();
@@ -44,6 +45,7 @@ extern "C" void
 	Init_beeps_mic_in();
 
 	Init_beeps_gain();
+	Init_beeps_mixer();
 	Init_beeps_envelope();
 	Init_beeps_time_stretch();
 	Init_beeps_pitch_shift();

data/ext/beeps/oscillator.cpp

@@ -38,6 +38,39 @@ RUCY_DEF0(get_type)
 }
 RUCY_END
 
+static
+RUCY_DEF1(set_samples, samples)
+{
+	CHECK;
+
+	Value* array = samples.as_array();
+	size_t size  = samples.size();
+
+	std::vector<float> floats;
+	floats.reserve(size);
+	for (size_t i = 0; i < size; ++i)
+		floats.push_back(to<float>(array[i]));
+
+	THIS->set_samples(&floats[0], floats.size());
+}
+RUCY_END
+
+static
+RUCY_DEF0(each_sample)
+{
+	CHECK;
+
+	const float* floats = THIS->samples();
+	size_t size         = THIS->nsamples();
+	if (!floats || size == 0) return Qnil;
+
+	Value ret;
+	for (size_t i = 0; i < size; ++i)
+		ret = rb_yield(value(floats[i]));
+	return ret;
+}
+RUCY_END
+
 static
 RUCY_DEF1(set_frequency, frequency)
 {
@@ -57,6 +90,25 @@ RUCY_DEF0(get_frequency)
 }
 RUCY_END
 
+static
+RUCY_DEF1(set_phase, phase)
+{
+	CHECK;
+
+	THIS->set_phase(to<float>(phase));
+	return phase;
+}
+RUCY_END
+
+static
+RUCY_DEF0(get_phase)
+{
+	CHECK;
+
+	return value(THIS->phase());
+}
+RUCY_END
+
 
 static Class cOscillator;
 
@@ -69,14 +121,20 @@ Init_beeps_oscillator ()
 	cOscillator.define_alloc_func(alloc);
 	cOscillator.define_method("type=", set_type);
 	cOscillator.define_method("type",  get_type);
+	cOscillator.define_method(     "samples=", set_samples);
+	cOscillator.define_method("each_sample!", each_sample);
 	cOscillator.define_method("frequency=", set_frequency);
 	cOscillator.define_method("frequency",  get_frequency);
+	cOscillator.define_method("phase=", set_phase);
+	cOscillator.define_method("phase",  get_phase);
 
 	cOscillator.define_const("TYPE_NONE", Beeps::Oscillator::TYPE_NONE);
 	cOscillator.define_const("SINE",      Beeps::Oscillator::SINE);
 	cOscillator.define_const("TRIANGLE",  Beeps::Oscillator::TRIANGLE);
 	cOscillator.define_const("SQUARE",    Beeps::Oscillator::SQUARE);
 	cOscillator.define_const("SAWTOOTH",  Beeps::Oscillator::SAWTOOTH);
+	cOscillator.define_const("NOISE",     Beeps::Oscillator::NOISE);
+	cOscillator.define_const("SAMPLES",   Beeps::Oscillator::SAMPLES);
 }
 
 

data/ext/beeps/processor.cpp

@@ -11,6 +11,8 @@ RUCY_DEFINE_WRAPPER_VALUE_FROM_TO(BEEPS_EXPORT, Beeps::Processor)
 
 #define CHECK RUCY_CHECK_OBJ(Beeps::Processor, self)
 
+#define CALL(fun) RUCY_CALL_SUPER(THIS, fun)
+
 
 static
 RUCY_DEF_ALLOC(alloc, klass)
@@ -48,6 +50,14 @@ RUCY_DEF0(get_input)
 }
 RUCY_END
 
+static
+RUCY_DEF0(on_start)
+{
+	CHECK;
+	CALL(on_start());
+}
+RUCY_END
+
 
 static Class cProcessor;
 
@@ -61,6 +71,7 @@ Init_beeps_processor ()
 	cProcessor.define_method("reset", reset);
 	cProcessor.define_method("input=", set_input);
 	cProcessor.define_method("input",  get_input);
+	cProcessor.define_method("on_start", on_start);
 }
 
 

data/include/beeps/filter.h

@@ -37,6 +37,47 @@ namespace Beeps
 	};// Gain
 
 
+	class Mixer : public Filter
+	{
+
+		typedef Filter Super;
+
+		public:
+
+			typedef std::vector<Processor::Ref> InputList;
+
+			typedef InputList::      iterator       iterator;
+
+			typedef InputList::const_iterator const_iterator;
+
+			Mixer (Processor* input = NULL);
+
+			virtual ~Mixer ();
+
+			virtual void    add_input (Processor* input);
+
+			virtual void remove_input (Processor* input);
+
+			virtual       iterator begin ();
+
+			virtual const_iterator begin () const;
+
+			virtual       iterator end ();
+
+			virtual const_iterator end () const;
+
+			virtual void filter (
+				Context* context, Signals* signals, uint* offset) override;
+
+			virtual operator bool () const override;
+
+			struct Data;
+
+			Xot::PImpl<Data> self;
+
+	};// Mixer
+
+
 	class Envelope : public Filter
 	{
 

data/include/beeps/generator.h

@@ -18,10 +18,15 @@ namespace Beeps
 
 		public:
 
-			enum Type {TYPE_NONE = 0, SINE, TRIANGLE, SQUARE, SAWTOOTH};
+			enum Type
+			{
+				TYPE_NONE = 0, SINE, TRIANGLE, SQUARE, SAWTOOTH, NOISE, SAMPLES
+			};
 
 			Oscillator (Type type = SINE);
 
+			Oscillator (float* samples, size_t size);
+
 			virtual ~Oscillator ();
 
 			virtual void reset () override;
@@ -30,10 +35,20 @@ namespace Beeps
 
 			virtual Type     type () const;
 
+			virtual void     set_samples (float* samples, size_t size);
+
+			virtual const float* samples () const;
+
+			virtual size_t      nsamples () const;
+
 			virtual void set_frequency (float frequency);
 
 			virtual float    frequency () const;
 
+			virtual void set_phase (float phase);
+
+			virtual float    phase () const;
+
 			virtual void generate (
 				Context* context, Signals* signals, uint* offset) override;
 

data/include/beeps/processor.h

@@ -37,6 +37,8 @@ namespace Beeps
 
 			virtual const Processor* input () const;
 
+			virtual void on_start ();
+
 			virtual operator bool () const;
 
 			virtual bool operator ! () const;