Allow users to set output intent

Author: liZe

tests/test_api.py

@@ -612,15 +612,21 @@ def test_partial_pdf_custom_metadata():
 
 
 @assert_no_logs
-def test_pdf_srgb():
-    stdout = _run('--srgb --uncompressed-pdf - -', b'test')
+def test_output_intent():
+    stdout = _run(
+        '--uncompressed-pdf --output-intent="sRGB" - -',
+        b'<div style="color: red">test')
     assert b'sRGB' in stdout
 
 
 @assert_no_logs
-def test_pdf_no_srgb():
-    stdout = _run('--uncompressed-pdf - -', b'test')
-    assert b'sRGB' not in stdout
+def test_output_intent_device_cmyk():
+    stdout = _run('--uncompressed-pdf - -', b''.join((
+        b'<style>@color-profile device-cmyk { src: url(',
+        path2url(resource_path('cmyk.icc')).encode(),
+        b'); components: c, m, y, k }</style>',
+        b'<div style="color: device-cmyk(1 0 0 0)">test')))
+    assert b'OutputIntents' in stdout
 
 
 @assert_no_logs

tests/test_pdf.py

@@ -537,7 +537,7 @@ def test_embed_images_from_pages():
     document = Document(
         (page1, page2), metadata=DocumentMetadata(),
         font_config=FontConfiguration(), color_profiles={},
-        url_fetcher=None).write_pdf()
+        url_fetcher=None, output_intent=None).write_pdf()
     assert document.count(b'/Filter /DCTDecode') == 2
 
 

weasyprint/__init__.py

@@ -46,9 +46,8 @@
 #:     Whether custom HTML metadata should be stored in the generated PDF.
 #: :param bool presentational_hints:
 #:     Whether HTML presentational hints are followed.
-#: :param bool srgb:
-#:     Whether sRGB color profile should be included and set as default for
-#:     device-dependant RGB colors.
+#: :param string output_intent:
+#:     CSS identifier or registered name of the output intent color space.
 #: :param bool optimize_images:
 #:     Whether size of embedded images should be optimized, with no quality
 #:     loss.
@@ -77,7 +76,7 @@
     'xmp_metadata': None,
     'custom_metadata': False,
     'presentational_hints': False,
-    'srgb': False,
+    'output_intent': None,
     'optimize_images': False,
     'jpeg_quality': None,
     'dpi': None,

weasyprint/__main__.py

@@ -114,10 +114,12 @@ def docstring(self):
 group.add_argument(
     '--custom-metadata', action='store_true',
     help='include custom HTML meta tags in PDF metadata')
+group.add_argument(
+    '--output-intent',
+    help='CSS identifier or registered name of the output intent color space')
 group.add_argument(
     '-p', '--presentational-hints', action='store_true',
     help='follow HTML presentational hints')
-group.add_argument('--srgb', action='store_true', help='include sRGB color profile')
 group.add_argument(
     '--optimize-images', action='store_true',
     help='optimize size of embedded images with no quality loss')

weasyprint/css/__init__.py

@@ -1231,6 +1231,7 @@ def __init__(self, file_object, descriptors):
         self.src = descriptors['src'][1]
         self.renderingintent = descriptors['rendering-intent']
         self.components = descriptors['components']
+        self.pdf_reference = None
         self._profile = ImageCmsProfile(file_object)
 
     @property

weasyprint/document.py

@@ -188,6 +188,13 @@ def _render(cls, html, font_config, counter_style, color_profiles, options):
         if color_profiles is None:
             color_profiles = {}
 
+        # Set default PDF options for PDF variants.
+        if variant := options['pdf_variant']:
+            _, properties = VARIANTS[variant]
+            for key, value in tuple(options.items()):
+                if value is None and key in properties:
+                    options[key] = properties[key]
+
         context = cls._build_layout_context(
             html, font_config, counter_style, color_profiles, options)
 
@@ -200,11 +207,12 @@ def _render(cls, html, font_config, counter_style, color_profiles, options):
         rendering = cls(
             [Page(page_box) for page_box in page_boxes],
             DocumentMetadata(**get_html_metadata(html)),
-            html.url_fetcher, font_config, color_profiles)
+            html.url_fetcher, font_config, color_profiles, options['output_intent'])
         rendering._html = html
         return rendering
 
-    def __init__(self, pages, metadata, url_fetcher, font_config, color_profiles):
+    def __init__(self, pages, metadata, url_fetcher, font_config, color_profiles,
+                 output_intent):
         #: A list of :class:`Page` objects.
         self.pages = pages
         #: A :class:`DocumentMetadata` object.
