<?php
/*
 * Copyright 2014 Google Inc.
 *
 * 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.
 */

namespace Google\Service\Transcoder;

class Vp9CodecSettings extends \Google\Model
{
  /**
   * Unspecified frame rate conversion strategy.
   */
  public const FRAME_RATE_CONVERSION_STRATEGY_FRAME_RATE_CONVERSION_STRATEGY_UNSPECIFIED = 'FRAME_RATE_CONVERSION_STRATEGY_UNSPECIFIED';
  /**
   * Selectively retain frames to reduce the output frame rate. Every _n_ th
   * frame is kept, where `n = ceil(input frame rate / target frame rate)`. When
   * _n_ = 1 (that is, the target frame rate is greater than the input frame
   * rate), the output frame rate matches the input frame rate. When _n_ > 1,
   * frames are dropped and the output frame rate is equal to `(input frame rate
   * / n)`. For more information, see [Calculate frame
   * rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate).
   */
  public const FRAME_RATE_CONVERSION_STRATEGY_DOWNSAMPLE = 'DOWNSAMPLE';
  /**
   * Drop or duplicate frames to match the specified frame rate.
   */
  public const FRAME_RATE_CONVERSION_STRATEGY_DROP_DUPLICATE = 'DROP_DUPLICATE';
  /**
   * Required. The video bitrate in bits per second. The minimum value is 1,000.
   * The maximum value is 480,000,000.
   *
   * @var int
   */
  public $bitrateBps;
  /**
   * Target CRF level. Must be between 10 and 36, where 10 is the highest
   * quality and 36 is the most efficient compression. The default is 21.
   * **Note:** This field is not supported.
   *
   * @var int
   */
  public $crfLevel;
  /**
   * Required. The target video frame rate in frames per second (FPS). Must be
   * less than or equal to 120.
   *
   * @var 
   */
  public $frameRate;
  /**
   * Optional. Frame rate conversion strategy for desired frame rate. The
   * default is `DOWNSAMPLE`.
   *
   * @var string
   */
  public $frameRateConversionStrategy;
  /**
   * Select the GOP size based on the specified duration. The default is `3s`.
   * Note that `gopDuration` must be less than or equal to
   * [`segmentDuration`](#SegmentSettings), and
   * [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
   *
   * @var string
   */
  public $gopDuration;
  /**
   * Select the GOP size based on the specified frame count. Must be greater
   * than zero.
   *
   * @var int
   */
  public $gopFrameCount;
  /**
   * The height of the video in pixels. Must be an even integer. When not
   * specified, the height is adjusted to match the specified width and input
   * aspect ratio. If both are omitted, the input height is used. For portrait
   * videos that contain horizontal ASR and rotation metadata, provide the
   * height, in pixels, per the horizontal ASR. The API calculates the width per
   * the horizontal ASR. The API detects any rotation metadata and swaps the
   * requested height and width for the output.
   *
   * @var int
   */
  public $heightPixels;
  protected $hlgType = Vp9ColorFormatHLG::class;
  protected $hlgDataType = '';
  /**
   * Pixel format to use. The default is `yuv420p`. Supported pixel formats: -
   * `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format -
   * `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format -
   * `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format -
   * `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
   *
   * @var string
   */
  public $pixelFormat;
  /**
   * Enforces the specified codec profile. The following profiles are supported:
   * * `profile0` (default) * `profile1` * `profile2` * `profile3` The available
   * options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/).
   * Note that certain values for this field may cause the transcoder to
   * override other fields you set in the `Vp9CodecSettings` message.
   *
   * @var string
   */
  public $profile;
  /**
   * Specify the mode. The default is `vbr`. Supported rate control modes: -
   * `vbr` - variable bitrate
   *
   * @var string
   */
  public $rateControlMode;
  protected $sdrType = Vp9ColorFormatSDR::class;
  protected $sdrDataType = '';
  /**
   * The width of the video in pixels. Must be an even integer. When not
   * specified, the width is adjusted to match the specified height and input
   * aspect ratio. If both are omitted, the input width is used. For portrait
   * videos that contain horizontal ASR and rotation metadata, provide the
   * width, in pixels, per the horizontal ASR. The API calculates the height per
   * the horizontal ASR. The API detects any rotation metadata and swaps the
   * requested height and width for the output.
   *
   * @var int
   */
  public $widthPixels;

