VideoRecorder.h

Go to the documentation of this file.

#pragma once
 
#ifndef CANDLEWICK_WITH_FFMPEG_SUPPORT
#error "Including this file requires candlewick to be built with FFmpeg support"
#endif
#include "../core/Core.h"
#include "../core/Tags.h"
 
#include <SDL3/SDL_gpu.h>
#include <SDL3/SDL_stdinc.h>
#include <memory>
 
namespace candlewick {
namespace media {
 
  struct VideoRecorderImpl;
 
  class TransferBufferPool;
 
  class VideoRecorder {
    std::unique_ptr<VideoRecorderImpl> _impl;
    Uint32 _width;
    Uint32 _height;
 
  public:
    struct Settings {
      int fps = 30;
      // default: 2.5 Mb/s
      int bitRate = 2'500'000u;
      int outputWidth = 0;
      int outputHeight = 0;
    } settings;

    explicit VideoRecorder(NoInitT);
    VideoRecorder(VideoRecorder &&) noexcept;
    VideoRecorder &operator=(VideoRecorder &&) noexcept;

    void open(Uint32 width, Uint32 height, std::string_view filename);

    bool isRecording() const { return _impl != nullptr; }

    VideoRecorder(Uint32 width, Uint32 height, std::string_view filename,
                  Settings settings);
 
    VideoRecorder(Uint32 width, Uint32 height, std::string_view filename);
 
    Uint32 frameCounter() const;
 
    void close() noexcept;
 
    ~VideoRecorder();
 
    void writeTextureToVideoFrame(CommandBuffer &command_buffer,
                                  const Device &device,
                                  TransferBufferPool &pool,
                                  SDL_GPUTexture *texture,
                                  SDL_GPUTextureFormat format);
  };
 
} // namespace media
} // namespace candlewick