android13/hardware/rockchip/hwcomposer/drmhwc2/include/drmdisplaycomposition.h

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ANDROID_DRM_DISPLAY_COMPOSITION_H_
#define ANDROID_DRM_DISPLAY_COMPOSITION_H_

#include "drmcrtc.h"
#include "drmlayer.h"
#include "drmplane.h"
#include "rockchip/utils/drmdebug.h"
#include "utils/drmfence.h"

#include <sstream>
#include <vector>

#include <hardware/hardware.h>
#include <hardware/hwcomposer.h>
#include <inttypes.h>

namespace android {

class Importer;
class Planner;
class SquashState;

enum DrmCompositionType {
  DRM_COMPOSITION_TYPE_EMPTY,
  DRM_COMPOSITION_TYPE_FRAME,
  DRM_COMPOSITION_TYPE_DPMS,
  DRM_COMPOSITION_TYPE_MODESET,
};

struct DrmCompositionDisplayLayersMap {
  int display;
  bool geometry_changed = true;
  std::vector<DrmHwcLayer> layers;

  DrmCompositionDisplayLayersMap() = default;
  DrmCompositionDisplayLayersMap(DrmCompositionDisplayLayersMap &&rhs) =
      default;
};

struct DrmCompositionRegion {
  std::vector<size_t> source_layers;
};

class DrmCompositionPlane {
 public:
  enum class Type : int32_t {
    kDisable,
    kLayer,
  };

  DrmCompositionPlane() = default;
  DrmCompositionPlane(DrmCompositionPlane &&rhs){
    type_  = rhs.type();
    plane_ = rhs.plane();
    crtc_  = rhs.crtc();
    mirror_ = rhs.mirror();

    if(rhs.type() == Type::kLayer){
      zpos_ = rhs.get_zpos();
      source_layers_.clear();
      source_layers_.push_back(rhs.source_layers().front());
    }
  };
  DrmCompositionPlane &operator=(DrmCompositionPlane &&rhs){
    type_  = rhs.type();
    plane_ = rhs.plane();
    crtc_  = rhs.crtc();
    mirror_ = rhs.mirror();

    if(rhs.type() == Type::kLayer){
      zpos_ = rhs.get_zpos();
      source_layers_.clear();
      source_layers_.push_back(rhs.source_layers().front());
    }
    return *this;
  };
  DrmCompositionPlane(Type type, DrmPlane *plane, DrmCrtc *crtc)
      : type_(type),
        plane_(plane),
        crtc_(crtc),
        mirror_(false){}

  DrmCompositionPlane(Type type, DrmPlane *plane, DrmCrtc *crtc,
                      size_t source_layer, bool mirror = false)
      : type_(type),
        plane_(plane),
        crtc_(crtc),
        source_layers_(1, source_layer),
        mirror_(mirror){}

  Type type() const {
    return type_;
  }

  bool mirror(){
    return mirror_;
  }

  DrmPlane *plane() const {
    return plane_;
  }
  void set_plane(DrmPlane *plane) {
    plane_ = plane;
  }

  DrmCrtc *crtc() const {
    return crtc_;
  }

  std::vector<size_t> &source_layers() {
    return source_layers_;
  }

  const std::vector<size_t> &source_layers() const {
    return source_layers_;
  }
 int get_zpos() { return zpos_; }
 void set_zpos(int zpos) { zpos_ =  zpos; }

 private:
  int zpos_;
  Type type_ = Type::kDisable;
  DrmPlane *plane_ = NULL;
  DrmCrtc *crtc_ = NULL;
  std::vector<size_t> source_layers_;
  bool mirror_;
};

class DrmDisplayComposition {
 public:
  DrmDisplayComposition() = default;
  DrmDisplayComposition(const DrmDisplayComposition &) = delete;
  ~DrmDisplayComposition();

  int Init(DrmDevice *drm, DrmCrtc *crtc, Importer *importer,
           Planner *planner, uint64_t frame_no, uint64_t display_id);

