19. Recording movies

Our engine does not include a ready API to record movies during interactive applications / games. This is not trivial to implement, and also you can use existing external programs to do this. Under Linux I like glc, under Windows there is fraps and many others.

You can of course grab and save a screenshot as often as you want. But doing this every frame will make your FPS very, very low — so it's not a good method to record a movie from a gameplay.

That said, you can use the screenshot method (SaveScreen) to record a predefined animation. That is, if you can programmatically animate your world and/or move the camera and do other necessary stuff, you can convert it into a perfect-quality movie. So we support recording a predefined animation in VRML/X3D (meaning: it plays without any user interaction) to a series of images. Such animation can then be converted into a movie e.g. using ffmpeg (our view3dscene does this automatically under the hood).

Although this is limited to predefined animations, in exchange this allows to record the animation with perfect quality and with constant number of frames per second.

Do it like this:

for .... do // in a loop, grab screenshot each frame
  SceneManager.Camera.Update(FrameTime, true, DummyBooleanInitializedToTrue);
  // ... do anything else you need to update the 3D world/camera
  // when the time passed
  { capture and save screen as before, like: }
  Image := Control.SaveScreen;
    { add your image to the movie sequence.
      Various options possible, e.g. you can save a sequence
      of images to a temporary location and later processes
      them by ffmpeg to produce a full movie. }
    SaveImage(Image, Format('screenshot_name_%4d.png', [FrameNumber]));
  finally FreeAndNil(Image) end;

You manually force the current time of the scene/camera to increase as much as you want before each screenshot. This makes it work 100% reliably, without any worries how fast you can process captured images.

The time of the scene and of the camera is actually independent. You can remove the "MainScene.IncreaseTime" call, if you know that your scene stays static (or you want to force it to look like static), and want to animate only camera. Or the other way around, if your camera is static (or you want to force it to be static) but you have an animation in VRML/X3D, you can remove the "Camera.Update" line.

FrameTime is a constant saying how many seconds passed between frames. Both TCastleSceneCore.IncreseTime and TCamera.Update take it's time argument in seconds. Don't worry, this is a float, so actually it honors fractions of seconds as well. So something like FrameTime := 1/25 to get 25 frames per second will work perfectly Ok.