VideoIOYuv.h

/* The copyright in this software is being made available under the BSD
 * License, included below. This software may be subject to other third party
 * and contributor rights, including patent rights, and no such rights are
 * granted under this license.
 *
 * Copyright (c) 2010-2023, ITU/ISO/IEC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  * Neither the name of the ITU/ISO/IEC nor the names of its contributors may
 *    be used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

/** \file     VideoIOYuv.h
    \brief    YUV file I/O class (header)
*/

#ifndef __VIDEOIOYUV__
#define __VIDEOIOYUV__

#include <stdio.h>
#include <fstream>
#include <iostream>
#include "CommonLib/CommonDef.h"
#include "CommonLib/Unit.h"

// ====================================================================================================================
// Class definition
// ====================================================================================================================

#include "CommonLib/Slice.h"
#include "CommonLib/Picture.h"

/// YUV file I/O class
class VideoIOYuv
{
private:
  std::fstream m_cHandle;                            ///< file handle
  ///
  BitDepths m_fileBitdepth;          // bitdepth of input/output video file
  BitDepths m_msbExtendedBitDepth;   // bitdepth after addition of MSBs (with value 0)
  BitDepths m_bitdepthShift;         // number of bits to increase or decrease image by before/after write/read

  int          m_inY4mFileHeaderLength = 0;
  int          m_outPicWidth           = 0;
  int          m_outPicHeight          = 0;
  int          m_outBitDepth           = 0;
  int          m_outFrameRate          = 0;
  int          m_outFrameScale         = 1;
  ChromaFormat m_outChromaFormat       = ChromaFormat::_420;
  bool         m_outY4m                = false;

public:
  VideoIOYuv()           {}
  virtual ~VideoIOYuv()  {}

  void parseY4mFileHeader(const std::string &fileName, int &width, int &height, int &frameRate, int &bitDepth,
                          ChromaFormat &chromaFormat);
  void setOutputY4mInfo(int width, int height, int frameRate, int frameScale, int bitDepth, ChromaFormat chromaFormat);
  void writeY4mFileHeader();
  void open(const std::string &fileName, bool bWriteMode, const BitDepths &fileBitDepth,
            const BitDepths &MSBExtendedBitDepth,
            const BitDepths &internalBitDepth);                  ///< open or create file
  void close();                                                  ///< close file
#if EXTENSION_360_VIDEO
  void skipFrames(int numFrames, uint32_t width, uint32_t height, ChromaFormat format);
#else
  void skipFrames(uint32_t numFrames, uint32_t width, uint32_t height, ChromaFormat format);
#endif
  // if fileFormat<NUM_CHROMA_FORMAT, the format of the file is that format specified, else it is the format of the PicYuv.


  // If fileFormat=NUM_CHROMA_FORMAT, use the format defined by pPicYuvTrueOrg
  bool read(PelUnitBuf& pic, PelUnitBuf& picOrg, const InputColourSpaceConversion ipcsc, int aiPad[2],
            ChromaFormat fileFormat   = ChromaFormat::UNDEFINED,
            const bool   clipToRec709 = false);   ///< read one frame with padding parameter

  // If fileFormat=NUM_CHROMA_FORMAT, use the format defined by pPicYuv
  bool write(uint32_t orgWidth, uint32_t orgHeight, const CPelUnitBuf& pic, const InputColourSpaceConversion ipCSC,
             const bool packedYuvOutputMode, int confLeft = 0, int confRight = 0, int confTop = 0, int confBottom = 0,
             ChromaFormat format = ChromaFormat::UNDEFINED, const bool clipToRec709 = false,
             const bool subtractConfWindowOffsets = true);   ///< write one YUV frame with padding parameter

  // If fileFormat=NUM_CHROMA_FORMAT, use the format defined by pPicYuvTop and pPicYuvBottom
  bool write(const CPelUnitBuf& picTop, const CPelUnitBuf& picBot, const InputColourSpaceConversion ipCSC,
             const bool packedYuvOutputMode, int confLeft = 0, int confRight = 0, int confTop = 0, int confBottom = 0,
             ChromaFormat format = ChromaFormat::UNDEFINED, const bool isTff = false, const bool clipToRec709 = false);

  static void ColourSpaceConvert(const CPelUnitBuf &src, PelUnitBuf &dest, const InputColourSpaceConversion conversion, bool bIsForwards);

  bool  isEof ();                                           ///< check for end-of-file
  bool  isFail();                                           ///< check for failure
  bool  isOpen() { return m_cHandle.is_open(); }
  void  setBitdepthShift(ChannelType ch, int bd) { m_bitdepthShift[ch] = bd; }
  int   getBitdepthShift(ChannelType ch) { return m_bitdepthShift[ch]; }
  int   getFileBitdepth(ChannelType ch) { return m_fileBitdepth[ch]; }

  bool writeUpscaledPicture(const SPS& sps, const PPS& pps, const CPelUnitBuf& pic,
                            const InputColourSpaceConversion ipCSC, const bool packedYuvOutputMode,
                            int outputChoice = 0, ChromaFormat format = ChromaFormat::UNDEFINED,
                            const bool clipToRec709            = false,
                            int        upscaleFilterForDisplay = 1);   ///< write one upsaled YUV frame
};

bool isY4mFileExt(const std::string &fileName);

#endif // __VIDEOIOYUV__