VintaSoft Barcode .NET SDK is a professional cross-platform SDK for Windows, Linux, macOS, which allows you to recognize and generate PDF417 barcodes in .NET, WPF, Web, MAUI. You only need a few lines of code to add the ability to recognize and generate PDF417 barcodes to your .NET application.
What is a PDF417 barcode?
The PDF417 barcode is a high-density, multilayered 2D barcode used to store large amounts of data (up to 1850 characters or 1108 bytes). Invented in 1991, it is widely used for government identification cards, boarding passes, and in logistics. It uses a 4-bar/4-space, 17-element pattern per codeword, supports built-in error correction and provides compact and reliable data storage.
Here is the image of PDF417 barcode:
The PDF417 barcode supports the following data storage modes:
- Alphanumeric (up to 1850 symbols)
- Byte (up to 1108 bytes)
- Numeric (up to 2710 digits)
The PDF417 barcode uses the Reed-Solomon error correction algorithm, which allows us to recognize damaged PDF417 barcodes.
The PDF417 barcode can encode the following special characters:
PDF417 Barcode Structure
The PDF417 barcode consists of a number of modules, which can be divided into three distinct groups:
- Start/stop pattern
- Left/right indicator
- Data codewords
Each module begins with a solid black column and ends with a solid white column to visually indicate where each module begins and ends. There is also a blank area on either side of the barcode, known as a quiet zone.
The start and stop search patterns indicate the beginning and end areas of the barcode. They help the barcode scanner detect the barcode but do not contain any data.
The left and right indicators contain information about the barcode, such as the number of lines in the barcode, the error correction level, etc.
The data codeword module contains the barcode data. The size of a PDF417 barcode depends on how much data is encoded.
The data codeword module can contain from 1 to 30 codewords and from 3 to 90 lines. In the figure above,
the data codeword module contains 4
codewords per row, marked in purple. In the figure above,
the data codeword module consists of 4 rows.
Each
codeword is 17 cells long and consists of 4 black stripes and 4 white cells, hence the name PDF417. Each data
codeword is read from left to right, top to bottom.
What is PDF417 Compact barcode?
The PDF417 Compact barcode is a variant of the PDF417 barcode that removes the right indicator and stop search pattern to save space.
Here is an image of the PDF417 Compact barcode:
What is Micro PDF417 barcode?
The Micro PDF417 barcode is a compact version of the PDF417 barcode. Micro PDF417 barcodes are typically used as part of composite codes (such as GS1 DataBar) for product labeling, document labeling, and healthcare applications:
The Micro PDF417 barcode supports the following data storage modes::
- Alphanumeric (up to 250 symbols)
- Byte (up to 150 bytes)
- Numeric (up to 366 digits)
The Micro PDF417 barcode can encode the following special characters:
What is AAMVA barcode?
AAMVA (DL/ID Card Design Standard) barcode - this is a PDF417 barcode that stores driver's license information.
VintaSoft Barcode .NET SDK can encode and decode data in the AAMVA format.
Here is an image of the "XFA Compressed QR" barcode:
What is XFA Compressed PDF417 barcode?
The "XFA Compressed PDF417" barcode is a PDF417 barcode that stores data compressed according to the Adobe XFA specification.
VintaSoft Barcode .NET SDK can generate and recognize "XFA Compressed PDF417" barcodes.
Here is an image of the "XFA Compressed QR" barcode:
The special character "Structure Append"
The PDF417 barcode supports a special character "Structure Append", which allows data to be split into multiple (up to 99,999) PDF417 barcodes. The special character "Structure Append" is encoded within the barcode and allows for the unique identification of the number of barcode parts and their order.
Here is an image of a PDF417 barcode with text "In order to fit a non-square area or to handle larger messages than are practical in a single symbol, a data message can be distributed across several symbols. Aztec, Code 16K, DataMatrix, DotCode, MaxiCode, QR Code, PDF417, Micro PDF417 symbols may be appended in a structured format.":
And here are five PDF417 barcodes with the same text, but in a smaller size. These five PDF417 barcodes are combined into a single value using the special character "Structure Append":
VintaSoft Barcode .NET SDK contains an algorithm for recovering data from a set of PDF417 barcode parts that have been separated using the special character "Structure Append".
What PDF417 barcodes can be recognized using VintaSoft Barcode .NET SDK?
VintaSoft Barcode .NET SDK can recognize all types of PDF417 barcodes: PDF417, PDF417 Compact, Micro PDF417, AAMVA, and XFA Compressed PDF417. Unique algorithms are used for recognition, allowing for quick recognition of barcodes in images with various issues:
- damaged matrix
- low contrast
- low modulation
- uneven illumination
- compression on one side
- spatial distortions
- large number of barcodes in a single image
Here is C# code that demonstrates how to recognize PDF417 barcodes in an image captured from a camera:
/// <summary>
/// Reads PDF417 barcodes from a <see cref="System.Drawing.Bitmap"/>.
/// </summary>
/// <param name="bitmap">A bitmap with barcodes.</param>
public static void ReadPdf417BarcodesFromBitmap(System.Drawing.Bitmap bitmap)
{
// create barcode reader
using (Vintasoft.Barcode.BarcodeReader reader = new Vintasoft.Barcode.BarcodeReader())
{
// specify that reader must search for PDF417 barcodes
reader.Settings.ScanBarcodeTypes = Vintasoft.Barcode.BarcodeType.PDF417;
// read barcodes from image
Vintasoft.Barcode.IBarcodeInfo[] infos = Vintasoft.Barcode.GdiExtensions.ReadBarcodes(reader, bitmap);
// if barcodes are not detected
if (infos.Length == 0)
{
System.Console.WriteLine("No barcodes found.");
}
// if barcodes are detected
else
{
// get information about extracted barcodes
System.Console.WriteLine(string.Format("{0} barcodes found:", infos.Length));
System.Console.WriteLine();
for (int i = 0; i < infos.Length; i++)
{
Vintasoft.Barcode.IBarcodeInfo info = infos[i];
System.Console.WriteLine(string.Format("[{0}:{1}]", i + 1, info.BarcodeType));
System.Console.WriteLine(string.Format("Value: {0}", info.Value));
System.Console.WriteLine(string.Format("Region: {0}", info.Region));
System.Console.WriteLine();
}
}
}
}
Here is C# code that demonstrates how to generate and recognize an AAMVA barcode:
/// <summary>
/// Generates and recognizes AAMVA barcode.
/// </summary>
public static void GenerateAndRecognizeAamvaBarcode()
{
// create DL data elements
AamvaDataElement[] dlElements = new AamvaDataElement[] {
new AamvaDataElement(AamvaDataElementIdentifiers.DAQ, "C12345678"),
new AamvaDataElement(AamvaDataElementIdentifiers.DCS, "CARPENTER"),
new AamvaDataElement(AamvaDataElementIdentifiers.DDE, "N"),
new AamvaDataElement(AamvaDataElementIdentifiers.DAC, "JON"),
new AamvaDataElement(AamvaDataElementIdentifiers.DDF, "N"),
new AamvaDataElement(AamvaDataElementIdentifiers.DAD, "T"),
new AamvaDataElement(AamvaDataElementIdentifiers.DDG, "N"),
new AamvaDataElement(AamvaDataElementIdentifiers.DCA, "D"),
new AamvaDataElement(AamvaDataElementIdentifiers.DCB, "1"),
new AamvaDataElement(AamvaDataElementIdentifiers.DCD, "NONE"),
new AamvaDataElement(AamvaDataElementIdentifiers.DBD, "10052015"),
new AamvaDataElement(AamvaDataElementIdentifiers.DBB, "07241984"),
new AamvaDataElement(AamvaDataElementIdentifiers.DBA, "01092022"),
new AamvaDataElement(AamvaDataElementIdentifiers.DBC, "1"),
new AamvaDataElement(AamvaDataElementIdentifiers.DAU, "067 in"),
new AamvaDataElement(AamvaDataElementIdentifiers.DAY, "BLK"),
new AamvaDataElement(AamvaDataElementIdentifiers.DAG, "3211 SANCTUARY LANE"),
new AamvaDataElement(AamvaDataElementIdentifiers.DAI, "LOUISVILLE"),
new AamvaDataElement(AamvaDataElementIdentifiers.DAJ, "KY"),
new AamvaDataElement(AamvaDataElementIdentifiers.DAK, "123454321"),
new AamvaDataElement(AamvaDataElementIdentifiers.DCF, "9876543210123456"),
new AamvaDataElement(AamvaDataElementIdentifiers.DCG, "USA"),
new AamvaDataElement(AamvaDataElementIdentifiers.DCK, "1234567890123456"),
new AamvaDataElement(AamvaDataElementIdentifiers.DDB, "01062016")
};
// create ZK data elements
AamvaDataElement[] zkElements = new AamvaDataElement[] {
new AamvaDataElement("ZKA", "Y"),
new AamvaDataElement("ZKB", "TEST"),
new AamvaDataElement("ZKC", "9876"),
new AamvaDataElement("ZKD", "DUP"),
};
// create subfiles
AamvaSubfile[] subfiles = new AamvaSubfile[]{
new AamvaSubfile("DL", dlElements),
new AamvaSubfile("ZK", zkElements)
};
// create AAMVA barcode value
AamvaBarcodeValue barcodeValue = new AamvaBarcodeValue(AamvaVersionLevel.AAMVA2016, 636046, 0, subfiles);
// generate barcode image
using (VintasoftBitmap barcodeImage = GenerateAamvaBarcode(barcodeValue))
{
// recognize barcode value
AamvaBarcodeInfo recognizedBarcode = RecognizeAamvaBarcode(barcodeImage);
// check value
if (barcodeValue.ToString() != recognizedBarcode.AamvaValue.ToString())
throw new ApplicationException();
// print value
Console.WriteLine("Version: {0}", recognizedBarcode.VersionLevel);
Console.WriteLine("Country: {0}", recognizedBarcode.CountryId);
Console.WriteLine("IIN: {0}", recognizedBarcode.IssuerIdentificationNumber);
Console.WriteLine("License number: {0}", recognizedBarcode.LicenseNumber);
Console.WriteLine("First name: {0}", recognizedBarcode.FirstName);
Console.WriteLine("Family name: {0}", recognizedBarcode.FamilyName);
Console.WriteLine("Middle name: {0}", recognizedBarcode.MiddleName);
Console.WriteLine("Sex (1=M;2=F): {0}", recognizedBarcode.Sex);
Console.WriteLine("Eye color: {0}", recognizedBarcode.EyeColor);
Console.WriteLine("Date of birth: {0}", recognizedBarcode.DateOfBirth.ToShortDateString());
Console.WriteLine("Issue date: {0}", recognizedBarcode.IssueDate.ToShortDateString());
Console.WriteLine("Expiration date: {0}", recognizedBarcode.ExpirationDate.ToShortDateString());
Console.WriteLine("State code: {0}", recognizedBarcode.AddressStateCode);
Console.WriteLine("City: {0}", recognizedBarcode.AddressCity);
Console.WriteLine("Postal code: {0}", recognizedBarcode.AddressPostalCode);
Console.WriteLine("Street: {0}", recognizedBarcode.AddressStreet1);
Console.WriteLine();
Console.WriteLine("Data elements:");
foreach (AamvaSubfile subfile in recognizedBarcode.Subfiles)
{
Console.WriteLine("[{0}] subfile:", subfile.SubfileType);
foreach (AamvaDataElement dataElement in subfile.DataElements)
{
if (dataElement.Identifier.VersionLevel != AamvaVersionLevel.Undefined)
Console.Write(" [{0}] {1}:", dataElement.Identifier.ID, dataElement.Identifier.Description);
else
Console.Write(" [{0}]:", dataElement.Identifier.ID);
Console.WriteLine(" {0}", dataElement.Value);
}
}
}
}
/// <summary>
/// Generates the AAMVA barcode image.
/// </summary>
/// <param name="barcodeValue">The barcode value.</param>
private static VintasoftBitmap GenerateAamvaBarcode(AamvaBarcodeValue barcodeValue)
{
// create barcode writer
using (BarcodeWriter writer = new BarcodeWriter())
{
// encode AAMVA barcode to writer settings
BarcodeSymbologySubsets.AAMVA.Encode(barcodeValue, writer.Settings);
// generate barcode image
return writer.GetBarcodeAsVintasoftBitmap();
}
}
/// <summary>
/// Recognizes the AAMVA barcode from image.
/// </summary>
/// <param name="barcodeImage">The barcode image.</param>
private static AamvaBarcodeInfo RecognizeAamvaBarcode(VintasoftBitmap barcodeImage)
{
// create barcode reader
using (BarcodeReader reader = new BarcodeReader())
{
// specify that AAMVA barcode must be recognized
reader.Settings.ScanBarcodeSubsets.Add(BarcodeSymbologySubsets.AAMVA);
// recognize barcodes
IBarcodeInfo info = reader.ReadBarcodes(barcodeImage)[0];
// return information about recognized AAMVA barcode
return (AamvaBarcodeInfo)info;
}
}
Here is C# code that demonstrates how to generate and recognize a PDF417 barcode, which stores data compressed according to the Adobe XFA specification:
/// <summary>
/// Generates PDF417 barcode with XFA compression.
/// </summary>
public void GeneratePdf417BarcodeWithXfaCompression()
{
string barcodeText =
"https://www.vintasoft.com/vsbarcode-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vstwain-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vstwain-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vsimaging-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vsannotation-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vspdf-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vsjbig2-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vsjpeg2000-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vsdoccleanup-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vsocr-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vsdicom-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vsformsprocessing-dotnet-index.html" + System.Environment.NewLine +
"https://www.vintasoft.com/vsoffice-dotnet-index.html";
// create the barcode writer
using (Vintasoft.Barcode.BarcodeWriter barcodeWriter = new Vintasoft.Barcode.BarcodeWriter())
{
// create the XFA compressed PDF417 barcode symbology
Vintasoft.Barcode.SymbologySubsets.XFACompressedPDF417BarcodeSymbology xfaCompressedPdf417BarcodeSymbology =
new Vintasoft.Barcode.SymbologySubsets.XFACompressedPDF417BarcodeSymbology();
// encode barcode text using XFA compressed PDF417 barcode symbology
xfaCompressedPdf417BarcodeSymbology.Encode(barcodeText, barcodeWriter.Settings);
// save the barcode image to a file
barcodeWriter.SaveBarcodeAsImage("pdf417-barcode-with-xfa-compression.png");
}
}
/// <summary>
/// Recognizes PDF417 barcode with XFA compression.
/// </summary>
public void RecognizePdf417BarcodeWithXfaCompression()
{
// create barcode reader
using (Vintasoft.Barcode.BarcodeReader reader = new Vintasoft.Barcode.BarcodeReader())
{
// specify that reader must search for XFA compressed PDF417 barcodes
reader.Settings.ScanBarcodeSubsets.Add(Vintasoft.Barcode.SymbologySubsets.BarcodeSymbologySubsets.XFACompressedPDF417);
// read barcodes from image file
Vintasoft.Barcode.IBarcodeInfo[] barcodeInfos = reader.ReadBarcodes("pdf417-barcode-with-xfa-compression.png");
// if barcodes are not detected
if (barcodeInfos.Length == 0)
{
System.Console.WriteLine("Barcodes are not found.");
}
// if barcodes are detected
else
{
// get information about recognized barcodes
System.Console.WriteLine(string.Format("{0} barcode(s) found:", barcodeInfos.Length));
System.Console.WriteLine();
for (int i = 0; i < barcodeInfos.Length; i++)
{
Vintasoft.Barcode.IBarcodeInfo barcodeInfo = barcodeInfos[i];
System.Console.WriteLine(string.Format("[{0}:{1}]", i + 1, barcodeInfo.BarcodeType));
System.Console.WriteLine(string.Format("Value: {0}", barcodeInfo.Value));
System.Console.WriteLine(string.Format("Region: {0}", barcodeInfo.Region));
System.Console.WriteLine();
}
}
}
}
What PDF417 barcodes can generate VintaSoft Barcode .NET SDK?
VintaSoft Barcode .NET SDK generated all types of PDF417 barcodes: PDF417, PDF417 Compact, Micro PDF417, AAMVA, XFA Compressed PDF417.
Here is C# code that demonstrates how to generate a bitmap image of a PDF417 barcode:
/// <summary>
/// Returns the PDF417 barcode as <see cref="System.Drawing.Bitmap"/>.
/// </summary>
/// <param name="value">The barcode value.</param>
/// <returns>A <see cref="System.Drawing.Bitmap"/> object.</returns>
public static System.Drawing.Bitmap GetPdf417BarcodeAsBitmap(string value)
{
// create the barcode writer
using (Vintasoft.Barcode.BarcodeWriter barcodeWriter = new Vintasoft.Barcode.BarcodeWriter())
{
// set barcode writer settings
barcodeWriter.Settings.Barcode = Vintasoft.Barcode.BarcodeType.PDF417;
barcodeWriter.Settings.Value = value;
// get a barcode image as System.Drawing.Bitmap
return Vintasoft.Barcode.GdiExtensions.GetBarcodeAsBitmap(barcodeWriter);
}
}
Here is C# code that demonstrates how to generate a bitmap image of a Micro PDF417 barcode:
/// <summary>
/// Returns the Micro PDF417 barcode as <see cref="System.Drawing.Bitmap"/>.
/// </summary>
/// <param name="value">The barcode value.</param>
/// <returns>A <see cref="System.Drawing.Bitmap"/> object.</returns>
public static System.Drawing.Bitmap GetMicroPdf417BarcodeAsBitmap(string value)
{
// create the barcode writer
using (Vintasoft.Barcode.BarcodeWriter barcodeWriter = new Vintasoft.Barcode.BarcodeWriter())
{
// set barcode writer settings
barcodeWriter.Settings.Barcode = Vintasoft.Barcode.BarcodeType.MicroPDF417;
barcodeWriter.Settings.Value = value;
// get a barcode image as System.Drawing.Bitmap
return Vintasoft.Barcode.GdiExtensions.GetBarcodeAsBitmap(barcodeWriter);
}
}
Here is C# code that demonstrates how to generate a vector (SVG) image of a PDF417 barcode:
/// <summary>
/// Returns the PDF417 barcode in vector form as a SVG string.
/// </summary>
/// <param name="barcodeValue">Barcode value.</param>
public static void GetPdf417BarcodeAsSvgString(string barcodeValue)
{
// create the barcode writer
using (Vintasoft.Barcode.BarcodeWriter barcodeWriter = new Vintasoft.Barcode.BarcodeWriter())
{
// set barcode writer settings
barcodeWriter.Settings.Barcode = Vintasoft.Barcode.BarcodeType.PDF417;
barcodeWriter.Settings.Value = barcodeValue;
// generate PDF417 barcode as a SVG string
return barcodeWriter.GetBarcodeAsSvgFile();
}
}
