Link to this section Summary

Creates a custom :framestamp, :framestamp === operator that returns true if both the real-world seconds values and the framerates for both framestamps are equal.

create_op_strict_neq()

Creates a custom :framestamp, :framestamp !=== operator that returns true if a and b do not have the same real-world-seconds, framerate playback, or framerate tags.

create_op_sub()

Creates a custom :framestamp, :framestamp - operator.

Pg Operator Classes

create_op_class_btree()

Creates a B-tree operator class to support indexing on comparison operations.

Pg Functions

create_func_floor_div_rational()

Creates DIV(:framestamp, :rational) that returns a floored :framestamp to match Postgres' DIV(real, real) behavior.

create_func_frames()

Converts framestamp to a frame number by the frame's index in the timecode stream, with 0 as SMPTE midnight.

create_func_with_frames()

Creates framestamp.with_frames(frames, rate) that creates a framestamp for the given frame count.

create_func_with_seconds()

framestamp.with_seconds(seconds, rate)

Pg Private Functions

create_func_add()

Creates framestamp.__private__add(a, b) that backs the + operator.

create_func_cmp()

Creates framestamp.__private__cmp(a, b) used in the PgTimecode b-tree operator class.

create_func_div_rational()

Creates framestamp.__private__div(:framestamp, :rational) that backs the / operator.

create_func_eq()

framestamp.__private__eq(framestamp, framestamp)

create_func_gt()

Creates framestamp.__private__gt(a, b) that backs the > operator.

create_func_gte()

Creates framestamp.__private__gte(a, b) that backs the >= operator.

create_func_lt()

Creates framestamp.__private__lt(a, b) that backs the < operator.

create_func_lte()

Creates framestamp.__private__lte(a, b) that backs the <= operator.

create_func_modulo_rational()

Creates framestamp.__private__modulo(:framestamp, :rational) that backs the % operator.

create_func_mult_rational()

Creates framestamp.__private__mult(:framestamp, :rational) that backs the * operator.

create_func_neq()

Creates framestamp.__private__neq(a, b) that backs the <> operator.

create_func_strict_eq()

Creates framestamp.__private__strict_eq(a, b) that backs the === operator.

create_func_strict_neq()

Creates framestamp.__private__strict_neq(a, b) that backs the !=== operator.

create_func_sub()

framestamp.__private__sub(a, b).

Functions

function(name, repo)

Returns the config-qualified name of the function for this type.

Link to this section Full

create_all()

@spec create_all() :: :ok

Adds raw SQL queries to a migration for creating the database types, associated functions, casts, operators, and operator families.

Safe to run multiple times when new functionality is added in updates to this library. Existing values will be skipped.

types-created
Types Created

Calling this macro creates the following type definitions:

CREATE TYPE framestamp AS (
  seconds rational,
  rate framerate
);

schemas-created
Schemas Created

Up to two schemas are created as detailed by the Configuring Database Objects section below.

configuring-database-objects
Configuring Database Objects

To change where supporting functions are created, add the following to your Repo confiugration:

config :vtc, Vtc.Test.Support.Repo,
  adapter: Ecto.Adapters.Postgres,
  ...
  vtc: [
    framestamp: [
      functions_schema: :framestamp,
      functions_prefix: "framestamp"
    ]
  ]

Option definitions are as follows:

functions_schema: The postgres schema to store framestamp-related custom functions.
functions_prefix: A prefix to add before all functions. Defaults to "framestamp" for any function created in the :public schema, and "" otherwise.

private-functions
Private Functions

Some custom function names are prefaced with __private__. These functions should not be called by end-users, as they are not subject to any API staility guarantees.

examples
Examples

defmodule MyMigration do
  use Ecto.Migration

  alias Vtc.Ecto.Postgres.PgFramestamp
  require PgFramestamp.Migrations

  def change do
    PgFramestamp.Migrations.create_all()
  end
end

Link to this section Pg Constraints

create_field_constraints(table, field)

@spec create_field_constraints(atom(), atom()) :: :ok

Creates basic constraints for a PgFramestamp / Framestamp database field.

constraints-created
Constraints created:

{field}_rate_positive: Checks that the playback speed is positive.
{field}_rate_ntsc_tags: Checks that both drop and non_drop are not set at the same time.
{field}_rate_ntsc_valid: Checks that NTSC framerates are mathematically sound, i.e., that the rate is equal to (round(rate.playback) * 1000) / 1001.
{field}_rate_ntsc_drop_valid: Checks that NTSC, drop-frame framerates are valid, i.e, are cleanly divisible by 30_000/1001.
{field_name}_seconds_divisible_by_rate: Checks that the seconds value of the framestamp is cleanly divisible by the rate.playback value.

