Artykuł techniczny

Import EMF w PDFlibPas: zasady PolyDraw, Polyline i Bezier

Narysuj trzypunktowe V przez Canvas.Polyline przy wybranym żółtym pędzlu, skonwertuj metaplik do PDF, a naiwny konwerter odda pełny żółty trójkąt. Ten sam konwerter potrafi wygiąć Beziera w stronę złego punktu kontrolnego i zostawić prostokąt PolyDraw z trzema bokami. Każdy przypadek wraca do jednej reguły [MS-EMF]: EMR_POLYBEZIER startuje w punkcie 0, polilinie są otwarte i tylko obrysowywane, PT_CLOSEFIGURE to bit flagi, a liczby punktów muszą mieścić się w rozmiarze rekordu

Kontekst urządzenia ma stan, którego ścieżka PDF nie ma

Rozszerzony metaplik to zapis wywołań GDI złożonych względem kontekstu urządzenia, i połowa sensu rekordu Poly* mieszka poza jego punktami: czy figura jest otwarta, czy startuje w bieżącej pozycji, które pióro i pędzel są wybrane i pod jakim offsetem bajtowym zaczynają się punkty. PDF nie ma niczego z tego. Ma ścieżkę, punkt bieżący wewnątrz tej ścieżki i operator malowania, który wybiera obrys (S), wypełnienie (f) albo oba (B). Wektorowy importer EMF w PDFlibPas, bibliotece PDF losLab dla Delphi, odtwarza ten stan kontekstu urządzenia obok współrzędnych, a reguły poniżej opisują, jak mapuje każdy rekord

Rodzina Poly* przychodzi też w dwóch szerokościach. Każdy rekord 32-bitowy, jak EMR_POLYLINE, ma bliźniaka 16-bitowego, jak EMR_POLYLINE16, który przechowuje punkty jako pary SmallInt, i GDI zapisuje formę zwartą, ilekroć każda współrzędna się mieści. Codzienne rysunki rzadko więc docierają do 32-bitowych handlerów konwertera. Przepuść te same punkty przez obie szerokości i porównaj ścieżki; to najtańszy audyt, jaki jest. Wszystkie rekordy omawiane tutaj należą do grupy rekordów rysujących w [MS-EMF] 2.3.5

RekordStartuje wZamknięty?Pozycja bieżąca
EMR_POLYBEZIERPunkt 0NieNieużywana, nieaktualizowana
EMR_POLYLINEPunkt 0Nie (tylko pióro)Nieużywana, nieaktualizowana
EMR_POLYLINETOBieżąca pozycjaNie (tylko pióro)Używana i aktualizowana
EMR_POLYPOLYLINEPierwszy punkt każdej poliliniiNie (tylko pióro)Nieużywana, nieaktualizowana
EMR_POLYDRAWPierwszy PT_MOVETO albo bieżąca pozycjaTylko tam, gdzie ustawiono PT_CLOSEFIGUREUżywana i aktualizowana

Gdzie naprawdę zaczyna się krzywa EMR_POLYBEZIER?

Krzywa EMR_POLYBEZIER startuje w punkcie 0, i dopiero punkty od indeksu 1 wzwyż są grupowane po trzy jako punkt kontrolny, punkt kontrolny, punkt końcowy. Rekord z 7 punktami rysuje dwa segmenty sześcienne: punkt 0 to start, punkty 1 do 3 tworzą pierwszy segment, a 4 do 6 drugi. Zacznij grupowanie od punktu 0, a punkt startowy zostanie skonsumowany jako pierwszy punkt kontrolny. Każdy dalszy segment przesunie się o jeden. Wyjście to wciąż gładka krzywa, tylko zła. PDFlibPas otwiera ścieżkę m w punkcie 0, w obu szerokościach rekordu, i zapisuje jedno c na każdą kompletną trójkę po niej

Diagram PDFlibPas rekordu EMR_POLYBEZIER z siedmioma punktami, gdzie punkt zero otwiera ścieżkę operatorem m, a punkty od jednego do trzech i od czterech do sześciu tworzą po jednym sześciennym segmencie c; zestawienie poprawnego grupowania z takim, które konsumuje punkt startowy jako punkt kontrolny
punkt 0 to punkt startowy i dopiero kompletne trójki po nim stają się segmentami sześciennymi, więc siedmiopunktowy PolyBezier renderuje się jako m plus dwa operatory c

