Test #3697

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [Unreleased]
 
 - Improved thread safety of rendering with CairoMakie (independent `Scene`s only) by locking FreeType handles [#3777](https://github.com/MakieOrg/Makie.jl/pull/3777).
+- Added `loop` option support for HTML outputs when recording videos with `record` [#3697](https://github.com/MakieOrg/Makie.jl/pull/3697).
 
 ## [0.20.9] - 2024-03-29
 

docs/explanations/animation.md

@@ -28,15 +28,12 @@ nframes = 30
 framerate = 30
 hue_iterator = range(0, 360, length=nframes)
 
-record(fig, "color_animation.mp4", hue_iterator;
+Record(fig, hue_iterator;
         framerate = framerate) do hue
     lineplot.color = HSV(hue, 1, 0.75)
 end
-nothing # hide
 ```
 
-\video{color_animation}
-
 Passing a function as the first argument is usually done with Julia's `do`-notation, which you might not be familiar with.
 Instead of the above, we could also have written:
 

src/ffmpeg-util.jl

@@ -24,14 +24,14 @@
 you have issues playing a video, try `profile = "high"` or `profile = "main"`.
 - `pixel_format = "yuv420p"`: A ffmpeg compatible pixel format (`-pix_fmt`). Currently only
 applies to `mp4`. Defaults to `yuv444p` for `profile = "high444"`.
-- `loop = 0`: Number of times the video is repeated, for a `gif`. Defaults to `0`, which
-means infinite looping. A value of `-1` turns off looping, and a value of `n > 0` and above
-means `n` repetitions (i.e. the video is played `n+1` times).
+- `loop = 0`: Number of times the video is repeated, for a `gif` or `html` output. Defaults to `0`, which
+means infinite looping. A value of `-1` turns off looping, and a value of `n > 0`
+means `n` repetitions (i.e. the video is played `n+1` times) when supported by backend.
 
     !!! warning
     `profile` and `pixel_format` are only used when `format` is `"mp4"`; a warning will be issued if `format`
     is not `"mp4"` and those two arguments are not `nothing`. Similarly, `compression` is only
-    valid when `format` is `"mp4"` or `"webm"`, and `loop` is only valid when `format` is `"gif"`.
+    valid when `format` is `"mp4"` or `"webm"`.
 """
 struct VideoStreamOptions
     format::String
@@ -63,15 +63,12 @@ struct VideoStreamOptions
             (compression === nothing) && (compression = 20)
         end
 
-        if format == "gif"
-            (loop === nothing) && (loop = 0)
-        end
+        (loop === nothing) && (loop = 0)
 
         # items are name, value, allowed_formats
         allowed_kwargs = [("compression", compression, ("mp4", "webm")),
                           ("profile", profile, ("mp4",)),
-                          ("pixel_format", pixel_format, ("mp4",)),
-                          ("loop", loop, ("gif",))]
+                          ("pixel_format", pixel_format, ("mp4",))]
 
         for (name, value, allowed_formats) in allowed_kwargs
             if !(format in allowed_formats) && value !== nothing

src/recording.jl

@@ -181,9 +181,11 @@ end
 function Base.show(io::IO, ::MIME"text/html", vs::VideoStream)
     mktempdir() do dir
         path = save(joinpath(dir, "video.mp4"), vs)
+        # <video> only supports infinite looping, so we loop forever even when a finite number is requested
+        loopoption = vs.options.loop ≥ 0 ? "loop" : ""
         print(
             io,
-            """<video autoplay controls><source src="data:video/x-m4v;base64,""",
+            """<video autoplay controls $loopoption><source src="data:video/x-m4v;base64,""",
             base64encode(open(read, path)),
             """" type="video/mp4"></video>"""
         )