Line data    Source code

       1              : /*
       2              :  * If not stated otherwise in this file or this component's LICENSE file the
       3              :  * following copyright and licenses apply:
       4              :  *
       5              :  * Copyright 2022 Sky UK
       6              :  *
       7              :  * Licensed under the Apache License, Version 2.0 (the "License");
       8              :  * you may not use this file except in compliance with the License.
       9              :  * You may obtain a copy of the License at
      10              :  *
      11              :  * http://www.apache.org/licenses/LICENSE-2.0
      12              :  *
      13              :  * Unless required by applicable law or agreed to in writing, software
      14              :  * distributed under the License is distributed on an "AS IS" BASIS,
      15              :  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      16              :  * See the License for the specific language governing permissions and
      17              :  * limitations under the License.
      18              :  */
      19              : 
      20              : #ifndef FIREBOLT_RIALTO_SERVER_SHM_UTILS_H_
      21              : #define FIREBOLT_RIALTO_SERVER_SHM_UTILS_H_
      22              : 
      23              : #include "ShmCommon.h"
      24              : #include <cstdint>
      25              : 
      26              : namespace firebolt::rialto::server
      27              : {
      28              : constexpr std::uint32_t kPrerollNumFrames{3};
      29              : constexpr std::uint32_t kMaxFrames{24};
      30           21 : constexpr std::uint32_t getMaxMetadataBytes()
      31              : {
      32              :     // The Rialto Server must size the metadata regions to be at least the following size:
      33              :     // 4 bytes version + max_frames_to_request * (maximum metadata struct size for stream type &
      34              :     //                                            supported metadata format versions)
      35              : 
      36              :     // Metadata V2 contains version only, so maximum metadata size is size of MetadataV1
      37           21 :     std::uint32_t maxMetadataStructSize = common::METADATA_V1_SIZE_PER_FRAME_BYTES;
      38           21 :     return common::VERSION_SIZE_BYTES + kMaxFrames * maxMetadataStructSize;
      39              : }
      40              : } // namespace firebolt::rialto::server
      41              : 
      42              : #endif // FIREBOLT_RIALTO_SERVER_SHM_UTILS_H_