Skip to content

kpb: calculate free space in history buffer #2343

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

Closed
bkokoszx wants to merge 3 commits into from
Closed

kpb: calculate free space in history buffer #2343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e85ce1d
kpb: add new state
mrajwa Jan 28, 2020
6c9ff0f
kpb: delete return to preserved state in kpb_init_draining()
bkokoszx Jan 31, 2020
94034bc
kpb: calculate free space in history buffer
bkokoszx Jan 28, 2020
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
38 changes: 26 additions & 12 deletions src/audio/kpb.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ struct comp_data {
size_t buffered_data; /**< keeps info about amount of buffered data */
struct dd draining_task_data;
size_t buffer_size; /**< size of internal history buffer */
size_t hb_free_space; /**< free space in history buffer */
size_t host_buffer_size; /**< size of host buffer */
size_t host_period_size; /**< size of history period */
bool sync_draining_mode; /**< should we synchronize draining with
Expand Down Expand Up @@ -661,22 +662,25 @@ static int kpb_copy(struct comp_dev *dev)
comp_update_buffer_consume(source, copy_bytes);

break;
case KPB_STATE_INIT_DRAINING:

@mrajwa mrajwa Jan 31, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is during "KPB_STATE_INIT_DRAINING" there should be no internal buffering as this can corrupt read pointer calculation.

@bkokoszx bkokoszx Jan 31, 2020 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mrajwa
I agree, but after adding spin lock in #2329, that situation will never happen. We want to properly handle situation when new kpb_copy() will come between kpb_init_draining() and kpb_draining_task().

case KPB_STATE_DRAINING:
/* In draining state we only buffer data in internal,
* history buffer.
/* In init_draining and draining state we only buffer data in
* internal, history buffer.
*/
if (source->stream.avail <= kpb->buffer_size) {
ret = kpb_buffer_data(dev, source,
source->stream.avail);
copy_bytes = MIN(source->stream.avail,
kpb->hb_free_space);

ret = kpb_buffer_data(dev, source, copy_bytes);
if (ret) {
trace_kpb_error_with_ids(dev, "kpb_copy(): "
"internal buffering "
"failed.");
goto out;
}

comp_update_buffer_consume(source,
source->stream.avail);
comp_update_buffer_consume(source, copy_bytes);
kpb->hb_free_space -= copy_bytes;
} else {
trace_kpb_error_with_ids(dev, "kpb_copy(): "
"too much data to buffer.");
Expand Down Expand Up @@ -721,8 +725,12 @@ static int kpb_buffer_data(struct comp_dev *dev,

tracev_kpb_with_ids(dev, "kpb_buffer_data()");

if (kpb->state != KPB_STATE_RUN && kpb->state != KPB_STATE_DRAINING)
if (kpb->state != KPB_STATE_RUN && kpb->state != KPB_STATE_DRAINING &&
kpb->state != KPB_STATE_INIT_DRAINING) {
trace_kpb_error("kpb_buffer_data() error: wrong state! (current state %d, state log %x)",
kpb->state, kpb->state_log);
return PPL_STATUS_PATH_STOP;
}

if (kpb->state == KPB_STATE_DRAINING)
draining_data->buffered_while_draining += size_to_copy;
Expand All @@ -746,8 +754,8 @@ static int kpb_buffer_data(struct comp_dev *dev,
current_time = platform_timer_get(timer);
if (timeout < current_time) {
trace_kpb_error("kpb_buffer_data(): timeout of %d [ms] (current state %d, state log %x)",
current_time - timeout, kpb->state,
kpb->state_log);
current_time - timeout, kpb->state,
kpb->state_log);
return -ETIME;
}

Expand Down Expand Up @@ -946,6 +954,8 @@ static void kpb_init_draining(struct comp_dev *dev, struct kpb_client *cli)
* in the history buffer. All we have to do now is to calculate
* read pointer from which we will start draining.
*/
kpb_change_state(kpb, KPB_STATE_INIT_DRAINING);

do {
/* Calculate how much data we have stored in
* current buffer.
Expand Down Expand Up @@ -999,6 +1009,12 @@ static void kpb_init_draining(struct comp_dev *dev, struct kpb_client *cli)

} while (buff != first_buff);

kpb->hb_free_space = MAX(kpb->buffer_size - history_depth,
kpb->buffer_size - kpb->buffered_data);

/* Change KPB internal state to DRAINING */
kpb_change_state(kpb, KPB_STATE_DRAINING);

/* Should we drain in synchronized mode (sync_draining_mode)?
* Note! We have already verified host params during
* kpb_prepare().
Expand Down Expand Up @@ -1083,9 +1099,6 @@ static enum task_state kpb_draining_task(void *arg)

pm_runtime_disable(PM_RUNTIME_DSP, PLATFORM_MASTER_CORE_ID);

/* Change KPB internal state to DRAINING */
kpb_change_state(kpb, KPB_STATE_DRAINING);

draining_time_start = platform_timer_get(timer);

while (history_depth > 0) {
Expand Down Expand Up @@ -1130,6 +1143,7 @@ static enum task_state kpb_draining_task(void *arg)
history_depth -= size_to_copy;
drained += size_to_copy;
period_bytes += size_to_copy;
kpb->hb_free_space += size_to_copy;

if (move_buffer) {
buff->r_ptr = buff->start_addr;
Expand Down
1 change: 1 addition & 0 deletions src/include/sof/audio/kpb.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ enum kpb_state {
KPB_STATE_PREPARING,
KPB_STATE_RUN,
KPB_STATE_BUFFERING,
KPB_STATE_INIT_DRAINING,
KPB_STATE_DRAINING,
KPB_STATE_HOST_COPY,
KPB_STATE_RESETTING,
Expand Down