@@ -221,8 +229,10 @@ def __init__(self, pages, metadata, url_fetcher, font_config, color_profiles):
         # rendering is destroyed. This is needed as font_config.__del__ removes
         # fonts that may be used when rendering
         self.font_config = font_config
-
+        # List of color profiles.
         self.color_profiles = color_profiles
+        # Output intent identifier.
+        self.output_intent = output_intent
 
     def copy(self, pages='all'):
         """Take a subset of the pages.
@@ -255,7 +265,7 @@ def copy(self, pages='all'):
             pages = list(pages)
         return type(self)(
             pages, self.metadata, self.url_fetcher, self.font_config,
-            self.color_profiles)
+            self.color_profiles, self.output_intent)
 
     def make_bookmark_tree(self, scale=1, transform_pages=False):
         """Make a tree of all bookmarks in the document.
@@ -321,13 +331,12 @@ def write_pdf(self, target=None, zoom=1, finisher=None, **options):
         new_options.update(options)
         options = new_options
 
-        # Set default PDF version for PDF variants.
+        # Set default PDF options for PDF variants.
         if variant := options['pdf_variant']:
             _, properties = VARIANTS[variant]
-            if 'version' in properties and not options['pdf_version']:
-                options['pdf_version'] = properties['version']
-            if 'identifier' in properties and not options['pdf_identifier']:
-                options['pdf_identifier'] = properties['identifier']
+            for key, value in tuple(options.items()):
+                if value is None and key in properties:
+                    options[key] = properties[key]
 
         pdf = generate_pdf(self, target, zoom, **options)
 

weasyprint/images.py

@@ -519,9 +519,7 @@ def draw(self, stream, concrete_width, concrete_height, style):
             for c0, c1, hint in color_couples)
         function = stream.create_stitching_function(
             domain, encode, bounds, sub_functions)
-        # TODO: handle other color spaces.
-        shading = stream.add_shading(
-            shading_type, 'RGB', domain, points, extend, function)
+        shading = stream.add_shading(shading_type, domain, points, extend, function)
         stream.transform(d=scale_y)
 
         if any(alpha != 1 for alpha in alphas):
@@ -535,7 +533,7 @@ def draw(self, stream, concrete_width, concrete_height, style):
             function = stream.create_stitching_function(
                 domain, encode, bounds, sub_functions)
             alpha_shading = alpha_stream.add_shading(
-                shading_type, 'Gray', domain, points, extend, function)
+                shading_type, domain, points, extend, function, 'DeviceGray')
             alpha_stream.transform(d=scale_y)
             alpha_stream.stream = [f'/{alpha_shading.id} sh']
 

weasyprint/pdf/__init__.py

@@ -1,7 +1,5 @@
 """PDF generation management."""
 
-from importlib.resources import files
-
 import pydyf
 from tinycss2.color5 import D50, D65
 
@@ -125,13 +123,10 @@ def generate_pdf(document, target, zoom, **options):
     compress = not options['uncompressed_pdf']
 
     # Set properties according to PDF variants
-    srgb = options['srgb']
     pdf_tags = options['pdf_tags']
     variant = options['pdf_variant']
     if variant:
         variant_function, properties = VARIANTS[variant]
-        if 'srgb' in properties:
-            srgb = properties['srgb']
         if 'pdf_tags' in properties:
             pdf_tags = properties['pdf_tags']
 
@@ -149,15 +144,15 @@ def generate_pdf(document, target, zoom, **options):
     })
     # Custom color profiles
     for key, color_profile in document.color_profiles.items():
-        if key == 'device-cmyk':
-            # Device CMYK profile is stored as OutputIntent.
-            continue
         profile = pydyf.Stream(
             [color_profile.content],
             pydyf.Dictionary({'N': len(color_profile.components)}),
             compress=compress)
         pdf.add_object(profile)
+        color_profile.pdf_reference = profile.reference
         color_space[key] = pydyf.Array(('/ICCBased', profile.reference))
