Zongzi.Score.Tempo (zongzi v0.3.0)

Copy Markdown

Entry point for duration utilities.

Summary

Types

physical_time()

Physical time in seconds.

tempo_event()

A tempo segment starting at a given tick.

tempo_events()

Functions

build_segment_from_event(module, start_tick, end_tick, payload)
duration_sec(segment, tpqn)
sec_to_tick(segment, sec, tpqn)
tick_to_sec(segment, tick, tpqn)

Types

physical_time()

@type physical_time() :: float()

Physical time in seconds.

tempo_event()

@type tempo_event() ::
  {Zongzi.Score.Tick.numeric_tick(), Zongzi.Score.Tempo.Event.t()}

A tempo segment starting at a given tick.

tempo_events()

@type tempo_events() ::
  [tempo_event()] | {[tempo_event()], last :: Zongzi.Score.Tick.t()}

Functions

build_segment_from_event(module, start_tick, end_tick, payload)

@spec build_segment_from_event(
  module(),
  Zongzi.Score.Tick.t(),
  Zongzi.Score.Tick.t(),
  any()
) ::
  {:ok, Zongzi.Score.Tempo.Segment.segment()} | {:error, term()}

duration_sec(segment, tpqn)

@spec duration_sec(Zongzi.Score.Tempo.Segment.segment(), pos_integer()) ::
  Zongzi.Score.Tempo.Segment.duration()

sec_to_tick(segment, sec, tpqn)

@spec sec_to_tick(
  Zongzi.Score.Tempo.Segment.segment(),
  physical_time(),
  pos_integer()
) ::
  Zongzi.Score.Tempo.Segment.duration()

tick_to_sec(segment, tick, tpqn)

@spec tick_to_sec(
  Zongzi.Score.Tempo.Segment.segment(),
  Zongzi.Score.Tick.t(),
  pos_integer()
) ::
  Zongzi.Score.Tempo.Segment.duration()