~ubuntu-branches/ubuntu/saucy/vips/saucy

void * <a class="link" href="VipsFormat.html#vips-format-map" title="vips_format_map ()">vips_format_map</a> (<code><a class="link" href="libvips-util.html#VipsSListMap2Fn" title="VipsSListMap2Fn ()">VipsSListMap2Fn</a> fn</code>,

<code>void *a</code>,

<code>void *b</code>);

<a class="link" href="VipsFormat.html#VipsFormatClass" title="VipsFormatClass">VipsFormatClass</a> * <a class="link" href="VipsFormat.html#vips-format-for-file" title="vips_format_for_file ()">vips_format_for_file</a> (<code>const char *filename</code>);

<a class="link" href="VipsFormat.html#VipsFormatClass" title="VipsFormatClass">VipsFormatClass</a> * <a class="link" href="VipsFormat.html#vips-format-for-name" title="vips_format_for_name ()">vips_format_for_name</a> (<code>const char *filename</code>);

<a class="link" href="VipsFormat.html#VipsFormatFlags" title="enum VipsFormatFlags">VipsFormatFlags</a> <a class="link" href="VipsFormat.html#vips-format-get-flags" title="vips_format_get_flags ()">vips_format_get_flags</a> (<code><a class="link" href="VipsFormat.html#VipsFormatClass" title="VipsFormatClass">VipsFormatClass</a> *format</code>,

<code>const char *filename</code>);

int <a class="link" href="VipsFormat.html#vips-format-read" title="vips_format_read ()">vips_format_read</a> (<code>const char *filename</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

int <a class="link" href="VipsFormat.html#vips-format-write" title="vips_format_write ()">vips_format_write</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

<code>const char *filename</code>);

int <a class="link" href="VipsFormat.html#im-jpeg2vips" title="im_jpeg2vips ()">im_jpeg2vips</a> (<code>const char *filename</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

int <a class="link" href="VipsFormat.html#im-bufjpeg2vips" title="im_bufjpeg2vips ()">im_bufjpeg2vips</a> (<code>void *buf</code>,

<code>size_t len</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>,

<code>gboolean header_only</code>);

int <a class="link" href="VipsFormat.html#im-vips2jpeg" title="im_vips2jpeg ()">im_vips2jpeg</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

<code>const char *filename</code>);

int <a class="link" href="VipsFormat.html#im-vips2mimejpeg" title="im_vips2mimejpeg ()">im_vips2mimejpeg</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

<code>int qfac</code>);

int <a class="link" href="VipsFormat.html#im-vips2bufjpeg" title="im_vips2bufjpeg ()">im_vips2bufjpeg</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>,

<code>int qfac</code>,

<code>char **obuf</code>,

<code>int *olen</code>);

int <a class="link" href="VipsFormat.html#im-tiff2vips" title="im_tiff2vips ()">im_tiff2vips</a> (<code>const char *filename</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

int <a class="link" href="VipsFormat.html#im-vips2tiff" title="im_vips2tiff ()">im_vips2tiff</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

<code>const char *filename</code>);

int <a class="link" href="VipsFormat.html#im-tile-cache" title="im_tile_cache ()">im_tile_cache</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>,

<code>int tile_width</code>,

<code>int tile_height</code>,

<code>int max_tiles</code>);