+        if key == 'default-cmyk':
+            color_space['DefaultCMYK'] = pydyf.Array(('/ICCBased', profile.reference))
     pdf.add_object(color_space)
     resources = pydyf.Dictionary({
         'ExtGState': pydyf.Dictionary(),
@@ -195,7 +190,7 @@ def generate_pdf(document, target, zoom, **options):
             (right - left) / scale, (bottom - top) / scale)
         stream = Stream(
             document.fonts, page_rectangle, resources, images, tags,
-            document.color_profiles, compress=compress)
+            document.color_profiles, document.output_intent, compress=compress)
         stream.transform(d=-1, f=(page.height * scale))
         pdf.add_object(stream)
         page_streams.append(stream)
@@ -337,46 +332,41 @@ def generate_pdf(document, target, zoom, **options):
             pdf.catalog['Names'] = pydyf.Dictionary()
         pdf.catalog['Names']['Dests'] = dests
 
-    # Add output ICC profile.
-    # TODO: we should allow the user or the PDF variant code to set custom values in
-    # OutputIntents and remove the "srgb" option. See PDF 2.0 chapter 14.11.5, and
-    # https://www.color.org/chardata/drsection1.xalter for a list of "standard
-    # production conditions".
-    if 'device-cmyk' in document.color_profiles:
-        color_profile = document.color_profiles['device-cmyk']
-        profile = pydyf.Stream(
-            [color_profile.content], pydyf.Dictionary({'N': 4}), compress=compress)
-        pdf.add_object(profile)
-        pdf.catalog['OutputIntents'] = pydyf.Array([
-            pydyf.Dictionary({
-                'Type': '/OutputIntent',
-                'S': '/GTS_PDFX',
-                'OutputConditionIdentifier': pydyf.String(color_profile.name),
-                'DestOutputProfile': profile.reference,
-            }),
-        ])
-    elif srgb:
-        profile = pydyf.Stream(
-            [(files(__package__) / 'sRGB2014.icc').read_bytes()],
-            pydyf.Dictionary({'N': 3, 'Alternate': '/DeviceRGB'}),
-            compress=compress)
-        pdf.add_object(profile)
-        pdf.catalog['OutputIntents'] = pydyf.Array([
-            pydyf.Dictionary({
-                'Type': '/OutputIntent',
-                'S': '/GTS_PDFA1',
-                'OutputConditionIdentifier': pydyf.String('sRGB IEC61966-2.1'),
-                'DestOutputProfile': profile.reference,
-            }),
-        ])
-
     # Add tags
     if pdf_tags:
         add_tags(pdf, document, page_streams)
 
+    # Add output intents.
+    subtype = '/GTS_PDFA1' if variant and 'pdf/a' in variant else '/GTS_PDFX'
+    output_intent = document.output_intent
+    color_profile = None
+    if output_intent:
+        if output_intent in document.color_profiles:
+            color_profile = document.color_profile[document.output_intent]
+        elif output_intent == 'device-cmyk':
+            output_intent = 'CGATS TR 001'
+    else:
+        if 'device-cmyk' in document.color_profiles:
+            color_profile = document.color_profiles['device-cmyk']
+        elif document.color_profiles:
+            color_profile = next(iter(document.color_profiles.values()))
+
+    # Add output intent
+    if output_intent or color_profile:
+        intents = pydyf.Dictionary({
+            'Type': '/OutputIntent',
+            'S': subtype,
+        })
+        if color_profile:
+            intents['OutputConditionIdentifier'] = pydyf.String(color_profile.name)
+            intents['Info'] = pydyf.String(color_profile.name)
+            intents['DestOutputProfile'] = color_profile.pdf_reference
+        else:
+            intents['OutputConditionIdentifier'] = pydyf.String(output_intent)
+        pdf.catalog['OutputIntents'] = pydyf.Array([intents])
+
     # Apply PDF variants functions
     if variant:
-        variant_function(
-            pdf, metadata, document, page_streams, attachments, compress)
+        variant_function(pdf, document, page_streams, attachments, compress)
 
     return pdf

weasyprint/pdf/pdfa.py

@@ -5,8 +5,7 @@
 import pydyf
 
 
-def pdfa(pdf, metadata, document, page_streams, attachments, compress,
-         version, variant):
+def pdfa(pdf, document, page_streams, attachments, compress, version, variant):
     """Set metadata for PDF/A documents."""
 
     # Handle attachments.
