media/filters/decrypting_video_decoder.cc

   1 // Copyright 2012 The Chromium Authors
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "media/filters/decrypting_video_decoder.h"
   6
   7 #include "base/bind.h"
   8 #include "base/callback_helpers.h"
   9 #include "base/location.h"
  10 #include "base/logging.h"
  11 #include "base/strings/string_number_conversions.h"
  12 #include "base/task/sequenced_task_runner.h"
  13 #include "base/trace_event/trace_event.h"
  14 #include "media/base/bind_to_current_loop.h"
  15 #include "media/base/cdm_context.h"
  16 #include "media/base/decoder_buffer.h"
  17 #include "media/base/media_log.h"
  18 #include "media/base/video_frame.h"
  19
  20 namespace media {
  21
  22 const char DecryptingVideoDecoder::kDecoderName[] = "DecryptingVideoDecoder";
  23
  24 DecryptingVideoDecoder::DecryptingVideoDecoder(
  25     const scoped_refptr<base::SequencedTaskRunner>& task_runner,
  26     MediaLog* media_log)
  27     : task_runner_(task_runner), media_log_(media_log) {
  28   DETACH_FROM_SEQUENCE(sequence_checker_);
  29 }
  30
  31 VideoDecoderType DecryptingVideoDecoder::GetDecoderType() const {
  32   return VideoDecoderType::kDecrypting;
  33 }
  34
  35 void DecryptingVideoDecoder::Initialize(const VideoDecoderConfig& config,
  36                                         bool /* low_delay */,
  37                                         CdmContext* cdm_context,
  38                                         InitCB init_cb,
  39                                         const OutputCB& output_cb,
  40                                         const WaitingCB& waiting_cb) {
  41   DVLOG(2) << __func__ << ": " << config.AsHumanReadableString();
  42
  43   DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  44   DCHECK(state_ == kUninitialized || state_ == kIdle ||
  45          state_ == kDecodeFinished)
  46       << state_;
  47   DCHECK(!decode_cb_);
  48   DCHECK(!reset_cb_);
  49   DCHECK(config.IsValidConfig());
  50
  51   init_cb_ = BindToCurrentLoop(std::move(init_cb));
  52
  53   if (!cdm_context) {
  54     // Once we have a CDM context, one should always be present.
  55     DCHECK(!support_clear_content_);
  56     std::move(init_cb_).Run(DecoderStatus::Codes::kUnsupportedEncryptionMode);
  57     return;
  58   }
  59
  60   if (!config.is_encrypted() && !support_clear_content_) {
  61     std::move(init_cb_).Run(DecoderStatus::Codes::kUnsupportedEncryptionMode);
  62     return;
  63   }
  64
  65   // Once initialized with encryption support, the value is sticky, so we'll use
  66   // the decryptor for clear content as well.
  67   support_clear_content_ = true;
  68
  69   output_cb_ = BindToCurrentLoop(output_cb);
  70   config_ = config;
  71
  72   DCHECK(waiting_cb);
  73   waiting_cb_ = waiting_cb;
  74
  75   if (state_ == kUninitialized) {
  76     if (!cdm_context->GetDecryptor()) {
  77       DVLOG(1) << __func__ << ": no decryptor";
  78       std::move(init_cb_).Run(DecoderStatus::Codes::kUnsupportedEncryptionMode);
  79       return;
  80     }
  81
  82     decryptor_ = cdm_context->GetDecryptor();
  83     event_cb_registration_ = cdm_context->RegisterEventCB(
  84         base::BindRepeating(&DecryptingVideoDecoder::OnCdmContextEvent,
  85                             weak_factory_.GetWeakPtr()));
  86   } else {
  87     // Reinitialization (i.e. upon a config change). The new config can be
  88     // encrypted or clear.
  89     decryptor_->DeinitializeDecoder(Decryptor::kVideo);
  90   }
  91
  92   state_ = kPendingDecoderInit;
  93   decryptor_->InitializeVideoDecoder(
  94       config_, BindToCurrentLoop(
  95                    base::BindOnce(&DecryptingVideoDecoder::FinishInitialization,
  96                                   weak_factory_.GetWeakPtr())));
  97 }
  98
  99 bool DecryptingVideoDecoder::SupportsDecryption() const {
 100   return true;
 101 }
 102
 103 void DecryptingVideoDecoder::Decode(scoped_refptr<DecoderBuffer> buffer,
 104                                     DecodeCB decode_cb) {
 105   DVLOG(3) << "Decode()";
 106   DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
 107   DCHECK(state_ == kIdle || state_ == kDecodeFinished || state_ == kError)
 108       << state_;
 109   DCHECK(decode_cb);
 110   CHECK(!decode_cb_) << "Overlapping decodes are not supported.";
 111
 112   decode_cb_ = BindToCurrentLoop(std::move(decode_cb));
 113
 114   if (state_ == kError) {
 115     std::move(decode_cb_).Run(DecoderStatus::Codes::kPlatformDecodeFailure);
 116     return;
 117   }
 118
 119   // Return empty frames if decoding has finished.
 120   if (state_ == kDecodeFinished) {
 121     std::move(decode_cb_).Run(DecoderStatus::Codes::kOk);
 122     return;
 123   }
 124
 125   pending_buffer_to_decode_ = std::move(buffer);
 126   state_ = kPendingDecode;
 127   DecodePendingBuffer();
 128 }
 129
 130 void DecryptingVideoDecoder::Reset(base::OnceClosure closure) {
 131   DVLOG(2) << "Reset() - state: " << state_;
 132   DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
 133   DCHECK(state_ == kIdle || state_ == kPendingDecode ||
 134          state_ == kWaitingForKey || state_ == kDecodeFinished ||
 135          state_ == kError)
 136       << state_;
 137   DCHECK(!init_cb_);  // No Reset() during pending initialization.
 138   DCHECK(!reset_cb_);
 139
 140   reset_cb_ = BindToCurrentLoop(std::move(closure));
 141
 142   decryptor_->ResetDecoder(Decryptor::kVideo);
 143
 144   // Reset() cannot complete if the decode callback is still pending.
 145   // Defer the resetting process in this case. The |reset_cb_| will be fired
 146   // after the decode callback is fired - see DecryptAndDecodeBuffer() and
 147   // DeliverFrame().
 148   if (state_ == kPendingDecode) {
 149     DCHECK(decode_cb_);
 150     return;
 151   }
 152
 153   if (state_ == kWaitingForKey) {
 154     CompleteWaitingForDecryptionKey();
 155     DCHECK(decode_cb_);
 156     pending_buffer_to_decode_.reset();
 157     std::move(decode_cb_).Run(DecoderStatus::Codes::kAborted);
 158   }
 159
 160   DCHECK(!decode_cb_);
 161   DoReset();
 162 }
 163
 164 DecryptingVideoDecoder::~DecryptingVideoDecoder() {
 165   DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
 166
 167   if (state_ == kUninitialized)
 168     return;
 169
 170   if (state_ == kWaitingForKey)
 171     CompleteWaitingForDecryptionKey();
 172   if (state_ == kPendingDecode)
 173     CompletePendingDecode(Decryptor::kError);
 174
 175   if (decryptor_) {
 176     decryptor_->DeinitializeDecoder(Decryptor::kVideo);
 177     decryptor_ = nullptr;
 178   }
 179   pending_buffer_to_decode_.reset();
 180   if (init_cb_)
 181     std::move(init_cb_).Run(DecoderStatus::Codes::kInterrupted);
 182   if (decode_cb_)
 183     std::move(decode_cb_).Run(DecoderStatus::Codes::kAborted);
 184   if (reset_cb_)
 185     std::move(reset_cb_).Run();
 186 }
 187
 188 void DecryptingVideoDecoder::FinishInitialization(bool success) {
 189   DVLOG(2) << "FinishInitialization()";
 190   DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
 191   DCHECK_EQ(state_, kPendingDecoderInit) << state_;
 192   DCHECK(init_cb_);
 193   DCHECK(!reset_cb_);   // No Reset() before initialization finished.
 194   DCHECK(!decode_cb_);  // No Decode() before initialization finished.
 195
 196   if (!success) {
 197     DVLOG(1) << __func__ << ": failed to init video decoder on decryptor";
 198     // TODO(*) Is there a better reason? Should this method itself take a
 199     // status?
 200     std::move(init_cb_).Run(DecoderStatus::Codes::kFailed);
 201     decryptor_ = nullptr;
 202     event_cb_registration_.reset();
 203     state_ = kError;
 204     return;
 205   }
 206
 207   // Success!
 208   state_ = kIdle;
 209   std::move(init_cb_).Run(DecoderStatus::Codes::kOk);
 210 }
 211
 212 void DecryptingVideoDecoder::DecodePendingBuffer() {
 213   DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
 214   DCHECK_EQ(state_, kPendingDecode) << state_;
 215
 216   // Note: Traces require a unique ID per decode, if we ever support multiple
 217   // in flight decodes, the trace begin+end macros need the same unique id.
 218   DCHECK_EQ(GetMaxDecodeRequests(), 1);
 219   TRACE_EVENT_ASYNC_BEGIN1(
 220       "media", "DecryptingVideoDecoder::DecodePendingBuffer", this,
 221       "timestamp_us",
 222       pending_buffer_to_decode_->end_of_stream()
 223           ? 0
 224           : pending_buffer_to_decode_->timestamp().InMicroseconds());
 225
 226   decryptor_->DecryptAndDecodeVideo(
 227       pending_buffer_to_decode_,
 228       BindToCurrentLoop(base::BindRepeating(
 229           &DecryptingVideoDecoder::DeliverFrame, weak_factory_.GetWeakPtr())));
 230 }
 231
 232 void DecryptingVideoDecoder::DeliverFrame(Decryptor::Status status,
 233                                           scoped_refptr<VideoFrame> frame) {
 234   DVLOG(3) << "DeliverFrame() - status: " << status;
 235   DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
 236   DCHECK_EQ(state_, kPendingDecode) << state_;
 237   DCHECK(decode_cb_);
 238   DCHECK(pending_buffer_to_decode_.get());
 239   CompletePendingDecode(status);
 240
 241   bool need_to_try_again_if_nokey_is_returned = key_added_while_decode_pending_;
 242   key_added_while_decode_pending_ = false;
 243
 244   scoped_refptr<DecoderBuffer> scoped_pending_buffer_to_decode =
 245       std::move(pending_buffer_to_decode_);
 246
 247   if (reset_cb_) {
 248     std::move(decode_cb_).Run(DecoderStatus::Codes::kAborted);
 249     DoReset();
 250     return;
 251   }
 252
 253   DCHECK_EQ(status == Decryptor::kSuccess, frame.get() != nullptr);
 254
 255   if (status == Decryptor::kError) {
 256     DVLOG(2) << "DeliverFrame() - kError";
 257     MEDIA_LOG(ERROR, media_log_) << GetDecoderType() << ": decode error";
 258     state_ = kError;
 259     std::move(decode_cb_).Run(DecoderStatus::Codes::kPlatformDecodeFailure);
 260     return;
 261   }
 262
 263   if (status == Decryptor::kNoKey) {
 264     std::string key_id =
 265         scoped_pending_buffer_to_decode->decrypt_config()->key_id();
 266     std::string log_message =
 267         "no key for key ID " + base::HexEncode(key_id.data(), key_id.size()) +
 268         "; will resume decoding after new usable key is available";
 269     DVLOG(1) << __func__ << ": " << log_message;
 270     MEDIA_LOG(INFO, media_log_) << GetDecoderType() << ": " << log_message;
 271
 272     // Set |pending_buffer_to_decode_| back as we need to try decoding the
 273     // pending buffer again when new key is added to the decryptor.
 274     pending_buffer_to_decode_ = std::move(scoped_pending_buffer_to_decode);
 275
 276     if (need_to_try_again_if_nokey_is_returned) {
 277       // The |state_| is still kPendingDecode.
 278       MEDIA_LOG(INFO, media_log_)
 279           << GetDecoderType() << ": key was added, resuming decode";
 280       DecodePendingBuffer();
 281       return;
 282     }
 283
 284     TRACE_EVENT_ASYNC_BEGIN0(
 285         "media", "DecryptingVideoDecoder::WaitingForDecryptionKey", this);
 286     state_ = kWaitingForKey;
 287     waiting_cb_.Run(WaitingReason::kNoDecryptionKey);
 288     return;
 289   }
 290
 291   if (status == Decryptor::kNeedMoreData) {
 292     DVLOG(2) << "DeliverFrame() - kNeedMoreData";
 293     state_ = scoped_pending_buffer_to_decode->end_of_stream() ? kDecodeFinished
 294                                                               : kIdle;
 295     std::move(decode_cb_).Run(DecoderStatus::Codes::kOk);
 296     return;
 297   }
 298
 299   DCHECK_EQ(status, Decryptor::kSuccess);
 300   CHECK(frame);
 301
 302   // Frame returned with kSuccess should not be an end-of-stream frame.
 303   DCHECK(!frame->metadata().end_of_stream);
 304
 305   // If color space is not set, use the color space in the |config_|.
 306   if (!frame->ColorSpace().IsValid()) {
 307     DVLOG(3) << "Setting color space using information in the config.";
 308     if (config_.color_space_info().IsSpecified())
 309       frame->set_color_space(config_.color_space_info().ToGfxColorSpace());
 310   }
 311
 312   output_cb_.Run(std::move(frame));
 313
 314   if (scoped_pending_buffer_to_decode->end_of_stream()) {
 315     // Set |pending_buffer_to_decode_| back as we need to keep flushing the
 316     // decryptor.
 317     pending_buffer_to_decode_ = std::move(scoped_pending_buffer_to_decode);
 318     DecodePendingBuffer();
 319     return;
 320   }
 321
 322   state_ = kIdle;
 323   std::move(decode_cb_).Run(DecoderStatus::Codes::kOk);
 324 }
 325
 326 void DecryptingVideoDecoder::OnCdmContextEvent(CdmContext::Event event) {
 327   DVLOG(2) << __func__;
 328   DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
 329
 330   if (event != CdmContext::Event::kHasAdditionalUsableKey)
 331     return;
 332
 333   if (state_ == kPendingDecode) {
 334     key_added_while_decode_pending_ = true;
 335     return;
 336   }
 337
 338   if (state_ == kWaitingForKey) {
 339     CompleteWaitingForDecryptionKey();
 340     MEDIA_LOG(INFO, media_log_)
 341         << GetDecoderType() << ": key added, resuming decode";
 342     state_ = kPendingDecode;
 343     DecodePendingBuffer();
 344   }
 345 }
 346
 347 void DecryptingVideoDecoder::DoReset() {
 348   DCHECK(!init_cb_);
 349   DCHECK(!decode_cb_);
 350   state_ = kIdle;
 351   std::move(reset_cb_).Run();
 352 }
 353
 354 void DecryptingVideoDecoder::CompletePendingDecode(Decryptor::Status status) {
 355   DCHECK_EQ(state_, kPendingDecode);
 356   TRACE_EVENT_ASYNC_END1("media", "DecryptingVideoDecoder::DecodePendingBuffer",
 357                          this, "status", Decryptor::GetStatusName(status));
 358 }
 359
 360 void DecryptingVideoDecoder::CompleteWaitingForDecryptionKey() {
 361   DCHECK_EQ(state_, kWaitingForKey);
 362   TRACE_EVENT_ASYNC_END0(
 363       "media", "DecryptingVideoDecoder::WaitingForDecryptionKey", this);
 364 }
 365
 366 }  // namespace media