Deocdes a raw YUV binary into [y, u, v] planes where each plane is a binary.

Arguments

• binary is a binary representation of a YUV image.

• width is the width of the image encoded in yuv.

• height is the height of the image encoded in yuv.

• encoding is one of :C444, :C422 or :C420 representing how yuv is encoded.

Returns

• {:ok, [y, u, v]} or

• {:error, reason}.

@spec encode(image :: Vix.Vips.Image.t(), encoding :: yuv_encoding()) ::
  {:ok, yuv_list()} | {:errpr, Image.error_message()}

Encodes an image that is in a YUV colorspace to raw YUV data that is a list of the three planes, each a binary.

The data is always written in a planar format.

Arguments

• image is any t:Vimage.t/0 that is in a YUV colorspace such as that returned from Image.YUV.new_from_file/5 or Image.YUV.new_from_binary/5.

• encoding is one of :C444, :C422 or :C420 representing how yuv is to be encoded.

Returns

• {:ok, [y, u, v]} or

• {:error, Image.error_message()}.

@spec new_from_binary(
  binary :: binary(),
  width :: pos_integer(),
  height :: pos_integer(),
  encoding :: yuv_encoding(),
  colorspace :: yuv_colorspace()
) :: {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}

Converts raw YUV data into an RGB image.

The data is assumed, and required to be in:

• Planar format
• 8-bit color depth

Arguments

• binary is raw YUV data as a binary.

• width is the width of the image encoded in the YUV data.

• height is the height of the image encoded in the YUV data.

• encoding is one of :C444, :C422 or :C420.

• colorspace is one of :bt601 (the default) or :bt709.

Returns

• {:ok, rgb_image} or

• {:error, reason}.

@spec new_from_file(
  path :: Path.t(),
  width :: pos_integer(),
  height :: pos_integer(),
  encoding :: yuv_encoding(),
  colorspace :: yuv_colorspace()
) :: {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}

Converts the raw YUV data in a .yuv file into an RGB image.

The data is assumed, and required to be in:

• Planar format
• 8-bit color depth

Arguments

• path is any accessible file system path.

• width is the width of the image encoded in the YUV data.

• height is the height of the image encoded in the YUV data.

• encoding is one of :C444, :C422 or :C420.

• colorspace is one of :bt601 (the default) or :bt709.

Returns

• {:ok, rgb_image} or

• {:error, reason}.

@spec to_rgb(image :: Vix.Vips.Image.t(), colorspace :: yuv_colorspace()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}

Convert an image in an YUV colorspace and convert it to RGB colorspace.

Arguments

• image is any t:Vimage.t/0 that is in a YUV colorspace such as that returned from Image.YUV.new_from_file/5 or Image.YUV.new_from_binary/5.

• colorspace is one of :bt601 (the default) or :bt709 that represents the colorspace of image before conversion.

@spec to_rgb(
  yuv :: yuv_list(),
  width :: pos_integer(),
  height :: pos_integer(),
  encoding :: yuv_encoding(),
  colorspace :: yuv_colorspace()
) :: {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}

Takes the [y, u, v] planes and converts them to an RGB image.

Arguments

• yuv is a list of three binaries representing the Y, U and V planes. Such a list is returned from Image.YUV.to_yuv/3 and from Image.YUV.encode/2.

• width is the width of the image encoded in yuv.

• height is the height of the image encoded in yuv.

• encoding is one of :C444, :C422 or :C420 representing how yuv is encoded.

• colorspace is one of :bt601 (the default) or :bt709 that represents the colorspace of image before conversion.

Returns

• {:ok, image} or

• {:error, reason}.

@spec to_yuv(
  image :: Vix.Vips.Image.t(),
  encoding :: yuv_encoding(),
  colorspace :: yuv_colorspace()
) ::
  {:ok, yuv_list()} | {:error, Image.error_message()}

Converts an image to raw YUV data as a binary.

Arguments

• image is any t:Vimage.t/0.

• encoding is one of :C444, :C422 or :C420.

• colorspace is one of :bt601 (the default) or :bt709.

Returns

• {:ok, [y, u, v]} or

• {:error, reason}.

@spec write_to_binary(
  image :: Vix.Vips.Image.t(),
  encoding :: yuv_encoding(),
  colorspace :: yuv_colorspace()
) :: {:ok, binary()} | {:error, Image.error_message()}

Writes an image to a YUV raw binary.

Arguments

• image is any t:Vimage.t/0.

• encoding is one of :C444, :C422 or :C420.

• colorspace is one of :bt601 (the default) or :bt709.

Returns

• {:ok, yuv_binary} or

• {:error, reason}.

@spec write_to_file(
  image :: Vix.Vips.Image.t(),
  path :: Path.t(),
  encoding :: yuv_encoding(),
  colorspace :: yuv_colorspace()
) :: :ok | {:error, Image.error_message()}

Writes an image to a YUV file as raw YUV data.

It is recommeneded, but not required, that the path name use a .yuv suffix.

Arguments

• path is any accessible file system path.

• encoding is one of :C444, :C422 or :C420.

• colorspace is one of :bt601 (the default) or :bt709.

Returns

• :ok or

• {:error, reason}.