ao 0.0.3

data/example/raw2wav.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+#-*- coding: utf-8 -*-
+
+#
+# RAW to WAV converter
+# (bit: 16bit, rate: 44100Hz, channel: 2ch,
+#  endian: native, matrix: default, option: default)
+#
+
+require 'audio/output'
+
+unless ARGV[1]
+  puts('ex) ./raw2wav.rb input.raw output.wav')
+  exit(1)
+end
+
+input  = ARGV[0]
+output = ARGV[1]
+ao = 
+raise unless File.file?(input)
+Audio::FileOutput.new(driver_id: Audio::Info.driver_id('wav'),
+                      filename: output){|ao|
+  File.open(input){|f|
+    while buffer = f.read(4096)
+      ao.play(buffer)
+    end
+  }
+}

data/example/rawplay.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+#-*- coding: utf-8 -*-
+
+#
+# Simple RAW Audio Player
+# (bits: 16bit, rate: 44100Hz, channels: 2ch,
+#  byte_format: Little endian,
+#  matrix: default, option: default)
+#
+
+require 'audio/output'
+
+ARGV.each{|file|
+  if File.file?(file)
+    Audio::LiveOutput.new(bits: 16, rate: 44100, channels: 2,
+                          byte_format: Audio::Info::FMT_LITTLE){|ao|
+      File.open(file){|f|
+        while buffer = f.read(4096)
+          ao.play(buffer)
+        end
+      }
+    }
+  end
+}

data/ext/cao.h

@@ -0,0 +1,61 @@
+#ifndef CAO_H
+#define CAO_H
+
+#include <ruby.h>
+#include <ruby/thread.h>
+#include <ao/ao.h>
+#include <ao/os_types.h>
+
+extern VALUE cAudio;
+extern VALUE cAO_Live;
+extern VALUE cAO_File;
+extern VALUE cAO_Info;
+extern VALUE cAO_DeviceData;
+extern VALUE cAO_eAOError;
+extern VALUE cAO_eDeviceError;
+extern VALUE cAO_eUnknownError;
+
+extern VALUE cAO_eNoDriver;
+extern VALUE cAO_eNotFile;
+extern VALUE cAO_eNotLive;
+extern VALUE cAO_eBadOption;
+extern VALUE cAO_eDriverError;
+
+extern VALUE cAO_eFileError;
+extern VALUE cAO_eFileExists;
+extern VALUE cAO_eBadFormat;
+
+typedef struct sample_buffer {
+  int   bytes;
+  char *samples;
+  struct sample_buffer *next;
+} sample_buffer;
+
+typedef struct dev_data {
+  ao_device        *device;
+  ao_sample_format *format;
+  ao_option        *option;
+  sample_buffer    *buffer;
+  int               playing;
+} dev_data;
+
+dev_data * append_device(ao_device *dev,
+			 ao_sample_format *format,
+			 ao_option *option);
+void close_device(dev_data *devdat);
+void remove_device(dev_data *devdat);
+
+void init_exception(void);
+void init_constant(void);
+ao_sample_format *
+set_format(VALUE bits, VALUE rate, VALUE channels,
+	   VALUE byte_format, VALUE matrix);
+void free_format(ao_sample_format *format);
+ao_option * set_option(VALUE a_options);
+
+VALUE
+raodev_play(VALUE obj, VALUE output_samples);
+
+VALUE raodev_close(VALUE obj);
+VALUE raodev_closed(VALUE obj);
+#endif

data/ext/constant.c

