{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.MediaConvert.Types.ImageInserter
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.MediaConvert.Types.ImageInserter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.MediaConvert.Types.InsertableImage
import qualified Amazonka.Prelude as Prelude

-- | Use the image inserter feature to include a graphic overlay on your
-- video. Enable or disable this feature for each input or output
-- individually. For more information, see
-- https:\/\/docs.aws.amazon.com\/mediaconvert\/latest\/ug\/graphic-overlay.html.
-- This setting is disabled by default.
--
-- /See:/ 'newImageInserter' smart constructor.
data ImageInserter = ImageInserter'
  { -- | Specify the images that you want to overlay on your video. The images
    -- must be PNG or TGA files.
    ImageInserter -> Maybe [InsertableImage]
insertableImages :: Prelude.Maybe [InsertableImage],
    -- | Specify the reference white level, in nits, for all of your image
    -- inserter images. Use to correct brightness levels within HDR10 outputs.
    -- For 1,000 nit peak brightness displays, we recommend that you set SDR
    -- reference white level to 203 (according to ITU-R BT.2408). Leave blank
    -- to use the default value of 100, or specify an integer from 100 to 1000.
    ImageInserter -> Maybe Natural
sdrReferenceWhiteLevel :: Prelude.Maybe Prelude.Natural
  }
  deriving (ImageInserter -> ImageInserter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ImageInserter -> ImageInserter -> Bool
$c/= :: ImageInserter -> ImageInserter -> Bool
== :: ImageInserter -> ImageInserter -> Bool
$c== :: ImageInserter -> ImageInserter -> Bool
Prelude.Eq, ReadPrec [ImageInserter]
ReadPrec ImageInserter
Int -> ReadS ImageInserter
ReadS [ImageInserter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ImageInserter]
$creadListPrec :: ReadPrec [ImageInserter]
readPrec :: ReadPrec ImageInserter
$creadPrec :: ReadPrec ImageInserter
readList :: ReadS [ImageInserter]
$creadList :: ReadS [ImageInserter]
readsPrec :: Int -> ReadS ImageInserter
$creadsPrec :: Int -> ReadS ImageInserter
Prelude.Read, Int -> ImageInserter -> ShowS
[ImageInserter] -> ShowS
ImageInserter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ImageInserter] -> ShowS
$cshowList :: [ImageInserter] -> ShowS
show :: ImageInserter -> String
$cshow :: ImageInserter -> String
showsPrec :: Int -> ImageInserter -> ShowS
$cshowsPrec :: Int -> ImageInserter -> ShowS
Prelude.Show, forall x. Rep ImageInserter x -> ImageInserter
forall x. ImageInserter -> Rep ImageInserter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ImageInserter x -> ImageInserter
$cfrom :: forall x. ImageInserter -> Rep ImageInserter x
Prelude.Generic)

-- |
-- Create a value of 'ImageInserter' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'insertableImages', 'imageInserter_insertableImages' - Specify the images that you want to overlay on your video. The images
-- must be PNG or TGA files.
--
-- 'sdrReferenceWhiteLevel', 'imageInserter_sdrReferenceWhiteLevel' - Specify the reference white level, in nits, for all of your image
-- inserter images. Use to correct brightness levels within HDR10 outputs.
-- For 1,000 nit peak brightness displays, we recommend that you set SDR
-- reference white level to 203 (according to ITU-R BT.2408). Leave blank
-- to use the default value of 100, or specify an integer from 100 to 1000.
newImageInserter ::
  ImageInserter
newImageInserter :: ImageInserter
newImageInserter =
  ImageInserter'
    { $sel:insertableImages:ImageInserter' :: Maybe [InsertableImage]
insertableImages = forall a. Maybe a
Prelude.Nothing,
      $sel:sdrReferenceWhiteLevel:ImageInserter' :: Maybe Natural
sdrReferenceWhiteLevel = forall a. Maybe a
Prelude.Nothing
    }

