openmv/lib/imlib/framebuffer.c
iabdalkader d05d5f1d3c lib/imlib: Use framebuffer_t for main and streaming buffers.
Removes separate jpegbuffer_t and consolidates streaming/preview
functionality into the main framebuffer_t structure.

Main changes:
- Remove jpegbuffer_t structure and global jpegbuffer variable
- Add streaming fields (enabled, quality, lock, raw_w, raw_h) to framebuffer_t
- Replace framebuffer_update_jpeg_buffer() with framebuffer_update_preview()

API improvements:
- Rename framebuffer_init_image() -> framebuffer_to_image()
- Rename framebuffer_init_from_image() -> framebuffer_from_image()
- Add framebuffer_set_enabled() and framebuffer_set_preview() utilities
- Remove accessor macros, use direct field access (kept framebuffer_get_buffer_size)
- Update framebuffer_init() to accept enabled parameter
- Add configurable raw preview dimensions per framebuffer

Signed-off-by: iabdalkader <i.abdalkader@gmail.com>
2025-09-02 15:52:17 +02:00

353 lines
11 KiB
C

/*
* SPDX-License-Identifier: MIT
*
* Copyright (C) 2013-2024 OpenMV, LLC.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* Framebuffer functions.
*/
#include <stdio.h>
#include "py/mphal.h"
#include "mpprint.h"
#include "fmath.h"
#include "framebuffer.h"
#include "omv_boardconfig.h"
// Main framebuffer memory
extern char _fb_memory_start;
extern char _fb_memory_end;
// Streaming buffer memory
extern char _sb_memory_start;
extern char _sb_memory_end;
// Framebuffers array.
static framebuffer_t framebuffers[2];
void framebuffer_init0() {
// Reuse the last enabled flag after resetting the state.
bool enabled = framebuffer_get(FB_STREAM_ID)->enabled;
// Initialize the main framebuffer.
framebuffer_init(framebuffer_get(FB_MAINFB_ID), &_fb_memory_start,
&_fb_memory_end - &_fb_memory_start, false, true);
// Initialize the streaming buffer.
framebuffer_init(framebuffer_get(FB_STREAM_ID), &_sb_memory_start,
&_sb_memory_end - &_sb_memory_start, false, enabled);
}
void framebuffer_init(framebuffer_t *fb, void *buff, size_t size, bool dynamic, bool enabled) {
// Clear framebuffers
memset(fb, 0, sizeof(framebuffer_t));
fb->raw_size = size;
fb->raw_base = buff;
fb->dynamic = dynamic;
fb->enabled = enabled;
#if OMV_RAW_PREVIEW_ENABLE
fb->raw_w = OMV_RAW_PREVIEW_WIDTH;
fb->raw_h = OMV_RAW_PREVIEW_HEIGHT;
#endif
fb->quality = ((OMV_JPEG_QUALITY_HIGH - OMV_JPEG_QUALITY_LOW) / 2) + OMV_JPEG_QUALITY_LOW;
mutex_init0(&fb->lock);
}
void framebuffer_to_image(framebuffer_t *fb, image_t *img) {
if (img != NULL) {
img->w = fb->w;
img->h = fb->h;
img->size = fb->size;
img->pixfmt = fb->pixfmt;
// For streaming buffers (no queues), use raw_base directly
if (fb->used_queue == NULL) {
img->pixels = (uint8_t *)fb->raw_base;
} else {
vbuffer_t *buffer = framebuffer_acquire(fb, FB_FLAG_USED | FB_FLAG_PEEK);
img->pixels = (buffer == NULL) ? NULL : buffer->data;
}
}
}
void framebuffer_from_image(framebuffer_t *fb, image_t *img) {
if (img == NULL) {
fb->w = 0;
fb->h = 0;
fb->size = 0;
fb->pixfmt = PIXFORMAT_INVALID;
} else {
fb->w = img->w;
fb->h = img->h;
fb->size = img->size;
fb->pixfmt = img->pixfmt;
}
}
framebuffer_t *framebuffer_get(size_t id) {
if (id >= FB_MAX_ID) {
return NULL;
}
return &framebuffers[id];
}
char *framebuffer_pool_start(framebuffer_t *fb, size_t buf_count) {
size_t qsize = (buf_count <= 3) ? 0 : queue_calc_size(buf_count);
return fb->raw_base + OMV_ALIGN_TO(qsize * 2, FRAMEBUFFER_ALIGNMENT);
}
char *framebuffer_pool_end(framebuffer_t *fb) {
char *pool_start = framebuffer_pool_start(fb, fb->buf_count);
return pool_start + ((fb->buf_size + sizeof(vbuffer_t)) * fb->buf_count);
}
void *framebuffer_pool_get(framebuffer_t *fb, int32_t index) {
char *pool_start = framebuffer_pool_start(fb, fb->buf_count);
return pool_start + ((fb->buf_size + sizeof(vbuffer_t)) * index);
}
void framebuffer_flush(framebuffer_t *fb) {
// Invalidate the frame buffer.
fb->pixfmt = PIXFORMAT_INVALID;
// Drop all frame buffers.
if (fb->buf_count) {
queue_flush(fb->free_queue);
queue_flush(fb->used_queue);
}
for (size_t i=0; i<fb->buf_count; i++) {
vbuffer_t *buffer = framebuffer_pool_get(fb, i);
// Reset the buffer's state.
framebuffer_reset(buffer);
// Discard any cached CPU writes.
#ifdef __DCACHE_PRESENT
SCB_InvalidateDCache_by_Addr(buffer->data, fb->buf_size);
#endif
// Push it back the free queue.
queue_push(fb->free_queue, buffer);
}
}
int framebuffer_resize(framebuffer_t *fb, size_t count, size_t frame_size, bool expand) {
size_t buf_size = 0;
// Queue size given the requested buffer count.
size_t queue_size = queue_calc_size(count);
// Maximum usable memory size without queues.
size_t min_size = frame_size + sizeof(vbuffer_t);
size_t max_size = fb->raw_size - queue_size * 2;
// Use the frame buffer memory for big queues.
char *queue_memory = (count > 3) ? fb->raw_base : fb->raw_static;
// Calculate a single buffer size (including vbuffer header).
if (!expand) {
// No expansion: buffer size equals frame size plus header.
buf_size = OMV_ALIGN_TO(min_size, FRAMEBUFFER_ALIGNMENT);
} else if (fb->dynamic) {
// Expanding a dynamic FB: divide the raw buffer size evenly.
buf_size = OMV_ALIGN_DOWN(max_size / count, FRAMEBUFFER_ALIGNMENT);
} else {
// Expanding a static FB: calculate the free FB memory size.
size_t fb_size = fb_alloc_sp() - framebuffer_pool_start(fb, count);
max_size = IM_MIN(max_size, fb_size);
buf_size = OMV_ALIGN_DOWN(max_size / count, FRAMEBUFFER_ALIGNMENT);
}
// Ensure that the buffer size is reasonable.
if (buf_size < min_size || buf_size * count > max_size) {
return -1;
}
// Initialize the frame buffer.
fb->expanded = expand;
fb->buf_count = count;
fb->buf_size = buf_size - sizeof(vbuffer_t);
// Initialize the buffer queues.
queue_init(&fb->free_queue, count, &queue_memory[queue_size * 0]);
queue_init(&fb->used_queue, count, &queue_memory[queue_size * 1]);
// Flush and reset the queues.
framebuffer_flush(fb);
return 0;
}
bool framebuffer_writable(framebuffer_t *fb) {
return !queue_is_empty(fb->free_queue);
}
bool framebuffer_readable(framebuffer_t *fb) {
return !queue_is_empty(fb->used_queue);
}
vbuffer_t *framebuffer_acquire(framebuffer_t *fb, uint32_t flags) {
queue_t *queue = (flags & FB_FLAG_USED) ? fb->used_queue : fb->free_queue;
vbuffer_t *buffer = queue_pop(queue, (flags & FB_FLAG_PEEK));
#ifdef __DCACHE_PRESENT
// Discard any cached CPU writes.
if (buffer && (flags & FB_FLAG_INVALIDATE)) {
SCB_InvalidateDCache_by_Addr(buffer->data, fb->buf_size);
}
#endif
return buffer;
}
vbuffer_t *framebuffer_release(framebuffer_t *fb, uint32_t flags) {
vbuffer_t *buffer = NULL;
if ((flags & FB_FLAG_CHECK_LAST) && queue_size(fb->free_queue) == 1) {
if (fb->buf_count == 2) {
// Double buffer: Reset but do Not release the buffer.
vbuffer_t *buffer = queue_pop(fb->free_queue, true);
framebuffer_reset(buffer);
return NULL;
} else if (fb->buf_count == 3) {
// Triple buffer: Swap the old buffer with the latest.
vbuffer_t *buffer = queue_swap(fb->used_queue, fb->free_queue);
framebuffer_reset(buffer);
return NULL;
}
}
if ((buffer = framebuffer_acquire(fb, flags))) {
if (flags & FB_FLAG_USED) {
// Invalidate the frame buffer.
fb->pixfmt = PIXFORMAT_INVALID;
// Move the buffer back to the free queue.
framebuffer_reset(buffer);
queue_push(fb->free_queue, buffer);
} else {
// Move the buffer back to the used queue.
queue_push(fb->used_queue, buffer);
}
}
return buffer;
}
void framebuffer_update_preview(image_t *src) {
static int overflow_count = 0;
framebuffer_t *fb = framebuffer_get(FB_STREAM_ID);
while (fb->quality == 0) {
}
// Check if the streaming buffer is disabled, image is NULL or format is not set.
if (!fb->enabled || !src->data || src->pixfmt == PIXFORMAT_INVALID) {
return;
}
// Lock the streaming buffer.
if (!mutex_try_lock_fair(&fb->lock, MUTEX_TID_OMV)) {
return;
}
if (src->is_compressed) {
if (src->size > fb->raw_size) {
framebuffer_from_image(fb, NULL);
mp_printf(MP_PYTHON_PRINTER, "\x1b[40O\n");
} else {
framebuffer_from_image(fb, src);
memcpy(fb->raw_base, src->pixels, src->size);
}
goto exit_cleanup;
}
image_t dst = {
.w = src->w,
.h = src->h,
.pixfmt = PIXFORMAT_JPEG,
.size = fb->raw_size,
.pixels = (uint8_t *) fb->raw_base
};
bool compress = true;
bool overflow = false;
#if OMV_RAW_PREVIEW_ENABLE
if (src->is_mutable) {
// Down-scale the frame (if necessary) and send the raw frame.
dst.size = src->bpp;
dst.pixfmt = src->pixfmt;
if (src->w <= fb->raw_w && src->h <= fb->raw_h) {
if (image_size(&dst) <= fb->raw_size) {
memcpy(dst.pixels, src->pixels, image_size(src));
compress = false;
}
} else {
float scale = IM_MIN((fb->raw_w / (float) src->w),
(fb->raw_h / (float) src->h));
dst.w = fast_floorf(src->w * scale);
dst.h = fast_floorf(src->h * scale);
if (image_size(&dst) <= fb->raw_size) {
imlib_draw_image(&dst, src, 0, 0, scale, scale, NULL, -1, 255, NULL, NULL,
IMAGE_HINT_BILINEAR | IMAGE_HINT_BLACK_BACKGROUND,
NULL, NULL, NULL, NULL);
compress = false;
}
}
}
#endif
// Compress the frame if the raw image didn't fit or the format is non-mutable.
if (compress) {
overflow = jpeg_compress(src, &dst, fb->quality, false, JPEG_SUBSAMPLING_AUTO);
}
if (overflow) {
// JPEG buffer overflowed, reduce JPEG quality for the next frame
// and skip the current frame. The IDE doesn't receive this frame.
if (fb->quality > 1) {
// Keep this quality for the next n frames
overflow_count = 60;
fb->quality = IM_MAX(1, (fb->quality / 2));
}
framebuffer_from_image(fb, NULL);
} else {
if (overflow_count) {
overflow_count--;
}
// Dynamically adjust our quality if the image is huge.
bool big_frame = image_size(src) > OMV_JPEG_QUALITY_THRESHOLD;
int quality_max = big_frame ? OMV_JPEG_QUALITY_LOW : OMV_JPEG_QUALITY_HIGH;
// No buffer overflow, increase quality up to max quality based on frame size...
if ((!overflow_count) && (fb->quality < quality_max)) {
fb->quality++;
}
framebuffer_from_image(fb, &dst);
}
exit_cleanup:
// Unlock the streaming buffer.
mutex_unlock(&fb->lock, MUTEX_TID_OMV);
}