A co z liczbą, która nie jest 1 plus wielokrotność 3? Rekord jest zniekształcony. Nasze stanowisko: końcowy jeden albo dwa punkty należy wyrzucić. Zszycie ich w krzywą przez wymyślenie brakującego punktu kontrolnego produkuje kształt, którego żadne urządzenie GDI nigdy nie narysowało, a czytelnik porównujący PDF z oryginałem nie ma sposobu, by rozstrzygnąć, która połowa krzywej jest wymyślona

Bajty typu 3 i 5 w PolyDraw

W EMR_POLYDRAW PT_CLOSEFIGURE (wartość 1) to bit sumowany logicznie OR do PT_LINETO (2) albo PT_BEZIERTO (4), więc całkiem poprawny bajt typu może być 3 albo 5. Typ punktu to bajt z tą flagą zamaskowaną; sama flaga znaczy „zamknij figurę po segmencie kończącym się na tym punkcie”. Handler, który porównuje bajt z pojedynczymi wartościami w pascalskiej instrukcji case, nigdy nie zobaczy dopasowania 3 albo 5. Te punkty są pomijane. Prostokąt narysowany PolyDrawem traci zamykający bok, a trójka Beziera, której ostatni punkt niesie flagę, traci ten punkt, co wysuwa każdą dalszą trójkę o jeden z rytmu

PDFlibPas rozdziela po Types[i] and not PT_CLOSEFIGURE i zamyka figurę dopiero, gdy segment jest kompletny: tuż po linii dla zamkniętego PT_LINETO i po trzecim punkcie grupy Beziera. Zniekształcony plik ustawiający flagę na pierwszym albo drugim punkcie trójki nie zamknie więc figury w połowie krzywej. Dwie dalsze reguły należą do tego samego handlera:

  • Tylko pierwszy PT_MOVETO w rekordzie otwiera ścieżkę; późniejsze ruchy otwierają nowe podścieżki. 16-bitowy EMR_POLYDRAW16 trzymający trzy figury musi wyprodukować trzy podścieżki, a handler restartujący ścieżkę przy każdym ruchu zachowa tylko ostatnią
  • Rekord PolyDraw, który nie zaczyna się od PT_MOVETO, startuje w bieżącej pozycji, jak mówi definicja rekordu. Zapis operatora l albo c bez poprzedzającego m to błąd strumienia treści, który każda przeglądarka PDF rozwiązuje po swojemu
Anatomia bajtu typu w EMR_POLYDRAW według PDFlibPas: PT_CLOSEFIGURE to bit flagi zero sumowany logicznie z PT_LINETO albo PT_BEZIERTO, więc poprawne bajty typu 3 i 5 trzeba zamaskować operacją and not PT_CLOSEFIGURE przed rozdziałem; stara instrukcja case pomijała oba bajty, a zamykane figury traciły ostatni bok
Zamaskuj flagę zamknięcia przed rozdziałem i emituj zamknięcie dopiero po ukończonej linii albo trójce Beziera, inaczej PolyDraw po cichu gubi punkty

Żółty trójkąt: dlaczego polilinia nigdy nie jest wypełniana

EMR_POLYLINE i EMR_POLYPOLYLINE to otwarte figury rysowane samym piórem, a w PDF operator wypełnienia domyka każdą otwartą podścieżkę przed malowaniem (ISO 32000-1 §8.5.3). Wyemituj B albo f dla trzypunktowej polilinii, a przeglądarka namaluje wypełniony trójkąt w bieżącym kolorze pędzla. To żółte V z akapitu otwierającego, albo klin pod linią trendu wykresu. PDFlibPas kończy obie szerokości polilinii S i nigdy nie dotyka pędzla, co trzyma semantykę GDI nietkniętą: Polygon domyka i wypełnia, Polyline nie robi ani jednego, ani drugiego

Porównanie w PDFlibPas otwartej polilinii w kształcie V eksportowanej z EMR_POLYLINE: poprawny konwerter kończy ścieżkę operatorem obrysu S i ignoruje wybrany pędzel, natomiast emisja f albo B domyka otwartą podścieżkę z automatu według ISO 32000-1 8.5.3 i maluje wypełniony klin, czyli znany błąd wykresów
Operator wypełnienia domyka każdą otwartą podścieżkę przed malowaniem, więc polilinie muszą kończyć się S bez h, f ani B na podścieżce

PolylineTo i pióro, którego nie wolno mu ruszać

