src/lib/image.cc

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/image.cc
  21  *  @brief A class to describe a video image.
  22  */
  23
  24 #include <iostream>
  25 extern "C" {
  26 #include <libswscale/swscale.h>
  27 #include <libavutil/pixfmt.h>
  28 #include <libavutil/pixdesc.h>
  29 }
  30 #include "image.h"
  31 #include "exceptions.h"
  32 #include "scaler.h"
  33 #include "timer.h"
  34
  35 #include "i18n.h"
  36
  37 using std::string;
  38 using std::min;
  39 using std::cout;
  40 using std::cerr;
  41 using boost::shared_ptr;
  42 using dcp::Size;
  43
  44 int
  45 Image::line_factor (int n) const
  46 {
  47         if (n == 0) {
  48                 return 1;
  49         }
  50
  51         AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
  52         if (!d) {
  53                 throw PixelFormatError ("lines()", _pixel_format);
  54         }
  55
  56         return pow (2.0f, d->log2_chroma_h);
  57 }
  58
  59 /** @param n Component index.
  60  *  @return Number of lines in the image for the given component.
  61  */
  62 int
  63 Image::lines (int n) const
  64 {
  65         return rint (ceil (static_cast<double>(size().height) / line_factor (n)));
  66 }
  67
  68 /** @return Number of components */
  69 int
  70 Image::components () const
  71 {
  72         AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
  73         if (!d) {
  74                 throw PixelFormatError ("components()", _pixel_format);
  75         }
  76
  77         if ((d->flags & PIX_FMT_PLANAR) == 0) {
  78                 return 1;
  79         }
  80
  81         return d->nb_components;
  82 }
  83
  84 /** Crop this image, scale it to `inter_size' and then place it in a black frame of `out_size' */
  85 shared_ptr<Image>
  86 Image::crop_scale_window (Crop crop, dcp::Size inter_size, dcp::Size out_size, Scaler const * scaler, AVPixelFormat out_format, bool out_aligned) const
  87 {
  88         assert (scaler);
  89         /* Empirical testing suggests that sws_scale() will crash if
  90            the input image is not aligned.
  91         */
  92         assert (aligned ());
  93
  94         assert (out_size.width >= inter_size.width);
  95         assert (out_size.height >= inter_size.height);
  96
  97         /* Here's an image of out_size */
  98         shared_ptr<Image> out (new Image (out_format, out_size, out_aligned));
  99         out->make_black ();
 100
 101         /* Size of the image after any crop */
 102         dcp::Size const cropped_size = crop.apply (size ());
 103
 104         /* Scale context for a scale from cropped_size to inter_size */
 105         struct SwsContext* scale_context = sws_getContext (
 106                         cropped_size.width, cropped_size.height, pixel_format(),
 107                         inter_size.width, inter_size.height, out_format,
 108                         scaler->ffmpeg_id (), 0, 0, 0
 109                 );
 110
 111         if (!scale_context) {
 112                 throw StringError (N_("Could not allocate SwsContext"));
 113         }
 114
 115         /* Prepare input data pointers with crop */
 116         uint8_t* scale_in_data[components()];
 117         for (int c = 0; c < components(); ++c) {
 118                 scale_in_data[c] = data()[c] + int (rint (bytes_per_pixel(c) * crop.left)) + stride()[c] * (crop.top / line_factor(c));
 119         }
 120
 121         /* Corner of the image within out_size */
 122         Position<int> const corner ((out_size.width - inter_size.width) / 2, (out_size.height - inter_size.height) / 2);
 123
 124         uint8_t* scale_out_data[out->components()];
 125         for (int c = 0; c < out->components(); ++c) {
 126                 scale_out_data[c] = out->data()[c] + int (rint (out->bytes_per_pixel(c) * corner.x)) + out->stride()[c] * corner.y;
 127         }
 128
 129         sws_scale (
 130                 scale_context,
 131                 scale_in_data, stride(),
 132                 0, cropped_size.height,
 133                 scale_out_data, out->stride()
 134                 );
 135
 136         sws_freeContext (scale_context);
 137
 138         return out;
 139 }
 140
 141 shared_ptr<Image>
 142 Image::scale (dcp::Size out_size, Scaler const * scaler, AVPixelFormat out_format, bool out_aligned) const
 143 {
 144         assert (scaler);
 145         /* Empirical testing suggests that sws_scale() will crash if
 146            the input image is not aligned.
 147         */
 148         assert (aligned ());
 149
 150         shared_ptr<Image> scaled (new Image (out_format, out_size, out_aligned));
 151
 152         struct SwsContext* scale_context = sws_getContext (
 153                 size().width, size().height, pixel_format(),
 154                 out_size.width, out_size.height, out_format,
 155                 scaler->ffmpeg_id (), 0, 0, 0
 156                 );
 157
 158         sws_scale (
 159                 scale_context,
 160                 data(), stride(),
 161                 0, size().height,
 162                 scaled->data(), scaled->stride()
 163                 );
 164
 165         sws_freeContext (scale_context);
 166
 167         return scaled;
 168 }
 169
 170 shared_ptr<Image>
 171 Image::crop (Crop crop, bool aligned) const
 172 {
 173         dcp::Size cropped_size = crop.apply (size ());
 174         shared_ptr<Image> out (new Image (pixel_format(), cropped_size, aligned));
 175
 176         for (int c = 0; c < components(); ++c) {
 177                 int const crop_left_in_bytes = bytes_per_pixel(c) * crop.left;
 178                 /* bytes_per_pixel() could be a fraction; in this case the stride will be rounded
 179                    up, and we need to make sure that we copy over the width (up to the stride)
 180                    rather than short of the width; hence the ceil() here.
 181                 */
 182                 int const cropped_width_in_bytes = ceil (bytes_per_pixel(c) * cropped_size.width);
 183
 184                 /* Start of the source line, cropped from the top but not the left */
 185                 uint8_t* in_p = data()[c] + (crop.top / out->line_factor(c)) * stride()[c];
 186                 uint8_t* out_p = out->data()[c];
 187
 188                 for (int y = 0; y < out->lines(c); ++y) {
 189                         memcpy (out_p, in_p + crop_left_in_bytes, cropped_width_in_bytes);
 190                         in_p += stride()[c];
 191                         out_p += out->stride()[c];
 192                 }
 193         }
 194
 195         return out;
 196 }
 197
 198 /** Blacken a YUV image whose bits per pixel is rounded up to 16 */
 199 void
 200 Image::yuv_16_black (uint16_t v, bool alpha)
 201 {
 202         memset (data()[0], 0, lines(0) * stride()[0]);
 203         for (int i = 1; i < 3; ++i) {
 204                 int16_t* p = reinterpret_cast<int16_t*> (data()[i]);
 205                 for (int y = 0; y < lines(i); ++y) {
 206                         /* We divide by 2 here because we are writing 2 bytes at a time */
 207                         for (int x = 0; x < line_size()[i] / 2; ++x) {
 208                                 p[x] = v;
 209                         }
 210                         p += stride()[i] / 2;
 211                 }
 212         }
 213
 214         if (alpha) {
 215                 memset (data()[3], 0, lines(3) * stride()[3]);
 216         }
 217 }
 218
 219 uint16_t
 220 Image::swap_16 (uint16_t v)
 221 {
 222         return ((v >> 8) & 0xff) | ((v & 0xff) << 8);
 223 }
 224
 225 void
 226 Image::make_black ()
 227 {
 228         /* U/V black value for 8-bit colour */
 229         static uint8_t const eight_bit_uv =     (1 << 7) - 1;
 230         /* U/V black value for 9-bit colour */
 231         static uint16_t const nine_bit_uv =     (1 << 8) - 1;
 232         /* U/V black value for 10-bit colour */
 233         static uint16_t const ten_bit_uv =      (1 << 9) - 1;
 234         /* U/V black value for 16-bit colour */
 235         static uint16_t const sixteen_bit_uv =  (1 << 15) - 1;
 236
 237         switch (_pixel_format) {
 238         case PIX_FMT_YUV420P:
 239         case PIX_FMT_YUV422P:
 240         case PIX_FMT_YUV444P:
 241         case PIX_FMT_YUV411P:
 242                 memset (data()[0], 0, lines(0) * stride()[0]);
 243                 memset (data()[1], eight_bit_uv, lines(1) * stride()[1]);
 244                 memset (data()[2], eight_bit_uv, lines(2) * stride()[2]);
 245                 break;
 246
 247         case PIX_FMT_YUVJ420P:
 248         case PIX_FMT_YUVJ422P:
 249         case PIX_FMT_YUVJ444P:
 250                 memset (data()[0], 0, lines(0) * stride()[0]);
 251                 memset (data()[1], eight_bit_uv + 1, lines(1) * stride()[1]);
 252                 memset (data()[2], eight_bit_uv + 1, lines(2) * stride()[2]);
 253                 break;
 254
 255         case PIX_FMT_YUV422P9LE:
 256         case PIX_FMT_YUV444P9LE:
 257                 yuv_16_black (nine_bit_uv, false);
 258                 break;
 259
 260         case PIX_FMT_YUV422P9BE:
 261         case PIX_FMT_YUV444P9BE:
 262                 yuv_16_black (swap_16 (nine_bit_uv), false);
 263                 break;
 264
 265         case PIX_FMT_YUV422P10LE:
 266         case PIX_FMT_YUV444P10LE:
 267                 yuv_16_black (ten_bit_uv, false);
 268                 break;
 269
 270         case PIX_FMT_YUV422P16LE:
 271         case PIX_FMT_YUV444P16LE:
 272                 yuv_16_black (sixteen_bit_uv, false);
 273                 break;
 274
 275         case PIX_FMT_YUV444P10BE:
 276         case PIX_FMT_YUV422P10BE:
 277                 yuv_16_black (swap_16 (ten_bit_uv), false);
 278                 break;
 279
 280         case AV_PIX_FMT_YUVA420P9BE:
 281         case AV_PIX_FMT_YUVA422P9BE:
 282         case AV_PIX_FMT_YUVA444P9BE:
 283                 yuv_16_black (swap_16 (nine_bit_uv), true);
 284                 break;
 285
 286         case AV_PIX_FMT_YUVA420P9LE:
 287         case AV_PIX_FMT_YUVA422P9LE:
 288         case AV_PIX_FMT_YUVA444P9LE:
 289                 yuv_16_black (nine_bit_uv, true);
 290                 break;
 291
 292         case AV_PIX_FMT_YUVA420P10BE:
 293         case AV_PIX_FMT_YUVA422P10BE:
 294         case AV_PIX_FMT_YUVA444P10BE:
 295                 yuv_16_black (swap_16 (ten_bit_uv), true);
 296                 break;
 297
 298         case AV_PIX_FMT_YUVA420P10LE:
 299         case AV_PIX_FMT_YUVA422P10LE:
 300         case AV_PIX_FMT_YUVA444P10LE:
 301                 yuv_16_black (ten_bit_uv, true);
 302                 break;
 303
 304         case AV_PIX_FMT_YUVA420P16BE:
 305         case AV_PIX_FMT_YUVA422P16BE:
 306         case AV_PIX_FMT_YUVA444P16BE:
 307                 yuv_16_black (swap_16 (sixteen_bit_uv), true);
 308                 break;
 309
 310         case AV_PIX_FMT_YUVA420P16LE:
 311         case AV_PIX_FMT_YUVA422P16LE:
 312         case AV_PIX_FMT_YUVA444P16LE:
 313                 yuv_16_black (sixteen_bit_uv, true);
 314                 break;
 315
 316         case PIX_FMT_RGB24:
 317         case PIX_FMT_ARGB:
 318         case PIX_FMT_RGBA:
 319         case PIX_FMT_ABGR:
 320         case PIX_FMT_BGRA:
 321                 memset (data()[0], 0, lines(0) * stride()[0]);
 322                 break;
 323
 324         case PIX_FMT_UYVY422:
 325         {
 326                 int const Y = lines(0);
 327                 int const X = line_size()[0];
 328                 uint8_t* p = data()[0];
 329                 for (int y = 0; y < Y; ++y) {
 330                         for (int x = 0; x < X / 4; ++x) {
 331                                 *p++ = eight_bit_uv; // Cb
 332                                 *p++ = 0;            // Y0
 333                                 *p++ = eight_bit_uv; // Cr
 334                                 *p++ = 0;            // Y1
 335                         }
 336                 }
 337                 break;
 338         }
 339
 340         default:
 341                 throw PixelFormatError ("make_black()", _pixel_format);
 342         }
 343 }
 344
 345 void
 346 Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
 347 {
 348         int this_bpp = 0;
 349         int other_bpp = 0;
 350
 351         if (_pixel_format == PIX_FMT_BGRA && other->pixel_format() == PIX_FMT_RGBA) {
 352                 this_bpp = 4;
 353                 other_bpp = 4;
 354         } else if (_pixel_format == PIX_FMT_RGB24 && other->pixel_format() == PIX_FMT_RGBA) {
 355                 this_bpp = 3;
 356                 other_bpp = 4;
 357         } else {
 358                 assert (false);
 359         }
 360
 361         int start_tx = position.x;
 362         int start_ox = 0;
 363
 364         if (start_tx < 0) {
 365                 start_ox = -start_tx;
 366                 start_tx = 0;
 367         }
 368
 369         int start_ty = position.y;
 370         int start_oy = 0;
 371
 372         if (start_ty < 0) {
 373                 start_oy = -start_ty;
 374                 start_ty = 0;
 375         }
 376
 377         for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 378                 uint8_t* tp = data()[0] + ty * stride()[0] + position.x * this_bpp;
 379                 uint8_t* op = other->data()[0] + oy * other->stride()[0];
 380                 for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 381                         float const alpha = float (op[3]) / 255;
 382                         tp[0] = (tp[0] * (1 - alpha)) + op[0] * alpha;
 383                         tp[1] = (tp[1] * (1 - alpha)) + op[1] * alpha;
 384                         tp[2] = (tp[2] * (1 - alpha)) + op[2] * alpha;
 385                         tp += this_bpp;
 386                         op += other_bpp;
 387                 }
 388         }
 389 }
 390
 391 void
 392 Image::copy (shared_ptr<const Image> other, Position<int> position)
 393 {
 394         /* Only implemented for RGB24 onto RGB24 so far */
 395         assert (_pixel_format == PIX_FMT_RGB24 && other->pixel_format() == PIX_FMT_RGB24);
 396         assert (position.x >= 0 && position.y >= 0);
 397
 398         int const N = min (position.x + other->size().width, size().width) - position.x;
 399         for (int ty = position.y, oy = 0; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 400                 uint8_t * const tp = data()[0] + ty * stride()[0] + position.x * 3;
 401                 uint8_t * const op = other->data()[0] + oy * other->stride()[0];
 402                 memcpy (tp, op, N * 3);
 403         }
 404 }
 405
 406 void
 407 Image::read_from_socket (shared_ptr<Socket> socket)
 408 {
 409         for (int i = 0; i < components(); ++i) {
 410                 uint8_t* p = data()[i];
 411                 for (int y = 0; y < lines(i); ++y) {
 412                         socket->read (p, line_size()[i]);
 413                         p += stride()[i];
 414                 }
 415         }
 416 }
 417
 418 void
 419 Image::write_to_socket (shared_ptr<Socket> socket) const
 420 {
 421         for (int i = 0; i < components(); ++i) {
 422                 uint8_t* p = data()[i];
 423                 for (int y = 0; y < lines(i); ++y) {
 424                         socket->write (p, line_size()[i]);
 425                         p += stride()[i];
 426                 }
 427         }
 428 }
 429
 430
 431 float
 432 Image::bytes_per_pixel (int c) const
 433 {
 434         AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
 435         if (!d) {
 436                 throw PixelFormatError ("lines()", _pixel_format);
 437         }
 438
 439         if (c >= components()) {
 440                 return 0;
 441         }
 442
 443         float bpp[4] = { 0, 0, 0, 0 };
 444
 445         bpp[0] = floor ((d->comp[0].depth_minus1 + 1 + 7) / 8);
 446         if (d->nb_components > 1) {
 447                 bpp[1] = floor ((d->comp[1].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
 448         }
 449         if (d->nb_components > 2) {
 450                 bpp[2] = floor ((d->comp[2].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
 451         }
 452         if (d->nb_components > 3) {
 453                 bpp[3] = floor ((d->comp[3].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
 454         }
 455
 456         if ((d->flags & PIX_FMT_PLANAR) == 0) {
 457                 /* Not planar; sum them up */
 458                 return bpp[0] + bpp[1] + bpp[2] + bpp[3];
 459         }
 460
 461         return bpp[c];
 462 }
 463
 464 /** Construct a Image of a given size and format, allocating memory
 465  *  as required.
 466  *
 467  *  @param p Pixel format.
 468  *  @param s Size in pixels.
 469  */
 470 Image::Image (AVPixelFormat p, dcp::Size s, bool aligned)
 471         : dcp::Image (s)
 472         , _pixel_format (p)
 473         , _aligned (aligned)
 474 {
 475         allocate ();
 476 }
 477
 478 void
 479 Image::allocate ()
 480 {
 481         _data = (uint8_t **) wrapped_av_malloc (4 * sizeof (uint8_t *));
 482         _data[0] = _data[1] = _data[2] = _data[3] = 0;
 483
 484         _line_size = (int *) wrapped_av_malloc (4 * sizeof (int));
 485         _line_size[0] = _line_size[1] = _line_size[2] = _line_size[3] = 0;
 486
 487         _stride = (int *) wrapped_av_malloc (4 * sizeof (int));
 488         _stride[0] = _stride[1] = _stride[2] = _stride[3] = 0;
 489
 490         for (int i = 0; i < components(); ++i) {
 491                 _line_size[i] = ceil (_size.width * bytes_per_pixel(i));
 492                 _stride[i] = stride_round_up (i, _line_size, _aligned ? 32 : 1);
 493
 494                 /* The assembler function ff_rgb24ToY_avx (in libswscale/x86/input.asm)
 495                    uses a 16-byte fetch to read three bytes (R/G/B) of image data.
 496                    Hence on the last pixel of the last line it reads over the end of
 497                    the actual data by 1 byte.  If the width of an image is a multiple
 498                    of the stride alignment there will be no padding at the end of image lines.
 499                    OS X crashes on this illegal read, though other operating systems don't
 500                    seem to mind.  The nasty + 1 in this malloc makes sure there is always a byte
 501                    for that instruction to read safely.
 502                 */
 503                 _data[i] = (uint8_t *) wrapped_av_malloc (_stride[i] * lines (i) + 1);
 504         }
 505 }
 506
 507 Image::Image (Image const & other)
 508         : dcp::Image (other)
 509         ,  _pixel_format (other._pixel_format)
 510         , _aligned (other._aligned)
 511 {
 512         allocate ();
 513
 514         for (int i = 0; i < components(); ++i) {
 515                 uint8_t* p = _data[i];
 516                 uint8_t* q = other._data[i];
 517                 for (int j = 0; j < lines(i); ++j) {
 518                         memcpy (p, q, _line_size[i]);
 519                         p += stride()[i];
 520                         q += other.stride()[i];
 521                 }
 522         }
 523 }
 524
 525 Image::Image (AVFrame* frame)
 526         : dcp::Image (dcp::Size (frame->width, frame->height))
 527         , _pixel_format (static_cast<AVPixelFormat> (frame->format))
 528         , _aligned (true)
 529 {
 530         allocate ();
 531
 532         for (int i = 0; i < components(); ++i) {
 533                 uint8_t* p = _data[i];
 534                 uint8_t* q = frame->data[i];
 535                 for (int j = 0; j < lines(i); ++j) {
 536                         memcpy (p, q, _line_size[i]);
 537                         p += stride()[i];
 538                         /* AVFrame's linesize is what we call `stride' */
 539                         q += frame->linesize[i];
 540                 }
 541         }
 542 }
 543
 544 Image::Image (shared_ptr<const Image> other, bool aligned)
 545         : dcp::Image (other)
 546         , _pixel_format (other->_pixel_format)
 547         , _aligned (aligned)
 548 {
 549         allocate ();
 550
 551         for (int i = 0; i < components(); ++i) {
 552                 assert(line_size()[i] == other->line_size()[i]);
 553                 uint8_t* p = _data[i];
 554                 uint8_t* q = other->data()[i];
 555                 for (int j = 0; j < lines(i); ++j) {
 556                         memcpy (p, q, line_size()[i]);
 557                         p += stride()[i];
 558                         q += other->stride()[i];
 559                 }
 560         }
 561 }
 562
 563 Image&
 564 Image::operator= (Image const & other)
 565 {
 566         if (this == &other) {
 567                 return *this;
 568         }
 569
 570         Image tmp (other);
 571         swap (tmp);
 572         return *this;
 573 }
 574
 575 void
 576 Image::swap (Image & other)
 577 {
 578         dcp::Image::swap (other);
 579
 580         std::swap (_pixel_format, other._pixel_format);
 581
 582         for (int i = 0; i < 4; ++i) {
 583                 std::swap (_data[i], other._data[i]);
 584                 std::swap (_line_size[i], other._line_size[i]);
 585                 std::swap (_stride[i], other._stride[i]);
 586         }
 587
 588         std::swap (_aligned, other._aligned);
 589 }
 590
 591 /** Destroy a Image */
 592 Image::~Image ()
 593 {
 594         for (int i = 0; i < components(); ++i) {
 595                 av_free (_data[i]);
 596         }
 597
 598         av_free (_data);
 599         av_free (_line_size);
 600         av_free (_stride);
 601 }
 602
 603 uint8_t **
 604 Image::data () const
 605 {
 606         return _data;
 607 }
 608
 609 int *
 610 Image::line_size () const
 611 {
 612         return _line_size;
 613 }
 614
 615 int *
 616 Image::stride () const
 617 {
 618         return _stride;
 619 }
 620
 621 dcp::Size
 622 Image::size () const
 623 {
 624         return _size;
 625 }
 626
 627 bool
 628 Image::aligned () const
 629 {
 630         return _aligned;
 631 }
 632