path: root/src/lib/image.cc

/*
    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

/** @file src/image.cc
 *  @brief A class to describe a video image.
 */

#include <iostream>
extern "C" {
#include <libswscale/swscale.h>
#include <libavutil/pixfmt.h>
#include <libavutil/pixdesc.h>
#include <libpostproc/postprocess.h>
}
#include "image.h"
#include "exceptions.h"
#include "scaler.h"

using std::string;
using std::min;
using std::cout;
using boost::shared_ptr;
using libdcp::Size;

int
Image::line_factor (int n) const
{
	if (n == 0) {
		return 1;
	}

	AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
	if (!d) {
		throw PixelFormatError ("lines()", _pixel_format);
	}
	
	return pow (2.0f, d->log2_chroma_h);
}

/** @param n Component index.
 *  @return Number of lines in the image for the given component.
 */
int
Image::lines (int n) const
{
	return rint (ceil (static_cast<double>(size().height) / line_factor (n)));
}

/** @return Number of components */
int
Image::components () const
{
	AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
	if (!d) {
		throw PixelFormatError ("components()", _pixel_format);
	}

	if ((d->flags & PIX_FMT_PLANAR) == 0) {
		return 1;
	}
	
	return d->nb_components;
}

shared_ptr<Image>
Image::scale (libdcp::Size out_size, Scaler const * scaler, bool result_aligned) const
{
	assert (scaler);
	/* Empirical testing suggests that sws_scale() will crash if
	   the input image is not aligned.
	*/
	assert (aligned ());

	shared_ptr<Image> scaled (new Image (pixel_format(), out_size, result_aligned));

	struct SwsContext* scale_context = sws_getContext (
		size().width, size().height, pixel_format(),
		out_size.width, out_size.height, pixel_format(),
		scaler->ffmpeg_id (), 0, 0, 0
		);

	sws_scale (
		scale_context,
		data(), stride(),
		0, size().height,
		scaled->data(), scaled->stride()
		);

	sws_freeContext (scale_context);

	return scaled;
}

/** Scale this image to a given size and convert it to RGB.
 *  @param out_size Output image size in pixels.
 *  @param scaler Scaler to use.
 */
shared_ptr<Image>
Image::scale_and_convert_to_rgb (libdcp::Size out_size, Scaler const * scaler, bool result_aligned) const
{
	assert (scaler);
	/* Empirical testing suggests that sws_scale() will crash if
	   the input image is not aligned.
	*/
	assert (aligned ());

	shared_ptr<Image> rgb (new Image (PIX_FMT_RGB24, out_size, result_aligned));

	struct SwsContext* scale_context = sws_getContext (
		size().width, size().height, pixel_format(),
		out_size.width, out_size.height, PIX_FMT_RGB24,
		scaler->ffmpeg_id (), 0, 0, 0
		);

	/* Scale and convert to RGB from whatever its currently in (which may be RGB) */
	sws_scale (
		scale_context,
		data(), stride(),
		0, size().height,
		rgb->data(), rgb->stride()
		);

	sws_freeContext (scale_context);

	return rgb;
}

/** Run a FFmpeg post-process on this image and return the processed version.
 *  @param pp Flags for the required set of post processes.
 *  @return Post-processed image.
 */
shared_ptr<Image>
Image::post_process (string pp, bool aligned) const
{
	shared_ptr<Image> out (new Image (pixel_format(), size (), aligned));

	int pp_format = 0;
	switch (pixel_format()) {
	case PIX_FMT_YUV420P:
		pp_format = PP_FORMAT_420;
		break;
	case PIX_FMT_YUV422P10LE:
	case PIX_FMT_YUV422P:
	case PIX_FMT_UYVY422:
		pp_format = PP_FORMAT_422;
		break;
	case PIX_FMT_YUV444P:
	case PIX_FMT_YUV444P9BE:
	case PIX_FMT_YUV444P9LE:
	case PIX_FMT_YUV444P10BE:
	case PIX_FMT_YUV444P10LE:
		pp_format = PP_FORMAT_444;
	default:
		throw PixelFormatError ("post_process", pixel_format());
	}
		
	pp_mode* mode = pp_get_mode_by_name_and_quality (pp.c_str (), PP_QUALITY_MAX);
	pp_context* context = pp_get_context (size().width, size().height, pp_format | PP_CPU_CAPS_MMX2);

	pp_postprocess (
		(const uint8_t **) data(), stride(),
		out->data(), out->stride(),
		size().width, size().height,
		0, 0, mode, context, 0
		);
		
	pp_free_mode (mode);
	pp_free_context (context);

	return out;
}

