Skip to content

Use the new async logging macros, fix various log messages #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 17, 2022
Merged

Use the new async logging macros, fix various log messages #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ crate-type = ["staticlib", "rlib"]
atomic = "0.4"
bitflags = "1.0"
coreaudio-sys-utils = { path = "coreaudio-sys-utils" }
cubeb-backend = "0.10"
cubeb-backend = "0.10.1"
float-cmp = "0.6"
libc = "0.2"
lazy_static = "1.2"
Expand Down
12 changes: 11 additions & 1 deletion src/backend/buffer_manager.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ impl BufferManager {
};
assert!(pushed <= to_push, "We don't support upmix");
if pushed != to_push {
cubeb_log!(
cubeb_alog!(
"Input ringbuffer full, could only push {} instead of {}",
pushed,
to_push
Expand All @@ -222,6 +222,11 @@ impl BufferManager {
unsafe { slice::from_raw_parts_mut::<i16>(data as *mut i16, needed_samples) };
let read = p.pop_slice(input);
if read < needed_samples {
cubeb_alog!(
"Underrun during input data pull: (needed: {}, available: {})",
needed_samples,
read
);
for i in 0..(needed_samples - read) {
input[read + i] = 0;
}
Expand All @@ -232,6 +237,11 @@ impl BufferManager {
unsafe { slice::from_raw_parts_mut::<f32>(data as *mut f32, needed_samples) };
let read = p.pop_slice(input);
if read < needed_samples {
cubeb_alog!(
"Underrun during input data pull: (needed: {}, available: {})",
needed_samples,
read
);
for i in 0..(needed_samples - read) {
input[read + i] = 0.0;
}
Expand Down
6 changes: 4 additions & 2 deletions src/backend/mixer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ impl Mixer {
assert!(out_channel_count > 0);

cubeb_log!(
"Create a mixer with input channel count: {}, input layout: {:?}, \
"Creating a mixer with input channel count: {}, input layout: {:?},\
out channel count: {}, output channels: {:?}",
in_channel_count,
input_layout,
Expand All @@ -189,7 +189,9 @@ impl Mixer {
);

let input_channels = if in_channel_count as u32 != input_layout.bits().count_ones() {
cubeb_log!("Mismatch between input channels and layout. Apply default layout instead");
cubeb_log!(
"Mismatch between input channels and layout. Applying default layout instead"
);
get_default_channel_order(in_channel_count)
} else {
get_channel_order(input_layout)
Expand Down
80 changes: 48 additions & 32 deletions src/backend/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ fn create_device_info(devid: AudioDeviceID, devtype: DeviceType) -> Option<devic
};

if devid == kAudioObjectUnknown {
cubeb_log!("Use the system default device");
cubeb_log!("Using the system default device");
flags |= device_flags::DEV_SELECTED_DEFAULT;
get_default_device(devtype).map(|id| device_info { id, flags })
} else {
Expand Down Expand Up @@ -390,7 +390,7 @@ extern "C" fn audiounit_input_callback(
// output device is no longer valid and must be reset.
// For now state that no error occurred and feed silence, stream will be
// resumed once reinit has completed.
cubeb_logv!(
cubeb_alog!(
"({:p}) input: reinit pending, output will pull silence instead",
stm.core_stream_data.stm_ptr
);
Expand All @@ -402,7 +402,7 @@ extern "C" fn audiounit_input_callback(
ErrorHandle::Return(status)
};

cubeb_logv!(
cubeb_alogv!(
"({:p}) input: buffers {}, size {}, channels {}, rendered frames {}, total frames {}.",
stm.core_stream_data.stm_ptr,
input_buffer_list.mNumberBuffers,
Expand Down Expand Up @@ -530,7 +530,7 @@ extern "C" fn audiounit_output_callback(
};

if stm.stopped.load(Ordering::SeqCst) {
cubeb_log!("({:p}) output stopped.", stm as *const AudioUnitStream);
cubeb_alog!("({:p}) output stopped.", stm as *const AudioUnitStream);
audiounit_make_silent(&mut buffers[0]);
return NO_ERR;
}
Expand All @@ -554,7 +554,7 @@ extern "C" fn audiounit_output_callback(
.store(output_latency_frames, Ordering::SeqCst);
}

cubeb_logv!(
cubeb_alogv!(
"({:p}) output: buffers {}, size {}, channels {}, frames {}.",
stm as *const AudioUnitStream,
buffers.len(),
Expand Down Expand Up @@ -599,7 +599,7 @@ extern "C" fn audiounit_output_callback(
if prev_frames_written == 0 && buffered_input_frames > input_frames_needed as usize {
input_buffer_manager.trim(input_frames_needed);
let popped_frames = buffered_input_frames - input_frames_needed as usize;
cubeb_log!("Dropping {} frames in input buffer.", popped_frames);
cubeb_alog!("Dropping {} frames in input buffer.", popped_frames);
}

let input_frames = if input_frames_needed > buffered_input_frames
Expand All @@ -609,7 +609,7 @@ extern "C" fn audiounit_output_callback(
{
// The silent frames will be inserted in `get_linear_data` below.
let silent_frames_to_push = input_frames_needed - buffered_input_frames;
cubeb_log!(
cubeb_alog!(
"({:p}) Missing Frames: {} will append {} frames of input silence.",
stm.core_stream_data.stm_ptr,
if stm.frames_read.load(Ordering::SeqCst) == 0 {
Expand Down Expand Up @@ -716,7 +716,7 @@ extern "C" fn audiounit_property_listener_callback(
let addrs = unsafe { slice::from_raw_parts(addresses, address_count as usize) };
if stm.switching_device.load(Ordering::SeqCst) {
cubeb_log!(
"Switching is already taking place. Skip Events for device {}",
"Switching is already taking place. Skipping event for device {}",
id
);
return NO_ERR;
Expand All @@ -725,9 +725,8 @@ extern "C" fn audiounit_property_listener_callback(

let mut input_device_dead = false;

// Log the events
cubeb_log!(
"({:p}) Handle {} device changed events for device {}",
"({:p}) Handling {} device changed events for device {}",
stm as *const AudioUnitStream,
address_count,
id
Expand All @@ -743,7 +742,7 @@ extern "C" fn audiounit_property_listener_callback(

// Handle the events
if input_device_dead {
cubeb_log!("The user-selected input device is dead, enter error state");
cubeb_log!("The user-selected input device is dead, entering error state");
stm.stopped.store(true, Ordering::SeqCst);
stm.core_stream_data.stop_audiounits();
stm.close_on_error();
Expand Down Expand Up @@ -803,7 +802,7 @@ fn audiounit_convert_channel_layout(layout: &AudioChannelLayout) -> Vec<mixer::C
// kAudioChannelLayoutTag_Mono
// kAudioChannelLayoutTag_Stereo
// ....
cubeb_log!("Only handle UseChannelDescriptions for now.\n");
cubeb_log!("Only handling UseChannelDescriptions for now.\n");
return Vec::new();
}

Expand Down Expand Up @@ -962,7 +961,7 @@ fn create_audiounit(device: &device_info) -> Result<AudioUnit> {

set_device_to_audiounit(unit, device.id).map_err(|e| {
cubeb_log!(
"Fail to set device {} to the created audiounit. Error: {}",
"Failed to set device {} to the created audiounit. Error: {}",
device.id,
e
);
Expand Down Expand Up @@ -1158,7 +1157,7 @@ fn set_buffer_size_sync(unit: AudioUnit, devtype: DeviceType, frames: u32) -> Re

set_buffer_size(unit, devtype, frames).map_err(|e| {
cubeb_log!(
"Fail to set buffer size for AudioUnit {:?} for {:?}. Error: {}",
"Failed to set buffer size for AudioUnit {:?} for {:?}. Error: {}",
unit,
devtype,
e
Expand All @@ -1172,7 +1171,7 @@ fn set_buffer_size_sync(unit: AudioUnit, devtype: DeviceType, frames: u32) -> Re
let (chg, timeout_res) = cvar.wait_timeout(changed, waiting_time).unwrap();
if timeout_res.timed_out() {
cubeb_log!(
"Time out for waiting the buffer frame size setting of AudioUnit {:?} for {:?}",
"Timed out for waiting the buffer frame size setting of AudioUnit {:?} for {:?}",
unit,
devtype
);
Expand Down Expand Up @@ -1303,7 +1302,7 @@ fn get_fixed_latency(devid: AudioObjectID, devtype: DeviceType) -> u32 {
let stream_latency = get_device_streams(devid, devtype).and_then(|streams| {
if streams.is_empty() {
cubeb_log!(
"No any stream on device {} in {:?} scope!",
"No stream on device {} in {:?} scope!",
devid,
devtype
);
Expand Down Expand Up @@ -1338,13 +1337,13 @@ fn get_device_group_id(
match get_custom_group_id(id, devtype) {
Some(id) => return Ok(id),
None => {
cubeb_log!("Get model uid instead.");
cubeb_log!("Getting model UID instead.");
}
};
}
Ok(trans_type) => {
cubeb_log!(
"The transport type is {:?}. Get model uid instead.",
"The transport type is {:?}. Getting model UID instead.",
convert_uint32_into_string(trans_type)
);
}
Expand Down Expand Up @@ -1373,7 +1372,7 @@ fn get_custom_group_id(id: AudioDeviceID, devtype: DeviceType) -> Option<CString
s @ Ok(IMIC) | s @ Ok(ISPK) => {
const GROUP_ID: &str = "builtin-internal-mic|spk";
cubeb_log!(
"Use hardcode group id: {} when source is: {:?}.",
"Using hardcode group id: {} when source is: {:?}.",
GROUP_ID,
convert_uint32_into_string(s.unwrap())
);
Expand All @@ -1382,7 +1381,7 @@ fn get_custom_group_id(id: AudioDeviceID, devtype: DeviceType) -> Option<CString
s @ Ok(EMIC) | s @ Ok(HDPN) => {
const GROUP_ID: &str = "builtin-external-mic|hdpn";
cubeb_log!(
"Use hardcode group id: {} when source is: {:?}.",
"Using hardcode group id: {} when source is: {:?}.",
GROUP_ID,
convert_uint32_into_string(s.unwrap())
);
Expand Down Expand Up @@ -1444,7 +1443,7 @@ fn create_cubeb_device_info(
}
Err(e) => {
cubeb_log!(
"Cannot get the uid for device {} in {:?} scope. Error: {}",
"Cannot get the UID for device {} in {:?} scope. Error: {}",
devid,
devtype,
e
Expand All @@ -1458,7 +1457,7 @@ fn create_cubeb_device_info(
}
Err(e) => {
cubeb_log!(
"Cannot get the model uid for device {} in {:?} scope. Error: {}",
"Cannot get the model UID for device {} in {:?} scope. Error: {}",
devid,
devtype,
e
Expand Down Expand Up @@ -1547,7 +1546,7 @@ fn create_cubeb_device_info(
latency + range.mMaximum as u32,
),
Err(e) => {
cubeb_log!("Cannot get the buffer frame size for device {} in {:?} scope. Use default value instead. Error: {}", devid, devtype, e);
cubeb_log!("Cannot get the buffer frame size for device {} in {:?} scope. Using default value instead. Error: {}", devid, devtype, e);
(
10 * dev_info.default_rate / 1000,
100 * dev_info.default_rate / 1000,
Expand Down Expand Up @@ -1659,7 +1658,7 @@ fn audiounit_get_devices_of_type(devtype: DeviceType) -> Vec<AudioObjectID> {
let info = format!("{} ({})", device, label);

if let Ok(channels) = get_channel_count(device, devtype) {
cubeb_log!("device {} has {} {:?}-channels", info, channels, devtype);
cubeb_log!("Device {} has {} {:?}-channels", info, channels, devtype);
if channels > 0 {
devices_in_scope.push(device);
}
Expand Down Expand Up @@ -1755,7 +1754,9 @@ impl DevicesData {
}

fn is_empty(&self) -> bool {
self.changed_callback == None && self.callback_user_ptr.is_null() && self.devices.is_empty()
self.changed_callback.is_none()
&& self.callback_user_ptr.is_null()
&& self.devices.is_empty()
}
}

Expand Down Expand Up @@ -2350,17 +2351,32 @@ impl<'ctx> CoreStreamData<'ctx> {
// It's impossible to create an aggregate device from an aggregate device, and it's
// unnecessary to create an aggregate device when opening the same device input/output. In
// all other cases, use an aggregate device.

let mut either_already_aggregate = false;
if self.has_input() {
either_already_aggregate |=
let input_is_aggregate =
get_device_transport_type(self.input_device.id, DeviceType::INPUT).unwrap_or(0)
== kAudioDeviceTransportTypeAggregate;
if input_is_aggregate {
either_already_aggregate = true;
}
cubeb_log!(
"Input device ID: {} (aggregate: {:?})",
self.input_device.id,
input_is_aggregate
);
}
if self.has_output() {
either_already_aggregate |=
let output_is_aggregate =
get_device_transport_type(self.output_device.id, DeviceType::OUTPUT).unwrap_or(0)
== kAudioDeviceTransportTypeAggregate;
if output_is_aggregate {
either_already_aggregate = true;
}
cubeb_log!(
"Output device ID: {} (aggregate: {:?})",
self.input_device.id,
output_is_aggregate
);
}
// Only use an aggregate device when the device are different.
self.has_input()
Expand Down Expand Up @@ -2437,15 +2453,15 @@ impl<'ctx> CoreStreamData<'ctx> {
out_dev_info.flags = device_flags::DEV_OUTPUT;
self.aggregate_device = Some(device);
cubeb_log!(
"({:p}) Use aggregate device {} for input and output.",
"({:p}) Using an aggregate device {} for input and output.",
self.stm_ptr,
self.aggregate_device.as_ref().unwrap().get_device_id()
);
}
Err(e) => {
cubeb_log!(
"({:p}) Create aggregate devices failed. Error: {}.\
Use assigned devices directly instead.",
"({:p}) Creation of aggregate devices failed. Error: {}.\
Using assigned devices directly instead.",
self.stm_ptr,
e
);
Expand All @@ -2461,7 +2477,7 @@ impl<'ctx> CoreStreamData<'ctx> {
// Configure I/O stream
if self.has_input() {
cubeb_log!(
"({:p}) Initialize input by device info: {:?}",
"({:p}) Initializing input by device info: {:?}",
self.stm_ptr,
in_dev_info
);
Expand Down