{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson and Iñaki García Etxebarria
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- GstVideoDither provides implementations of several dithering algorithms
-- that can be applied to lines of video pixels to quantize and dither them.

#if (MIN_VERSION_haskell_gi_overloading(1,0,0) && !defined(__HADDOCK_VERSION__))
#define ENABLE_OVERLOADING
#endif

module GI.GstVideo.Structs.VideoDither
    ( 

-- * Exported types
    VideoDither(..)                         ,


 -- * Methods
-- | 
-- 
--  === __Click to display all available methods, including inherited ones__
-- ==== Methods
-- [free]("GI.GstVideo.Structs.VideoDither#g:method:free"), [line]("GI.GstVideo.Structs.VideoDither#g:method:line").
-- 
-- ==== Getters
-- /None/.
-- 
-- ==== Setters
-- /None/.

#if defined(ENABLE_OVERLOADING)
    ResolveVideoDitherMethod                ,
#endif

-- ** free #method:free#

#if defined(ENABLE_OVERLOADING)
    VideoDitherFreeMethodInfo               ,
#endif
    videoDitherFree                         ,


-- ** line #method:line#

#if defined(ENABLE_OVERLOADING)
    VideoDitherLineMethodInfo               ,
#endif
    videoDitherLine                         ,




    ) where

import Data.GI.Base.ShortPrelude
import qualified Data.GI.Base.ShortPrelude as SP
import qualified Data.GI.Base.Overloading as O
import qualified Prelude as P

import qualified Data.GI.Base.Attributes as GI.Attributes
import qualified Data.GI.Base.BasicTypes as B.Types
import qualified Data.GI.Base.ManagedPtr as B.ManagedPtr
import qualified Data.GI.Base.GArray as B.GArray
import qualified Data.GI.Base.GClosure as B.GClosure
import qualified Data.GI.Base.GError as B.GError
import qualified Data.GI.Base.GHashTable as B.GHT
import qualified Data.GI.Base.GVariant as B.GVariant
import qualified Data.GI.Base.GValue as B.GValue
import qualified Data.GI.Base.GParamSpec as B.GParamSpec
import qualified Data.GI.Base.CallStack as B.CallStack
import qualified Data.GI.Base.Properties as B.Properties
import qualified Data.GI.Base.Signals as B.Signals
import qualified Control.Monad.IO.Class as MIO
import qualified Data.Coerce as Coerce
import qualified Data.Text as T
import qualified Data.Kind as DK
import qualified Data.ByteString.Char8 as B
import qualified Data.Map as Map
import qualified Foreign.Ptr as FP
import qualified GHC.OverloadedLabels as OL
import qualified GHC.Records as R


-- | Memory-managed wrapper type.
newtype VideoDither = VideoDither (SP.ManagedPtr VideoDither)
    deriving (VideoDither -> VideoDither -> Bool
(VideoDither -> VideoDither -> Bool)
-> (VideoDither -> VideoDither -> Bool) -> Eq VideoDither
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: VideoDither -> VideoDither -> Bool
== :: VideoDither -> VideoDither -> Bool
$c/= :: VideoDither -> VideoDither -> Bool
/= :: VideoDither -> VideoDither -> Bool
Eq)

instance SP.ManagedPtrNewtype VideoDither where
    toManagedPtr :: VideoDither -> ManagedPtr VideoDither
toManagedPtr (VideoDither ManagedPtr VideoDither
p) = ManagedPtr VideoDither
p

-- XXX Wrapping a foreign struct/union with no known destructor or size, leak?
instance BoxedPtr VideoDither where
    boxedPtrCopy :: VideoDither -> IO VideoDither
boxedPtrCopy = VideoDither -> IO VideoDither
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return
    boxedPtrFree :: VideoDither -> IO ()
boxedPtrFree = \VideoDither
_x -> () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()


#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList VideoDither
type instance O.AttributeList VideoDither = VideoDitherAttributeList
type VideoDitherAttributeList = ('[ ] :: [(Symbol, DK.Type)])
#endif

-- method VideoDither::free
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "dither"
--           , argType =
--               TInterface Name { namespace = "GstVideo" , name = "VideoDither" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GstVideoDither" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "gst_video_dither_free" gst_video_dither_free :: 
    Ptr VideoDither ->                      -- dither : TInterface (Name {namespace = "GstVideo", name = "VideoDither"})
    IO ()

-- | Free /@dither@/
videoDitherFree ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    VideoDither
    -- ^ /@dither@/: a t'GI.GstVideo.Structs.VideoDither.VideoDither'
    -> m ()
videoDitherFree :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
VideoDither -> m ()
videoDitherFree VideoDither
dither = IO () -> m ()
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ do
    Ptr VideoDither
dither' <- VideoDither -> IO (Ptr VideoDither)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr VideoDither
dither
    Ptr VideoDither -> IO ()
gst_video_dither_free Ptr VideoDither
dither'
    VideoDither -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr VideoDither
dither
    () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
data VideoDitherFreeMethodInfo
instance (signature ~ (m ()), MonadIO m) => O.OverloadedMethod VideoDitherFreeMethodInfo VideoDither signature where
    overloadedMethod = videoDitherFree

instance O.OverloadedMethodInfo VideoDitherFreeMethodInfo VideoDither where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.GstVideo.Structs.VideoDither.videoDitherFree",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gstvideo-1.0.28/docs/GI-GstVideo-Structs-VideoDither.html#v:videoDitherFree"
        })


#endif

-- method VideoDither::line
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "dither"
--           , argType =
--               TInterface Name { namespace = "GstVideo" , name = "VideoDither" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GstVideoDither" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "line"
--           , argType = TBasicType TPtr
--           , direction = DirectionIn
--           , mayBeNull = True
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "pointer to the pixels of the line"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "x"
--           , argType = TBasicType TUInt
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "x coordinate" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "y"
--           , argType = TBasicType TUInt
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "y coordinate" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "width"
--           , argType = TBasicType TUInt
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the width" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "gst_video_dither_line" gst_video_dither_line :: 
    Ptr VideoDither ->                      -- dither : TInterface (Name {namespace = "GstVideo", name = "VideoDither"})
    Ptr () ->                               -- line : TBasicType TPtr
    Word32 ->                               -- x : TBasicType TUInt
    Word32 ->                               -- y : TBasicType TUInt
    Word32 ->                               -- width : TBasicType TUInt
    IO ()

-- | Dither /@width@/ pixels starting from offset /@x@/ in /@line@/ using /@dither@/.
-- 
-- /@y@/ is the line number of /@line@/ in the output image.
videoDitherLine ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    VideoDither
    -- ^ /@dither@/: a t'GI.GstVideo.Structs.VideoDither.VideoDither'
    -> Ptr ()
    -- ^ /@line@/: pointer to the pixels of the line
    -> Word32
    -- ^ /@x@/: x coordinate
    -> Word32
    -- ^ /@y@/: y coordinate
    -> Word32
    -- ^ /@width@/: the width
    -> m ()
videoDitherLine :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
VideoDither -> Ptr () -> Word32 -> Word32 -> Word32 -> m ()
videoDitherLine VideoDither
dither Ptr ()
line Word32
x Word32
y Word32
width = IO () -> m ()
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ do
    Ptr VideoDither
dither' <- VideoDither -> IO (Ptr VideoDither)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr VideoDither
dither
    Ptr VideoDither -> Ptr () -> Word32 -> Word32 -> Word32 -> IO ()
gst_video_dither_line Ptr VideoDither
dither' Ptr ()
line Word32
x Word32
y Word32
width
    VideoDither -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr VideoDither
dither
    () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
data VideoDitherLineMethodInfo
instance (signature ~ (Ptr () -> Word32 -> Word32 -> Word32 -> m ()), MonadIO m) => O.OverloadedMethod VideoDitherLineMethodInfo VideoDither signature where
    overloadedMethod = videoDitherLine

instance O.OverloadedMethodInfo VideoDitherLineMethodInfo VideoDither where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.GstVideo.Structs.VideoDither.videoDitherLine",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gstvideo-1.0.28/docs/GI-GstVideo-Structs-VideoDither.html#v:videoDitherLine"
        })


