pg014 V Ycrcb2rgb

Download as pdf or txt
Download as pdf or txt
You are on page 1of 69

YCrCb to RGB

Color-Space
Converter v7.1
LogiCORE IP Product Guide

PG014 November 18, 2015


Table of Contents
IP Facts

Chapter 1: Overview
Feature Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Licensing and Ordering Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 2: Product Specification


Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Performance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Resource Utilization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Core Interfaces and Register Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 3: Designing with the Core


General Design Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Color‐Space Conversion Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Clock, Enable, and Reset Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
System Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Chapter 4: Customizing and Generating the Core


Vivado Integrated Design Environment (IDE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Output Generation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Chapter 5: Constraining the Core


Required Constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Chapter 6: C Model Reference


Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Using the C‐Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
C‐Model Example Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


2
PG014 November 18, 2015
Chapter 7: Simulation

Chapter 8: Synthesis and Implementation

Chapter 9: Detailed Example Design

Chapter 10: Test Bench


Demonstration Test Bench . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Appendix A: Verification, Compliance, and Interoperability


Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Hardware Testing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Interoperability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Appendix B: Migrating and Upgrading


Migrating to the Vivado Design Suite. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Upgrading in Vivado Design Suite. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Appendix C: Debugging
Finding Help on Xilinx.com . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Debug Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Hardware Debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Interface Debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Appendix D: Additional Resources


Xilinx Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Notice of Disclaimer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


3
PG014 November 18, 2015
IP Facts

Introduction LogiCORE IP Facts Table


Core Specifics
The Xilinx LogiCORE™ IP YCrCb to RGB
Supported UltraScale+™ Families,
Color-Space Converter core is a simplified 3x3 UltraScale™ Architecture, Zynq® -7000,
Device Family (1)
matrix multiplier converting three input color 7 Series
samples to three output samples in a single Supported User
AXI4-Lite, AXI4-Stream (2)
clock cycle. The optimized structure uses only Interfaces
four XtremeDSP™ slices by taking advantage of Resources See Table 2-1 through Table 2-4
the dependencies between coefficients in the
Provided with Core
conversion matrix of most YCrCb 4:4:4 or YUV
4:4:4 to RGB standards. Documentation Product Guide

Design Files Encrypted RTL

Example Design Not Provided


Features Test Bench Verilog (3)

Constraints File XDC


• Built-in support for:
Simulation Encrypted RTL, VHDL or Verilog Structural,
° SD (ITU 601) Models C-Model

° HD (ITU 709) PAL Supported


Standalone
Software Drivers

° HD (ITU 709) NTSC Tested Design Flows (5)


° YUV Design Entry Vivado® Design Suite
Tools IP Intergrator
• Support for user-defined conversion
Simulation For supported simulators, see the Xilinx Design
matrices Tools: Release Notes Guide.

• AXI4-Stream data interfaces Synthesis Tools Vivado Synthesis

• Optional AXI4-Lite control interface Support


Provided by Xilinx, Inc.
• Supports 8, 10, 12 and 16-bit per color
1. For a complete listing of supported devices, see the Vivado IP
component input and output Catalog.
2. Video protocol as defined in the Video IP: AXI Feature
• Built-in, optional bypass and test-pattern Adoption section of AXI Reference Guide [Ref 1].
generator mode 3. HDL test bench and C-Model available on the product page
on Xilinx.com at http://www.xilinx.com/products/
• Built-in, optional throughput monitors intellectual-property/YCrCb_to_RGB.htm.
4. Standalone driver details can be found in the SDK directory
• Supports spatial resolutions from 32x32 up (<install_directory>/doc/usenglish/xilinx_drivers.htm). Linux
to 7680x7680 OS and driver support information is available from
the Xilinx Wiki page.

° Supports 1080P60 in all supported 5. For the supported versions of the tools, see the Xilinx Design
Tools: Release Notes Guide.
device families (1)

° Supports 4kx2k at the 24 Hz in


supported high performance devices
1. Performance on low power devices may be lower.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


4
PG014 November 18, 2015 Product Specification
Chapter 1

Overview
A color space is a mathematical representation of a set of colors. The two most popular
color models are:

• RGB or R'G'B', gamma corrected RGB, used in computer graphics


• YIQ, YUV and YCrCb used in video systems

These color spaces are directly related to the intuitive notions of hue, saturation and
brightness.

All color spaces can be derived from the RGB information supplied by devices such as
cameras and scanners. Different color spaces have historically evolved for different
applications. In each case, a color space was chosen for application-specific reasons.

The convergence of computers, the Internet and a wide variety of video devices, all using
different color representations, is forcing the digital designer today to convert between
them. The objective is to have all inputs converted to a common color space before
algorithms and processes are executed. Converters are useful for a number of markets,
including image and video processing.

Feature Summary
The YCrCb to RGB Color-Space Converter core transforms YCrCb 4:4:4 or YUV 4:4:4 video
data into RGB video data. The core supports a 4 common format conversions as well as
custom mode that allows for a user-defined transform. The core is capable of a maximum
resolution of 7680 columns by 7680 rows with 8, 10, 12, or 16 bits per pixel and supports the
bandwidth necessary for High-definition (1080p60) resolutions in all Xilinx FPGA device
families. Higher resolutions can be supported in Xilinx high-performance device families.

You can configure and instantiate the core from the Vivado Design Suite. Core functionality
may be controlled dynamically with an optional AXI4-Lite interface.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


5
PG014 November 18, 2015
Applications

Applications
• Post-processing core for image data
• Video surveillance
• Video conferencing
• Machine vision
• Other imaging applications

Licensing and Ordering Information


This Xilinx LogiCORE IP module is provided at no cost under the terms of the Xilinx Core
License Agreement. The module is shipped as part of the Vivado Design Suite. For full
access to all core functionalities in simulation and in hardware, you must purchase a license
for the core. Contact your local Xilinx sales representative for information about pricing and
availability.

For more information, visit the YCrCb to RGB Color-Space Converter product web page.

Information about other Xilinx LogiCORE IP modules is available at the Xilinx Intellectual
Property page. For information on pricing and availability of other Xilinx LogiCORE IP
modules and tools, contact your local Xilinx sales representative.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


6
PG014 November 18, 2015
Chapter 2

Product Specification

Standards
The YCrCb to RGB Color-Space Converter core is compliant with the AXI4-Stream Video
Protocol and AXI4-Lite interconnect standards. Refer to the Video IP: AXI Feature Adoption
section of the AXI Reference Guide [Ref 1] for additional information.

Performance
The following sections detail the performance characteristics of the YCrCb to RGB
Color-Space Converter core.

Maximum Frequencies
This section contains typical clock frequencies for the target devices. The maximum
achievable clock frequency can vary. The maximum achievable clock frequency and all
resource counts can be affected by other tool options, additional logic in the device, using
a different version of Xilinx tools and other factors. See Table 2-1 through Table 2-4 for
device-specific information.

Latency
The processing latency of the core is shown in the following equation:

Latency = 9 + 1(if has clipping) + 1(if has clamping)

This code evaluates to 11 clock cycles for typical cases (unless in “custom” mode the
clipping and/or clamping circuits are not used).

Throughput
The YCrCb to RGB Color Space Converter core outputs one YCbCr 4:4:4 sample per clock
cycle.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


7
PG014 November 18, 2015
Resource Utilization

Resource Utilization
Table 2-1 through Table 2-4 were generated using Vivado Design Suite with the AXI4-Lite
interface, INTC_IF, and the Debug Features disabled. UltraScale™ results are expected to
be similar to 7 series results.

Table 2‐1: Kintex‐7 FPGA and Zynq‐7000 Devices with Kintex Based Programmable Logic
Clock
Data Width Slice FFs Slice LUTs LUT6‐FF pairs DSPs Frequency
(MHz)
8 237 248 274 8 234

10 275 272 295 8 234

12 313 311 336 8 234

16 389 375 410 8 234

Table 2‐2: Artix‐7 FPGA and Zynq‐7000 Devices with Artix Based Programmable Logic
Clock
Data Width Slice FFs Slice LUTs LUT6‐FF pairs DSPs Frequency
(MHz)
8 237 248 268 8 188

10 275 271 293 8 188

12 313 311 338 8 196

16 389 374 405 8 172

Table 2‐3: Virtex‐7 FPGA Performance


Clock
Data Width Slice FFs Slice LUTs LUT6‐FF pairs DSPs Frequency
(MHz)
8 237 247 268 8 234

10 275 272 294 8 234

12 313 311 343 8 234

16 389 375 402 8 234

Table 2‐4: Zynq‐7000 Device Performance


Clock
Data Width Slice FFs Slice LUTs LUT6‐FF pairs DSPs Frequency
(MHz)
8 237 248 272 8 226

10 275 272 295 8 226

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


8
PG014 November 18, 2015
Core Interfaces and Register Space

Table 2‐4: Zynq‐7000 Device Performance (Cont’d)


Clock
Data Width Slice FFs Slice LUTs LUT6‐FF pairs DSPs Frequency
(MHz)
12 313 311 338 8 234

16 389 375 405 8 234

Core Interfaces and Register Space


Port Descriptions
The YCrCb to RGB Color-Space Converter core uses industry standard control and data
interfaces to connect to other system components. The following sections describe the
various interfaces available with the core. Figure 2-1 illustrates an I/O diagram of the
YCrCb2RGB core. Some signals are optional and not present for all configurations of the
core. The AXI4-Lite interface and the IRQ pin are present only when the core is configured
via the GUI with an AXI4-Lite control interface. The INTC_IF interface is present only when
the core is configured via the GUI with the INTC interface enabled.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


9
PG014 November 18, 2015
Core Interfaces and Register Space

X-Ref Target - Figure 2-1

9#R#B TO 2'" #OLOR 3PACE #ONVERTER


S?AXIS?VIDEO?TDATA M?AXIS?VIDEO?TDATA
!8) 3TREAM S?AXIS?VIDEO?TVALID M?AXIS?VIDEO?TVALID !8) 3TREAM
3LAVE INPUT S?AXIS?VIDEO?TREADY M?AXIS?VIDEO?TREADY -ASTER OUTPUT
)NTERFACE S?AXIS?VIDEO?TLAST M?AXIS?VIDEO?TLAST )NTERFACE
S?AXIS?VIDEO?TUSER M?AXIS?VIDEO?TUSER

S?AXI?AWADDR;=
S?AXI?AWVALID
S?AXI?ACLK
S?AXI?ACLKEN
S?AXI?ARESETN
S?AXI?AWREADY IRQ
S?AXI?WDATA;=
S?AXI?WSTRB;= ).4#?IF
S?AXI?WVALID
S?AXI?WREADY
/PTIONAL S?AXI?BRESP;=
!8) ,ITE
S?AXI?BVALID
#ONTROL
)NTERFACE S?AXI?BREADY
S?AXI?ARADDR;=
S?AXI?ARVALID
S?AXI?ARREADY
S?AXI?RDATA;=
S?AXI?RRESP;=
S?AXI?RVALID
S?AXI?RREADY

ACLK
ACLKEN
ARESETN
8

Figure 2‐1: YCrCb2RGB Core Top‐Level Signaling Interface

Common Interface Signals


Table 2-5 summarizes the signals which are either shared by, or not part of the dedicated
AXI4-Stream data or AXI4-Lite control interfaces.

Table 2‐5: Common Interface Signals


Signal Name Direction Width Description
ACLK In 1 Video Core Clock
ACLKEN In 1 Video Core Active High Clock Enable
ARESETn In 1 Video Core Active Low Synchronous Reset
INTC_IF Optional External Interrupt Controller Interface. Available only
Out 6
when INTC_IF is selected on GUI.
IRQ Optional Interrupt Request Pin. Available only when AXI4-Liter
Out 1
interface is selected on GUI.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


10
PG014 November 18, 2015
Core Interfaces and Register Space

The ACLK, ACLKEN and ARESETn signals are shared between the core and the AXI4-Stream
data interfaces. The AXI4-Lite control interface has its own set of clock, clock enable and
reset pins: S_AXI_ACLK, S_AXI_ACLKEN and S_AXI_ARESETn. Refer to The Interrupt
Subsystem for a description of the INTC_IF and IRQ pins.

ACLK
The AXI4-Stream interface must be synchronous to the core clock signal ACLK. All
AXI4-Stream interface input signals are sampled on the rising edge of ACLK. All
AXI4-Stream output signal changes occur after the rising edge of ACLK. The AXI4-Lite
interface is unaffected by the ACLK signal.

ACLKEN
The ACLKEN pin is an active-high, synchronous clock-enable input pertaining to
AXI4-Stream interfaces. Setting ACLKEN low (de-asserted) halts the operation of the core
despite rising edges on the ACLK pin. Internal states are maintained, and output signal
levels are held until ACLKEN is asserted again. When ACLKEN is de-asserted, core inputs are
not sampled, except ARESETn, which supersedes ACLKEN. The AXI4-Lite interface is
unaffected by the ACLKEN signal.

ARESETn
The ARESETn pin is an active-low, synchronous reset input pertaining to only AXI4-Stream
interfaces. ARESETn supersedes ACLKEN, and when set to 0, the core resets at the next
rising edge of ACLK even if ACLKEN is de-asserted. The ARESETn signal must be
synchronous to the ACLK and must be held low for a minimum of 32 clock cycles of the
slowest clock. The AXI4-Lite interface is unaffected by the ARESETn signal.

Data Interface
The YCrCb2RGB core receives and transmits data using AXI4-Stream interfaces that
implement a video protocol as defined in the Video IP: AXI Feature Adoption section of the
AXI Reference Guide [Ref 1].

AXI4‐Stream Signal Names and Descriptions


Table 2-6 describes the AXI4-Stream signal names and descriptions.

Table 2‐6: AXI4‐Stream Data Interface Signal Descriptions


Signal Name Direction Width Description
s_axis_video_tdata In 24,32,40,48 Input Video Data
s_axis_video_tvalid In 1 Input Video Valid Signal
s_axis_video_tready Out 1 Input Ready

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


11
PG014 November 18, 2015
Core Interfaces and Register Space

Table 2‐6: AXI4‐Stream Data Interface Signal Descriptions


Signal Name Direction Width Description
s_axis_video_tuser In 1 Input Video Start Of Frame
s_axis_video_tlast In 1 Input Video End Of Line
m_axis_video_tdata Out 24,32,40,48 Output Video Data
m_axis_video_tvalid Out 1 Output Valid
m_axis_video_tready In 1 Output Ready
m_axis_video_tuser Out 1 Output Video Start Of Frame
m_axis_video_tlast Out 1 Output Video End Of Line

Video Data
The AXI4-Stream interface specification restricts TDATA widths to integer multiples of
8 bits. Therefore, 10 and 12 bit sensor data must be padded with zeros on the MSB to form
Nx8 bit wide vector before connecting to s_axis_video_tdata. Padding does not affect
the size of the core.

For example, YCC data on the YCrCb2RGB input s_axis_video_tdata is packed and
padded to multiples of 8 bits as necessary, as seen in Figure 2-2. Zero padding the most
significant bits only necessary for 10 and 12 bits wide data.
X-Ref Target - Figure 2-2

 PAD #OMPONENT #R #OMPONENT #B #OMPONENT 9

     BIT 

8

Figure 2‐2: YCrCb Data Encoding on s_axis_video_tdata

Similarly, RGB data on the YCrCb2RGB output m_axis_video_tdata is packed and


padded to multiples of 8 bits as necessary, as seen in Figure 2-3. Zero padding the most
significant bits is only necessary for 10 and 12 bit wide data.
X-Ref Target - Figure 2-3

 PAD #OMPONENT 2 #OMPONENT " #OMPONENT '

     BIT 

8

Figure 2‐3: RGB Data Encoding on m_axis_video_tdata

READY/VALID Handshake
A valid transfer occurs whenever READY, VALID, ACLKEN, and ARESETn are high at the
rising edge of ACLK, as seen in Figure 2-4. During valid transfers, DATA only carries active

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


12
PG014 November 18, 2015
Core Interfaces and Register Space

video data. Blank periods and ancillary data packets are not transferred via the AXI4-Stream
video protocol.

Guidelines on Driving s_axis_video_tvalid


Once s_axis_video_tvalid is asserted, no interface signals (except the YCrCb2RGB
core driving s_axis_video_tready) may change value until the transaction completes
(s_axis_video_tready, s_axis_video_tvalid ACLKEN high on the rising edge of
ACLK). Once asserted, s_axis_video_tvalid may only be de-asserted after a
transaction has completed. Transactions may not be retracted or aborted. In any cycle
following a transaction, s_axis_video_tvalid can either be de-asserted or remain
asserted to initiate a new transfer.
X-Ref Target - Figure 2-4

Figure 2‐4: Example of READY/VALID Handshake, Start of a New Frame

Guidelines on Driving m_axis_video_tready


The m_axis_video_tready signal may be asserted before, during or after the cycle in
which the YCrCb2RGB core asserted m_axis_video_tvalid. The assertion of
m_axis_video_tready may be dependent on the value of m_axis_video_tvalid. A slave
that can immediately accept data qualified by m_axis_video_tvalid, should pre-assert
its m_axis_video_tready signal until data is received. Alternatively,
m_axis_video_tready can be registered and driven the cycle following VALID
assertion. It is recommended that the AXI4-Stream slave should drive READY
independently, or pre-assert READY to minimize latency.

Start of Frame Signals ‐ m_axis_video_tuser0, s_axis_video_tuser0


The Start-Of-Frame (SOF) signal, physically transmitted over the AXI4-Stream TUSER0
signal, marks the first pixel of a video frame. The SOF pulse is 1 valid transaction wide, and
must coincide with the first pixel of the frame, as seen in Figure 2-4. SOF serves as a frame
synchronization signal, which allows downstream cores to re-initialize, and detect the first
pixel of a frame. The SOF signal may be asserted an arbitrary number of ACLK cycles before
the first pixel value is presented on DATA, as long as a VALID is not asserted.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


13
PG014 November 18, 2015
Core Interfaces and Register Space

End of Line Signals ‐ m_axis_video_tlast, s_axis_video_tlast


The End-Of-Line signal, physically transmitted over the AXI4-Stream TLAST signal, marks
the last pixel of a line. The EOL pulse is 1 valid transaction wide, and must coincide with the
last pixel of a scan-line, as seen in Figure 2-5.
X-Ref Target - Figure 2-5

Figure 2‐5: Use of EOL and SOF Signals

Control Interface
When configuring the core, you can add an AXI4-Lite register interface to dynamically
control the behavior of the core. The AXI4-Lite slave interface facilitates integrating the core
into a processor system, or along with other video or AXI4-Lite compliant IP, connected via
AXI4-Lite interface to an AXI4-Lite master. In a static configuration with a fixed set of
parameters (constant configuration), the core can be instantiated without the AXI4-Lite
control interface, which reduces the core Slice footprint.

Constant Configuration
The constant configuration caters to users who will use the core in one setup that will not
need to change over time. In constant configuration the image resolution (number of active
pixels per scan line and the number of active scan lines per frame), and the other core
parameters are hard coded into the core via the YCrCb2RGB core GUI. Since there is no
AXI4-Lite interface, the core is not programmable, but can be reset, enabled, or disabled
using the ARESETn and ACLKEN ports.

AXI4‐Lite Interface
The AXI4-Lite interface allows a user to dynamically control parameters within the core.
Core configuration can be accomplished using an AXI4-Stream master state machine, or an
embedded ARM or soft system processor such as MicroBlaze.

The YCrCb2RGB core can be controlled via the AXI4-Lite interface using read and write
transactions to the YCrCb2RGB register space.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


14
PG014 November 18, 2015
Core Interfaces and Register Space

Table 2‐7: AXI4‐Lite Interface Signals


Signal Name Direction Width Description
s_axi_aclk In 1 AXI4-Lite clock
s_axi_aclken In 1 AXI4-Lite clock enable
s_axi_aresetn In 1 AXI4-Lite synchronous Active Low reset
s_axi_awvalid In 1 AXI4-Lite Write Address Channel Write Address Valid.
s_axi_awread AXI4-Lite Write Address Channel Write Address Ready. Indicates DMA
Out 1
ready to accept the write address.
s_axi_awaddr In 32 AXI4-Lite Write Address Bus
s_axi_wvalid In 1 AXI4-Lite Write Data Channel Write Data Valid.
s_axi_wready AXI4-Lite Write Data Channel Write Data Ready. Indicates DMA is ready to
Out 1
accept the write data.
s_axi_wdata In 32 AXI4-Lite Write Data Bus
s_axi_bresp Out 2 AXI4-Lite Write Response Channel. Indicates results of the write transfer.
s_axi_bvalid AXI4-Lite Write Response Channel Response Valid. Indicates response is
Out 1
valid.
s_axi_bready AXI4-Lite Write Response Channel Ready. Indicates target is ready to
In 1
receive response.
s_axi_arvalid In 1 AXI4-Lite Read Address Channel Read Address Valid
s_axi_arready Out 1 Ready. Indicates DMA is ready to accept the read address.
s_axi_araddr In 32 AXI4-Lite Read Address Bus
s_axi_rvalid Out 1 AXI4-Lite Read Data Channel Read Data Valid
s_axi_rready AXI4-Lite Read Data Channel Read Data Ready. Indicates target is ready to
In 1
accept the read data.
s_axi_rdata Out 32 AXI4-Lite Read Data Bus
s_axi_rresp AXI4-Lite Read Response Channel Response. Indicates results of the read
Out 2
transfer.

S_AXI_ACLK
The AXI4-Lite interface must be synchronous to the S_AXI_ACLK clock signal. The
AXI4-Lite interface input signals are sampled on the rising edge of ACLK. The AXI4-Lite
output signal changes occur after the rising edge of ACLK. The AXI4-Stream interfaces
signals are not affected by the S_AXI_ACLK.

S_AXI_ACLKEN
The S_AXI_ACLKEN pin is an active-high, synchronous clock-enable input for the AXI4-Lite
interface. Setting S_AXI_ACLKEN low (de-asserted) halts the operation of the AXI4-Lite
interface despite rising edges on the S_AXI_ACLK pin. AXI4-Lite interface states are
maintained, and AXI4-Lite interface output signal levels are held until S_AXI_ACLKEN is

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


15
PG014 November 18, 2015
Core Interfaces and Register Space

asserted again. When S_AXI_ACLKEN is de-asserted, AXI4-Lite interface inputs are not
sampled, except S_AXI_ARESETn, which supersedes S_AXI_ACLKEN. The AXI4-Stream
interfaces signals are not affected by the S_AXI_ACLKEN.

S_AXI_ARESETn
The S_AXI_ARESETn pin is an active-low, synchronous reset input for the AXI4-Lite
interface. S_AXI_ARESETn supersedes S_AXI_ACLKEN, and when set to 0, the core resets
at the next rising edge of S_AXI_ACLK even if S_AXI_ACLKEN is de-asserted. The
S_AXI_ARESETn signal must be synchronous to the S_AXI_ACLK and must be held low
for a minimum of 32 clock cycles of the slowest clock. The S_AXI_ARESETn input is
resynchronized to the ACLK clock domain. The AXI4-Stream interfaces and core signals are
also reset by S_AXI_ARESETn.

Register Space
The standardized Xilinx Video IP register space is partitioned to control-, timing-, and core
specific registers. The YCrCb2RGB core uses only one timing related register, ACTIVE_SIZE
(0x0020), which allows specifying the input frame dimensions. The core has nine core
specific registers that control Matrix coefficients, the data offsets and the clip and clamp
values.

Table 2‐8: Register Names and Descriptions


Address
(hex) Register Name Access Double Default Value Register Description
BASEADDR Type Buffered
+
Bit 0: SW_ENABLE
No AXI4-Lite IF: Bit 1: REG_UPDATE
0x1 Bit 4: BYPASS(1)
0x0000 CONTROL R/W N
Power-on-Reset Bit 5: TEST_PATTERN(1)
: 0x0 Bit 30: FRAME_SYNC_RESET (1: reset)
Bit 31: SW_RESET (1: reset)
Bit 0: PROC_STARTED
0x0004 STATUS R/W No 0 Bit 1: EOF
Bit 16: SLAVE_ERROR
Bit 0: SLAVE_EOL_EARLY
Bit 1: SLAVE_EOL_LATE
0x0008 ERROR R/W No 0
Bit 2: SLAVE_SOF_EARLY
Bit 3: SLAVE_SOF_LATE
16-0: Interrupt enable bits
0x000C IRQ_ENABLE R/W No 0
corresponding to STATUS bits

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


16
PG014 November 18, 2015
Core Interfaces and Register Space

Table 2‐8: Register Names and Descriptions


Address
(hex) Access Double
BASEADDR Register Name Type Buffered Default Value Register Description
+
7-0: REVISION_NUMBER
11-8: PATCH_ID
0x0010 VERSION R N/A 0x07010000 15-12: VERSION_REVISION
23-16: VERSION_MINOR
31-24: VERSION_MAJOR
0x0014 SYSDEBUG0 R N/A 0 0-31: Frame Throughput monitor (1)
0x0018 SYSDEBUG1 R N/A 0 0-31: Line Throughput monitor(1)
0x001C SYSDEBUG2 R N/A 0 0-31: Pixel Throughput monitor(1)
12-0: Number of Active Pixels per
Specified via Scanline
0x0020 ACTIVE_SIZE R/W Yes
GUI 28-16: Number of Active Lines per
Frame
0x0100 RGBMAX R/W Yes Specified via GUI 15:0: RGB clippling value
0x0104 RGBMIN R/W Yes Specified via GUI 15:0: RGB clampling value
0x0108 ROFFSET R/W Yes Specified via GUI 31:0: Red offset compensation
0x010C GOFFSET R/W Yes Specified via GUI 31:0: Green offset compensation
0x0110 BOFFSET R/W Yes Specified via GUI 31:0: Blue offset compensation
0x0114 ACOEF R/W Yes Specified via GUI 17:0: ACOEF, BCOEF, CCOEF, DCOEF are
derived from CA, CB, CC and CD, by
0x0118 BCOEF R/W Yes Specified via GUI
calculating the inverse multiplication
0x011C CCOEF R/W Yes Specified via GUI matrix and representing as a 17-bit
0x0120 DCOEF R/W Yes Specified via GUI
fixed point number.

1. Only available when the debugging features option is enabled in the GUI at the time the core is instantiated.

CONTROL (0x0000) Register


Bit 0 of the CONTROL register, SW_ENABLE, facilitates enabling and disabling the core from
software. Writing '0' to this bit effectively disables the core halting further operations,
which blocks the propagation of all video signals. The default value of SW enable is 1
(enabled) for the Constant configuration. After Power up, or Global Reset, the SW_ENABLE
defaults to 0 for the AXI4-Lite interface. Similar to the ACLKEN pin, the SW_ENABLE flag is
not synchronized with the AXI4-Stream interfaces: Enabling or Disabling the core takes
effect immediately, irrespective of the core processing status. Disabling the core for
extended periods may lead to image tearing.

Bit 1 of the CONTROL register, REG_UPDATE is a write done semaphore for the host
processor, which facilitates committing all user and timing register updates simultaneously.
The YCrCb2RGB core ACTIVE_SIZE and core specific registers are double buffered. One
set of registers (the processor registers) is directly accessed by the processor interface,

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


17
PG014 November 18, 2015
Core Interfaces and Register Space

while the other set (the active set) is actively used by the core. New values written to the
processor registers will get copied over to the active set at the end of the AXI4-Stream
frame, if and only if REG_UPDATE is set. Setting REG_UPDATE to 0 before updating multiple
register values, then setting REG_UPDATE to 1 when updates are completed ensures all
registers are updated simultaneously at the frame boundary without causing image tearing.

Bit 4 of the CONTROL register, BYPASS, switches the core to bypass mode if debug features
are enabled. In bypass mode the YCrCb2RGB core processing function is bypassed, and the
core repeats AXI4-Stream input samples on its output. Refer to Debug Tools in Appendix C
for more information. If debug features were not included at instantiation, this flag has no
effect on the operation of the core. Switching bypass mode on or off is not synchronized to
frame processing, therefore can lead to image tearing.

Bit 5 of the CONTROL register, TEST_PATTERN, switches the core to test-pattern generator
mode if debug features are enabled. Refer to Debug Tools in Appendix C for more
information. If debug features were not included at instantiation, this flag has no effect on
the operation of the core. Switching test-pattern generator mode on or off is not
synchronized to frame processing, therefore can lead to image tearing.

Bits 30 and 31 of the CONTROL register, FRAME_SYNC_RESET and SW_RESET facilitate


software reset. Setting SW_RESET reinitializes the core to GUI default values, all internal
registers and outputs are cleared and held at initial values until SW_RESET is set to 0. The
SW_RESET flag is not synchronized with the AXI4-Stream interfaces. Resetting the core
while frame processing is progress will cause image tearing. For applications where the
soft-ware reset functionality is desirable, but image tearing has to be avoided a frame
synchronized software reset (FRAME_SYNC_RESET) is available. Setting
FRAME_SYNC_RESET to 1 will reset the core at the end of the frame being processed, or
immediately if the core is between frames when the FRAME_SYNC_RESET was asserted.
After reset, the FRAME_SYNC_RESET bit is automatically cleared, so the core can get ready
to process the next frame of video as soon as possible. The default value of both RESET bits
is 0. Core instances with no AXI4-Lite control interface can only be reset via the ARESETn
pin.

STATUS (0x0004) Register


All bits of the STATUS register can be used to request an interrupt from the host processor.
To facilitate identification of the interrupt source, bits of the STATUS register remain set
after an event associated with the particular STATUS register bit, even if the event condition
is not present at the time the interrupt is serviced.

Bits of the STATUS register can be cleared individually by writing '1' to the bit position.

Bit 0 of the STATUS register, PROC_STARTED, indicates that processing of a frame has
commenced via the AXI4-Stream interface.

Bit 1 of the STATUS register, End-of-frame (EOF), indicates that the processing of a frame
has completed.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


18
PG014 November 18, 2015
Core Interfaces and Register Space

Bit 16 of the STATUS register, SLAVE_ERROR, indicates that one of the conditions
monitored by the ERROR register has occurred.

ERROR (0x0008) Register


Bit 4 of the STATUS register, SLAVE_ERROR, indicates that one of the conditions monitored
by the ERROR register has occurred. This bit can be used to request an interrupt from the
host processor. To facilitate identification of the interrupt source, bits of the STATUS and
ERROR registers remain set after an event associated with the particular ERROR register bit,
even if the event condition is not present at the time the interrupt is serviced.

Bits of the ERROR register can be inverted individually by writing '1' to the bit position to be
cleared.

Bit 0 of the ERROR register, EOL_EARLY, indicates an error during processing a video frame
via the AXI4-Stream slave port. The number of pixels received between the latest and the
preceding End-Of-Line (EOL) signal was less than the value programmed into the
ACTIVE_SIZE register.

Bit 1 of the ERROR register, EOL_LATE, indicates an error during processing a video frame
via the AXI4-Stream slave port. The number of pixels received between the last EOL signal
surpassed the value programmed into the ACTIVE_SIZE register.

Bit 2 of the ERROR register, SOF_EARLY, indicates an error during processing a video frame
via the AXI4-Stream slave port. The number of pixels received between the latest and the
preceding Start-Of-Frame (SOF) signal was less than the value programmed into the
ACTIVE_SIZE register.

Bit 3 of the ERROR register, SOF_LATE, indicates an error during processing a video frame
via the AXI4-Stream slave port. The number of pixels received between the last SOF signal
surpassed the value programmed into the ACTIVE_SIZE register.

IRQ_ENABLE (0x000C) Register


Any bits of the STATUS register can generate a host-processor interrupt request via the IRQ
pin. The Interrupt Enable register facilitates selecting which bits of STATUS register will
assert IRQ. Bits of the STATUS registers are masked by (AND) corresponding bits of the
IRQ_ENABLE register and the resulting terms are combined (OR) together to generate IRQ.

Version (0x0010) Register


Bit fields of the Version Register facilitate software identification of the exact version of the
hardware peripheral incorporated into a system. The core driver can take advantage of this
Read-Only value to verify that the software is matched to the correct version of the
hardware. See Table 2-8 for more information.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


19
PG014 November 18, 2015
Core Interfaces and Register Space

SYSDEBUG0 (0x0014) Register


The SYSDEBUG0, or Frame Throughput Monitor, register indicates the number of frames
processed since power-up or the last time the core was reset. The SYSDEBUG registers can
be useful to identify external memory / Frame buffer / or throughput bottlenecks in a video
system. Refer to Debug Tools in Appendix C for more information.

SYSDEBUG1 (0x0018) Register


The SYSDEBUG1, or Line Throughput Monitor, register indicates the number of lines
processed since power-up or the last time the core was reset. The SYSDEBUG registers can
be useful to identify external memory / Frame buffer / or throughput bottlenecks in a video
system. Refer to Debug Tools in Appendix C for more information.

SYSDEBUG2 (0x001C) Register


The SYSDEBUG2, or Pixel Throughput Monitor, register indicates the number of pixels
processed since power-up or the last time the core was reset. The SYSDEBUG registers can
be useful to identify external memory / Frame buffer / or throughput bottlenecks in a video
system. Refer to Debug Tools in Appendix C for more information.

ACTIVE_SIZE (0x0020) Register


The ACTIVE_SIZE register encodes the number of active pixels per scan line and the
number of active scan lines per frame. The lower half-word (bits 12:0) encodes the number
of active pixels per scan line. Supported values are between 32 and the value provided in
the Maximum number of pixels per scan line field in the GUI. The upper half-word (bits
28:16) encodes the number of active pixels per scan line. Supported values are 32 to 7680.
To avoid processing errors, you should restrict values written to ACTIVE_SIZE the range
supported by the core instance.

RGBMAX (0x0100) Register


The RGBMAX register holds the maximum value allowed on the Red, Green and Blue
channels of the output. If the output data is greater than this value, then this value replaces
it on the output. This register is only valid if "Outputs Clipped" is selected in the core
parameterization GUI.

RGBMIN (0x0104) Register


The YMin register holds the minimum value allowed on the Red, Green and Blue channels of
the output. If the output data is less than this value, then this value replaces it on the
output. This register is only valid if "Outputs Clamped" is selected in the core
parameterization GUI.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


20
PG014 November 18, 2015
Core Interfaces and Register Space

ROFFSET (0x0108) Register


The ROFFSET register holds the offset compensation value for the Red channel.

GOFFSET(0x010C) Register
The GOFFSET register holds the offset compensation value for the Green channel.

BOFFSET (0x0110) Register


The BOFFSET register holds the offset compensation value for the Blue channel.

ACOEF (0x0114) Register


The ACOEF register holds the transformed CA coefficient expressed as an 18.16 floating
point number.

BCOEF (0x0118) Register


The BCOEF register holds the transformed CB coefficient expressed as an 18.16 floating
point number.

CCOEF (0x011C) Register


The CCOEF register holds the transformed CC coefficient expressed as an 18.16 floating
point number.

DCOEF (0x0120) Register


The DCOEF register holds the transformed CD coefficient expressed as an 18.16 floating
point number.

The Interrupt Subsystem


STATUS register bits can trigger interrupts so embedded application developers can
quickly identify faulty inter-faces or incorrectly parameterized cores in a video system.
Irrespective of whether the AXI4-Lite control interface is present or not, the YCrCb2RGB
core detects AXI4-Stream framing errors, as well as the beginning and the end of frame
processing.

When the core is instantiated with an AXI4-Lite Control interface, the optional interrupt
request pin (IRQ) is present. Events associated with bits of the STATUS register can
generate a (level triggered) interrupt, if the corresponding bits of the interrupt enable
register (IRQ_ENABLE) are set. Once set by the corresponding event, bits of the STATUS
register stay set until the application clears them by writing '1' to the desired bit positions.
Using this mechanism the system processor can identify and clear the interrupt source.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


21
PG014 November 18, 2015
Core Interfaces and Register Space

Without the AXI4-Lite interface, the application can still benefit from the core signaling
error and status events. By selecting the Enable INTC Port check-box on the GUI, the core
generates the optional INTC_IF port. This vector of signals gives parallel access to the
individual interrupt sources, as seen in Table 2-9.

Unlike STATUS and ERROR flags, INTC_IF signals are not held, rather stay asserted only
while the corresponding event persists.

Table 2‐9: INTC_IF Signal Functions


INTC_IF signal Function
0 Frame processing start
1 Frame processing complete
2 Reserved
3 Reserved
4 Video over AXI4-Stream Error
5 EOL Early
6 EOL Late
7 SOF Early
8 SOF Late

In a system integration tool, the interrupt controller INTC IP can be used to register the
selected INTC_IF signals as edge triggered interrupt sources. The INTC IP provides
functionality to mask (enable or disable), as well as identify individual interrupt sources
from software. Alternatively, for an external processor or MCU, you can custom build a
priority interrupt controller to aggregate interrupt requests and identify interrupt sources.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


22
PG014 November 18, 2015
Chapter 3

Designing with the Core

General Design Guidelines


The YCrCb2RGB core converts YCrCb 4:4:4 (or YUV 4:4:4) video data into RGB video data.The
core processes samples provided via an AXI4-Stream slave interface, outputs pixels via an
AXI4-Stream master interface, and can be controlled via an optional AXI4-Lite interface. The
YCrCb2RGB block cannot change the input/output image sizes, the input and output pixel
clock rates, or the frame rate. It is recommended that the YCrCb2RGB core is used in
conjunction with the Video In to AXI4-Stream and Video Timing Controller cores. The Video
Timing Controller core measures the timing parameters, such as number of active scan
lines, number of active pixels per scan line of the image sensor. The Video In to AXI4-Stream
core converts a standard parallel clocked video interface with syncs and or blanks to
AXI4-Stream Video protocol as defined in the Video IP: AXI Feature Adoption section of the
AXI Reference Guide [Ref 1].

Typically, the YCrCb to RGB core is part of an Image Sensor Pipeline (ISP) System, as shown
in Figure 3-1.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


23
PG014 November 18, 2015
Color‐Space Conversion Background

X-Ref Target - Figure 3-1

