diff options
Diffstat (limited to 'webrtc/modules/video_coding/codecs/i420/include/i420.h')
-rw-r--r-- | webrtc/modules/video_coding/codecs/i420/include/i420.h | 145 |
1 files changed, 73 insertions, 72 deletions
diff --git a/webrtc/modules/video_coding/codecs/i420/include/i420.h b/webrtc/modules/video_coding/codecs/i420/include/i420.h index 8990ccf878..9f77845e96 100644 --- a/webrtc/modules/video_coding/codecs/i420/include/i420.h +++ b/webrtc/modules/video_coding/codecs/i420/include/i420.h @@ -8,12 +8,12 @@ * be found in the AUTHORS file in the root of the source tree. */ -#ifndef WEBRTC_MODULES_VIDEO_CODING_CODECS_I420_MAIN_INTERFACE_I420_H_ -#define WEBRTC_MODULES_VIDEO_CODING_CODECS_I420_MAIN_INTERFACE_I420_H_ +#ifndef WEBRTC_MODULES_VIDEO_CODING_CODECS_I420_INCLUDE_I420_H_ +#define WEBRTC_MODULES_VIDEO_CODING_CODECS_I420_INCLUDE_I420_H_ #include <vector> -#include "webrtc/modules/video_coding/codecs/interface/video_codec_interface.h" +#include "webrtc/modules/video_coding/include/video_codec_interface.h" #include "webrtc/typedefs.h" namespace webrtc { @@ -24,45 +24,45 @@ class I420Encoder : public VideoEncoder { virtual ~I420Encoder(); -// Initialize the encoder with the information from the VideoCodec. -// -// Input: -// - codecSettings : Codec settings. -// - numberOfCores : Number of cores available for the encoder. -// - maxPayloadSize : The maximum size each payload is allowed -// to have. Usually MTU - overhead. -// -// Return value : WEBRTC_VIDEO_CODEC_OK if OK. -// <0 - Error + // Initialize the encoder with the information from the VideoCodec. + // + // Input: + // - codecSettings : Codec settings. + // - numberOfCores : Number of cores available for the encoder. + // - maxPayloadSize : The maximum size each payload is allowed + // to have. Usually MTU - overhead. + // + // Return value : WEBRTC_VIDEO_CODEC_OK if OK. + // <0 - Error int InitEncode(const VideoCodec* codecSettings, int /*numberOfCores*/, size_t /*maxPayloadSize*/) override; -// "Encode" an I420 image (as a part of a video stream). The encoded image -// will be returned to the user via the encode complete callback. -// -// Input: -// - inputImage : Image to be encoded. -// - codecSpecificInfo : Pointer to codec specific data. -// - frameType : Frame type to be sent (Key /Delta). -// -// Return value : WEBRTC_VIDEO_CODEC_OK if OK. -// <0 - Error + // "Encode" an I420 image (as a part of a video stream). The encoded image + // will be returned to the user via the encode complete callback. + // + // Input: + // - inputImage : Image to be encoded. + // - codecSpecificInfo : Pointer to codec specific data. + // - frameType : Frame type to be sent (Key /Delta). + // + // Return value : WEBRTC_VIDEO_CODEC_OK if OK. + // <0 - Error int Encode(const VideoFrame& inputImage, const CodecSpecificInfo* /*codecSpecificInfo*/, const std::vector<FrameType>* /*frame_types*/) override; -// Register an encode complete callback object. -// -// Input: -// - callback : Callback object which handles encoded images. -// -// Return value : WEBRTC_VIDEO_CODEC_OK if OK, < 0 otherwise. + // Register an encode complete callback object. + // + // Input: + // - callback : Callback object which handles encoded images. + // + // Return value : WEBRTC_VIDEO_CODEC_OK if OK, < 0 otherwise. int RegisterEncodeCompleteCallback(EncodedImageCallback* callback) override; -// Free encoder memory. -// -// Return value : WEBRTC_VIDEO_CODEC_OK if OK, < 0 otherwise. + // Free encoder memory. + // + // Return value : WEBRTC_VIDEO_CODEC_OK if OK, < 0 otherwise. int Release() override; int SetRates(uint32_t /*newBitRate*/, uint32_t /*frameRate*/) override { @@ -76,12 +76,13 @@ class I420Encoder : public VideoEncoder { void OnDroppedFrame() override {} private: - static uint8_t* InsertHeader(uint8_t* buffer, uint16_t width, + static uint8_t* InsertHeader(uint8_t* buffer, + uint16_t width, uint16_t height); - bool _inited; - EncodedImage _encodedImage; - EncodedImageCallback* _encodedCompleteCallback; + bool _inited; + EncodedImage _encodedImage; + EncodedImageCallback* _encodedCompleteCallback; }; // class I420Encoder class I420Decoder : public VideoDecoder { @@ -90,50 +91,50 @@ class I420Decoder : public VideoDecoder { virtual ~I420Decoder(); -// Initialize the decoder. -// The user must notify the codec of width and height values. -// -// Return value : WEBRTC_VIDEO_CODEC_OK. -// <0 - Errors + // Initialize the decoder. + // The user must notify the codec of width and height values. + // + // Return value : WEBRTC_VIDEO_CODEC_OK. + // <0 - Errors int InitDecode(const VideoCodec* codecSettings, int /*numberOfCores*/) override; -// Decode encoded image (as a part of a video stream). The decoded image -// will be returned to the user through the decode complete callback. -// -// Input: -// - inputImage : Encoded image to be decoded -// - missingFrames : True if one or more frames have been lost -// since the previous decode call. -// - codecSpecificInfo : pointer to specific codec data -// - renderTimeMs : Render time in Ms -// -// Return value : WEBRTC_VIDEO_CODEC_OK if OK -// <0 - Error + // Decode encoded image (as a part of a video stream). The decoded image + // will be returned to the user through the decode complete callback. + // + // Input: + // - inputImage : Encoded image to be decoded + // - missingFrames : True if one or more frames have been lost + // since the previous decode call. + // - codecSpecificInfo : pointer to specific codec data + // - renderTimeMs : Render time in Ms + // + // Return value : WEBRTC_VIDEO_CODEC_OK if OK + // <0 - Error int Decode(const EncodedImage& inputImage, bool missingFrames, const RTPFragmentationHeader* /*fragmentation*/, const CodecSpecificInfo* /*codecSpecificInfo*/, int64_t /*renderTimeMs*/) override; -// Register a decode complete callback object. -// -// Input: -// - callback : Callback object which handles decoded images. -// -// Return value : WEBRTC_VIDEO_CODEC_OK if OK, < 0 otherwise. + // Register a decode complete callback object. + // + // Input: + // - callback : Callback object which handles decoded images. + // + // Return value : WEBRTC_VIDEO_CODEC_OK if OK, < 0 otherwise. int RegisterDecodeCompleteCallback(DecodedImageCallback* callback) override; -// Free decoder memory. -// -// Return value : WEBRTC_VIDEO_CODEC_OK if OK. -// <0 - Error + // Free decoder memory. + // + // Return value : WEBRTC_VIDEO_CODEC_OK if OK. + // <0 - Error int Release() override; -// Reset decoder state and prepare for a new call. -// -// Return value : WEBRTC_VIDEO_CODEC_OK. -// <0 - Error + // Reset decoder state and prepare for a new call. + // + // Return value : WEBRTC_VIDEO_CODEC_OK. + // <0 - Error int Reset() override; private: @@ -142,12 +143,12 @@ class I420Decoder : public VideoDecoder { uint16_t* height); VideoFrame _decodedImage; - int _width; - int _height; - bool _inited; - DecodedImageCallback* _decodeCompleteCallback; + int _width; + int _height; + bool _inited; + DecodedImageCallback* _decodeCompleteCallback; }; // class I420Decoder } // namespace webrtc -#endif // WEBRTC_MODULES_VIDEO_CODING_CODECS_I420_MAIN_INTERFACE_I420_H_ +#endif // WEBRTC_MODULES_VIDEO_CODING_CODECS_I420_INCLUDE_I420_H_ |