timer: user_instance: report error for timer already attached

After opening character device, applications can select event type. The
operation should be done before attaching to any timer device or the other
instances, Else it fails and returns EBUSY error to the applications.

This commit handles it and report local error.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: user_instance: report error for unattached timer instance

When querying or starting the user instance, the instance should be
attached to any timer device or the other instances. Else, applications
receives EBADFD error.

This commit handles it and report local error.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: user_instance: report error for timer instance not found

After instantiation and opening character device, application can attach
any timer device to the instance according to the identifier information.
If ALSA timer system has no substance identified by the information,
application receives ENODEV error.

This commit handles it and report local error.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: user_instance: report error due to open system call

The call of open system call can return several types of error from VFS.
It's hard to dispatch all of the error in local error domain.

This commit uses GFileError to dispatch the most of the error. At
failure of conversion to GFileError, local error domain is used.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: user_instance: report error due to ioctl failure

This commit uses class-local error domain to report ioctl failure.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: user_instance: add GQuark to report error for ALSATimer.UserInstance

This commit adds new GLib GQuark as a domain of error in instance of
ALSATimerUserInstance class.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: add GLib enumeration to report type of error for ALSATimer.UserInstance

This commit adds new GLib enumeration for error reporting in
instance of ALSATimerUserInstance class.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: user_instance: just return when character device is not opened

It's programming mistake when operating without opening character device.

This commit uses GLib macro just return in the case with warnings.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: instance-params: add checks for method arguments

In Rules for use of GError, it's just used for recoverable runtime
error, not for programming error. The invalid arguments are a kind of
programming error.

This commit adds the check for method arguments.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: add checks for method arguments

In Rules for use of GError, it's just used for recoverable runtime
error, not for programming error. The invalid arguments are a kind of
programming error.

This commit adds the check for method arguments.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: check whether method argument for GError is available

In Rules for use of GError, the check of arguments for GError may be
preferable to avoid to unexpected function call.

This commit adds the check.

Reference: https://developer.gnome.org/glib/stable/glib-Error-Reporting.html
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: skip check of return value from g_malloc()

In GLib implementation, the call of g_malloc() can bring program abort
due to memory starvation. This is necessarily preferable because applications
cannot handle the case and GLib has alternative APIs named 'try' to
allow applications to handle the case.

On the other hand, the memory starvation is system wide issue and it's
hard for applications to solve the issue. It's reasonable for the
implementation to have program abort somehow.

Furthermore, the call of g_object_new() can bring program abort due
to memory starvation. It's impossible for applications to handle the
case.

This commit skips check of return value from g_malloc().

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: user_instance: fix function comment

The function comment for documentation includes wrong descriptions.

This commit corrects it.

Fixes: 3a6d788bf47d ("timer: user_instance: add an API to attach user instance to another instance as slave")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: obsolete library-wide GQuark for error reporting

This commit obsoletes library-wide GQuark. This is not exported, thus
it doesn't lose backward compatibility.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: query: use GFileError to report error

This commit uses GFileError to report errors in library global functions.

It's better to add new GLib enumerations and GQuark for the reporting,
however it's cumbersome to add them just for the global functions.
Thus this commit just uses the existent error in GLib.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: card: update function comment for error reporting

This commit updates function comment for error reporting with
alsactl_card_error_quark() or g_file_error_quark() domains.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: card: report error due to existent control element

The operation to add user-defined control elements returns EBUSY when
sound card has any control element which has the same identifier.

This commit handles the error in local error domain.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: card: report error due to operations against element owned by the other processes

Some operations to control element returns EBUSY or EPERM when the
element is locked for write by the other processes.

This commit handles the error in local error domain.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: card: report error about unsupported element operation

ANy operation to control element returns EPERM when the operation is not
supported by the element.

This commit handles the error in local error domain.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: card: report error about element not found

Any operation to control element returns ENOENT when sound card doesn't
have the element.