examples
Examples

create table("my_table", primary_key: false) do
  add(:id, :uuid, primary_key: true, null: false)
  add(:a, Framestamp.type())
  add(:b, Framestamp.type())
end

PgRational.migration_add_field_constraints(:my_table, :a)
PgRational.migration_add_field_constraints(:my_table, :b)

Link to this section Pg Types

create_function_schemas()

@spec create_function_schemas() :: :ok

Creates function schema as described by the Configuring Database Objects section above.

create_type_framestamp()

@spec create_type_framestamp() :: :ok

Adds framestamp composite type.

Link to this section Pg Operators

create_op_add()

@spec create_op_add() :: :ok

Creates a custom :framestamp, :framestamp + operator.

Just like Framestamp.add/3, if the rate of a and b are not equal, the result will inheret a's framerate, and the internal seconds field will be rounded to the nearest whole-frame to ensure data integrity.

create_op_div_rational()

@spec create_op_div_rational() :: :ok

Creates a custom :framestamp, :rational / operator.

Just like Framestamp.div/3, a's the internal seconds field will be rounded to the nearest whole-frame to ensure data integrity.

Unlike Framestamp.div/3, the result is rounded to the closest frame, rather than truncating ala integer division.

create_op_eq()

@spec create_op_eq() :: :ok

Creates a custom :framestamp, :framestamp = operator that returns true if the real-world seconds values for both framestamps are equal.

create_op_gt()

@spec create_op_gt() :: :ok

Creates a custom :framestamp, :framestamp > operator.

create_op_gte()

@spec create_op_gte() :: :ok

Creates a custom :framestamp, :framestamp >= operator.

create_op_lt()

@spec create_op_lt() :: :ok

Creates a custom :framestamp, :framestamp < operator.

create_op_lte()

@spec create_op_lte() :: :ok

Creates a custom :framestamp, :framestamp <= operator.

create_op_modulo_rational()

@spec create_op_modulo_rational() :: :ok

Creates a custom :framestamp, :rational % operator.

Just like Framestamp.rem/3, this operation is done on the frame count representation of the Framestamp, which is then used as the basis of a new framestamp.

create_op_mult_rational()

@spec create_op_mult_rational() :: :ok

Creates a custom :framestamp, :rational * operator.

Just like Framestamp.add/3, a's the internal seconds field will be rounded to the nearest whole-frame to ensure data integrity.

create_op_neq2()

@spec create_op_neq2() :: :ok

Creates a custom :framestamp, :framestamp != operator that returns true if the real-world seconds values for both framestamps are not equal.

create_op_neq()

@spec create_op_neq() :: :ok

Creates a custom :framestamp, :framestamp <> operator that returns true if the real-world seconds values for both framestamps are not equal.

create_op_strict_eq()

@spec create_op_strict_eq() :: :ok

Creates a custom :framestamp, :framestamp === operator that returns true if both the real-world seconds values and the framerates for both framestamps are equal.

create_op_strict_neq()

@spec create_op_strict_neq() :: :ok

Creates a custom :framestamp, :framestamp !=== operator that returns true if a and b do not have the same real-world-seconds, framerate playback, or framerate tags.

create_op_sub()

@spec create_op_sub() :: :ok

Creates a custom :framestamp, :framestamp - operator.

Just like Framestamp.add/3, if the rate of a and b are not equal, the result will inheret a's framerate, and the internal seconds field will be rounded to the nearest whole-frame to ensure data integrity.

Link to this section Pg Operator Classes

create_op_class_btree()

@spec create_op_class_btree() :: :ok

Creates a B-tree operator class to support indexing on comparison operations.

Link to this section Pg Functions

create_func_floor_div_rational()

@spec create_func_floor_div_rational() :: :ok

Creates DIV(:framestamp, :rational) that returns a floored :framestamp to match Postgres' DIV(real, real) behavior.

Just like Framestamp.div/3, this operation is done on the frame count representation of the Framestamp, which is then used as the basis of a new framestamp.

create_func_frames()

@spec create_func_frames() :: :ok

Converts framestamp to a frame number by the frame's index in the timecode stream, with 0 as SMPTE midnight.

Equivalent to Framestamp.frames/2 with :round set to trunc.

create_func_with_frames()

@spec create_func_with_frames() :: :ok

Creates framestamp.with_frames(frames, rate) that creates a framestamp for the given frame count.

create_func_with_seconds()

@spec create_func_with_seconds() :: :ok

framestamp.with_seconds(seconds, rate)

Rounds seconds to the nearest whole frame based on rate and returns a constructed framestamp.

Link to this section Pg Private Functions

create_func_add()

