DescriptionRecord.h

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * 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 <map>
#include <string>
 
#include <vrs/ForwardDefinitions.h>
#include <vrs/VrsExport.h>
#include <vrs/WriteFileHandler.h>
 
namespace vrs {
 
class FileHandler;
 
using std::map;
using std::string;
 
namespace DescriptionRecord {
 
enum {
  kLegacyDescriptionFormatVersion = 1, 
  kDescriptionFormatVersion = 2 
};
 
VRS_API int writeDescriptionRecord(
    WriteFileHandler& file,
    const map<StreamId, const StreamTags*>& streamTags,
    const map<string, string>& fileTags,
    uint32_t& outPreviousRecordSize);
 
VRS_API int readDescriptionRecord(
    FileHandler& file,
    uint32_t recordHeaderSize,
    uint32_t& outDescriptionRecordSize,
    map<StreamId, StreamTags>& outStreamTags,
    map<string, string>& outFileTags);
 
VRS_API void upgradeStreamTags(map<string, string>& streamTags);
 
VRS_API void createStreamSerialNumbers(
    const map<string, string>& inFileTags,
    map<StreamId, StreamTags>& inOutStreamTags);
 
} // namespace DescriptionRecord
 
} // namespace vrs