Skip to content

Clarify Metadata Format #266

Description

@ReinhardKeil

sample-project.zip contains test data (currently used for SDS extension).

The SDS Metadata format is confusing and before cleaning the schema, it requires definition of the required content.

This is pre-work for the sds-convert utility and for potentially new tools that allow combining algorithms based on sds metadata.

Current documentation is here:
https://github.com/ARM-software/SDS-Framework/tree/main/schema#yaml-format

frequency:

is currently required, however it can be derived from the timeslots when the assumption is that timeslot values are based on tick-frequency. IMHO frequency should be optional.

content:

Content can be either value:, image:, or audio:.
Is for image: or audio: also a value: required? If not, that requirement should be removed.

audio: is currently un-documented, what are the fields, default values, and which fields are required?
This is an example:

    audio:
      sample_rate: 16000
      bit_depth: 16
      audio_channels: 1
      codec: pcm

There is also a video format in "sample-project". In SDS extension this enables a play button. But I believe also images can be seen as a video

    video:
      pixel_format: RGB888
      width: 160
      height: 120
      fps: 10           # IMHO this is identical with frequency, is the value required?
      codec: raw        # is this required given that the format is defined? What other values are possible here?

Closing gaps:

Do we need new content types for:

What output should be supported by sds-convert?

  • sds-convert should be extended with block start/stop to define the segment of an SDS data file that should be converted.

@arneschmid what information from metadata is currently used by SDS extension?

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions