Implement Dependency Descriptor writer

Bug: webrtc:10342
Change-Id: I561825265c0990864e1d16aeed4afbdd98871940
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/153350
Reviewed-by: Philip Eliasson <philipel@webrtc.org>
Commit-Queue: Danil Chapovalov <danilchap@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#29232}

modules/rtp_rtcp/BUILD.gn

@@ -46,8 +46,6 @@ rtc_source_set("rtp_rtcp_format") {
     "source/rtcp_packet/tmmbr.h",
     "source/rtcp_packet/transport_feedback.h",
     "source/rtp_dependency_descriptor_extension.h",
-    "source/rtp_dependency_descriptor_reader.h",
-    "source/rtp_dependency_descriptor_writer.h",
     "source/rtp_generic_frame_descriptor.h",
     "source/rtp_generic_frame_descriptor_extension.h",
     "source/rtp_header_extensions.h",
@@ -87,6 +85,9 @@ rtc_source_set("rtp_rtcp_format") {
     "source/rtcp_packet/transport_feedback.cc",
     "source/rtp_dependency_descriptor_extension.cc",
     "source/rtp_dependency_descriptor_reader.cc",
+    "source/rtp_dependency_descriptor_reader.h",
+    "source/rtp_dependency_descriptor_writer.cc",
+    "source/rtp_dependency_descriptor_writer.h",
     "source/rtp_generic_frame_descriptor.cc",
     "source/rtp_generic_frame_descriptor_extension.cc",
     "source/rtp_header_extension_map.cc",
@@ -112,6 +113,7 @@ rtc_source_set("rtp_rtcp_format") {
     "../../common_video/generic_frame_descriptor",
     "../../rtc_base:checks",
     "../../rtc_base:deprecation",
+    "../../rtc_base:divide_round",
     "../../rtc_base:rtc_base_approved",
     "../../rtc_base/system:unused",
     "../../system_wrappers",

modules/rtp_rtcp/source/rtp_dependency_descriptor_extension.cc

@@ -16,6 +16,8 @@
 #include "common_video/generic_frame_descriptor/generic_frame_info.h"
 #include "modules/rtp_rtcp/include/rtp_rtcp_defines.h"
 #include "modules/rtp_rtcp/source/rtp_dependency_descriptor_reader.h"
+#include "modules/rtp_rtcp/source/rtp_dependency_descriptor_writer.h"
+#include "rtc_base/numerics/divide_round.h"
 
 namespace webrtc {
 
@@ -30,4 +32,19 @@ bool RtpDependencyDescriptorExtension::Parse(
   return reader.ParseSuccessful();
 }
 
+size_t RtpDependencyDescriptorExtension::ValueSize(
+    const FrameDependencyStructure& structure,
+    const DependencyDescriptor& descriptor) {
+  RtpDependencyDescriptorWriter writer(/*data=*/{}, structure, descriptor);
+  return DivideRoundUp(writer.ValueSizeBits(), 8);
+}
+
+bool RtpDependencyDescriptorExtension::Write(
+    rtc::ArrayView<uint8_t> data,
+    const FrameDependencyStructure& structure,
+    const DependencyDescriptor& descriptor) {
+  RtpDependencyDescriptorWriter writer(data, structure, descriptor);
+  return writer.Write();
+}
+
 }  // namespace webrtc

modules/rtp_rtcp/source/rtp_dependency_descriptor_extension.h

@@ -15,7 +15,6 @@
 #include "api/array_view.h"
 #include "common_video/generic_frame_descriptor/generic_frame_info.h"
 #include "modules/rtp_rtcp/include/rtp_rtcp_defines.h"
-#include "modules/rtp_rtcp/source/rtp_dependency_descriptor_writer.h"
 
 namespace webrtc {
 // Trait to read/write the dependency descriptor extension as described in
@@ -34,15 +33,11 @@ class RtpDependencyDescriptorExtension {
                     const FrameDependencyStructure* structure,
                     DependencyDescriptor* descriptor);
 
-  static size_t ValueSize(RtpDependencyDescriptorWriter* writer,
+  static size_t ValueSize(const FrameDependencyStructure& structure,
-                          const DependencyDescriptor& descriptor) {
+                          const DependencyDescriptor& descriptor);
-    return writer->ValueSizeBytes(descriptor);
-  }
   static bool Write(rtc::ArrayView<uint8_t> data,
-                    RtpDependencyDescriptorWriter* writer,
+                    const FrameDependencyStructure& structure,
-                    const DependencyDescriptor& descriptor) {
+                    const DependencyDescriptor& descriptor);
-    return writer->Write(descriptor, data);
-  }
 };
 
 }  // namespace webrtc

modules/rtp_rtcp/source/rtp_dependency_descriptor_writer.cc

@@ -0,0 +1,359 @@
+/*
+ *  Copyright (c) 2019 The WebRTC project authors. All Rights Reserved.
+ *
+ *  Use of this source code is governed by a BSD-style license
+ *  that can be found in the LICENSE file in the root of the source
+ *  tree. An additional intellectual property rights grant can be found
+ *  in the file PATENTS.  All contributing project authors may
+ *  be found in the AUTHORS file in the root of the source tree.
+ */
+#include "modules/rtp_rtcp/source/rtp_dependency_descriptor_writer.h"
+
+#include <cstddef>
+#include <cstdint>
+#include <iterator>
+#include <vector>
+
+#include "absl/algorithm/container.h"
+#include "api/array_view.h"
+#include "common_video/generic_frame_descriptor/generic_frame_info.h"
+#include "rtc_base/bit_buffer.h"
+#include "rtc_base/checks.h"
+
+namespace webrtc {
+namespace {
+
+constexpr int kMaxTemplates = 63;
+
+enum class NextLayerIdc : uint64_t {
+  kSameLayer = 0,
+  kNextTemporal = 1,
+  kNewSpatial = 2,
+  kNoMoreLayers = 3,
+  kInvalid = 4
+};
+
+NextLayerIdc GetNextLayerIdc(const FrameDependencyTemplate& previous,
+                             const FrameDependencyTemplate& next) {
+  // TODO(danilchap): Move these constants to header shared between reader and
+  // writer.
+  static constexpr int kMaxSpatialId = 3;
+  static constexpr int kMaxTemporalId = 7;
+  RTC_DCHECK_LE(next.spatial_id, kMaxSpatialId);
+  RTC_DCHECK_LE(next.temporal_id, kMaxTemporalId);
+
+  if (next.spatial_id == previous.spatial_id &&
+      next.temporal_id == previous.temporal_id) {
+    return NextLayerIdc::kSameLayer;
+  } else if (next.spatial_id == previous.spatial_id &&
+             next.temporal_id == previous.temporal_id + 1) {
+    return NextLayerIdc::kNextTemporal;
+  } else if (next.spatial_id == previous.spatial_id + 1 &&
+             next.temporal_id == 0) {
+    return NextLayerIdc::kNewSpatial;
+  }
+  // Everything else is unsupported.
+  return NextLayerIdc::kInvalid;
+}
+
+}  // namespace
+
+RtpDependencyDescriptorWriter::RtpDependencyDescriptorWriter(
+    rtc::ArrayView<uint8_t> data,
+    const FrameDependencyStructure& structure,
+    const DependencyDescriptor& descriptor)
+    : descriptor_(descriptor),
+      structure_(structure),
+      bit_writer_(data.data(), data.size()) {
+  FindBestTemplate();
+}
+
+bool RtpDependencyDescriptorWriter::Write() {
+  WriteMandatoryFields();
+  if (HasExtendedFields()) {
+    WriteExtendedFields();
+    WriteFrameDependencyDefinition();
+  }
+  return !build_failed_;
+}
+
+int RtpDependencyDescriptorWriter::ValueSizeBits() const {
+  static constexpr int kMandatoryFields = 1 + 1 + 6 + 16;
+  int value_size_bits = kMandatoryFields + best_template_.extra_size_bits;
+  if (descriptor_.attached_structure)
+    value_size_bits += 10 + StructureSizeBits();
+  return value_size_bits;
+}
+
+int RtpDependencyDescriptorWriter::StructureSizeBits() const {
+  // template_id offset (6 bits) and number of decode targets (5 bits)
+  int bits = 11;
+  // template layers.
+  bits += 2 * structure_.templates.size();
+  // dtis.
+  bits += 2 * structure_.templates.size() * structure_.num_decode_targets;
+  // fdiffs. each templates uses 1 + 5 * sizeof(fdiff) bits.
+  bits += structure_.templates.size();
+  for (const FrameDependencyTemplate& frame_template : structure_.templates) {
+    bits += 5 * frame_template.frame_diffs.size();
+  }
+  bits += rtc::BitBufferWriter::SizeNonSymmetricBits(
+      structure_.num_chains, structure_.num_decode_targets + 1);
+  if (structure_.num_chains > 0) {
+    for (int protected_by : structure_.decode_target_protected_by_chain) {
+      bits += rtc::BitBufferWriter::SizeNonSymmetricBits(
+          protected_by, structure_.num_chains + 1);
+    }
+    bits += 4 * structure_.templates.size() * structure_.num_chains;
+  }
+  // Resolutions.
+  bits += 1 + 32 * structure_.resolutions.size();
+  return bits;
+}
+
+RtpDependencyDescriptorWriter::TemplateMatch
+RtpDependencyDescriptorWriter::CalculateMatch(
+    TemplateIterator frame_template) const {
+  TemplateMatch result;
+  result.template_position = frame_template;
+  result.need_custom_fdiffs =
+      descriptor_.frame_dependencies.frame_diffs != frame_template->frame_diffs;
+  result.need_custom_dtis =
+      descriptor_.frame_dependencies.decode_target_indications !=
+      frame_template->decode_target_indications;
+  result.need_custom_chains =
+      descriptor_.frame_dependencies.chain_diffs != frame_template->chain_diffs;
+
+  if (!result.need_custom_fdiffs && !result.need_custom_dtis &&
+      !result.need_custom_chains) {
+    // Perfect match.
+    result.extra_size_bits = 0;
+    return result;
+  }
+  // If structure should be attached, then there will be ExtendedFields anyway,
+  // so do not count 10 bits for them as extra.
+  result.extra_size_bits = descriptor_.attached_structure ? 0 : 10;
+  if (result.need_custom_fdiffs) {
+    result.extra_size_bits +=
+        2 * (1 + descriptor_.frame_dependencies.frame_diffs.size());
+    for (int fdiff : descriptor_.frame_dependencies.frame_diffs) {
+      if (fdiff <= (1 << 4))
+        result.extra_size_bits += 4;
+      else if (fdiff <= (1 << 8))
+        result.extra_size_bits += 8;
+      else
+        result.extra_size_bits += 12;
+    }
+  }
+  if (result.need_custom_dtis) {
+    result.extra_size_bits +=
+        2 * descriptor_.frame_dependencies.decode_target_indications.size();
+  }
+  if (result.need_custom_chains)
+    result.extra_size_bits += 8 * structure_.num_chains;
+  return result;
+}
+
+void RtpDependencyDescriptorWriter::FindBestTemplate() {
+  const std::vector<FrameDependencyTemplate>& templates = structure_.templates;
+  // Find range of templates with matching spatial/temporal id.
+  auto same_layer = [&](const FrameDependencyTemplate& frame_template) {
+    return descriptor_.frame_dependencies.spatial_id ==
+               frame_template.spatial_id &&
+           descriptor_.frame_dependencies.temporal_id ==
+               frame_template.temporal_id;
+  };
+  auto first = absl::c_find_if(templates, same_layer);
+  RTC_CHECK(first != templates.end());
+  auto last = std::find_if_not(first, templates.end(), same_layer);
+
+  best_template_ = CalculateMatch(first);
+  // Search if there any better template than the first one.
+  for (auto next = std::next(first); next != last; ++next) {
+    TemplateMatch match = CalculateMatch(next);
+    if (match.extra_size_bits < best_template_.extra_size_bits)
+      best_template_ = match;
+  }
+}
+
+bool RtpDependencyDescriptorWriter::HasExtendedFields() const {
+  return best_template_.extra_size_bits > 0 || descriptor_.attached_structure;
+}
+
+uint64_t RtpDependencyDescriptorWriter::TemplateId() const {
+  return (best_template_.template_position - structure_.templates.begin() +
+          structure_.structure_id) %
+         kMaxTemplates;
+}
+
+void RtpDependencyDescriptorWriter::WriteBits(uint64_t val, size_t bit_count) {
+  if (!bit_writer_.WriteBits(val, bit_count))
+    build_failed_ = true;
+}
+
+void RtpDependencyDescriptorWriter::WriteNonSymmetric(uint32_t value,
+                                                      uint32_t num_values) {
+  if (!bit_writer_.WriteNonSymmetric(value, num_values))
+    build_failed_ = true;
+}
+
+void RtpDependencyDescriptorWriter::WriteTemplateDependencyStructure() {
+  RTC_DCHECK_GE(structure_.structure_id, 0);
+  RTC_DCHECK_LT(structure_.structure_id, kMaxTemplates);
+  RTC_DCHECK_GT(structure_.num_decode_targets, 0);
+  RTC_DCHECK_LE(structure_.num_decode_targets, 1 << 5);
+
+  WriteBits(structure_.structure_id, 6);
+  WriteBits(structure_.num_decode_targets - 1, 5);
+  WriteTemplateLayers();
+  WriteTemplateDtis();
+  WriteTemplateFdiffs();
+  WriteTemplateChains();
+  uint64_t has_resolutions = structure_.resolutions.empty() ? 0 : 1;
+  WriteBits(has_resolutions, 1);
+  if (has_resolutions)
+    WriteResolutions();
+}
+
+void RtpDependencyDescriptorWriter::WriteTemplateLayers() {
+  const auto& templates = structure_.templates;
+  RTC_DCHECK(!templates.empty());
+  RTC_DCHECK_LE(templates.size(), kMaxTemplates);
+  RTC_DCHECK_EQ(templates[0].spatial_id, 0);
+  RTC_DCHECK_EQ(templates[0].temporal_id, 0);
+
+  for (size_t i = 1; i < templates.size(); ++i) {
+    uint64_t next_layer_idc =
+        static_cast<uint64_t>(GetNextLayerIdc(templates[i - 1], templates[i]));
+    RTC_DCHECK_LE(next_layer_idc, 3);
+    WriteBits(next_layer_idc, 2);
+  }
+  WriteBits(static_cast<uint64_t>(NextLayerIdc::kNoMoreLayers), 2);
+}
+
+void RtpDependencyDescriptorWriter::WriteTemplateDtis() {
+  for (const FrameDependencyTemplate& current_template : structure_.templates) {
+    RTC_DCHECK_EQ(current_template.decode_target_indications.size(),
+                  structure_.num_decode_targets);
+    for (DecodeTargetIndication dti :
+         current_template.decode_target_indications) {
+      WriteBits(static_cast<uint32_t>(dti), 2);
+    }
+  }
+}
+
+void RtpDependencyDescriptorWriter::WriteTemplateFdiffs() {
+  for (const FrameDependencyTemplate& current_template : structure_.templates) {
+    for (int fdiff : current_template.frame_diffs) {
+      RTC_DCHECK_GE(fdiff - 1, 0);
+      RTC_DCHECK_LT(fdiff - 1, 1 << 4);
+      WriteBits((1u << 4) | (fdiff - 1), 1 + 4);
+    }
+    // No more diffs for current template.
+    WriteBits(/*val=*/0, /*bit_count=*/1);
+  }
+}
+
+void RtpDependencyDescriptorWriter::WriteTemplateChains() {
+  RTC_DCHECK_GE(structure_.num_chains, 0);
+  RTC_DCHECK_LE(structure_.num_chains, structure_.num_decode_targets);
+
+  WriteNonSymmetric(structure_.num_chains, structure_.num_decode_targets + 1);
+  if (structure_.num_chains == 0)
+    return;
+
+  RTC_DCHECK_EQ(structure_.decode_target_protected_by_chain.size(),
+                structure_.num_decode_targets);
+  for (int protected_by : structure_.decode_target_protected_by_chain) {
+    RTC_DCHECK_GE(protected_by, 0);
+    RTC_DCHECK_LE(protected_by, structure_.num_chains);
+    WriteNonSymmetric(protected_by, structure_.num_chains + 1);
+  }
+  for (const auto& frame_template : structure_.templates) {
+    RTC_DCHECK_EQ(frame_template.chain_diffs.size(), structure_.num_chains);
+    for (int chain_diff : frame_template.chain_diffs) {
+      RTC_DCHECK_GE(chain_diff, 0);
+      RTC_DCHECK_LT(chain_diff, 1 << 4);
+      WriteBits(chain_diff, 4);
+    }
+  }
+}
+
+void RtpDependencyDescriptorWriter::WriteResolutions() {
+  int max_spatial_id = structure_.templates.back().spatial_id;
+  RTC_DCHECK_EQ(structure_.resolutions.size(), max_spatial_id + 1);
+  for (const RenderResolution& resolution : structure_.resolutions) {
+    RTC_DCHECK_GT(resolution.Width(), 0);
+    RTC_DCHECK_LE(resolution.Width(), 1 << 16);
+    RTC_DCHECK_GT(resolution.Height(), 0);
+    RTC_DCHECK_LE(resolution.Height(), 1 << 16);
+
+    WriteBits(resolution.Width() - 1, 16);
+    WriteBits(resolution.Height() - 1, 16);
+  }
+}
+
+void RtpDependencyDescriptorWriter::WriteMandatoryFields() {
+  static constexpr uint64_t kExtendedFieldsIndicator = 0b111111;
+  WriteBits(descriptor_.first_packet_in_frame, 1);
+  WriteBits(descriptor_.last_packet_in_frame, 1);
+  WriteBits(HasExtendedFields() ? kExtendedFieldsIndicator : TemplateId(), 6);
+  WriteBits(descriptor_.frame_number, 16);
+}
+
+void RtpDependencyDescriptorWriter::WriteExtendedFields() {
+  WriteBits(TemplateId(), 6);
+  uint64_t template_dependency_structure_present_flag =
+      descriptor_.attached_structure ? 1u : 0u;
+  WriteBits(template_dependency_structure_present_flag, 1);
+  WriteBits(best_template_.need_custom_dtis, 1);
+  WriteBits(best_template_.need_custom_fdiffs, 1);
+  WriteBits(best_template_.need_custom_chains, 1);
+  if (descriptor_.attached_structure)
+    WriteTemplateDependencyStructure();
+}
+
+void RtpDependencyDescriptorWriter::WriteFrameDependencyDefinition() {
+  if (best_template_.need_custom_dtis)
+    WriteFrameDtis();
+  if (best_template_.need_custom_fdiffs)
+    WriteFrameFdiffs();
+  if (best_template_.need_custom_chains)
+    WriteFrameChains();
+}
+
+void RtpDependencyDescriptorWriter::WriteFrameDtis() {
+  RTC_DCHECK_EQ(descriptor_.frame_dependencies.decode_target_indications.size(),
+                structure_.num_decode_targets);
+  for (DecodeTargetIndication dti :
+       descriptor_.frame_dependencies.decode_target_indications) {
+    WriteBits(static_cast<uint32_t>(dti), 2);
+  }
+}
+
+void RtpDependencyDescriptorWriter::WriteFrameFdiffs() {
+  for (int fdiff : descriptor_.frame_dependencies.frame_diffs) {
+    RTC_DCHECK_GT(fdiff, 0);
+    RTC_DCHECK_LE(fdiff, 1 << 12);
+    if (fdiff <= (1 << 4))
+      WriteBits((1u << 4) | (fdiff - 1), 2 + 4);
+    else if (fdiff <= (1 << 8))
+      WriteBits((2u << 8) | (fdiff - 1), 2 + 8);
+    else  // fdiff <= (1 << 12)
+      WriteBits((3u << 12) | (fdiff - 1), 2 + 12);
+  }
+  // No more diffs.
+  WriteBits(/*val=*/0, /*bit_count=*/2);
+}
+
+void RtpDependencyDescriptorWriter::WriteFrameChains() {
+  RTC_DCHECK_EQ(descriptor_.frame_dependencies.chain_diffs.size(),
+                structure_.num_chains);
+  for (int chain_diff : descriptor_.frame_dependencies.chain_diffs) {
+    RTC_DCHECK_GE(chain_diff, 0);
+    RTC_DCHECK_LT(chain_diff, 1 << 8);
+    WriteBits(chain_diff, 8);
+  }
+}
+
+}  // namespace webrtc

modules/rtp_rtcp/source/rtp_dependency_descriptor_writer.h

@@ -10,38 +10,74 @@
 #ifndef MODULES_RTP_RTCP_SOURCE_RTP_DEPENDENCY_DESCRIPTOR_WRITER_H_
 #define MODULES_RTP_RTCP_SOURCE_RTP_DEPENDENCY_DESCRIPTOR_WRITER_H_
 
+#include <cstddef>
 #include <cstdint>
+#include <vector>
 
 #include "api/array_view.h"
 #include "common_video/generic_frame_descriptor/generic_frame_info.h"
+#include "rtc_base/bit_buffer.h"
 
 namespace webrtc {
-// Serialize DependencyDescriptor with respect to set FrameDependencyStructure.
 class RtpDependencyDescriptorWriter {
  public:
+  // Assumes |structure| and |descriptor| are valid and
+  // |descriptor| matches the |structure|.
+  RtpDependencyDescriptorWriter(rtc::ArrayView<uint8_t> data,
+                                const FrameDependencyStructure& structure,
+                                const DependencyDescriptor& descriptor);
+
+  // Serializes DependencyDescriptor rtp header extension.
+  // Returns false if |data| is too small to serialize the |descriptor|.
+  bool Write();
+
   // Returns minimum number of bits needed to serialize descriptor with respect
-  // to current FrameDependencyStructure. Returns 0 if |descriptor| can't be
+  // to the |structure|. Returns 0 if |descriptor| can't be serialized.
-  // serialized.
+  int ValueSizeBits() const;
-  size_t ValueSizeBits(const DependencyDescriptor& descriptor) const {
-    // TODO(bugs.webrtc.org/10342): Implement.
-    return 0;
-  }
-  size_t ValueSizeBytes(const DependencyDescriptor& descriptor) const {
-    return (ValueSizeBits(descriptor) + 7) / 8;
-  }
 
-  bool Write(const DependencyDescriptor& frame_info,
+ private:
-             rtc::ArrayView<uint8_t> raw_data) const {
+  // Used both as pointer to the template and as index in the templates vector.
-    // TODO(bugs.webrtc.org/10342): Implement.
+  using TemplateIterator = std::vector<FrameDependencyTemplate>::const_iterator;
-    return false;
+  struct TemplateMatch {
-  }
+    TemplateIterator template_position;
+    bool need_custom_dtis;
+    bool need_custom_fdiffs;
+    bool need_custom_chains;
+    // Size in bits to store frame-specific details, i.e.
+    // excluding mandatory fields and template dependency structure.
+    int extra_size_bits;
+  };
+  int StructureSizeBits() const;
+  TemplateMatch CalculateMatch(TemplateIterator frame_template) const;
+  void FindBestTemplate();
+  bool HasExtendedFields() const;
+  uint64_t TemplateId() const;
 
-  // Sets FrameDependencyStructure to derive individual descriptors from.
+  void WriteBits(uint64_t val, size_t bit_count);
-  // Returns false on failure, e.g. structure is invalid or oversized.
+  void WriteNonSymmetric(uint32_t value, uint32_t num_values);
-  bool SetStructure(const FrameDependencyStructure& structure) {
+
-    // TODO(bugs.webrtc.org/10342): Implement.
+  // Functions to read template dependency structure.
-    return false;
+  void WriteTemplateDependencyStructure();
-  }
+  void WriteTemplateLayers();
+  void WriteTemplateDtis();
+  void WriteTemplateFdiffs();
+  void WriteTemplateChains();
+  void WriteResolutions();
+
+  // Function to read details for the current frame.
+  void WriteMandatoryFields();
+  void WriteExtendedFields();
+  void WriteFrameDependencyDefinition();
+
+  void WriteFrameDtis();
+  void WriteFrameFdiffs();
+  void WriteFrameChains();
+
+  bool build_failed_ = false;
+  const DependencyDescriptor& descriptor_;
+  const FrameDependencyStructure& structure_;
+  rtc::BitBufferWriter bit_writer_;
+  TemplateMatch best_template_;
 };
 
 }  // namespace webrtc