data_track_schema.h

/*
 * Copyright 2026 LiveKit
 *
 * 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.
 */
 
#pragma once
 
#include <string>
#include <utility>
 
namespace livekit {
 
class DataTrackSchemaEncoding {
public:
  enum WellKnown {
    Protobuf,
    Flatbuffer,
    Ros1Msg,
    Ros2Msg,
    Ros2Idl,
    OmgIdl,
    JsonSchema,
    Other,
  };
 
  DataTrackSchemaEncoding(WellKnown well_known) : well_known_(well_known) {}
 
  static DataTrackSchemaEncoding custom(std::string identifier) {
    DataTrackSchemaEncoding encoding;
    encoding.custom_ = std::move(identifier);
    return encoding;
  }
 
  bool isCustom() const { return !custom_.empty(); }
 
  WellKnown wellKnown() const { return well_known_; }
 
  const std::string& customIdentifier() const { return custom_; }
 
private:
  DataTrackSchemaEncoding() = default;
 
  WellKnown well_known_ = Other;
  std::string custom_;
};
 
inline bool operator==(const DataTrackSchemaEncoding& a, const DataTrackSchemaEncoding& b) {
  if (a.isCustom() || b.isCustom()) {
    return a.customIdentifier() == b.customIdentifier();
  }
  return a.wellKnown() == b.wellKnown();
}
inline bool operator!=(const DataTrackSchemaEncoding& a, const DataTrackSchemaEncoding& b) { return !(a == b); }
 
class DataTrackFrameEncoding {
public:
  enum WellKnown {
    Ros1,
    Cdr,
    Protobuf,
    Flatbuffer,
    Cbor,
    Msgpack,
    Json,
    Other,
  };
 
  DataTrackFrameEncoding(WellKnown well_known) : well_known_(well_known) {}
 
  static DataTrackFrameEncoding custom(std::string identifier) {
    DataTrackFrameEncoding encoding;
    encoding.custom_ = std::move(identifier);
    return encoding;
  }
 
  bool isCustom() const { return !custom_.empty(); }
 
  WellKnown wellKnown() const { return well_known_; }
 
  const std::string& customIdentifier() const { return custom_; }
 
private:
  DataTrackFrameEncoding() = default;
 
  WellKnown well_known_ = Other;
  std::string custom_;
};
 
inline bool operator==(const DataTrackFrameEncoding& a, const DataTrackFrameEncoding& b) {
  if (a.isCustom() || b.isCustom()) {
    return a.customIdentifier() == b.customIdentifier();
  }
  return a.wellKnown() == b.wellKnown();
}
inline bool operator!=(const DataTrackFrameEncoding& a, const DataTrackFrameEncoding& b) { return !(a == b); }
 
struct DataTrackSchemaId {
  std::string name;
 
  DataTrackSchemaEncoding encoding = DataTrackSchemaEncoding::Other;
};
 
inline bool operator==(const DataTrackSchemaId& a, const DataTrackSchemaId& b) {
  return a.name == b.name && a.encoding == b.encoding;
}
inline bool operator!=(const DataTrackSchemaId& a, const DataTrackSchemaId& b) { return !(a == b); }
 
} // namespace livekit