VideoFFMPEGPipeCapture.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
 
 
#ifndef AGXOSG_VIDEOFFMPEGPIPECAPTURE_H
#define AGXOSG_VIDEOFFMPEGPIPECAPTURE_H
 
#include <agxOSG/ImageCapture.h>
#include <agxOSG/ExternalProcess.h>
 
typedef void *HANDLE;
 
namespace agxOSG
{
  AGX_DECLARE_POINTER_TYPES(VideoFFMPEGPipeCapture);
  class AGXOSG_EXPORT VideoFFMPEGPipeCapture : public ImageCaptureBase
  {
  public:
    class DrawCallback;
 
    enum class OutputCodec : agx::UInt32
    {
      H264 = 0,
      H264RGB = 1,
      XVID = 2
    };
 
    // Codec hashFunc
    struct CodecHash
    {
      template <typename T>
      agx::UInt32 operator()(T t) const
      {
        return static_cast<agx::UInt32>(t);
      }
    };
 
    typedef agx::HashTable<OutputCodec, agx::String, CodecHash> CodecStringConversionMap;
    static CodecStringConversionMap OutputCodecStrings;
 
  public:
 
    VideoFFMPEGPipeCapture(agx::UInt width, agx::UInt height, agx::Real fps, agxSDK::Simulation *sim = nullptr);
 
    void init();
 
    void setFilename(const agx::String& filename);
 
    void setFilenameExtension(const agx::String& extension);
 
    agx::String getFilenameExtension() const;
 
    agx::String getFilename() const;
 
    void setVideoFPS(agx::Real videoFPS);
 
    agx::Real getVideoFPS() const;
 
    void setVideoCRF(agx::UInt crf);
 
    agx::UInt getVideoCRF() const;
 
    void setImageCaptureFPS(agx::Real imageFPS);
 
    agx::Real getImageCaptureFPS();
 
    void setEnableLossless(bool enable);
 
    bool getEnableLossless() const;
 
    void setOutputVideoCodec(OutputCodec codec);
 
    OutputCodec getOutputCodec() const;
 
    bool hasActiveVideo() const;
 
    bool stopProcess();
 
  protected:
    virtual ~VideoFFMPEGPipeCapture();
 
    void startExternalFFMPEGProcess();
 
    void closeExternalFFMPEGProcess();
 
    agx::String generatePipeName() const;
 
    agx::String getPipeName() const;
 
    agx::String getFFMPEGBinaryPath() const;
 
  private:
 
    virtual void writeImage(osg::Image *image, agx::Index index);
 
  private:
    agx::String            m_filename;
    agx::Real              m_videoFPS;
    agx::String            m_pipeName;
    OutputCodec            m_outputCodec;
    agx::UInt              m_crf;
    agx::UInt              m_numWrittenFramesToPipe;
    bool m_firstFrame;
    bool m_enableLossless;
 
#ifdef _MSC_VER
    HANDLE hPipe;
#else
    FILE* m_fifo;
#endif
    agxOSG::ExternalProcessRef m_imageServerProcess;
  };
}
 
#endif /* AGXOSG_VideoFFMPEGPipeCapture_H */