leonarski_fandClaude Opus 4.8
02514bb6b7
Compress() and FrameTransformation::CompressImage() returned int64_t with a negative value meaning "did not fit". That is a footgun: the negative result silently converts to a huge size_t if a caller forgets to check it. Return size_t and instead throw a named CompressionBufferTooSmallException (deriving from JFJochException, Compression category) when the output would not fit the destination buffer. The receiver catches it explicitly and drops just that frame, as before; the offline/GetCompressedImage path uses a worst-case buffer so it never throws. Add a test that a too-small destination throws and a worst-case buffer does not. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
31 lines
1.1 KiB
C++
31 lines
1.1 KiB
C++
// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
|
|
// SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
#pragma once
|
|
|
|
#include "../common/DiffractionExperiment.h"
|
|
#include "JFJochCompressor.h"
|
|
#include "../common/JFJochMessages.h"
|
|
#include "../fpga/pcie_driver/jfjoch_fpga.h"
|
|
|
|
class FrameTransformation {
|
|
const DiffractionExperiment& experiment;
|
|
JFJochBitShuffleCompressor compressor;
|
|
|
|
std::vector<char> precompression_buffer;
|
|
std::vector<char> compressed_buffer;
|
|
std::vector<char> err_value;
|
|
|
|
const size_t pixel_depth;
|
|
const CompressedImageMode image_mode;
|
|
public:
|
|
explicit FrameTransformation(const DiffractionExperiment &experiment);
|
|
void ProcessModule(const DeviceOutput *output, int data_stream);
|
|
void ProcessModule(const void *input, uint16_t module_number, int data_stream);
|
|
void FillNotCollectedModule(uint16_t module_number, int data_stream);
|
|
CompressedImage GetCompressedImage();
|
|
// Throws CompressionBufferTooSmallException if the image does not fit output_size.
|
|
size_t CompressImage(void *output, size_t output_size);
|
|
const void *GetImage() const;
|
|
};
|