Skip to content

Commit

Permalink
Update CompressedVideo format strings again, bump package versions (#157
Browse files Browse the repository at this point in the history
)

Update CompressedVideo documentation for new formats, bump all package
versions
  • Loading branch information
jtbandes authored Dec 11, 2024
1 parent 1adbc24 commit 292b165
Show file tree
Hide file tree
Showing 18 changed files with 69 additions and 29 deletions.
7 changes: 5 additions & 2 deletions internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,9 @@ export type CompressedVideo = {
* - Each CompressedVideo message should contain enough NAL units to decode exactly one video frame
* - Each message containing a key frame (IRAP) must also include relevant VPS/SPS/PPS NAL units
*
* - \`vp9\`
* - Each CompressedVideo message should contain exactly one video frame
*
* - \`av1\`
* - Use the "Low overhead bitstream format" (section 5.2)
* - Each CompressedVideo message should contain enough OBUs to decode exactly one video frame
Expand All @@ -227,9 +230,9 @@ export type CompressedVideo = {
/**
* Video format.
*
* Supported values: \`h264\`, \`h265\`, \`av1\`.
* Supported values: \`h264\`, \`h265\`, \`vp9\`, \`av1\`.
*
* Note: compressed video support is subject to hardware limitations and patent licensing, so not all encodings may be supported on all platforms. See more about [H.265 support](https://caniuse.com/hevc) and [AV1 support](https://caniuse.com/av1).
* Note: compressed video support is subject to hardware limitations and patent licensing, so not all encodings may be supported on all platforms. See more about [H.265 support](https://caniuse.com/hevc), [VP9 support](https://caniuse.com/webm), and [AV1 support](https://caniuse.com/av1).
*/
format: string;
};
Expand Down
5 changes: 4 additions & 1 deletion internal/schemas.ts
Original file line number Diff line number Diff line change
Expand Up @@ -826,6 +826,9 @@ Specifically, the requirements for different \`format\` values are:
- Each CompressedVideo message should contain enough NAL units to decode exactly one video frame
- Each message containing a key frame (IRAP) must also include relevant VPS/SPS/PPS NAL units
- \`vp9\`
- Each CompressedVideo message should contain exactly one video frame
- \`av1\`
- Use the "Low overhead bitstream format" (section 5.2)
- Each CompressedVideo message should contain enough OBUs to decode exactly one video frame
Expand All @@ -835,7 +838,7 @@ Specifically, the requirements for different \`format\` values are:
name: "format",
type: { type: "primitive", name: "string" },
description:
"Video format.\n\nSupported values: `h264`, `h265`, `av1`.\n\nNote: compressed video support is subject to hardware limitations and patent licensing, so not all encodings may be supported on all platforms. See more about [H.265 support](https://caniuse.com/hevc) and [AV1 support](https://caniuse.com/av1).",
"Video format.\n\nSupported values: `h264`, `h265`, `vp9`, `av1`.\n\nNote: compressed video support is subject to hardware limitations and patent licensing, so not all encodings may be supported on all platforms. See more about [H.265 support](https://caniuse.com/hevc), [VP9 support](https://caniuse.com/webm), and [AV1 support](https://caniuse.com/av1).",
},
],
};
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@foxglove/schemas",
"version": "1.6.5",
"version": "1.6.6",
"description": "Foxglove-defined message schemas for ROS, Protobuf, FlatBuffers, OMG IDL, and JSON",
"license": "MIT",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion python/foxglove-schemas-flatbuffer/setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = foxglove-schemas-flatbuffer
version = 0.2.0
version = 0.2.1
description = Flatbuffer classes for Foxglove Schemas
long_description = file: README.md
long_description_content_type = text/markdown
Expand Down
2 changes: 1 addition & 1 deletion python/foxglove-schemas-protobuf/setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = foxglove-schemas-protobuf
version = 0.2.1
version = 0.2.2
description = Protobuf classes for Foxglove Schemas
long_description = file: README.md
long_description_content_type = text/markdown
Expand Down
7 changes: 7 additions & 0 deletions ros_foxglove_msgs/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
Changelog for package foxglove_msgs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

3.0.1 (2024-12-10)
------------------
* Updating distortion model description
* Update ImageAnnotation schemas' coordinate fields with comment specifying the coordinate space
* Update RawImage schema with endianness
* Update CompressedVideo format strings

3.0.0 (2023-10-31)
------------------
* Add a frame_id field to LocationFix
Expand Down
2 changes: 1 addition & 1 deletion ros_foxglove_msgs/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>foxglove_msgs</name>
<version>3.0.0</version>
<version>3.0.1</version>
<description>
foxglove_msgs provides visualization messages that are supported by Foxglove.
</description>
Expand Down
7 changes: 5 additions & 2 deletions ros_foxglove_msgs/ros1/CompressedVideo.msg

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions ros_foxglove_msgs/ros2/CompressedVideo.msg

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions schemas/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions schemas/flatbuffer/CompressedVideo.fbs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions schemas/jsonschema/CompressedVideo.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions schemas/jsonschema/index.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions schemas/omgidl/foxglove/CompressedVideo.idl

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions schemas/proto/foxglove/CompressedVideo.proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions schemas/ros1/CompressedVideo.msg

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 292b165

Please sign in to comment.