Dala.Media.Clock (dala v0.3.1)

Realtime frame-clock for AV sync and animation.

Uses audio clock as master (audio glitches are more noticeable than video drops). Drives the animation system and frame pacing.

Architecture:

Audio Clock (master)
    ↓
Frame Pacer
    ↓
Video Frame Selection
    ↓
Frame Presentation

Summary

Types

clock_ref()

timestamp_us()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

drift(pid)

Get current AV drift in microseconds.

report_video_frame(pid, pts_us)

Report a video frame presentation (called by video renderer).

start_link(opts \\ [])

Start the frame clock.

start_ticking(pid)

Start ticking at the target FPS.

stats(pid)

Get frame statistics.

stop_ticking(pid)

Stop ticking.

subscribe(pid, listener)

Register a listener process that receives {:clock, :tick, %{frame: n, timestamp_us: us}}.

unsubscribe(pid, listener)

Unsubscribe a listener.

update_audio_clock(pid, timestamp_us)

Update the audio master clock (called by audio output callback).

Types

clock_ref()

@type clock_ref() :: pid()

timestamp_us()

@type timestamp_us() :: integer()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

drift(pid)

@spec drift(clock_ref()) :: integer()

Get current AV drift in microseconds.

report_video_frame(pid, pts_us)

@spec report_video_frame(clock_ref(), timestamp_us()) :: :ok

Report a video frame presentation (called by video renderer).

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()

Start the frame clock.

start_ticking(pid)

@spec start_ticking(clock_ref()) :: :ok

Start ticking at the target FPS.

stats(pid)

@spec stats(clock_ref()) :: %{
  frame_count: non_neg_integer(),
  dropped_frames: non_neg_integer(),
  drift_us: integer(),
  target_fps: pos_integer()
}

Get frame statistics.

stop_ticking(pid)

@spec stop_ticking(clock_ref()) :: :ok

Stop ticking.

unsubscribe(pid, listener)

@spec unsubscribe(clock_ref(), pid()) :: :ok

Unsubscribe a listener.

update_audio_clock(pid, timestamp_us)

@spec update_audio_clock(clock_ref(), timestamp_us()) :: :ok

Update the audio master clock (called by audio output callback).