In addition to simple text overlays using Annotate, Streamline supports the annotation of images, providing further application-level context to the Timeline view.
Just like textual annotation, the application writes to
file using standard c-library functions. The gator driver outputs
this data with a timestamp to Streamline and integrates it with
the trace and sample report.
The mechanics of instrumenting your source code to provide visual annotation is similar to the process of adding standard annotation. For more information on text-only annotation, see Customize reports using Annotate.
To include images in the data sent to the host during a capture
session, use the
ANNOTATE_VISUAL macro in your
source code instead of the
used in standard annotation.
a parameter for image data.
You can locate all of the files provided by DS-5 by selecting Help → ARM Extras... from the main menu.
To use visual annotation, you must:
streamline_annotate.hheader file located in
.../gator/annotate/in your source code using the following line of code:
You can customize the example
streamline_annotate.hfile provided by DS-5 or create your own. Use it as a template if you want to create your own customized annotate functions.
You must call the following before using the
ANNOTATE_VISUALmacro into your code:
with your image,
with the size of the data being written to the
with a descriptive string to be included with the image. Including a string is optional.
Visual Annotation supports images in the following formats: GIF, PNG, JPEG, TIFF, ICO, and BMP +RLE. There is no limit to the image size but the larger the image, the greater impact on the system performance. Increasing the amount of data sent to the host in this way increases the probe effect for the applications you are profiling
For an example of how to use Visual Annotate, see the
source file, located in
To annotate from within the kernel or a module, use the
streamline_annotate.h. The annotate
annotate_kernel.h duplicate the functionality
of the standard annotate statements defined in
but they are titled differently. Kernel annotate statements all
KERNEL_ prefix. For example, to annotate
your kernel module code to add images to report data, include
annotate_kernel.h and add
to your code.
data, length, string)
You can see the effects of visual annotation in the Timeline and Log views of your Streamline Analysis Reports. With visual annotation, the Timeline view data includes a chart that contains the annotated images. For more information about how visual annotation changes the Timeline view and how to interact with it, see Timeline view charts.
Any annotation event that includes an image has an icon in the message field of the Log view. Hover over the icon to see the image.