diff options
author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-05-24 19:23:08 +0900 |
---|---|---|
committer | 坂本 貴史 <o-takashi@sakamocchi.jp> | 2022-05-25 13:49:17 +0900 |
commit | 12881a0b1af33a0ebabe893311b8c486e4885dc9 (patch) | |
tree | d1ab74f1d17d2b4b31f87a09e7a6474eb7b3e123 | |
parent | 34a643bbbc42070928b903ae42f292927e06628a (diff) | |
download | libhinawa-12881a0b1af33a0ebabe893311b8c486e4885dc9.tar.gz |
snd_*: add deprecation note and flag to delegate to libhitaki
All of HinawaSnd* object classes and structures are supported by libhitaki
instead. Let's obsolete current implementations.
* https://github.com/alsa-project/libhitaki
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r-- | doc/hinawa.toml.in | 9 | ||||
-rw-r--r-- | doc/urlmap.js | 1 | ||||
-rw-r--r-- | src/hinawa_enum_types.h | 4 | ||||
-rw-r--r-- | src/snd_dg00x.c | 10 | ||||
-rw-r--r-- | src/snd_dg00x.h | 2 | ||||
-rw-r--r-- | src/snd_dice.c | 14 | ||||
-rw-r--r-- | src/snd_dice.h | 2 | ||||
-rw-r--r-- | src/snd_efw.c | 17 | ||||
-rw-r--r-- | src/snd_efw.h | 2 | ||||
-rw-r--r-- | src/snd_motu.c | 20 | ||||
-rw-r--r-- | src/snd_motu.h | 4 | ||||
-rw-r--r-- | src/snd_motu_register_dsp_parameter.c | 47 | ||||
-rw-r--r-- | src/snd_tscm.c | 12 | ||||
-rw-r--r-- | src/snd_tscm.h | 2 | ||||
-rw-r--r-- | src/snd_unit.c | 38 | ||||
-rw-r--r-- | src/snd_unit.h | 4 |
16 files changed, 175 insertions, 13 deletions
diff --git a/doc/hinawa.toml.in b/doc/hinawa.toml.in index 9c2e791..16a06c0 100644 --- a/doc/hinawa.toml.in +++ b/doc/hinawa.toml.in @@ -12,6 +12,10 @@ dependencies = [ "GObject-2.0", ] +related = [ + "Hitaki-0.0", +] + [dependencies."GLib-2.0"] name = "GLib" description = "The base utility library" @@ -22,6 +26,11 @@ name = "GObject" description = "The base type system and object class" docs_url = "https://docs.gtk.org/gobject/" +[related."Hitaki-0.0"] +name = "Hitaki" +description = "Library to abstract the access to the ALSA firewire hwdep device " +docs_url = "https://alsa-project.github.io/libhitaki-doc/" + [source-location] base_url = "https://github.com/alsa-project/libhinawa/blob/master/" file_format = "{filename}#L{line}" diff --git a/doc/urlmap.js b/doc/urlmap.js index 915cb9d..25589f6 100644 --- a/doc/urlmap.js +++ b/doc/urlmap.js @@ -1,4 +1,5 @@ baseURLs = [ [ 'GLib', 'https://docs.gtk.org/glib/' ], [ 'GObject', 'https://docs.gtk.org/gobject/' ], + [ 'Hitaki', 'https://alsa-project.github.io/libhitaki-doc/' ], ] diff --git a/src/hinawa_enum_types.h b/src/hinawa_enum_types.h index 1933d6b..8d1d54c 100644 --- a/src/hinawa_enum_types.h +++ b/src/hinawa_enum_types.h @@ -125,6 +125,7 @@ typedef enum { * A representation of type for sound unit defined by Linux sound subsystem. * * Since: 1.0 + * Deprecated: 2.5. Use [enum@Hitaki.AlsaFirewireType] in libhitaki library instead. */ typedef enum { HINAWA_SND_UNIT_TYPE_DICE = 1, @@ -203,6 +204,7 @@ typedef enum { * A set of error code for [struct@GLib.Error] with domain which equals to Hinawa.SndUnitError. * * Since: 2.1 + * Deprecated: 2.5. Use Hitaki.AlsaFirewireError in libhitaki library instead. */ typedef enum { HINAWA_SND_UNIT_ERROR_DISCONNECTED, @@ -222,6 +224,7 @@ typedef enum { * A set of error code for [structGLib.Error] with domain which equals to Hinawa.SndDiceError. * * Since: 2.1 + * Deprecated: 2.5. Use Hitaki.AlsaFirewireError in libhitaki library instead. */ typedef enum { HINAWA_SND_DICE_ERROR_TIMEOUT, @@ -250,6 +253,7 @@ typedef enum { * A set of status code for Echo Audio Fireworks Transaction. * * Since: 2.1 + * Deprecated: 2.5. Use Hitaki.EfwProtocolError in libhitaki library instead. */ typedef enum { HINAWA_SND_EFW_STATUS_OK = 0, diff --git a/src/snd_dg00x.c b/src/snd_dg00x.c index e0de7a6..1278898 100644 --- a/src/snd_dg00x.c +++ b/src/snd_dg00x.c @@ -9,6 +9,8 @@ * A notification listener for Digidesign Digi 00x models. * * A [class@SndDg00x] listen to Dg00x notification and generates signal when received. + * + * Deprecated: 2.5. libhitaki library provides [class@Hitaki.SndDigi00x] as the alternative. */ G_DEFINE_TYPE(HinawaSndDg00x, hinawa_snd_dg00x, HINAWA_TYPE_SND_UNIT) @@ -30,11 +32,13 @@ static void hinawa_snd_dg00x_class_init(HinawaSndDg00xClass *klass) * Emitted when Dg00x models transfer notification. * * Since: 0.7 + * Deprecated: 2.5. Use implementation of [signal@Hitaki.AlsaFirewire::notified] in + * [class@Hitaki.SndDigi00x] instead. */ dg00x_sigs[DG00X_SIG_TYPE_MESSAGE] = g_signal_new("message", G_OBJECT_CLASS_TYPE(klass), - G_SIGNAL_RUN_LAST, + G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED, G_STRUCT_OFFSET(HinawaSndDg00xClass, message), NULL, NULL, g_cclosure_marshal_VOID__UINT, @@ -52,7 +56,9 @@ static void hinawa_snd_dg00x_init(HinawaSndDg00x *self) * Instantiate [class@SndDg00x] object and return the instance. * * Returns: an instance of [class@SndDg00x]. + * * Since: 1.3. + * Deprecated: 2.5. Use [method@Hitaki.SndDigi00x.new] instead. */ HinawaSndDg00x *hinawa_snd_dg00x_new(void) { @@ -69,6 +75,8 @@ HinawaSndDg00x *hinawa_snd_dg00x_new(void) * Open ALSA hwdep character device and check it for Dg00x devices. * * Since: 0.7 + * Deprecated: 2.5. Use implementation of [method@Hitaki.AlsaFirewire.open] + * [class@Hitaki.SndDigi00x] for instead. */ void hinawa_snd_dg00x_open(HinawaSndDg00x *self, gchar *path, GError **error) { diff --git a/src/snd_dg00x.h b/src/snd_dg00x.h index a701b47..41a2ca0 100644 --- a/src/snd_dg00x.h +++ b/src/snd_dg00x.h @@ -21,6 +21,8 @@ struct _HinawaSndDg00xClass { * Class closure for the [signal@SndDg00x::message] signal. * * Since: 1.2 + * Deprecated: 2.5. Use implementation of [vfunc@Hitaki.AlsaFirewire.notified] in + * [class@Hitaki.SndDigi00x] instead. */ void (*message)(HinawaSndDg00x *self, guint32 message); }; diff --git a/src/snd_dice.c b/src/snd_dice.c index 9c7c81c..844985e 100644 --- a/src/snd_dice.c +++ b/src/snd_dice.c @@ -9,6 +9,8 @@ * A notification listener for Dice models. * * A [class@SndDice] listen to Dice notification and generates signal when received. + * + * Deprecated: 2.5. libhitaki library provides [class@Hitaki.SndDice] as the alternative. */ /** @@ -17,6 +19,7 @@ * Return the [alias@GLib.Quark] for [struct@GLib.Error] which has code in Hinawa.SndDiceError. * * Since: 2.1 + * Deprecated: 2.5. * * Returns: A [alias@GLib.Quark]. */ @@ -74,11 +77,13 @@ static void hinawa_snd_dice_class_init(HinawaSndDiceClass *klass) * Emitted when Dice unit transfers notification. * * Since: 0.3 + * Deprecated: 2.5. Use implementation of [class@Hitaki.SndDice] for + * [signal@Hitaki.QuadletNotification::notified] instead. */ dice_sigs[DICE_SIG_TYPE_NOTIFIED] = g_signal_new("notified", G_OBJECT_CLASS_TYPE(klass), - G_SIGNAL_RUN_LAST, + G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED, G_STRUCT_OFFSET(HinawaSndDiceClass, notified), NULL, NULL, g_cclosure_marshal_VOID__UINT, @@ -96,7 +101,9 @@ static void hinawa_snd_dice_init(HinawaSndDice *self) * Instantiate [class@SndDice] object and return the instance. * * Returns: an instance of [class@SndDice]. + * * Since: 1.3. + * Deprecated: 2.5. Use [method@Hitaki.SndDice.new] instead. */ HinawaSndDice *hinawa_snd_dice_new(void) { @@ -113,6 +120,8 @@ HinawaSndDice *hinawa_snd_dice_new(void) * Open ALSA hwdep character device and check it for Dice devices. * * Since: 0.4 + * Deprecated: 2.5. Use implementation of [method@Hitaki.AlsaFirewire.open] in + * [class@Hitaki.SndDice] instead. */ void hinawa_snd_dice_open(HinawaSndDice *self, gchar *path, GError **error) { @@ -147,6 +156,9 @@ void hinawa_snd_dice_open(HinawaSndDice *self, gchar *path, GError **error) * Execute write transactions to the given address, then wait and check notification. * * Since: 1.4. + * Deprecated: 2.5. Use [class@FwReq] to send write request transaction to the unit, then use + * implementaion of [signal@Hitaki.QuadletNotification::notified] in + * [class@Hitaki.SndDice] to wait for notification. */ void hinawa_snd_dice_transaction(HinawaSndDice *self, guint64 addr, const guint32 *frame, gsize frame_count, diff --git a/src/snd_dice.h b/src/snd_dice.h index 8656ed9..d21f33b 100644 --- a/src/snd_dice.h +++ b/src/snd_dice.h @@ -25,6 +25,8 @@ struct _HinawaSndDiceClass { * Class closure for the [signal@SndDice::notified]. * * Since: 1.2 + * Deprecated: 2.5. Use implementation of [class@Hitaki.SndDice] for + * [vfunc@Hitaki.QuadletNotification.notified] instead. */ void (*notified)(HinawaSndDice *self, guint message); }; diff --git a/src/snd_efw.c b/src/snd_efw.c index cb15387..314e305 100644 --- a/src/snd_efw.c +++ b/src/snd_efw.c @@ -9,6 +9,8 @@ * A transaction executor for Fireworks models. * * A [class@SndEfw] is an application of Echo Fireworks Transaction. + * + * Deprecated: 2.5. libhitaki library provides [class@Hitaki.SndEfw] as the alternative. */ /** @@ -18,6 +20,7 @@ * [enum@SndEfwStatus]. * * Since: 2.1 + * Deprecated: 2.5. Use Hitaki.EfwProtocolError instead. * * Returns: A [alias@GLib.Quark]. */ @@ -80,11 +83,13 @@ static void hinawa_snd_efw_class_init(HinawaSndEfwClass *klass) * response. * * Since: 2.1 + * Deprecated: 2.5. Use implementation of [class@Hitaki.SndEfw] for + * [signal@Hitaki.EfwProtocol::responded] instead. */ efw_sigs[EFW_SIG_TYPE_RESPONDED] = g_signal_new("responded", G_OBJECT_CLASS_TYPE(klass), - G_SIGNAL_RUN_LAST, + G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED, G_STRUCT_OFFSET(HinawaSndEfwClass, responded), NULL, NULL, hinawa_sigs_marshal_VOID__ENUM_UINT_UINT_UINT_POINTER_UINT, @@ -103,7 +108,9 @@ static void hinawa_snd_efw_init(HinawaSndEfw *self) * Instantiate [class@SndEfw] object and return the instance. * * Returns: an instance of [class@SndEfw]. + * * Since: 1.3. + * Deprecated: 2.5. Use [method@Hitaki.SndEfw.new] instead. */ HinawaSndEfw *hinawa_snd_efw_new(void) { @@ -120,6 +127,8 @@ HinawaSndEfw *hinawa_snd_efw_new(void) * Open ALSA hwdep character device and check it for Fireworks devices. * * Since: 0.3 + * Deprecated: 2.5. Use implementation of [method@Hitaki.AlsaFirewire.open] in + * [class@Hitaki.SndEfw] instead. */ void hinawa_snd_efw_open(HinawaSndEfw *self, gchar *path, GError **error) { @@ -156,6 +165,8 @@ void hinawa_snd_efw_open(HinawaSndEfw *self, gchar *path, GError **error) * emitted. * * Since: 2.1. + * Deprecated: 2.5. Use implementation of [method@Hitaki.EfwProtocol.transmit_request] in + * [class@Hitaki.SndEfw] instead. */ void hinawa_snd_efw_transaction_async(HinawaSndEfw *self, guint category, guint command, const guint32 *args, gsize arg_count, guint32 *resp_seqnum, @@ -263,6 +274,8 @@ static void handle_responded_signal(HinawaSndEfw *self, HinawaSndEfwStatus statu * asynchronous transaction for response frame within the given timeout. * * Since: 2.1. + * Deprecated: 2.5. Use implementation of [method@Hitaki.EfwProtocol.transaction] in + * [class@Hitaki.SndEfw] instead. */ void hinawa_snd_efw_transaction_sync(HinawaSndEfw *self, guint category, guint command, const guint32 *args, gsize arg_count, @@ -344,6 +357,8 @@ end: * the response of transaction within 200 millisecond timeout. * * Since: 1.4. + * Deprecated: 2.5. Use implementation of [method@Hitaki.EfwProtocol.transaction] in + * [class@Hitaki.SndEfw] instead. */ void hinawa_snd_efw_transaction(HinawaSndEfw *self, guint category, guint command, diff --git a/src/snd_efw.h b/src/snd_efw.h index 4d2c89d..3e46869 100644 --- a/src/snd_efw.h +++ b/src/snd_efw.h @@ -31,6 +31,8 @@ struct _HinawaSndEfwClass { * Class closure for the [signal@SndEfw::responded] signal. * * Since: 2.1 + * Deprecated: 2.5. Use implementation of [vfunc@Hitaki.EfwProtocol.responded] in + * [class@Hitaki.SndEfw] instead. */ void (*responded)(HinawaSndEfw *self, HinawaSndEfwStatus status, guint seqnum, guint category, guint command, const guint32 *frame, guint frame_size); diff --git a/src/snd_motu.c b/src/snd_motu.c index 23e4e6c..f25225d 100644 --- a/src/snd_motu.c +++ b/src/snd_motu.c @@ -10,6 +10,8 @@ * * A [class@SndMotu] is an application of asynchronous notification defined by Mark of the Unicorn * (MOTU). + * + * Deprecated: 2.5. libhitaki library provides [class@Hitaki.SndMotu] as the alternative. */ typedef struct { @@ -35,11 +37,13 @@ static void hinawa_snd_motu_class_init(HinawaSndMotuClass *klass) * Emitted when Motu models transfer notification. * * Since: 0.8 + * Deprecated: 2.5. Use implementation of [signal@Hitaki.QuadletNotification::notified] + * in [class@Hitaki.SndMotu] instead. */ motu_sigs[MOTU_SIG_TYPE_NOTIFIED] = g_signal_new("notified", G_OBJECT_CLASS_TYPE(klass), - G_SIGNAL_RUN_LAST, + G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED, G_STRUCT_OFFSET(HinawaSndMotuClass, notified), NULL, NULL, g_cclosure_marshal_VOID__UINT, @@ -59,11 +63,13 @@ static void hinawa_snd_motu_class_init(HinawaSndMotuClass *klass) * For detail, see `sound/firewire/motu/motu-register-dsp-message-parser.c` in Linux kernel. * * Since: 2.4 + * Deprecated: 2.5. Use implementation [signal@Hitaki.MotuRegisterDsp::changed] in + * [class@Hitaki.SndMotu] instead. */ motu_sigs[MOTU_SIG_TYPE_REGISTER_DSP_CHANGED] = g_signal_new("register-dsp-changed", G_OBJECT_CLASS_TYPE(klass), - G_SIGNAL_RUN_LAST, + G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED, G_STRUCT_OFFSET(HinawaSndMotuClass, register_dsp_changed), NULL, NULL, hinawa_sigs_marshal_VOID__POINTER_UINT, @@ -82,7 +88,9 @@ static void hinawa_snd_motu_init(HinawaSndMotu *self) * Instantiate [class@SndMotu] object and return the instance. * * Returns: an instance of [class@SndMotu]. + * * Since: 1.3. + * Deprecated: 2.5. Use [method@Hitaki.SndMotu.new] instead. */ HinawaSndMotu *hinawa_snd_motu_new(void) { @@ -99,6 +107,8 @@ HinawaSndMotu *hinawa_snd_motu_new(void) * Open ALSA hwdep character device and check it for Motu devices. * * Since: 0.8 + * Deprecated: 2.5. Use implementation of [method@Hitaki.AlsaFirewire.open] in + * [class@Hitaki.SndMotu] instead. */ void hinawa_snd_motu_open(HinawaSndMotu *self, gchar *path, GError **error) { @@ -119,6 +129,8 @@ void hinawa_snd_motu_open(HinawaSndMotu *self, gchar *path, GError **error) * Read parameter for register DSP models. * * Since: 2.4 + * Deprecated: 2.5. Use implementation of [method@Hitaki.MotuRegisterDsp.read_parameter] in + * [class@Hitaki.SndMotu] instead. */ void hinawa_snd_motu_read_register_dsp_parameter(HinawaSndMotu *self, HinawaSndMotuRegisterDspParameter *const *param, @@ -148,6 +160,8 @@ void hinawa_snd_motu_read_register_dsp_parameter(HinawaSndMotu *self, * Read data of meter information for register DSP models. * * Since: 2.4 + * Deprecated: 2.5. Use implementation of [method@Hitaki.MotuRegisterDsp.read_byte_meter] in + * [class@Hitaki.SndMotu] instead. */ void hinawa_snd_motu_read_register_dsp_meter(HinawaSndMotu *self, guint8 *const meter[48], GError **error) @@ -174,6 +188,8 @@ void hinawa_snd_motu_read_register_dsp_meter(HinawaSndMotu *self, guint8 *const * Read data of meter information for command DSP models. * * Since: 2.4 + * Deprecated: 2.5. Use implementation of [method@Hitaki.MotuCommandDsp.read_float_meter] in + * [class@Hitaki.SndMotu] instead. */ void hinawa_snd_motu_read_command_dsp_meter(HinawaSndMotu *self, gfloat *const meter[400], GError **error) diff --git a/src/snd_motu.h b/src/snd_motu.h index 4e6c47e..21224c0 100644 --- a/src/snd_motu.h +++ b/src/snd_motu.h @@ -21,6 +21,8 @@ struct _HinawaSndMotuClass { * Class closure for the [signal@SndMotu::notified] signal. * * Since: 1.2 + * Deprecated: 2.5. Use implementation of [vfunc@Hitaki.QuadletNotification.notified] + * in [class@Hitaki.SndMotu] instead. */ void (*notified)(HinawaSndMotu *self, guint message); @@ -34,6 +36,8 @@ struct _HinawaSndMotuClass { * Class closure for the [signal@SndMotu::register-dsp-changed] signal. * * Since: 2.4 + * Deprecated: 2.5. Use implementation [vfunc@Hitaki.MotuRegisterDsp.changed] in + * [class@Hitaki.SndMotu] instead. */ void (*register_dsp_changed)(HinawaSndMotu *self, const guint32 *events, guint length); }; diff --git a/src/snd_motu_register_dsp_parameter.c b/src/snd_motu_register_dsp_parameter.c index 7a0370c..205f824 100644 --- a/src/snd_motu_register_dsp_parameter.c +++ b/src/snd_motu_register_dsp_parameter.c @@ -7,6 +7,10 @@ * * A [struct@SndMotuRegisterDspParameter] is a boxed object for container of parameter in register * DSP model. + * + * Since: 2.4. + * Deprecated: 2.5. libhitaki library provides [struct@Hitaki.SndMotuRegisterDspParameter] as the + * alternative. */ HinawaSndMotuRegisterDspParameter *register_dsp_parameter_copy(const HinawaSndMotuRegisterDspParameter *self) { @@ -29,7 +33,9 @@ G_DEFINE_BOXED_TYPE(HinawaSndMotuRegisterDspParameter, hinawa_snd_motu_register_ * Instantiate [struct@SndMotuRegisterDspParameter] object and return the instance. * * Returns: an instance of [struct@SndMotuRegisterDspParameter]. + * * Since: 2.4 + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.new] instead. */ HinawaSndMotuRegisterDspParameter *hinawa_snd_motu_register_dsp_parameter_new(void) { @@ -45,6 +51,8 @@ HinawaSndMotuRegisterDspParameter *hinawa_snd_motu_register_dsp_parameter_new(vo * * Get the array with elements for the data of source gains in indicated mixer. The data has gain * value between 0x00 and 0x80. + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_mixer_source_gain] instead. */ void hinawa_snd_motu_register_dsp_parameter_get_mixer_source_gain( const HinawaSndMotuRegisterDspParameter *self, gsize mixer, const guint8 *gain[20]) @@ -68,6 +76,8 @@ void hinawa_snd_motu_register_dsp_parameter_get_mixer_source_gain( * * Get the array with elements for the data of source pans in indicated mixer. The data has pan * value between 0x00 and 0x80. + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_mixer_source_pan] instead. */ void hinawa_snd_motu_register_dsp_parameter_get_mixer_source_pan( const HinawaSndMotuRegisterDspParameter *self, gsize mixer, const guint8 *pan[20]) @@ -94,6 +104,8 @@ void hinawa_snd_motu_register_dsp_parameter_get_mixer_source_pan( * * - 0x01: whether to enable mute function for the source. * - 0x02: whether to enable solo function for the source. + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_mixer_source_flag] instead. */ void hinawa_snd_motu_register_dsp_parameter_get_mixer_source_flag( const HinawaSndMotuRegisterDspParameter *self, gsize mixer, const guint8 *flag[20]) @@ -117,6 +129,9 @@ void hinawa_snd_motu_register_dsp_parameter_get_mixer_source_flag( * * Get the array with elements for the data of paired source L/R balance in indicated mixer. The * data has L/R balance value between 0x00 and 0x80. + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_mixer_source_paired_balance] + * instead. */ void hinawa_snd_motu_register_dsp_parameter_get_mixer_source_paired_balance( const HinawaSndMotuRegisterDspParameter *self, gsize mixer, const guint8 *balance[20]) @@ -140,6 +155,9 @@ void hinawa_snd_motu_register_dsp_parameter_get_mixer_source_paired_balance( * * Get the array with elements for the data of paired source width in indicated mixer. The data * has width value between 0x00 and 0x80. + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_mixer_source_paired_width] + * instead. */ void hinawa_snd_motu_register_dsp_parameter_get_mixer_source_paired_width( const HinawaSndMotuRegisterDspParameter *self, gsize mixer, const guint8 *width[20]) @@ -162,6 +180,9 @@ void hinawa_snd_motu_register_dsp_parameter_get_mixer_source_paired_width( * * Get the array with elements for the data of paired output volume in indicated mixer. The data * has gain value between 0x00 and 0x80. + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_mixer_output_paired_volume] + * instead. */ void hinawa_snd_motu_register_dsp_parameter_get_mixer_output_paired_volume( const HinawaSndMotuRegisterDspParameter *self, const guint8 *volume[4]) @@ -186,6 +207,9 @@ void hinawa_snd_motu_register_dsp_parameter_get_mixer_output_paired_volume( * * - 0x0f: the mask for destination of paired output * - 0x10: whether to enable mute for paired output + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_mixer_output_paired_flag] + * instead. */ void hinawa_snd_motu_register_dsp_parameter_get_mixer_output_paired_flag( const HinawaSndMotuRegisterDspParameter *self, const guint8 *flag[4]) @@ -206,6 +230,9 @@ void hinawa_snd_motu_register_dsp_parameter_get_mixer_output_paired_flag( * * Get the array with elements for the data of paired main output volume. The data has volume value * between 0x00 and 0x80. + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_main_output_paired_volume] + * instead. */ void hinawa_snd_motu_register_dsp_parameter_get_main_output_paired_volume( const HinawaSndMotuRegisterDspParameter *self, guint8 *volume) @@ -226,6 +253,10 @@ void hinawa_snd_motu_register_dsp_parameter_get_main_output_paired_volume( * * Get the array with elements for the data of paired headphone output volume. The data has volume * value between 0x00 and 0x80. + * + * Deprecated: 2.5. Use + * [method@Hitaki.SndMotuRegisterDspParameter.get_headphone_output_paired_volume] + * instead. */ void hinawa_snd_motu_register_dsp_parameter_get_headphone_output_paired_volume( const HinawaSndMotuRegisterDspParameter *self, guint8 *volume) @@ -246,6 +277,10 @@ void hinawa_snd_motu_register_dsp_parameter_get_headphone_output_paired_volume( * * Get the array with elements for the data of paired headphone output source. The data has index * value of source. + * + * Deprecated: 2.5. Use + * [method@Hitaki.SndMotuRegisterDspParameter.get_headphone_output_paired_assignment] + * instead. */ void hinawa_snd_motu_register_dsp_parameter_get_headphone_output_paired_assignment( const HinawaSndMotuRegisterDspParameter *self, guint8 *assignment) @@ -266,6 +301,9 @@ void hinawa_snd_motu_register_dsp_parameter_get_headphone_output_paired_assignme * * Get the data for flags of line input boost. The data consists of bit flags for corresponding line * input channel. When the flag stands, the input is boosted. + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_line_input_boost_flag] + * instead. */ void hinawa_snd_motu_register_dsp_parameter_get_line_input_boost_flag( const HinawaSndMotuRegisterDspParameter *self, guint8 *boost_flag) @@ -287,6 +325,10 @@ void hinawa_snd_motu_register_dsp_parameter_get_line_input_boost_flag( * Get the data for flags of line input nominal level. The data consists of bit flags for * corresponding line input channel. When the flag stands, the nominal level of input is +4 dBu, * else -10 dBV. + * + * Deprecated: 2.5. Use + * [method@Hitaki.SndMotuRegisterDspParameter.get_line_input_nominal_level_flag] + * instead. */ void hinawa_snd_motu_register_dsp_parameter_get_line_input_nominal_level_flag( const HinawaSndMotuRegisterDspParameter *self, guint8 *nominal_level_flag) @@ -315,6 +357,9 @@ void hinawa_snd_motu_register_dsp_parameter_get_line_input_nominal_level_flag( * - Audio Express and 4 pre * - 0x3f: the gain * - 0x40: whether to invert phase of the input + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_input_gain_and_invert] + * instead. */ void hinawa_snd_motu_register_dsp_parameter_get_input_gain_and_invert( const HinawaSndMotuRegisterDspParameter *self, const guint8 *gain_and_invert[10]) @@ -340,6 +385,8 @@ void hinawa_snd_motu_register_dsp_parameter_get_input_gain_and_invert( * - 0x02: whether to enable phantom powering * - 0x04: whether to enable attenuation pad * - 0x08: whether to detect plug insert to jack + * + * Deprecated: 2.5. Use [method@Hitaki.SndMotuRegisterDspParameter.get_input_flag] instead. */ void hinawa_snd_motu_register_dsp_parameter_get_input_flag( const HinawaSndMotuRegisterDspParameter *self, const guint8 *flag[10]) diff --git a/src/snd_tscm.c b/src/snd_tscm.c index 8f92fb2..a36f0e8 100644 --- a/src/snd_tscm.c +++ b/src/snd_tscm.c @@ -9,6 +9,8 @@ * A state reader for Tascam FireWire models * * A [class@SndTscm] is an application of protocol defined by TASCAM. + * + * Deprecated: 2.5. libhitaki library provides [class@Hitaki.SndTascam] as the alternative. */ typedef struct { @@ -37,11 +39,13 @@ static void hinawa_snd_tscm_class_init(HinawaSndTscmClass *klass) * is emitted. * * Since: 1.1 + * Deprecated: 2.5. Use implementation of [signal@Hitaki.TascamProtocol::changed] in + * [class@Hitaki.SndTascam] instead. */ tscm_sigs[TSCM_SIG_TYPE_CTL] = g_signal_new("control", G_OBJECT_CLASS_TYPE(klass), - G_SIGNAL_RUN_LAST, + G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED, G_STRUCT_OFFSET(HinawaSndTscmClass, control), NULL, NULL, hinawa_sigs_marshal_VOID__UINT_UINT_UINT, @@ -60,7 +64,9 @@ static void hinawa_snd_tscm_init(HinawaSndTscm *self) * Instantiate [class@SndTscm] object and return the instance. * * Returns: an instance of [class@SndTscm]. + * * Since: 1.3. + * Deprecated: 2.5. Use [method@Hitaki.SndTascam.new] instead. */ HinawaSndTscm *hinawa_snd_tscm_new(void) { @@ -77,6 +83,8 @@ HinawaSndTscm *hinawa_snd_tscm_new(void) * Open ALSA hwdep character device and check it for Tascam devices. * * Since: 1.1 + * Deprecated: 2.5. Use implementation of [method@Hitaki.AlsaFirewire.open] in + * [class@Hitaki.SndTascam] instead. */ void hinawa_snd_tscm_open(HinawaSndTscm *self, gchar *path, GError **error) { @@ -97,6 +105,8 @@ void hinawa_snd_tscm_open(HinawaSndTscm *self, gchar *path, GError **error) * Returns: (element-type guint32) (array fixed-size=64) (transfer none): state image. * * Since: 1.1 + * Deprecated: 2.5. Use implementation of [method@Hitaki.TascamProtocol.read_state] in + * [class@Hitaki.SndTascam] instead. */ const guint32 *hinawa_snd_tscm_get_state(HinawaSndTscm *self, GError **error) { diff --git a/src/snd_tscm.h b/src/snd_tscm.h index 43f1a97..85e7062 100644 --- a/src/snd_tscm.h +++ b/src/snd_tscm.h @@ -23,6 +23,8 @@ struct _HinawaSndTscmClass { * Class closure for the [signal@SndTscm::control] signal. * * Since: 1.2 + * Deprecated: 2.5. Use implementation of [vfunc@Hitaki.TascamProtocol.changed] in + * [class@Hitaki.SndTascam] instead. */ void (*control)(HinawaSndTscm *self, guint index, guint before, guint after); }; diff --git a/src/snd_unit.c b/src/snd_unit.c index 7a4b810..4891a98 100644 --- a/src/snd_unit.c +++ b/src/snd_unit.c @@ -18,6 +18,8 @@ * * This class is an application of ALSA FireWire stack. Any functionality which ALSA drivers in the * stack can be available. + * + * Deprecated: 2.5. libhitaki library provides [class@Hitaki.SndUnit] as the alternative. */ /** @@ -26,6 +28,7 @@ * Return the [alias@GLib.Quark] for [struct@GLib.Error] which has code in Hinawa.SndUnitError. * * Since: 2.1 + * Deprecated: 2.5. Use Hitaki.AlsaFirewireError instead. * * Returns: A [alias@GLib.Quark]. */ @@ -139,59 +142,64 @@ static void hinawa_snd_unit_class_init(HinawaSndUnitClass *klass) * HinawaSndUnit:type: * * Since: 1.0 + * Deprecated: 2.5. Use [property@Hitaki.AlsaFirewire:unit-type] instead. */ snd_unit_props[SND_UNIT_PROP_TYPE_FW_TYPE] = g_param_spec_enum("type", "type", "The value of HinawaSndUnitType enumerators", HINAWA_TYPE_SND_UNIT_TYPE, HINAWA_SND_UNIT_TYPE_DICE, - G_PARAM_READABLE); + G_PARAM_READABLE | G_PARAM_DEPRECATED); /** * HinawaSndUnit:card: * * Since: 2.0 + * Deprecated: 2.5. Use [property@Hitaki.AlsaFirewire:card] instead. */ snd_unit_props[SND_UNIT_PROP_TYPE_CARD_ID] = g_param_spec_uint("card", "card", "The numeric ID for ALSA sound card", 0, G_MAXUINT, 0, - G_PARAM_READABLE); + G_PARAM_READABLE | G_PARAM_DEPRECATED); /** * HinawaSndUnit:device: * * * Since: 0.3 + * Deprecated: 2.5. Use [property@Hitaki.AlsaFirewire:node-device] instead. */ snd_unit_props[SND_UNIT_PROP_TYPE_DEVICE] = g_param_spec_string("device", "device", "A name of special file as FireWire unit.", NULL, - G_PARAM_READABLE); + G_PARAM_READABLE | G_PARAM_DEPRECATED); /** * HinawaSndUnit:streaming: * * Since: 0.4 + * Deprecated: 2.5. Use [property@Hitaki.AlsaFirewire:is-locked] instead. */ snd_unit_props[SND_UNIT_PROP_TYPE_STREAMING] = g_param_spec_boolean("streaming", "streaming", "Whether this device is streaming or not", FALSE, - G_PARAM_READABLE); + G_PARAM_READABLE | G_PARAM_DEPRECATED); /** * HinawaSndUnit:guid: * * Since: 0.4 + * Deprecated: 2.5. Use [property@Hitaki.AlsaFirewire:guid] instead. */ snd_unit_props[SND_UNIT_PROP_TYPE_GUID] = g_param_spec_uint64("guid", "guid", "Global unique ID for this firewire unit.", 0, G_MAXUINT64, 0, - G_PARAM_READABLE); + G_PARAM_READABLE | G_PARAM_DEPRECATED); g_object_class_install_properties(gobject_class, SND_UNIT_PROP_TYPE_COUNT, @@ -206,11 +214,13 @@ static void hinawa_snd_unit_class_init(HinawaSndUnitClass *klass) * packet streaming requested by ALSA PCM/Rawmidi applications. * * Since: 0.3 + * Deprecated: 2.5. Use change notify signal of [property@Hitaki.AlsaFirewire:is-locked] + * instead. */ snd_unit_sigs[SND_UNIT_SIG_TYPE_LOCK_STATUS] = g_signal_new("lock-status", G_OBJECT_CLASS_TYPE(klass), - G_SIGNAL_RUN_LAST, + G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED, G_STRUCT_OFFSET(HinawaSndUnitClass, lock_status), NULL, NULL, g_cclosure_marshal_VOID__BOOLEAN, @@ -225,11 +235,13 @@ static void hinawa_snd_unit_class_init(HinawaSndUnitClass *klass) * quickly as possible to release ALSA hwdep character device. * * Since: 2.0 + * Deprecated: 2.5. Use change notify signal of + * [property@Hitaki.AlsaFirewire:is-disconnected] instead. */ snd_unit_sigs[SND_UNIT_SIG_TYPE_DISCONNECTED] = g_signal_new("disconnected", G_OBJECT_CLASS_TYPE(klass), - G_SIGNAL_RUN_LAST, + G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED, G_STRUCT_OFFSET(HinawaSndUnitClass, disconnected), NULL, NULL, g_cclosure_marshal_VOID__VOID, @@ -250,7 +262,9 @@ static void hinawa_snd_unit_init(HinawaSndUnit *self) * Instantiate [class@SndUnit] object and return the instance. * * Returns: an instance of [class@SndUnit]. + * * Since: 1.3. + * Deprecated: 2.5. Use [method@Hitaki.SndUnit.new] instead. */ HinawaSndUnit *hinawa_snd_unit_new(void) { @@ -267,6 +281,8 @@ HinawaSndUnit *hinawa_snd_unit_new(void) * Open ALSA hwdep character device and check it for FireWire sound devices. * * Since: 0.4 + * Deprecated: 2.5. Use implementation of [method@Hitaki.AlsaFirewire.open] in + * [class@Hitaki.SndUnit] instead. */ void hinawa_snd_unit_open(HinawaSndUnit *self, gchar *path, GError **error) { @@ -346,6 +362,8 @@ end: * Retrieve an instance of [class@FwNode] associated to the given unit. * * Since: 2.0. + * Deprecated: 2.5. Instantiate [class@FwNode] according to + * [property@Hitaki.AlsaFirewire:node-device] instead. */ void hinawa_snd_unit_get_node(HinawaSndUnit *self, HinawaFwNode **node) { @@ -367,6 +385,8 @@ void hinawa_snd_unit_get_node(HinawaSndUnit *self, HinawaFwNode **node) * Disallow corresponding ALSA driver to start packet streaming. * * Since: 0.3 + * Deprecated: 2.5. Use implementation of [method@Hitaki.AlsaFirewire.lock] in + * [class@Hitaki.SndUnit] instead. */ void hinawa_snd_unit_lock(HinawaSndUnit *self, GError **error) { @@ -399,6 +419,8 @@ void hinawa_snd_unit_lock(HinawaSndUnit *self, GError **error) * Allow corresponding ALSA driver to start packet streaming. * * Since: 0.3 + * Deprecated: 2.5. Use implementation of [method@Hitaki.AlsaFirewire.unlock] in + * [class@Hitaki.SndUnit] instead. */ void hinawa_snd_unit_unlock(HinawaSndUnit *self, GError **error) { @@ -598,6 +620,8 @@ static void finalize_src(GSource *gsrc) * device. * * Since: 1.4. + * Deprecated: 2.5. Use implementation of [method@Hitaki.AlsaFirewire.create_source] in + * [class@Hitaki.SndUnit] instead. */ void hinawa_snd_unit_create_source(HinawaSndUnit *self, GSource **gsrc, GError **error) diff --git a/src/snd_unit.h b/src/snd_unit.h index fc526bb..1840fba 100644 --- a/src/snd_unit.h +++ b/src/snd_unit.h @@ -25,6 +25,8 @@ struct _HinawaSndUnitClass { * Class closure for the [signal@SndUnit::lock-status], * * Since: 1.2 + * Deprecated: 2.5. Use change notify signal of [property@Hitaki.AlsaFirewire:is-locked] + * instead. */ void (*lock_status)(HinawaSndUnit *self, gboolean state); @@ -35,6 +37,8 @@ struct _HinawaSndUnitClass { * Class closure for the [signal@SndUnit::disconnected]. * * Since: 2.0 + * Deprecated: 2.5. Use change notify signal of + * [property@Hitaki.AlsaFirewire:is-disconnected] instead. */ void (*disconnected)(HinawaSndUnit *self); }; |