# Manifest for the example source node.
#
# Its reason to exist is as much mechanical as documentary: `dora validate`
# matches a node manifest to a `path:` node by entrypoint, and without a
# manifest here the repository-root dora-node.yml -- whose entrypoint is
# `dora-image-view` -- gets tried against `examples/source.py`, does not match,
# and warns. Under `strict_types: true` that warning fails the run.
#
# Declaring the types here rather than as `output_types:` in dataflow.yml is
# what makes them checked: an inline annotation shadows the manifest, so the
# manifest would be injected but never compared against dora-image-view's.
apiVersion: 1
name: source
namespace: liria
description: Synthetic image, depth, camera_info, bbox and text source for the dora-image-view example
categories: [debug]
keywords: [example, test, synthetic]

runtime: python
entrypoint: source.py
build: pip install .
dora: ">=1.0"

inputs:
  tick:
    required: true
    description: Timer tick; one frame is emitted per tick.

outputs:
  image:
    type: std/core/v1/UInt8
    description: >-
      Animated bgr8 frame as a flat UInt8 buffer, with metadata
      {width, height, encoding}.
  bbox:
    description: >-
      The box around the moving square: an Arrow struct {bbox, conf, labels}
      with metadata {format: xyxy}. Untyped to match the dora-image-view input.
  text:
    type: std/core/v1/String
    description: A fixed caption.
  camera_info:
    type: std/core/v1/Float32
    description: >-
      [fx, fy, cx, cy] for the frames above. Published once, on the first tick,
      the way a real camera publishes it once per session.
  depth:
    type: std/core/v1/Float32
    description: >-
      Depth of the same scene in millimetres, [height, width]: a flat wall with
      the square standing in front of it.


env:
  SOURCE_WIDTH:
    type: int
    description: Frame width in pixels. Defaults to 640.
  SOURCE_HEIGHT:
    type: int
    description: Frame height in pixels. Defaults to 480.
  SOURCE_FRAMES:
    type: int
    description: Stop after this many frames. 0, the default, runs until the viewer quits.