  /**
   * Required. The video bitrate in bits per second. The minimum value is 1,000.
   * The maximum value is 480,000,000.
   *
   * @param int $bitrateBps
   */
  public function setBitrateBps($bitrateBps)
  {
    $this->bitrateBps = $bitrateBps;
  }
  /**
   * @return int
   */
  public function getBitrateBps()
  {
    return $this->bitrateBps;
  }
  /**
   * Target CRF level. Must be between 10 and 36, where 10 is the highest
   * quality and 36 is the most efficient compression. The default is 21.
   * **Note:** This field is not supported.
   *
   * @param int $crfLevel
   */
  public function setCrfLevel($crfLevel)
  {
    $this->crfLevel = $crfLevel;
  }
  /**
   * @return int
   */
  public function getCrfLevel()
  {
    return $this->crfLevel;
  }
  public function setFrameRate($frameRate)
  {
    $this->frameRate = $frameRate;
  }
  public function getFrameRate()
  {
    return $this->frameRate;
  }
  /**
   * Optional. Frame rate conversion strategy for desired frame rate. The
   * default is `DOWNSAMPLE`.
   *
   * Accepted values: FRAME_RATE_CONVERSION_STRATEGY_UNSPECIFIED, DOWNSAMPLE,
   * DROP_DUPLICATE
   *
   * @param self::FRAME_RATE_CONVERSION_STRATEGY_* $frameRateConversionStrategy
   */
  public function setFrameRateConversionStrategy($frameRateConversionStrategy)
  {
    $this->frameRateConversionStrategy = $frameRateConversionStrategy;
  }
  /**
   * @return self::FRAME_RATE_CONVERSION_STRATEGY_*
   */
  public function getFrameRateConversionStrategy()
  {
    return $this->frameRateConversionStrategy;
  }
  /**
   * Select the GOP size based on the specified duration. The default is `3s`.
   * Note that `gopDuration` must be less than or equal to
   * [`segmentDuration`](#SegmentSettings), and
   * [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
   *
   * @param string $gopDuration
   */
  public function setGopDuration($gopDuration)
  {
    $this->gopDuration = $gopDuration;
  }
  /**
   * @return string
   */
  public function getGopDuration()
  {
    return $this->gopDuration;
  }
  /**
   * Select the GOP size based on the specified frame count. Must be greater
   * than zero.
   *
   * @param int $gopFrameCount
   */
  public function setGopFrameCount($gopFrameCount)
  {
    $this->gopFrameCount = $gopFrameCount;
  }
  /**
   * @return int
   */
  public function getGopFrameCount()
  {
    return $this->gopFrameCount;
  }
  /**
   * The height of the video in pixels. Must be an even integer. When not
   * specified, the height is adjusted to match the specified width and input
   * aspect ratio. If both are omitted, the input height is used. For portrait
   * videos that contain horizontal ASR and rotation metadata, provide the
   * height, in pixels, per the horizontal ASR. The API calculates the width per
   * the horizontal ASR. The API detects any rotation metadata and swaps the
   * requested height and width for the output.
   *
   * @param int $heightPixels
   */
  public function setHeightPixels($heightPixels)
  {
    $this->heightPixels = $heightPixels;
  }
  /**
   * @return int
   */
  public function getHeightPixels()
  {
    return $this->heightPixels;
  }
  /**
   * Optional. HLG color format setting for VP9.
   *
   * @param Vp9ColorFormatHLG $hlg
   */
  public function setHlg(Vp9ColorFormatHLG $hlg)
  {
    $this->hlg = $hlg;
  }
  /**
   * @return Vp9ColorFormatHLG
   */
  public function getHlg()
  {
    return $this->hlg;
  }
  /**
   * Pixel format to use. The default is `yuv420p`. Supported pixel formats: -
   * `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format -
   * `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format -
   * `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format -
   * `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
   *
   * @param string $pixelFormat
   */
  public function setPixelFormat($pixelFormat)
  {
    $this->pixelFormat = $pixelFormat;
  }
  /**
   * @return string
   */
  public function getPixelFormat()
  {
    return $this->pixelFormat;
  }
  /**
   * Enforces the specified codec profile. The following profiles are supported:
   * * `profile0` (default) * `profile1` * `profile2` * `profile3` The available
   * options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/).
   * Note that certain values for this field may cause the transcoder to
   * override other fields you set in the `Vp9CodecSettings` message.
   *
   * @param string $profile
   */
  public function setProfile($profile)
  {
    $this->profile = $profile;
  }
  /**
   * @return string
   */
  public function getProfile()
  {
    return $this->profile;
  }
  /**
   * Specify the mode. The default is `vbr`. Supported rate control modes: -
   * `vbr` - variable bitrate
   *
   * @param string $rateControlMode
   */
  public function setRateControlMode($rateControlMode)
  {
    $this->rateControlMode = $rateControlMode;
  }
  /**
   * @return string
   */
  public function getRateControlMode()
  {
    return $this->rateControlMode;
  }
  /**
   * Optional. SDR color format setting for VP9.
   *
   * @param Vp9ColorFormatSDR $sdr
   */
  public function setSdr(Vp9ColorFormatSDR $sdr)
  {
    $this->sdr = $sdr;
  }
  /**
   * @return Vp9ColorFormatSDR
   */
  public function getSdr()
  {
    return $this->sdr;
  }
  /**
   * The width of the video in pixels. Must be an even integer. When not
   * specified, the width is adjusted to match the specified height and input
   * aspect ratio. If both are omitted, the input width is used. For portrait
   * videos that contain horizontal ASR and rotation metadata, provide the
   * width, in pixels, per the horizontal ASR. The API calculates the height per
   * the horizontal ASR. The API detects any rotation metadata and swaps the
   * requested height and width for the output.
   *
   * @param int $widthPixels
   */
  public function setWidthPixels($widthPixels)
  {
    $this->widthPixels = $widthPixels;
  }
  /**
   * @return int
   */
  public function getWidthPixels()
  {
    return $this->widthPixels;
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Vp9CodecSettings::class, 'Google_Service_Transcoder_Vp9CodecSettings');
