MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
WindowContainer.cpp
Go to the documentation of this file.
1#include "WindowContainer.hpp"
2
12
13namespace MayaFlux::Kakshya {
14
15namespace {
16
17 /**
18 * @brief Map a MayaFlux surface format to the closest Portal ImageFormat.
19 *
20 * Packed A2B10G10R10 has no direct ImageFormat equivalent; it is widened
21 * to RGBA16F so TextureLoom can allocate a sampled image without data loss.
22 */
23 ImageFormat surface_format_to_image_format(
25 {
27 using IF = ImageFormat;
28 switch (fmt) {
29 case SF::B8G8R8A8_SRGB:
30 return IF::BGRA8_SRGB;
31 case SF::B8G8R8A8_UNORM:
32 return IF::BGRA8;
33 case SF::R8G8B8A8_SRGB:
34 return IF::RGBA8_SRGB;
35 case SF::R8G8B8A8_UNORM:
36 return IF::RGBA8;
37 case SF::R16G16B16A16_SFLOAT:
38 case SF::A2B10G10R10_UNORM:
39 return IF::RGBA16F;
40 case SF::R32G32B32A32_SFLOAT:
41 return IF::RGBA32F;
42 default:
43 return IF::BGRA8_SRGB;
44 }
45 }
46
47 Portal::Graphics::ImageKey sampled_image_key(
48 uint32_t width, uint32_t height, ImageFormat format)
49 {
50 return { .width = width, .height = height, .layers = 1, .format = format };
51 }
52
53} // namespace
54
55WindowContainer::WindowContainer(std::shared_ptr<Core::Window> window,
56 uint32_t frame_capacity)
57 : m_window(std::move(window))
58 , m_frame_capacity(frame_capacity)
59{
60 if (!m_window) {
61 error<std::invalid_argument>(
64 std::source_location::current(),
65 "WindowContainer requires a valid window");
66 }
67
68 m_processing_chain = std::make_shared<DataProcessingChain>();
71
73 "WindowContainer created for window '{}' ({}x{} frames={})",
74 m_window->get_create_info().title,
76}
77
79{
80 return surface_format_to_image_format(query_surface_format(m_window));
81}
82
83// =========================================================================
84// Setup
85// =========================================================================
86
88{
89 const auto& state = m_window->get_state();
90 const uint32_t w = state.current_width;
91 const uint32_t h = state.current_height;
92 const uint32_t c = m_window->get_create_info().container_format.color_channels;
93 const size_t sz = static_cast<size_t>(w) * h * c;
94
96
99 { static_cast<uint64_t>(m_frame_capacity),
100 static_cast<uint64_t>(h),
101 static_cast<uint64_t>(w),
102 static_cast<uint64_t>(c) },
104
105 m_data.resize(m_frame_capacity);
106 for (auto& slot : m_data)
107 slot = std::vector<uint8_t>(sz, 0U);
108
110 m_normalised_dirty = std::vector<std::atomic<bool>>(m_frame_capacity);
111 for (auto& flag : m_normalised_dirty)
112 flag.store(true, std::memory_order_relaxed);
113
114 m_processed_data.resize(1);
115 m_processed_data[0] = std::vector<uint8_t>(sz, 0U);
116}
117
118uint8_t* WindowContainer::mutable_frame_ptr(uint32_t frame_index)
119{
120 if (frame_index >= m_data.size())
121 return nullptr;
122
123 auto* v = std::get_if<std::vector<uint8_t>>(&m_data[frame_index]);
124 return (v && !v->empty()) ? v->data() : nullptr;
125}
126
128{
129 m_write_head.store((m_write_head.load(std::memory_order_relaxed) + 1U) % m_frame_capacity,
130 std::memory_order_release);
131 m_frames_written.fetch_add(1U, std::memory_order_release);
132}
133
134// =========================================================================
135// NDDimensionalContainer
136// =========================================================================
137
138std::vector<DataDimension> WindowContainer::get_dimensions() const
139{
140 return m_structure.dimensions;
141}
142
147
152
157
158std::vector<DataVariant> WindowContainer::get_region_data(const Region& region) const
159{
160 std::vector<DataVariant> result;
161
162 seqlock_read_void(m_data_lock, 8, [&] {
163 if (m_processed_data.empty())
164 return;
165 const auto* src = std::get_if<std::vector<uint8_t>>(&m_processed_data[0]);
166 if (!src || src->empty())
167 return;
168
169 const std::span<const uint8_t> src_span { src->data(), src->size() };
170 const auto& dims = m_structure.dimensions;
171
172 for (const auto& [name, group] : m_region_groups) {
173 for (const auto& r : group.regions) {
174 if (!regions_intersect(r, region))
175 continue;
176 try {
177 result.emplace_back(extract_nd_region<uint8_t>(src_span, r, dims));
178 } catch (const std::exception& e) {
180 "WindowContainer::get_region_data extraction failed : {}", e.what());
181 }
182 }
183 }
184 });
185 return result;
186}
187
188std::shared_ptr<Core::VKImage> WindowContainer::to_image() const
189{
190 auto pixels = snapshot_pixels();
191 if (!pixels)
192 return nullptr;
193
194 const auto format = get_image_format();
197 m_surface_image, sampled_image_key(pixels->width, pixels->height, format),
198 pixels->pixels);
199}
200
201std::shared_ptr<Core::VKImage> WindowContainer::to_image(
202 const std::shared_ptr<Buffers::VKBuffer>& staging) const
203{
204 auto pixels = snapshot_pixels();
205 if (!pixels)
206 return nullptr;
207
208 const auto format = get_image_format();
211 m_surface_image, sampled_image_key(pixels->width, pixels->height, format),
212 pixels->pixels, staging);
213}
214
215std::shared_ptr<Core::VKImage> WindowContainer::image_at(uint32_t frame_index) const
216{
217 if (frame_index >= m_data.size()) {
219 "WindowContainer::to_image({}) : out of range (capacity={})",
220 frame_index, m_frame_capacity);
221 return nullptr;
222 }
223
224 const uint64_t written = m_frames_written.load(std::memory_order_acquire);
225 const uint32_t head = m_write_head.load(std::memory_order_acquire);
226 const bool ring_full = written >= m_frame_capacity;
227
228 if (!ring_full && frame_index >= head) {
230 "WindowContainer::image_at({}) : frame index is ahead of write head ({}), data may be stale or uninitialized",
231 frame_index, head);
232 return nullptr;
233 }
234
235 auto pixels = snapshot_pixels(frame_index);
236 if (!pixels)
237 return nullptr;
238
239 const auto format = get_image_format();
242 m_frame_images[frame_index], sampled_image_key(pixels->width, pixels->height, format),
243 pixels->pixels);
244}
245
246std::shared_ptr<Core::VKImage> WindowContainer::image_at(
247 uint32_t frame_index, const std::shared_ptr<Buffers::VKBuffer>& staging) const
248{
249 if (frame_index >= m_data.size()) {
251 "WindowContainer::image_at(staging, {}) : out of range (capacity={})",
252 frame_index, m_frame_capacity);
253 return nullptr;
254 }
255
256 const uint64_t written = m_frames_written.load(std::memory_order_acquire);
257 const uint32_t head = m_write_head.load(std::memory_order_acquire);
258 const bool ring_full = written >= m_frame_capacity;
259 if (!ring_full && frame_index >= head) {
261 "WindowContainer::image_at(staging, {}) : frame index is ahead of write head ({}), data may be stale or uninitialized",
262 frame_index, head);
263 return nullptr;
264 }
265
266 auto pixels = snapshot_pixels(frame_index);
267 if (!pixels)
268 return nullptr;
269
270 const auto format = get_image_format();
273 m_frame_images[frame_index], sampled_image_key(pixels->width, pixels->height, format),
274 pixels->pixels, staging);
275}
276
277std::shared_ptr<Core::VKImage> WindowContainer::region_to_image(const Region& region) const
278{
279 if (region.start_coordinates.size() < 2 || region.end_coordinates.size() < 2) {
281 "WindowContainer::region_to_image — region must have at least 2 coordinates (SPATIAL_Y, SPATIAL_X)");
282 return nullptr;
283 }
284
285 if (region.start_coordinates[0] > region.end_coordinates[0]
286 || region.start_coordinates[1] > region.end_coordinates[1]) {
288 "WindowContainer::region_to_image : inverted region");
289 return nullptr;
290 }
291
292 auto pixels = snapshot_pixels();
293 if (!pixels)
294 return nullptr;
295
296 std::vector<uint8_t> cropped;
297 try {
298 cropped = extract_region_data<uint8_t>(
299 std::span<const uint8_t> { pixels->pixels.data(), pixels->pixels.size() },
300 region,
301 pixels->dimensions);
302 } catch (const std::exception& e) {
304 "WindowContainer::region_to_image : crop failed for '{}': {}",
305 m_window->get_create_info().title, e.what());
306 return nullptr;
307 }
308
309 const auto rh = static_cast<uint32_t>(region.end_coordinates[0] - region.start_coordinates[0] + 1);
310 const auto rw = static_cast<uint32_t>(region.end_coordinates[1] - region.start_coordinates[1] + 1);
311 const auto key = std::pair { rw, rh };
312 const auto format = get_image_format();
315 m_region_images[key], sampled_image_key(rw, rh, format), cropped);
316}
317
318std::optional<WindowContainer::PixelSnapshot> WindowContainer::snapshot_pixels(
319 std::optional<uint32_t> frame_index) const
320{
321 auto snapshot = seqlock_read(m_data_lock, 8, [&]() -> PixelSnapshot {
322 const auto& data = frame_index ? m_data : m_processed_data;
323 const auto index = frame_index.value_or(0);
324
325 if (index >= data.size())
326 return {};
327
328 const auto* source = std::get_if<std::vector<uint8_t>>(&data[index]);
329
330 if (!source)
331 return {};
332
333 return {
334 .pixels = *source,
335 .dimensions = m_structure.dimensions,
336 .width = static_cast<uint32_t>(m_structure.get_width()),
337 .height = static_cast<uint32_t>(m_structure.get_height())
338 };
339 });
340
341 if (!snapshot || snapshot->pixels.empty()) {
343 "WindowContainer : no usable pixel data for '{}'",
344 m_window->get_create_info().title);
345 return std::nullopt;
346 }
347 return snapshot;
348}
349
350void WindowContainer::set_region_data(const Region& /*region*/, const std::vector<DataVariant>& /*data*/)
351{
353 "WindowContainer::set_region_data — write path not yet implemented");
354}
355
356std::vector<DataVariant> WindowContainer::get_region_group_data(const RegionGroup& /*group*/) const
357{
358 std::optional<std::vector<DataVariant>> result;
359 seqlock_read_void(m_data_lock, 8, [&] {
360 result = m_processed_data;
361 });
362 return result.value_or(std::vector<DataVariant> {});
363}
364
365std::vector<DataVariant> WindowContainer::get_segments_data(const std::vector<RegionSegment>& /*segments*/) const
366{
367 std::optional<std::vector<DataVariant>> result;
368 seqlock_read_void(m_data_lock, 8, [&] {
369 result = m_processed_data;
370 });
371 return result.value_or(std::vector<DataVariant> {});
372}
373
374uint64_t WindowContainer::coordinates_to_linear_index(const std::vector<uint64_t>& coordinates) const
375{
376 return coordinates_to_linear(coordinates, m_structure.dimensions);
377}
378
379std::vector<uint64_t> WindowContainer::linear_index_to_coordinates(uint64_t index) const
380{
382}
383
385{
386 {
388 const size_t sz = m_structure.get_width() * m_structure.get_height()
390 m_processed_data.resize(1);
391 m_processed_data[0] = std::vector<uint8_t>(sz, 0U);
392 if (!m_normalised_dirty.empty())
393 m_normalised_dirty[0].store(true, std::memory_order_release);
394 }
396}
397
399{
400 if (m_processed_data.empty())
401 return nullptr;
402 const auto* v = std::get_if<std::vector<uint8_t>>(&m_processed_data[0]);
403 return (v && !v->empty()) ? v->data() : nullptr;
404}
405
407{
408 bool result = false;
409 seqlock_read_void(m_data_lock, 8, [&] {
410 if (m_processed_data.empty())
411 return;
412 result = std::visit([](const auto& v) { return !v.empty(); }, m_processed_data[0]);
413 });
414 return result;
415}
416
418{
420 "WindowContainer::load_region — no-op. Register regions via add_region_group()");
421}
422
424{
426 "WindowContainer::unload_region — no-op. Remove regions via remove_region_group()");
427}
428
429bool WindowContainer::is_region_loaded(const Region& /*region*/) const
430{
431 return true;
432}
433
435{
437 m_write_head.store(0, std::memory_order_release);
438 m_frames_written.store(0, std::memory_order_release);
440}
441
442std::span<const float> WindowContainer::processed_frame_as_float(uint32_t frame_index) const
443{
444 if (frame_index >= m_processed_data.size())
445 return {};
446
447 if (!m_normalised_dirty[frame_index].load(std::memory_order_acquire))
448 return { m_normalised_cache[frame_index] };
449
450 std::span<const float> result;
451 seqlock_read_void(m_data_lock, 8, [&] {
452 result = Kakshya::as_normalised_float(m_processed_data[frame_index], m_normalised_cache[frame_index]);
453 });
454
455 if (!result.empty())
456 m_normalised_dirty[frame_index].store(false, std::memory_order_release);
457
458 return result;
459}
460
462{
463 if (frame_index >= m_normalised_dirty.size())
464 return;
465 m_normalised_dirty[frame_index].store(true, std::memory_order_release);
466}
467
468// =========================================================================
469// RegionGroup management
470// =========================================================================
471
477
479{
480 static const RegionGroup empty;
481 std::optional<RegionGroup> result;
482 seqlock_read_void(m_region_lock, 8, [&] {
483 auto it = m_region_groups.find(name);
484 result = (it != m_region_groups.end()) ? it->second : empty;
485 });
486 return result.value_or(empty);
487}
488
489std::unordered_map<std::string, RegionGroup> WindowContainer::get_all_region_groups() const
490{
491 std::optional<std::unordered_map<std::string, RegionGroup>> result;
492 seqlock_read_void(m_region_lock, 8, [&] {
493 result = m_region_groups;
494 });
495 return result.value_or(std::unordered_map<std::string, RegionGroup> {});
496}
497
503
504// =========================================================================
505// SignalSourceContainer
506// =========================================================================
507
512
514{
515 ProcessingState old = m_processing_state.exchange(new_state);
516 if (old == new_state)
517 return;
518
519 seqlock_read_void(m_cb_lock, 8, [&] {
521 m_state_callback(shared_from_this(), new_state);
522 });
523}
524
526 std::function<void(const std::shared_ptr<SignalSourceContainer>&, ProcessingState)> callback)
527{
529 m_state_callback = std::move(callback);
530}
531
537
539{
540 return m_ready_for_processing.load(std::memory_order_acquire);
541}
542
544{
545 m_ready_for_processing.store(ready, std::memory_order_release);
546}
547
549{
550 auto readback = std::make_shared<WindowAccessProcessor>();
551 readback->on_attach(shared_from_this());
552 m_default_processor = readback;
553}
554
556{
558 m_default_processor->process(shared_from_this());
559}
560
561void WindowContainer::set_default_processor(const std::shared_ptr<DataProcessor>& proc)
562{
564 m_default_processor->on_detach(shared_from_this());
565 m_default_processor = proc;
567 m_default_processor->on_attach(shared_from_this());
568}
569
570std::shared_ptr<DataProcessor> WindowContainer::get_default_processor() const
571{
572 return m_default_processor;
573}
574
575std::shared_ptr<DataProcessingChain> WindowContainer::get_processing_chain()
576{
578 m_processing_chain = std::make_shared<DataProcessingChain>();
579
580 return m_processing_chain;
581}
582
583void WindowContainer::set_processing_chain(const std::shared_ptr<DataProcessingChain>& chain)
584{
586}
587
588// =========================================================================
589// Consumer tracking
590// =========================================================================
591
592uint32_t WindowContainer::register_dimension_reader(uint32_t /*slot_index*/)
593{
595 return m_next_reader_id.fetch_add(1, std::memory_order_relaxed);
596}
597
599{
600 if (m_registered_readers.load(std::memory_order_relaxed) > 0)
602}
603
605{
606 return m_registered_readers.load(std::memory_order_acquire) > 0;
607}
608
609void WindowContainer::mark_dimension_consumed(uint32_t /*slot_index*/, uint32_t /*reader_id*/)
610{
611 m_consumed_readers.fetch_add(1, std::memory_order_release);
612}
613
615{
616 return m_consumed_readers.load(std::memory_order_acquire)
617 >= m_registered_readers.load(std::memory_order_acquire);
618}
619
620// =========================================================================
621// Data access
622// =========================================================================
623
624std::vector<DataVariant>& WindowContainer::get_processed_data()
625{
626 return m_processed_data;
627}
628
629const std::vector<DataVariant>& WindowContainer::get_processed_data() const
630{
631 return m_processed_data;
632}
633
634const std::vector<DataVariant>& WindowContainer::get_data()
635{
636 return m_data;
637}
638
640{
642 "WindowContainer::channel_data — not meaningful for interleaved image data; returning full surface");
644}
645
650
652{
654}
655
657{
658 return m_structure.get_height();
659}
660
661auto WindowContainer::get_frame_span_impl(uint64_t frame_index) const -> DataSpanVariant
662{
663 return { get_frame_typed(frame_index) };
664}
665
667 void* output,
668 size_t count,
669 uint64_t start_frame,
670 uint64_t num_frames,
671 const std::type_info& type) const
672{
673 if (type != typeid(uint8_t)) {
674 error<std::runtime_error>(
677 std::source_location::current(),
678 "WindowContainer only supports uint8_t");
679 }
680
681 get_frames_typed(std::span<uint8_t>(static_cast<uint8_t*>(output), count), start_frame, num_frames);
682}
683
684auto WindowContainer::get_frame_typed(uint64_t frame_index) const -> std::span<const uint8_t>
685{
686 std::span<const uint8_t> result;
687 seqlock_read_void(m_data_lock, 8, [&] {
688 const uint64_t h = m_structure.get_height();
689 if (frame_index >= h || m_processed_data.empty())
690 return;
691
692 const auto* pixels = std::get_if<std::vector<uint8_t>>(&m_processed_data[0]);
693 if (!pixels || pixels->empty())
694 return;
695
696 const uint64_t row_elems = m_structure.get_width() * m_structure.get_channel_count();
697 const uint64_t offset = frame_index * row_elems;
698 if (offset + row_elems > pixels->size())
699 return;
700
701 result = std::span<const uint8_t>(pixels->data() + offset, row_elems);
702 });
703
704 return result;
705}
706
707void WindowContainer::get_frames_typed(std::span<uint8_t> output, uint64_t start_frame, uint64_t num_frames) const
708{
709 seqlock_read_void(m_data_lock, 8, [&] {
710 const uint64_t h = m_structure.get_height();
711 if (start_frame >= h || output.empty() || m_processed_data.empty()) {
712 std::ranges::fill(output, uint8_t { 0 });
713 return;
714 }
715
716 const auto* pixels = std::get_if<std::vector<uint8_t>>(&m_processed_data[0]);
717 if (!pixels || pixels->empty()) {
718 std::ranges::fill(output, uint8_t { 0 });
719 return;
720 }
721
722 const uint64_t row_elems = m_structure.get_width() * m_structure.get_channel_count();
723 const uint64_t frames_to_copy = std::min(num_frames, h - start_frame);
724 const uint64_t elems_to_copy = std::min(frames_to_copy * row_elems, static_cast<uint64_t>(output.size()));
725 const uint64_t src_offset = start_frame * row_elems;
726
727 std::copy_n(pixels->begin() + static_cast<std::ptrdiff_t>(src_offset),
728 static_cast<std::ptrdiff_t>(elems_to_copy),
729 output.begin());
730
731 if (elems_to_copy < output.size())
732 std::fill(output.begin() + static_cast<std::ptrdiff_t>(elems_to_copy), output.end(), uint8_t { 0 });
733 });
734}
735
736void WindowContainer::get_value_impl(
737 const std::vector<uint64_t>& coords,
738 void* out,
739 const std::type_info& type) const
740{
741 if (type != typeid(uint8_t) || coords.size() < 3)
742 return;
743
744 const uint64_t w = m_structure.get_width();
745 const uint64_t c = m_structure.get_channel_count();
746 const uint64_t idx = (coords[0] * w + coords[1]) * c + coords[2];
747
748 seqlock_read_void(m_data_lock, 8, [&] {
749 if (m_processed_data.empty())
750 return;
751 const auto* pixels = std::get_if<std::vector<uint8_t>>(&m_processed_data[0]);
752 if (!pixels || idx >= pixels->size())
753 return;
754 *static_cast<uint8_t*>(out) = (*pixels)[idx];
755 });
756}
757
758} // namespace MayaFlux::Kakshya
#define MF_INFO(comp, ctx,...)
#define MF_RT_WARN(comp, ctx,...)
#define MF_RT_ERROR(comp, ctx,...)
#define MF_WARN(comp, ctx,...)
uint64_t offset
Definition Composite.cpp:10
const std::vector< float > * pixels
Definition Decoder.cpp:48
bool format
uint32_t h
Definition InkPress.cpp:29
BufferProcessingChain * chain
PickCallback callback
Definition Picker.cpp:22
std::weak_ptr< Core::Window > window
Definition Picker.cpp:23
const uint32_t * src
std::vector< float > * out
std::vector< glm::ivec3 > coords
Definition VDBWriter.cpp:25
vk::PhysicalDeviceType type
Definition VKDevice.cpp:126
std::string name
Definition VKDevice.cpp:123
uint32_t index
Definition VKDevice.cpp:122
size_t count
uint32_t width
uint32_t height
Type-erased accessor for NDData with semantic view construction.
uint64_t coordinates_to_linear_index(const std::vector< uint64_t > &coordinates) const override
Convert coordinates to linear index based on current memory layout.
ProcessingState get_processing_state() const override
Get the current processing state of the container.
std::atomic< uint32_t > m_registered_readers
std::optional< PixelSnapshot > snapshot_pixels(std::optional< uint32_t > frame_index=std::nullopt) const
std::function< void(const std::shared_ptr< SignalSourceContainer > &, ProcessingState)> m_state_callback
std::atomic< ProcessingState > m_processing_state
void set_processing_chain(const std::shared_ptr< DataProcessingChain > &chain) override
Set the processing chain for this container.
void create_default_processor() override
Create and configure a default processor for this container.
DataAccess channel_data(size_t channel_index) override
Get channel data with semantic interpretation.
ImageFormat get_image_format() const
Portal ImageFormat corresponding to the live swapchain surface format.
bool is_region_loaded(const Region &region) const override
Always returns true.
void invalidate_float_frame_cache(uint32_t frame_index=0)
Invalidate the normalised float cache for a specific processed_data slot.
void set_memory_layout(MemoryLayout layout) override
Set the memory layout for this container.
void unregister_dimension_reader(uint32_t dimension_index) override
Unregister a reader for a specific dimension.
std::shared_ptr< Core::VKImage > to_image() const
Upload the full surface readback to a container-owned VKImage.
WindowContainer(std::shared_ptr< Core::Window > window, uint32_t frame_capacity=60)
Construct from an existing managed window.
std::shared_ptr< Core::VKImage > image_at(uint32_t frame_index) const
Refresh the cached VKImage for m_data[frame_index].
void clear() override
Clear all data in the container.
void unregister_state_change_callback() override
Unregister the state change callback, if any.
std::shared_ptr< Core::Window > m_window
uint64_t get_total_elements() const override
Get the total number of elements in the container.
const void * get_raw_data() const override
Get a raw pointer to the underlying data storage.
std::shared_ptr< Core::VKImage > region_to_image(const Region &region) const
Crop a region from the last readback and refresh its cached VKImage.
std::vector< DataDimension > get_dimensions() const override
Get the dimensions describing the structure of the data.
std::atomic< uint32_t > m_consumed_readers
const std::vector< DataVariant > & get_data() override
Get a reference to the raw data stored in the container.
void load_region(const Region &region) override
No-op.
Portal::Graphics::ImageCacheEntry m_surface_image
std::vector< std::vector< float > > m_normalised_cache
void get_frames_impl(void *output, size_t count, uint64_t start_frame, uint64_t num_frames, const std::type_info &type) const override
Implementation-specific method to retrieve multiple frames.
std::vector< DataVariant > m_processed_data
uint64_t get_num_frames() const override
Get the number of frames in the primary (temporal) dimension.
std::vector< std::atomic< bool > > m_normalised_dirty
std::unordered_map< std::string, RegionGroup > m_region_groups
void mark_dimension_consumed(uint32_t dimension_index, uint32_t reader_id) override
Mark a dimension as consumed for the current processing cycle.
uint8_t * mutable_frame_ptr(uint32_t frame_index)
Mutable pointer into m_data[frame_index] for the processor to write into.
uint32_t register_dimension_reader(uint32_t dimension_index) override
Register a reader for a specific dimension.
std::unordered_map< std::string, RegionGroup > get_all_region_groups() const override
Get all region groups in the container.
void get_frames_typed(std::span< uint8_t > output, uint64_t start_frame, uint64_t num_frames) const
std::vector< DataVariant > m_data
void update_processing_state(ProcessingState new_state) override
Update the processing state of the container.
void mark_ready_for_processing(bool ready) override
Mark the container as ready or not ready for processing.
std::vector< DataVariant > get_region_group_data(const RegionGroup &group) const override
Get data for multiple regions efficiently.
std::shared_ptr< DataProcessingChain > m_processing_chain
std::shared_ptr< DataProcessor > m_default_processor
uint64_t get_frame_size() const override
Get the number of elements that constitute one "frame".
std::atomic< uint64_t > m_frames_written
bool has_data() const override
Check if the container currently holds any data.
void remove_region_group(const std::string &name) override
Remove a region group by name.
void set_default_processor(const std::shared_ptr< DataProcessor > &processor) override
Set the default data processor for this container.
std::vector< Portal::Graphics::ImageCacheEntry > m_frame_images
MemoryLayout get_memory_layout() const override
Get the memory layout used by this container.
bool has_active_readers() const override
Check if any dimensions currently have active readers.
std::vector< DataVariant > get_segments_data(const std::vector< RegionSegment > &segments) const override
Get data for multiple region segments efficiently.
std::vector< DataVariant > get_region_data(const Region &region) const override
Extract data for all regions across all region groups that spatially intersect region.
auto get_frame_typed(uint64_t frame_index) const -> std::span< const uint8_t >
void set_region_data(const Region &region, const std::vector< DataVariant > &data) override
Set data for a specific region.
std::shared_ptr< DataProcessor > get_default_processor() const override
Get the current default data processor.
void unload_region(const Region &region) override
No-op.
std::vector< DataAccess > all_channel_data() override
Get all channel data as accessors.
std::span< const float > processed_frame_as_float(uint32_t frame_index=0) const
processed_data[frame_index] as a normalised float span.
bool all_dimensions_consumed() const override
Check if all active dimensions have been consumed in this cycle.
std::vector< DataVariant > & get_processed_data() override
Get a mutable reference to the processed data buffer.
void register_state_change_callback(std::function< void(const std::shared_ptr< SignalSourceContainer > &, ProcessingState)> callback) override
Register a callback to be invoked on processing state changes.
std::map< std::pair< uint32_t, uint32_t >, Portal::Graphics::ImageCacheEntry > m_region_images
std::shared_ptr< DataProcessingChain > get_processing_chain() override
Get the current processing chain for this container.
RegionGroup get_region_group(const std::string &name) const override
Get a region group by name.
void process_default() override
Process the container's data using the default processor.
void handle_surface_resize()
Reallocate m_data and m_processed_data to match the current window dimensions.
void advance_write_head()
Advance the write head index, wrapping around frame_capacity.
bool is_ready_for_processing() const override
Check if the container is ready for processing.
std::vector< uint64_t > linear_index_to_coordinates(uint64_t linear_index) const override
Convert linear index to coordinates based on current memory layout.
std::atomic< uint32_t > m_next_reader_id
auto get_frame_span_impl(uint64_t frame_index) const -> DataSpanVariant override
Implementation-specific method to retrieve a frame span.
void add_region_group(const RegionGroup &group) override
Add a named group of regions to the container.
RAII guard that brackets a Seqlock write region.
Definition SeqLock.hpp:155
Scope guard for a serialized Seqlock write.
Definition SeqLock.hpp:184
std::shared_ptr< Core::VKImage > refresh_cached_image(ImageCacheEntry &entry, const ImageKey &key, std::span< const uint8_t > pixels, const std::shared_ptr< Buffers::VKBuffer > &staging={})
Refresh a sampled image in an owner-held cache entry.
@ ContainerProcessing
Container operations (Kakshya - file/stream/region processing)
@ Runtime
General runtime operations (default fallback)
@ Kakshya
Containers[Signalsource, Stream, File], Regions, DataProcessors.
ProcessingState
Represents the current processing lifecycle state of a container.
@ IDLE
Container is inactive with no data or not ready for processing.
ImageFormat
User-friendly image format enum.
Definition ImageData.hpp:12
typename detail::span_const_from_vector_variant< DataVariant >::type DataSpanVariant
Definition NDData.hpp:625
std::span< const float > as_normalised_float(const DataVariant &variant, std::vector< float > &storage)
Extract a DataVariant holding pixel data as a normalised float span.
Definition DataUtils.cpp:61
uint64_t coordinates_to_linear(const std::vector< uint64_t > &coords, const std::vector< DataDimension > &dimensions)
Convert N-dimensional coordinates to a linear index for interleaved data.
Definition CoordUtils.cpp:8
@ VIDEO_COLOR
4D video (time + 2D + color)
@ IMAGE_COLOR
2D RGB/RGBA image
bool regions_intersect(const Region &r1, const Region &r2) noexcept
Test whether two N-dimensional regions overlap on every shared axis.
MemoryLayout
Memory layout for multi-dimensional data.
Definition NDData.hpp:33
@ ROW_MAJOR
C/C++ style (last dimension varies fastest)
std::vector< uint64_t > linear_to_coordinates(uint64_t index, const std::vector< DataDimension > &dimensions)
Convert a linear index to N-dimensional coordinates for interleaved data.
Core::GraphicsSurfaceInfo::SurfaceFormat query_surface_format(const std::shared_ptr< Core::Window > &window)
Query the actual vk::Format in use by the window's live swapchain, translated back to the MayaFlux su...
std::shared_ptr< T > store(std::shared_ptr< T > obj)
Transfer ownership of an existing object to the persistent store for process lifetime.
Definition Persist.hpp:28
SurfaceFormat
Default pixel format for window surfaces (Vulkan-compatible)
static uint64_t get_height(const std::vector< DataDimension > &dimensions)
Extract height from image/video dimensions.
static uint64_t get_channel_count(const std::vector< DataDimension > &dimensions)
Extract channel count from dimensions.
static size_t get_frame_size(const std::vector< DataDimension > &dimensions)
Extract the size of non time dimensions (channel, spatial, frequency)
static ContainerDataStructure image_interleaved()
Create structure for interleaved image data.
static uint64_t get_total_elements(const std::vector< DataDimension > &dimensions)
Get total elements across all dimensions.
static uint64_t get_width(const std::vector< DataDimension > &dimensions)
Extract width from image/video dimensions.
static std::vector< DataDimension > create_dimensions(DataModality modality, const std::vector< uint64_t > &shape, MemoryLayout layout=MemoryLayout::ROW_MAJOR)
Create dimension descriptors for a data modality.
Definition NDData.cpp:127
std::string name
Descriptive name of the group.
Organizes related signal regions into a categorized collection.
std::vector< uint64_t > end_coordinates
Ending frame index (inclusive)
Definition Region.hpp:78
std::vector< uint64_t > start_coordinates
Starting frame index (inclusive)
Definition Region.hpp:75
Represents a point or span in N-dimensional space.
Definition Region.hpp:73