  int SetLayers(DrmHwcLayer *layers, size_t num_layers, bool geometry_changed);
  int AddPlaneComposition(DrmCompositionPlane &&plane);
  int AddPlaneDisable(DrmPlane *plane);
  int SetDpmsMode(uint32_t dpms_mode);
  int SetDisplayMode(const DrmMode &display_mode);
  int SetDisplayHdrMode(DrmHdrType hdr_mode,
                        android_dataspace_t dataspace);
  // 丢帧模式，允许 DrmDisplayCompositor 线程丢掉不能够及时送显的
  // DrmDisplayComposition
  int SetDropMode(bool mode);
  bool IsDropMode();

  int DisableUnusedPlanes();
  int CreateAndAssignReleaseFences(SyncTimeline &sync_timeline);
  sp<ReleaseFence> GetReleaseFence(hwc2_layer_t layer_id);
  int SignalCompositionDone();

  std::vector<DrmHwcLayer> &layers() {
    return layers_;
  }

  std::vector<DrmCompositionPlane> &composition_planes() {
    return composition_planes_;
  }

  std::queue<std::unique_ptr<DrmDisplayComposition>> &useless_composition_queue(){
    return useless_composition_queue_;
  }

  bool geometry_changed() const {
    return geometry_changed_;
  }

  uint64_t frame_no() const {
    return frame_no_;
  }

  int display() const {
    return display_id_;
  }
  DrmCompositionType type() const {
    return type_;
  }

  uint32_t dpms_mode() const {
    return dpms_mode_;
  }

  const DrmMode &display_mode() const {
    return display_mode_;
  }

  DrmCrtc *crtc() const {
    return crtc_;
  }

  Importer *importer() const {
    return importer_;
  }

  Planner *planner() const {
    return planner_;
  }

  int take_out_fence() {
    return out_fence_.Release();
  }

  void set_out_fence(int out_fence) {
    out_fence_.Set(out_fence);
  }

  bool has_svep() {
    return has_svep_layer_;
  }

  bool has_sideband2() const {
    return has_sideband2_layer_;
  }

  uint64_t get_sideband_tunnel_id() const {
    return sideband_tunnel_id_;
  }

  DrmHdrType hdr_mode() const{ return hdr_mode_;}
  bool has_10bit_Yuv() const{ return bYuv10bit_;}
  android_dataspace_t dataspace() const{ return dataspace_;}

  void Dump(std::ostringstream *out) const;

 private:
  bool validate_composition_type(DrmCompositionType desired);

  DrmDevice *drm_ = NULL;
  DrmCrtc *crtc_ = NULL;
  Importer *importer_ = NULL;
  Planner *planner_ = NULL;

  DrmCompositionType type_ = DRM_COMPOSITION_TYPE_EMPTY;
  uint32_t dpms_mode_ = DRM_MODE_DPMS_ON;
  DrmMode display_mode_;
  bool  drop_mode_ = false;

  DrmHdrType hdr_mode_;
  bool bYuv10bit_;
  android_dataspace_t dataspace_;

  int timeline_ = 0;
  int timeline_current_ = 0;

  UniqueFd out_fence_ = -1;

  bool geometry_changed_;
  bool has_svep_layer_;
  // sideband
  bool has_sideband2_layer_ = false;
  uint64_t sideband_tunnel_id_ = 0;

  std::vector<DrmHwcLayer> layers_;
  std::vector<DrmCompositionPlane> composition_planes_;

  std::queue<std::unique_ptr<DrmDisplayComposition>> useless_composition_queue_;


  uint64_t frame_no_ = 0;
  uint64_t display_id_;

  // mutable since we need to acquire in HaveQueuedComposites
  mutable pthread_mutex_t lock_;
  bool signal_;
};
}  // namespace android

#endif  // ANDROID_DRM_DISPLAY_COMPOSITION_H_