EMR_POLYLINETO rysuje od bieżącej pozycji przez każdy punkt rekordu, pozostaje otwarte i zostawia bieżącą pozycję na ostatnim punkcie. Stan pióra jest własnością EMR_SELECTOBJECT i EMR_CREATEPEN, nigdy handlera rekordu rysującego. Specjalny przypadek wyłączający pióro wewnątrz jednego rekordu nie ma niczego, co włączy je z powrotem, więc każdy dalszy rekord traci swój obrys. Dla formy jednopunktowej: przeczytaj dokładnie tyle punktów, ile rekord trzyma, i stop

Punkty PolyPolyline siedzą za tablicą liczb

32-bitowy EMR_POLYPOLYLINE przechowuje nPolys liczb, a potem cptl punktów, więc punkty zaczynają się pod offsetem bajtowym 32 + nPolys * 4. Pułapka siedzi w RTL Delphi. Jednostka Windows deklaruje TEMRPolyPolyline z aPolyCounts i aptl jako tablicami jednoelementowymi, co znaczy, że aptl[0] jest pierwszym punktem tylko przy nPolys równym 1. Indeksuj aptl wprost, a każdy wieloliniowy rekord przeczyta liczby jako współrzędne. Gorzej: kontrola rozmiaru zbudowana na tym układzie odrzuci poprawne wieloliniowe rekordy z marszu. PDFlibPas liczy offset tak samo jak dla PolyPolygon i rysuje każdą polilinię jako jej własną otwartą podścieżkę, z jednym obrysem na końcu. Bliźniak 16-bitowy podąża tym samym wzorcem; rysowanie go segment po segmencie połamałoby łączenia linii i zignorowało wybrany NULL_PEN

Obiekty domyślne i nawiasy ścieżek

  • Świeży kontekst urządzenia GDI ma już wybrane BLACK_PEN i WHITE_BRUSH. Metaplik rysujący bez ani jednego EMR_SELECTOBJECT jest legalny i dostaje czarne obrysy; konwerter startujący bez pióra zapisze n (koniec ścieżki, nic nie maluj) dla tych rekordów
  • Wewnątrz nawiasu BeginPath / EndPath Polyline ani nie używa, ani nie aktualizuje bieżącej pozycji, więc otwiera nową podścieżkę w swoim pierwszym punkcie, zamiast dospawać do poprzedniej figury. Nic nie jest malowane, dopóki nawias nie zostanie obrysowany albo wypełniony

Nagranie testowego metapliku z TMetafileCanvas

Najszybsza droga, by przepuścić konwerter przez te reguły, to nagranie trzech ryzykownych wywołań do jednego rozszerzonego metapliku przez TMetafileCanvas. Procedura poniżej rysuje krzywe pędzlem pustym, po czym celowo wybiera pełny żółty pędzel przed polilinią. Poprawny konwerter ten pędzel ignoruje. Jakikolwiek żółty w wyjściowym PDF znaczy, że polilinia została wypełniona. PolyDraw nie ma wrappera na TCanvas, więc idzie przez API Windows na uchwycie kanwy, z bajtami typu 3 i 5 ćwiczącymi flagę zamknięcia

uses
  Winapi.Windows, System.Types, Vcl.Graphics;

procedure BuildPolyTestEmf(const FileName: string);
const
  // Zamknięty kwadrat (3 = LINETO + CLOSEFIGURE), a potem zamknięta
  // figura Beziera, której ostatnia trójka kontrolna kończy się 5 = BEZIERTO + CLOSEFIGURE
  DrawPts: array[0..7] of TPoint = (
    (X: 300; Y: 40), (X: 380; Y: 40), (X: 380; Y: 120), (X: 300; Y: 120),
    (X: 420; Y: 120), (X: 440; Y: 40), (X: 520; Y: 40), (X: 540; Y: 120));
  DrawTypes: array[0..7] of Byte = (
    PT_MOVETO, PT_LINETO, PT_LINETO, PT_LINETO or PT_CLOSEFIGURE,
    PT_MOVETO, PT_BEZIERTO, PT_BEZIERTO, PT_BEZIERTO or PT_CLOSEFIGURE);
var
  Mf: TMetafile;
  Canvas: TMetafileCanvas;