#endif

#if defined(ENABLE_OVERLOADING)
type family ResolveVideoDitherMethod (t :: Symbol) (o :: DK.Type) :: DK.Type where
    ResolveVideoDitherMethod "free" o = VideoDitherFreeMethodInfo
    ResolveVideoDitherMethod "line" o = VideoDitherLineMethodInfo
    ResolveVideoDitherMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveVideoDitherMethod t VideoDither, O.OverloadedMethod info VideoDither p) => OL.IsLabel t (VideoDither -> p) where
#if MIN_VERSION_base(4,10,0)
    fromLabel = O.overloadedMethod @info
#else
    fromLabel _ = O.overloadedMethod @info
#endif

#if MIN_VERSION_base(4,13,0)
instance (info ~ ResolveVideoDitherMethod t VideoDither, O.OverloadedMethod info VideoDither p, R.HasField t VideoDither p) => R.HasField t VideoDither p where
    getField = O.overloadedMethod @info

#endif

instance (info ~ ResolveVideoDitherMethod t VideoDither, O.OverloadedMethodInfo info VideoDither) => OL.IsLabel t (O.MethodProxy info VideoDither) where
#if MIN_VERSION_base(4,10,0)
    fromLabel = O.MethodProxy
#else
    fromLabel _ = O.MethodProxy
#endif

#endif