MagickCore  7.0.3
blob.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2019 ImageMagick Studio LLC, a non-profit organization
3  dedicated to making software imaging solutions freely available.
4 
5  You may not use this file except in compliance with the License. You may
6  obtain a copy of the License at
7 
8  https://imagemagick.org/script/license.php
9 
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15 
16  MagickCore Binary Large OBjects methods.
17 */
18 #ifndef MAGICKCORE_BLOB_H
19 #define MAGICKCORE_BLOB_H
20 
21 #if defined(__cplusplus) || defined(c_plusplus)
22 extern "C" {
23 #endif
24 
25 #define MagickMaxBufferExtent 81920
26 
27 typedef enum
28 {
33 } MapMode;
34 
35 typedef ssize_t
36  (*CustomStreamHandler)(unsigned char *,const size_t,void *);
37 
38 typedef MagickOffsetType
39  (*CustomStreamSeeker)(const MagickOffsetType,const int,void *);
40 
41 typedef MagickOffsetType
42  (*CustomStreamTeller)(void *);
43 
44 typedef struct _CustomStreamInfo
46 
47 #include "MagickCore/image.h"
48 #include "MagickCore/stream.h"
49 
53 
54 extern MagickExport FILE
55  *GetBlobFileHandle(const Image *) magick_attribute((__pure__));
56 
57 extern MagickExport Image
58  *BlobToImage(const ImageInfo *,const void *,const size_t,ExceptionInfo *),
59  *PingBlob(const ImageInfo *,const void *,const size_t,ExceptionInfo *),
60  *CustomStreamToImage(const ImageInfo *,ExceptionInfo *);
61 
63  BlobToFile(char *,const void *,const size_t,ExceptionInfo *),
64  FileToImage(Image *,const char *,ExceptionInfo *),
65  GetBlobError(const Image *) magick_attribute((__pure__)),
66  ImageToFile(Image *,char *,ExceptionInfo *),
67  InjectImageBlob(const ImageInfo *,Image *,Image *,const char *,
68  ExceptionInfo *),
69  IsBlobExempt(const Image *) magick_attribute((__pure__)),
70  IsBlobSeekable(const Image *) magick_attribute((__pure__)),
71  IsBlobTemporary(const Image *) magick_attribute((__pure__));
72 
74  GetBlobSize(const Image *);
75 
77  GetBlobStreamHandler(const Image *) magick_attribute((__pure__));
78 
79 extern MagickExport void
80  *GetBlobStreamData(const Image *) magick_attribute((__pure__)),
81  DestroyBlob(Image *),
82  DuplicateBlob(Image *,const Image *),
83  *FileToBlob(const char *,const size_t,size_t *,ExceptionInfo *),
84  *ImageToBlob(const ImageInfo *,Image *,size_t *,ExceptionInfo *),
85  ImageToCustomStream(const ImageInfo *,Image *,ExceptionInfo *),
86  *ImagesToBlob(const ImageInfo *,Image *,size_t *,ExceptionInfo *),
87  ImagesToCustomStream(const ImageInfo *,Image *,ExceptionInfo *),
88  SetBlobExempt(Image *,const MagickBooleanType),
90  SetCustomStreamReader(CustomStreamInfo *,CustomStreamHandler),
91  SetCustomStreamSeeker(CustomStreamInfo *,CustomStreamSeeker),
92  SetCustomStreamTeller(CustomStreamInfo *,CustomStreamTeller),
93  SetCustomStreamWriter(CustomStreamInfo *,CustomStreamHandler);
94 
95 #if defined(__cplusplus) || defined(c_plusplus)
96 }
97 #endif
98 
99 #endif
MagickExport void ImageToCustomStream(const ImageInfo *image_info, Image *image, ExceptionInfo *exception)
Definition: blob.c:2098
Definition: blob.h:29
MagickExport void SetCustomStreamWriter(CustomStreamInfo *custom_stream, CustomStreamHandler writer)
Definition: blob.c:5298
MagickExport MagickBooleanType GetBlobError(const Image *image)
Definition: blob.c:1672
size_t(* StreamHandler)(const Image *, const void *, const size_t)
Definition: stream.h:31
MagickExport void * ImageToBlob(const ImageInfo *image_info, Image *image, size_t *length, ExceptionInfo *exception)
Definition: blob.c:1966
Definition: blob.h:31
MagickExport Image * PingBlob(const ImageInfo *image_info, const void *blob, const size_t length, ExceptionInfo *exception)
Definition: blob.c:3541
MagickExport MagickBooleanType ImageToFile(Image *image, char *filename, ExceptionInfo *exception)
Definition: blob.c:2246
MagickExport MagickBooleanType FileToImage(Image *image, const char *filename, ExceptionInfo *exception)
Definition: blob.c:1572
MagickExport Image * CustomStreamToImage(const ImageInfo *image_info, ExceptionInfo *exception)
Definition: blob.c:735
ssize_t MagickOffsetType
Definition: magick-type.h:129
Definition: image.h:151
#define magick_attribute(x)
MagickOffsetType(* CustomStreamSeeker)(const MagickOffsetType, const int, void *)
Definition: blob.h:39
MagickExport void SetCustomStreamReader(CustomStreamInfo *custom_stream, CustomStreamHandler reader)
Definition: blob.c:5199
MagickExport Image * BlobToImage(const ImageInfo *image_info, const void *blob, const size_t length, ExceptionInfo *exception)
Definition: blob.c:421
MagickBooleanType
Definition: magick-type.h:158
MagickExport FILE * GetBlobFileHandle(const Image *image)
Definition: blob.c:1703
MagickExport void * FileToBlob(const char *filename, const size_t extent, size_t *length, ExceptionInfo *exception)
Definition: blob.c:1350
MagickOffsetType(* CustomStreamTeller)(void *)
Definition: blob.h:42
MagickExport MagickBooleanType InjectImageBlob(const ImageInfo *image_info, Image *image, Image *inject_image, const char *format, ExceptionInfo *exception)
Definition: blob.c:2661
size_t MagickSizeType
Definition: magick-type.h:130
MagickExport MagickBooleanType IsBlobTemporary(const Image *image)
Definition: blob.c:2916
MagickExport void SetBlobExempt(Image *image, const MagickBooleanType exempt)
Definition: blob.c:4980
MagickExport void * ImagesToBlob(const ImageInfo *image_info, Image *images, size_t *length, ExceptionInfo *exception)
Definition: blob.c:2368
MagickExport CustomStreamInfo * DestroyCustomStreamInfo(CustomStreamInfo *custom_stream)
Definition: blob.c:953
MagickExport MagickBooleanType IsBlobSeekable(const Image *image)
Definition: blob.c:2837
ssize_t(* CustomStreamHandler)(unsigned char *, const size_t, void *)
Definition: blob.h:36
MagickExport MagickSizeType GetBlobSize(const Image *image)
Definition: blob.c:1800
Definition: blob.h:30
MagickExport void SetCustomStreamData(CustomStreamInfo *custom_stream, void *data)
Definition: blob.c:5166
MagickExport MagickBooleanType IsBlobExempt(const Image *image)
Definition: blob.c:2806
MapMode
Definition: blob.h:27
MagickExport CustomStreamInfo * AcquireCustomStreamInfo(ExceptionInfo *magick_unused(exception))
Definition: blob.c:222
MagickExport void SetCustomStreamTeller(CustomStreamInfo *custom_stream, CustomStreamTeller teller)
Definition: blob.c:5265
MagickExport void SetCustomStreamSeeker(CustomStreamInfo *custom_stream, CustomStreamSeeker seeker)
Definition: blob.c:5232
#define MagickExport
MagickExport StreamHandler GetBlobStreamHandler(const Image *image)
Definition: blob.c:1924
MagickExport void DestroyBlob(Image *image)
Definition: blob.c:891
MagickExport void ImagesToCustomStream(const ImageInfo *image_info, Image *images, ExceptionInfo *exception)
Definition: blob.c:2506
MagickExport void DuplicateBlob(Image *image, const Image *duplicate)
Definition: blob.c:1150
MagickExport void * GetBlobStreamData(const Image *image)
Definition: blob.c:1895
MagickExport MagickBooleanType BlobToFile(char *filename, const void *blob, const size_t length, ExceptionInfo *exception)
Definition: blob.c:346