@@ -63,45 +62,30 @@ def pdfa(pdf, metadata, document, page_streams, attachments, compress,
     if version == 1:
         # Metadata compression is forbidden for version 1.
         compress = False
-    metadata.include_in_pdf(pdf, 'a', version, variant, compress)
+    document.metadata.include_in_pdf(pdf, 'a', version, variant, compress)
 
     # Remove document information.
     if version >= 4:
         pdf.info.clear()
 
 
+def _values(version, pdf_tags=None):
+    values = {'pdf_version': version, 'pdf_identifier': True, 'output_intent': 'sRGB'}
+    if pdf_tags is not None:
+        values['pdf_tags'] = pdf_tags
+    return values
+
+
 VARIANTS = {
-    'pdf/a-1b': (
-        partial(pdfa, version=1, variant='B'),
-        {'version': '1.4', 'identifier': True, 'srgb': True}),
-    'pdf/a-2b': (
-        partial(pdfa, version=2, variant='B'),
-        {'version': '1.7', 'identifier': True, 'srgb': True}),
-    'pdf/a-3b': (
-        partial(pdfa, version=3, variant='B'),
-        {'version': '1.7', 'identifier': True, 'srgb': True}),
-    'pdf/a-2u': (
-        partial(pdfa, version=2, variant='U'),
-        {'version': '1.7', 'identifier': True, 'srgb': True}),
-    'pdf/a-3u': (
-        partial(pdfa, version=3, variant='U'),
-        {'version': '1.7', 'identifier': True, 'srgb': True}),
-    'pdf/a-4u': (
-        partial(pdfa, version=4, variant='U'),
-        {'version': '2.0', 'identifier': True, 'srgb': True}),
-    'pdf/a-1a': (
-        partial(pdfa, version=1, variant='A'),
-        {'version': '1.4', 'identifier': True, 'srgb': True, 'pdf_tags': True}),
-    'pdf/a-2a': (
-        partial(pdfa, version=2, variant='A'),
-        {'version': '1.7', 'identifier': True, 'srgb': True, 'pdf_tags': True}),
-    'pdf/a-3a': (
-        partial(pdfa, version=3, variant='A'),
-        {'version': '1.7', 'identifier': True, 'srgb': True, 'pdf_tags': True}),
-    'pdf/a-4e': (
-        partial(pdfa, version=4, variant='E'),
-        {'version': '2.0', 'identifier': True, 'srgb': True}),
-    'pdf/a-4f': (
-        partial(pdfa, version=4, variant='F'),
-        {'version': '2.0', 'identifier': True, 'srgb': True}),
+    'pdf/a-1b': (partial(pdfa, version=1, variant='B'), _values('1.4')),
+    'pdf/a-2b': (partial(pdfa, version=2, variant='B'), _values('1.7')),
+    'pdf/a-3b': (partial(pdfa, version=3, variant='B'), _values('1.7')),
+    'pdf/a-2u': (partial(pdfa, version=2, variant='U'), _values('1.7')),
+    'pdf/a-3u': (partial(pdfa, version=3, variant='U'), _values('1.7')),
+    'pdf/a-4u': (partial(pdfa, version=4, variant='U'), _values('2.0')),
+    'pdf/a-1a': (partial(pdfa, version=1, variant='A'), _values('1.4', pdf_tags=True)),
+    'pdf/a-2a': (partial(pdfa, version=1, variant='A'), _values('1.7', pdf_tags=True)),
+    'pdf/a-3a': (partial(pdfa, version=1, variant='A'), _values('1.7', pdf_tags=True)),
+    'pdf/a-4e': (partial(pdfa, version=4, variant='U'), _values('2.0')),
+    'pdf/a-4f': (partial(pdfa, version=4, variant='U'), _values('2.0')),
 }

weasyprint/pdf/pdfua.py

@@ -3,13 +3,14 @@
 from functools import partial
 
 
-def pdfua(pdf, metadata, document, page_streams, attachments, compress, version):
+def pdfua(pdf, document, page_streams, attachments, compress, version):
     """Set metadata for PDF/UA documents."""
     # Common PDF metadata stream
-    metadata.include_in_pdf(pdf, 'ua', version, conformance=None, compress=compress)
+    document.metadata.include_in_pdf(
+        pdf, 'ua', version, conformance=None, compress=compress)
 
 
 VARIANTS = {
-    'pdf/ua-1': (partial(pdfua, version=1), {'version': '1.7', 'pdf_tags': True}),
-    'pdf/ua-2': (partial(pdfua, version=2), {'version': '2.0', 'pdf_tags': True}),
+    'pdf/ua-1': (partial(pdfua, version=1), {'pdf_version': '1.7', 'pdf_tags': True}),
+    'pdf/ua-2': (partial(pdfua, version=2), {'pdf_version': '2.0', 'pdf_tags': True}),
 }