FG-2933: Add CompressedAudio schema

foxglove · Dec 16, 2024 · 09a6ae0 · 09a6ae0
1 parent 4fc6a4f
commit 09a6ae0
Show file tree

Hide file tree

Showing 15 changed files with 338 additions and 1 deletion.
diff --git a/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap b/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap
@@ -236,6 +236,31 @@ export type CompressedVideo = {
    */
   format: string;
 };
+",
+  "CompressedAudio" => "// Generated by https://github.com/foxglove/schemas
+// Options: {}
+
+import { Time } from "./Time";
+
+/** A single frame of a compressed audio bitstream */
+export type CompressedAudio = {
+  /** Timestamp of audio frame */
+  timestamp: Time;
+
+  /**
+   * Compressed audio frame data.
+   * 
+   * TK
+   */
+  data: Uint8Array;
+
+  /**
+   * Audio format.
+   * 
+   * Supported values: \`opus\`.
+   */
+  format: string;
+};
 ",
   "CylinderPrimitive" => "// Generated by https://github.com/foxglove/schemas
 // Options: {}
@@ -1104,6 +1129,7 @@ export enum PositionCovarianceType {
 export * from "./CameraCalibration";
 export * from "./CircleAnnotation";
 export * from "./Color";
+export * from "./CompressedAudio";
 export * from "./CompressedImage";
 export * from "./CompressedVideo";
 export * from "./CubePrimitive";

diff --git a/internal/schemas.ts b/internal/schemas.ts
@@ -843,6 +843,31 @@ Specifically, the requirements for different \`format\` values are:
   ],
 };
 
+const CompressedAudio: FoxgloveMessageSchema = {
+  type: "message",
+  name: "CompressedAudio",
+  description: "A single frame of a compressed audio bitstream",
+  fields: [
+    {
+      name: "timestamp",
+      type: { type: "primitive", name: "time" },
+      description: "Timestamp of audio frame",
+    },
+    {
+      name: "data",
+      type: { type: "primitive", name: "bytes" },
+      description: `Compressed audio frame data.
+
+TK`,
+    },
+    {
+      name: "format",
+      type: { type: "primitive", name: "string" },
+      description: "Audio format.\n\nSupported values: `opus`.",
+    },
+  ],
+};
+
 const RawImage: FoxgloveMessageSchema = {
   type: "message",
   name: "RawImage",
@@ -1482,6 +1507,7 @@ export const foxgloveMessageSchemas = {
   Color,
   CompressedImage,
   CompressedVideo,
+  CompressedAudio,
   CylinderPrimitive,
   CubePrimitive,
   FrameTransform,

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@foxglove/schemas",
-  "version": "1.6.6",
+  "version": "1.6.7",
   "description": "Foxglove-defined message schemas for ROS, Protobuf, FlatBuffers, OMG IDL, and JSON",
   "license": "MIT",
   "repository": {

diff --git a/ros_foxglove_msgs/ros1/CompressedAudio.msg b/ros_foxglove_msgs/ros1/CompressedAudio.msg
diff --git a/ros_foxglove_msgs/ros2/CompressedAudio.msg b/ros_foxglove_msgs/ros2/CompressedAudio.msg
diff --git a/schemas/README.md b/schemas/README.md
diff --git a/schemas/flatbuffer/CompressedAudio.fbs b/schemas/flatbuffer/CompressedAudio.fbs
diff --git a/schemas/jsonschema/CompressedAudio.json b/schemas/jsonschema/CompressedAudio.json
diff --git a/schemas/jsonschema/index.ts b/schemas/jsonschema/index.ts
diff --git a/schemas/omgidl/foxglove/CompressedAudio.idl b/schemas/omgidl/foxglove/CompressedAudio.idl
diff --git a/schemas/proto/foxglove/CompressedAudio.proto b/schemas/proto/foxglove/CompressedAudio.proto
diff --git a/schemas/ros1/CompressedAudio.msg b/schemas/ros1/CompressedAudio.msg
diff --git a/schemas/ros2/CompressedAudio.msg b/schemas/ros2/CompressedAudio.msg