int <a class="link" href="VipsFormat.html#im-magick2vips" title="im_magick2vips ()">im_magick2vips</a> (<code>const char *filename</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

int <a class="link" href="VipsFormat.html#im-exr2vips" title="im_exr2vips ()">im_exr2vips</a> (<code>const char *filename</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

int <a class="link" href="VipsFormat.html#im-ppm2vips" title="im_ppm2vips ()">im_ppm2vips</a> (<code>const char *filename</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

int <a class="link" href="VipsFormat.html#im-vips2ppm" title="im_vips2ppm ()">im_vips2ppm</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

<code>const char *filename</code>);

int <a class="link" href="VipsFormat.html#im-analyze2vips" title="im_analyze2vips ()">im_analyze2vips</a> (<code>const char *filename</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

int <a class="link" href="VipsFormat.html#im-csv2vips" title="im_csv2vips ()">im_csv2vips</a> (<code>const char *filename</code>,

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

int <a class="link" href="VipsFormat.html#im-vips2csv" title="im_vips2csv ()">im_vips2csv</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

100

<code>const char *filename</code>);

101

int <a class="link" href="VipsFormat.html#im-png2vips" title="im_png2vips ()">im_png2vips</a> (<code>const char *filename</code>,

102

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

103

int <a class="link" href="VipsFormat.html#im-vips2png" title="im_vips2png ()">im_vips2png</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

104

<code>const char *filename</code>);

105

int <a class="link" href="VipsFormat.html#im-vips2bufpng" title="im_vips2bufpng ()">im_vips2bufpng</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

106

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>,

107

<code>int compression</code>,

108

<code>int interlace</code>,

109

<code>char **obuf</code>,

110

<code>size_t *olen</code>);

111

int <a class="link" href="VipsFormat.html#im-raw2vips" title="im_raw2vips ()">im_raw2vips</a> (<code>const char *filename</code>,

112

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>,

113

<code>int width</code>,

114

<code>int height</code>,

115

<code>int bpp</code>,

116

<code>int offset</code>);

117

int <a class="link" href="VipsFormat.html#im-vips2raw" title="im_vips2raw ()">im_vips2raw</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

118

<code>int fd</code>);

119

int <a class="link" href="VipsFormat.html#im-mat2vips" title="im_mat2vips ()">im_mat2vips</a> (<code>const char *filename</code>,

120

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

121

int <a class="link" href="VipsFormat.html#im-rad2vips" title="im_rad2vips ()">im_rad2vips</a> (<code>const char *filename</code>,

122

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

123

int <a class="link" href="VipsFormat.html#im-vips2rad" title="im_vips2rad ()">im_vips2rad</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

124

<code>const char *filename</code>);

125

int <a class="link" href="VipsFormat.html#im-fits2vips" title="im_fits2vips ()">im_fits2vips</a> (<code>const char *filename</code>,

126

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);

127

int <a class="link" href="VipsFormat.html#im-vips2fits" title="im_vips2fits ()">im_vips2fits</a> (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

128

<code>const char *filename</code>);

129

</pre>

130

</div>

131

132

<a name="VipsFormat.object-hierarchy"></a><h2>Object Hierarchy</h2>

133

134

GObject

135

+----<a class="link" href="libvips-VipsArgument.html#VipsObject">VipsObject</a>

136

+----VipsFormat

137

</pre>

138

</div>

139

140

<a name="VipsFormat.description"></a><h2>Description</h2>

141

142

VIPS has a simple system for representing image load and save operations in

143

a generic way.

144

You can ask for a loader for a certain file or select a saver based on a

145

filename. Once you have found a format, you can use it to load a file of

146

that type, save an image to a file of that type, query files for their type

147

and fields, and ask for supported features. You can also call the

148

converters directly, if you like.

149

150

151

If you define a new format, support for

152

it automatically appears in all VIPS user-interfaces. It will also be

153

transparently supported by <code class="function">im_open()</code>.

154

155

156

VIPS comes with VipsFormat for TIFF, JPEG, PNG, Analyze, PPM, OpenEXR, CSV,

157

Matlab, Radiance, RAW, VIPS and one that wraps libMagick.

158

159

</div>

160

161

<a name="VipsFormat.details"></a><h2>Details</h2>

162

163

<a name="VipsFormatFlags"></a><h3>enum VipsFormatFlags</h3>

164

<pre class="programlisting">typedef enum {

165

VIPS_FORMAT_NONE = 0, /* No flags set */

166

VIPS_FORMAT_PARTIAL = 1, /* Lazy read OK (eg. tiled tiff) */

167

VIPS_FORMAT_BIGENDIAN = 2 /* Most-significant byte first */

168

} VipsFormatFlags;

169

</pre>

170

171

Some hints about the image loader.

172

173

174

<code>VIPS_FORMAT_PARTIAL</code> means that the image can be read directly from the

175

file without needing to be unpacked to a temporary image first.

176

177

178

<code>VIPS_FORMAT_BIGENDIAN</code> means that image pixels are most-significant byte

179

first. Depending on the native byte order of the host machine, you may

180

need to swap bytes. See <a class="link" href="libvips-conversion.html#im-copy-swap" title="im_copy_swap ()"><code class="function">im_copy_swap()</code></a>.

181

182

183

184

<tbody>

185

<tr>

186

<td><a name="VIPS-FORMAT-NONE:CAPS"></a><code class="literal">VIPS_FORMAT_NONE</code></td>

187

<td>no flags set

188

</td>

189

</tr>

190

<tr>

191

<td><a name="VIPS-FORMAT-PARTIAL:CAPS"></a><code class="literal">VIPS_FORMAT_PARTIAL</code></td>

192

<td>the image may be read lazilly

193

</td>

194

</tr>

195

<tr>

196

<td><a name="VIPS-FORMAT-BIGENDIAN:CAPS"></a><code class="literal">VIPS_FORMAT_BIGENDIAN</code></td>

197

<td>image pixels are most-significant byte first

198

</td>

199

</tr>

200

</tbody>

201

</table></div>

202

</div>

203

<hr>

204

205

<a name="VipsFormat-struct"></a><h3>VipsFormat</h3>

206

<pre class="programlisting">typedef struct _VipsFormat VipsFormat;</pre>

207

208

Actually, we never make <a class="link" href="VipsFormat.html" title="VipsFormat"><code class="literal">VipsFormat</code></a> objects, we just use virtual methods on

209

the class object. It is defined as:

210

211

212

213

214

typedef struct _VipsFormatClass {

215

VipsObjectClass parent_class;

216

217

gboolean (*is_a)( const char *filename );

218

int (*header)( const char *filename, IMAGE *out );

219

int (*load)( const char *filename, IMAGE *out );

220

int (*save)( IMAGE *in, const char *filename );

221

VipsFormatFlags (*get_flags)( const char *filename );

222

int priority;

223

const char **suffs;

224

} VipsFormatClass;

225

</pre></div>

226

227

228

229

Add a new format to VIPS by subclassing VipsFormat. Subclasses need to

230

implement at least <code class="function">load()</code> or <code class="function">save()</code>.

231

232

233

These members are:

234

235

236

237

238

239

<code class="function">is_a()</code> This function should return <code class="literal">TRUE</code> if the file

240

contains an image of this type. If you don't define this function, VIPS

241

will use the list of suffixes you supply instead.

242

</li>

243

244

<code class="function">header()</code> This function should load the image header,

245

but not load any pixel data. If you don't define it, VIPS will use your

246

<code class="function">load()</code> method instead. Return 0 for success, -1 for error, setting

247

<code class="function">im_error()</code>.

248

</li>

249

250

<code class="function">load()</code> This function should load the image, or perhaps use <code class="function">im_generate()</code> to

251

attach something to load sections of the image on demand.

252

Users can embed

253

load options in the filename, see (for example) <a class="link" href="VipsFormat.html#im-jpeg2vips" title="im_jpeg2vips ()"><code class="function">im_jpeg2vips()</code></a>.

254

If you don't

255

define this method, you can still define <code class="function">save()</code> and have a save-only

256

format.

257

Return 0 for success, -1 for error, setting

258

<code class="function">im_error()</code>.

259

</li>

260

261

<code class="function">save()</code> This function should save the image to the file.

262

Users can embed

263

save options in the filename, see (for example) <a class="link" href="VipsFormat.html#im-vips2tiff" title="im_vips2tiff ()"><code class="function">im_vips2tiff()</code></a>.

264

If you don't

265

define this method, you can still define <code class="function">load()</code> and have a load-only

266

format.

267

Return 0 for success, -1 for error, setting

268

<code class="function">im_error()</code>.

269

</li>

270

271

<code class="function">get_flags()</code> This function should return a hint about the properties of this

272

loader on this file. If you don't define it, users will always see '0', or

273

no flags.

274

</li>

275

276

<code>priority</code> Where this format should fit in this

277

list of

278

supported formats. 0 is a sensible value for most formats. Set a negative

279

value if you want to be lower on the list, positive to move up.

280

</li>

281

282

283

<code>suffs</code> A <code class="literal">NULL</code>-terminated list of possible file

284

name

285

suffixes, for example:

286

287

288

static const char *tiff_suffs[] = { ".tif", ".tiff", NULL };

289

</pre></div>

290

291

The suffix list is used to select a format to save a file in, and to pick a

292

loader if you don't define <code class="function">is_a()</code>.

293

294

</li>

295

</ul></div>

296

297

298

299

You should also define <code>nickname</code> and

300

<code>description</code> in <a class="link" href="libvips-VipsArgument.html#VipsObject">VipsObject</a>.

301

302

303

At the command-line, use:

304

305

306

307

308

vips --list classes | grep Format

309

</pre></div>

310

311

312

313

To see a list of all the supported formats.

314

315

316

For example, the TIFF format is defined like this:

317

318

319

320

321

typedef VipsFormat VipsFormatTiff;

322

typedef VipsFormatClass VipsFormatTiffClass;

323

324

static void

325

vips_format_tiff_class_init( VipsFormatTiffClass *class )

326

{

327

VipsObjectClass *object_class = (VipsObjectClass *) class;

328

VipsFormatClass *format_class = (VipsFormatClass *) class;

329

330

object_class->nickname = "tiff";

331

object_class->description = _( "TIFF" );

332

333

format_class->is_a = istiff;

334

format_class->header = tiff2vips_header;

335

format_class->load = im_tiff2vips;

336

format_class->save = im_vips2tiff;

337

format_class->get_flags = tiff_flags;

338

format_class->suffs = tiff_suffs;

339

}

340

341

static void

342

vips_format_tiff_init( VipsFormatTiff *object )

343

{

344

}

345

346

G_DEFINE_TYPE( VipsFormatTiff, vips_format_tiff, VIPS_TYPE_FORMAT );

347

</pre></div>

348

349

350

351

Then call <code class="function">vips_format_tiff_get_type()</code> somewhere in your init code to link

352

the format into VIPS (though of course the tiff format is linked in for you

353

already).

354

355

</div>

356

<hr>

357

358

<a name="VipsFormatClass"></a><h3>VipsFormatClass</h3>

359

<pre class="programlisting">typedef struct {

360

VipsObjectClass parent_class;

361

362

/* Is a file in this format.

363

364

gboolean (*is_a)( const char * );

365

366

/* Read just the header into the VipsImage.

367

368

int (*header)( const char *, VipsImage * );

369

370

/* Load the whole image.

371

372

int (*load)( const char *, VipsImage * );

373

374

/* Write the VipsImage to the file in this format.

375

376

int (*save)( VipsImage *, const char * );

377

378

/* Get the flags for this file in this format.

379

380

VipsFormatFlags (*get_flags)( const char * );

381

382

/* Loop over formats in this order, default 0. We need this because

383

* some formats can be read by several loaders (eg. tiff can be read

384

* by the libMagick loader as well as by the tiff loader), and we want

385

* to make sure the better loader comes first.

386

387

int priority;

388

389

/* Null-terminated list of allowed suffixes, eg. ".tif", ".tiff".

390

391

const char **suffs;

392

} VipsFormatClass;

393

</pre>

394

</div>

395

<hr>

396

397

<a name="vips-format-map"></a><h3>vips_format_map ()</h3>

398

<pre class="programlisting">void * vips_format_map (<code><a class="link" href="libvips-util.html#VipsSListMap2Fn" title="VipsSListMap2Fn ()">VipsSListMap2Fn</a> fn</code>,

399

<code>void *a</code>,

400

401

402

Apply a function to every <a class="link" href="VipsFormat.html#VipsFormatClass" title="VipsFormatClass"><code class="literal">VipsFormatClass</code></a> that VIPS knows about. Formats

403

are presented to the function in priority order.

404

405

406

Like all VIPS map functions, if <code>fn</code> returns <code class="literal">NULL</code>, iteration continues. If

407

it returns non-<code class="literal">NULL</code>, iteration terminates and that value is returned. The

408

map function returns <code class="literal">NULL</code> if all calls return <code class="literal">NULL</code>.

409

410

411

See also: <code class="function">im_slist_map()</code>.

412

413

414

415

<tbody>

416

<tr>

417

418

<td>function to apply to each <a class="link" href="VipsFormat.html#VipsFormatClass" title="VipsFormatClass">VipsFormatClass</a>

419

</td>

420

</tr>

421

<tr>

422

423

424

</tr>

425

<tr>

426

427

428

</tr>

429

<tr>

430

<td>Returns :</td>

431

<td>the result of iteration</td>

432

</tr>

433

</tbody>

434

</table></div>

435

</div>

436

<hr>

437

438

<a name="vips-format-for-file"></a><h3>vips_format_for_file ()</h3>

439

<pre class="programlisting"><a class="link" href="VipsFormat.html#VipsFormatClass" title="VipsFormatClass">VipsFormatClass</a> * vips_format_for_file (<code>const char *filename</code>);</pre>

440

441

Searches for a format you could use to load a file.

442

443

444

See also: <a class="link" href="VipsFormat.html#vips-format-read" title="vips_format_read ()"><code class="function">vips_format_read()</code></a>, <a class="link" href="VipsFormat.html#vips-format-for-name" title="vips_format_for_name ()"><code class="function">vips_format_for_name()</code></a>.

445

446

447

448

<tbody>

449

<tr>

450

<td><code>filename</code> :</td>

451

<td>file to find a format for</td>

452

</tr>

453

<tr>

454

<td>Returns :</td>

455

<td>a format on success, <code class="literal">NULL</code> on error</td>

456

</tr>

457

</tbody>

458

</table></div>

459

</div>

460

<hr>

461

462

<a name="vips-format-for-name"></a><h3>vips_format_for_name ()</h3>

463

<pre class="programlisting"><a class="link" href="VipsFormat.html#VipsFormatClass" title="VipsFormatClass">VipsFormatClass</a> * vips_format_for_name (<code>const char *filename</code>);</pre>

464

465

Searches for a format you could use to save a file.

466

467

468

See also: <a class="link" href="VipsFormat.html#vips-format-write" title="vips_format_write ()"><code class="function">vips_format_write()</code></a>, <a class="link" href="VipsFormat.html#vips-format-for-file" title="vips_format_for_file ()"><code class="function">vips_format_for_file()</code></a>.

469

470

471

472

<tbody>

473

<tr>

474

<td><code>filename</code> :</td>

475

<td>name to find a format for</td>

476

</tr>

477

<tr>

478

<td>Returns :</td>

479

<td>a format on success, <code class="literal">NULL</code> on error</td>

480

</tr>

481

</tbody>

482

</table></div>

483

</div>

484

<hr>

485

486

<a name="vips-format-get-flags"></a><h3>vips_format_get_flags ()</h3>

487

<pre class="programlisting"><a class="link" href="VipsFormat.html#VipsFormatFlags" title="enum VipsFormatFlags">VipsFormatFlags</a> vips_format_get_flags (<code><a class="link" href="VipsFormat.html#VipsFormatClass" title="VipsFormatClass">VipsFormatClass</a> *format</code>,

488

<code>const char *filename</code>);</pre>

489

490

Get a set of flags for this file.

491

492

493

494

<tbody>

495

<tr>

496

<td><code>format</code> :</td>

497

<td>format to test</td>

498

</tr>

499

<tr>

500

<td><code>filename</code> :</td>

501

502

</tr>

503

<tr>

504

<td>Returns :</td>

505

<td>flags for this format and file</td>

506

</tr>

507

</tbody>

508

</table></div>

509

</div>

510

<hr>

511

512

<a name="vips-format-read"></a><h3>vips_format_read ()</h3>

513

<pre class="programlisting">int vips_format_read (<code>const char *filename</code>,

514

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

515

516

Searches for a format for this file, then loads the file into <code>out</code>.

517

518

519

See also: <a class="link" href="VipsFormat.html#vips-format-write" title="vips_format_write ()"><code class="function">vips_format_write()</code></a>.

520

521

522

523

<tbody>

524

<tr>

525

<td><code>filename</code> :</td>

526

527

</tr>

528

<tr>

529

530

<td>write the file to this image</td>

531

</tr>

532

<tr>

533

<td>Returns :</td>

534

<td>0 on success, -1 on error</td>

535

</tr>

536

</tbody>

537

</table></div>

538

</div>

539

<hr>

540

541

<a name="vips-format-write"></a><h3>vips_format_write ()</h3>

542

<pre class="programlisting">int vips_format_write (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

543

<code>const char *filename</code>);</pre>

544

545

Searches for a format for this name, then saves <code>im</code> to it.

546

547

548

See also: <a class="link" href="VipsFormat.html#vips-format-read" title="vips_format_read ()"><code class="function">vips_format_read()</code></a>.

549

550

551

552

<tbody>

553

<tr>

554

555

<td>image to write</td>

556

</tr>

557

<tr>

558

<td><code>filename</code> :</td>

559

<td>file to write to</td>

560

</tr>

561

<tr>

562

<td>Returns :</td>

563

<td>0 on success, -1 on error</td>

564

</tr>

565

</tbody>

566

</table></div>

567

</div>

568

<hr>

569

570

571

<pre class="programlisting">int im_jpeg2vips (<code>const char *filename</code>,

572

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

573

574

Read a JPEG file into a VIPS image. It can read most 8-bit JPEG images,

575

including CMYK and YCbCr.

576

577

578

You can embed options in the filename. They have the form:

579

580

581

582

583

filename.jpg:shrink-factor,fail

584

</pre></div>

585

586

587

588

589

590

591

shrink-factor

592

Shrink by this integer factor during load. Allowed values are 1, 2, 4

593

and 8. Shrinking during read is very much faster than decompressing the

594

whole image and then shrinking.

595

</li>

596

597

fail

598

This makes the JPEG reader fail on any warnings. This can be useful for

599

detecting truncated files, for example. Normally reading these produces

600

a warning, but no fatal error.

601

</li>

602

</ul></div>

603

604

605

606

Example:

607

608

609

610

611

im_jpeg2vips( "fred.jpg:8" out );

612

im_jpeg2vips( "fred.jpg:,fail" out );

613

</pre></div>

614

615

616

617

The first example will shrink by a factor of 8 during load. The second will

618

fail with an error if there are any problems loading the file.

619

620

621

Any embedded ICC profiles are ignored: you always just get the RGB from

622

the file. Instead, the embedded profile will be attached to the image as

623

metadata. You need to use something like <a class="link" href="libvips-colour.html#im-icc-import" title="im_icc_import ()"><code class="function">im_icc_import()</code></a> to get CIE

624

values from the file. Any EXIF data is also attached as VIPS metadata.

625

626

627

The int metadata item "jpeg-multiscan" is set to the result of

628

<code class="function">jpeg_has_multiple_scans()</code>. Interlaced jpeg images need a large amount of

629

memory to load, so this field gives callers a chance to handle these

630

images differently.

631

632

633

The EXIF thumbnail, if present, is attached to the image as

634

"jpeg-thumbnail-data". See <code class="function">im_meta_get_blob()</code>.

635

636

637

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-vips2jpeg" title="im_vips2jpeg ()"><code class="function">im_vips2jpeg()</code></a>.

638

639

640

641

<tbody>

642

<tr>

643

<td><code>filename</code> :</td>

644

645

</tr>

646

<tr>

647

648

<td>image to write to</td>

649

</tr>

650

<tr>

651

<td>Returns :</td>

652

<td>0 on success, -1 on error.</td>

653

</tr>

654

</tbody>

655

</table></div>

656

</div>

657

<hr>

658

659

<a name="im-bufjpeg2vips"></a><h3>im_bufjpeg2vips ()</h3>

660

<pre class="programlisting">int im_bufjpeg2vips (<code>void *buf</code>,

661

<code>size_t len</code>,

662

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>,

663

<code>gboolean header_only</code>);</pre>

664

665

Read a JPEG-formatted memory block into a VIPS image. It can read most

666

8-bit JPEG images, including CMYK and YCbCr.

667

668

669

This function is handy for processing JPEG image thumbnails.

670

671

672

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-jpeg2vips" title="im_jpeg2vips ()"><code class="function">im_jpeg2vips()</code></a>.

673

674

675

676

<tbody>

677

<tr>

678

679

<td>memory area to load</td>

680

</tr>

681

<tr>

682

683

<td>size of memory area</td>

684

</tr>

685

<tr>

686

687

<td>image to write</td>

688

</tr>

689

<tr>

690

<td><code>header_only</code> :</td>

691

<td>set to just read the header</td>

692

</tr>

693

<tr>

694

<td>Returns :</td>

695

<td>0 on success, -1 on error.</td>

696

</tr>

697

</tbody>

698

</table></div>

699

</div>

700

<hr>

701

702

703

<pre class="programlisting">int im_vips2jpeg (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

704

<code>const char *filename</code>);</pre>

705

706

Write a VIPS image to a file as JPEG.

707

708

709

You can embed options in the filename. They have the form:

710

711

712

713

714

filename.jpg:compression,profile

715

</pre></div>

716

717

718

719

720

721

722

compression

723

Compress with this quality factor. Default 75.

724

</li>

725

726

profile

727

Attach this ICC profile. For example, "fred.jpg:,/home/john/srgb.icc" will

728

embed the profile stored in the file "/home/john/srgb.icc" in the JPEG

729

image. This does not affect the pixels which are written, just the way

730

they are tagged. You can use the special string "none" to mean

731

"don't attach a profile".

732

</li>

733

</ul></div>

734

735

736

737

If no profile is specified in the save string and the VIPS header

738

contains an ICC profile named IM_META_ICC_NAME ("icc-profile-data"), the

739

profile from the VIPS header will be attached.

740

741

742

The image is automatically converted to RGB, Monochrome or CMYK before

743

saving. Any metadata attached to the image is saved as EXIF, if possible.

744

745

746

Example:

747

748

749

750

751

im_vips2jpeg( in, "fred.jpg:99,none" );

752

</pre></div>

753

754

755

756

Will write "fred.jpg" at high-quality with no ICC profile.

757

758

759

760

761

762

763

<tbody>

764

<tr>

765

766

<td>image to save</td>

767

</tr>

768

<tr>

769

<td><code>filename</code> :</td>

770

<td>file to write to</td>

771

</tr>

772

<tr>

773

<td>Returns :</td>

774

<td>0 on success, -1 on error.</td>

775

</tr>

776

</tbody>

777

</table></div>

778

</div>

779

<hr>

780

781

<a name="im-vips2mimejpeg"></a><h3>im_vips2mimejpeg ()</h3>

782

<pre class="programlisting">int im_vips2mimejpeg (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

783

784

785

As <a class="link" href="VipsFormat.html#im-vips2jpeg" title="im_vips2jpeg ()"><code class="function">im_vips2jpeg()</code></a>, but save as a mime jpeg on stdout.

786

787

788

789

790

791

792

<tbody>

793

<tr>

794

795

<td>image to save</td>

796

</tr>

797

<tr>

798

799

<td>JPEG quality factor</td>

800

</tr>

801

<tr>

802

<td>Returns :</td>

803

<td>0 on success, -1 on error.</td>

804

</tr>

805

</tbody>

806

</table></div>

807

</div>

808

<hr>

809

810

<a name="im-vips2bufjpeg"></a><h3>im_vips2bufjpeg ()</h3>

811

<pre class="programlisting">int im_vips2bufjpeg (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

812

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>,

813

<code>int qfac</code>,

814

<code>char **obuf</code>,

815

816

817

As <a class="link" href="VipsFormat.html#im-vips2jpeg" title="im_vips2jpeg ()"><code class="function">im_vips2jpeg()</code></a>, but save as a memory buffer. The memory is allocated

818

local to <code>out</code> (that is, when <code>out</code> is closed the memory will be released,

819

pass <code class="literal">NULL</code> to release yourself).

820

821

822

The address of the buffer is returned in <code>obuf</code>, the length of the buffer in

823

<code>olen</code>. <code>olen</code> should really be a size_t rather than an int :-(

824

825

826

827

828

829

830

<tbody>

831

<tr>

832

833

<td>image to save</td>

834

</tr>

835

<tr>

836

837

<td>allocate output buffer local to this</td>

838

</tr>

839

<tr>

840

841

<td>JPEG quality factor</td>

842

</tr>

843

<tr>

844

845

<td>return output buffer here</td>

846

</tr>

847

<tr>

848

849

<td>return output length here</td>

850

</tr>

851

<tr>

852

<td>Returns :</td>

853

<td>0 on success, -1 on error.</td>

854

</tr>

855

</tbody>

856

</table></div>

857

</div>

858

<hr>

859

860

861

<pre class="programlisting">int im_tiff2vips (<code>const char *filename</code>,

862

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

863

864

Read a TIFF file into a VIPS image. It is a full baseline TIFF 6 reader,

865

with extensions for tiled images, multipage images, LAB colour space,

866

pyramidal images and JPEG compression. including CMYK and YCbCr.

867

868

869

You can embed a page number in the filename. For example:

870

871

872

873

874

im_tiff2vips( "fred.tif:23", out );

875

</pre></div>

876

877

878

879

Will read page 23. By default, the operation reads the first page.

880

881

882

Any ICC profile is read out and attached to the VIPS image.

883

884

885

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-vips2tiff" title="im_vips2tiff ()"><code class="function">im_vips2tiff()</code></a>.

886

887

888

889

<tbody>

890

<tr>

891

<td><code>filename</code> :</td>

892

893

</tr>

894

<tr>

895

896

<td>image to write to</td>

897

</tr>

898

<tr>

899

<td>Returns :</td>

900

<td>0 on success, -1 on error.</td>

901

</tr>

902

</tbody>

903

</table></div>

904

</div>

905

<hr>

906

907

908

<pre class="programlisting">int im_vips2tiff (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

909

<code>const char *filename</code>);</pre>

910

911

Write a VIPS image to a file as TIFF.

912

913

914

You can embed options in the filename. They have the form:

915

916

917

918

919

filename.tif:compression,layout,multi-res,format,resolution,icc, bigtiff

920

</pre></div>

921

922

923

924

925

926

927

928

compression

929

should be one of "none" (no compression), "jpeg" (JPEG compression),

930

"deflate" (ZIP compression), "packbits" (TIFF packbits compression),

931

"ccittfax4" (CCITT Group 4 fax encoding), "lzw" (Lempel-Ziv compression).

932

933

934

"jpeg" compression can be followed by a ":" character and a JPEG quality

935

level; "lzw" and "deflate" can be followed by a ":" and predictor value.

936

The default compression type is "none", the default JPEG quality factor

937

is 75.

938

939

940

Predictor is not set by default. There are three predictor values recognised

941

at the moment (2007, July): 1 is no prediction, 2 is a horizontal

942

differencing and 3 is a floating point predictor. Refer to the libtiff

943

specifications for further discussion of various predictors. In short,

944

predictor helps to better compress image, especially in case of digital

945

photos or scanned images and bit depths > 8. Try it to find whether it

946

works for your images.

947

948

949

JPEG compression is a good lossy compressor for photographs, packbits is

950

good for 1-bit images, and deflate is the best lossless compression TIFF

951

can do. LZW has patent problems and is no longer recommended.

952

953

</li>

954

955

956

layout

957

should be "strip" (strip layout) or "tile" (tiled layout).

958

959

960

"tile" layout can be followed by a ":" character and the horizontal and

961

vertical tile size, separated by a "x" character. The default layout is

962

"strip", and the default tile size is 128 by 128 pixels.

963

964

</li>

965

966

multi-res

967

should be "flat" (single image) or "pyramid" (many images arranged in a

968

pyramid). The default multi-res mode is "flat".

969

</li>

970

971

format

972

shoiuld be "manybit" (don't bit-reduce images) or "onebit" (one band 8

973

bit images are saved as 1 bit). The default format is "multibit".

974

</li>

975

976

977

resolution

978

should be "res_cm" (output resolution unit is pixels per centimetre) or

979

"res_inch" (output resolution unit is pixels per inch). The default

980

resolution unit is taken from the header field "resolution-unit"

981

(IM_META_RESOLUTION_UNIT in C). If this field is not set, then

982

VIPS defaults to cm.

983

984

985

The unit can optionally be followed by a ":" character and the

986

horizontal and vertical resolution, separated by a "x" character.

987

You can have a single number with no "x" and set the horizontal and

988

vertical resolutions together.

989

990

</li>

991

992

icc

993

Attach this ICC profile.

994

This does not affect the pixels which are written, just the way

995

they are tagged.

996

</li>

997

998

bigtiff

999

Set this to 8 to enable bigtiff output. Bigtiff is a variant of the TIFF

1000

format that allows more than 4GB in a file.

1001

</li>

1002

</ul></div>

1003

1004

1005

1006

Example:

1007

1008

1009

1010

1011

im_vips2jpeg( in, "fred.tif:jpeg,tile,pyramid" );

1012

</pre></div>

1013

1014

1015

1016

Will write "fred.tif" as a tiled jpeg-compressed pyramid.

1017

1018

1019

1020

1021

im_vips2jpeg( in, "fred.tif:packbits,tile,,onebit" );

1022

</pre></div>

1023

1024

1025

1026

Writes a tiled one bit TIFF image (provided fred.v is a one band 8 bit

1027

image) compressed with packbits.

1028

1029

1030

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-tiff2vips" title="im_tiff2vips ()"><code class="function">im_tiff2vips()</code></a>.

1031

1032

1033

1034

<tbody>

1035

<tr>

1036

1037

<td>image to save</td>

1038

</tr>

1039

<tr>

1040

<td><code>filename</code> :</td>

1041

<td>file to write to</td>

1042

</tr>

1043

<tr>

1044

<td>Returns :</td>

1045

<td>0 on success, -1 on error.</td>

1046

</tr>

1047

</tbody>

1048

</table></div>

1049

</div>

1050

<hr>

1051

1052

<a name="im-tile-cache"></a><h3>im_tile_cache ()</h3>

1053

<pre class="programlisting">int im_tile_cache (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

1054

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>,

1055

<code>int tile_width</code>,

1056

<code>int tile_height</code>,

1057

<code>int max_tiles</code>);</pre>

1058

1059

This operation behaves rather like <a class="link" href="libvips-conversion.html#im-copy" title="im_copy ()"><code class="function">im_copy()</code></a> between images

1060

<code>in</code> and <code>out</code>, except that it keeps a cache of computed pixels.

1061

This cache is made of up to <code>max_tiles</code> tiles (a value of -1 for

1062

means any number of tiles), and each tile is of size <code>tile_width</code>

1063

by <code>tile_height</code> pixels. Each cache tile is made with a single call to

1064

<code class="function">im_prepare()</code>.

1065

1066

1067

This is a lower-level operation than <code class="function">im_cache()</code> since it does no

1068

subdivision. It is suitable for caching the output of operations like

1069

<a class="link" href="VipsFormat.html#im-exr2vips" title="im_exr2vips ()"><code class="function">im_exr2vips()</code></a> on tiled images.

1070

1071

1072

See also: <code class="function">im_cache()</code>.

1073

1074

1075

1076

<tbody>

1077

<tr>

1078

1079

<td>input image</td>

1080

</tr>

1081

<tr>

1082

1083

<td>output image</td>

1084

</tr>

1085

<tr>

1086

<td><code>tile_width</code> :</td>

1087

<td>tile width</td>

1088

</tr>

1089

<tr>

1090

<td><code>tile_height</code> :</td>

1091

<td>tile height</td>

1092

</tr>

1093

<tr>

1094

<td><code>max_tiles</code> :</td>

1095

<td>maximum number of tiles to cache</td>

1096

</tr>

1097

<tr>

1098

<td>Returns :</td>

1099

<td>0 on success, -1 on error.</td>

1100

</tr>

1101

</tbody>

1102

</table></div>

1103

</div>

1104

<hr>

1105

1106

<a name="im-magick2vips"></a><h3>im_magick2vips ()</h3>

1107

<pre class="programlisting">int im_magick2vips (<code>const char *filename</code>,

1108

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

1109

1110

Read in an image using libMagick, the ImageMagick library. This library can

1111

read more than 80 file formats, including SVG, BMP, EPS, DICOM and many

1112

others.

1113

The reader can handle any ImageMagick image, including the float and double

1114

formats. It will work with any quantum size, including HDR. Any metadata

1115

attached to the libMagick image is copied on to the VIPS image.

1116

1117

1118

The reader should also work with most versions of GraphicsMagick.

1119

1120

1121

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>.

1122

1123

1124

1125

<tbody>

1126

<tr>

1127

<td><code>filename</code> :</td>

1128

1129

</tr>

1130

<tr>

1131

1132

<td>image to write to</td>

1133

</tr>

1134

<tr>

1135

<td>Returns :</td>

1136

<td>0 on success, -1 on error.</td>

1137

</tr>

1138

</tbody>

1139

</table></div>

1140

</div>

1141

<hr>

1142

1143

1144

<pre class="programlisting">int im_exr2vips (<code>const char *filename</code>,

1145

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

1146

1147

Read a OpenEXR file into a VIPS image.

1148

1149

1150

The reader can handle scanline and tiled OpenEXR images. It can't handle

1151

OpenEXR colour management, image attributes, many pixel formats, anything

1152

other than RGBA.

1153

1154

1155

This reader uses the rather limited OpenEXR C API. It should really be

1156

redone in C++.

1157

1158

1159

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>.

1160

1161

1162

1163

<tbody>

1164

<tr>

1165

<td><code>filename</code> :</td>

1166

1167

</tr>

1168

<tr>

1169

1170

<td>image to write to</td>

1171

</tr>

1172

<tr>

1173

<td>Returns :</td>

1174

<td>0 on success, -1 on error.</td>

1175

</tr>

1176

</tbody>

1177

</table></div>

1178

</div>

1179

<hr>

1180

1181

1182

<pre class="programlisting">int im_ppm2vips (<code>const char *filename</code>,

1183

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

1184

1185

Read a PPM/PBM/PGM/PFM file into a VIPS image.

1186

It can read 1, 8, 16 and 32 bit images, colour or monochrome,

1187

stored in binary or in ASCII. One bit images become 8 bit VIPS images,

1188

with 0 and 255 for 0 and 1.

1189

1190

1191

PFM images have the scale factor attached as "pfm-scale".

1192

1193

1194

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-vips2ppm" title="im_vips2ppm ()"><code class="function">im_vips2ppm()</code></a>, <code class="function">im_meta_get_double()</code>

1195

1196

1197

1198

<tbody>

1199

<tr>

1200

<td><code>filename</code> :</td>

1201

1202

</tr>

1203

<tr>

1204

1205

<td>image to write to</td>

1206

</tr>

1207

<tr>

1208

<td>Returns :</td>

1209

<td>0 on success, -1 on error.</td>

1210

</tr>

1211

</tbody>

1212

</table></div>

1213

</div>

1214

<hr>

1215

1216

1217

<pre class="programlisting">int im_vips2ppm (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

1218

<code>const char *filename</code>);</pre>

1219

1220

Write a VIPS image to a file as PPM. It can write 8, 16 or

1221

32 bit unsigned integer images, float images, colour or monochrome,

1222

stored as binary or ASCII.

1223

Integer images of more than 8 bits can only be stored in ASCII.

1224

1225

1226

When writing float (PFM) images the scale factor is set from the

1227

"pfm-scale" metadata.

1228

1229

1230

The storage format is indicated by a filename extension, for example:

1231

1232

1233

1234

1235

im_vips2ppm( im, "fred.ppm:ascii" )

1236

</pre></div>

1237

1238

1239

1240

will write to "fred.ppm" in ascii format. The default is binary.

1241

1242

1243

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-ppm2vips" title="im_ppm2vips ()"><code class="function">im_ppm2vips()</code></a>, <code class="function">im_meta_set_double()</code>.

1244

1245

1246

1247

<tbody>

1248

<tr>

1249

1250

<td>image to save</td>

1251

</tr>

1252

<tr>

1253

<td><code>filename</code> :</td>

1254

<td>file to write to</td>

1255

</tr>

1256

<tr>

1257

<td>Returns :</td>

1258

<td>0 on success, -1 on error.</td>

1259

</tr>

1260

</tbody>

1261

</table></div>

1262

</div>

1263

<hr>

1264

1265

<a name="im-analyze2vips"></a><h3>im_analyze2vips ()</h3>

1266

<pre class="programlisting">int im_analyze2vips (<code>const char *filename</code>,

1267

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

1268

1269

Load an Analyze 6.0 file. If <code>filename</code> is "fred.img", this will look for

1270

an image header called "fred.hdr" and pixel data in "fred.img". You can

1271

also load "fred" or "fred.hdr".

1272

1273

1274

Images are

1275

loaded lazilly and byte-swapped, if necessary. The Analyze metadata is read

1276

and attached.

1277

1278

1279

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <code class="function">im_meta_get()</code>, <a class="link" href="libvips-conversion.html#im-grid" title="im_grid ()"><code class="function">im_grid()</code></a>.

1280

1281

1282

1283

<tbody>

1284

<tr>

1285

<td><code>filename</code> :</td>

1286

1287

</tr>

1288

<tr>

1289

1290

<td>image to write to</td>

1291

</tr>

1292

<tr>

1293

<td>Returns :</td>

1294

<td>0 on success, -1 on error.</td>

1295

</tr>

1296

</tbody>

1297

</table></div>

1298

</div>

1299

<hr>

1300

1301

1302

<pre class="programlisting">int im_csv2vips (<code>const char *filename</code>,

1303

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

1304

1305

Load a CSV (comma-separated values) file. The output image is always 1

1306

band (monochrome), <code class="literal">IM_BANDFMT_DOUBLE</code>.

1307

The reader is deliberately rather fussy: it will fail if there are any

1308

short lines, or if the file is too short. It will ignore lines that are

1309

too long.

1310

1311

1312

Read options can be embedded in the filename. The options can be given

1313

in any order and are:

1314

1315

1316

1317

1318

1319

skip:lines-to-skip The number of lines to skip at

1320

the start of the file. Default zero.

1321

</li>

1322

1323

line:lines-to-read

1324

The number of lines to read from the file. Default -1, meaning read to end of

1325

file.

1326

</li>

1327

1328

whi:whitespace-characters

1329

The skippable whitespace characters. Default space and

1330

double quotes (").

1331

Whitespace characters are always run together.

1332

</li>

1333

1334

sep:separator-characters

1335

The characters that separate fields. Default ;,tab.

1336

Separators are never run together.

1337

</li>

1338

</ul></div>

1339

1340

1341

1342

For example:

1343

1344

1345

1346

1347

im_csv2vips( "fred.csv:skip:58,sep:\,,line:3", out );

1348

</pre></div>

1349

1350

1351

1352

Will read three lines starting at line 59, with comma as the only

1353

allowed separator. Note that the ',' has to be escaped with a backslash.

1354

1355

1356

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-vips2csv" title="im_vips2csv ()"><code class="function">im_vips2csv()</code></a>, <a class="link" href="libvips-mask.html#im-read-dmask" title="im_read_dmask ()"><code class="function">im_read_dmask()</code></a>, <a class="link" href="VipsFormat.html#im-ppm2vips" title="im_ppm2vips ()"><code class="function">im_ppm2vips()</code></a>.

1357

1358

1359

1360

<tbody>

1361

<tr>

1362

<td><code>filename</code> :</td>

1363

1364

</tr>

1365

<tr>

1366

1367

<td>image to write to</td>

1368

</tr>

1369

<tr>

1370

<td>Returns :</td>

1371

<td>0 on success, -1 on error.</td>

1372

</tr>

1373

</tbody>

1374

</table></div>

1375

</div>

1376

<hr>

1377

1378

1379

<pre class="programlisting">int im_vips2csv (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

1380

<code>const char *filename</code>);</pre>

1381

1382

Save a CSV (comma-separated values) file. The image is written

1383

one line of text per scanline. Complex numbers are written as

1384

"(real,imaginary)" and will need extra parsing I guess. The image must

1385

have a single band.

1386

1387

1388

Write options can be embedded in the filename. The options can be given

1389

in any order and are:

1390

1391

1392

1393

1394

sep:separator-string

1395

The string to use to separate numbers in the output.

1396

The default is "\\t" (tab).

1397

</li></ul></div>

1398

1399

1400

1401

For example:

1402

1403

1404

1405

1406

im_csv2vips( in, "fred.csv:sep:\t" );

1407

</pre></div>

1408

1409

1410

1411

Will write to fred.csv, separating numbers with tab characters.

1412

1413

1414

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-csv2vips" title="im_csv2vips ()"><code class="function">im_csv2vips()</code></a>, <a class="link" href="libvips-mask.html#im-write-dmask" title="im_write_dmask ()"><code class="function">im_write_dmask()</code></a>, <a class="link" href="VipsFormat.html#im-vips2ppm" title="im_vips2ppm ()"><code class="function">im_vips2ppm()</code></a>.

1415

1416

1417

1418

<tbody>

1419

<tr>

1420

1421

<td>image to save</td>

1422

</tr>

1423

<tr>

1424

<td><code>filename</code> :</td>

1425

<td>file to write to</td>

1426

</tr>

1427

<tr>

1428

<td>Returns :</td>

1429

<td>0 on success, -1 on error.</td>

1430

</tr>

1431

</tbody>

1432

</table></div>

1433

</div>

1434

<hr>

1435

1436

1437

<pre class="programlisting">int im_png2vips (<code>const char *filename</code>,

1438

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

1439

1440

Read a PNG file into a VIPS image. It can read all png images, including 8-

1441

and 16-bit images, 1 and 3 channel, with and without an alpha channel.

1442

1443

1444

There is no support for embedded ICC profiles.

1445

1446

1447

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-vips2png" title="im_vips2png ()"><code class="function">im_vips2png()</code></a>.

1448

1449

1450

1451

<tbody>

1452

<tr>

1453

<td><code>filename</code> :</td>

1454

1455

</tr>

1456

<tr>

1457

1458

<td>image to write to</td>

1459

</tr>

1460

<tr>

1461

<td>Returns :</td>

1462

<td>0 on success, -1 on error.</td>

1463

</tr>

1464

</tbody>

1465

</table></div>

1466

</div>

1467

<hr>

1468

1469

1470

<pre class="programlisting">int im_vips2png (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

1471

<code>const char *filename</code>);</pre>

1472

1473

Write a VIPS image to a file as PNG.

1474

1475

1476

You can embed options in the filename. They have the form:

1477

1478

1479

1480

1481

filename.png:compression,interlace

1482

</pre></div>

1483

1484

1485

1486

1487

1488

1489

compression

1490

Compress with this much effort (0 - 9). Default 6.

1491

</li>

1492

1493

interlace

1494

0 means don't interlace (the default), 1 selects ADAM7 interlacing. Beware

1495

than an interlaced PNG can be up to 7 times slower to write than a

1496

non-interlaced image.

1497

</li>

1498

</ul></div>

1499

1500

1501

1502

There is no support for attaching ICC profiles to PNG images.

1503

1504

1505

The image is automatically converted to RGB, RGBA, Monochrome or Mono +

1506

alpha before saving. Images with more than one byte per band element are

1507

saved as 16-bit PNG, others are saved as 8-bit PNG.

1508

1509

1510

Example:

1511

1512

1513

1514

1515

im_vips2png( in, "fred.png:0,1" );

1516

</pre></div>

1517

1518

1519

1520

Will write "fred.png" with no compression and with ADAM7 interlacing.

1521

1522

1523

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-png2vips" title="im_png2vips ()"><code class="function">im_png2vips()</code></a>.

1524

1525

1526

1527

<tbody>

1528

<tr>

1529

1530

<td>image to save</td>

1531

</tr>

1532

<tr>

1533

<td><code>filename</code> :</td>

1534

<td>file to write to</td>

1535

</tr>

1536

<tr>

1537

<td>Returns :</td>

1538

<td>0 on success, -1 on error.</td>

1539

</tr>

1540

</tbody>

1541

</table></div>

1542

</div>

1543

<hr>

1544

1545

<a name="im-vips2bufpng"></a><h3>im_vips2bufpng ()</h3>

1546

<pre class="programlisting">int im_vips2bufpng (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

1547

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>,

1548

<code>int compression</code>,

1549

<code>int interlace</code>,

1550

<code>char **obuf</code>,

1551

1552

1553

As <a class="link" href="VipsFormat.html#im-vips2png" title="im_vips2png ()"><code class="function">im_vips2png()</code></a>, but save as a memory buffer. The memory is allocated

1554

local to <code>out</code> (that is, when <code>out</code> is closed the memory will be released,

1555

pass <code class="literal">NULL</code> to release yourself).

1556

1557

1558

The address of the buffer is returned in <code>obuf</code>, the length of the buffer in

1559

<code>olen</code>.

1560

1561

1562

1563

1564

1565

1566

<tbody>

1567

<tr>

1568

1569

<td>image to save</td>

1570

</tr>

1571

<tr>

1572

1573

<td>allocate output buffer local to this</td>

1574

</tr>

1575

<tr>

1576

<td><code>compression</code> :</td>

1577

<td>compress with this much effort</td>

1578

</tr>

1579

<tr>

1580

<td><code>interlace</code> :</td>

1581

<td>0 means don't interlace, 1 selects ADAM7 interlacing</td>

1582

</tr>

1583

<tr>

1584

1585

<td>return output buffer here</td>

1586

</tr>

1587

<tr>

1588

1589

<td>return output length here</td>

1590

</tr>

1591

<tr>

1592

<td>Returns :</td>

1593

<td>0 on success, -1 on error.</td>

1594

</tr>

1595

</tbody>

1596

</table></div>

1597

</div>

1598

<hr>

1599

1600

1601

<pre class="programlisting">int im_raw2vips (<code>const char *filename</code>,

1602

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>,

1603

<code>int width</code>,

1604

<code>int height</code>,

1605

<code>int bpp</code>,

1606

<code>int offset</code>);</pre>

1607

1608

This operation mmaps the file, setting <code>out</code> so that access to that

1609

image will read from the file.

1610

1611

1612

Use functions like <a class="link" href="libvips-conversion.html#im-copy-morph" title="im_copy_morph ()"><code class="function">im_copy_morph()</code></a> to set the pixel type, byte ordering

1613

and so on.

1614

1615

1616

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-vips2raw" title="im_vips2raw ()"><code class="function">im_vips2raw()</code></a>.

1617

1618

1619

1620

<tbody>

1621

<tr>

1622

<td><code>filename</code> :</td>

1623

1624

</tr>

1625

<tr>

1626

1627

<td>image to write to</td>

1628

</tr>

1629

<tr>

1630

<td><code>width</code> :</td>

1631

<td>image width in pixels</td>

1632

</tr>

1633

<tr>

1634

<td><code>height</code> :</td>

1635

<td>image height in pixels</td>

1636

</tr>

1637

<tr>

1638

1639

<td>bytes per pixel</td>

1640

</tr>

1641

<tr>

1642

<td><code>offset</code> :</td>

1643

<td>skip this many bytes at the start of the file</td>

1644

</tr>

1645

<tr>

1646

<td>Returns :</td>

1647

<td>0 on success, -1 on error.</td>

1648

</tr>

1649

</tbody>

1650

</table></div>

1651

</div>

1652

<hr>

1653

1654

1655

<pre class="programlisting">int im_vips2raw (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

1656

1657

1658

Writes the pixels in <code>in</code> to the file descriptor. It's handy for writing

1659

writers for other formats.

1660

1661

1662

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="VipsFormat.html#im-raw2vips" title="im_raw2vips ()"><code class="function">im_raw2vips()</code></a>.

1663

1664

1665

1666

<tbody>

1667

<tr>

1668

1669

<td>image to save</td>

1670

</tr>

1671

<tr>

1672

1673

<td>file descriptor to write to</td>

1674

</tr>

1675

<tr>

1676

<td>Returns :</td>

1677

<td>0 on success, -1 on error.</td>

1678

</tr>

1679

</tbody>

1680

</table></div>

1681

</div>

1682

<hr>

1683

1684

1685

<pre class="programlisting">int im_mat2vips (<code>const char *filename</code>,

1686

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

1687

1688

Read a Matlab save file into a VIPS image.

1689

1690

1691

This operation searches the save

1692

file for the first array variable with between 1 and 3 dimensions and loads

1693

it as an image. It will not handle complex images. It does not handle

1694

sparse matrices.

1695

1696

1697

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>.

1698

1699

1700

1701

<tbody>

1702

<tr>

1703

<td><code>filename</code> :</td>

1704

1705

</tr>

1706

<tr>

1707

1708

<td>image to write to</td>

1709

</tr>

1710

<tr>

1711

<td>Returns :</td>

1712

<td>0 on success, -1 on error.</td>

1713

</tr>

1714

</tbody>

1715

</table></div>

1716

</div>

1717

<hr>

1718

1719

1720

<pre class="programlisting">int im_rad2vips (<code>const char *filename</code>,

1721

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

1722

1723

Read a Radiance (HDR) file into a VIPS image.

1724

1725

1726

Radiance files are read as IM_CODING_RAD. They have one byte for each of

1727

red, green and blue, and one byte of shared exponent. Some operations (like

1728

<a class="link" href="libvips-conversion.html#im-extract-area" title="im_extract_area ()"><code class="function">im_extract_area()</code></a>) can work directly with images in this format, but

1729

mmany (all the arithmetic operations, for example) will not. unpack

1730

IM_CODING_RAD images to 3 band float with <a class="link" href="libvips-colour.html#im-rad2float" title="im_rad2float ()"><code class="function">im_rad2float()</code></a> if you want to do

1731

arithmetic on them.

1732

1733

1734

This operation ignores some header fields, like VIEW and DATE. It will not

1735

rotate/flip as the FORMAT string asks.

1736

1737

1738

Sections of this reader from Greg Ward and Radiance with kind permission.

1739

1740

1741

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="libvips-colour.html#im-rad2float" title="im_rad2float ()"><code class="function">im_rad2float()</code></a>, <a class="link" href="VipsFormat.html#im-vips2rad" title="im_vips2rad ()"><code class="function">im_vips2rad()</code></a>.

1742

1743

1744

1745

<tbody>

1746

<tr>

1747

<td><code>filename</code> :</td>

1748

1749

</tr>

1750

<tr>

1751

1752

<td>image to write to</td>

1753

</tr>

1754

<tr>

1755

<td>Returns :</td>

1756

<td>0 on success, -1 on error.</td>

1757

</tr>

1758

</tbody>

1759

</table></div>

1760

</div>

1761

<hr>

1762

1763

1764

<pre class="programlisting">int im_vips2rad (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

1765

<code>const char *filename</code>);</pre>

1766

1767

Write a VIPS image in Radiance (HDR) format.

1768

1769

1770

This operation needs an IM_CODING_RAD image, or a three-band float image.

1771

1772

1773

Sections of this reader from Greg Ward and Radiance with kind permission.

1774

1775

1776

See also: <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>, <a class="link" href="libvips-colour.html#im-float2rad" title="im_float2rad ()"><code class="function">im_float2rad()</code></a>, <a class="link" href="VipsFormat.html#im-rad2vips" title="im_rad2vips ()"><code class="function">im_rad2vips()</code></a>.

1777

1778

1779

1780

<tbody>

1781

<tr>

1782

1783

<td>image to save</td>

1784

</tr>

1785

<tr>

1786

<td><code>filename</code> :</td>

1787

<td>file to write to</td>

1788

</tr>

1789

<tr>

1790

<td>Returns :</td>

1791

<td>0 on success, -1 on error.</td>

1792

</tr>

1793

</tbody>

1794

</table></div>

1795

</div>

1796

<hr>

1797

1798

1799

<pre class="programlisting">int im_fits2vips (<code>const char *filename</code>,

1800

<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *out</code>);</pre>

1801

1802

Read a FITS image file into a VIPS image.

1803

1804

1805

See also: <a class="link" href="VipsFormat.html#im-vips2fits" title="im_vips2fits ()"><code class="function">im_vips2fits()</code></a>, <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>.

1806

1807

1808

1809

<tbody>

1810

<tr>

1811

<td><code>filename</code> :</td>

1812

1813

</tr>

1814

<tr>

1815

1816

<td>image to write to</td>

1817

</tr>

1818

<tr>

1819

<td>Returns :</td>

1820

<td>0 on success, -1 on error.</td>

1821

</tr>

1822

</tbody>

1823

</table></div>

1824

</div>

1825

<hr>

1826

1827

1828

<pre class="programlisting">int im_vips2fits (<code><a class="link" href="VipsImage.html" title="VipsImage">VipsImage</a> *in</code>,

1829

<code>const char *filename</code>);</pre>

1830

1831

Write <code>in</code> to <code>filename</code> in FITS format.

1832

1833

1834

See also: <a class="link" href="VipsFormat.html#im-fits2vips" title="im_fits2vips ()"><code class="function">im_fits2vips()</code></a>, <a class="link" href="VipsFormat.html" title="VipsFormat">VipsFormat</a>.

1835

1836

1837

1838

<tbody>

1839

<tr>

1840

1841

<td>image to write</td>

1842

</tr>

1843

<tr>

1844

<td><code>filename</code> :</td>

1845

<td>file to write to</td>

1846

</tr>

1847

<tr>

1848

<td>Returns :</td>

1849

<td>0 on success, -1 on error.</td>

1850

</tr>

1851

</tbody>

1852

</table></div>

1853

</div>

1854

</div>

1855

1856

1857

image

1858

</div>

1859

</div>

1860

1861

<hr>

1862

Generated by GTK-Doc V1.17</div>

1863

</body>

1864

</html>

b'\\ No newline at end of file'

Older »