Files

440 lines
18 KiB
HTML

<!DOCTYPE html>
<html lang="en" data-bs-theme="dark">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
<!-- Title and Description -->
<title>ImageMagick | Command-line Tools: Stream</title>
<meta name="description" content="ImageMagick is a powerful open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for developers, designers, and researchers." />
<!-- Canonical URL -->
<link rel="canonical" href="stream.html" />
<!-- Robots -->
<meta name="robots" content="index, follow" />
<!-- Theme Color -->
<meta name="theme-color" content="#000000" />
<!-- Verification Tags -->
<meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
<!-- Favicon and Apple Icon -->
<link rel="shortcut icon" href="../images/wand.png" type="images/png" />
<link rel="apple-touch-icon" href="../images/wand.png" type="images/png" />
<!-- Preconnect for External Resources -->
<link rel="preconnect" href="../index.html" />
<!-- Stylesheets -->
<link rel="preload" href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/css/bootstrap.min.css" as="style" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/css/bootstrap.min.css" />
<!-- Accessibility Enhancement -->
<style>
html {
scroll-padding-top: 70px;
}
a.nav-link:hover,
a.dropdown-item:hover {
color: #ffc107 !important;
text-shadow: 0px 2px 4px rgba(255, 193, 7, 0.8);
}
.btn-outline-warning {
color: #cd7f32;
border-color: #cd7f32;
}
.navbar-brand {
color: #d4af37;
transition: color 0.3s ease, text-shadow 0.3s ease;
}
.navbar-brand:hover {
color: #e9c03d;
text-shadow: 0px 2px 4px rgba(203, 163, 120, 0.6);
}
</style>
<!-- Open Graph Meta Tags -->
<meta property="og:title" content="ImageMagick | Command-line Tools: Stream" />
<meta property="og:description" content="ImageMagick is a powerful open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for developers, designers, and researchers." />
<meta property="og:image" content="../images/logo.png" />
<meta property="og:logo" content="../images/logo.png" />
<meta property="og:url" content="../www/stream.html" />
<meta property="og:type" content="website" />
<meta property="og:site_name" content="ImageMagick" />
<meta property="og:locale" content="en_us" />
<!-- Twitter Card Meta Tags -->
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:site" content="@imagemagick" />
<meta name="twitter:creator" content="@imagemagick" />
<meta name="twitter:title" content="ImageMagick | Command-line Tools: Stream" />
<meta name="twitter:description" content="ImageMagick is a powerful open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for developers, designers, and researchers." />
<meta name="twitter:image" content="../images/logo.png" />
<meta name="twitter:image:alt" content="ImageMagick logo and tag line" />
<!-- JSON-LD Structured Data -->
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "SoftwareApplication",
"name": "ImageMagick",
"url": "../www/stream.html",
"image": "../images/logo.png",
"description": "ImageMagick is a powerful open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for developers, designers, and researchers.",
"applicationCategory": "Multimedia",
"operatingSystem": "Windows, macOS, Linux, Unix",
"softwareVersion": "7.1.2-3",
"license": "../www/license.html",
"creator": {
"@type": "Organization",
"name": "ImageMagick Studio LLC",
"url": "https://imagemagick.org"
},
"keywords": [
"Command-line Tools: Stream",
"image processing software",
"image conversion tool",
"batch image editing",
"open-source image editor",
"ImageMagick command-line",
"resize images ImageMagick",
"crop and rotate images",
"ImageMagick tutorial",
"ImageMagick automation",
"ImageMagick for developers",
"ImageMagick CLI",
"ImageMagick filters and effects",
"ImageMagick scripting",
"ImageMagick API integration"
],
"sameAs": [
"https://github.com/ImageMagick",
"https://x.com/imagemagick"
],
"offers": {
"@type": "Offer",
"price": "0.00",
"priceCurrency": "USD"
}
}
</script>
<!-- Google Custom Search -->
</head>
<body>
<script>
function setTheme(theme) {
localStorage.setItem('theme', theme);
updateThemeIcon(theme);
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? getSystemTheme() : theme);
}
function getSystemTheme() {
return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
}
function updateThemeIcon(theme) {
const iconMap = {
light: '☀️',
dark: '🌙',
auto: '🌓'
};
document.getElementById('currentThemeIcon').textContent = iconMap[theme] || '🌓';
}
document.addEventListener('DOMContentLoaded', () => {
const savedTheme = localStorage.getItem('theme') || 'auto';
setTheme(savedTheme);
});
</script>
<nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
<div class="container-fluid">
<a class="navbar-brand fw-bold" href="../index.html" title="$meta->sitename;">
ImageMagick </a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="magick-navbars">
<ul class="navbar-nav me-auto">
<li class="nav-item">
<a class="nav-link " href="download.html">Download</a>
</li>
<li class="nav-item">
<a class="nav-link " href="command-line-tools.html">Tools</a>
</li>
<li class="nav-item">
<a class="nav-link " href="command-line-processing.html">CLI</a>
</li>
<li class="nav-item">
<a class="nav-link " href="develop.html">Develop</a>
</li>
<li class="nav-item">
<a class="nav-link" rel="noopener noreferrer" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
</li>
<li class="nav-item ms-4">
<iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
</li>
</ul>
<ul class="navbar-nav ms-auto">
<li class="nav-item ms-3">
<form class="d-flex form-inline" action="../www/search.html">
<input class="form-control me-2" type="text" name="q" placeholder="Search site..." aria-label="Search">
<button class="btn btn-outline-warning" type="submit" name="sa">Search</button>
</form>
</li>
<li class="nav-item dropdown ms-3">
<a class="nav-link dropdown-toggle" href="#" id="themeDropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
<span id="currentThemeIcon">🌓</span>
</a>
<ul class="dropdown-menu dropdown-menu-end" aria-labelledby="themeDropdown">
<li><a class="dropdown-item" href="#" onclick="setTheme('light')">☀️ Light</a></li>
<li><a class="dropdown-item" href="#" onclick="setTheme('dark')">🌙 Dark</a></li>
<li><a class="dropdown-item" href="#" onclick="setTheme('auto')">🌓 Auto</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<div class="col-lg-8 mx-auto text-body-secondary pt-5 pt-lg-5">
<header class="d-flex align-items-center pb-3 mb-5 border-bottom">
<div class="mt-3 ms-3">
<a href="../index.html" class="text-decoration-none">
<h1 class="fs-2 mb-1">Command-line Tools: Stream</h1>
</a>
<h2 class="fs-5 text-muted">ImageMagick</h2>
</div>
</header>
<main role="main" class="container">
<div>
<p class="text-center"><a href="#usage">Example Usage</a><a href="#options">Option Summary</a></p>
<p class="lead"><samp>Stream</samp> is a lightweight tool to stream one or more pixel components of the image or portion of the image to your choice of storage formats. It writes the pixel components as they are read from the input image a row at a time making <samp>stream</samp> desirable when working with large images or when you require raw pixel components.</p>
<h2><a class="anchor" id="usage"></a>Example Usage</h2>
<p>We list a few examples of the <samp>stream</samp> command here to illustrate its usefulness and ease of use. To get started, lets stream the red, green, blue components of a 640x480 JPEG image to disk as unsigned characters:</p>
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary cli"><samp>magick stream -map rgb -storage-type char image.jpg pixels.dat
magick display -depth 8 -size 640x480 rgb:pixels.dat
</samp></pre>
<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary cli"><samp>magick stream -map i -storage-type double -extract 100x100+30+40 image.tif gray.raw
</samp></pre>
<p>You can also associate the region to extract with the image filename:</p>
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary cli"><samp>magick stream -map i -storage-type double 'image.tif[100x100+30+40]' gray.raw
</samp></pre>
<p>Streaming requires that the image coder read the image pixels in row order. Not all formats adhere to this requirement. Verify a particular image format first, before you utilize streaming in your workflow.</p>
<h2><a class="anchor" id="options"></a>Option Summary</h2>
<p>The <samp>stream</samp> command recognizes these options. Click on an option to get more details about how that option works.</p>
<table class="table table-sm table-hover table-striped table-responsive">
<thead>
<tr>
<th scope="col">Option</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="command-line-options.html#authenticate">-authenticate <var>value</var></a></td>
<td>decrypt image with this password</td>
</tr>
<tr>
<td><a href="command-line-options.html#channel">-channel <var>type</var></a></td>
<td>apply option to select image channels</td>
</tr>
<tr>
<td><a href="command-line-options.html#colorspace">-colorspace <var>type</var></a></td>
<td>set image colorspace</td>
</tr>
<tr>
<td><a href="command-line-options.html#debug">-debug <var>events</var></a></td>
<td>display copious debugging information</td>
</tr>
<tr>
<td><a href="command-line-options.html#define">-define <var>format:option</var></a></td>
<td>define one or more image format options</td>
</tr>
<tr>
<td><a href="command-line-options.html#density">-density <var>geometry</var></a></td>
<td>horizontal and vertical density of the image</td>
</tr>
<tr>
<td><a href="command-line-options.html#depth">-depth <var>value</var></a></td>
<td>image depth</td>
</tr>
<tr>
<td><a href="command-line-options.html#extract">-extract <var>geometry</var></a></td>
<td>extract area from image</td>
</tr>
<tr>
<td><a href="command-line-options.html#help">-help</a></td>
<td>print program options</td>
</tr>
<tr>
<td><a href="command-line-options.html#interlace">-interlace <var>type</var></a></td>
<td>type of image interlacing scheme</td>
</tr>
<tr>
<td><a href="command-line-options.html#interpolate">-interpolate <var>method</var></a></td>
<td>pixel color interpolation method</td>
</tr>
<tr>
<td><a href="command-line-options.html#limit">-limit <var>type value</var></a></td>
<td>pixel cache resource limit</td>
</tr>
<tr>
<td><a href="command-line-options.html#list">-list <var>type</var></a></td>
<td>Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
</tr>
<tr>
<td><a href="command-line-options.html#log">-log <var>format</var></a></td>
<td>format of debugging information</td>
</tr>
<tr>
<td><a href="command-line-options.html#stream-map">-map <var>components</var></a></td>
<td>store pixels in this format.</td>
</tr>
<tr>
<td><a href="command-line-options.html#monitor">-monitor</a></td>
<td>monitor progress</td>
</tr>
<tr>
<td><a href="command-line-options.html#quantize">-quantize <var>colorspace</var></a></td>
<td>reduce image colors in this colorspace</td>
</tr>
<tr>
<td><a href="command-line-options.html#quiet">-quiet</a></td>
<td>suppress all warning messages</td>
</tr>
<tr>
<td><a href="command-line-options.html#regard-warnings">-regard-warnings</a></td>
<td>pay attention to warning messages.</td>
</tr>
<tr>
<td><a href="command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
<td>settings remain in effect until parenthesis boundary.</td>
</tr>
<tr>
<td><a href="command-line-options.html#sampling-factor">-sampling-factor <var>geometry</var></a></td>
<td>horizontal and vertical sampling factor</td>
</tr>
<tr>
<td><a href="command-line-options.html#seed">-seed <var>value</var></a></td>
<td>seed a new sequence of pseudo-random numbers</td>
</tr>
<tr>
<td><a href="command-line-options.html#set">-set <var>attribute value</var></a></td>
<td>set an image attribute</td>
</tr>
<tr>
<td><a href="command-line-options.html#size">-size <var>geometry</var></a></td>
<td>width and height of image</td>
</tr>
<tr>
<td><a href="command-line-options.html#storage-type">-storage-type <var>type</var></a></td>
<td>store pixels with this storage type.</td>
</tr>
<tr>
<td><a href="command-line-options.html#synchronize">-synchronize</a></td>
<td>synchronize image to storage device</td>
</tr>
<tr>
<td><a href="command-line-options.html#taint">-taint</a></td>
<td>mark the image as modified</td>
</tr>
<tr>
<td><a href="command-line-options.html#transparent-color">-transparent-color <var>color</var></a></td>
<td>transparent color</td>
</tr>
<tr>
<td><a href="command-line-options.html#verbose">-verbose</a></td>
<td>print detailed information about the image</td>
</tr>
<tr>
<td><a href="command-line-options.html#version">-version</a></td>
<td>print version information</td>
</tr>
<tr>
<td><a href="command-line-options.html#virtual-pixel">-virtual-pixel <var>method</var></a></td>
<td>access method for pixels outside the boundaries of the image</td>
</tr>
</tbody>
</table>
</div>
<a aria-label="About ImageMagick" class="btn btn-outline-warning mt-3" href="../index.html">About ImageMagick</a>
</main><!-- /.container -->
<footer class="text-center pt-5 my-5 text-body-secondary border-top">
<div class="container-fluid">
<a href="security-policy.html">Security</a>
<a href="../www/news.html">News</a>
<a href="#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../images/wand.ico" /></a>
<a href="../www/links.html">Related</a>
<a href="../www/sitemap.html">Sitemap</a>
<br>
<a href="../www/support.html">Sponsor</a>
<a href="../www/cite.html">Cite</a>
<a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
<a href="../www/https://imagemagick.org/script/contact.php">Contact Us</a>
<br>
<a href="https://github.com/imagemagick/imagemagick" rel="noopener noreferrer" target="_blank" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a>
<a href="https://twitter.com/imagemagick" rel="noopener noreferrer" target="_blank" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
<br>
<small>Copyright © 1999 ImageMagick Studio LLC</small>
</div>
</footer>
</div>
<!-- Javascript assets -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js" integrity="sha384-FKyoEForCGlyvwx9Hj09JcYn3nv7wiPVlz7YYwJrWVcXK/BmnVDxM+D2scQbITxI" crossorigin="anonymous"></script>
~
</body>
</html>
<!-- Magick Cache 3rd October 2025 22:22 -->