blob: 20505a16afeff7b9abcdd6327b66e6aae113a71c [file] [log] [blame]
ilnikd60d06a2017-04-05 03:02:20 -07001/*
2 * Copyright (c) 2014 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020011#ifndef API_VIDEO_CODECS_VIDEO_DECODER_H_
12#define API_VIDEO_CODECS_VIDEO_DECODER_H_
ilnikd60d06a2017-04-05 03:02:20 -070013
14#include <memory>
15#include <string>
16#include <vector>
17
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020018#include "api/video/video_frame.h"
Mirko Bonadei71207422017-09-15 13:58:09 +020019#include "common_types.h" // NOLINT(build/include)
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020020#include "common_video/include/video_frame.h"
Mirko Bonadei71207422017-09-15 13:58:09 +020021#include "typedefs.h" // NOLINT(build/include)
ilnikd60d06a2017-04-05 03:02:20 -070022
23namespace webrtc {
24
25class RTPFragmentationHeader;
26// TODO(pbos): Expose these through a public (root) header or change these APIs.
27struct CodecSpecificInfo;
28class VideoCodec;
29
30class DecodedImageCallback {
31 public:
32 virtual ~DecodedImageCallback() {}
33
34 virtual int32_t Decoded(VideoFrame& decodedImage) = 0;
35 // Provides an alternative interface that allows the decoder to specify the
36 // decode time excluding waiting time for any previous pending frame to
37 // return. This is necessary for breaking positive feedback in the delay
38 // estimation when the decoder has a single output buffer.
Niels Möllerbe682d42018-03-27 08:31:45 +020039 virtual int32_t Decoded(VideoFrame& decodedImage, int64_t decode_time_ms);
40
ilnikd60d06a2017-04-05 03:02:20 -070041 // TODO(sakal): Remove other implementations when upstream projects have been
42 // updated.
43 virtual void Decoded(VideoFrame& decodedImage,
44 rtc::Optional<int32_t> decode_time_ms,
Niels Möllerbe682d42018-03-27 08:31:45 +020045 rtc::Optional<uint8_t> qp);
ilnikd60d06a2017-04-05 03:02:20 -070046
Niels Möllerbe682d42018-03-27 08:31:45 +020047 virtual int32_t ReceivedDecodedReferenceFrame(const uint64_t pictureId);
ilnikd60d06a2017-04-05 03:02:20 -070048
Niels Möllerbe682d42018-03-27 08:31:45 +020049 virtual int32_t ReceivedDecodedFrame(const uint64_t pictureId);
ilnikd60d06a2017-04-05 03:02:20 -070050};
51
52class VideoDecoder {
53 public:
54 virtual ~VideoDecoder() {}
55
56 virtual int32_t InitDecode(const VideoCodec* codec_settings,
57 int32_t number_of_cores) = 0;
58
59 virtual int32_t Decode(const EncodedImage& input_image,
60 bool missing_frames,
Niels Möller8df3a382018-05-07 16:10:01 +020061 const CodecSpecificInfo* codec_specific_info,
62 int64_t render_time_ms);
63
64 // TODO(nisse): Deprecated. Delete this method, and make the above pure
65 // virtual, after downstream projects are updated. The default implementations
66 // of this method and the above ensures that during the transition, subclasses
67 // can choose to implement one or the other.
68 virtual int32_t Decode(const EncodedImage& input_image,
69 bool missing_frames,
ilnikd60d06a2017-04-05 03:02:20 -070070 const RTPFragmentationHeader* fragmentation,
71 const CodecSpecificInfo* codec_specific_info = NULL,
Niels Möller8df3a382018-05-07 16:10:01 +020072 int64_t render_time_ms = -1);
ilnikd60d06a2017-04-05 03:02:20 -070073
74 virtual int32_t RegisterDecodeCompleteCallback(
75 DecodedImageCallback* callback) = 0;
76
77 virtual int32_t Release() = 0;
78
79 // Returns true if the decoder prefer to decode frames late.
80 // That is, it can not decode infinite number of frames before the decoded
81 // frame is consumed.
Niels Möllerbe682d42018-03-27 08:31:45 +020082 virtual bool PrefersLateDecoding() const;
ilnikd60d06a2017-04-05 03:02:20 -070083
Niels Möllerbe682d42018-03-27 08:31:45 +020084 virtual const char* ImplementationName() const;
ilnikd60d06a2017-04-05 03:02:20 -070085};
86
87} // namespace webrtc
88
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020089#endif // API_VIDEO_CODECS_VIDEO_DECODER_H_