simtap 0.0.0-stage → 0.6.0

package/vendor/axe/Frameworks/FBSimulatorControl.framework/Versions/A/Headers/FBSimulatorControl.h

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+// Headers with C type definitions must come before any header that imports
+// FBSimulatorControl-Swift.h, because the generated Swift header may reference
+// these types (e.g. FBSimulatorBootOptions).
+#import <FBSimulatorControl/FBFramebuffer.h>
+#import <FBSimulatorControl/FBPeriodicStatsTimer.h>
+#import <FBSimulatorControl/FBSimDeviceWrapper.h>
+#import <FBSimulatorControl/FBSimulator.h>
+#import <FBSimulatorControl/FBSimulatorBootConfiguration.h>
+#import <FBSimulatorControl/FBSimulatorControlFrameworkLoader.h>
+#import <FBSimulatorControl/FBSimulatorVideoStream.h>
+
+#if __has_include(<FBSimulatorControl/FBSimulatorControl-Swift.h>)
+ #import <FBSimulatorControl/FBSimulatorControl-Swift.h>
+#endif

package/vendor/axe/Frameworks/FBSimulatorControl.framework/Versions/A/Headers/FBSimulatorControlFrameworkLoader.h

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import <FBControlCore/FBControlCore.h>
+
+/**
+ A Class for handling Framework Loading of Private Frameworks that FBSimulatorControl depends on.
+ */
+@interface FBSimulatorControlFrameworkLoader : FBControlCoreFrameworkLoader
+
+/**
+ The Frameworks needed for most operations.
+ */
+@property (class, nonnull, nonatomic, readonly, strong) FBSimulatorControlFrameworkLoader *essentialFrameworks;
+
+/**
+ The frameworks needed for Accessibility operations.
+ */
+@property (class, nonnull, nonatomic, readonly, strong) FBSimulatorControlFrameworkLoader *accessibilityFrameworks;
+
+/**
+ The Xcode frameworks needed to bootstrap simulator Accessibility on Xcode 27+.
+ */
+@property (class, nonnull, nonatomic, readonly, strong) FBSimulatorControlFrameworkLoader *accessibilityAutomationFrameworks;
+
+/**
+ Starts a short-lived remote automation session and asks it to load Accessibility.
+ */
++ (BOOL)bootstrapAccessibilityForSimulatorDevice:(nonnull id)simulatorDevice
+                                         timeout:(NSTimeInterval)timeout
+                                          logger:(nullable id<FBControlCoreLogger>)logger
+                                           error:(NSError * _Nullable * _Nullable)error;
+
+/**
+ All of the Frameworks for operations involving the HID and Framebuffer.
+ */
+@property (class, nonnull, nonatomic, readonly, strong) FBSimulatorControlFrameworkLoader *xcodeFrameworks;
+
+@end

package/vendor/axe/Frameworks/FBSimulatorControl.framework/Versions/A/Headers/FBSimulatorVideoStream.h