/HJHQG
$;,/LWH
9LUWXDO
&RQQHFWLRQ ,PDJH6HQVRU3LSHOLQH
VRIWZDUH
$;,6 6WXFN &RORU)LOWHU 7HVW &RORU 5*% <&E&U
$;,6WUHDP ,QSXW ,PDJH *DPPD ,PDJH
3L[HO $UUD\ 3DWWHUQ &RUUHFWLRQ WR WR
6WDWLVWLFV &RUUHFWLRQ (QKDQFHPHQW
,QWHUIDFH &RUUHFWLRQ ,QWHUSRODWLRQ *HQHUDWRU 0DWUL[ <&E&U 5*%
YLGHR YLGHR
9LGHRWR < < 5*% 5*% 5*% 5*% 5*% <&& <&& 5*% $;,6 +'0,
GDWD GDWD
6HQVRU
WLPLQJ $;,6
63& &)$

73*

6WDWV

&&0

Ȗ 
&6&

(QKDQFH

&6&

WRYLGHR WLPLQJ 3+<

WLPLQJ
WLPLQJ

97& 97&
9LGHR 9LGHR
7LPLQJ 7LPLQJ
'HWHFWRU *HQHUDWRU
$;,/LWH

97& '3& &)$ 73* 6WDWV &&0 *DPPD &6& (QKDQFH &6& 97&
GULYHU GULYHU GULYHU GULYHU GULYHU GULYHU GULYHU GULYHU GULYHU GULYHU GULYHU

6HQVRU
$* $:%
*DLQ

6HQVRU *OREDO
$(
([SRVXUH &RQWUDVW (PEHGGHG3URFHVVRU
;

Figure 3‐1: Image Sensor Pipeline System with YCrCb to RGB Core

Color‐Space Conversion Background


RGB Color Space
The red, green and blue (RGB) color space is widely used throughout computer graphics.
Red, green and blue are three primary additive colors: individual components are added
together to form a desired color, and are represented by a three dimensional, Cartesian
coordinate system, as shown in Figure 3-2.

Table 3-1 presents the RGB values for 100% saturated color bars, a common video test
signal.

Table 3‐1: 100% RGB Color Bars


Normal White Yellow Cyan Green Magenta Red Blue Black
Range
R 0 to 255 255 255 0 0 255 255 0 0

G 0 to 255 255 255 255 255 0 0 0 0

B 0 to 255 255 0 255 0 255 0 255 0

The RGB color space is the most prevalent choice for computer graphics because color
displays use red, green and blue to create the desired color. Also, a system that is designed

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


24
PG014 November 18, 2015
Color‐Space Conversion Background

using the RGB color space can take advantage of a large number of existing software
algorithms.

However, RGB is not very efficient when dealing with real-world images. All three
components need equal bandwidth to generate arbitrary colors within the RGB color cube.
Also, processing an image in the RGB color space is usually not the most efficient method.
For example, to modify the intensity or color of a given pixel, all three RGB values must be
read, modified and written back to the frame buffer. If the system had access to the image
stored in the intensity and color format, the process would be faster.

R'G'B' Color Space


While the RGB color space is ideal to represent computer graphics, 8-bit linear-light coding
performs poorly for images to be viewed. It is necessary to have 12 or 14 bits per
component to achieve excellent quality. The best perceptual use is made of a limited
number of bits by using nonlinear coding that mimics the nonlinear response of human
vision. In video, JPEG, MPEG, computing, digital photography, and many other domains, a
nonlinear transfer function is applied to the RGB signals to give nonlinearly coded
gamma-corrected components, denoted with symbols R'G'B'. Excellent image quality can
be obtained with 10-bit nonlinear coding with a transfer function similar to that of Rec. 709
or RGB.

YUV Color Space


The YUV color space is used by the analog PAL, NTSC and SECAM color video/TV standards.
In the past, black and white systems used only the luminance (Y) information. Chrominance
information (U and V) was added in such a way that a black and white receiver can still
display a normal black and white picture.

YCrCb (or YCbCr) Color Space


The YCrCb or YCbCr color space was developed as part of the ITU-R BT.601 during the
development of a world-wide digital component video standard. YCbCr is a scaled, offset
version of the YUV color space. Y has a nominal range of 16-235; Cb and Cr have a nominal
range of 16-240. There are several YCbCr sampling formats, such as 4:4:4, 4:2:2 and 4:2:0.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


25
PG014 November 18, 2015
Color‐Space Conversion Background

X-Ref Target - Figure 3-2

DS659_01_032408

Figure 3‐2: RGB and YCrCb Color Representations

Conversion Equations
Derivation of Conversion Equations
To generate the luminance (Y, or gray value) component, biometric experiments were
employed to measure how the human eye perceives the intensities of the red, green and
blue colors. Based on these experiments, optimal values for coefficients CA and CB were
determined, such that:

Y = CA R +  1 – CA – CB  G + CB B Equation 3‐1

Actual values for CA and CB differ slightly in different standards.

Conversion from the RGB color space to luminance and chrominance (differential color
components) could be described with the following equation:

Y CA 1 – CA – CB CB R
R – Y = 1 – CA CA + CB – 1 – CB G Equation 3‐2
B–Y – CA CA + CB – 1 1 – CB B

Coefficients CA and CB are chosen between 0 and 1, which guarantees that the range of Y
is constrained between the maximum and the minimum RGB values permitted, RGB max and
RGBmin respectively.

In most practical implementations, the range of the luminance and chrominance


components should be equal. There are two ways to accomplish this: the chrominance
components (B-Y and R-Y) can be normalized (compressed and offset compensated), or
values above and below the luminance range can be clipped/clamped.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


26
PG014 November 18, 2015
Color‐Space Conversion Background

Both clipping and dynamic range compression results in loss of information; however, the
introduced artifacts are different. To leverage differences in the input (RGB) range, different
standards choose different tradeoffs between clipping and normalization.

The YCrCb to RGB Color-Space Converter core supports only the conversions that fit the
following general form:

Y CA 1 – CA – CB CB R OY
C R = CC  1 – CA  CC  CA + CB – 1  CC  – CB  G + O Cr Equation 3‐3
CB CD  – CA  CD  CA + CB – 1  CD  1 – CB  B O Cb

CC and CD allow dynamic range compression for B-Y and R-Y, and constants OY and O C
facilitate offset compensation for the resulting CB and CR. To avoid arithmetic under- and
overflows while converting from the RGB to the YCrCb domain, with RGB values in the [0.1]
range, a choice for CC and CD is:
1 1
CC = ------------------------- CD = ------------------------- Equation 3‐4
2  1 – CA  2  1 – CB 
The YCrCb to RGB core facilitates both range de-compression and optional clipping and
clamping. Range, offset, clipping and clamping levels are parameterizable.

By inverting the transformation matrix in Equation 3-3, the transformation from the YCrCb
color space to the RGB color space can be defined as:

1 1  CC 0 Y – OY
R
– CA – CB
G = 1 -------------------------------------------- -------------------------------------------- C R – O Cr Equation 3‐5
CC  1 – CA – CB  CD  1 – CA – CB 
B C B – O Cb
1 0 1  CD
Hardware Implementation
The YCrCb to RGB color-space transformation (Equation 3-5) can be expressed as:

R = Y – O Y + ACOEF  C R – O Cr  Equation 3‐6

G = Y – O Y + BCOEF  C R – O Cr  + CCOEF  C B – O Cb  Equation 3‐7

B = Y – O Y + DCOEF  C B – O Cb  Equation 3‐8

This cannot efficiently utilize the MADD capabilities of XtremeDSP slices. As offsets and
coefficients are constants, the preceding equations can be rewritten as:

R = ACOEF  C R + ROFFSET + Y Equation 3‐9

G = BCOEF  C R + CCOEF  C B + GOFFSET + Y Equation 3‐10

B = DCOEF  C B + BOFFSET + Y Equation 3‐11

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


27
PG014 November 18, 2015
Color‐Space Conversion Background

This can be directly mapped to the architecture shown in Figure 3-3. The blue and gray
boxes represent logic blocks, which are always implemented using XtremeDSP slices.
X-Ref Target - Figure 3-3

Round
Y

BCOE G

Cr ROFFSET MAX MIN

ACOEF R

MAX MIN
CCOEF

Cb GOFFSET

DCOEF B

BOFFSET MAX MIN


DS659_02_032408

Figure 3‐3: YcrCb to RGB Schematic

Assigning Values to Design Parameters


The following section specifies parameter values for some widely used standards. Most
parameter values, except for COEF and OFFSET parameters, can be assigned from Table 3-2,
Table 3-3 and Table 3-4 directly. These parameters have to be calculated, scaled and
rounded before assigning integer values to corresponding VHDL parameters, using the
following equations:
1
ACOEF = -------- Equation 3‐12
CC
– CA
BCOEF = -------------------------------------------- Equation 3‐13
CC  1 – CA – CB 
– CB
CCOEF = -------------------------------------------- Equation 3‐14
CD  1 – CA – CB 
1
DCOEF = -------- Equation 3‐15
CD
Coefficients are passed to the core in 17 bits wide two's complement format. Y, Cr and Cb
are passed as DATA_WIDTH bits wide unsigned integers. MWIDTH is preset to Min(32,
DATA_WIDTH+17).
MWIDTH – DATA_WIDTH
ROUNDING_CONST = 2 Equation 3‐16

Equation 3‐17
ROFFSET = ROUNDING_CONST –  ACOEF  CROFFSET + YOFSET   SCALE_M

Equation 3‐18
GOFFSET = ROUNDING_CONST –   BOEF + CROFFSET  + (CCOEF X CBOFFSET) + YOFFSET   SCALE_M

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


28
PG014 November 18, 2015
Color‐Space Conversion Background

Equation 3‐19
BOFFSET = ROUNDING_CONST –  DCOEF  CBOFFSET + YOFFSET   SCALE_M
MWDITH – IWIDTH – 17
SCALE_M = 2 Equation 3‐20

ITU 601 (SD) and 709 ‐ 1125/60 (NTSC) Standard Conversion Coefficients

Table 3‐2: Parameterization Values for the SD (ITU 601) and NTSC HD (ITU 709) Standards

Coefficient/ Range
Parameter 16‐240 16‐235 0‐255
CA 0.299 0.2568
CB 0.114 0.0979
CC 0.713 0.7295 0.5910
CD 0.564 0.5772
YOFFSET 2DATA_WIDTH-4
CB/CR 2DATA_WIDTH-1
YMAX 240*2 DATA_WIDTH-8 235*2 DATA_WIDTH-8 2 DATA_WIDTH-1
CMAX 240*2 DATA_WIDTH-8 235*2 DATA_WIDTH-8 2 DATA_WIDTH-1
YMIN 16*2 DATA_WIDTH-8 0
CMIN 16*2 DATA_WIDTH-8 0

Standard ITU 709 (HD) 1250/50 (PAL)

Table 3‐3: Parameterization Values for the PAL HD (ITU 709) Standard

Coefficient/ Input range


Parameter 16‐240 16‐235 0‐255
CA 0.2126 0.1819
CB 0.0722 0.0618
CC 0.6350 0.6495 0.6495
CD 0.5389 0.5512
YOFFSET 2DATA_WIDTH-4
COFFSET 2DATA_WIDTH-1
YMAX 240*2 DATA_WIDTH-8 235*2 DATA_WIDTH-8 2 DATA_WIDTH-1
CMAX 240*2 DATA_WIDTH-8 235*2 DATA_WIDTH-8 2 DATA_WIDTH-1
YMIN 16*2 DATA_WIDTH-8 0
CMIN 16*2 DATA_WIDTH-8 0

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


29
PG014 November 18, 2015
Color‐Space Conversion Background

YUV Standard

Table 3‐4: Parameterization Values for the YUV Standard

Coefficient/ Value
Parameter 16‐240 16‐235 0‐255
CA 0.299
CB 0.114
CC 0.877283
CD 0.492111
DATA_WIDTH-4
YOFFSET 2
COFFSET 2 DATA_WIDTH-1
YMAX 240*2 DATA_WIDTH-8 235*2 DATA_WIDTH-8 2 DATA_WIDTH-1
CMAX 240*2 DATA_WIDTH-8 235*2 DATA_WIDTH-8 2 DATA_WIDTH-1
YMIN 16*2 DATA_WIDTH-8 0
DATA_WIDTH-8
CMIN 16*2 0

Clipping and Clamping


Output Quantization Noise
Coefficients CC and CD in Equation 3-3 allow standard designers to trade off output
quantization and clipping noise. Actual noise inserted depends on the probability statistics
of the Cb and Cr variables, but in general if CC and CD are larger than the maximum values
calculated in Equation 3-4, output values may clip, introducing clipping noise. However, the
lower CC and CD values are chosen, the worse Cb and Cr values will use the available
dynamic range, thus introducing more quantization noise. Therefore, the designer's task is
to equalize output quantization and clipping noise insertion by carefully choosing CC and
CD values based on knowing the statistics of Cb and Cr values. For instance, when
probabilities of extreme chrominance values are small, it is beneficial to increase CC and CD
values, as the extra noise inserted by occasional clipping is less than the gain in average
signal power (and thus SQNR).

Output Clipping Noise


If coefficients CC and CD in Equation 3-3 are larger than the maximum values calculated in
Equation 3-4, Cr and Cb output values may get larger (overflow) than the maximum or
smaller (underflow) than minimum value the output representation can carry. If overflow
occurs and the design does not have clipping logic, binary values wrap around and insert
substantial noise to the output. If clamping/clipping logic is used, output values saturate
and less noise is introduced, as shown in Figure 3-4. Use of clipping and clamping increases
slice count of the design by approximately 6*DATA_WIDTH slices.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


30
PG014 November 18, 2015
Clock, Enable, and Reset Considerations

If a targeted standard limits output of values to a predefined range other than those of
binary representation, such as ITU-R BT.601-5, use of clipping and clamping logic facilitates
constraining output values to the predefined range by setting RGB max and RGBmin values
according to the standard specifications.
X-Ref Target - Figure 3-4

255
240

0 16
DS659_03_032408

Figure 3‐4: Wrap‐Around and Saturation

Clock, Enable, and Reset Considerations


ACLK
The master and slave AXI4-Stream video interfaces use the ACLK clock signal as their shared
clock reference, as shown in Figure 3-5.
X-Ref Target - Figure 3-5

6IDEO )0 h3OURCEv 6IDEO )0 #ORE 6IDEO )0 h3INKv

S?AXIS?VIDEO?TDATA M?AXIS?VIDEO?TDATA S?AXIS?VIDEO?TDATA M?AXIS?VIDEO?TDATA S?AXIS?VIDEO?TDATA M?AXIS?VIDEO?TDATA


S?AXIS?VIDEO?TVALID M?AXIS?VIDEO?TVALID S?AXIS?VIDEO?TVALID M?AXIS?VIDEO?TVALID S?AXIS?VIDEO?TVALID M?AXIS?VIDEO?TVALID
S?AXIS?VIDEO?TREADY M?AXIS?VIDEO?TREADY S?AXIS?VIDEO?TREADY M?AXIS?VIDEO?TREADY S?AXIS?VIDEO?TREADY M?AXIS?VIDEO?TREADY
S?AXIS?VIDEO?TLAST M?AXIS?VIDEO?TLAST S?AXIS?VIDEO?TLAST M?AXIS?VIDEO?TLAST S?AXIS?VIDEO?TLAST M?AXIS?VIDEO?TLAST
S?AXIS?VIDEO?TUSER M?AXIS?VIDEO?TUSER S?AXIS?VIDEO?TUSER M?AXIS?VIDEO?TUSER S?AXIS?VIDEO?TUSER M?AXIS?VIDEO?TUSER

ACLK ACLK ACLK


ACLKEN ACLKEN ACLKEN
ARESETN ARESETN ARESETN

ACLK
ACLKEN
ARESETN 8

Figure 3‐5: Example of ACLK Routing in an ISP Processing Pipeline

S_AXI_ACLK
The AXI4-Lite interface uses the S_AXI_ACLK pin as its clock source. The ACLK pin is not
shared between the AXI4-Lite and AXI4-Stream interfaces. The YCrCb to RGB core contains
clock-domain crossing logic between the ACLK (AXI4-Stream and Video Processing) and
S_AXI_ACLK (AXI4-Lite) clock domains. The core automatically ensures that the AXI4-Lite

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


31
PG014 November 18, 2015
Clock, Enable, and Reset Considerations

transactions completes even if the video processing is stalled with ARESETn, ACLKEN or
with the video clock not running.

ACLKEN
The YCrCb to RGB core has two enable options: the ACLKEN pin (hardware clock enable),
and the software reset option provided through the AXI4-Lite control interface (when
present).

ACLKEN may not be synchronized internally to AXI4-Stream frame processing therefore


de-asserting ACLKEN for extended periods of time may lead to image tearing.

The ACLKEN pin facilitates:

• Multi-cycle path designs (high speed clock division without clock gating)
• Standby operation of subsystems to save on power
• Hardware controlled bring-up of system components

IMPORTANT: When ACLKEN (clock enable) pins are used (toggled) in conjunction with a common clock
source driving the master and slave sides of an AXI4-Stream interface, to prevent transaction errors the
ACLKEN pins associated with the master and slave component interfaces must also be driven by the
same signal (Figure 2-2).

IMPORTANT: When two cores connected through AXI4-Stream interfaces, where only the master or the
slave interface has an ACLKEN port, which is not permanently tied high, the two interfaces should be
connected through the AXI4-Stream Interconnect or AXI-FIFO cores to avoid data corruption
(Figure 2-3).

S_AXI_ACLKEN
The S_AXI_ACLKEN is the clock enable signal for the AXI4-Lite interface only. Driving this
signal Low only affects the AXI4-Lite interface and does not halt the video processing in the
ACLK clock domain.

ARESETn
The YCrCb to RGB core has two reset source: the ARESETn pin (hardware reset), and the
software reset option provided through the AXI4-Lite control interface (when present).

IMPORTANT: ARESETn is not synchronized internally to AXI4-Stream frame processing. Deasserting


ARESETn while a frame is being process leads to image tearing.

The external reset pulse needs to be held for 32 ACLK cycles to reset the core. The ARESETn
signal only resets the AXI4-Stream interfaces. The AXI4-Lite interface is unaffected by the

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


32
PG014 November 18, 2015
System Considerations

ARESETn signal to allow the video processing core to be reset without halting the AXI4-Lite
interface.

IMPORTANT: When a system with multiple-clocks and corresponding reset signals are being reset, the
reset generator has to ensure all signals are asserted/de-asserted long enough so that all interfaces
and clock-domains are correctly reinitialized.

S_AXI_ARESETn
The S_AXI_ARESETn signal is synchronous to the S_AXI_ACLK clock domain, but is
internally synchronized to the ACLK clock domain. The S_AXI_ARESETn signal resets the
entire core including the AXI4-Lite and AXI4-Stream interfaces.

System Considerations
When using the YCrCb2RGB, it needs to be configured for the actual frame size and the
proper color-space conversion to operate properly. To gather the frame size information
from the video, it can be connected to the Video In to AXI-Stream input and the Video
Timing Controller. The timing detector logic in the Video Timing Controller will gather the
video timing signals. The AXI4-Lite control interface on the Video Timing Controller allows
the system processor to read out the measured frame dimensions, and program all
downstream cores, such as the YCrCb2RGB, with the appropriate image dimensions.

If the target system uses only one configuration of the YCrCb2RGB core (i.e. does not need
to be reprogrammed ever), you may choose to create a constant configuration by removing
the AXI4-Lite interface. This reduces the core Slice footprint.

Clock Domain Interaction


The ARESETn and ACLKEN input signals will not reset or halt the AXI4-Lite interface. This
allows the video processing to be reset or halted separately from the AXI4-Lite interface
without disrupting AXI4-Lite transactions.

The AXI4-Lite interface will respond with an error if the core registers cannot be read or
written within 128 S_AXI_ACLK clock cycles. The core registers cannot be read or written
if the ARESETn signal is held low, if the ACLKEN signal is held low or if the ACLK signal is
not connected or not running. If core register read does not complete, the AXI4-Lite read
transaction will respond with 10 on the S_AXI_RRESP bus. Similarly, if a core register write
does not complete, the AXI4-Lite write transaction will respond with 10 on the
S_AXI_BRESP bus. The S_AXI_ARESETn input signal resets the entire core.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


33
PG014 November 18, 2015
System Considerations

Programming Sequence
If processing parameters such as the image size needs to be changed on the fly, or the
system needs to be reinitialized, it is recommended that pipelined Xilinx IP video cores are
disabled/reset from system output towards the system input, and programmed/enabled
from system input to system output. STATUS register bits allow system processors to
identify the processing states of individual constituent cores, and successively disable a
pipeline as one core after another is finished processing the last frame of data.

Error Propagation and Recovery


Parameterization and/or configuration registers define the dimensions of video frames
video IP should process. Starting from a known state, based on these configuration settings
the IP can predict when the beginning of the next frame is expected. Similarly, the IP can
predict when the last pixel of each scan line is expected. SOF detected before it was
expected (early), or SOF not present when it is expected (late), EOL detected before
expected (early), or EOL not present when expected (late), signals error conditions
indicative of either upstream communication errors or incorrect core configuration.

When SOF is detected early, the output SOF signal is generated early, terminating the
previous frame immediately. When SOF is detected late, the output SOF signal is generated
according to the programmed values. Extra lines / pixels from the previous frame are
dropped until the input SOF is captured.

Similarly, when EOL is detected early, the output EOL signal is generated early, terminating
the previous line immediately. When EOL is detected late, the output EOL signal is
generated according to the programmed values. Extra pixels from the previous line are
dropped until the input EOL is captured.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


34
PG014 November 18, 2015
Chapter 4

Customizing and Generating the Core


This chapter includes information about using Xilinx tools to customize and generate the
core in the Vivado Design Suite environment.

Vivado Integrated Design Environment (IDE)


You can customize the IP for use in your design by specifying values for the various
parameters associated with the IP core using the following steps:

1. Select the IP from the IP catalog.


2. Double-click on the selected IP or select the Customize IP command from the toolbar or
popup menu.

For details, see the sections, “Working with IP” and “Customizing IP for the Design” in the
Vivado Design Suite User Guide: Designing with IP (UG896) [Ref 3] and the “Working with the
Vivado IDE” section in the Vivado Design Suite User Guide: Getting Started (UG910) [Ref 5].

If you are customizing and generating the core in the Vivado IP Integrator, see the Vivado
Design Suite User Guide: Designing IP Subsystems Using IP Integrator (UG994) [Ref 7] for
detailed information. IP Integrator might auto-compute certain configuration values when
validating or generating the design. To check whether the values do change, see the
description of the parameter in this chapter. To view the parameter value you can run the
validate_bd_design command in the Tcl console.

Note: Figures in this chapter are illustrations of the Vivado IDE. This layout might vary from the
current version.

Interface
The main screen of the Graphical User Interface (GUI) of Vivado IP Catalog shown in
Figure 4-1 allows quick implementation of standard YCrCb to RGB or YUV to RGB converters
without having to manually enter values from Table 3-2, Table 3-3 and Table 3-4. The
Color-Space Converter core also supports proprietary (non-standard) converter
implementations, by selecting “custom” from the Standard Selection drop-down menu, as

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


35
PG014 November 18, 2015
Interface

long as the custom conversion matrix can be transformed to the form of Equation 3-3.
Descriptions of the options provided in the GUI screens are included in this section.
X-Ref Target - Figure 4-1

Figure 4‐1: Color Space Converter Main Screen

The first page of the GUI displays the following options:

• Component Name: The component name is used as the base name of output files
generated for the module. Names must begin with a letter and must be composed
from characters: a to z, 0 to 9 and “_”. The name v_ycrcb2rgb_v7_1 cannot be used as a
component name.
• Video Component Width: Specifies the bit width of input samples. Permitted values
are 8, 10, 12 and 16 bits.
• Pixels per Scanline (Default): When the AXI4-Lite control interface is enabled, the
generated core will use the value specified in the GUI as the default value for the lower
half-word of the ACTIVE_SIZE register. When an AXI4-Lite interface is not present, the
GUI selection permanently defines the horizontal size of the frames the generated core
instance is to process.
• Scanlines per Frame (Default): When the AXI4-Lite control interface is enabled, the
generated core will use the value specified in the GUI as the default value for the upper
half-word of the ACTIVE_SIZE register. When an AXI4-Lite interface is not present, the

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


36
PG014 November 18, 2015
Interface

GUI selection permanently defines the vertical size (number of lines) of the frames the
generated core instance is to process.
• Optional Features:

° AXI4-Lite Register Interface: When selected, the core will be generated with an
AXI4-Lite interface, which gives access to dynamically program and change
processing parameters. For more information, refer to Control Interface in Chapter
2.

° Include Debug Features: When selected, the core will be generated with
debugging features, which simplify system design, testing and debugging. For more
information, refer to Debugging Features in Appendix C.
Note: Debugging features are only available when the AXI4-Lite Register Interface is
selected.
• Enable INTC Port: When selected, the core will generate the optional INTC_IF port,
which gives parallel access to signals indicating frame processing status and error
conditions. For more information, refer to The Interrupt Subsystem in Chapter 2.
• Converter Type

° Standard Selection: Select the standard to be implemented. The offered standards


are:
- YCrCb ITU 601 (SD)
- YCrCb ITU 709 (HD) 1125/60 (PAL)
- YCrCb ITU 709 (HD) 1250/50 (NTSC)
- YUV
- custom

Selecting “custom” enables the controls on page 2 of the GUI, so conversion settings can
be customized. Otherwise, page 2 only displays the parameters to implement the
selected standard.

° Output Range Selection: This selection governs the range of outputs R, G and B by
affecting the conversion coefficients as well as the clipping and clamping values.
The core supports typical output ranges:
- 16 to 235, typical for studio equipment
- 16 to 240, typical for broadcast or television
- 0 to 255, typical for computer graphics

The previously-mentioned ranges are characteristic for 8-bit outputs. If 10-, 12- or
16-bit outputs are used, the ranges are extended proportionally. For example, 16 to
240 mode for 10-bit outputs will result in output values ranging from 64 to 960.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


37
PG014 November 18, 2015
Interface

The Conversion Matrix, Offset Compensation, Output Clipped and Output Clamped screen
displays and enables editing of conversion coefficients, similar to Equation 3-3. Contents
are editable only when “custom” is selected as the standard on page 1 (Figure 4-2).
X-Ref Target - Figure 4-2

Figure 4‐2: Conversion Matrix, Offset Compensation, Clipping and Clamping Screen

• Conversion Matrix: Enter floating-point conversion constants, ranging from 0 to 1,


into the four fields representing CA, CB, CC and CD.
• Offset Compensation: Enter the offset compensation constants (OY, OCb, and OCr in
Equation 3-17, Equation 3-18 and Equation 3-19). These constants are scaled to the
output representation. If OY, O Cb, and OCr are in the 0.0 - 1.0 range, and the output is
represented as 10-bit unsigned integers, then luminance and chrominance offsets
should be entered as integers in the 0 - 1023 range.
• Outputs Clipped/Outputs Clamped: These check boxes control whether clipping/
clamping logic will be instantiated in the generated netlist. The clipping/clamping logic
ensures no arithmetic wrap-arounds happen at overflows, at the expense of extra
slice-based logic resources.
• Minimum and Maximum Values: Similar to offset values, the edit boxes take unsigned
integer values in the range permitted by the current output representation.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


38
PG014 November 18, 2015
Output Generation

Output Generation
For details, see “Generating IP Output Products” in the Vivado Design Suite User Guide:
Designing with IP (UG896) [Ref 3].

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


39
PG014 November 18, 2015
Chapter 5

Constraining the Core

Required Constraints
The only constraints required are clock frequency constraints for the video clock, clk, and
the AXI4-Lite clock, s_axi_aclk. Paths between the two clock domains should be
constrained with a max_delay constraint and use the datapathonly flag, causing setup
and hold checks to be ignored for signals that cross clock domains. These constraints are
provided in the XDC constraints file included with the core.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


40
PG014 November 18, 2015
Chapter 6

C Model Reference
The YCrCb to RGB Color-Space Converter core has a bit accurate C model designed for
system modeling.

Features
• Bit-accurate with the Image YCrCb to RGB Color Space v7.1 core
• Statically linked library (.lib for Windows)
• Dynamically linked library (.so for Linux)
• Available for 32-bit and 64-bit Windows platforms and 32-bit and 64-bit Linux
platforms
• Supports all features of the Image Enhancement core that affect numerical results
• Designed for rapid integration into a larger system model
• Example C code showing how to use the function is provided

Overview
The YCrCb to RGB Color-Space Converter core has a bit-accurate C model for 32-bit and
64-bit Windows platforms and 32-bit and 64-bit Linux platforms. the model's interface
consists of a set of C functions residing in a statically linked library (shared library).

See Using the C-Model for full details of the interface. A C code example of how to call the
model is provided in C-Model Example Code.

The model is bit accurate, as it produces exactly the same output data as the core on a
frame-by-frame basis. However, the model is not cycle accurate, and it does not model the
core's latency or its interface signals.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


41
PG014 November 18, 2015
Overview

Unpacking the Model Contents


Unzip the v_rgb2ycrcb_v7_1_bitacc_model.zip file creates the following directory
structures and files which are described in Table 6-1.

Table 6‐1: C‐Model Files


File Description
/lin Pre-compiled bit accurate ANSI C reference model for
simulation on 32-bit Linux Platforms
libIp_v_ycrcb2rgb_v7_1_bitacc_cmo Model shared object library
del.so
run_bitacc_cmodel Pre-compiled bit accurate executable for simulation on 32-bit
Linux Platforms
/lin64 Pre-compiled bit accurate ANSI C reference model for
simulation on 64-bit Linux Platforms
libIp_v_ycrcb2rgb_v7_1_bitacc_cmo Model shared object library
del.so
run_bitacc_cmodel Pre-compiled bit accurate executable for simulation on 32-bit
Linux Platforms
/nt Pre-compiled bit accurate ANSI C reference model for
simulation on 32-bit Windows Platforms
libIp_v_ycrcb2rgb_v7_1_bitacc_cmo Pre-compiled library file for win32 compilation
del.lib
run_bitacc_cmodel.exe Pre-compiled bit accurate executable for simulation on 32-bit
Windows Platforms
/nt64 Pre-compiled bit accurate ANSI C reference model for
simulation on 64-bit Windows Platforms
libIp_v_ycrcb2rgb_v7_1_bitacc_cmo Pre-compiled library file for win32 compilation
del.so
run_bitacc_cmodel.exe Pre-compiled bit accurate executable for simulation on 64-bit
Windows Platforms
v_ycrcb2rgb_v7_1_bitacc_cmodel.h Model header file
rgb_utils.h Header file declaring the RGB image / video container type and
support functions
bmp_utils.h Header file declaring the bitmap (.bmp) image file I/O
functions
video_utils.h Header file declaring the generalized image / video container
type, I/O and support functions.
Test_stimuli.bmp 32x32 sample test image
run_bittacc_cmodel.c Example code calling the C-Model

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


42
PG014 November 18, 2015
Using the C‐Model

Installation
For Linux, ensure that the file is in the same directory that in your $LD_LIBRARY_PATH
environment variable is in:

• libIp_v_ycrcb2rgb_v7_1_bitacc_cmodel.so

Software Requirements
The YCrCb to RGB Color-Space Converter v7.0 C-models were compiled and tested with the
following software versions.

Table 6‐2: Supported Systems and Software Requirements


Platform C‐Compiler
Linux 32-bit and 64-bit GCC 4.1.1
Windows 32-bit and 64-bit Microsoft Visual Studio 2005, Visual Studio 2008 (Visual C++ 8.0)

Using the C‐Model


The bit accurate C model is accessed through a set of functions and data structures that are
declared in the v_ycrcb2rgb_v7_1_bitacc_cmodel.h file. Before using the model, the
structures holding the inputs, generics and output of the YCrCb to RGB Color-Space
Converter instance must be defined:

struct xilinx_ip_v_ycrcb2rgb_v7_1_generics generics;


struct xilinx_ip_v_ycrcb2rgb_v7_1_inputs inputs;
struct xilinx_ip_v_ycrcb2rgb_v7_1_outputs outputs;

The declaration of these structures is in the v_ycrcb2rgb_v7_1_bitacc_cmodel.h file.


Table 6-3 lists the generic parameters taken by the YCrCb to RGB Color-Space Converter
v4.0 IP core bit accurate model, as well as the default values.

Table 6‐3: Core Generic Parameters and Default Values


Default
Generic Variable Type Range Description
Value

ACTIVE_COLS int 1920 0-7680 Active # of Columns


ACTIVE_ROWS int 1080 0-7680 Active # of Rows
COEF_IN ycrcb_coef_in YCC coefficient input structure
puts
COEF_OUT ycrcb_coef_o YCC coefficient output structure
utputs

RGBMAX int 240 0 - 2OWIDTH-1 Clipping value for the R, G and B


Channels

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


43
PG014 November 18, 2015
Using the C‐Model

Table 6‐3: Core Generic Parameters and Default Values (Cont’d)


RGBMIN int 16 0 - 2OWIDTH-1 Clipping value for the R, G and B
Channels
HAS_CLIP int 1 0,1 Determines if Clipping is performed on
the output data
HAS_CLAMP int 1 0,1 Determines if Clamping is performed on
the output data
STANDARD_SEL int 0 0,1,2,3 Standard Selection
0 = SD_ITU_601 1 =
HD_ITU_709__1125_NTSC 2 =
HD_ITU_709__1250_PAL 3 = YUV
INPUT_RANGE int 0 0,1,2 Input Range 0 = 16_to_240_for_TV, 1 =
16_to_235_for_Studio_Equipment 2 =
0_to_255_for_Computer_Graphics

Table 6‐4: ycrcb_coef_inputs Structure


Variable Type Default Value Range Description
IWIDTH int 8 8,10,12,16 Data Width

ACOEF double 0.299 0.0 - 1.0 CA GUI coefficient

BCOEF double 0.114 0.0 - 1.0 CB GUI coefficient

CCOEF double 0.713 0.0 - 0.9 CC GUI coefficient

DCOEF double 0.564 0.0 - 0.9 CD GUI coefficient

YOFFSET int 16 0 - 2 IWIDTH-1 GUI YOFFSET

CBOFFSET int 128 0- 2 IWIDTH-1 GUI CBOFFSET

CROFFSET int 128 0 - 2 IWIDTH-1 GUI CROFFSET

Table 6‐5: ycrcb_coef_output Structure


Variable Type Default Value Range Description
IWIDTH int 8 8,10,12,16 Data Width

ACOEF int 91907 -217.. 2 17-1 Transformed CA coefficient

BCOEF int -46751 -217 17


.. 2 -1 Transformed CB coefficient

CCOEF int -22503 -217.. 2 17-1 Transformed CC coefficient


17 17
DCOEF int 116156 -2 .. 2 -1 Transformed CD coefficient

ROFFSET int -45953 -231 - 231-1 Transformed YOFFSET


31 31
GOFFSET int 34627 -2 - 2 -1 Transformed CBOFFSET

BOFFSET int - 58077 -231 - 231-1 Transformed CROFFSET

Calling xilinx_ip_v_ycrcb2rgb_v7_1_get_default_generics(&generics)
initializes the generics structure with the default value.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


44
PG014 November 18, 2015
Using the C‐Model

The inputs structure defines the actual input image. For the description of the input video
structure, see Input and Output Video Structures.

Calling xilinx_ip_v_ycrcb2rgb_v7_1_get_default_inputs(&generics,
&inputs) initializes the input video structure before it can be assigned an image or video
sequence using the memory allocation or file I/O functions provided in the BMP, RGB or
video utility functions.

IMPORTANT: The video_in variable is not initialized because the initialization depends on the actual
test image to be simulated. C-Model Example Code describes the initialization of the video_in structure

Note: The video_in variable is not initialized to point to a valid image / video container, as the
container size depends on the actual test image to be simulated. The initialization of the video_in
structure is described in Initializing the Input Video Structure.

After the inputs are defined, the model can be simulated by calling this function:

int xilinx_ip_v_ycrcb2rgb_v7_1_bitacc_simulate(
struct xilinx_ip_v_ycrcb2rgb_v7_1_generics* generics,
struct xilinx_ip_v_ycrcb2rgb_v7_1_inputs* inputs,
struct xilinx_ip_v_ycrcb2rgb_v7_1_outputs* outputs).

Results are included in the outputs structure, which contains only one member, type
video_struct. After the outputs are evaluated and saved, dynamically allocated memory
for input and output video structures must be released by calling this function:

void xilinx_ip_v_ycrcb2rgb_v7_1_destroy(
struct xilinx_ip_v_ycrcb2rgb_v7_1_inputs *input,
struct xilinx_ip_v_ycrcb2rgb_v7_1_outputs *output).

Successful execution of all provided functions, except for the destroy function, return value
0. A non-zero error code indicates that problems occurred during function calls.

Input and Output Video Structures


Input images or video streams can be provided to the YCrCb to RGB Color-Space Converter
v4.0 reference model using the video_struct structure, defined in video_utils.h:

struct video_struct{
int frames, rows, cols, bits_per_component, mode;
uint16*** data[5]; };

Table 6‐6: Member Variables of the Video Structure


Member Variable Designation
frames Number of video/image frames in the data structure.
rows Number of rows per frame. Pertaining to the image plane with the most rows
and columns, such as the luminance channel for YUV data. Frame dimensions
are assumed constant through all frames of the video stream. However
different planes, such as y, u and v can have different dimensions.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


45
PG014 November 18, 2015
Using the C‐Model

Table 6‐6: Member Variables of the Video Structure (Cont’d)


cols Number of columns per frame. Pertaining to the image plane with the most
rows and columns, such as the luminance channel for YUV data. Frame
dimensions are assumed constant through all frames of the video stream.
However different planes, such as y, u and v can have different dimensions.
bits_per_component Number of bits per color channel/component.All image planes are assumed
to have the same color/component representation. Maximum number of bits
per component is 16.
mode Contains information about the designation of data planes. Named
constants to be assigned to mode are listed in Table 6-7.
data Set of five pointers to three dimensional arrays containing data for image
planes. Data is in 16-bit unsigned integer format accessed as
data[plane][frame][row][col].

Table 6‐7: Named Video Modes with Corresponding Planes and Representations1
Mode Planes Video Representation
FORMAT_MONO 1 Monochrome – Luminance only
FORMAT_RGB 3 RGB image/video data
FORMAT_C444 3 444 YUV, or YCrCb image/video data
FORMAT_C422 3 422 format YUV video, (u, v chrominance channels horizontally
sub-sampled)
FORMAT_C420 3 420 format YUV video, (u, v sub-sampled both horizontally and vertically)
FORMAT_MONO_M 3 Monochrome (Luminance) video with Motion
FORMAT_RGBA 4 RGB image/video data with alpha (transparency) channel
FORMAT_C420_M 5 420 YUV video with Motion
FORMAT_C422_M 5 422 YUV video with Motion
FORMAT_C444_M 5 444 YUV video with Motion
FORMAT_RGBM 5 RGB video with Motion

1
The Color Space Conversion core C model supports FORMAT_C444 for input data and FORMAT_RGB for output data.

Initializing the Input Video Structure


The easiest way to assign stimuli values to the input video structure is to initialize it with an
image or video. The yuv_utils.h, bmp_util.h and video_util.h header files
packaged with the bit accurate C models contain functions to facilitate file I/O.

Bitmap Image Files


The header bmp_utils.h declares functions that help access files in Windows Bitmap
format (http://en.wikipedia.org/wiki/BMP_file_format). However, this format limits color
depth to a maximum of 8-bits per pixel, and operates on images with three planes (R,G,B).
Consequently, the following functions operate on arguments type rgb8_video_struct,

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


46
PG014 November 18, 2015
Using the C‐Model

which is defined in rgb_utils.h. Also, both functions support only true-color,


non-indexed formats with 24-bits per pixel.

int write_bmp(FILE *outfile, struct rgb8_video_struct *rgb8_video);


int read_bmp(FILE *infile, struct rgb8_video_struct *rgb8_video);

Exchanging data between rgb8_video_struct and general video_struct type


frames/videos is facilitated by these functions:

int copy_rgb8_to_video(struct rgb8_video_struct* rgb8_in,


struct video_struct* video_out );
int copy_video_to_rgb8(struct video_struct* video_in,
struct rgb8_video_struct* rgb8_out );

Note: All image/video manipulation utility functions expect both input and output structures
initialized; for example, pointing to a structure that has been allocated in memory, either as static or
dynamic variables. Moreover, the input structure must have the dynamically allocated container
(data or r, g, b) structures already allocated and initialized with the input frame(s). If the output
container structure is pre-allocated at the time of the function call, the utility functions verify and
issue an error if the output container size does not match the size of the expected output.

Binary Image/Video Files


The video_utils.h header file declares functions that help load and save generalized
video files in raw, uncompressed format.

int read_video( FILE* infile, struct video_struct* in_video);


int write_video(FILE* outfile, struct video_struct* out_video);

These functions serialize the video_struct structure. The corresponding file contains a
small, plain text header defining, "Mode", "Frames", "Rows", "Columns", and "Bits per Pixel".
The plain text header is followed by binary data, 16-bits per component in scan line
continuous format. Subsequent frames contain as many component planes as defined by
the video mode value selected. Also, the size (rows, columns) of component planes can
differ within each frame as defined by the actual video mode selected.

YUV Image Files


The yuv_utils.h file declares functions that help access files in standard YUV format. It
operates on images with three planes (Y, U and V). The following functions operate on
arguments of type yuv8_video_struct, which is defined in yuv_utils.h:

int write_yuv8(FILE *outfile, struct yuv8_video_struct *yuv8_video);


int read_yuv8(FILE *infile, struct yuv8_video_struct *yuv8_video);

Exchanging data between yuv8_video_struct and general video_struct type


frames/videos is facilitated by these functions:

int copy_yuv8_to_video(struct yuv8_video_struct* yuv8_in,


struct video_struct* video_out );
int copy_video_to_yuv8(struct video_struct* video_in,

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


47
PG014 November 18, 2015
C‐Model Example Code

struct yuv8_video_struct* yuv8_out );

Note: All image/video manipulation utility functions expect both input and output structures
initialized; for example, pointing to a structure that has been allocated in memory, either as static or
dynamic variables. Moreover, the input structure must have the dynamically allocated container
(data or y, u, v) structures already allocated and initialized with the input frame(s). If the output
container structure is pre-allocated at the time of the function call, the utility functions verify and
issue an error if the output container size does not match the size of the expected output.

Working with Video_struct Containers


The video_utils.h header file defines functions to simplify access to video data in
video_struct.

int video_planes_per_mode(int mode);


int video_rows_per_plane(struct video_struct* video, int plane);
int video_cols_per_plane(struct video_struct* video, int plane);

The video_planes_per_mode function returns the number of component planes defined


by the mode variable, as described in Table 6-7. The video_rows_per_plane and
video_cols_per_plane functions return the number of rows and columns in a given
plane of the selected video structure. The following example demonstrates using these
functions in conjunction to process all pixels within a video stream stored in the in_video
variable:

for (int frame = 0; frame < in_video->frames; frame++) {


for (int plane = 0; plane < video_planes_per_mode(in_video->mode); plane++) {
for (int row = 0; row < rows_per_plane(in_video,plane); row++) {
for (int col = 0; col < cols_per_plane(in_video,plane); col++) {
// User defined pixel operations on
// in_video->data[plane][frame][row][col]
}
}
}
}

C‐Model Example Code


The example C demonstrator provided with the core, run_bitacc_cmodel.c demonstrates the
steps required to run the C-model, by:

• Opening an example yuv file


• Increasing the color-component width to 10, 12, or 16 bits as necessary by shifting 8 bit
data derived from the yuv file and padding the LSBs with X-Y ramp bits.
• Running the YCrCb2RGB C-model

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


48
PG014 November 18, 2015
C‐Model Example Code

After following the compilation instructions, run the example executable. The executable
takes the path/name of the input file and the path of the output as parameters. If invoked
with insufficient parameters, the following help message is printed:

Usage:run_bitacc_cmodel in_file out_path


in_file : path/name of the input YUV file
out_path : path to to the output files

During successful execution, two directories are created at the location specified by the
out_path command line parameter. The first directory is the "expected" directory. This
directory contains a BMP file that corresponds to the output of the first frame that was
processed. This directory also contains a txt file called golden_1.txt. This txt file contains
the output of the model in a format that can be directly used with the demonstration test
bench. The second directory that is created is the "stimuli" directory. This directory contains
a txt file called stimuli_1.txt. This txt file contains the input of the model in a format
that can be directly used with the demonstration test bench.

Compiling with the YCrCb to RGB C‐Model


Linux (32‐ and 64‐bit)
To compile the example core, perform these steps:

1. Set your $LD_LIBRARY_PATH environment variable to include the root directory where
you unzipped the model zip file using a command such as:
setenv LD_LIBRARY_PATH <unzipped_c_model_dir>:${LD_LIBRARY_PATH}

2. Copy file from the /lin64 directory to the root directory:


libIP_v_ycrcb2rgb_v7_1_bitacc_cmodel.so

3. In the root directory, compile using the GNU C Compiler with this command:
gcc -m32 -x c++ ../run_bitacc_cmodel.c ../gen_stim.c -o run_bitacc_cmodel -L.
-lIp_v_ycrcb2rgb_v7_1_bitacc_cmodel -Wl,-rpath,.

gcc -m64 -x c++ ../run_bitacc_cmodel.c ../gen_stim.c -o run_bitacc_cmodel -L.


-lIp_v_ycrcb2rgb_v7_1_bitacc_cmodel -Wl,-rpath,.

Windows (32‐ and 64‐bit)


The precompiled library v_ycrcb2rgb_v7_1_bitacc_cmodel.dll, and top-level
demonstration code run_bitacc_cmodel.c should be compiled with an ANSI C
compliant compiler under Windows. An example procedure is provided using Microsoft
Visual Studio:

1. In Visual Studio create a new, empty Windows Console Application project.


2. As existing items, add:

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


49
PG014 November 18, 2015
C‐Model Example Code

a. The libIP_v_ycrcb2rgb_v7_1_bitacc_cmodel.dll file to the "Resource


Files" folder of the project
b. The run_bitacc_cmodel.c and gen_stim.c files to the "Source Files" folder of
the project
c. The v_ycrcb2rgb_v7_1_bitacc_cmodel.h header files to "Header Files" folder of
the project (optional)
3. After the project has been created and populated, it needs to be compiled and linked
(built) to create a win32 executable. To perform the build step, choose Build Solution
from the Build menu. An executable matching the project name has been created either
in the Debug or Release subdirectories under the project location based on whether
Debug or Release has been selected in the Configuration Manager under the Build
menu.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


50
PG014 November 18, 2015
Chapter 7

Simulation
This chapter contains information about simulating IP in the Vivado® Design Suite
environment. For comprehensive information about Vivado simulation components, as well
as information about using supported third party tools, see the Vivado Design Suite User
Guide: Logic Simulation (UG900) [Ref 6].

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


51
PG014 November 18, 2015
Chapter 8

Synthesis and Implementation


This chapter contains information about simulating and implementing in the Vivado®
Design Suite environment.

For details about synthesis and implementation, see “Synthesizing IP” and “Implementing
IP” in the Vivado Design Suite User Guide: Designing with IP (UG896) [Ref 3].

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


52
PG014 November 18, 2015
Chapter 9

Detailed Example Design


No example design is available at the time for the YCrCb to RGB Color-Space Converter v7.1
core.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


53
PG014 November 18, 2015
Chapter 10

Test Bench
This chapter contains information about the provided test bench in the Vivado® Design
Suite environment.

Demonstration Test Bench


A demonstration test bench is provided with the core which enables you to observe core
behavior in a typical scenario. This test bench is generated together with the core in
Vivado Design Suite. You are encouraged to make simple modifications to the
configurations and observe the changes in the waveform.

Directory and File Contents


The following files are expected to be generated in the in the demonstration test bench
output directory:

• axi4lite_mst.v
• axi4s_video_mst.v
• axi4s_video_slv.v
• ce_generator.v
• tb_<IP_instance_name>.v

Test Bench Structure


The top-level entity is tb_<IP_instance_name>.

It instantiates the following modules:

• DUT

The <IP> core instance under test.

• axi4lite_mst

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


54
PG014 November 18, 2015
Chapter 10: Test Bench

The AXI4-Lite master module, which initiates AXI4-Lite transactions to program core
registers.

• axi4s_video_mst

The AXI4-Stream master module, which generates ramp data and initiates AXI4-Stream
transactions to provide video stimuli for the core and can also be used to open stimuli
files generated from the reference C models and convert them into corresponding
AXI4-Stream transactions.

To do this, edit tb_<IP_instance_name>.v:

a. Add define macro for the stimuli file name and directory path
define STIMULI_FILE_NAME<path><filename>.
b. Comment-out/remove the following line:
MST.is_ramp_gen(`C_ACTIVE_ROWS, `C_ACTIVE_COLS, 2);
and replace with the following line:
MST.use_file(`STIMULI_FILE_NAME);

For information on how to generate stimuli files, see Chapter 4, C Model Reference.

• axi4s_video_slv

The AXI4-Stream slave module, which acts as a passive slave to provide handshake
signals for the AXI4-Stream transactions from the core output, can be used to open the
data files generated from the reference C model and verify the output from the core.

To do this, edit tb_<IP_instance_name>.v:

a. Add define macro for the golden file name and directory path
define GOLDEN_FILE_NAME “<path><filename>”.
b. Comment out the following line:
SLV.is_passive;
and replace with the following line:
SLV.use_file(`GOLDEN_FILE_NAME);

For information on how to generate golden files, see Chapter 4, C Model Reference.

• ce_gen

Programmable Clock Enable (ACLKEN) generator.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


55
PG014 November 18, 2015
Appendix A

Verification, Compliance, and


Interoperability

Simulation
A highly parameterizable test bench was used to test the YCrCb to RGB Color-Space
Converter core. Testing included the following:

• Register accesses
• Processing multiple frames of data
• AXI4-Stream bidirectional data-throttling tests
• Testing detection, and recovery from various AXI4-Stream framing error scenarios
• Testing different ACLKEN and ARESETn assertion scenarios
• Testing of various frame sizes
• Varying parameter settings

Hardware Testing
The YCrCb to RGB Color-Space Converter core has been validated in hardware at Xilinx to
represent a variety of parameterizations, including the following:

• A test design was developed for the core that incorporated a MicroBlaze™ processor,
AXI4-Lite interconnect and various other peripherals. The software for the test system
included pre-generated input and output data along with live video stream. The
MicroBlaze processor was responsible for:

° Initializing the appropriate input and output buffers

° Initializing the YCrCb to RGB Color-Space Converter core

° Launching the test

° Comparing the output of the core against the expected results

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


56
PG014 November 18, 2015
Interoperability

° Reporting the Pass/Fail status of the test and any errors that were found

Interoperability
The core slave (input) AXI4-Stream interface can work directly with any Video core which
produces YCrCb (or YUV) 4:4:4 video data on an AXI4-Stream interface with a Video
Protocol. The core master (output) RGB interface can work directly with any Video core
which consumes RGB data on an AXI4-Stream interface with a Video Protocol.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


57
PG014 November 18, 2015
Appendix B

Migrating and Upgrading


This appendix contains information about migrating from an ISE design to the Vivado
Design Suite, and for upgrading to a more recent version of the IP core. For customers
upgrading their IP core, important details (where applicable) about any port changes and
other impact to user logic are included.

Migrating to the Vivado Design Suite


For information about migration to Vivado Design Suite, see ISE to Vivado Design Suite
Migration Guide (UG911) [Ref 2].

Upgrading in Vivado Design Suite


This section provides information about any changes to the user logic or port designations
that take place when you upgrade to a more current version of this IP core in the Vivado
Design Suite.

Parameter Changes
There are no parameter changes.

Port Changes
There are no port changes.

Other Changes
From version v7.0 to v7.1 of the YCrCb2RGB core the following significant changes took
place:

• Minor change on core GUI display from "Input" to "Output" Range Selection.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


58
PG014 November 18, 2015
Appendix C

Debugging
This appendix includes details about resources available on the Xilinx Support website and
debugging tools.

Finding Help on Xilinx.com


To help in the design and debug process when using the YCrCB to RGB Color-Space
Converter core, the Xilinx Support web page (Xilinx Support web page) contains key
resources such as product documentation, release notes, answer records, information about
known issues, and links for opening a Technical Support Web Case.

Documentation
This product guide is the main document associated with the YCrCB to RGB Color-Space
Converter core. This guide, along with documentation related to all products that aid in the
design process, can be found on the Xilinx Support web page or by using the Xilinx
Documentation Navigator.

Download the Xilinx Documentation Navigator from the Downloads page. For more
information about this tool and the features available, open the online help after
installation.

Answer Records
Answer Records include information about commonly encountered problems, helpful
information on how to resolve these problems, and any known issues with a Xilinx product.
Answer Records are created and maintained daily ensuring that users have access to the
most accurate information available.

Answer Records for this core are listed below, and can also be located by using the Search
Support box on the main Xilinx support web page. To maximize your search results, use
proper keywords such as

• Product name
• Tool message(s)

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


59
PG014 November 18, 2015
Appendix C: Debugging

• Summary of the issue encountered

A filter search is available after results are returned to further target the results.

Answer Records for the YCrCB to RGB Color-Space Converter Core

AR 54542

Technical Support
Xilinx provides technical support in the Xilinx Support web page for this LogiCORE™ IP
product when used as described in the product documentation. Xilinx cannot guarantee
timing, functionality, or support if you do any of the following:

• Implement the solution in devices that are not defined in the documentation.
• Customize the solution beyond that allowed in the product documentation.
• Change any section of the design labeled DO NOT MODIFY.

Xilinx provides premier technical support for customers encountering issues that require
additional assistance.

To contact Xilinx Technical Support, navigate to the Xilinx Support web page.

1. Open a WebCase by selecting the WebCase link located under Support Quick Links.
• A block diagram of the video system that explains the video source, destination and IP
(custom and Xilinx) used.
Note: Access to WebCase is not available in all cases. Please login to the WebCase tool to see your
specific support options.

Debug Tools
There are many tools available to address YCrCB to RGB Color-Space Converter core design
issues. It is important to know which tools are useful for debugging various situations.

Vivado Lab Tools


Vivado® lab tools insert logic analyzer and virtual I/O cores directly into your design.
Vivado lab tools allows you to set trigger conditions to capture application and integrated
block port signals in hardware. Captured signals can then be analyzed. This feature
represents the functionality in the Vivado IDE that is used for logic debugging and
validation of a design running in Xilinx devices in hardware.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


60
PG014 November 18, 2015
Appendix C: Debugging

The Vivado lab tools logic analyzer is used to interact with the logic debug LogiCORE IP
cores, including:

• ILA 2.0 (and later versions)


• VIO 2.0 (and later versions)

See Vivado Design Suite User Guide: Programming and Debugging (UG908).

Reference Boards
Various Xilinx development boards support YCrCB to RGB Color-Space Converter. These
boards can be used to prototype designs and establish that the core can communicate with
the system.

• 7 series evaluation boards

° KC705

° KC724

C Model Reference
See C Model Reference in this guide for tips and instructions for using the provided C model
files to debug your design.

Hardware Debug
Hardware issues can range from link bring-up to problems seen after hours of testing. This
section provides debug steps for common issues. The Vivado lab tools are a valuable
resource to use in hardware debug. The signal names mentioned in the following individual
sections can be probed using the Vivado lab tools for debugging the specific problems.

General Checks
Ensure that all the timing constraints for the core were properly incorporated from the
example design and that all constraints were met during implementation.

• Does it work in post-place and route timing simulation? If problems are seen in
hardware but not in timing simulation, this could indicate a PCB issue. Ensure that all
clock sources are active and clean.
• If using MMCMs in the design, ensure that all MMCMs have obtained lock by
monitoring the LOCKED port.
• If your outputs go to 0, check your licensing.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


61
PG014 November 18, 2015
Appendix C: Debugging

Core Bypass Option


The bypass option facilitates establishing a straight through connection between input
(AXI4-Stream slave) and output (AXI4-Stream master) interfaces bypassing any processing
functionality.

Flag BYPASS (bit 4 of the CONTROL register) can turn bypass on (1) or off, when the core
instance Debugging Features were enabled at generation. Within the IP this switch controls
multiplexers in the AXI4-Stream path.

In bypass mode the core processing function is bypassed, and the core repeats AXI4-Stream
input samples on its output.

Starting a system with all processing cores set to bypass, then by turning bypass off from
the system input towards the system output allows verification of subsequent cores with
known good stimuli.

Built‐in Test‐Pattern Generator


The optional built-in test-pattern generator facilitates to temporarily feed the output
AXI4-Stream master interface with a predefined pattern.

Flag TEST_PATTERN (bit 5 of the CONTROL register) can turn test-pattern generation on (1)
or off, when the core instance Debugging Features were enabled at generation. Within the
IP this switch controls multiplexers in the AXI4-Stream path, switching between the regular
core processing output and the test-pattern generator. When enabled, a set of counters
generate 256 scan-lines of color-bars, each color bar 64 pixels wide, repetitively cycling
through Black, Green, Blue, Cyan, Red, Yellow, Magenta, and White colors till the end of
each scan-line. After the Color-Bars segment, the rest of the frame is filled with a
monochrome horizontal and vertical ramp.

Starting a system with all processing cores set to test-pattern mode, then by turning
test-pattern generation off from the system output towards the system input allows
successive bring-up and parameterization of subsequent cores.

Throughput Monitors
Throughput monitors enable monitoring processing performance within the core. This
information can be used to help debug frame-buffer bandwidth limitation issues, and if
possible, allow video application software to balance memory pathways.

Often times video systems, with multiport access to a shared external memory, have
different processing islands. For example, a pre-processing sub-system working in the input
video clock domain may clean up, transform, and write a video stream, or multiple video
streams to memory. The processing sub-system may read the frames out, process, scale,
encode, then write frames back to the frame buffer, in a separate processing clock domain.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


62
PG014 November 18, 2015
Appendix C: Debugging

Finally, the output sub-system may format the data and read out frames locked to an
external clock.

Typically, access to external memory using a multiport memory controller involves


arbitration between competing streams. However, to maximize the throughput of the
system, different memory ports may need different specific priorities. To fine tune the
arbitration and dynamically balance frame rates, it is beneficial to have access to
throughput information measured in different video datapaths.

The SYSDEBUG0 (0x0014) (or Frame Throughput Monitor) indicates the number of frames
processed since power-up or the last time the core was reset. The SYSDEBUG1 (0x0018), or
Line Throughput Monitor, register indicates the number of lines processed since power-up
or the last time the core was reset. The SYSDEBUG2 (0x001C), or Pixel Throughput Monitor,
register indicates the number of pixels processed since power-up or the last time the core
was reset.

Priorities of memory access points can be modified by the application software dynamically
to equalize frame, or partial frame rates.

Evaluation Core Timeout


The YCrCB to RGB Color-Space Converter hardware evaluation core times out after
approximately eight hours of operation. The output is driven to zero. This results in a black
screen for RGB color systems and in a dark-green screen for YUV color systems.

Interface Debug
AXI4‐Lite Interfaces
Table C-1 describes how to troubleshoot the AXI4-Lite interface.

Table C‐1: Troubleshooting the AXI4‐Lite Interface


Symptom Solution
Readback from the Version Are the S_AXI_ACLK and ACLK pins connected?
Register through the AXI4-Lite The VERSION_REGISTER readout issue may be indicative of the
interface times out, or a core core not receiving the AXI4-Lite interface.
instance without an AXI4-Lite
interface seems non-responsive.
Readback from the Version Is the core enabled? Is s_axi_aclken connected to vcc?
Register through the AXI4-Lite Verify that signal ACLKEN is connected to either net_vcc or to a
interface times out, or a core designated clock enable signal.
instance without an AXI4-Lite
interface seems non-responsive.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


63
PG014 November 18, 2015
Appendix C: Debugging

Table C‐1: Troubleshooting the AXI4‐Lite Interface (Cont’d)


Symptom Solution
Readback from the Version Is the core in reset?
Register through the AXI4-Lite S_AXI_ARESETn and ARESETn should be connected to vcc for
interface times out, or a core the core not to be in reset. Verify that the S_AXI_ARESETn and
instance without an AXI4-Lite ARESETn signals are connected to either net_vcc or to a
interface seems non-responsive. designated reset signal.
Readback value for the The core and/or the driver in a legacy project has not been
VERSION_REGISTER is different updated. Ensure that old core versions, implementation files, and
from expected default values implementation caches have been cleared.

Assuming the AXI4-Lite interface works, the second step is to bring up the AXI4-Stream
interfaces.

AXI4‐Stream Interfaces
Table C-2 describes how to troubleshoot the AXI4-Stream interface.

Table C‐2: Troubleshooting AXI4‐Stream Interface


Symptom Solution
Bit 0 of the ERROR Bit 0 of the ERROR register, EOL_EARLY, indicates the number of pixels received
register reads back between the latest and the preceding End-Of-Line (EOL) signal was less than
set. the value programmed into the ACTIVE_SIZE register. If the value was
provided by the Video Timing Controller core, read out ACTIVE_SIZE register
value from the VTC core again, and make sure that the TIMING_LOCKED flag is
set in the VTC core. Otherwise, using Vivado Lab Tools, measure the number of
active AXI4-Stream transactions between EOL pulses.
Bit 1 of the ERROR Bit 1 of the ERROR register, EOL_LATE, indicates the number of pixels received
register reads back between the last End-Of-Line (EOL) signal surpassed the value programmed
set. into the ACTIVE_SIZE register. If the value was provided by the Video Timing
Controller core, read out ACTIVE_SIZE register value from the VTC core
again, and make sure that the TIMING_LOCKED flag is set in the VTC core.
Otherwise, using Vivado Lab Tools, measure the number of active AXI4-Stream
transactions between EOL pulses.
Bit 2 or Bit 3 of the Bit 2 of the ERROR register, SOF_EARLY, and bit 3 of the ERROR register
ERROR register reads SOF_LATE indicate the number of pixels received between the latest and the
back set. preceding Start-Of-Frame (SOF) differ from the value programmed into the
ACTIVE_SIZE register. If the value was provided by the Video Timing
Controller core, read out ACTIVE_SIZE register value from the VTC core
again, and make sure that the TIMING_LOCKED flag is set in the VTC core.
Otherwise, using Vivado Lab Tools, measure the number EOL pulses between
subsequent SOF pulses.
s_axis_video_tready During initialization, line-, and frame-flushing, the core keeps its
stuck low, the s_axis_video_tready input low. Afterwards, the core should assert
upstream core cannot s_axis_video_tready automatically.
send data. Is m_axis_video_tready low? If so, the core cannot send data downstream,
and the internal FIFOs are full.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


64
PG014 November 18, 2015
Appendix C: Debugging

Table C‐2: Troubleshooting AXI4‐Stream Interface (Cont’d)


Symptom Solution
m_axis_video_tvalid • No data is generated during the first two lines of processing.
stuck low, the • If the programmed active number of pixels per line is radically smaller than
downstream core is the actual line length, the core drops most of the pixels waiting for the
not receiving data (s_axis_video_tlast) End-of-line signal. Check the ERROR register.
Generated SOF signal Check the ERROR register.
(m_axis_video_tuser0)
signal misplaced.
Generated EOL signal Check the ERROR register.
(m_axis_video_tl
ast) signal
misplaced.
Data samples lost • Are the Master and Slave AXI4-Stream interfaces in the same clock domain?
between Upstream • Is proper clock-domain crossing logic instantiated between the upstream
core and this core. core and this core (Asynchronous FIFO)?
Inconsistent EOL and/ • Did the design meet timing?
or SOF periods
• Is the frequency of the clock source driving the ACLK pin lower than the
received.
reported Fmax reached?
Data samples lost • Are the Master and Slave AXI4-Stream interfaces in the same clock domain?
between Downstream • Is proper clock-domain crossing logic instantiated between the upstream
core and this core. core and this core (Asynchronous FIFO)?
Inconsistent EOL and/ • Did the design meet timing?
or SOF periods
• Is the frequency of the clock source driving the ACLK pin lower than the
received.
reported Fmax reached?

If the AXI4-Stream communication is healthy, but the data seems corrupted, the next step is
to find the correct configuration for this core.

Other Interfaces
Table C-3 describes how to troubleshoot third-party interfaces.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


65
PG014 November 18, 2015
Appendix C: Debugging

Table C‐3: Troubleshooting Third‐Party Interfaces


Symptom Solution
Severe color Verify that the color component logical addressing on the AXI4-Stream TDATA
distortion or signal is in according to Data Interface in Chapter 2. If misaligned:
color-swap when In HDL, break up the TDATA vector to constituent components and manually
interfacing to connect the slave and master interface sides.
third-party video IP.
Severe color Unless the particular software driver was developed with the AXI4-Stream TDATA
distortion or signal color component assignments described in Data Interface in Chapter 2 in
color-swap when mind, there are no guarantees that the software correctly identifies bits
processing video corresponding to color components.
written to external Verify that the color component logical addressing TDATA is in alignment with
memory using the the data format expected by the software drivers reading/writing external
AXI-VDMA core. memory. If misaligned:
In HDL, break up the TDATA vector to constituent components, and manually
connect the slave and master interface sides.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


66
PG014 November 18, 2015
Appendix D

Additional Resources

Xilinx Resources
For support resources such as Answers, Documentation, Downloads, and Forums, see the
Xilinx Support website at:

http://Xilinx Support web page.

For a glossary of technical terms used in Xilinx documentation, see:

http://www.xilinx.com/support/documentation/sw_manuals/glossary.pdf.

For a comprehensive listing of Video and Imaging application notes, white papers,
reference designs and related IP cores, see the Video and Imaging Resources page at:

http://www.xilinx.com/esp/video/refdes_listing.htm#ref_des.

References
These documents provide supplemental material useful with this user guide:

1. Vivado AXI Reference Guide (UG1037)


2. ISE to Vivado Design Suite Migration Guide (UG911)
3. Vivado Design Suite User Guide: Designing with IP (UG896)
4. Vivado Design Suite User Guide: Programming and Debugging (UG908)
5. Vivado Design Suite User Guide: Getting Started (UG910)
6. Vivado Design Suite User Guide: Logic Simulation (UG900)
7. Vivado Design Suite User Guide: Designing IP Subsystems Using IP Integrator (UG994)

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


67
PG014 November 18, 2015
Revision History

Revision History
The following table shows the revision history for this document.

Date Version Revision


11/18/2015 7.1 Added UltraScale+ support.
10/01/2014 7.1 Removed Application Software Development appendix.
12/18/2013 7.1 Added UltraScale Architecture support.
10/02/2013 7.1 Synch document version with core version. Updated Constraints and Test
Bench chapters.
03/20/2013 4.0 Updated for core version. Updated Debugging appendix. Removed ISE
chapter.
10/16/2012 3.1 Updated for core version. Added Vivado test bench.
07/25/2012 3.0 Updated for core version. Added Vivado information.
4/24/2012 2.0 Updated for core version. Added Zynq-7000 devices, added AXI4-Stream
interfaces, deprecated GPP interface.
10/19/2011 1.0 Initial Xilinx release of Product Guide, replacing DS659 and UG833.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


68
PG014 November 18, 2015
Notice of Disclaimer

Notice of Disclaimer
The information disclosed to you hereunder (the “Materials”) is provided solely for the selection and use of Xilinx products. To the
maximum extent permitted by applicable law: (1) Materials are made available “AS IS” and with all faults, Xilinx hereby DISCLAIMS
ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether
in contract or tort, including negligence, or under any other theory of liability) for any loss or damage of any kind or nature related
to, arising under, or in connection with, the Materials (including your use of the Materials), including for any direct, indirect,
special, incidental, or consequential loss or damage (including loss of data, profits, goodwill, or any type of loss or damage
suffered as a result of any action brought by a third party) even if such damage or loss was reasonably foreseeable or Xilinx had
been advised of the possibility of the same. Xilinx assumes no obligation to correct any errors contained in the Materials or to
notify you of updates to the Materials or to product specifications. You may not reproduce, modify, distribute, or publicly display
the Materials without prior written consent. Certain products are subject to the terms and conditions of the Limited Warranties
which can be viewed at http://www.xilinx.com/warranty.htm; IP cores may be subject to warranty and support terms contained in
a license issued to you by Xilinx. Xilinx products are not designed or intended to be fail-safe or for use in any application requiring
fail-safe performance; you assume sole risk and liability for use of Xilinx products in Critical Applications: http://www.xilinx.com/
warranty.htm#critapps.
© Copyright 2011–2013 Xilinx, Inc. Xilinx, the Xilinx logo, Artix, ISE, Kintex, Spartan, Virtex, Zynq, and other designated brands
included herein are trademarks of Xilinx in the United States and other countries. All other trademarks are the property of their
respective owners.

YCrCb to RGB Color‐Space Converter v7.1 www.xilinx.com Send Feedback


69
PG014 November 18, 2015

You might also like