[FL-2655, FL-2650] Buffered file streams (#1424)

* Initial buffered file stream implementation
* Fix logical errors
* Fix more logical errors
* Minimally working implementation
* Adapt infrared unit tests for buffered streams
* Increase read buffer size from 512 to 1K
* Correct naming and formatting
* More code improvements
* Allow passing access and open modes for buffered streams
* Implement tests for buffered streams
* Better file and method names
* Add comments and correct formatting
* Use buffered streams in Infrared
* Fix compilation error

lib/toolbox/stream/buffered_file_stream.c

@@ -0,0 +1,155 @@
+#include "buffered_file_stream.h"
+
+#include "stream_i.h"
+#include "file_stream.h"
+#include "stream_cache.h"
+
+typedef struct {
+    Stream stream_base;
+    Stream* file_stream;
+    StreamCache* cache;
+} BufferedFileStream;
+
+static void buffered_file_stream_free(BufferedFileStream* stream);
+static bool buffered_file_stream_eof(BufferedFileStream* stream);
+static void buffered_file_stream_clean(BufferedFileStream* stream);
+static bool
+    buffered_file_stream_seek(BufferedFileStream* stream, int32_t offset, StreamOffset offset_type);
+static size_t buffered_file_stream_tell(BufferedFileStream* stream);
+static size_t buffered_file_stream_size(BufferedFileStream* stream);
+static size_t
+    buffered_file_stream_write(BufferedFileStream* stream, const uint8_t* data, size_t size);
+static size_t buffered_file_stream_read(BufferedFileStream* stream, uint8_t* data, size_t size);
+static bool buffered_file_stream_delete_and_insert(
+    BufferedFileStream* stream,
+    size_t delete_size,
+    StreamWriteCB write_callback,
+    const void* ctx);
+
+const StreamVTable buffered_file_stream_vtable = {
+    .free = (StreamFreeFn)buffered_file_stream_free,
+    .eof = (StreamEOFFn)buffered_file_stream_eof,
+    .clean = (StreamCleanFn)buffered_file_stream_clean,
+    .seek = (StreamSeekFn)buffered_file_stream_seek,
+    .tell = (StreamTellFn)buffered_file_stream_tell,
+    .size = (StreamSizeFn)buffered_file_stream_size,
+    .write = (StreamWriteFn)buffered_file_stream_write,
+    .read = (StreamReadFn)buffered_file_stream_read,
+    .delete_and_insert = (StreamDeleteAndInsertFn)buffered_file_stream_delete_and_insert,
+};
+
+Stream* buffered_file_stream_alloc(Storage* storage) {
+    BufferedFileStream* stream = malloc(sizeof(BufferedFileStream));
+
+    stream->file_stream = file_stream_alloc(storage);
+    stream->cache = stream_cache_alloc();
+
+    stream->stream_base.vtable = &buffered_file_stream_vtable;
+    return (Stream*)stream;
+}
+
+bool buffered_file_stream_open(
+    Stream* _stream,
+    const char* path,
+    FS_AccessMode access_mode,
+    FS_OpenMode open_mode) {
+    furi_assert(_stream);
+    BufferedFileStream* stream = (BufferedFileStream*)_stream;
+    stream_cache_drop(stream->cache);
+    furi_check(stream->stream_base.vtable == &buffered_file_stream_vtable);
+    return file_stream_open(stream->file_stream, path, access_mode, open_mode);
+}
+
+bool buffered_file_stream_close(Stream* _stream) {
+    furi_assert(_stream);
+    BufferedFileStream* stream = (BufferedFileStream*)_stream;
+    furi_check(stream->stream_base.vtable == &buffered_file_stream_vtable);
+    return file_stream_close(stream->file_stream);
+}
+
+FS_Error buffered_file_stream_get_error(Stream* _stream) {
+    furi_assert(_stream);
+    BufferedFileStream* stream = (BufferedFileStream*)_stream;
+    furi_check(stream->stream_base.vtable == &buffered_file_stream_vtable);
+    return file_stream_get_error(stream->file_stream);
+}
+
+static void buffered_file_stream_free(BufferedFileStream* stream) {
+    furi_assert(stream);
+    stream_free(stream->file_stream);
+    stream_cache_free(stream->cache);
+    free(stream);
+}
+
+static bool buffered_file_stream_eof(BufferedFileStream* stream) {
+    return stream_cache_at_end(stream->cache) && stream_eof(stream->file_stream);
+}
+
+static void buffered_file_stream_clean(BufferedFileStream* stream) {
+    stream_cache_drop(stream->cache);
+    stream_clean(stream->file_stream);
+}
+
+static bool buffered_file_stream_seek(
+    BufferedFileStream* stream,
+    int32_t offset,
+    StreamOffset offset_type) {
+    bool success = false;
+    int32_t new_offset = offset;
+
+    if(offset_type == StreamOffsetFromCurrent) {
+        new_offset -= stream_cache_seek(stream->cache, offset);
+        if(new_offset < 0) {
+            new_offset -= (int32_t)stream_cache_size(stream->cache);
+        }
+    }
+
+    if((new_offset != 0) || (offset_type != StreamOffsetFromCurrent)) {
+        stream_cache_drop(stream->cache);
+        success = stream_seek(stream->file_stream, new_offset, offset_type);
+    } else {
+        success = true;
+    }
+
+    return success;
+}
+
+static size_t buffered_file_stream_tell(BufferedFileStream* stream) {
+    return stream_tell(stream->file_stream) + stream_cache_pos(stream->cache) -
+           stream_cache_size(stream->cache);
+}
+
+static size_t buffered_file_stream_size(BufferedFileStream* stream) {
+    return stream_cache_size(stream->cache) + stream_size(stream->file_stream);
+}
+
+static size_t
+    buffered_file_stream_write(BufferedFileStream* stream, const uint8_t* data, size_t size) {
+    stream_cache_drop(stream->cache);
+    return stream_write(stream->file_stream, data, size);
+}
+
+static size_t buffered_file_stream_read(BufferedFileStream* stream, uint8_t* data, size_t size) {
+    size_t need_to_read = size;
+
+    while(need_to_read) {
+        need_to_read -=
+            stream_cache_read(stream->cache, data + (size - need_to_read), need_to_read);
+        if(need_to_read) {
+            if(!stream_cache_fill(stream->cache, stream->file_stream)) {
+                break;
+            }
+        }
+    }
+
+    return size - need_to_read;
+}
+
+static bool buffered_file_stream_delete_and_insert(
+    BufferedFileStream* stream,
+    size_t delete_size,
+    StreamWriteCB write_callback,
+    const void* ctx) {
+    stream_cache_drop(stream->cache);
+    return stream_delete_and_insert(stream->file_stream, delete_size, write_callback, ctx);
+}