[GSoC'21] Livestreaming v2

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Javis.jl - Changelog
 
 ## Unreleased
+- Make livestreaming faster
+- Allow specifying frames to livestream 
 - added `@Frames` macro for full power mode of defining frames
 - bugfix in `@JLayer` when dimensions are not defined explicitly
 

src/Javis.jl

@@ -275,6 +275,11 @@ function render(
         tempdirectory = mktempdir()
     end
 
+    if streamconfig != nothing
+        _livestream(streamconfig, framerate, video, objects, layers, frames, tempdirectory)
+        return
+    end
+
     filecounter = 1
     @showprogress 1 "Rendering frames..." for frame in frames
         frame_image = convert.(RGB, get_javis_frame(video, objects, frame; layers = layers))
@@ -318,9 +323,6 @@ function render(
         @error "Currently, only gif and mp4 creation is supported. Not a $ext."
     end
 
-    # check if livestream is used and livestream if that's the case
-    _livestream(streamconfig, framerate, video.width, video.height, pathname)
-
     # clear all CURRENT_* constants to not accidentally use a previous video when creating a new one
     empty_CURRENT_constants()
 

src/javis_viewer.jl

@@ -291,13 +291,14 @@ Sets up the livestream configuration.
 **NOTE:** Twitch not fully implemented, do not use.
 """
 function setup_stream(
-    livestreamto::Symbol = :local;
+    livestreamto::Symbol = :local,
+    frames::Union{UnitRange{Int},Symbol} = :all;
     protocol::String = "udp",
     address::String = "0.0.0.0",
     port::Int = 14015,
     twitch_key::String = "",
 )
-    StreamConfig(livestreamto, protocol, address, port, twitch_key)
+    StreamConfig(livestreamto, protocol, address, port, twitch_key, frames)
 end
 
 """
@@ -332,7 +333,7 @@ function cancel_stream()
             ),
         ),
     )
-    return "Livestream Cancelled!"
+    return @info "Livestream Cancelled!"
 end
 
 """
@@ -342,20 +343,37 @@ Internal method for livestreaming
 """
 function _livestream(
     streamconfig::StreamConfig,
-    framerate::Int,
-    width::Int,
-    height::Int,
-    pathname::String,
+    framerate,
+    video,
+    objects,
+    layers,
+    frames,
+    tempdirectory,
 )
+    # kill any existing stream
     cancel_stream()
 
     livestreamto = streamconfig.livestreamto
+    config_frames = streamconfig.frames
     twitch_key = streamconfig.twitch_key
 
     if livestreamto == :twitch && isempty(twitch_key)
         return error("Please enter your twitch stream key")
     end
 
+    stream_frames = config_frames == :all ? frames : config_frames
+    stream_filecounter = 1
+    for frame in stream_frames
+        frame_image = convert.(RGB, get_javis_frame(video, objects, frame; layers = layers))
+        if !isempty(tempdirectory)
+            Images.save(
+                "$(tempdirectory)/$(lpad(stream_filecounter, 10, "0")).png",
+                frame_image,
+            )
+        end
+        stream_filecounter += 1
+    end
+
     command = [
         "-stream_loop", # loop the stream -1 times i.e. indefinitely
         "-1",
@@ -366,15 +384,14 @@ function _livestream(
         "error",
         "-re", # read input at native frame rate
         "-i", # input file
-        "$pathname",
+        "$(tempdirectory)/%10d.png",
     ]
 
     if livestreamto == :twitch
         if isempty(twitch_key)
-            error("Please enter your twitch api key")
+            error("Please enter your twitch stream key")
         end
 
-        # 
         twitch_cmd = [
             "-f",
             "flv", # force the file to flv format
@@ -396,11 +413,3 @@ function _livestream(
         ffmpeg_exe(`$command`)
     end)
 end
-
-_livestream(
-    streamconfig::Nothing,
-    framerate::Int,
-    width::Int,
-    height::Int,
-    pathname::String,
-) = return

src/structs/Livestream.jl

@@ -9,11 +9,13 @@ Holds the conguration for livestream, defaults to `nothing`
 - `address::String` The IP address for the `:local` stream(ignored in case of `:twitch`)
 - `port::Int` The port for the `:local` stream(ignored in case of `:twitch`)
 - `twitch_key::String` Twitch stream key for your account
+- `frames::Union{UnitRange{Int}, Symbol}` The specific frames to be livestreamed. Defaults to `:all` 
 """
 struct StreamConfig
     livestreamto::Symbol
     protocol::String
     address::String
     port::Int
     twitch_key::String
+    frames::Union{UnitRange{Int},Symbol}
 end

test/viewer.jl

@@ -133,6 +133,7 @@ end
     @test conf_local.protocol == "udp"
     @test conf_local.address == "0.0.0.0"
     @test conf_local.port == 8081
+    @test conf_local.frames == :all
 
     conf_twitch_err = setup_stream(:twitch)
     conf_twitch = setup_stream(:twitch, twitch_key = "foo")
@@ -141,14 +142,27 @@ end
     @test isempty(conf_twitch_err.twitch_key)
     @test conf_twitch.twitch_key == "foo"
 
-    render(vid, pathname = "stream_local.gif", streamconfig = conf_local)
+    render(vid, pathname = "test_stream.gif", streamconfig = conf_local)
 
     # errors with macos; a good test to have
     # test_local = run(pipeline(`lsof -i -P -n`, `grep ffmpeg`))
     # @test test_local isa Base.ProcessChain
     # @test test_local.processes isa Vector{Base.Process}
 
-    cancel_stream()
+    # can't actually test the streamed frames but let's check if they're atleast created
+    conf_local = setup_stream(:local, 56:60)
+    render(vid, tempdirectory = "images", streamconfig = conf_local)
+
+    for i in 56:60
+        @test_reference "refs/livestream_frames$i.png" load(
+            "images/$(lpad((i-55), 10, "0")).png",
+        )
+    end
+
+    for i in 1:5
+        rm("images/$(lpad(i, 10, "0")).png")
+    end
+
     @test_throws ProcessFailedException run(
         pipeline(
             `ps aux`,