@@ -0,0 +1,25 @@
+#include "cao.h"
+
+VALUE cAudio;
+VALUE cAO_Info;
+
+/* constants */
+void
+init_constant(void)
+{
+  /* ドライバがLive出力用であることを示す。 */
+  rb_define_const(cAO_Info, "TYPE_LIVE",  INT2FIX(AO_TYPE_LIVE));
+
+  /* ドライバがファイル出力用であることを示す。 */
+  rb_define_const(cAO_Info, "TYPE_FILE",  INT2FIX(AO_TYPE_FILE));
+
+  /* データのエンディアンがリトルエンディアンであることを示す。 */
+  rb_define_const(cAO_Info, "FMT_LITTLE", INT2FIX(AO_FMT_LITTLE));
+
+  /* データのエンディアンがビッグエンディアンであることを示す。 */
+  rb_define_const(cAO_Info, "FMT_BIG",    INT2FIX(AO_FMT_BIG));
+
+  /* データのエンディアンがホストのネイティブ形式であることを示す。 */
+  rb_define_const(cAO_Info, "FMT_NATIVE", INT2FIX(AO_FMT_NATIVE));
+  return;
+}

data/ext/device.c

@@ -0,0 +1,133 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+#include "cao.h"
+
+typedef struct play_data {
+  ao_device *device;
+  char *samples;
+  uint_32 bytes;
+  int result;
+} play_data;
+
+void *nogvl_ao_play(void *playdata){
+  play_data *pd = playdata;
+  pd->result =
+    ao_play(pd->device, pd->samples, pd->bytes);
+  return NULL;
+}
+
+/*
+ * デバイス一覧にデバイスを追加する。
+ * 追加した構造体へのポインタを返す。
+ * 割当に失敗した場合は-1を返す。
+ */
+dev_data *
+append_device(ao_device *dev, ao_sample_format *format,
+	      ao_option *option)
+{
+  dev_data *newdev;
+  newdev          = ALLOC(dev_data);
+  newdev->device  = dev;
+  newdev->format  = format;
+  newdev->option  = option;
+  newdev->playing = 0;
+  newdev->buffer  = NULL;
+  return newdev;
+}
+
+/*
+ * devdata構造体の持つデバイスを全て閉じ、
+ * またオプションとフォーマットの情報も削除する。
+ * メンバ変数にはNULLを設定する。
+ * devdata構造体自体は開放しない。
+ * (rubyのGCによって実行されるremove_device関数に任せるため)
+ */
+void
+close_device(dev_data *devdat){
+  if (devdat->device != NULL){
+    ao_close(devdat->device);
+  }
+  if (devdat->option != NULL){
+    ao_free_options(devdat->option);
+  }
+  if (devdat->format != NULL){
+    free_format(devdat->format);
+  }
+  devdat->device = NULL;
+  devdat->option = NULL;
+  devdat->format = NULL;
+  devdat->buffer = NULL;
+  return;
+}
+
+/* 
+ * GCが実行された時にデバイスを閉じ、構造体を開放する。
+ * この関数はopen_live()とopen_file()にてdev_data構造体をWrapする時に
+ * 構造体free用関数として渡す(rubyのGCにて呼ばれるよう設定する)
+ * Data_Wrap_Struct(cAO_DeviceData, 0, remove_device, devdat);
+ */
+void
+remove_device(dev_data *devdat)
+{
+  close_device(devdat);
+  free(devdat);
+  return;
+}
+
+/*
+ * call-seq: ao.play(output_samples)
+ *
+ * 受け取ったサンプルを再生する。
+ * (デバイスがファイル出力の場合はファイルに書き出す)
+ * 一度に渡せる量はunsigned int(32bit)の範囲まで。
+ *
+ * [arg1] buffer(String)
+ * [return] Fixnum
+*/
+VALUE
+raodev_play(VALUE obj, VALUE output_samples)
+{
+  dev_data  *devdata;
+  play_data  playdata;
+
+  Check_Type(output_samples, T_STRING);
+  Data_Get_Struct(rb_ivar_get(obj, rb_intern("@device")),
+		  dev_data, devdata);
+  playdata.device  = devdata->device;
+  playdata.bytes   = RSTRING_LENINT(output_samples);
+  if ((playdata.samples = malloc(playdata.bytes)) == NULL){
+    rb_raise(cAO_eAOError, "Memory allocation failure.");
+  }
+  memcpy(playdata.samples, StringValuePtr(output_samples), playdata.bytes);
+#ifdef HAVE_RB_THREAD_CALL_WITHOUT_GVL
+  rb_thread_call_without_gvl2(nogvl_ao_play, &playdata, NULL, NULL);
+  /*rb_thread_call_without_gvl2((rb_blocking_function_t *)nogvl_ao_play, &playdata, NULL, NULL);*/
+#else
+  nogvl_ao_play(&playdata);
+#endif
+  free(playdata.samples);
+  if (playdata.result == 0){
+    rb_raise(cAO_eDeviceError, "Device should be closed.");
+  }
+  return INT2FIX(playdata.result);
+}
+
+/*
+ * call-seq: ao.closed?
+ *
+ * デバイスが既に閉じられているか確認する。
+ * [return] true or false
+*/
+VALUE
+raodev_closed(VALUE obj)
+{
+  dev_data  *devdata;
+  Data_Get_Struct(rb_ivar_get(obj, rb_intern("@device")),
+		  dev_data, devdata);
+  if (devdata->device == NULL){
+    return Qtrue;
+  }
+  return Qfalse;
+}

