segmenter.h

// Copyright 2014 Google LLC. 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
 
#ifndef PACKAGER_MEDIA_FORMATS_MP4_SEGMENTER_H_
#define PACKAGER_MEDIA_FORMATS_MP4_SEGMENTER_H_
 
#include <cstdint>
#include <map>
#include <memory>
#include <optional>
#include <vector>
 
#include <packager/macros/classes.h>
#include <packager/media/base/encryption_config.h>
#include <packager/media/base/fourccs.h>
#include <packager/media/base/range.h>
#include <packager/media/formats/mp4/box_definitions.h>
#include <packager/status.h>
 
namespace shaka {
namespace media {
 
struct MuxerOptions;
struct SegmentInfo;
 
class BufferWriter;
class MediaSample;
class MuxerListener;
class ProgressListener;
class StreamInfo;
 
namespace mp4 {
 
class Fragmenter;
struct KeyFrameInfo;
 
class Segmenter {
 public:
  Segmenter(const MuxerOptions& options,
            std::unique_ptr<FileType> ftyp,
            std::unique_ptr<Movie> moov);
  virtual ~Segmenter();
 
  Status Initialize(
      const std::vector<std::shared_ptr<const StreamInfo>>& streams,
      MuxerListener* muxer_listener,
      ProgressListener* progress_listener);
 
  Status Finalize();
 
  Status AddSample(size_t stream_id, const MediaSample& sample);
 
  Status FinalizeSegment(size_t stream_id, const SegmentInfo& segment_info);
 
  // TODO(rkuroiwa): Change these Get*Range() methods to return
  // std::optional<Range> as well.
  virtual bool GetInitRange(size_t* offset, size_t* size) = 0;
 
  virtual bool GetIndexRange(size_t* offset, size_t* size) = 0;
 
  // Returns an empty vector if there are no specific ranges for the segments,
  // e.g. the media is in multiple files.
  // Otherwise, a vector of ranges for the media segments are returned.
  virtual std::vector<Range> GetSegmentRanges() = 0;
 
  int32_t GetReferenceTimeScale() const;
 
  double GetDuration() const;
 
  void SetAes128EncryptionConfig(const EncryptionConfig& config) {
    aes128_encryption_config_ = config;
  }
 
  int64_t sample_duration() const {
    return sample_durations_[num_samples_ < 2 ? 0 : 1];
  }
 
 protected:
  void UpdateProgress(uint64_t progress);
  void SetComplete();
 
  const MuxerOptions& options() const { return options_; }
  FileType* ftyp() { return ftyp_.get(); }
  Movie* moov() { return moov_.get(); }
  BufferWriter* fragment_buffer() { return fragment_buffer_.get(); }
  SegmentIndex* sidx() { return sidx_.get(); }
  MuxerListener* muxer_listener() { return muxer_listener_; }
  uint64_t progress_target() { return progress_target_; }
  const std::vector<KeyFrameInfo>& key_frame_infos() const {
    return key_frame_infos_;
  }
 
  void set_progress_target(uint64_t progress_target) {
    progress_target_ = progress_target;
  }
 
  const EncryptionConfig& aes128_encryption_config() const {
    return aes128_encryption_config_;
  }
 
 private:
  virtual Status DoInitialize() = 0;
  virtual Status DoFinalize() = 0;
  virtual Status DoFinalizeSegment(int64_t segment_number) = 0;
  virtual Status DoFinalizeChunk(int64_t segment_number) { return Status::OK; }
 
  uint32_t GetReferenceStreamId();
 
  void FinalizeFragmentForKeyRotation(
      size_t stream_id,
      bool fragment_encrypted,
      const EncryptionConfig& encryption_config);
 
  const MuxerOptions& options_;
  std::unique_ptr<FileType> ftyp_;
  std::unique_ptr<Movie> moov_;
  std::unique_ptr<MovieFragment> moof_;
  std::unique_ptr<BufferWriter> fragment_buffer_;
  std::unique_ptr<SegmentIndex> sidx_;
  std::vector<std::unique_ptr<Fragmenter>> fragmenters_;
  MuxerListener* muxer_listener_ = nullptr;
  ProgressListener* progress_listener_ = nullptr;
  uint64_t progress_target_ = 0u;
  uint64_t accumulated_progress_ = 0u;
  int64_t sample_durations_[2] = {0, 0};
  size_t num_samples_ = 0;
  std::vector<uint64_t> stream_durations_;
  std::vector<KeyFrameInfo> key_frame_infos_;
  // Only set for AES-128; holds key/IV for whole-segment encryption.
  EncryptionConfig aes128_encryption_config_;
 
  DISALLOW_COPY_AND_ASSIGN(Segmenter);
};
 
}  // namespace mp4
}  // namespace media
}  // namespace shaka
 
#endif  // PACKAGER_MEDIA_FORMATS_MP4_SEGMENTER_H_