shared_ptr<Image>
Image::crop (Crop crop, bool aligned) const
{
	libdcp::Size cropped_size = size ();
	cropped_size.width -= crop.left + crop.right;
	cropped_size.height -= crop.top + crop.bottom;

	shared_ptr<Image> out (new Image (pixel_format(), cropped_size, aligned));

	for (int c = 0; c < components(); ++c) {
		int const crop_left_in_bytes = bytes_per_pixel(c) * crop.left;
		/* bytes_per_pixel() could be a fraction; in this case the stride will be rounded
		   up, and we need to make sure that we copy over the width (up to the stride)
		   rather than short of the width; hence the ceil() here.
		*/
		int const cropped_width_in_bytes = ceil (bytes_per_pixel(c) * cropped_size.width);

		/* Start of the source line, cropped from the top but not the left */
		uint8_t* in_p = data()[c] + (crop.top / out->line_factor(c)) * stride()[c];
		uint8_t* out_p = out->data()[c];

		for (int y = 0; y < out->lines(c); ++y) {
			memcpy (out_p, in_p + crop_left_in_bytes, cropped_width_in_bytes);
			in_p += stride()[c];
			out_p += out->stride()[c];
		}
	}

	return out;
}

/** Blacken a YUV image whose bits per pixel is rounded up to 16 */
void
Image::yuv_16_black (uint16_t v)
{
	memset (data()[0], 0, lines(0) * stride()[0]);
	for (int i = 1; i < 3; ++i) {
		int16_t* p = reinterpret_cast<int16_t*> (data()[i]);
		for (int y = 0; y < size().height; ++y) {
			for (int x = 0; x < line_size()[i] / 2; ++x) {
				p[x] = v;
			}
			p += stride()[i] / 2;
		}
	}
}

uint16_t
Image::swap_16 (uint16_t v)
{
	return ((v >> 8) & 0xff) | ((v & 0xff) << 8);
}

void
Image::make_black ()
{
	/* U/V black value for 8-bit colour */
	static uint8_t const eight_bit_uv =	(1 << 7) - 1;
	/* U/V black value for 9-bit colour */
	static uint16_t const nine_bit_uv =	(1 << 8) - 1;
	/* U/V black value for 10-bit colour */
	static uint16_t const ten_bit_uv =	(1 << 9) - 1;
	/* U/V black value for 16-bit colour */
	static uint16_t const sixteen_bit_uv =	(1 << 15) - 1;
	
	switch (_pixel_format) {
	case PIX_FMT_YUV420P:
	case PIX_FMT_YUV422P:
	case PIX_FMT_YUV444P:
		memset (data()[0], 0, lines(0) * stride()[0]);
		memset (data()[1], eight_bit_uv, lines(1) * stride()[1]);
		memset (data()[2], eight_bit_uv, lines(2) * stride()[2]);
		break;

	case PIX_FMT_YUVJ420P:
	case PIX_FMT_YUVJ422P:
	case PIX_FMT_YUVJ444P:
		memset (data()[0], 0, lines(0) * stride()[0]);
		memset (data()[1], eight_bit_uv + 1, lines(1) * stride()[1]);
		memset (data()[2], eight_bit_uv + 1, lines(2) * stride()[2]);
		break;

	case PIX_FMT_YUV422P9LE:
	case PIX_FMT_YUV444P9LE:
		yuv_16_black (nine_bit_uv);
		break;

	case PIX_FMT_YUV422P9BE:
	case PIX_FMT_YUV444P9BE:
		yuv_16_black (swap_16 (nine_bit_uv));
		break;
		
	case PIX_FMT_YUV422P10LE:
	case PIX_FMT_YUV444P10LE:
		yuv_16_black (ten_bit_uv);
		break;

	case PIX_FMT_YUV422P16LE:
	case PIX_FMT_YUV444P16LE:
		yuv_16_black (sixteen_bit_uv);
		break;
		
	case PIX_FMT_YUV444P10BE:
	case PIX_FMT_YUV422P10BE:
		yuv_16_black (swap_16 (ten_bit_uv));
		break;

	case PIX_FMT_RGB24:		
		memset (data()[0], 0, lines(0) * stride()[0]);
		break;

	case PIX_FMT_UYVY422:
	{
		int const Y = lines(0);
		int const X = line_size()[0];
		uint8_t* p = data()[0];
		for (int y = 0; y < Y; ++y) {
			for (int x = 0; x < X / 4; ++x) {
				*p++ = eight_bit_uv; // Cb
				*p++ = 0;	     // Y0
				*p++ = eight_bit_uv; // Cr
				*p++ = 0;	     // Y1
			}
		}
		break;
	}

	default:
		throw PixelFormatError ("make_black()", _pixel_format);
	}
}

