{-# 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.CaptionSelector
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.MediaConvert.Types.CaptionSelector where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import Amazonka.MediaConvert.Types.CaptionSourceSettings
import Amazonka.MediaConvert.Types.LanguageCode
import qualified Amazonka.Prelude as Prelude

-- | Use captions selectors to specify the captions data from your input that
-- you use in your outputs. You can use up to 20 captions selectors per
-- input.
--
-- /See:/ 'newCaptionSelector' smart constructor.
data CaptionSelector = CaptionSelector'
  { -- | The specific language to extract from source, using the ISO 639-2 or ISO
    -- 639-3 three-letter language code. If input is SCTE-27, complete this
    -- field and\/or PID to select the caption language to extract. If input is
    -- DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and\/or
    -- PID to select the caption language to extract. If input is DVB-Sub that
    -- is being passed through, omit this field (and PID field); there is no
    -- way to extract a specific language with pass-through captions.
    CaptionSelector -> Maybe Text
customLanguageCode :: Prelude.Maybe Prelude.Text,
    -- | The specific language to extract from source. If input is SCTE-27,
    -- complete this field and\/or PID to select the caption language to
    -- extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete
    -- this field and\/or PID to select the caption language to extract. If
    -- input is DVB-Sub that is being passed through, omit this field (and PID
    -- field); there is no way to extract a specific language with pass-through
    -- captions.
    CaptionSelector -> Maybe LanguageCode
languageCode :: Prelude.Maybe LanguageCode,
    -- | If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml
    -- file, specify the URI of the input captions source file. If your input
    -- captions are IMSC in an IMF package, use TrackSourceSettings instead of
    -- FileSoureSettings.
    CaptionSelector -> Maybe CaptionSourceSettings
sourceSettings :: Prelude.Maybe CaptionSourceSettings
  }
  deriving (CaptionSelector -> CaptionSelector -> Bool
(CaptionSelector -> CaptionSelector -> Bool)
-> (CaptionSelector -> CaptionSelector -> Bool)
-> Eq CaptionSelector
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CaptionSelector -> CaptionSelector -> Bool
$c/= :: CaptionSelector -> CaptionSelector -> Bool
== :: CaptionSelector -> CaptionSelector -> Bool
$c== :: CaptionSelector -> CaptionSelector -> Bool
Prelude.Eq, ReadPrec [CaptionSelector]
ReadPrec CaptionSelector
Int -> ReadS CaptionSelector
ReadS [CaptionSelector]
(Int -> ReadS CaptionSelector)
-> ReadS [CaptionSelector]
-> ReadPrec CaptionSelector
-> ReadPrec [CaptionSelector]
-> Read CaptionSelector
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CaptionSelector]
$creadListPrec :: ReadPrec [CaptionSelector]
readPrec :: ReadPrec CaptionSelector
$creadPrec :: ReadPrec CaptionSelector
readList :: ReadS [CaptionSelector]
$creadList :: ReadS [CaptionSelector]
readsPrec :: Int -> ReadS CaptionSelector
$creadsPrec :: Int -> ReadS CaptionSelector
Prelude.Read, Int -> CaptionSelector -> ShowS
[CaptionSelector] -> ShowS
CaptionSelector -> String
(Int -> CaptionSelector -> ShowS)
-> (CaptionSelector -> String)
-> ([CaptionSelector] -> ShowS)
-> Show CaptionSelector
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CaptionSelector] -> ShowS
$cshowList :: [CaptionSelector] -> ShowS
show :: CaptionSelector -> String
$cshow :: CaptionSelector -> String
showsPrec :: Int -> CaptionSelector -> ShowS
$cshowsPrec :: Int -> CaptionSelector -> ShowS
Prelude.Show, (forall x. CaptionSelector -> Rep CaptionSelector x)
-> (forall x. Rep CaptionSelector x -> CaptionSelector)
-> Generic CaptionSelector
forall x. Rep CaptionSelector x -> CaptionSelector
forall x. CaptionSelector -> Rep CaptionSelector x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CaptionSelector x -> CaptionSelector
$cfrom :: forall x. CaptionSelector -> Rep CaptionSelector x
Prelude.Generic)