This commit handles the error in local error domain.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: card: report error about disconnection

When sound card is under disconnection state, operations fail and return
ENODEV error.

This commit handles the situation in local error domain.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: card: report open error

The call of open system call can return several types of error from VFS.
It's hard to dispatch all of the error in local error domain.

This commit uses GFileError to dispatch the most of the error. At
failure of conversion to GFileError, local error domain is used.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: card: report system call error with own error domain

This commit uses class-local error domain to report ioctl failure.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: card: add GQuark to report error specific for the class

This commit adds new GLib GQuark as a domain of error in instance of
ALSACtlCard class.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: add GLib enumerations for error reporting

This commit adds new GLib enumeration for error reporting in
instance of ALSACtlCard class.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: card: just return when character device is not opened

It's programming error when operating without opening character device.

This commit uses GLib macro just return in the case with warnings.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: add checks for method arguments

In Rules for use of GError, it's just used for recoverable runtime
error, not for programming error. The invalid arguments are a kind of
programming error.

This commit adds the check for method arguments.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: check whether method argument for GError is available

In Rules for use of GError, the check of arguments for GError may be
preferable to avoid to unexpected function call.

This commit adds the check.

Reference: https://developer.gnome.org/glib/stable/glib-Error-Reporting.html
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: skip check of return value from g_malloc()

In GLib implementation, the call of g_malloc() can bring program abort
due to memory starvation. This is necessarily preferable because applications
cannot handle the case and GLib has alternative APIs named 'try' to
allow applications to handle the case.

On the other hand, the memory starvation is system wide issue and it's
hard for applications to solve the issue. It's reasonable for the
implementation to have program abort somehow.

Furthermore, the call of g_object_new() can bring program abort due
to memory starvation. It's impossible for applications to handle the
case.

This commit skips check of return value from g_malloc().

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

bump version up to 0.1.0 to release

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

doc: seq: reorder sections

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

doc: timer: reorder sections

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

update README with alsa-gobject-rs URL

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

rawmidi: add an API to retrieve current version of protocol in rawmidi interface

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: add an API to retrieve current version of protocol in sequencer interface

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: add an API to retrieve current version of protocol in timer interface

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: add an API to retrieve current version of protocol in control interface

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

rawmidi: fix indentation

Fixes: 664d41f58fcd ("rawmidi: generate enumerations")

rawmidi: stream_pair: fix indentation

seq: fix indentation

Fixes: fd8fbfb342e5 ("seq: add global method to get information of client for ALSA Sequencer")

seq: client_pool: fix indentation

Fixes: 2cb4e8dfccab ("seq: client_pool: add properties")

seq: user_client: fix indentation

Fixes: 3bbab4321c58 ("seq: user_client: return filled object after creating queue")

seq: remove_filter: fix indentation

Fixes: 50dea0bdde7d ("seq: remove_filter; add constructor methods")

seq: event_cntr: fix indentation

Fixes: 7e43bc934ab5 ("seq: event_cntr: add an API to calculate the amount of cells in pool consumed by a batch of event")

timer: instance_params: fix indentation

Fixes: 562145cabf5e ("timer: instance_params: add properties")

ctl: elem_value: fix indentation

Fixes: cc98991330fc ("ctl: elem_value: split function with two argument into the one with single argument")

seq: supplement to use guint8 for the numerical ID of queue

Fixes: 1550112567c6 ("seq: use guint8 for the numerical ID of queue")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: supplement to use guint8 for the numerical ID of client

Fixes: 912236f0a415 ("seq: use guint8 for the numerical ID of client")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: use guint8 for the numerical ID of port

seq: use guint8 for the numerical ID of client

seq: use guint8 for the numerical ID of queue