@@ -0,0 +1,153 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import <FBControlCore/FBControlCore.h>
+#import <FBSimulatorControl/FBFramebuffer.h>
+
+@class FBFramebuffer;
+@class FBVideoStreamConfiguration;
+@protocol FBDataConsumer;
+@protocol FBDataConsumerSync;
+@protocol FBDataConsumerAsync;
+@protocol FBControlCoreLogger;
+
+/**
+ Edge insets that extend the output frame dimensions beyond the source framebuffer.
+ Each edge adds opaque pixels for overlay content (label bars, diagnostic stats, etc.).
+ */
+typedef struct {
+  NSUInteger top;
+  NSUInteger bottom;
+  NSUInteger left;
+  NSUInteger right;
+} FBVideoStreamEdgeInsets;
+
+/**
+ Stats tracked by the video encoder (VideoToolbox).
+ Zeroed if the stream uses a non-encoded format (e.g. bitmap/BGRA).
+ */
+typedef struct {
+  NSUInteger callbackCount;
+  NSUInteger writeCount;
+  NSUInteger dropCount;
+  NSUInteger writeFailureCount;
+  NSUInteger encodeErrorCount;
+  NSUInteger tornFrameCount;
+  NSUInteger totalEncodedBytes;
+  CFTimeInterval totalEncodeSubmitSeconds;
+} FBVideoEncoderStats;
+
+/**
+ A Video Stream of a Simulator's Framebuffer.
+ This component can be used to provide a real-time stream of a Simulator's Framebuffer.
+ This can be connected to additional software via a stream to a File Handle or Fifo.
+ */
+// FBFramebufferConsumer and FBVideoStream conformance are declared in .m.
+@interface FBSimulatorVideoStream : NSObject
+
+#pragma mark Initializers
+
+/**
+ Constructs a Bitmap Stream.
+ Bitmaps will only be written when there is a new bitmap available.
+
+ @param framebuffer the framebuffer to get frames from.
+ @param configuration the configuration to use.
+ @param logger the logger to log to.
+ @return a new Bitmap Stream object.
+ */
++ (nonnull instancetype)streamWithFramebuffer:(nonnull FBFramebuffer *)framebuffer configuration:(nonnull FBVideoStreamConfiguration *)configuration logger:(nonnull id<FBControlCoreLogger>)logger;
+
+/**
+ Constructs a Bitmap Stream with edge insets for overlay content.
+ Insets extend the output frame dimensions, pushing video content inward.
+
+ @param framebuffer the framebuffer to get frames from.
+ @param configuration the configuration to use.
+ @param edgeInsets the number of output pixels to add on each edge for overlay content.
+ @param logger the logger to log to.
+ @return a new Bitmap Stream object.
+ */
++ (nonnull instancetype)streamWithFramebuffer:(nonnull FBFramebuffer *)framebuffer configuration:(nonnull FBVideoStreamConfiguration *)configuration edgeInsets:(FBVideoStreamEdgeInsets)edgeInsets logger:(nonnull id<FBControlCoreLogger>)logger;
+
+/**
+ Builds the compression session properties dictionary for a given configuration and caller-provided properties.
+ This is extracted for testability — the dictionary is passed to VTSessionSetProperties at stream start.
+
+ @param configuration the stream configuration (encoding, quality, bitrate, etc.).
+ @param callerProperties additional properties from the stream subclass (e.g. FPS-related keys for eager streams).
+ @return an immutable dictionary of compression session properties.
+ */
++ (nonnull NSDictionary<NSString *, id> *)compressionSessionPropertiesForConfiguration:(nonnull FBVideoStreamConfiguration *)configuration callerProperties:(nonnull NSDictionary<NSString *, id> *)callerProperties;
+
+#pragma mark Overlay
+
+/**
+ Update the overlay buffer and push a frame to encode the change.
+ The buffer should be BGRA with premultiplied alpha, ideally IOSurface-backed for zero-copy GPU compositing.
+ Pass the same buffer reference after updating its contents in-place, or a new buffer to swap.
+ Pass nil to clear the overlay.
+
+ In lazy/VFR mode: dispatches pushFrame on the write queue so overlay changes are encoded immediately.
+ In eager/CFR mode: no extra push — the next cadence tick picks up the change without disrupting frame timing.
+
+ @param overlayBuffer a CVPixelBuffer with the overlay content, or nil to clear.
+ */
+- (void)updateOverlayBuffer:(nullable CVPixelBufferRef)overlayBuffer;
+
+#pragma mark Timed Metadata
+
+/**
+ Write a timed metadata marker (chapter) to the stream.
+ Dispatches to the appropriate transport mechanism (MPEG-TS ID3, fMP4 emsg).
+ Logs and drops if the transport does not support timed metadata.
+
+ @param text the chapter/marker label text.
+ */
+- (void)writeTimedMetadata:(nonnull NSString *)text;
+
+#pragma mark Screenshot
+
+/**
+ Capture a PNG screenshot of the current frame with overlay composited.
+
+ @param error an error out for any error that occurs.
+ @return PNG data if successful, nil otherwise.
+ */
+- (nullable NSData *)captureCompositedScreenshotWithError:(NSError * _Nullable * _Nullable)error;
+
+#pragma mark Stats
+
+/**
+ Returns a snapshot of the current video encoder stats.
+ Returns a zeroed struct if the stream uses a non-encoded format (e.g. bitmap/BGRA).
+ */
+- (FBVideoEncoderStats)currentEncoderStats;
+
+/**
+ Returns a snapshot of the current framebuffer stats (from the underlying FBFramebuffer).
+ */
+- (FBFramebufferStats)currentFramebufferStats;
+
+/**
+ Total number of frames pushed to the encoder since streaming started.
+ */
+@property (nonatomic, readonly) NSUInteger currentFrameNumber;
+
+/**
+ Wall-clock time when the first frame was pushed, or 0 if not yet started.
+ */
+@property (nonatomic, readonly) CFTimeInterval currentTimeAtFirstFrame;
+
+/**
+ Wall-clock time when the first framebuffer callback was received, or 0 if not yet started.
+ */
+@property (nonatomic, readonly) CFTimeInterval framebufferStatsStartTime;
+
+@end