-- |
-- Create a value of 'CaptionSelector' 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:
--
-- 'customLanguageCode', 'captionSelector_customLanguageCode' - The specific language to extract from source, using the ISO 639-2 or ISO
-- 639-3 three-letter language code. If input is SCTE-27, complete this
-- field and\/or PID to select the caption language to extract. If input is
-- DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and\/or
-- PID to select the caption language to extract. If input is DVB-Sub that
-- is being passed through, omit this field (and PID field); there is no
-- way to extract a specific language with pass-through captions.
--
-- 'languageCode', 'captionSelector_languageCode' - The specific language to extract from source. If input is SCTE-27,
-- complete this field and\/or PID to select the caption language to
-- extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete
-- this field and\/or PID to select the caption language to extract. If
-- input is DVB-Sub that is being passed through, omit this field (and PID
-- field); there is no way to extract a specific language with pass-through
-- captions.
--
-- 'sourceSettings', 'captionSelector_sourceSettings' - If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml
-- file, specify the URI of the input captions source file. If your input
-- captions are IMSC in an IMF package, use TrackSourceSettings instead of
-- FileSoureSettings.
newCaptionSelector ::
  CaptionSelector
newCaptionSelector :: CaptionSelector
newCaptionSelector =
  CaptionSelector' :: Maybe Text
-> Maybe LanguageCode
-> Maybe CaptionSourceSettings
-> CaptionSelector
CaptionSelector'
    { $sel:customLanguageCode:CaptionSelector' :: Maybe Text
customLanguageCode =
        Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:languageCode:CaptionSelector' :: Maybe LanguageCode
languageCode = Maybe LanguageCode
forall a. Maybe a
Prelude.Nothing,
      $sel:sourceSettings:CaptionSelector' :: Maybe CaptionSourceSettings
sourceSettings = Maybe CaptionSourceSettings
forall a. Maybe a
Prelude.Nothing
    }

-- | The specific language to extract from source, using the ISO 639-2 or ISO
-- 639-3 three-letter language code. If input is SCTE-27, complete this
-- field and\/or PID to select the caption language to extract. If input is
-- DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and\/or
-- PID to select the caption language to extract. If input is DVB-Sub that
-- is being passed through, omit this field (and PID field); there is no
-- way to extract a specific language with pass-through captions.
captionSelector_customLanguageCode :: Lens.Lens' CaptionSelector (Prelude.Maybe Prelude.Text)
captionSelector_customLanguageCode :: (Maybe Text -> f (Maybe Text))
-> CaptionSelector -> f CaptionSelector
captionSelector_customLanguageCode = (CaptionSelector -> Maybe Text)
-> (CaptionSelector -> Maybe Text -> CaptionSelector)
-> Lens CaptionSelector CaptionSelector (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CaptionSelector' {Maybe Text
customLanguageCode :: Maybe Text
$sel:customLanguageCode:CaptionSelector' :: CaptionSelector -> Maybe Text
customLanguageCode} -> Maybe Text
customLanguageCode) (\s :: CaptionSelector
s@CaptionSelector' {} Maybe Text
a -> CaptionSelector
s {$sel:customLanguageCode:CaptionSelector' :: Maybe Text
customLanguageCode = Maybe Text
a} :: CaptionSelector)

-- | The specific language to extract from source. If input is SCTE-27,
-- complete this field and\/or PID to select the caption language to
-- extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete
-- this field and\/or PID to select the caption language to extract. If
-- input is DVB-Sub that is being passed through, omit this field (and PID
-- field); there is no way to extract a specific language with pass-through
-- captions.
captionSelector_languageCode :: Lens.Lens' CaptionSelector (Prelude.Maybe LanguageCode)
captionSelector_languageCode :: (Maybe LanguageCode -> f (Maybe LanguageCode))
-> CaptionSelector -> f CaptionSelector
captionSelector_languageCode = (CaptionSelector -> Maybe LanguageCode)
-> (CaptionSelector -> Maybe LanguageCode -> CaptionSelector)
-> Lens
     CaptionSelector
     CaptionSelector
     (Maybe LanguageCode)
     (Maybe LanguageCode)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CaptionSelector' {Maybe LanguageCode