begin
  Mf := TMetafile.Create;
  try
    Mf.Enhanced := True;
    Mf.Width := 600;
    Mf.Height := 260;
    Canvas := TMetafileCanvas.Create(Mf, 0);
    try
      Canvas.Pen.Color := clNavy;
      Canvas.Pen.Width := 2;
      Canvas.Brush.Style := bsClear;    // tylko obrysy dla krzywych
      // Punkt 0 to start; 1..3 oraz 4..6 to dwa segmenty sześcienne
      Canvas.PolyBezier([Point(20, 120), Point(60, 20), Point(100, 220),
        Point(140, 120), Point(180, 20), Point(220, 220), Point(260, 120)]);
      PolyDraw(Canvas.Handle, DrawPts[0], DrawTypes[0], Length(DrawPts));
      // Otwarte V z wybranym pełnym pędzlem: tylko obrys, nigdy domknięte
      // do żółtego trójkąta
      Canvas.Brush.Style := bsSolid;
      Canvas.Brush.Color := clYellow;
      Canvas.Polyline([Point(20, 240), Point(120, 160), Point(220, 240)]);
    finally
      Canvas.Free;   // kończy zapis
    end;
    Mf.SaveToFile(FileName);
  finally
    Mf.Free;
  end;
end;

Każda współrzędna tutaj mieści się w SmallInt, więc GDI zapisuje zwykle warianty 16-bitowe. Osiągnięcie handlerów 32-bitowych wymaga producenta, który je zapisze, albo rekordów złożonych ręcznie. Ręcznie zbudowane pliki mają własną pułapkę, a wychodzi ona jako błąd VCL „Metafile is not valid”: TMetafile.LoadFromStream traktuje strumień jako EMF tylko wtedy, gdy pozostała długość jest ściśle większa od 108-bajtowego TEnhMetaHeader. Krótki nagłówek albo pusty EMF mający dokładnie 108 bajtów jest brany za WMF i odrzucany. Zapisz pełny 108-bajtowy nagłówek, z polami rozszerzeń włącznie, przed pierwszym testowym rekordem

Import metapliku przez ImportEMFFromFile

PDFlibPas importuje EMF przez ImportEMFFromFile albo ImportEMFFromStream. Oba zwracają niezerowy identyfikator obrazu przy sukcesie i 0 przy porażce. GeneralOptions = 0 trzyma ścieżkę wektorową, o której ten artykuł, a 1 rasteryzuje metaplik do bitmapy. FontOptions = 1 dodaje fonty użyte przez metaplik i osadza je jako subsety. Wariant strumieniowy cofa się do pozycji 0 przed wczytaniem, więc podaj mu strumień zawierający metaplik i nic poza tym

uses
  System.SysUtils, PDFlibrary;

procedure EmfToPdf(const EmfFile, PdfFile: WideString);
var
  PDF: TPDFlib;
  ImageID: Integer;
  PageOps: AnsiString;
begin
  PDF := TPDFlib.Create;
  try
    PDF.SetOrigin(1);              // początek w lewym górnym rogu dla DrawImage
    PDF.SetMeasurementUnits(0);    // punkty
    // FontOptions 1 = dodaj fonty metapliku jako osadzone subsety
    // GeneralOptions 0 = import wektorowy, 1 = bitmapa
    ImageID := PDF.ImportEMFFromFile(EmfFile, 1, 0);
    if ImageID = 0 then
      raise Exception.Create('The metafile could not be imported');
    PDF.SelectImage(ImageID);
    // Dla EMF ImageWidth / ImageHeight to rozmiar ramki w punktach
    PDF.DrawImage(36, 36, PDF.ImageWidth, PDF.ImageHeight);

    // Strona jedynie wywołuje zaimportowaną formę: q ... cm /Name Do Q
    // (opcjonalna kontrola rozsądku, którą możesz dodać do własnego kodu)
    PageOps := PDF.GetPageContentToString;
    if Pos(AnsiString(' Do'), PageOps) = 0 then
      raise Exception.Create('Expected a form XObject invocation');

    if PDF.SaveToFile(PdfFile) <> 1 then
      raise Exception.Create('The PDF could not be saved');
  finally
    PDF.Free;
  end;
end;

Wektorowy import EMF staje się form XObjectem, więc GetPageContentToString zwraca wyłącznie sekwencję zapis, transformacja, Do i odtworzenie. Operatory m, l, c, h i S wygenerowane z rekordów Poly* mieszkają w skompresowanym strumieniu form XObjecta. Otwórz zapisany plik w inspektorze obiektów PDF, zdekompresuj ten strumień i sprawdź trzy rzeczy dla testowego pliku wyżej: polilinia kończy się S bez żadnego h przed nią, każda flaga zamknięcia w figurach PolyDraw wyprodukowała h i żadne f ani B nie pojawia się na żadnej z tych podścieżek. DrawImage skaluje zaimportowany EMF jednostajnie według mniejszej z wartości Width i Height, więc rysunek zachowuje proporcje nawet wtedy, gdy pudełko, które podasz, im nie odpowiada

