Line data    Source code

       1             : /*
       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             : 
      11             : #ifndef WEBRTC_VIDEO_DECODER_H_
      12             : #define WEBRTC_VIDEO_DECODER_H_
      13             : 
      14             : #include <memory>
      15             : #include <string>
      16             : #include <vector>
      17             : 
      18             : #include "webrtc/common_types.h"
      19             : #include "webrtc/typedefs.h"
      20             : #include "webrtc/video_frame.h"
      21             : 
      22             : namespace webrtc {
      23             : 
      24             : class RTPFragmentationHeader;
      25             : // TODO(pbos): Expose these through a public (root) header or change these APIs.
      26             : struct CodecSpecificInfo;
      27             : class VideoCodec;
      28             : 
      29           0 : class DecodedImageCallback {
      30             :  public:
      31           0 :   virtual ~DecodedImageCallback() {}
      32             : 
      33             :   virtual int32_t Decoded(VideoFrame& decodedImage) = 0;
      34             :   // Provides an alternative interface that allows the decoder to specify the
      35             :   // decode time excluding waiting time for any previous pending frame to
      36             :   // return. This is necessary for breaking positive feedback in the delay
      37             :   // estimation when the decoder has a single output buffer.
      38             :   // TODO(perkj): Remove default implementation when chromium has been updated.
      39           0 :   virtual int32_t Decoded(VideoFrame& decodedImage, int64_t decode_time_ms) {
      40             :     // The default implementation ignores custom decode time value.
      41           0 :     return Decoded(decodedImage);
      42             :   }
      43             : 
      44           0 :   virtual int32_t ReceivedDecodedReferenceFrame(const uint64_t pictureId) {
      45           0 :     return -1;
      46             :   }
      47             : 
      48           0 :   virtual int32_t ReceivedDecodedFrame(const uint64_t pictureId) { return -1; }
      49             : };
      50             : 
      51           0 : class VideoDecoder {
      52             :  public:
      53           0 :   virtual ~VideoDecoder() {}
      54             : 
      55             :   virtual int32_t InitDecode(const VideoCodec* codec_settings,
      56             :                              int32_t number_of_cores) = 0;
      57             : 
      58             :   virtual int32_t Decode(const EncodedImage& input_image,
      59             :                          bool missing_frames,
      60             :                          const RTPFragmentationHeader* fragmentation,
      61             :                          const CodecSpecificInfo* codec_specific_info = NULL,
      62             :                          int64_t render_time_ms = -1) = 0;
      63             : 
      64             :   virtual int32_t RegisterDecodeCompleteCallback(
      65             :       DecodedImageCallback* callback) = 0;
      66             : 
      67             :   virtual int32_t Release() = 0;
      68             : 
      69             :   // Returns true if the decoder prefer to decode frames late.
      70             :   // That is, it can not decode infinite number of frames before the decoded
      71             :   // frame is consumed.
      72           0 :   virtual bool PrefersLateDecoding() const { return true; }
      73             : 
      74           0 :   virtual const char* ImplementationName() const { return "unknown"; }
      75             : };
      76             : 
      77             : }  // namespace webrtc
      78             : 
      79             : #endif  // WEBRTC_VIDEO_DECODER_H_