-- | Specify the images that you want to overlay on your video. The images
-- must be PNG or TGA files.
imageInserter_insertableImages :: Lens.Lens' ImageInserter (Prelude.Maybe [InsertableImage])
imageInserter_insertableImages :: Lens' ImageInserter (Maybe [InsertableImage])
imageInserter_insertableImages = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ImageInserter' {Maybe [InsertableImage]
insertableImages :: Maybe [InsertableImage]
$sel:insertableImages:ImageInserter' :: ImageInserter -> Maybe [InsertableImage]
insertableImages} -> Maybe [InsertableImage]
insertableImages) (\s :: ImageInserter
s@ImageInserter' {} Maybe [InsertableImage]
a -> ImageInserter
s {$sel:insertableImages:ImageInserter' :: Maybe [InsertableImage]
insertableImages = Maybe [InsertableImage]
a} :: ImageInserter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Specify the reference white level, in nits, for all of your image
-- inserter images. Use to correct brightness levels within HDR10 outputs.
-- For 1,000 nit peak brightness displays, we recommend that you set SDR
-- reference white level to 203 (according to ITU-R BT.2408). Leave blank
-- to use the default value of 100, or specify an integer from 100 to 1000.
imageInserter_sdrReferenceWhiteLevel :: Lens.Lens' ImageInserter (Prelude.Maybe Prelude.Natural)
imageInserter_sdrReferenceWhiteLevel :: Lens' ImageInserter (Maybe Natural)
imageInserter_sdrReferenceWhiteLevel = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ImageInserter' {Maybe Natural
sdrReferenceWhiteLevel :: Maybe Natural
$sel:sdrReferenceWhiteLevel:ImageInserter' :: ImageInserter -> Maybe Natural
sdrReferenceWhiteLevel} -> Maybe Natural
sdrReferenceWhiteLevel) (\s :: ImageInserter
s@ImageInserter' {} Maybe Natural
a -> ImageInserter
s {$sel:sdrReferenceWhiteLevel:ImageInserter' :: Maybe Natural
sdrReferenceWhiteLevel = Maybe Natural
a} :: ImageInserter)

instance Data.FromJSON ImageInserter where
  parseJSON :: Value -> Parser ImageInserter
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ImageInserter"
      ( \Object
x ->
          Maybe [InsertableImage] -> Maybe Natural -> ImageInserter
ImageInserter'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"insertableImages"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"sdrReferenceWhiteLevel")
      )

instance Prelude.Hashable ImageInserter where
  hashWithSalt :: Int -> ImageInserter -> Int
hashWithSalt Int
_salt ImageInserter' {Maybe Natural
Maybe [InsertableImage]
sdrReferenceWhiteLevel :: Maybe Natural
insertableImages :: Maybe [InsertableImage]
$sel:sdrReferenceWhiteLevel:ImageInserter' :: ImageInserter -> Maybe Natural
$sel:insertableImages:ImageInserter' :: ImageInserter -> Maybe [InsertableImage]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [InsertableImage]
insertableImages
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
sdrReferenceWhiteLevel

instance Prelude.NFData ImageInserter where
  rnf :: ImageInserter -> ()
rnf ImageInserter' {Maybe Natural
Maybe [InsertableImage]
sdrReferenceWhiteLevel :: Maybe Natural
insertableImages :: Maybe [InsertableImage]
$sel:sdrReferenceWhiteLevel:ImageInserter' :: ImageInserter -> Maybe Natural
$sel:insertableImages:ImageInserter' :: ImageInserter -> Maybe [InsertableImage]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [InsertableImage]
insertableImages
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
sdrReferenceWhiteLevel

instance Data.ToJSON ImageInserter where
  toJSON :: ImageInserter -> Value
toJSON ImageInserter' {Maybe Natural
Maybe [InsertableImage]
sdrReferenceWhiteLevel :: Maybe Natural
insertableImages :: Maybe [InsertableImage]
$sel:sdrReferenceWhiteLevel:ImageInserter' :: ImageInserter -> Maybe Natural
$sel:insertableImages:ImageInserter' :: ImageInserter -> Maybe [InsertableImage]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"insertableImages" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [InsertableImage]
insertableImages,
            (Key
"sdrReferenceWhiteLevel" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
sdrReferenceWhiteLevel
          ]
      )