@spec create_func_add() :: :ok

Creates framestamp.__private__add(a, b) that backs the + operator.

Just like Framestamp.add/3, if the rate of a and b are not equal, the result will inheret a's framerate, and the internal seconds field will be rounded to the nearest whole-frame to ensure data integrity.

create_func_cmp()

@spec create_func_cmp() :: :ok

Creates framestamp.__private__cmp(a, b) used in the PgTimecode b-tree operator class.

create_func_div_rational()

@spec create_func_div_rational() :: :ok

Creates framestamp.__private__div(:framestamp, :rational) that backs the / operator.

Just like Framestamp.div/3, a's the internal seconds field will be rounded to the nearest whole-frame to ensure data integrity.

Unlike Framestamp.div/3, the result is rounded to the closest frame, rather than truncating ala integer division.

create_func_eq()

@spec create_func_eq() :: :ok

framestamp.__private__eq(framestamp, framestamp)

Backs the = operator.

create_func_gt()

@spec create_func_gt() :: :ok

Creates framestamp.__private__gt(a, b) that backs the > operator.

create_func_gte()

@spec create_func_gte() :: :ok

Creates framestamp.__private__gte(a, b) that backs the >= operator.

create_func_lt()

@spec create_func_lt() :: :ok

Creates framestamp.__private__lt(a, b) that backs the < operator.

create_func_lte()

@spec create_func_lte() :: :ok

Creates framestamp.__private__lte(a, b) that backs the <= operator.

create_func_modulo_rational()

@spec create_func_modulo_rational() :: :ok

Creates framestamp.__private__modulo(:framestamp, :rational) that backs the % operator.

Just like Framestamp.rem/3, this operation is done on the frame count representation of the Framestamp, which is then used as the basis of a new framestamp.

create_func_mult_rational()

@spec create_func_mult_rational() :: :ok

Creates framestamp.__private__mult(:framestamp, :rational) that backs the * operator.

Just like Framestamp.add/3, a's the internal seconds field will be rounded to the nearest whole-frame to ensure data integrity.

create_func_neq()

@spec create_func_neq() :: :ok

Creates framestamp.__private__neq(a, b) that backs the <> operator.

create_func_strict_eq()

@spec create_func_strict_eq() :: :ok

Creates framestamp.__private__strict_eq(a, b) that backs the === operator.

create_func_strict_neq()

@spec create_func_strict_neq() :: :ok

Creates framestamp.__private__strict_neq(a, b) that backs the !=== operator.

create_func_sub()

@spec create_func_sub() :: :ok

framestamp.__private__sub(a, b).

Backs the - operator.

Just like Framestamp.sub/3, if the rate of a and b are not equal, the result will inheret a's framerate, and the internal seconds field will be rounded to the nearest whole-frame to ensure data integrity.

Link to this section Functions

function(name, repo)

@spec function(atom(), Ecto.Repo.t()) :: String.t()

Returns the config-qualified name of the function for this type.

Settings View Source Vtc.Ecto.Postgres.PgFramestamp.Migrations (vtc v0.13.11)

Link to this section Summary

Link to this section Full

create_all()

types-created Types Created

schemas-created Schemas Created

configuring-database-objects Configuring Database Objects

private-functions Private Functions

examples Examples

Link to this section Pg Constraints

create_field_constraints(table, field)

constraints-created Constraints created:

examples Examples

Link to this section Pg Types

create_function_schemas()

create_type_framestamp()

Link to this section Pg Operators

create_op_add()

create_op_div_rational()

create_op_eq()

create_op_gt()

create_op_gte()

create_op_lt()

create_op_lte()

create_op_modulo_rational()

create_op_mult_rational()

create_op_neq2()

create_op_neq()

create_op_strict_eq()

create_op_strict_neq()

create_op_sub()

Link to this section Pg Operator Classes

create_op_class_btree()

Link to this section Pg Functions

create_func_floor_div_rational()

create_func_frames()

create_func_with_frames()

create_func_with_seconds()

Link to this section Pg Private Functions

create_func_add()

create_func_cmp()

create_func_div_rational()

create_func_eq()

create_func_gt()

create_func_gte()

create_func_lt()

create_func_lte()

create_func_modulo_rational()

create_func_mult_rational()

create_func_neq()

create_func_strict_eq()

create_func_strict_neq()

create_func_sub()

Link to this section Functions

function(name, repo)

View Source Vtc.Ecto.Postgres.PgFramestamp.Migrations (vtc v0.13.11)

types-created
Types Created

schemas-created
Schemas Created

configuring-database-objects
Configuring Database Objects

private-functions
Private Functions

examples
Examples

constraints-created
Constraints created:

examples
Examples