data/ext/exception.c

@@ -0,0 +1,110 @@
+#include "cao.h"
+
+VALUE cAudio;
+VALUE cAO_Live;
+VALUE cAO_File;
+VALUE cAO_eAOError;
+VALUE cAO_eNoDriver;
+VALUE cAO_eNotFile;
+VALUE cAO_eNotLive;
+VALUE cAO_eBadOption;
+VALUE cAO_eDeviceError;
+VALUE cAO_eDriverError;
+VALUE cAO_eFileError;
+VALUE cAO_eFileExists;
+VALUE cAO_eBadFormat;
+VALUE cAO_eUnknownError;
+
+void init_exception(void)
+{
+  /*
+   * Document-class: Audio::LiveOutput::Error
+   *
+   * Audio::BasicOutputに関するエラーは
+   * Audio::BasicOutput::Errorを継承する。
+   */
+  cAO_eAOError =
+    rb_define_class_under(cAO_Live, "Error", rb_eStandardError);
+
+  /*
+   * Document-class: Audio::LiveOutput::NoDriver
+   *
+   * ドライバが見つからない時に発生する。
+   */
+  cAO_eNoDriver =
+    rb_define_class_under(cAO_Live, "NoDriver",     cAO_eAOError);
+
+  /*
+   * Document-class: Audio::LiveOutput::NotFile
+   *
+   * ドライバがファイル出力用のものではない時に発生する。
+   */
+  cAO_eNotFile =
+    rb_define_class_under(cAO_Live, "NotFile",      cAO_eAOError);
+
+  /*
+   * Document-class: Audio::LiveOutput::NotLive
+   *
+   * ドライバがデバイス出力用のものではない時に発生する。
+   */
+  cAO_eNotLive =
+    rb_define_class_under(cAO_Live, "NotLive",      cAO_eAOError);
+
+  /*
+   * Document-class: Audio::LiveOutput::BadOption
+   *
+   * ドライバに設定したオプションの値が不正である時に発生する。
+   */
+  cAO_eBadOption =
+    rb_define_class_under(cAO_Live, "BadOption",    cAO_eAOError);
+
+  /*
+   * Document-class: Audio::LiveOutput::DriverError
+   *
+   * ドライバに関するエラー。
+   */
+  cAO_eDriverError =
+    rb_define_class_under(cAO_Live, "DriverError",  cAO_eAOError);
+
+  /* 
+   * Document-class: Audio::LiveOutput::DeviceError
+   *
+   * デバイスに関するエラー。
+   */
+  cAO_eDeviceError =
+    rb_define_class_under(cAO_Live, "DeviceError",  cAO_eAOError);
+
+  /*
+   * Document-class: Audio::FileOutput::FileError
+   *
+   * ファイル出力に関するエラー。
+   */
+  cAO_eFileError =
+    rb_define_class_under(cAO_File, "FileError",    cAO_eAOError);
+
+  /* 
+   * Document-class: Audio::FileOutput::FileExists
+   *
+   * ファイル出力時の上書き禁止が設定されている時に
+   * 既にファイルが存在する場合に発生する。
+   */
+  cAO_eFileExists =
+    rb_define_class_under(cAO_File, "FileExists",   cAO_eAOError);
+
+  /*
+   * Document-class: Audio::FileOutput::Badformat
+   *
+   * オーディオ出力フォーマットが不正である場合発生する。
+   */
+  cAO_eBadFormat =
+    rb_define_class_under(cAO_File, "BadFormat",    cAO_eAOError);
+
+  /* 
+   * Document-class: Audio::LiveOutput::UnknownError
+   *
+   * 不明なエラー。
+   */
+  cAO_eUnknownError =
+    rb_define_class_under(cAO_Live, "UnknownError", cAO_eAOError);
+  return;
+}

