xml_node.h

// Copyright 2014 Google Inc. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file or at
// https://developers.google.com/open-source/licenses/bsd
//
// Classes to wrap XML operations. XmlNode is a generic wrapper class for
// XmlNode in libxml2. There are also MPD XML specific classes as well.
 
#ifndef MPD_BASE_XML_XML_NODE_H_
#define MPD_BASE_XML_XML_NODE_H_
 
#include <stdint.h>
 
#include <list>
#include <set>
#include <string>
#include <vector>
 
#include "packager/base/compiler_specific.h"
#include "packager/base/macros.h"
#include "packager/mpd/base/content_protection_element.h"
#include "packager/mpd/base/media_info.pb.h"
 
typedef struct _xmlNode xmlNode;
 
namespace shaka {
 
class MpdBuilder;
struct SegmentInfo;
 
namespace xml {
class XmlNode;
}  // namespace xml
 
// Defined in tests under mpd/test/xml_compare.h
bool XmlEqual(const std::string& xml1, const xml::XmlNode& xml2);
 
namespace xml {
 
class XmlNode {
 public:
  explicit XmlNode(const std::string& name);
  XmlNode(XmlNode&&);
  virtual ~XmlNode();
 
  XmlNode& operator=(XmlNode&&);
 
  bool AddChild(XmlNode child) WARN_UNUSED_RESULT;
 
  bool AddElements(const std::vector<Element>& elements) WARN_UNUSED_RESULT;
 
  bool SetStringAttribute(const std::string& attribute_name,
                          const std::string& attribute) WARN_UNUSED_RESULT;
 
  bool SetIntegerAttribute(const std::string& attribute_name,
                           uint64_t number) WARN_UNUSED_RESULT;
 
  bool SetFloatingPointAttribute(const std::string& attribute_name,
                                 double number) WARN_UNUSED_RESULT;
 
  bool SetId(uint32_t id) WARN_UNUSED_RESULT;
 
  void AddContent(const std::string& content);
 
  void SetContent(const std::string& content);
 
  std::set<std::string> ExtractReferencedNamespaces() const;
 
  std::string ToString(const std::string& comment) const;
 
  bool GetAttribute(const std::string& name, std::string* value) const;
 
 private:
  friend bool shaka::XmlEqual(const std::string& xml1,
                              const xml::XmlNode& xml2);
  xmlNode* GetRawPtr() const;
 
  // Don't use xmlNode directly so we don't have to forward-declare a bunch of
  // libxml types to define the scoped_xml_ptr type.  This allows us to only
  // include libxml headers in a few source files.
  class Impl;
  std::unique_ptr<Impl> impl_;
 
  DISALLOW_COPY_AND_ASSIGN(XmlNode);
};
 
class RepresentationBaseXmlNode : public XmlNode {
 public:
  ~RepresentationBaseXmlNode() override;
  bool AddContentProtectionElements(
      const std::list<ContentProtectionElement>& content_protection_elements)
      WARN_UNUSED_RESULT;
 
  bool AddSupplementalProperty(const std::string& scheme_id_uri,
                               const std::string& value) WARN_UNUSED_RESULT;
 
  bool AddEssentialProperty(const std::string& scheme_id_uri,
                            const std::string& value) WARN_UNUSED_RESULT;
 
 protected:
  explicit RepresentationBaseXmlNode(const std::string& name);
 
  bool AddDescriptor(const std::string& descriptor_name,
                     const std::string& scheme_id_uri,
                     const std::string& value) WARN_UNUSED_RESULT;
 
 private:
  bool AddContentProtectionElement(
      const ContentProtectionElement& content_protection_element)
      WARN_UNUSED_RESULT;
 
  DISALLOW_COPY_AND_ASSIGN(RepresentationBaseXmlNode);
};
 
class AdaptationSetXmlNode : public RepresentationBaseXmlNode {
 public:
  AdaptationSetXmlNode();
  ~AdaptationSetXmlNode() override;
 
  bool AddAccessibilityElement(const std::string& scheme_id_uri,
                               const std::string& value) WARN_UNUSED_RESULT;
 
  bool AddRoleElement(const std::string& scheme_id_uri,
                      const std::string& value) WARN_UNUSED_RESULT;
 
 private:
  DISALLOW_COPY_AND_ASSIGN(AdaptationSetXmlNode);
};
 
class RepresentationXmlNode : public RepresentationBaseXmlNode {
 public:
  RepresentationXmlNode();
  ~RepresentationXmlNode() override;
 
  bool AddVideoInfo(const MediaInfo::VideoInfo& video_info,
                    bool set_width,
                    bool set_height,
                    bool set_frame_rate) WARN_UNUSED_RESULT;
 
  bool AddAudioInfo(const MediaInfo::AudioInfo& audio_info) WARN_UNUSED_RESULT;
 
  //         duration of media segments. This is only used when use_segment_list
  //         is true.
  bool AddVODOnlyInfo(const MediaInfo& media_info,
                      bool use_segment_list,
                      double target_segment_duration) WARN_UNUSED_RESULT;
 
  bool AddLiveOnlyInfo(const MediaInfo& media_info,
                       const std::list<SegmentInfo>& segment_infos,
                       uint32_t start_number) WARN_UNUSED_RESULT;
 
 private:
  // Add AudioChannelConfiguration element. Note that it is a required element
  // for audio Representations.
  bool AddAudioChannelInfo(const MediaInfo::AudioInfo& audio_info)
      WARN_UNUSED_RESULT;
 
  // Add audioSamplingRate attribute to this element, if present.
  bool AddAudioSamplingRateInfo(const MediaInfo::AudioInfo& audio_info)
      WARN_UNUSED_RESULT;
 
  DISALLOW_COPY_AND_ASSIGN(RepresentationXmlNode);
};
 
}  // namespace xml
}  // namespace shaka
#endif  // MPD_BASE_XML_XML_NODE_H_