void
Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
{
	/* Only implemented for RGBA onto RGB24 so far */
	assert (_pixel_format == PIX_FMT_RGB24 && other->pixel_format() == PIX_FMT_RGBA);

	int start_tx = position.x;
	int start_ox = 0;

	if (start_tx < 0) {
		start_ox = -start_tx;
		start_tx = 0;
	}

	int start_ty = position.y;
	int start_oy = 0;

	if (start_ty < 0) {
		start_oy = -start_ty;
		start_ty = 0;
	}

	for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
		uint8_t* tp = data()[0] + ty * stride()[0] + position.x * 3;
		uint8_t* op = other->data()[0] + oy * other->stride()[0];
		for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
			float const alpha = float (op[3]) / 255;
			tp[0] = (tp[0] * (1 - alpha)) + op[0] * alpha;
			tp[1] = (tp[1] * (1 - alpha)) + op[1] * alpha;
			tp[2] = (tp[2] * (1 - alpha)) + op[2] * alpha;
			tp += 3;
			op += 4;
		}
	}
}

void
Image::copy (shared_ptr<const Image> other, Position<int> position)
{
	/* Only implemented for RGB24 onto RGB24 so far */
	assert (_pixel_format == PIX_FMT_RGB24 && other->pixel_format() == PIX_FMT_RGB24);
	assert (position.x >= 0 && position.y >= 0);

	int const N = min (position.x + other->size().width, size().width) - position.x;
	for (int ty = position.y, oy = 0; ty < size().height && oy < other->size().height; ++ty, ++oy) {
		uint8_t * const tp = data()[0] + ty * stride()[0] + position.x * 3;
		uint8_t * const op = other->data()[0] + oy * other->stride()[0];
		memcpy (tp, op, N * 3);
	}
}	

void
Image::read_from_socket (shared_ptr<Socket> socket)
{
	for (int i = 0; i < components(); ++i) {
		uint8_t* p = data()[i];
		for (int y = 0; y < lines(i); ++y) {
			socket->read (p, line_size()[i]);
			p += stride()[i];
		}
	}
}

void
Image::write_to_socket (shared_ptr<Socket> socket) const
{
	for (int i = 0; i < components(); ++i) {
		uint8_t* p = data()[i];
		for (int y = 0; y < lines(i); ++y) {
			socket->write (p, line_size()[i]);
			p += stride()[i];
		}
	}
}