data/ext/extconf.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+#-*- coding: utf-8 -*-
+
+require 'mkmf'
+
+dir_config('audio')
+have_header('ao/ao.h')
+have_header('ao/os_types.h')
+have_header('ao/plugin.h')
+have_library('ao')
+have_func('rb_thread_call_without_gvl')
+create_makefile('audio/outputc')

data/ext/info.c

@@ -0,0 +1,187 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include "cao.h"
+
+VALUE cAudio;
+VALUE cAO_Live;
+VALUE cAO_Info;
+VALUE cAO_eDriverError;
+VALUE cAO_eBadFormat;
+
+/*
+  ao_info構造体をRubyのHashに変換し返す。
+*/
+static VALUE
+ao_info2hash(ao_info *info)
+{
+  int opt_count;
+  VALUE ihash, optary;
+
+  ihash  = rb_hash_new();
+  optary = rb_ary_new();
+  rb_hash_aset(ihash, ID2SYM(rb_intern("type")), INT2FIX(info->type));
+  rb_hash_aset(ihash, ID2SYM(rb_intern("name")), rb_str_new2(info->name));
+  rb_hash_aset(ihash, ID2SYM(rb_intern("short_name")), rb_str_new2(info->short_name));
+  rb_hash_aset(ihash, ID2SYM(rb_intern("author")), rb_str_new2(info->author));
+  rb_hash_aset(ihash, ID2SYM(rb_intern("comment")), rb_str_new2(info->comment));
+  rb_hash_aset(ihash, ID2SYM(rb_intern("byte_format")), INT2FIX(info->preferred_byte_format));
+  rb_hash_aset(ihash, ID2SYM(rb_intern("priority")), INT2FIX(info->priority));
+  rb_hash_aset(ihash, ID2SYM(rb_intern("opt_count")), INT2FIX(info->option_count));
+  for(opt_count=0; opt_count<info->option_count; opt_count++){
+    rb_ary_push(optary, rb_str_new2(info->options[opt_count]));
+  }
+  rb_hash_aset(ihash, ID2SYM(rb_intern("options")), optary);
+  return ihash;
+}
+
+/* driver information */
+/*
+ * call-seq: Audio::Info.driver_id(short_name)
+ *
+ * short_nameを元にDriverIDを検索する。
+ * 見つからなかった場合はnilを返す。
+ *
+ * [arg1] short_name(String)
+ * [return] DriverID or nil
+ */
+static VALUE
+rao_driver_id(VALUE obj, VALUE short_name)
+{
+  int driver_id;
+
+  Check_Type(short_name, T_STRING);
+  driver_id = ao_driver_id(StringValuePtr(short_name));
+  if (driver_id < 0){
+    return Qnil;
+  }
+  return INT2FIX(driver_id);
+}
+
+/*
+ * call-seq: Audio::Info.default_driver_id
+ *
+ * デフォルトのDriverIDを返す。
+ * [return] DriverID
+ */
+static VALUE
+rao_default_driver_id(VALUE obj)
+{
+  int id;
+
+  id = ao_default_driver_id();
+  if (id < 0){
+    rb_raise(cAO_eNoDriver,
+	     "Failure to find a usable audio output device.");
+  }
+  return INT2FIX(id);
+}
+
+/*
+ * call-seq: Audio::Info.driver_info(driver_id)
+ *
+ * ドライバの情報を確認する。
+ * ドライバ情報の要素順は以下の通り。
+ * [name(String), short_name(String), author(String),
+ * comment(String), preferred_byte_format(Fixnum),
+ * priority(Fixnum), option_count(Fixnum), options(Array)]
+ *
+ * [arg1] DriverID
+ * [return] Driver Information(Array)
+ */
+static VALUE
+rao_driver_info(VALUE obj, VALUE driver_id)
+{
+  ao_info *info;
+
+  Check_Type(driver_id, T_FIXNUM);
+  info = ao_driver_info(FIX2INT(driver_id));
+  if (info == NULL){
+    rb_raise(cAO_eNoDriver,
+	     "Does not correspond to an actual driver.");
+  }
+  return ao_info2hash(info);;
+}
+
+/*
+ * call-seq: Audio::Info.driver_info_list
+ *
+ * システムのlibaoがサポートしているドライバ一覧を配列で返す。
+ * [return] ドライバ一覧の配列
+ */
+static VALUE
+rao_driver_info_list(VALUE obj)
+{
+  ao_info **info;
+  int info_count, driver_count;
+  VALUE iary;
+
+  iary = rb_ary_new();
+  info = ao_driver_info_list(&driver_count);
+  for (info_count=0; info_count<driver_count;
+       info_count++){
+    rb_ary_push(iary, ao_info2hash(info[info_count]));
+  }
+  return iary;
+}
+
+/*
+ * call-seq: Audio::Info.file_extension(driver_id)
+ *
+ * ファイル出力時の拡張子の標準を確認する。
+ *
+ * [arg1] DriverID
+ * [return] ext name(String)
+ */
+static VALUE
+rao_file_extension(VALUE obj, VALUE driver_id)
+{
+  char *ext;
+
+  Check_Type(driver_id, T_FIXNUM);
+  ext = (char *)ao_file_extension(FIX2INT(driver_id));
+  if (ext == NULL){
+    rb_raise(cAO_eDriverError,
+	     "This driver has no file extension associated with it or if this driver does not exist.");
+  }
+  return rb_str_new2(ext);
+}
+
+/* miscellaneous */
+/*
+ * call-seq: Audio::Info.bigendian?
+ *
+ * ホストの環境がビッグエンディアンであるか否かを調査する。
+ * [return] ビッグエンディアンであればtrue、リトルエンディアンであればfalse
+ */
+static VALUE
+rao_is_big_endian(VALUE obj)
+{
+  if (ao_is_big_endian() == 1){
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
+void
+init_info(void)
+{
+  /*
+   * Document-class: Audio::Info
+   *
+   * オーディオ出力デバイスに関する情報を取り扱うモジュール。
+   */
+  cAO_Info = rb_define_module_under(cAudio, "Info");
+
+  /* driver information */
+  rb_define_module_function(cAO_Info, "driver_id",         rao_driver_id, 1);
+  rb_define_module_function(cAO_Info, "default_driver_id", rao_default_driver_id, 0);
+  rb_define_module_function(cAO_Info, "driver_info",       rao_driver_info, 1);
+  rb_define_module_function(cAO_Info, "driver_info_list",  rao_driver_info_list, 0);
+  rb_define_module_function(cAO_Info, "file_extension",    rao_file_extension, 1);
+
+  /* miscellaneous */
+  rb_define_module_function(cAO_Info, "bigendian?", rao_is_big_endian, 0);
+}