Użytkownicy Free Pascala mogą przeczytać jak wektorowy importer EMF PDFlibPas buduje się pod Free Pascalem; semantyka rekordów jest identyczna, gdziekolwiek importer się kompiluje

Liczby punktów w pliku EMF to niezaufane wejście

Każdą liczbę punktów w metapliku należy sprawdzić względem rozmiaru rekordu, zanim skopiuje się choć jeden punkt. EnumEnhMetaFile gwarantuje tylko, że nSize każdego rekordu mieści się w pliku. Nigdy nie sprawdza, że cptl zgadza się z nSize. Handler kopiujący cptl punktów przez Move z przyjemnością wczyta się w następne rekordy albo poza koniec metapliku, gdy tylko liczba jest podrobiona albo uszkodzona. PDFlibPas porównuje stały nagłówek plus liczba razy bajty na punkt względem nSize dla PolyDraw, PolyBezier, PolyBezierTo, Polyline, PolylineTo i Polygon w obu szerokościach, dokładając jeden bajt na punkt dla tablicy typów PolyDraw. Dla rekordów PolyPoly liczby per figura muszą też sumować się do nie więcej niż zadeklarowana całkowita, a figury o zeru punktów są pomijane

Wolimy pominąć rekord, który tej próby nie przechodzi, niż obcinać liczbę do tego, co się mieści. Obcięty rekord wciąż się rysuje, a częściowo narysowana figura w raporcie jest trudniejsza do wychwycenia niż brakująca. Kontrola jest krótka na tyle, by wrzucić ją do własnego parsera; ta wersja waliduje 32-bitowy EMR_POLYPOLYLINE i zwraca wskaźnik do jego prawdziwej tablicy punktów:

uses
  Winapi.Windows;

// Kontrola do dodania do własnego parsera EMF (nie procedura biblioteki).
// Zwraca nil, chyba że rekord naprawdę trzyma punkty, które deklaruje.
// Punkty zaczynają się za tablicą liczb: 32 + nPolys * 4 bajty w głąb, nie pod
// aptl[0], który RTL deklaruje jako tablicę jednoelementową
function PolyPolylinePoints(Rec: PEnhMetaRecord): PPoint;
var
  P: PEMRPolyPolyline;
  Count: PDWORD;
  PointsOffset, Total: Int64;
  I: Cardinal;
begin
  Result := nil;
  if (Rec^.iType <> EMR_POLYPOLYLINE) or (Rec^.nSize < 32) then
    Exit;
  P := PEMRPolyPolyline(Rec);
  if P^.nPolys = 0 then
    Exit;
  PointsOffset := 32 + Int64(P^.nPolys) * SizeOf(DWORD);
  if PointsOffset + Int64(P^.cptl) * SizeOf(TPoint) > Rec^.nSize then
    Exit;                         // podrobiona albo ucięta liczba
  Total := 0;
  Count := @P^.aPolyCounts[0];    // spacer wskaźnikiem: [0..0] odpala kontrole zakresów
  for I := 1 to P^.nPolys do
  begin
    Inc(Total, Count^);
    Inc(Count);
  end;
  if Total > P^.cptl then
    Exit;                         // figury roszczą więcej punktów, niż istnieje
  Result := PPoint(NativeUInt(Rec) + NativeUInt(PointsOffset));
end;

Kolejność ma tu znaczenie. Test „punkty się mieszczą” biegnie pierwszy, co dowodzi, że tablica liczb leży wewnątrz rekordu, zanim pętla po niej zacznie iść. Arytmetyka używa Int64, bo nPolys * 4 i cptl * 8 policzone na 32 bitach potrafią zawinąć się do małej liczby i przejść porównanie

Ta sama semantyka rekordów obowiązuje niezależnie od tego, który komponent renderuje twoje raporty. Import wektorowy EMF i WMF w HotPDF opisuje, jak tamten komponent zamienia pędzle gradientowe i kreskowane w patterny PDF, a grafika wektorowa, shadery i gradienty w PDFlibPas pokazuje, jak narysować te same kształty wprost przez API biblioteki, z pominięciem metapliku

By przepuścić własne metapliki raportowe przez ten importer, strona biblioteki PDF PDFlibPas dla Delphi ma szczegóły produktu i pobranie wersji próbnej