seq: queue_timer_data_alsa: use const qualifier to self argument for getter API

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: event_data_result: use const qualifier to self argument for getter API

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: event_data_queue: use const qualifier to self argument for getter API

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: event_data_note: use const qualifier to self argument for getter API

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: event_data_ctl: use const qualifier to self argument for getter API

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: event_data_connect: use const qualifier to self argument for getter API

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: tstamp: use const qualifier to self argument for getter API

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: event_data_tstamp: use const qualifier to self argument for getter API

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: event_data_tick: use const qualifier to self argument for getter API

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: instance_status: add constructor

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: device_status: add constructor

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: queue_status: add constructor

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

tests: timer: fix test for ALSATimerDeviceStatus

Fixes: 0146f26c3447 ("timer: device_status: add properties")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: user_instance: use (inout) annotation to retrieve the status of instance

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: use (inout) annotation to retrieve the status of timer device

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: use (inout) annotation to retrieve the status of queue

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

update README

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

samples: add Python 3 sample script for ALSASeq

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

samples: add Python 3 sample script for ALSATimer

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

samples: add Python 3 sample script for ALSARawmidi

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

samples: add Python 3 sample script for ALSAHwdep

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

samples: add Python 3 sample script for ALSACtl

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: user_client: return filled object after creating queue

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: user_client: return filled object after creating port

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: user_client: add an API to create port with indicated numerical ID

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: port_info: fix description for queue-id property

Fixes: f3457eaf706b ("seq: port_info: add properties")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: user_client: Fix the type of property for int64 value

Fixes: 4e8675f631ce ("seq: client_info: add properties and accessor methods")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

rawmidi: substream_status: use uint64_t for avail and xrun properties

The avail and xrun members in struct snd_rawmidi_params are defined as
size_t type. The size_t is long type, thus the size is different between
32 bit ABI and 64 bit ABI. This commit uses uint64_t type for the
properties so that the size is the same as these two ABIs.

Fixes: 2371b927816d ("rawmidi: substream_status: add properties")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: instance_status: unify two arguments to single argument for timestamp

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: event_data_tstamp: unify two arguments to single argument for timestamp

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: event: add constructor

The constructor is convenient for any test.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: elem_value: split function with two argument into the one with single argument

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: update documentation for system call information

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

rawmidi: update documentation for system call information

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: update documentation for system call information

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

hwdep: update documentation with system call information

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: update documentation with system call information

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: user_client: correct ioctl command to get the usage of queue by client

Fixes: 4198dc4f7854 ("seq: user_client: add APIs to register usage of queue")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

seq: user_client: correct ioctl command to update queue

Fixes: 2ab3feab20d3 ("seq: user_client: add APIs to create/delete/update queue")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

rawmidi: stream-pair: fix signal name according to internal convention

Fixes: bd91f8f3d6f2 ("rawmidi: stream_pair: add GObject signal to notify receipt of messages")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

rawmidi: fix leak of file descriptor in global methods of ALSARawmidi

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

hwdep: fix leak of file descriptor in global methods of ALSAHwdep

Fixes: 53d99ede2486 ("hwdep: add global method to get information of hwdep device")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

timer: user_instance: add API to choose the type of event to read

Currently ALSATimer.UserInstance has any attach API to decide the type of
event to read. In design of ALSA Timer core, the attach API has two
functionality; to attach or to detach with error for absent timer device.
Current implementation has inconvenient for the functionality due to
execution to choose the type of event in advance. The execution fails
when the instance is already attached.

This commit adds a new API to choose the type of event and split the
call from any attach API.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: elem_info: fix SIGSEGV due to missing sentinel for arguments of g_object_new()

Fixes: 5cc31d27e702 ("ctl: elem_info: become concrete class instead of abstract class")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: elem_info_int64: dismiss ALSACtlElemInfoInt64

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: elem_info_iec60958: dismiss ALSACtlElemInfoIec60958

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: elem_info_bytes: dismiss ALSACtlElemInfoBytes

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: elem_info_enum: dismiss ALSACtlElemInfoEnum

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

ctl: elem_info_int: dismiss ALSACtlElemInfoInt

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>