ivideoencoder.h

Go to the documentation of this file.

/********************************************************************************************
* Twitch Broadcasting SDK
*
* This software is supplied under the terms of a license agreement with Twitch Interactive, Inc. and
* may not be copied or used except in accordance with the terms of that agreement
* Copyright (c) 2012-2016 Twitch Interactive, Inc.
*********************************************************************************************/

#pragma once

#include "twitchsdk/broadcast/broadcasttypes.h"
#include "twitchsdk/broadcast/ivideoframereceiver.h"

#include <vector>
#include <memory>

namespace ttv
{
    namespace broadcast
    {       
        class IFrameWriter;
        class VideoFrame;
        class IVideoEncoder;
    }
}


class ttv::broadcast::IVideoEncoder
{
public:
    virtual ~IVideoEncoder();

public:
    virtual std::string GetName() const = 0;
    virtual bool SupportsBitRateAdjustment() const = 0;
    virtual TTV_ErrorCode Initialize() = 0;
    virtual TTV_ErrorCode Shutdown() = 0;
    virtual TTV_ErrorCode SetFrameWriter(const std::shared_ptr<IFrameWriter>& frameWriter) = 0;
    /*
     * Called by the system to ensure the video parameters are valid for the encoder.
     * @return
     *    - TTV_EC_SUCCESS - Video parameters are valid for this encoder.
     *    - TTV_EC_BROADCAST_INVALID_RESOLUTION - Resolution is not valid for this encoder.
     *    - TTV_EC_BROADCAST_INVALID_FPS - Frames per second is not valid for this encoder.
     *    - TTV_EC_INVALID_ARG - Some other parameter is an invalid value.
     */
    virtual TTV_ErrorCode ValidateVideoParams(const VideoParams& videoParams) const = 0;
    /*
     * Called by the system when the stream starts.
     */
    virtual TTV_ErrorCode Start(uint32_t streamIndex, const VideoParams& videoParams) = 0;
    virtual TTV_ErrorCode SubmitFrame(const std::shared_ptr<VideoFrame>& videoFrame) = 0;
    virtual TTV_ErrorCode Stop() = 0;
    virtual TTV_ErrorCode GetSpsPps(std::vector<uint8_t>& sps, std::vector<uint8_t>& pps) = 0;
    virtual TTV_ErrorCode ValidateFrame(const std::shared_ptr<VideoFrame>& videoframe) = 0;
    virtual TTV_ErrorCode SetTargetBitRate(uint32_t kbps) = 0;
    template <typename T> bool SupportsReceiverProtocol() const { return SupportsReceiverProtocol(T::GetReceiverTypeId()); }
    virtual bool SupportsReceiverProtocol(IVideoFrameReceiver::ReceiverTypeId typeId) const = 0;
    virtual std::shared_ptr<IVideoFrameReceiver> GetReceiverImplementation(IVideoFrameReceiver::ReceiverTypeId typeId) = 0;
};