DASH Media Packaging SDK
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator
mpd_builder.cc
1 // Copyright 2014 Google Inc. All rights reserved.
2 //
3 // Use of this source code is governed by a BSD-style
4 // license that can be found in the LICENSE file or at
5 // https://developers.google.com/open-source/licenses/bsd
6 
7 #include "packager/mpd/base/mpd_builder.h"
8 
9 #include <libxml/tree.h>
10 #include <libxml/xmlstring.h>
11 
12 #include <cmath>
13 #include <iterator>
14 #include <list>
15 #include <memory>
16 #include <string>
17 
18 #include "packager/base/base64.h"
19 #include "packager/base/bind.h"
20 #include "packager/base/files/file_path.h"
21 #include "packager/base/logging.h"
22 #include "packager/base/strings/string_number_conversions.h"
23 #include "packager/base/strings/stringprintf.h"
24 #include "packager/base/synchronization/lock.h"
25 #include "packager/base/time/default_clock.h"
26 #include "packager/base/time/time.h"
27 #include "packager/media/base/language_utils.h"
28 #include "packager/media/file/file.h"
29 #include "packager/mpd/base/content_protection_element.h"
30 #include "packager/mpd/base/mpd_utils.h"
31 #include "packager/mpd/base/xml/xml_node.h"
32 #include "packager/version/version.h"
33 
34 namespace shaka {
35 
36 using base::FilePath;
37 using xml::XmlNode;
38 using xml::RepresentationXmlNode;
39 using xml::AdaptationSetXmlNode;
40 
41 namespace {
42 
43 AdaptationSet::Role MediaInfoTextTypeToRole(
44  MediaInfo::TextInfo::TextType type) {
45  switch (type) {
46  case MediaInfo::TextInfo::UNKNOWN:
47  LOG(WARNING) << "Unknown text type, assuming subtitle.";
48  return AdaptationSet::kRoleSubtitle;
49  case MediaInfo::TextInfo::CAPTION:
50  return AdaptationSet::kRoleCaption;
51  case MediaInfo::TextInfo::SUBTITLE:
52  return AdaptationSet::kRoleSubtitle;
53  default:
54  NOTREACHED() << "Unknown MediaInfo TextType: " << type
55  << " assuming subtitle.";
56  return AdaptationSet::kRoleSubtitle;
57  }
58 }
59 
60 std::string GetMimeType(const std::string& prefix,
61  MediaInfo::ContainerType container_type) {
62  switch (container_type) {
63  case MediaInfo::CONTAINER_MP4:
64  return prefix + "/mp4";
65  case MediaInfo::CONTAINER_MPEG2_TS:
66  // NOTE: DASH MPD spec uses lowercase but RFC3555 says uppercase.
67  return prefix + "/MP2T";
68  case MediaInfo::CONTAINER_WEBM:
69  return prefix + "/webm";
70  default:
71  break;
72  }
73 
74  // Unsupported container types should be rejected/handled by the caller.
75  LOG(ERROR) << "Unrecognized container type: " << container_type;
76  return std::string();
77 }
78 
79 void AddMpdNameSpaceInfo(XmlNode* mpd) {
80  DCHECK(mpd);
81 
82  static const char kXmlNamespace[] = "urn:mpeg:dash:schema:mpd:2011";
83  static const char kXmlNamespaceXsi[] =
84  "http://www.w3.org/2001/XMLSchema-instance";
85  static const char kXmlNamespaceXlink[] = "http://www.w3.org/1999/xlink";
86  static const char kDashSchemaMpd2011[] =
87  "urn:mpeg:dash:schema:mpd:2011 DASH-MPD.xsd";
88  static const char kCencNamespace[] = "urn:mpeg:cenc:2013";
89 
90  mpd->SetStringAttribute("xmlns", kXmlNamespace);
91  mpd->SetStringAttribute("xmlns:xsi", kXmlNamespaceXsi);
92  mpd->SetStringAttribute("xmlns:xlink", kXmlNamespaceXlink);
93  mpd->SetStringAttribute("xsi:schemaLocation", kDashSchemaMpd2011);
94  mpd->SetStringAttribute("xmlns:cenc", kCencNamespace);
95 }
96 
97 bool IsPeriodNode(xmlNodePtr node) {
98  DCHECK(node);
99  int kEqual = 0;
100  return xmlStrcmp(node->name, reinterpret_cast<const xmlChar*>("Period")) ==
101  kEqual;
102 }
103 
104 // Find the first <Period> element. This does not recurse down the tree,
105 // only checks direct children. Returns the pointer to Period element on
106 // success, otherwise returns false.
107 // As noted here, we must traverse.
108 // http://www.xmlsoft.org/tutorial/ar01s04.html
109 xmlNodePtr FindPeriodNode(XmlNode* xml_node) {
110  for (xmlNodePtr node = xml_node->GetRawPtr()->xmlChildrenNode; node != NULL;
111  node = node->next) {
112  if (IsPeriodNode(node))
113  return node;
114  }
115 
116  return NULL;
117 }
118 
119 bool Positive(double d) {
120  return d > 0.0;
121 }
122 
123 // Return current time in XML DateTime format. The value is in UTC, so the
124 // string ends with a 'Z'.
125 std::string XmlDateTimeNowWithOffset(
126  int32_t offset_seconds,
127  base::Clock* clock) {
128  base::Time time = clock->Now();
129  time += base::TimeDelta::FromSeconds(offset_seconds);
130  base::Time::Exploded time_exploded;
131  time.UTCExplode(&time_exploded);
132 
133  return base::StringPrintf("%4d-%02d-%02dT%02d:%02d:%02dZ", time_exploded.year,
134  time_exploded.month, time_exploded.day_of_month,
135  time_exploded.hour, time_exploded.minute,
136  time_exploded.second);
137 }
138 
139 void SetIfPositive(const char* attr_name, double value, XmlNode* mpd) {
140  if (Positive(value)) {
141  mpd->SetStringAttribute(attr_name, SecondsToXmlDuration(value));
142  }
143 }
144 
145 uint32_t GetTimeScale(const MediaInfo& media_info) {
146  if (media_info.has_reference_time_scale()) {
147  return media_info.reference_time_scale();
148  }
149 
150  if (media_info.has_video_info()) {
151  return media_info.video_info().time_scale();
152  }
153 
154  if (media_info.has_audio_info()) {
155  return media_info.audio_info().time_scale();
156  }
157 
158  LOG(WARNING) << "No timescale specified, using 1 as timescale.";
159  return 1;
160 }
161 
162 uint64_t LastSegmentStartTime(const SegmentInfo& segment_info) {
163  return segment_info.start_time + segment_info.duration * segment_info.repeat;
164 }
165 
166 // This is equal to |segment_info| end time
167 uint64_t LastSegmentEndTime(const SegmentInfo& segment_info) {
168  return segment_info.start_time +
169  segment_info.duration * (segment_info.repeat + 1);
170 }
171 
172 uint64_t LatestSegmentStartTime(const std::list<SegmentInfo>& segments) {
173  DCHECK(!segments.empty());
174  const SegmentInfo& latest_segment = segments.back();
175  return LastSegmentStartTime(latest_segment);
176 }
177 
178 // Given |timeshift_limit|, finds out the number of segments that are no longer
179 // valid and should be removed from |segment_info|.
180 int SearchTimedOutRepeatIndex(uint64_t timeshift_limit,
181  const SegmentInfo& segment_info) {
182  DCHECK_LE(timeshift_limit, LastSegmentEndTime(segment_info));
183  if (timeshift_limit < segment_info.start_time)
184  return 0;
185 
186  return (timeshift_limit - segment_info.start_time) / segment_info.duration;
187 }
188 
189 // Overload this function to support different types of |output|.
190 // Note that this could be done by call MpdBuilder::ToString() and use the
191 // result to write to a file, it requires an extra copy.
192 bool WriteXmlCharArrayToOutput(xmlChar* doc,
193  int doc_size,
194  std::string* output) {
195  DCHECK(doc);
196  DCHECK(output);
197  output->assign(doc, doc + doc_size);
198  return true;
199 }
200 
201 bool WriteXmlCharArrayToOutput(xmlChar* doc,
202  int doc_size,
203  media::File* output) {
204  DCHECK(doc);
205  DCHECK(output);
206  if (output->Write(doc, doc_size) < doc_size)
207  return false;
208 
209  return output->Flush();
210 }
211 
212 std::string MakePathRelative(const std::string& path,
213  const std::string& mpd_dir) {
214  return (path.find(mpd_dir) == 0) ? path.substr(mpd_dir.size()) : path;
215 }
216 
217 // Check whether the video info has width and height.
218 // DASH IOP also requires several other fields for video representations, namely
219 // width, height, framerate, and sar.
220 bool HasRequiredVideoFields(const MediaInfo_VideoInfo& video_info) {
221  if (!video_info.has_height() || !video_info.has_width()) {
222  LOG(ERROR)
223  << "Width and height are required fields for generating a valid MPD.";
224  return false;
225  }
226  // These fields are not required for a valid MPD, but required for DASH IOP
227  // compliant MPD. MpdBuilder can keep generating MPDs without these fields.
228  LOG_IF(WARNING, !video_info.has_time_scale())
229  << "Video info does not contain timescale required for "
230  "calculating framerate. @frameRate is required for DASH IOP.";
231  LOG_IF(WARNING, !video_info.has_frame_duration())
232  << "Video info does not contain frame duration required "
233  "for calculating framerate. @frameRate is required for DASH IOP.";
234  LOG_IF(WARNING, !video_info.has_pixel_width())
235  << "Video info does not contain pixel_width to calculate the sample "
236  "aspect ratio required for DASH IOP.";
237  LOG_IF(WARNING, !video_info.has_pixel_height())
238  << "Video info does not contain pixel_height to calculate the sample "
239  "aspect ratio required for DASH IOP.";
240  return true;
241 }
242 
243 // Returns the picture aspect ratio string e.g. "16:9", "4:3".
244 // "Reducing the quotient to minimal form" does not work well in practice as
245 // there may be some rounding performed in the input, e.g. the resolution of
246 // 480p is 854:480 for 16:9 aspect ratio, can only be reduced to 427:240.
247 // The algorithm finds out the pair of integers, num and den, where num / den is
248 // the closest ratio to scaled_width / scaled_height, by looping den through
249 // common values.
250 std::string GetPictureAspectRatio(uint32_t width,
251  uint32_t height,
252  uint32_t pixel_width,
253  uint32_t pixel_height) {
254  const uint32_t scaled_width = pixel_width * width;
255  const uint32_t scaled_height = pixel_height * height;
256  const double par = static_cast<double>(scaled_width) / scaled_height;
257 
258  // Typical aspect ratios have par_y less than or equal to 19:
259  // https://en.wikipedia.org/wiki/List_of_common_resolutions
260  const uint32_t kLargestPossibleParY = 19;
261 
262  uint32_t par_num = 0;
263  uint32_t par_den = 0;
264  double min_error = 1.0;
265  for (uint32_t den = 1; den <= kLargestPossibleParY; ++den) {
266  uint32_t num = par * den + 0.5;
267  double error = fabs(par - static_cast<double>(num) / den);
268  if (error < min_error) {
269  min_error = error;
270  par_num = num;
271  par_den = den;
272  if (error == 0) break;
273  }
274  }
275  VLOG(2) << "width*pix_width : height*pixel_height (" << scaled_width << ":"
276  << scaled_height << ") reduced to " << par_num << ":" << par_den
277  << " with error " << min_error << ".";
278 
279  return base::IntToString(par_num) + ":" + base::IntToString(par_den);
280 }
281 
282 // Adds an entry to picture_aspect_ratio if the size of picture_aspect_ratio is
283 // less than 2 and video_info has both pixel width and pixel height.
284 void AddPictureAspectRatio(
285  const MediaInfo::VideoInfo& video_info,
286  std::set<std::string>* picture_aspect_ratio) {
287  // If there are more than one entries in picture_aspect_ratio, the @par
288  // attribute cannot be set, so skip.
289  if (picture_aspect_ratio->size() > 1)
290  return;
291 
292  if (video_info.width() == 0 || video_info.height() == 0 ||
293  video_info.pixel_width() == 0 || video_info.pixel_height() == 0) {
294  // If there is even one Representation without a @sar attribute, @par cannot
295  // be calculated.
296  // Just populate the set with at least 2 bogus strings so that further call
297  // to this function will bail out immediately.
298  picture_aspect_ratio->insert("bogus");
299  picture_aspect_ratio->insert("entries");
300  return;
301  }
302 
303  const std::string par = GetPictureAspectRatio(
304  video_info.width(), video_info.height(),
305  video_info.pixel_width(), video_info.pixel_height());
306  DVLOG(1) << "Setting par as: " << par
307  << " for video with width: " << video_info.width()
308  << " height: " << video_info.height()
309  << " pixel_width: " << video_info.pixel_width() << " pixel_height; "
310  << video_info.pixel_height();
311  picture_aspect_ratio->insert(par);
312 }
313 
314 std::string RoleToText(AdaptationSet::Role role) {
315  // Using switch so that the compiler can detect whether there is a case that's
316  // not being handled.
317  switch (role) {
318  case AdaptationSet::kRoleCaption:
319  return "caption";
320  case AdaptationSet::kRoleSubtitle:
321  return "subtitle";
322  case AdaptationSet::kRoleMain:
323  return "main";
324  case AdaptationSet::kRoleAlternate:
325  return "alternate";
326  case AdaptationSet::kRoleSupplementary:
327  return "supplementary";
328  case AdaptationSet::kRoleCommentary:
329  return "commentary";
330  case AdaptationSet::kRoleDub:
331  return "dub";
332  default:
333  break;
334  }
335 
336  NOTREACHED();
337  return "";
338 }
339 
340 // Spooky static initialization/cleanup of libxml.
341 class LibXmlInitializer {
342  public:
343  LibXmlInitializer() : initialized_(false) {
344  base::AutoLock lock(lock_);
345  if (!initialized_) {
346  xmlInitParser();
347  initialized_ = true;
348  }
349  }
350 
351  ~LibXmlInitializer() {
352  base::AutoLock lock(lock_);
353  if (initialized_) {
354  xmlCleanupParser();
355  initialized_ = false;
356  }
357  }
358 
359  private:
360  base::Lock lock_;
361  bool initialized_;
362 
363  DISALLOW_COPY_AND_ASSIGN(LibXmlInitializer);
364 };
365 
366 class RepresentationStateChangeListenerImpl
367  : public RepresentationStateChangeListener {
368  public:
369  // |adaptation_set| is not owned by this class.
370  RepresentationStateChangeListenerImpl(uint32_t representation_id,
371  AdaptationSet* adaptation_set)
372  : representation_id_(representation_id), adaptation_set_(adaptation_set) {
373  DCHECK(adaptation_set_);
374  }
375  ~RepresentationStateChangeListenerImpl() override {}
376 
377  // RepresentationStateChangeListener implementation.
378  void OnNewSegmentForRepresentation(uint64_t start_time,
379  uint64_t duration) override {
380  adaptation_set_->OnNewSegmentForRepresentation(representation_id_,
381  start_time, duration);
382  }
383 
384  void OnSetFrameRateForRepresentation(uint32_t frame_duration,
385  uint32_t timescale) override {
386  adaptation_set_->OnSetFrameRateForRepresentation(representation_id_,
387  frame_duration, timescale);
388  }
389 
390  private:
391  const uint32_t representation_id_;
392  AdaptationSet* const adaptation_set_;
393 
394  DISALLOW_COPY_AND_ASSIGN(RepresentationStateChangeListenerImpl);
395 };
396 
397 } // namespace
398 
400  : mpd_options_(mpd_options), clock_(new base::DefaultClock()) {}
401 
402 MpdBuilder::~MpdBuilder() {}
403 
404 void MpdBuilder::AddBaseUrl(const std::string& base_url) {
405  base_urls_.push_back(base_url);
406 }
407 
408 AdaptationSet* MpdBuilder::AddAdaptationSet(const std::string& lang) {
409  std::unique_ptr<AdaptationSet> adaptation_set(
410  new AdaptationSet(adaptation_set_counter_.GetNext(), lang, mpd_options_,
411  &representation_counter_));
412  DCHECK(adaptation_set);
413 
414  if (!lang.empty() && lang == mpd_options_.default_language) {
415  adaptation_set->AddRole(AdaptationSet::kRoleMain);
416  }
417 
418  adaptation_sets_.push_back(std::move(adaptation_set));
419  return adaptation_sets_.back().get();
420 }
421 
423  DCHECK(output_file);
424  return WriteMpdToOutput(output_file);
425 }
426 
427 bool MpdBuilder::ToString(std::string* output) {
428  DCHECK(output);
429  return WriteMpdToOutput(output);
430 }
431 template <typename OutputType>
432 bool MpdBuilder::WriteMpdToOutput(OutputType* output) {
433  static LibXmlInitializer lib_xml_initializer;
434 
435  xml::scoped_xml_ptr<xmlDoc> doc(GenerateMpd());
436  if (!doc.get())
437  return false;
438 
439  static const int kNiceFormat = 1;
440  int doc_str_size = 0;
441  xmlChar* doc_str = NULL;
442  xmlDocDumpFormatMemoryEnc(doc.get(), &doc_str, &doc_str_size, "UTF-8",
443  kNiceFormat);
444 
445  bool result = WriteXmlCharArrayToOutput(doc_str, doc_str_size, output);
446  xmlFree(doc_str);
447 
448  // Cleanup, free the doc.
449  doc.reset();
450  return result;
451 }
452 
453 xmlDocPtr MpdBuilder::GenerateMpd() {
454  // Setup nodes.
455  static const char kXmlVersion[] = "1.0";
456  xml::scoped_xml_ptr<xmlDoc> doc(xmlNewDoc(BAD_CAST kXmlVersion));
457  XmlNode mpd("MPD");
458 
459  // Iterate thru AdaptationSets and add them to one big Period element.
460  XmlNode period("Period");
461 
462  // Always set id=0 for now. Since this class can only generate one Period
463  // at the moment, just use a constant.
464  // Required for 'dynamic' MPDs.
465  period.SetId(0);
466  for (const std::unique_ptr<AdaptationSet>& adaptation_set :
467  adaptation_sets_) {
468  xml::scoped_xml_ptr<xmlNode> child(adaptation_set->GetXml());
469  if (!child.get() || !period.AddChild(std::move(child)))
470  return NULL;
471  }
472 
473  // Add baseurls to MPD.
474  std::list<std::string>::const_iterator base_urls_it = base_urls_.begin();
475  for (; base_urls_it != base_urls_.end(); ++base_urls_it) {
476  XmlNode base_url("BaseURL");
477  base_url.SetContent(*base_urls_it);
478 
479  if (!mpd.AddChild(base_url.PassScopedPtr()))
480  return NULL;
481  }
482 
483  // TODO(kqyang): Should we set @start unconditionally to 0?
484  if (mpd_options_.mpd_type == MpdType::kDynamic) {
485  // This is the only Period and it is a regular period.
486  period.SetStringAttribute("start", "PT0S");
487  }
488 
489  if (!mpd.AddChild(period.PassScopedPtr()))
490  return NULL;
491 
492  AddMpdNameSpaceInfo(&mpd);
493 
494  static const char kOnDemandProfile[] =
495  "urn:mpeg:dash:profile:isoff-on-demand:2011";
496  static const char kLiveProfile[] =
497  "urn:mpeg:dash:profile:isoff-live:2011";
498  switch (mpd_options_.dash_profile) {
499  case DashProfile::kOnDemand:
500  mpd.SetStringAttribute("profiles", kOnDemandProfile);
501  break;
502  case DashProfile::kLive:
503  mpd.SetStringAttribute("profiles", kLiveProfile);
504  break;
505  default:
506  NOTREACHED() << "Unknown DASH profile: "
507  << static_cast<int>(mpd_options_.dash_profile);
508  break;
509  }
510 
511  AddCommonMpdInfo(&mpd);
512  switch (mpd_options_.mpd_type) {
513  case MpdType::kStatic:
514  AddStaticMpdInfo(&mpd);
515  break;
516  case MpdType::kDynamic:
517  AddDynamicMpdInfo(&mpd);
518  break;
519  default:
520  NOTREACHED() << "Unknown MPD type: "
521  << static_cast<int>(mpd_options_.mpd_type);
522  break;
523  }
524 
525  DCHECK(doc);
526  const std::string version = GetPackagerVersion();
527  if (!version.empty()) {
528  std::string version_string =
529  base::StringPrintf("Generated with %s version %s",
530  GetPackagerProjectUrl().c_str(), version.c_str());
531  xml::scoped_xml_ptr<xmlNode> comment(
532  xmlNewDocComment(doc.get(), BAD_CAST version_string.c_str()));
533  xmlDocSetRootElement(doc.get(), comment.get());
534  xmlAddSibling(comment.release(), mpd.Release());
535  } else {
536  xmlDocSetRootElement(doc.get(), mpd.Release());
537  }
538  return doc.release();
539 }
540 
541 void MpdBuilder::AddCommonMpdInfo(XmlNode* mpd_node) {
542  if (Positive(mpd_options_.min_buffer_time)) {
543  mpd_node->SetStringAttribute(
544  "minBufferTime", SecondsToXmlDuration(mpd_options_.min_buffer_time));
545  } else {
546  LOG(ERROR) << "minBufferTime value not specified.";
547  // TODO(tinskip): Propagate error.
548  }
549 }
550 
551 void MpdBuilder::AddStaticMpdInfo(XmlNode* mpd_node) {
552  DCHECK(mpd_node);
553  DCHECK_EQ(MpdType::kStatic, mpd_options_.mpd_type);
554 
555  static const char kStaticMpdType[] = "static";
556  mpd_node->SetStringAttribute("type", kStaticMpdType);
557  mpd_node->SetStringAttribute(
558  "mediaPresentationDuration",
559  SecondsToXmlDuration(GetStaticMpdDuration(mpd_node)));
560 }
561 
562 void MpdBuilder::AddDynamicMpdInfo(XmlNode* mpd_node) {
563  DCHECK(mpd_node);
564  DCHECK_EQ(MpdType::kDynamic, mpd_options_.mpd_type);
565 
566  static const char kDynamicMpdType[] = "dynamic";
567  mpd_node->SetStringAttribute("type", kDynamicMpdType);
568 
569  // No offset from NOW.
570  mpd_node->SetStringAttribute("publishTime",
571  XmlDateTimeNowWithOffset(0, clock_.get()));
572 
573  // 'availabilityStartTime' is required for dynamic profile. Calculate if
574  // not already calculated.
575  if (availability_start_time_.empty()) {
576  double earliest_presentation_time;
577  if (GetEarliestTimestamp(&earliest_presentation_time)) {
578  availability_start_time_ =
579  XmlDateTimeNowWithOffset(mpd_options_.availability_time_offset -
580  std::ceil(earliest_presentation_time),
581  clock_.get());
582  } else {
583  LOG(ERROR) << "Could not determine the earliest segment presentation "
584  "time for availabilityStartTime calculation.";
585  // TODO(tinskip). Propagate an error.
586  }
587  }
588  if (!availability_start_time_.empty())
589  mpd_node->SetStringAttribute("availabilityStartTime",
590  availability_start_time_);
591 
592  if (Positive(mpd_options_.minimum_update_period)) {
593  mpd_node->SetStringAttribute(
594  "minimumUpdatePeriod",
595  SecondsToXmlDuration(mpd_options_.minimum_update_period));
596  } else {
597  LOG(WARNING) << "The profile is dynamic but no minimumUpdatePeriod "
598  "specified.";
599  }
600 
601  SetIfPositive("timeShiftBufferDepth", mpd_options_.time_shift_buffer_depth,
602  mpd_node);
603  SetIfPositive("suggestedPresentationDelay",
604  mpd_options_.suggested_presentation_delay, mpd_node);
605 }
606 
607 float MpdBuilder::GetStaticMpdDuration(XmlNode* mpd_node) {
608  DCHECK(mpd_node);
609  DCHECK_EQ(MpdType::kStatic, mpd_options_.mpd_type);
610 
611  xmlNodePtr period_node = FindPeriodNode(mpd_node);
612  DCHECK(period_node) << "Period element must be a child of mpd_node.";
613  DCHECK(IsPeriodNode(period_node));
614 
615  // TODO(kqyang): Verify if this works for static + live profile.
616  // Attribute mediaPresentationDuration must be present for 'static' MPD. So
617  // setting "PT0S" is required even if none of the representaions have duration
618  // attribute.
619  float max_duration = 0.0f;
620  for (xmlNodePtr adaptation_set = xmlFirstElementChild(period_node);
621  adaptation_set; adaptation_set = xmlNextElementSibling(adaptation_set)) {
622  for (xmlNodePtr representation = xmlFirstElementChild(adaptation_set);
623  representation;
624  representation = xmlNextElementSibling(representation)) {
625  float duration = 0.0f;
626  if (GetDurationAttribute(representation, &duration)) {
627  max_duration = max_duration > duration ? max_duration : duration;
628 
629  // 'duration' attribute is there only to help generate MPD, not
630  // necessary for MPD, remove the attribute.
631  xmlUnsetProp(representation, BAD_CAST "duration");
632  }
633  }
634  }
635 
636  return max_duration;
637 }
638 
639 bool MpdBuilder::GetEarliestTimestamp(double* timestamp_seconds) {
640  DCHECK(timestamp_seconds);
641 
642  double earliest_timestamp(-1);
643  for (const std::unique_ptr<AdaptationSet>& adaptation_set :
644  adaptation_sets_) {
645  double timestamp;
646  if (adaptation_set->GetEarliestTimestamp(&timestamp) &&
647  ((earliest_timestamp < 0) || (timestamp < earliest_timestamp))) {
648  earliest_timestamp = timestamp;
649  }
650  }
651  if (earliest_timestamp < 0)
652  return false;
653 
654  *timestamp_seconds = earliest_timestamp;
655  return true;
656 }
657 
658 void MpdBuilder::MakePathsRelativeToMpd(const std::string& mpd_path,
659  MediaInfo* media_info) {
660  DCHECK(media_info);
661  const std::string kFileProtocol("file://");
662  std::string mpd_file_path = (mpd_path.find(kFileProtocol) == 0)
663  ? mpd_path.substr(kFileProtocol.size())
664  : mpd_path;
665 
666  if (!mpd_file_path.empty()) {
667  std::string mpd_dir(FilePath::FromUTF8Unsafe(mpd_file_path)
668  .DirName().AsEndingWithSeparator().AsUTF8Unsafe());
669  if (!mpd_dir.empty()) {
670  if (media_info->has_media_file_name()) {
671  media_info->set_media_file_name(
672  MakePathRelative(media_info->media_file_name(), mpd_dir));
673  }
674  if (media_info->has_init_segment_name()) {
675  media_info->set_init_segment_name(
676  MakePathRelative(media_info->init_segment_name(), mpd_dir));
677  }
678  if (media_info->has_segment_template()) {
679  media_info->set_segment_template(
680  MakePathRelative(media_info->segment_template(), mpd_dir));
681  }
682  }
683  }
684 }
685 
686 AdaptationSet::AdaptationSet(uint32_t adaptation_set_id,
687  const std::string& lang,
688  const MpdOptions& mpd_options,
689  base::AtomicSequenceNumber* counter)
690  : representation_counter_(counter),
691  id_(adaptation_set_id),
692  lang_(lang),
693  mpd_options_(mpd_options),
694  segments_aligned_(kSegmentAlignmentUnknown),
695  force_set_segment_alignment_(false) {
696  DCHECK(counter);
697 }
698 
699 AdaptationSet::~AdaptationSet() {}
700 
701 Representation* AdaptationSet::AddRepresentation(const MediaInfo& media_info) {
702  const uint32_t representation_id = representation_counter_->GetNext();
703  // Note that AdaptationSet outlive Representation, so this object
704  // will die before AdaptationSet.
705  std::unique_ptr<RepresentationStateChangeListener> listener(
706  new RepresentationStateChangeListenerImpl(representation_id, this));
707  std::unique_ptr<Representation> representation(new Representation(
708  media_info, mpd_options_, representation_id, std::move(listener)));
709 
710  if (!representation->Init()) {
711  LOG(ERROR) << "Failed to initialize Representation.";
712  return NULL;
713  }
714 
715  // For videos, record the width, height, and the frame rate to calculate the
716  // max {width,height,framerate} required for DASH IOP.
717  if (media_info.has_video_info()) {
718  const MediaInfo::VideoInfo& video_info = media_info.video_info();
719  DCHECK(video_info.has_width());
720  DCHECK(video_info.has_height());
721  video_widths_.insert(video_info.width());
722  video_heights_.insert(video_info.height());
723 
724  if (video_info.has_time_scale() && video_info.has_frame_duration())
725  RecordFrameRate(video_info.frame_duration(), video_info.time_scale());
726 
727  AddPictureAspectRatio(video_info, &picture_aspect_ratio_);
728  }
729 
730  if (media_info.has_video_info()) {
731  content_type_ = "video";
732  } else if (media_info.has_audio_info()) {
733  content_type_ = "audio";
734  } else if (media_info.has_text_info()) {
735  content_type_ = "text";
736 
737  if (media_info.text_info().has_type() &&
738  (media_info.text_info().type() != MediaInfo::TextInfo::UNKNOWN)) {
739  roles_.insert(MediaInfoTextTypeToRole(media_info.text_info().type()));
740  }
741  }
742 
743  representations_.push_back(std::move(representation));
744  return representations_.back().get();
745 }
746 
748  const ContentProtectionElement& content_protection_element) {
749  content_protection_elements_.push_back(content_protection_element);
750  RemoveDuplicateAttributes(&content_protection_elements_.back());
751 }
752 
753 void AdaptationSet::UpdateContentProtectionPssh(const std::string& drm_uuid,
754  const std::string& pssh) {
755  UpdateContentProtectionPsshHelper(drm_uuid, pssh,
756  &content_protection_elements_);
757 }
758 
759 void AdaptationSet::AddRole(Role role) {
760  roles_.insert(role);
761 }
762 
763 // Creates a copy of <AdaptationSet> xml element, iterate thru all the
764 // <Representation> (child) elements and add them to the copy.
765 // Set all the attributes first and then add the children elements so that flags
766 // can be passed to Representation to avoid setting redundant attributes. For
767 // example, if AdaptationSet@width is set, then Representation@width is
768 // redundant and should not be set.
769 xml::scoped_xml_ptr<xmlNode> AdaptationSet::GetXml() {
770  AdaptationSetXmlNode adaptation_set;
771 
772  bool suppress_representation_width = false;
773  bool suppress_representation_height = false;
774  bool suppress_representation_frame_rate = false;
775 
776  adaptation_set.SetId(id_);
777  adaptation_set.SetStringAttribute("contentType", content_type_);
778  if (!lang_.empty() && lang_ != "und") {
779  adaptation_set.SetStringAttribute("lang", LanguageToShortestForm(lang_));
780  }
781 
782  // Note that std::{set,map} are ordered, so the last element is the max value.
783  if (video_widths_.size() == 1) {
784  suppress_representation_width = true;
785  adaptation_set.SetIntegerAttribute("width", *video_widths_.begin());
786  } else if (video_widths_.size() > 1) {
787  adaptation_set.SetIntegerAttribute("maxWidth", *video_widths_.rbegin());
788  }
789  if (video_heights_.size() == 1) {
790  suppress_representation_height = true;
791  adaptation_set.SetIntegerAttribute("height", *video_heights_.begin());
792  } else if (video_heights_.size() > 1) {
793  adaptation_set.SetIntegerAttribute("maxHeight", *video_heights_.rbegin());
794  }
795 
796  if (video_frame_rates_.size() == 1) {
797  suppress_representation_frame_rate = true;
798  adaptation_set.SetStringAttribute("frameRate",
799  video_frame_rates_.begin()->second);
800  } else if (video_frame_rates_.size() > 1) {
801  adaptation_set.SetStringAttribute("maxFrameRate",
802  video_frame_rates_.rbegin()->second);
803  }
804 
805  // Note: must be checked before checking segments_aligned_ (below). So that
806  // segments_aligned_ is set before checking below.
807  if (mpd_options_.dash_profile == DashProfile::kOnDemand) {
808  CheckVodSegmentAlignment();
809  }
810 
811  if (segments_aligned_ == kSegmentAlignmentTrue) {
812  adaptation_set.SetStringAttribute(
813  mpd_options_.dash_profile == DashProfile::kOnDemand
814  ? "subsegmentAlignment"
815  : "segmentAlignment",
816  "true");
817  }
818 
819  if (picture_aspect_ratio_.size() == 1)
820  adaptation_set.SetStringAttribute("par", *picture_aspect_ratio_.begin());
821 
822  if (!adaptation_set.AddContentProtectionElements(
823  content_protection_elements_)) {
824  return xml::scoped_xml_ptr<xmlNode>();
825  }
826 
827  std::string switching_ids;
828  for (uint32_t id : adaptation_set_switching_ids_) {
829  if (!switching_ids.empty())
830  switching_ids += ',';
831  switching_ids += base::UintToString(id);
832  }
833  if (!switching_ids.empty()) {
834  adaptation_set.AddSupplementalProperty(
835  "urn:mpeg:dash:adaptation-set-switching:2016", switching_ids);
836  }
837 
838  for (AdaptationSet::Role role : roles_)
839  adaptation_set.AddRoleElement("urn:mpeg:dash:role:2011", RoleToText(role));
840 
841  for (const std::unique_ptr<Representation>& representation :
842  representations_) {
843  if (suppress_representation_width)
844  representation->SuppressOnce(Representation::kSuppressWidth);
845  if (suppress_representation_height)
846  representation->SuppressOnce(Representation::kSuppressHeight);
847  if (suppress_representation_frame_rate)
848  representation->SuppressOnce(Representation::kSuppressFrameRate);
849  xml::scoped_xml_ptr<xmlNode> child(representation->GetXml());
850  if (!child || !adaptation_set.AddChild(std::move(child)))
851  return xml::scoped_xml_ptr<xmlNode>();
852  }
853 
854  return adaptation_set.PassScopedPtr();
855 }
856 
857 void AdaptationSet::ForceSetSegmentAlignment(bool segment_alignment) {
858  segments_aligned_ =
859  segment_alignment ? kSegmentAlignmentTrue : kSegmentAlignmentFalse;
860  force_set_segment_alignment_ = true;
861 }
862 
863 void AdaptationSet::AddAdaptationSetSwitching(uint32_t adaptation_set_id) {
864  adaptation_set_switching_ids_.push_back(adaptation_set_id);
865 }
866 
867 // Check segmentAlignment for Live here. Storing all start_time and duration
868 // will out-of-memory because there's no way of knowing when it will end.
869 // VOD subsegmentAlignment check is *not* done here because it is possible
870 // that some Representations might not have been added yet (e.g. a thread is
871 // assigned per muxer so one might run faster than others).
872 // To be clear, for Live, all Representations should be added before a
873 // segment is added.
874 void AdaptationSet::OnNewSegmentForRepresentation(uint32_t representation_id,
875  uint64_t start_time,
876  uint64_t duration) {
877  if (mpd_options_.dash_profile == DashProfile::kLive) {
878  CheckLiveSegmentAlignment(representation_id, start_time, duration);
879  } else {
880  representation_segment_start_times_[representation_id].push_back(
881  start_time);
882  }
883 }
884 
886  uint32_t representation_id,
887  uint32_t frame_duration,
888  uint32_t timescale) {
889  RecordFrameRate(frame_duration, timescale);
890 }
891 
892 bool AdaptationSet::GetEarliestTimestamp(double* timestamp_seconds) {
893  DCHECK(timestamp_seconds);
894 
895  double earliest_timestamp(-1);
896  for (const std::unique_ptr<Representation>& representation :
897  representations_) {
898  double timestamp;
899  if (representation->GetEarliestTimestamp(&timestamp) &&
900  ((earliest_timestamp < 0) || (timestamp < earliest_timestamp))) {
901  earliest_timestamp = timestamp;
902  }
903  }
904  if (earliest_timestamp < 0)
905  return false;
906 
907  *timestamp_seconds = earliest_timestamp;
908  return true;
909 }
910 
911 // This implementation assumes that each representations' segments' are
912 // contiguous.
913 // Also assumes that all Representations are added before this is called.
914 // This checks whether the first elements of the lists in
915 // representation_segment_start_times_ are aligned.
916 // For example, suppose this method was just called with args rep_id=2
917 // start_time=1.
918 // 1 -> [1, 100, 200]
919 // 2 -> [1]
920 // The timestamps of the first elements match, so this flags
921 // segments_aligned_=true.
922 // Also since the first segment start times match, the first element of all the
923 // lists are removed, so the map of lists becomes:
924 // 1 -> [100, 200]
925 // 2 -> []
926 // Note that there could be false positives.
927 // e.g. just got rep_id=3 start_time=1 duration=300, and the duration of the
928 // whole AdaptationSet is 300.
929 // 1 -> [1, 100, 200]
930 // 2 -> [1, 90, 100]
931 // 3 -> [1]
932 // They are not aligned but this will be marked as aligned.
933 // But since this is unlikely to happen in the packager (and to save
934 // computation), this isn't handled at the moment.
935 void AdaptationSet::CheckLiveSegmentAlignment(uint32_t representation_id,
936  uint64_t start_time,
937  uint64_t /* duration */) {
938  if (segments_aligned_ == kSegmentAlignmentFalse ||
939  force_set_segment_alignment_) {
940  return;
941  }
942 
943  std::list<uint64_t>& representation_start_times =
944  representation_segment_start_times_[representation_id];
945  representation_start_times.push_back(start_time);
946  // There's no way to detemine whether the segments are aligned if some
947  // representations do not have any segments.
948  if (representation_segment_start_times_.size() != representations_.size())
949  return;
950 
951  DCHECK(!representation_start_times.empty());
952  const uint64_t expected_start_time = representation_start_times.front();
953  for (RepresentationTimeline::const_iterator it =
954  representation_segment_start_times_.begin();
955  it != representation_segment_start_times_.end(); ++it) {
956  // If there are no entries in a list, then there is no way for the
957  // segment alignment status to change.
958  // Note that it can be empty because entries get deleted below.
959  if (it->second.empty())
960  return;
961 
962  if (expected_start_time != it->second.front()) {
963  // Flag as false and clear the start times data, no need to keep it
964  // around.
965  segments_aligned_ = kSegmentAlignmentFalse;
966  representation_segment_start_times_.clear();
967  return;
968  }
969  }
970  segments_aligned_ = kSegmentAlignmentTrue;
971 
972  for (RepresentationTimeline::iterator it =
973  representation_segment_start_times_.begin();
974  it != representation_segment_start_times_.end(); ++it) {
975  it->second.pop_front();
976  }
977 }
978 
979 // Make sure all segements start times match for all Representations.
980 // This assumes that the segments are contiguous.
981 void AdaptationSet::CheckVodSegmentAlignment() {
982  if (segments_aligned_ == kSegmentAlignmentFalse ||
983  force_set_segment_alignment_) {
984  return;
985  }
986  if (representation_segment_start_times_.empty())
987  return;
988  if (representation_segment_start_times_.size() == 1) {
989  segments_aligned_ = kSegmentAlignmentTrue;
990  return;
991  }
992 
993  // This is not the most efficient implementation to compare the values
994  // because expected_time_line is compared against all other time lines, but
995  // probably the most readable.
996  const std::list<uint64_t>& expected_time_line =
997  representation_segment_start_times_.begin()->second;
998 
999  bool all_segment_time_line_same_length = true;
1000  // Note that the first entry is skipped because it is expected_time_line.
1001  RepresentationTimeline::const_iterator it =
1002  representation_segment_start_times_.begin();
1003  for (++it; it != representation_segment_start_times_.end(); ++it) {
1004  const std::list<uint64_t>& other_time_line = it->second;
1005  if (expected_time_line.size() != other_time_line.size()) {
1006  all_segment_time_line_same_length = false;
1007  }
1008 
1009  const std::list<uint64_t>* longer_list = &other_time_line;
1010  const std::list<uint64_t>* shorter_list = &expected_time_line;
1011  if (expected_time_line.size() > other_time_line.size()) {
1012  shorter_list = &other_time_line;
1013  longer_list = &expected_time_line;
1014  }
1015 
1016  if (!std::equal(shorter_list->begin(), shorter_list->end(),
1017  longer_list->begin())) {
1018  // Some segments are definitely unaligned.
1019  segments_aligned_ = kSegmentAlignmentFalse;
1020  representation_segment_start_times_.clear();
1021  return;
1022  }
1023  }
1024 
1025  // TODO(rkuroiwa): The right way to do this is to also check the durations.
1026  // For example:
1027  // (a) 3 4 5
1028  // (b) 3 4 5 6
1029  // could be true or false depending on the length of the third segment of (a).
1030  // i.e. if length of the third segment is 2, then this is not aligned.
1031  if (!all_segment_time_line_same_length) {
1032  segments_aligned_ = kSegmentAlignmentUnknown;
1033  return;
1034  }
1035 
1036  segments_aligned_ = kSegmentAlignmentTrue;
1037 }
1038 
1039 // Since all AdaptationSet cares about is the maxFrameRate, representation_id
1040 // is not passed to this method.
1041 void AdaptationSet::RecordFrameRate(uint32_t frame_duration,
1042  uint32_t timescale) {
1043  if (frame_duration == 0) {
1044  LOG(ERROR) << "Frame duration is 0 and cannot be set.";
1045  return;
1046  }
1047  video_frame_rates_[static_cast<double>(timescale) / frame_duration] =
1048  base::IntToString(timescale) + "/" + base::IntToString(frame_duration);
1049 }
1050 
1052  const MediaInfo& media_info,
1053  const MpdOptions& mpd_options,
1054  uint32_t id,
1055  std::unique_ptr<RepresentationStateChangeListener> state_change_listener)
1056  : media_info_(media_info),
1057  id_(id),
1058  bandwidth_estimator_(BandwidthEstimator::kUseAllBlocks),
1059  mpd_options_(mpd_options),
1060  start_number_(1),
1061  state_change_listener_(std::move(state_change_listener)),
1062  output_suppression_flags_(0) {}
1063 
1064 Representation::~Representation() {}
1065 
1067  if (!AtLeastOneTrue(media_info_.has_video_info(),
1068  media_info_.has_audio_info(),
1069  media_info_.has_text_info())) {
1070  // This is an error. Segment information can be in AdaptationSet, Period, or
1071  // MPD but the interface does not provide a way to set them.
1072  // See 5.3.9.1 ISO 23009-1:2012 for segment info.
1073  LOG(ERROR) << "Representation needs one of video, audio, or text.";
1074  return false;
1075  }
1076 
1077  if (MoreThanOneTrue(media_info_.has_video_info(),
1078  media_info_.has_audio_info(),
1079  media_info_.has_text_info())) {
1080  LOG(ERROR) << "Only one of VideoInfo, AudioInfo, or TextInfo can be set.";
1081  return false;
1082  }
1083 
1084  if (media_info_.container_type() == MediaInfo::CONTAINER_UNKNOWN) {
1085  LOG(ERROR) << "'container_type' in MediaInfo cannot be CONTAINER_UNKNOWN.";
1086  return false;
1087  }
1088 
1089  if (media_info_.has_video_info()) {
1090  mime_type_ = GetVideoMimeType();
1091  if (!HasRequiredVideoFields(media_info_.video_info())) {
1092  LOG(ERROR) << "Missing required fields to create a video Representation.";
1093  return false;
1094  }
1095  } else if (media_info_.has_audio_info()) {
1096  mime_type_ = GetAudioMimeType();
1097  } else if (media_info_.has_text_info()) {
1098  mime_type_ = GetTextMimeType();
1099  }
1100 
1101  if (mime_type_.empty())
1102  return false;
1103 
1104  codecs_ = GetCodecs(media_info_);
1105  return true;
1106 }
1107 
1109  const ContentProtectionElement& content_protection_element) {
1110  content_protection_elements_.push_back(content_protection_element);
1111  RemoveDuplicateAttributes(&content_protection_elements_.back());
1112 }
1113 
1114 void Representation::UpdateContentProtectionPssh(const std::string& drm_uuid,
1115  const std::string& pssh) {
1116  UpdateContentProtectionPsshHelper(drm_uuid, pssh,
1117  &content_protection_elements_);
1118 }
1119 
1120 void Representation::AddNewSegment(uint64_t start_time,
1121  uint64_t duration,
1122  uint64_t size) {
1123  if (start_time == 0 && duration == 0) {
1124  LOG(WARNING) << "Got segment with start_time and duration == 0. Ignoring.";
1125  return;
1126  }
1127 
1128  if (state_change_listener_)
1129  state_change_listener_->OnNewSegmentForRepresentation(start_time, duration);
1130  if (IsContiguous(start_time, duration, size)) {
1131  ++segment_infos_.back().repeat;
1132  } else {
1133  SegmentInfo s = {start_time, duration, /* Not repeat. */ 0};
1134  segment_infos_.push_back(s);
1135  }
1136 
1137  bandwidth_estimator_.AddBlock(
1138  size, static_cast<double>(duration) / media_info_.reference_time_scale());
1139 
1140  SlideWindow();
1141  DCHECK_GE(segment_infos_.size(), 1u);
1142 }
1143 
1144 void Representation::SetSampleDuration(uint32_t sample_duration) {
1145  if (media_info_.has_video_info()) {
1146  media_info_.mutable_video_info()->set_frame_duration(sample_duration);
1147  if (state_change_listener_) {
1148  state_change_listener_->OnSetFrameRateForRepresentation(
1149  sample_duration, media_info_.video_info().time_scale());
1150  }
1151  }
1152 }
1153 
1154 // Uses info in |media_info_| and |content_protection_elements_| to create a
1155 // "Representation" node.
1156 // MPD schema has strict ordering. The following must be done in order.
1157 // AddVideoInfo() (possibly adds FramePacking elements), AddAudioInfo() (Adds
1158 // AudioChannelConfig elements), AddContentProtectionElements*(), and
1159 // AddVODOnlyInfo() (Adds segment info).
1160 xml::scoped_xml_ptr<xmlNode> Representation::GetXml() {
1161  if (!HasRequiredMediaInfoFields()) {
1162  LOG(ERROR) << "MediaInfo missing required fields.";
1163  return xml::scoped_xml_ptr<xmlNode>();
1164  }
1165 
1166  const uint64_t bandwidth = media_info_.has_bandwidth()
1167  ? media_info_.bandwidth()
1168  : bandwidth_estimator_.Estimate();
1169 
1170  DCHECK(!(HasVODOnlyFields(media_info_) && HasLiveOnlyFields(media_info_)));
1171 
1172  RepresentationXmlNode representation;
1173  // Mandatory fields for Representation.
1174  representation.SetId(id_);
1175  representation.SetIntegerAttribute("bandwidth", bandwidth);
1176  if (!codecs_.empty())
1177  representation.SetStringAttribute("codecs", codecs_);
1178  representation.SetStringAttribute("mimeType", mime_type_);
1179 
1180  const bool has_video_info = media_info_.has_video_info();
1181  const bool has_audio_info = media_info_.has_audio_info();
1182 
1183  if (has_video_info &&
1184  !representation.AddVideoInfo(
1185  media_info_.video_info(),
1186  !(output_suppression_flags_ & kSuppressWidth),
1187  !(output_suppression_flags_ & kSuppressHeight),
1188  !(output_suppression_flags_ & kSuppressFrameRate))) {
1189  LOG(ERROR) << "Failed to add video info to Representation XML.";
1190  return xml::scoped_xml_ptr<xmlNode>();
1191  }
1192 
1193  if (has_audio_info &&
1194  !representation.AddAudioInfo(media_info_.audio_info())) {
1195  LOG(ERROR) << "Failed to add audio info to Representation XML.";
1196  return xml::scoped_xml_ptr<xmlNode>();
1197  }
1198 
1199  if (!representation.AddContentProtectionElements(
1200  content_protection_elements_)) {
1201  return xml::scoped_xml_ptr<xmlNode>();
1202  }
1203 
1204  // Set media duration for static mpd.
1205  if (mpd_options_.mpd_type == MpdType::kStatic &&
1206  media_info_.has_media_duration_seconds()) {
1207  // Adding 'duration' attribute, so that this information can be used when
1208  // generating one MPD file. This should be removed from the final MPD.
1209  representation.SetFloatingPointAttribute(
1210  "duration", media_info_.media_duration_seconds());
1211  }
1212 
1213  if (HasVODOnlyFields(media_info_) &&
1214  !representation.AddVODOnlyInfo(media_info_)) {
1215  LOG(ERROR) << "Failed to add VOD segment info.";
1216  return xml::scoped_xml_ptr<xmlNode>();
1217  }
1218 
1219  if (HasLiveOnlyFields(media_info_) &&
1220  !representation.AddLiveOnlyInfo(media_info_, segment_infos_,
1221  start_number_)) {
1222  LOG(ERROR) << "Failed to add Live info.";
1223  return xml::scoped_xml_ptr<xmlNode>();
1224  }
1225  // TODO(rkuroiwa): It is likely that all representations have the exact same
1226  // SegmentTemplate. Optimize and propagate the tag up to AdaptationSet level.
1227 
1228  output_suppression_flags_ = 0;
1229  return representation.PassScopedPtr();
1230 }
1231 
1232 void Representation::SuppressOnce(SuppressFlag flag) {
1233  output_suppression_flags_ |= flag;
1234 }
1235 
1236 bool Representation::HasRequiredMediaInfoFields() {
1237  if (HasVODOnlyFields(media_info_) && HasLiveOnlyFields(media_info_)) {
1238  LOG(ERROR) << "MediaInfo cannot have both VOD and Live fields.";
1239  return false;
1240  }
1241 
1242  if (!media_info_.has_container_type()) {
1243  LOG(ERROR) << "MediaInfo missing required field: container_type.";
1244  return false;
1245  }
1246 
1247  if (HasVODOnlyFields(media_info_) && !media_info_.has_bandwidth()) {
1248  LOG(ERROR) << "Missing 'bandwidth' field. MediaInfo requires bandwidth for "
1249  "static profile for generating a valid MPD.";
1250  return false;
1251  }
1252 
1253  VLOG_IF(3, HasLiveOnlyFields(media_info_) && !media_info_.has_bandwidth())
1254  << "MediaInfo missing field 'bandwidth'. Using estimated from "
1255  "segment size.";
1256 
1257  return true;
1258 }
1259 
1260 bool Representation::IsContiguous(uint64_t start_time,
1261  uint64_t duration,
1262  uint64_t size) const {
1263  if (segment_infos_.empty())
1264  return false;
1265 
1266  // Contiguous segment.
1267  const SegmentInfo& previous = segment_infos_.back();
1268  const uint64_t previous_segment_end_time =
1269  previous.start_time + previous.duration * (previous.repeat + 1);
1270  if (previous_segment_end_time == start_time &&
1271  segment_infos_.back().duration == duration) {
1272  return true;
1273  }
1274 
1275  // No out of order segments.
1276  const uint64_t previous_segment_start_time =
1277  previous.start_time + previous.duration * previous.repeat;
1278  if (previous_segment_start_time >= start_time) {
1279  LOG(ERROR) << "Segments should not be out of order segment. Adding segment "
1280  "with start_time == "
1281  << start_time << " but the previous segment starts at "
1282  << previous.start_time << ".";
1283  return false;
1284  }
1285 
1286  // A gap since previous.
1287  const uint64_t kRoundingErrorGrace = 5;
1288  if (previous_segment_end_time + kRoundingErrorGrace < start_time) {
1289  LOG(WARNING) << "Found a gap of size "
1290  << (start_time - previous_segment_end_time)
1291  << " > kRoundingErrorGrace (" << kRoundingErrorGrace
1292  << "). The new segment starts at " << start_time
1293  << " but the previous segment ends at "
1294  << previous_segment_end_time << ".";
1295  return false;
1296  }
1297 
1298  // No overlapping segments.
1299  if (start_time < previous_segment_end_time - kRoundingErrorGrace) {
1300  LOG(WARNING)
1301  << "Segments should not be overlapping. The new segment starts at "
1302  << start_time << " but the previous segment ends at "
1303  << previous_segment_end_time << ".";
1304  return false;
1305  }
1306 
1307  // Within rounding error grace but technically not contiguous in terms of MPD.
1308  return false;
1309 }
1310 
1311 void Representation::SlideWindow() {
1312  DCHECK(!segment_infos_.empty());
1313  if (mpd_options_.time_shift_buffer_depth <= 0.0 ||
1314  mpd_options_.mpd_type == MpdType::kStatic)
1315  return;
1316 
1317  const uint32_t time_scale = GetTimeScale(media_info_);
1318  DCHECK_GT(time_scale, 0u);
1319 
1320  uint64_t time_shift_buffer_depth =
1321  static_cast<uint64_t>(mpd_options_.time_shift_buffer_depth * time_scale);
1322 
1323  // The start time of the latest segment is considered the current_play_time,
1324  // and this should guarantee that the latest segment will stay in the list.
1325  const uint64_t current_play_time = LatestSegmentStartTime(segment_infos_);
1326  if (current_play_time <= time_shift_buffer_depth)
1327  return;
1328 
1329  const uint64_t timeshift_limit = current_play_time - time_shift_buffer_depth;
1330 
1331  // First remove all the SegmentInfos that are completely out of range, by
1332  // looking at the very last segment's end time.
1333  std::list<SegmentInfo>::iterator first = segment_infos_.begin();
1334  std::list<SegmentInfo>::iterator last = first;
1335  size_t num_segments_removed = 0;
1336  for (; last != segment_infos_.end(); ++last) {
1337  const uint64_t last_segment_end_time = LastSegmentEndTime(*last);
1338  if (timeshift_limit < last_segment_end_time)
1339  break;
1340  num_segments_removed += last->repeat + 1;
1341  }
1342  segment_infos_.erase(first, last);
1343  start_number_ += num_segments_removed;
1344 
1345  // Now some segment in the first SegmentInfo should be left in the list.
1346  SegmentInfo* first_segment_info = &segment_infos_.front();
1347  DCHECK_LE(timeshift_limit, LastSegmentEndTime(*first_segment_info));
1348 
1349  // Identify which segments should still be in the SegmentInfo.
1350  const int repeat_index =
1351  SearchTimedOutRepeatIndex(timeshift_limit, *first_segment_info);
1352  CHECK_GE(repeat_index, 0);
1353  if (repeat_index == 0)
1354  return;
1355 
1356  first_segment_info->start_time = first_segment_info->start_time +
1357  first_segment_info->duration * repeat_index;
1358 
1359  first_segment_info->repeat = first_segment_info->repeat - repeat_index;
1360  start_number_ += repeat_index;
1361 }
1362 
1363 std::string Representation::GetVideoMimeType() const {
1364  return GetMimeType("video", media_info_.container_type());
1365 }
1366 
1367 std::string Representation::GetAudioMimeType() const {
1368  return GetMimeType("audio", media_info_.container_type());
1369 }
1370 
1371 std::string Representation::GetTextMimeType() const {
1372  CHECK(media_info_.has_text_info());
1373  if (media_info_.text_info().format() == "ttml") {
1374  switch (media_info_.container_type()) {
1375  case MediaInfo::CONTAINER_TEXT:
1376  return "application/ttml+xml";
1377  case MediaInfo::CONTAINER_MP4:
1378  return "application/mp4";
1379  default:
1380  LOG(ERROR) << "Failed to determine MIME type for TTML container: "
1381  << media_info_.container_type();
1382  return "";
1383  }
1384  }
1385  if (media_info_.text_info().format() == "vtt") {
1386  if (media_info_.container_type() == MediaInfo::CONTAINER_TEXT) {
1387  return "text/vtt";
1388  } else if (media_info_.container_type() == MediaInfo::CONTAINER_MP4) {
1389  return "application/mp4";
1390  }
1391  LOG(ERROR) << "Failed to determine MIME type for VTT container: "
1392  << media_info_.container_type();
1393  return "";
1394  }
1395 
1396  LOG(ERROR) << "Cannot determine MIME type for format: "
1397  << media_info_.text_info().format()
1398  << " container: " << media_info_.container_type();
1399  return "";
1400 }
1401 
1402 bool Representation::GetEarliestTimestamp(double* timestamp_seconds) {
1403  DCHECK(timestamp_seconds);
1404 
1405  if (segment_infos_.empty())
1406  return false;
1407 
1408  *timestamp_seconds = static_cast<double>(segment_infos_.begin()->start_time) /
1409  GetTimeScale(media_info_);
1410  return true;
1411 }
1412 
1413 } // namespace shaka
void OnSetFrameRateForRepresentation(uint32_t representation_id, uint32_t frame_duration, uint32_t timescale)
Definition: mpd_builder.cc:885
virtual void AddNewSegment(uint64_t start_time, uint64_t duration, uint64_t size)
bool WriteMpdToFile(media::File *output_file)
Definition: mpd_builder.cc:422
Representation(const MediaInfo &media_info, const MpdOptions &mpd_options, uint32_t representation_id, std::unique_ptr< RepresentationStateChangeListener > state_change_listener)
virtual void SetSampleDuration(uint32_t sample_duration)
virtual Representation * AddRepresentation(const MediaInfo &media_info)
Definition: mpd_builder.cc:701
std::string LanguageToShortestForm(const std::string &language)
Define an abstract file interface.
Definition: file.h:24
virtual void AddContentProtectionElement(const ContentProtectionElement &element)
Definition: mpd_builder.cc:747
MpdBuilder(const MpdOptions &mpd_options)
Definition: mpd_builder.cc:399
virtual void AddRole(Role role)
Definition: mpd_builder.cc:759
void AddBaseUrl(const std::string &base_url)
Definition: mpd_builder.cc:404
virtual void UpdateContentProtectionPssh(const std::string &drm_uuid, const std::string &pssh)
Definition: mpd_builder.cc:753
AdaptationSet(uint32_t adaptation_set_id, const std::string &lang, const MpdOptions &mpd_options, base::AtomicSequenceNumber *representation_counter)
Definition: mpd_builder.cc:686
xml::scoped_xml_ptr< xmlNode > GetXml()
virtual bool ToString(std::string *output)
Definition: mpd_builder.cc:427
void AddAdaptationSetSwitching(uint32_t adaptation_set_id)
Definition: mpd_builder.cc:863
virtual void ForceSetSegmentAlignment(bool segment_alignment)
Definition: mpd_builder.cc:857
static void MakePathsRelativeToMpd(const std::string &mpd_path, MediaInfo *media_info)
Definition: mpd_builder.cc:658
xml::scoped_xml_ptr< xmlNode > GetXml()
Definition: mpd_builder.cc:769
virtual void AddContentProtectionElement(const ContentProtectionElement &element)
virtual AdaptationSet * AddAdaptationSet(const std::string &lang)
Definition: mpd_builder.cc:408
Defines Mpd Options.
Definition: mpd_options.h:23
void OnNewSegmentForRepresentation(uint32_t representation_id, uint64_t start_time, uint64_t duration)
Definition: mpd_builder.cc:874
virtual void UpdateContentProtectionPssh(const std::string &drm_uuid, const std::string &pssh)
void SuppressOnce(SuppressFlag flag)