obs-StreamFX/source/encoders/ffmpeg-encoder.hpp

// FFMPEG Video Encoder Integration for OBS Studio
// Copyright (c) 2019 Michael Fabian Dirks <info@xaymar.com>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#pragma once
#include <condition_variable>
#include <map>
#include <memory>
#include <mutex>
#include <queue>
#include <stack>
#include <string>
#include <thread>
#include <vector>
#include "ffmpeg/avframe-queue.hpp"
#include "ffmpeg/hwapi/base.hpp"
#include "ffmpeg/swscale.hpp"
#include "handlers/handler.hpp"

extern "C" {
#include <obs-properties.h>
#include <obs.h>
#pragma warning(push)
#pragma warning(disable : 4244)
#include <libavcodec/avcodec.h>
#include <libavutil/frame.h>
#pragma warning(pop)
}

#define S_RATECONTROL "FFmpeg.RateControl"
#define S_RATECONTROL_MODE "FFmpeg.RateControl.Mode"
#define S_RATECONTROL_MODE_(x) "FFmpeg.RateControl.Mode." D_VSTR(x)
#define S_RATECONTROL_BITRATE_TARGET "FFmpeg.RateControl.Bitrate.Target"
#define S_RATECONTROL_BITRATE_MINIMUM "FFmpeg.RateControl.Bitrate.Minimum"
#define S_RATECONTROL_BITRATE_MAXIMUM "FFmpeg.RateControl.Bitrate.Maximum"
#define S_RATECONTROL_BUFFERSIZE "FFmpeg.RateControl.BufferSize"
#define S_RATECONTROL_QUALITY_TARGET "RateControl.Quality.Target"
#define S_RATECONTROL_QUALITY_MINIMUM "RateControl.Quality.Minimum"
#define S_RATECONTROL_QUALITY_MAXIMUM "RateControl.Quality.Maximum"
#define S_RATECONTROL_QP_I "RateControl.QP.I"
#define S_RATECONTROL_QP_P "RateControl.QP.P"
#define S_RATECONTROL_QP_B "RateControl.QP.B"
#define S_RATECONTROL_QP_I_INITIAL "RateControl.QP.I.Initial"
#define S_RATECONTROL_QP_P_INITIAL "RateControl.QP.P.Initial"
#define S_RATECONTROL_QP_B_INITIAL "RateControl.QP.B.Initial"

#define S_KEYFRAMES "KeyFrames"
#define S_KEYFRAMES_INTERVALTYPE "KeyFrames.IntervalType"
#define S_KEYFRAMES_INTERVALTYPE_(x) "KeyFrames.IntervalType." D_VSTR(x)
#define S_KEYFRAMES_INTERVAL "KeyFrames.Interval"
#define S_KEYFRAMES_INTERVAL_SECONDS "KeyFrames.Interval.Seconds"
#define S_KEYFRAMES_INTERVAL_FRAMES "KeyFrames.Interval.Frames"

namespace encoder::ffmpeg {
	class ffmpeg_factory;

	class ffmpeg_manager {
		static ::std::shared_ptr<ffmpeg_manager> _instance;

		public: // Singleton
		static void initialize()
		{
			_instance = ::std::make_shared<ffmpeg_manager>();
		}

		static void finalize()
		{
			_instance.reset();
		}

		static std::shared_ptr<ffmpeg_manager> get()
		{
			return _instance;
		}

		private:
		std::map<const AVCodec*, std::shared_ptr<ffmpeg_factory>> _factories;
		std::map<std::string, std::shared_ptr<handler::handler>>  _handlers;
		std::shared_ptr<handler::handler>                         _debug_handler;

		public:
		ffmpeg_manager();
		~ffmpeg_manager();

		void register_handler(std::string const codec, std::shared_ptr<handler::handler> const handler);

		std::shared_ptr<handler::handler> const get_handler(std::string const codec);

		bool has_handler(std::string const codec);
	};

	struct ffmpeg_info {
		std::string      uid;
		std::string      codec;
		std::string      readable_name;
		obs_encoder_info oei = {0};
	};

	class ffmpeg_factory {
		ffmpeg_info    info;
		ffmpeg_info    info_fallback;
		const AVCodec* avcodec_ptr;

		std::shared_ptr<handler::handler> _handler;

		public:
		ffmpeg_factory(const AVCodec* codec);
		virtual ~ffmpeg_factory();

		void register_encoder();

		void get_defaults(obs_data_t* settings, bool hw_encoder = false);

		void get_properties(obs_properties_t* props, bool hw_encoder = false);

		const AVCodec* get_avcodec();

		const ffmpeg_info& get_info();

		const ffmpeg_info& get_fallback();
	};

	class ffmpeg_instance {
		obs_encoder_t*  _self;
		ffmpeg_factory* _factory;

		const AVCodec*  _codec;
		AVCodecContext* _context;

		std::shared_ptr<handler::handler> _handler;

		std::shared_ptr<::ffmpeg::hwapi::base>     _hwapi;
		std::shared_ptr<::ffmpeg::hwapi::instance> _hwinst;

		::ffmpeg::swscale _swscale;
		AVPacket          _current_packet;

		size_t _lag_in_frames;
		size_t _count_send_frames;

		// Extra Data
		bool                 _have_first_frame;
		std::vector<uint8_t> _extra_data;
		std::vector<uint8_t> _sei_data;

		// Frame Stack and Queue
		std::stack<std::shared_ptr<AVFrame>>           _free_frames;
		std::queue<std::shared_ptr<AVFrame>>           _used_frames;
		std::chrono::high_resolution_clock::time_point _free_frames_last_used;

		void initialize_sw(obs_data_t* settings);
		void initialize_hw(obs_data_t* settings);

		void                     push_free_frame(std::shared_ptr<AVFrame> frame);
		std::shared_ptr<AVFrame> pop_free_frame();

		void                     push_used_frame(std::shared_ptr<AVFrame> frame);
		std::shared_ptr<AVFrame> pop_used_frame();

		public:
		ffmpeg_instance(obs_data_t* settings, obs_encoder_t* encoder, bool is_texture_encode = false);
		virtual ~ffmpeg_instance();

		public: // OBS API
		// Shared
		void get_properties(obs_properties_t* props, bool hw_encode = false);

		bool update(obs_data_t* settings);

		// Audio only
		void get_audio_info(struct audio_convert_info* info);

		size_t get_frame_size();

		bool audio_encode(struct encoder_frame* frame, struct encoder_packet* packet, bool* received_packet);

		// Video only
		void get_video_info(struct video_scale_info* info);

		bool get_sei_data(uint8_t** sei_data, size_t* size);

		bool get_extra_data(uint8_t** extra_data, size_t* size);

		bool video_encode(struct encoder_frame* frame, struct encoder_packet* packet, bool* received_packet);

		bool video_encode_texture(uint32_t handle, int64_t pts, uint64_t lock_key, uint64_t* next_key,
								  struct encoder_packet* packet, bool* received_packet);

		int receive_packet(bool* received_packet, struct encoder_packet* packet);

		int send_frame(std::shared_ptr<AVFrame> frame);

		bool encode_avframe(std::shared_ptr<AVFrame> frame, struct encoder_packet* packet, bool* received_packet);

		public: // Handler API
		bool is_hardware_encode();

		const AVCodec* get_avcodec();

		const AVCodecContext* get_avcodeccontext();

		void parse_ffmpeg_commandline(std::string text);
	};
} // namespace encoder::ffmpeg