languageCode :: Maybe LanguageCode
$sel:languageCode:CaptionSelector' :: CaptionSelector -> Maybe LanguageCode
languageCode} -> Maybe LanguageCode
languageCode) (\s :: CaptionSelector
s@CaptionSelector' {} Maybe LanguageCode
a -> CaptionSelector
s {$sel:languageCode:CaptionSelector' :: Maybe LanguageCode
languageCode = Maybe LanguageCode
a} :: CaptionSelector)

-- | If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml
-- file, specify the URI of the input captions source file. If your input
-- captions are IMSC in an IMF package, use TrackSourceSettings instead of
-- FileSoureSettings.
captionSelector_sourceSettings :: Lens.Lens' CaptionSelector (Prelude.Maybe CaptionSourceSettings)
captionSelector_sourceSettings :: (Maybe CaptionSourceSettings -> f (Maybe CaptionSourceSettings))
-> CaptionSelector -> f CaptionSelector
captionSelector_sourceSettings = (CaptionSelector -> Maybe CaptionSourceSettings)
-> (CaptionSelector
    -> Maybe CaptionSourceSettings -> CaptionSelector)
-> Lens
     CaptionSelector
     CaptionSelector
     (Maybe CaptionSourceSettings)
     (Maybe CaptionSourceSettings)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CaptionSelector' {Maybe CaptionSourceSettings
sourceSettings :: Maybe CaptionSourceSettings
$sel:sourceSettings:CaptionSelector' :: CaptionSelector -> Maybe CaptionSourceSettings
sourceSettings} -> Maybe CaptionSourceSettings
sourceSettings) (\s :: CaptionSelector
s@CaptionSelector' {} Maybe CaptionSourceSettings
a -> CaptionSelector
s {$sel:sourceSettings:CaptionSelector' :: Maybe CaptionSourceSettings
sourceSettings = Maybe CaptionSourceSettings
a} :: CaptionSelector)

instance Core.FromJSON CaptionSelector where
  parseJSON :: Value -> Parser CaptionSelector
parseJSON =
    String
-> (Object -> Parser CaptionSelector)
-> Value
-> Parser CaptionSelector
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"CaptionSelector"
      ( \Object
x ->
          Maybe Text
-> Maybe LanguageCode
-> Maybe CaptionSourceSettings
-> CaptionSelector
CaptionSelector'
            (Maybe Text
 -> Maybe LanguageCode
 -> Maybe CaptionSourceSettings
 -> CaptionSelector)
-> Parser (Maybe Text)
-> Parser
     (Maybe LanguageCode
      -> Maybe CaptionSourceSettings -> CaptionSelector)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"customLanguageCode")
            Parser
  (Maybe LanguageCode
   -> Maybe CaptionSourceSettings -> CaptionSelector)
-> Parser (Maybe LanguageCode)
-> Parser (Maybe CaptionSourceSettings -> CaptionSelector)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe LanguageCode)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"languageCode")
            Parser (Maybe CaptionSourceSettings -> CaptionSelector)
-> Parser (Maybe CaptionSourceSettings) -> Parser CaptionSelector
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe CaptionSourceSettings)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"sourceSettings")
      )

instance Prelude.Hashable CaptionSelector

instance Prelude.NFData CaptionSelector

instance Core.ToJSON CaptionSelector where
  toJSON :: CaptionSelector -> Value
toJSON CaptionSelector' {Maybe Text
Maybe LanguageCode
Maybe CaptionSourceSettings
sourceSettings :: Maybe CaptionSourceSettings
languageCode :: Maybe LanguageCode
customLanguageCode :: Maybe Text
$sel:sourceSettings:CaptionSelector' :: CaptionSelector -> Maybe CaptionSourceSettings
$sel:languageCode:CaptionSelector' :: CaptionSelector -> Maybe LanguageCode
$sel:customLanguageCode:CaptionSelector' :: CaptionSelector -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"customLanguageCode" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
customLanguageCode,
            (Text
"languageCode" Text -> LanguageCode -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (LanguageCode -> Pair) -> Maybe LanguageCode -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe LanguageCode
languageCode,
            (Text
"sourceSettings" Text -> CaptionSourceSettings -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (CaptionSourceSettings -> Pair)
-> Maybe CaptionSourceSettings -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe CaptionSourceSettings
sourceSettings
          ]
      )