Source file src/image/png/writer.go

Documentation: image/png

     1  // Copyright 2009 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  package png
     6  
     7  import (
     8  	"bufio"
     9  	"compress/zlib"
    10  	"encoding/binary"
    11  	"hash/crc32"
    12  	"image"
    13  	"image/color"
    14  	"io"
    15  	"strconv"
    16  )
    17  
    18  // Encoder configures encoding PNG images.
    19  type Encoder struct {
    20  	CompressionLevel CompressionLevel
    21  
    22  	// BufferPool optionally specifies a buffer pool to get temporary
    23  	// EncoderBuffers when encoding an image.
    24  	BufferPool EncoderBufferPool
    25  }
    26  
    27  // EncoderBufferPool is an interface for getting and returning temporary
    28  // instances of the EncoderBuffer struct. This can be used to reuse buffers
    29  // when encoding multiple images.
    30  type EncoderBufferPool interface {
    31  	Get() *EncoderBuffer
    32  	Put(*EncoderBuffer)
    33  }
    34  
    35  // EncoderBuffer holds the buffers used for encoding PNG images.
    36  type EncoderBuffer encoder
    37  
    38  type encoder struct {
    39  	enc     *Encoder
    40  	w       io.Writer
    41  	m       image.Image
    42  	cb      int
    43  	err     error
    44  	header  [8]byte
    45  	footer  [4]byte
    46  	tmp     [4 * 256]byte
    47  	cr      [nFilter][]uint8
    48  	pr      []uint8
    49  	zw      *zlib.Writer
    50  	zwLevel int
    51  	bw      *bufio.Writer
    52  }
    53  
    54  type CompressionLevel int
    55  
    56  const (
    57  	DefaultCompression CompressionLevel = 0
    58  	NoCompression      CompressionLevel = -1
    59  	BestSpeed          CompressionLevel = -2
    60  	BestCompression    CompressionLevel = -3
    61  
    62  	// Positive CompressionLevel values are reserved to mean a numeric zlib
    63  	// compression level, although that is not implemented yet.
    64  )
    65  
    66  type opaquer interface {
    67  	Opaque() bool
    68  }
    69  
    70  // Returns whether or not the image is fully opaque.
    71  func opaque(m image.Image) bool {
    72  	if o, ok := m.(opaquer); ok {
    73  		return o.Opaque()
    74  	}
    75  	b := m.Bounds()
    76  	for y := b.Min.Y; y < b.Max.Y; y++ {
    77  		for x := b.Min.X; x < b.Max.X; x++ {
    78  			_, _, _, a := m.At(x, y).RGBA()
    79  			if a != 0xffff {
    80  				return false
    81  			}
    82  		}
    83  	}
    84  	return true
    85  }
    86  
    87  // The absolute value of a byte interpreted as a signed int8.
    88  func abs8(d uint8) int {
    89  	if d < 128 {
    90  		return int(d)
    91  	}
    92  	return 256 - int(d)
    93  }
    94  
    95  func (e *encoder) writeChunk(b []byte, name string) {
    96  	if e.err != nil {
    97  		return
    98  	}
    99  	n := uint32(len(b))
   100  	if int(n) != len(b) {
   101  		e.err = UnsupportedError(name + " chunk is too large: " + strconv.Itoa(len(b)))
   102  		return
   103  	}
   104  	binary.BigEndian.PutUint32(e.header[:4], n)
   105  	e.header[4] = name[0]
   106  	e.header[5] = name[1]
   107  	e.header[6] = name[2]
   108  	e.header[7] = name[3]
   109  	crc := crc32.NewIEEE()
   110  	crc.Write(e.header[4:8])
   111  	crc.Write(b)
   112  	binary.BigEndian.PutUint32(e.footer[:4], crc.Sum32())
   113  
   114  	_, e.err = e.w.Write(e.header[:8])
   115  	if e.err != nil {
   116  		return
   117  	}
   118  	_, e.err = e.w.Write(b)
   119  	if e.err != nil {
   120  		return
   121  	}
   122  	_, e.err = e.w.Write(e.footer[:4])
   123  }
   124  
   125  func (e *encoder) writeIHDR() {
   126  	b := e.m.Bounds()
   127  	binary.BigEndian.PutUint32(e.tmp[0:4], uint32(b.Dx()))
   128  	binary.BigEndian.PutUint32(e.tmp[4:8], uint32(b.Dy()))
   129  	// Set bit depth and color type.
   130  	switch e.cb {
   131  	case cbG8:
   132  		e.tmp[8] = 8
   133  		e.tmp[9] = ctGrayscale
   134  	case cbTC8:
   135  		e.tmp[8] = 8
   136  		e.tmp[9] = ctTrueColor
   137  	case cbP8:
   138  		e.tmp[8] = 8
   139  		e.tmp[9] = ctPaletted
   140  	case cbP4:
   141  		e.tmp[8] = 4
   142  		e.tmp[9] = ctPaletted
   143  	case cbP2:
   144  		e.tmp[8] = 2
   145  		e.tmp[9] = ctPaletted
   146  	case cbP1:
   147  		e.tmp[8] = 1
   148  		e.tmp[9] = ctPaletted
   149  	case cbTCA8:
   150  		e.tmp[8] = 8
   151  		e.tmp[9] = ctTrueColorAlpha
   152  	case cbG16:
   153  		e.tmp[8] = 16
   154  		e.tmp[9] = ctGrayscale
   155  	case cbTC16:
   156  		e.tmp[8] = 16
   157  		e.tmp[9] = ctTrueColor
   158  	case cbTCA16:
   159  		e.tmp[8] = 16
   160  		e.tmp[9] = ctTrueColorAlpha
   161  	}
   162  	e.tmp[10] = 0 // default compression method
   163  	e.tmp[11] = 0 // default filter method
   164  	e.tmp[12] = 0 // non-interlaced
   165  	e.writeChunk(e.tmp[:13], "IHDR")
   166  }
   167  
   168  func (e *encoder) writePLTEAndTRNS(p color.Palette) {
   169  	if len(p) < 1 || len(p) > 256 {
   170  		e.err = FormatError("bad palette length: " + strconv.Itoa(len(p)))
   171  		return
   172  	}
   173  	last := -1
   174  	for i, c := range p {
   175  		c1 := color.NRGBAModel.Convert(c).(color.NRGBA)
   176  		e.tmp[3*i+0] = c1.R
   177  		e.tmp[3*i+1] = c1.G
   178  		e.tmp[3*i+2] = c1.B
   179  		if c1.A != 0xff {
   180  			last = i
   181  		}
   182  		e.tmp[3*256+i] = c1.A
   183  	}
   184  	e.writeChunk(e.tmp[:3*len(p)], "PLTE")
   185  	if last != -1 {
   186  		e.writeChunk(e.tmp[3*256:3*256+1+last], "tRNS")
   187  	}
   188  }
   189  
   190  // An encoder is an io.Writer that satisfies writes by writing PNG IDAT chunks,
   191  // including an 8-byte header and 4-byte CRC checksum per Write call. Such calls
   192  // should be relatively infrequent, since writeIDATs uses a bufio.Writer.
   193  //
   194  // This method should only be called from writeIDATs (via writeImage).
   195  // No other code should treat an encoder as an io.Writer.
   196  func (e *encoder) Write(b []byte) (int, error) {
   197  	e.writeChunk(b, "IDAT")
   198  	if e.err != nil {
   199  		return 0, e.err
   200  	}
   201  	return len(b), nil
   202  }
   203  
   204  // Chooses the filter to use for encoding the current row, and applies it.
   205  // The return value is the index of the filter and also of the row in cr that has had it applied.
   206  func filter(cr *[nFilter][]byte, pr []byte, bpp int) int {
   207  	// We try all five filter types, and pick the one that minimizes the sum of absolute differences.
   208  	// This is the same heuristic that libpng uses, although the filters are attempted in order of
   209  	// estimated most likely to be minimal (ftUp, ftPaeth, ftNone, ftSub, ftAverage), rather than
   210  	// in their enumeration order (ftNone, ftSub, ftUp, ftAverage, ftPaeth).
   211  	cdat0 := cr[0][1:]
   212  	cdat1 := cr[1][1:]
   213  	cdat2 := cr[2][1:]
   214  	cdat3 := cr[3][1:]
   215  	cdat4 := cr[4][1:]
   216  	pdat := pr[1:]
   217  	n := len(cdat0)
   218  
   219  	// The up filter.
   220  	sum := 0
   221  	for i := 0; i < n; i++ {
   222  		cdat2[i] = cdat0[i] - pdat[i]
   223  		sum += abs8(cdat2[i])
   224  	}
   225  	best := sum
   226  	filter := ftUp
   227  
   228  	// The Paeth filter.
   229  	sum = 0
   230  	for i := 0; i < bpp; i++ {
   231  		cdat4[i] = cdat0[i] - pdat[i]
   232  		sum += abs8(cdat4[i])
   233  	}
   234  	for i := bpp; i < n; i++ {
   235  		cdat4[i] = cdat0[i] - paeth(cdat0[i-bpp], pdat[i], pdat[i-bpp])
   236  		sum += abs8(cdat4[i])
   237  		if sum >= best {
   238  			break
   239  		}
   240  	}
   241  	if sum < best {
   242  		best = sum
   243  		filter = ftPaeth
   244  	}
   245  
   246  	// The none filter.
   247  	sum = 0
   248  	for i := 0; i < n; i++ {
   249  		sum += abs8(cdat0[i])
   250  		if sum >= best {
   251  			break
   252  		}
   253  	}
   254  	if sum < best {
   255  		best = sum
   256  		filter = ftNone
   257  	}
   258  
   259  	// The sub filter.
   260  	sum = 0
   261  	for i := 0; i < bpp; i++ {
   262  		cdat1[i] = cdat0[i]
   263  		sum += abs8(cdat1[i])
   264  	}
   265  	for i := bpp; i < n; i++ {
   266  		cdat1[i] = cdat0[i] - cdat0[i-bpp]
   267  		sum += abs8(cdat1[i])
   268  		if sum >= best {
   269  			break
   270  		}
   271  	}
   272  	if sum < best {
   273  		best = sum
   274  		filter = ftSub
   275  	}
   276  
   277  	// The average filter.
   278  	sum = 0
   279  	for i := 0; i < bpp; i++ {
   280  		cdat3[i] = cdat0[i] - pdat[i]/2
   281  		sum += abs8(cdat3[i])
   282  	}
   283  	for i := bpp; i < n; i++ {
   284  		cdat3[i] = cdat0[i] - uint8((int(cdat0[i-bpp])+int(pdat[i]))/2)
   285  		sum += abs8(cdat3[i])
   286  		if sum >= best {
   287  			break
   288  		}
   289  	}
   290  	if sum < best {
   291  		best = sum
   292  		filter = ftAverage
   293  	}
   294  
   295  	return filter
   296  }
   297  
   298  func zeroMemory(v []uint8) {
   299  	for i := range v {
   300  		v[i] = 0
   301  	}
   302  }
   303  
   304  func (e *encoder) writeImage(w io.Writer, m image.Image, cb int, level int) error {
   305  	if e.zw == nil || e.zwLevel != level {
   306  		zw, err := zlib.NewWriterLevel(w, level)
   307  		if err != nil {
   308  			return err
   309  		}
   310  		e.zw = zw
   311  		e.zwLevel = level
   312  	} else {
   313  		e.zw.Reset(w)
   314  	}
   315  	defer e.zw.Close()
   316  
   317  	bitsPerPixel := 0
   318  
   319  	switch cb {
   320  	case cbG8:
   321  		bitsPerPixel = 8
   322  	case cbTC8:
   323  		bitsPerPixel = 24
   324  	case cbP8:
   325  		bitsPerPixel = 8
   326  	case cbP4:
   327  		bitsPerPixel = 4
   328  	case cbP2:
   329  		bitsPerPixel = 2
   330  	case cbP1:
   331  		bitsPerPixel = 1
   332  	case cbTCA8:
   333  		bitsPerPixel = 32
   334  	case cbTC16:
   335  		bitsPerPixel = 48
   336  	case cbTCA16:
   337  		bitsPerPixel = 64
   338  	case cbG16:
   339  		bitsPerPixel = 16
   340  	}
   341  
   342  	// cr[*] and pr are the bytes for the current and previous row.
   343  	// cr[0] is unfiltered (or equivalently, filtered with the ftNone filter).
   344  	// cr[ft], for non-zero filter types ft, are buffers for transforming cr[0] under the
   345  	// other PNG filter types. These buffers are allocated once and re-used for each row.
   346  	// The +1 is for the per-row filter type, which is at cr[*][0].
   347  	b := m.Bounds()
   348  	sz := 1 + (bitsPerPixel*b.Dx()+7)/8
   349  	for i := range e.cr {
   350  		if cap(e.cr[i]) < sz {
   351  			e.cr[i] = make([]uint8, sz)
   352  		} else {
   353  			e.cr[i] = e.cr[i][:sz]
   354  		}
   355  		e.cr[i][0] = uint8(i)
   356  	}
   357  	cr := e.cr
   358  	if cap(e.pr) < sz {
   359  		e.pr = make([]uint8, sz)
   360  	} else {
   361  		e.pr = e.pr[:sz]
   362  		zeroMemory(e.pr)
   363  	}
   364  	pr := e.pr
   365  
   366  	gray, _ := m.(*image.Gray)
   367  	rgba, _ := m.(*image.RGBA)
   368  	paletted, _ := m.(*image.Paletted)
   369  	nrgba, _ := m.(*image.NRGBA)
   370  
   371  	for y := b.Min.Y; y < b.Max.Y; y++ {
   372  		// Convert from colors to bytes.
   373  		i := 1
   374  		switch cb {
   375  		case cbG8:
   376  			if gray != nil {
   377  				offset := (y - b.Min.Y) * gray.Stride
   378  				copy(cr[0][1:], gray.Pix[offset:offset+b.Dx()])
   379  			} else {
   380  				for x := b.Min.X; x < b.Max.X; x++ {
   381  					c := color.GrayModel.Convert(m.At(x, y)).(color.Gray)
   382  					cr[0][i] = c.Y
   383  					i++
   384  				}
   385  			}
   386  		case cbTC8:
   387  			// We have previously verified that the alpha value is fully opaque.
   388  			cr0 := cr[0]
   389  			stride, pix := 0, []byte(nil)
   390  			if rgba != nil {
   391  				stride, pix = rgba.Stride, rgba.Pix
   392  			} else if nrgba != nil {
   393  				stride, pix = nrgba.Stride, nrgba.Pix
   394  			}
   395  			if stride != 0 {
   396  				j0 := (y - b.Min.Y) * stride
   397  				j1 := j0 + b.Dx()*4
   398  				for j := j0; j < j1; j += 4 {
   399  					cr0[i+0] = pix[j+0]
   400  					cr0[i+1] = pix[j+1]
   401  					cr0[i+2] = pix[j+2]
   402  					i += 3
   403  				}
   404  			} else {
   405  				for x := b.Min.X; x < b.Max.X; x++ {
   406  					r, g, b, _ := m.At(x, y).RGBA()
   407  					cr0[i+0] = uint8(r >> 8)
   408  					cr0[i+1] = uint8(g >> 8)
   409  					cr0[i+2] = uint8(b >> 8)
   410  					i += 3
   411  				}
   412  			}
   413  		case cbP8:
   414  			if paletted != nil {
   415  				offset := (y - b.Min.Y) * paletted.Stride
   416  				copy(cr[0][1:], paletted.Pix[offset:offset+b.Dx()])
   417  			} else {
   418  				pi := m.(image.PalettedImage)
   419  				for x := b.Min.X; x < b.Max.X; x++ {
   420  					cr[0][i] = pi.ColorIndexAt(x, y)
   421  					i += 1
   422  				}
   423  			}
   424  
   425  		case cbP4, cbP2, cbP1:
   426  			pi := m.(image.PalettedImage)
   427  
   428  			var a uint8
   429  			var c int
   430  			for x := b.Min.X; x < b.Max.X; x++ {
   431  				a = a<<uint(bitsPerPixel) | pi.ColorIndexAt(x, y)
   432  				c++
   433  				if c == 8/bitsPerPixel {
   434  					cr[0][i] = a
   435  					i += 1
   436  					a = 0
   437  					c = 0
   438  				}
   439  			}
   440  			if c != 0 {
   441  				for c != 8/bitsPerPixel {
   442  					a = a << uint(bitsPerPixel)
   443  					c++
   444  				}
   445  				cr[0][i] = a
   446  			}
   447  
   448  		case cbTCA8:
   449  			if nrgba != nil {
   450  				offset := (y - b.Min.Y) * nrgba.Stride
   451  				copy(cr[0][1:], nrgba.Pix[offset:offset+b.Dx()*4])
   452  			} else {
   453  				// Convert from image.Image (which is alpha-premultiplied) to PNG's non-alpha-premultiplied.
   454  				for x := b.Min.X; x < b.Max.X; x++ {
   455  					c := color.NRGBAModel.Convert(m.At(x, y)).(color.NRGBA)
   456  					cr[0][i+0] = c.R
   457  					cr[0][i+1] = c.G
   458  					cr[0][i+2] = c.B
   459  					cr[0][i+3] = c.A
   460  					i += 4
   461  				}
   462  			}
   463  		case cbG16:
   464  			for x := b.Min.X; x < b.Max.X; x++ {
   465  				c := color.Gray16Model.Convert(m.At(x, y)).(color.Gray16)
   466  				cr[0][i+0] = uint8(c.Y >> 8)
   467  				cr[0][i+1] = uint8(c.Y)
   468  				i += 2
   469  			}
   470  		case cbTC16:
   471  			// We have previously verified that the alpha value is fully opaque.
   472  			for x := b.Min.X; x < b.Max.X; x++ {
   473  				r, g, b, _ := m.At(x, y).RGBA()
   474  				cr[0][i+0] = uint8(r >> 8)
   475  				cr[0][i+1] = uint8(r)
   476  				cr[0][i+2] = uint8(g >> 8)
   477  				cr[0][i+3] = uint8(g)
   478  				cr[0][i+4] = uint8(b >> 8)
   479  				cr[0][i+5] = uint8(b)
   480  				i += 6
   481  			}
   482  		case cbTCA16:
   483  			// Convert from image.Image (which is alpha-premultiplied) to PNG's non-alpha-premultiplied.
   484  			for x := b.Min.X; x < b.Max.X; x++ {
   485  				c := color.NRGBA64Model.Convert(m.At(x, y)).(color.NRGBA64)
   486  				cr[0][i+0] = uint8(c.R >> 8)
   487  				cr[0][i+1] = uint8(c.R)
   488  				cr[0][i+2] = uint8(c.G >> 8)
   489  				cr[0][i+3] = uint8(c.G)
   490  				cr[0][i+4] = uint8(c.B >> 8)
   491  				cr[0][i+5] = uint8(c.B)
   492  				cr[0][i+6] = uint8(c.A >> 8)
   493  				cr[0][i+7] = uint8(c.A)
   494  				i += 8
   495  			}
   496  		}
   497  
   498  		// Apply the filter.
   499  		// Skip filter for NoCompression and paletted images (cbP8) as
   500  		// "filters are rarely useful on palette images" and will result
   501  		// in larger files (see http://www.libpng.org/pub/png/book/chapter09.html).
   502  		f := ftNone
   503  		if level != zlib.NoCompression && cb != cbP8 && cb != cbP4 && cb != cbP2 && cb != cbP1 {
   504  			// Since we skip paletted images we don't have to worry about
   505  			// bitsPerPixel not being a multiple of 8
   506  			bpp := bitsPerPixel / 8
   507  			f = filter(&cr, pr, bpp)
   508  		}
   509  
   510  		// Write the compressed bytes.
   511  		if _, err := e.zw.Write(cr[f]); err != nil {
   512  			return err
   513  		}
   514  
   515  		// The current row for y is the previous row for y+1.
   516  		pr, cr[0] = cr[0], pr
   517  	}
   518  	return nil
   519  }
   520  
   521  // Write the actual image data to one or more IDAT chunks.
   522  func (e *encoder) writeIDATs() {
   523  	if e.err != nil {
   524  		return
   525  	}
   526  	if e.bw == nil {
   527  		e.bw = bufio.NewWriterSize(e, 1<<15)
   528  	} else {
   529  		e.bw.Reset(e)
   530  	}
   531  	e.err = e.writeImage(e.bw, e.m, e.cb, levelToZlib(e.enc.CompressionLevel))
   532  	if e.err != nil {
   533  		return
   534  	}
   535  	e.err = e.bw.Flush()
   536  }
   537  
   538  // This function is required because we want the zero value of
   539  // Encoder.CompressionLevel to map to zlib.DefaultCompression.
   540  func levelToZlib(l CompressionLevel) int {
   541  	switch l {
   542  	case DefaultCompression:
   543  		return zlib.DefaultCompression
   544  	case NoCompression:
   545  		return zlib.NoCompression
   546  	case BestSpeed:
   547  		return zlib.BestSpeed
   548  	case BestCompression:
   549  		return zlib.BestCompression
   550  	default:
   551  		return zlib.DefaultCompression
   552  	}
   553  }
   554  
   555  func (e *encoder) writeIEND() { e.writeChunk(nil, "IEND") }
   556  
   557  // Encode writes the Image m to w in PNG format. Any Image may be
   558  // encoded, but images that are not image.NRGBA might be encoded lossily.
   559  func Encode(w io.Writer, m image.Image) error {
   560  	var e Encoder
   561  	return e.Encode(w, m)
   562  }
   563  
   564  // Encode writes the Image m to w in PNG format.
   565  func (enc *Encoder) Encode(w io.Writer, m image.Image) error {
   566  	// Obviously, negative widths and heights are invalid. Furthermore, the PNG
   567  	// spec section 11.2.2 says that zero is invalid. Excessively large images are
   568  	// also rejected.
   569  	mw, mh := int64(m.Bounds().Dx()), int64(m.Bounds().Dy())
   570  	if mw <= 0 || mh <= 0 || mw >= 1<<32 || mh >= 1<<32 {
   571  		return FormatError("invalid image size: " + strconv.FormatInt(mw, 10) + "x" + strconv.FormatInt(mh, 10))
   572  	}
   573  
   574  	var e *encoder
   575  	if enc.BufferPool != nil {
   576  		buffer := enc.BufferPool.Get()
   577  		e = (*encoder)(buffer)
   578  
   579  	}
   580  	if e == nil {
   581  		e = &encoder{}
   582  	}
   583  	if enc.BufferPool != nil {
   584  		defer enc.BufferPool.Put((*EncoderBuffer)(e))
   585  	}
   586  
   587  	e.enc = enc
   588  	e.w = w
   589  	e.m = m
   590  
   591  	var pal color.Palette
   592  	// cbP8 encoding needs PalettedImage's ColorIndexAt method.
   593  	if _, ok := m.(image.PalettedImage); ok {
   594  		pal, _ = m.ColorModel().(color.Palette)
   595  	}
   596  	if pal != nil {
   597  		if len(pal) <= 2 {
   598  			e.cb = cbP1
   599  		} else if len(pal) <= 4 {
   600  			e.cb = cbP2
   601  		} else if len(pal) <= 16 {
   602  			e.cb = cbP4
   603  		} else {
   604  			e.cb = cbP8
   605  		}
   606  	} else {
   607  		switch m.ColorModel() {
   608  		case color.GrayModel:
   609  			e.cb = cbG8
   610  		case color.Gray16Model:
   611  			e.cb = cbG16
   612  		case color.RGBAModel, color.NRGBAModel, color.AlphaModel:
   613  			if opaque(m) {
   614  				e.cb = cbTC8
   615  			} else {
   616  				e.cb = cbTCA8
   617  			}
   618  		default:
   619  			if opaque(m) {
   620  				e.cb = cbTC16
   621  			} else {
   622  				e.cb = cbTCA16
   623  			}
   624  		}
   625  	}
   626  
   627  	_, e.err = io.WriteString(w, pngHeader)
   628  	e.writeIHDR()
   629  	if pal != nil {
   630  		e.writePLTEAndTRNS(pal)
   631  	}
   632  	e.writeIDATs()
   633  	e.writeIEND()
   634  	return e.err
   635  }
   636  

View as plain text