Release Nageru 1.0.0, with some documentation updates.

[nageru] / theme.lua

diff --git a/theme.lua b/theme.lua
index 2884793ed4f5dae01d6b36853ce79168dffd77e8..243b352670182c7bbd3c56dffe761bf32d5e268f 100644 (file)
--- a/theme.lua
+++ b/theme.lua
@@ -32,6 +32,8 @@ local STATIC_SIGNAL_NUM = 3
 local FADE_SIGNAL_NUM = 4
 
 -- Last width/height/resolution for each channel, if we have it.
+-- Note that unlike the values we get from Nageru, the resolution is per
+-- frame and not per field, since we deinterlace.
 local last_resolution = {}
 
 -- Utility function to help creating many similar chains that can differ
@@ -228,6 +230,11 @@ function get_input_type(signals, signal_num)
 end
 
 function needs_scale(signals, signal_num, width, height)
+       if signal_num == STATIC_SIGNAL_NUM then
+               -- We assume this is already correctly scaled at load time.
+               return false
+       end
+       assert(signal_num == INPUT0_SIGNAL_NUM or signal_num == INPUT1_SIGNAL_NUM)
        return (signals:get_width(signal_num) ~= width or signals:get_height(signal_num) ~= height)
 end
 
@@ -241,6 +248,7 @@ function set_scale_parameters_if_needed(chain_or_input, width, height)
        end
 end
 
+-- API ENTRY POINT
 -- Returns the number of outputs in addition to the live (0) and preview (1).
 -- Called only once, at the start of the program.
 function num_channels()
@@ -251,13 +259,10 @@ end
 function get_frame_rate(signal_num)
        local nom = last_resolution[signal_num].frame_rate_nom
        local den = last_resolution[signal_num].frame_rate_den
-       if last_resolution[signal_num].interlaced then
-               nom = nom * 2
-       end
        if nom % den == 0 then
                return nom / den
        else
-               return string.format("%.2f", num / den)
+               return string.format("%.2f", nom / den)
        end
 end
 
@@ -268,7 +273,7 @@ function get_channel_resolution(signal_num)
                   last_resolution[signal_num].height == 525 then
                        return "no signal"
                elseif last_resolution[signal_num].interlaced then
-                       return (last_resolution[signal_num].height * 2) .. "i" .. get_frame_rate(signal_num)
+                       return last_resolution[signal_num].height .. "i" .. get_frame_rate(signal_num)
                else
                        return last_resolution[signal_num].height .. "p" .. get_frame_rate(signal_num)
                end
@@ -277,6 +282,7 @@ function get_channel_resolution(signal_num)
        end
 end
 
+-- API ENTRY POINT
 -- Returns the name for each additional channel (starting from 2).
 -- Called at the start of the program, and then each frame for live
 -- channels in case they change resolution.
@@ -292,12 +298,29 @@ function channel_name(channel)
        end
 end
 
+-- API ENTRY POINT
+-- Returns, given a channel number, which signal it corresponds to (starting from 0).
+-- Should return -1 if the channel does not correspond to a simple signal.
+-- Called once for each channel, at the start of the program.
+-- Will never be called for live (0) or preview (1).
+function channel_signal(channel)
+       if channel == 2 then
+               return 0
+       elseif channel == 3 then
+               return 1
+       else
+               return -1
+       end
+end
+
+-- API ENTRY POINT
 -- Returns if a given channel supports setting white balance (starting from 2).
 -- Called only once for each channel, at the start of the program.
 function supports_set_wb(channel)
        return channel == 2 or channel == 3
 end
 
+-- API ENTRY POINT
 -- Gets called with a new gray point when the white balance is changing.
 -- The color is in linear light (not sRGB gamma).
 function set_wb(channel, red, green, blue)
@@ -320,6 +343,7 @@ function finish_transitions(t)
        end
 end
 
+-- API ENTRY POINT
 -- Called every frame.
 function get_transitions(t)
        finish_transitions(t)
@@ -436,10 +460,12 @@ function transition_clicked(num, t)
        end
 end
 
+-- API ENTRY POINT
 function channel_clicked(num)
        preview_signal_num = num
 end
 
+-- API ENTRY POINT
 -- Called every frame. Get the chain for displaying at input <num>,
 -- where 0 is live, 1 is preview, 2 is the first channel to display
 -- in the bottom bar, and so on up to num_channels()+1. t is the
@@ -466,13 +492,26 @@ end
 function get_chain(num, t, width, height, signals)
        local input_resolution = {}
        for signal_num=0,1 do
-               input_resolution[signal_num] = {
+               local res = {
                        width = signals:get_width(signal_num),
                        height = signals:get_height(signal_num),
                        interlaced = signals:get_interlaced(signal_num),
                        frame_rate_nom = signals:get_frame_rate_nom(signal_num),
                        frame_rate_den = signals:get_frame_rate_den(signal_num)
                }
+
+               if res.interlaced then
+                       -- Convert height from frame height to field height.
+                       -- (Needed for e.g. place_rectangle.)
+                       res.height = res.height * 2
+
+                       -- Show field rate instead of frame rate; really for cosmetics only
+                       -- (and actually contrary to EBU recommendations, although in line
+                       -- with typical user expectations).
+                       res.frame_rate_nom = res.frame_rate_nom * 2
+               end
+
+               input_resolution[signal_num] = res
        end
        last_resolution = input_resolution