float
Image::bytes_per_pixel (int c) const
{
	AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
	if (!d) {
		throw PixelFormatError ("lines()", _pixel_format);
	}

	if (c >= components()) {
		return 0;
	}

	float bpp[4] = { 0, 0, 0, 0 };

	bpp[0] = floor ((d->comp[0].depth_minus1 + 1 + 7) / 8);
	if (d->nb_components > 1) {
		bpp[1] = floor ((d->comp[1].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
	}
	if (d->nb_components > 2) {
		bpp[2] = floor ((d->comp[2].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
	}
	if (d->nb_components > 3) {
		bpp[3] = floor ((d->comp[3].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
	}
	
	if ((d->flags & PIX_FMT_PLANAR) == 0) {
		/* Not planar; sum them up */
		return bpp[0] + bpp[1] + bpp[2] + bpp[3];
	}

	return bpp[c];
}

/** Construct a Image of a given size and format, allocating memory
 *  as required.
 *
 *  @param p Pixel format.
 *  @param s Size in pixels.
 */
Image::Image (AVPixelFormat p, libdcp::Size s, bool aligned)
	: libdcp::Image (s)
	, _pixel_format (p)
	, _aligned (aligned)
{
	allocate ();
}

void
Image::allocate ()
{
	_data = (uint8_t **) av_malloc (4 * sizeof (uint8_t *));
	_data[0] = _data[1] = _data[2] = _data[3] = 0;
	
	_line_size = (int *) av_malloc (4 * sizeof (int));
	_line_size[0] = _line_size[1] = _line_size[2] = _line_size[3] = 0;
	
	_stride = (int *) av_malloc (4 * sizeof (int));
	_stride[0] = _stride[1] = _stride[2] = _stride[3] = 0;

	for (int i = 0; i < components(); ++i) {
		_line_size[i] = _size.width * bytes_per_pixel(i);
		_stride[i] = stride_round_up (i, _line_size, _aligned ? 32 : 1);
		_data[i] = (uint8_t *) av_malloc (_stride[i] * lines (i));
	}
}

Image::Image (Image const & other)
	: libdcp::Image (other)
	,  _pixel_format (other._pixel_format)
	, _aligned (other._aligned)
{
	allocate ();

	for (int i = 0; i < components(); ++i) {
		uint8_t* p = _data[i];
		uint8_t* q = other._data[i];
		for (int j = 0; j < lines(i); ++j) {
			memcpy (p, q, _line_size[i]);
			p += stride()[i];
			q += other.stride()[i];
		}
	}
}

Image::Image (AVFrame* frame)
	: libdcp::Image (libdcp::Size (frame->width, frame->height))
	, _pixel_format (static_cast<AVPixelFormat> (frame->format))
	, _aligned (true)
{
	allocate ();

	for (int i = 0; i < components(); ++i) {
		uint8_t* p = _data[i];
		uint8_t* q = frame->data[i];
		for (int j = 0; j < lines(i); ++j) {
			memcpy (p, q, _line_size[i]);
			p += stride()[i];
			/* AVFrame's linesize is what we call `stride' */
			q += frame->linesize[i];
		}
	}
}

Image::Image (shared_ptr<const Image> other, bool aligned)
	: libdcp::Image (other)
	, _pixel_format (other->_pixel_format)
	, _aligned (aligned)
{
	allocate ();

	for (int i = 0; i < components(); ++i) {
		assert(line_size()[i] == other->line_size()[i]);
		uint8_t* p = _data[i];
		uint8_t* q = other->data()[i];
		for (int j = 0; j < lines(i); ++j) {
			memcpy (p, q, line_size()[i]);
			p += stride()[i];
			q += other->stride()[i];
		}
	}
}

Image&
Image::operator= (Image const & other)
{
	if (this == &other) {
		return *this;
	}

	Image tmp (other);
	swap (tmp);
	return *this;
}

void
Image::swap (Image & other)
{
	libdcp::Image::swap (other);
	
	std::swap (_pixel_format, other._pixel_format);

	for (int i = 0; i < 4; ++i) {
		std::swap (_data[i], other._data[i]);
		std::swap (_line_size[i], other._line_size[i]);
		std::swap (_stride[i], other._stride[i]);
	}

	std::swap (_aligned, other._aligned);
}

/** Destroy a Image */
Image::~Image ()
{
	for (int i = 0; i < components(); ++i) {
		av_free (_data[i]);
	}

	av_free (_data);
	av_free (_line_size);
	av_free (_stride);
}

uint8_t **
Image::data () const
{
	return _data;
}

int *
Image::line_size () const
{
	return _line_size;
}

int *
Image::stride () const
{
	return _stride;
}

libdcp::Size
Image::size () const
{
	return _size;
}

bool
Image::aligned () const
{
	return _aligned;
}