summaryrefslogtreecommitdiff
path: root/common/quicktime_win32/CGDataProvider.h
blob: 0f0fa650cf323a373ac52dade37b1382316a7950 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/*
     File:       CGDataProvider.h
 
     Contains:   CoreGraphics data provider
 
     Version:    QuickTime 7.3
 
     Copyright:  (c) 2007 (c) 2000-2001 by Apple Computer, Inc., all rights reserved.
 
     Bugs?:      For bug reports, consult the following page on
                 the World Wide Web:
 
                     http://developer.apple.com/bugreporter/
 
*/
#ifndef CGDATAPROVIDER_H_
#define CGDATAPROVIDER_H_

#ifndef __CGBASE__
#include <CGBase.h>
#endif

#ifndef __CFURL__
#include <CFURL.h>
#endif




#if PRAGMA_ONCE
#pragma once
#endif

#ifdef __cplusplus
extern "C" {
#endif

#if PRAGMA_IMPORT
#pragma import on
#endif

#if PRAGMA_STRUCT_ALIGN
    #pragma options align=mac68k
#elif PRAGMA_STRUCT_PACKPUSH
    #pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
    #pragma pack(2)
#endif

typedef struct CGDataProvider*          CGDataProviderRef;
typedef CALLBACK_API_C( size_t , CGGetBytesProcPtr )(void *info, void *buffer, size_t count);
typedef CALLBACK_API_C( void , CGSkipBytesProcPtr )(void *info, size_t count);
typedef CALLBACK_API_C( void , CGRewindProcPtr )(void * info);
typedef CALLBACK_API_C( void , CGReleaseProviderProcPtr )(void * info);
/* Callbacks for sequentially accessing data.
 * `getBytes' is called to copy `count' bytes from the provider's data to
 * `buffer'.  It should return the number of bytes copied, or 0 if there's
 * no more data.
 * `skipBytes' is called to skip ahead in the provider's data by `count' bytes.
 * `rewind' is called to rewind the provider to the beginning of the data.
 * `releaseProvider', if non-NULL, is called when the provider is freed. */
struct CGDataProviderCallbacks {
  CGGetBytesProcPtr   getBytes;
  CGSkipBytesProcPtr  skipBytes;
  CGRewindProcPtr     rewind;
  CGReleaseProviderProcPtr  releaseProvider;
};
typedef struct CGDataProviderCallbacks  CGDataProviderCallbacks;
typedef CALLBACK_API_C( void *, CGGetBytePointerProcPtr )(void * info);
typedef CALLBACK_API_C( void , CGReleaseByteProcPtr )(void *info, const void *pointer);
typedef CALLBACK_API_C( size_t , CGGetBytesDirectProcPtr )(void *info, void *buffer, size_t offset, size_t count);
/* Callbacks for directly accessing data.
 * `getBytePointer', if non-NULL, is called to return a pointer to the
 * provider's entire block of data.
 * `releaseBytePointer', if non-NULL, is called to release a pointer to
 * the provider's entire block of data.
 * `getBytes', if non-NULL, is called to copy `count' bytes at offset
 * `offset' from the provider's data to `buffer'.  It should return the
 * number of bytes copied, or 0 if there's no more data.
 * `releaseProvider', if non-NULL, is called when the provider is freed.
 * At least one of `getBytePointer' or `getBytes' must be non-NULL.  */
struct CGDataProviderDirectAccessCallbacks {
  CGGetBytePointerProcPtr  getBytePointer;
  CGReleaseByteProcPtr  releaseBytePointer;
  CGGetBytesDirectProcPtr  getBytes;
  CGReleaseProviderProcPtr  releaseProvider;
};
typedef struct CGDataProviderDirectAccessCallbacks CGDataProviderDirectAccessCallbacks;
typedef CALLBACK_API_C( void , CGReleaseDataProcPtr )(void *info, const void *data, size_t size);
/* Create a sequential-access data provider using `callbacks' to provide
 * the data.  `info' is passed to each of the callback functions. */
/*
 *  CGDataProviderCreate()
 *  
 *  Availability:
 *    Non-Carbon CFM:   not available
 *    CarbonLib:        not available
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API_C( CGDataProviderRef )
CGDataProviderCreate(
  void *                           info,
  const CGDataProviderCallbacks *  callbacks);


/* Create a direct-access data provider using `callbacks' to supply `size'
 * bytes of data. `info' is passed to each of the callback functions. */
/*
 *  CGDataProviderCreateDirectAccess()
 *  
 *  Availability:
 *    Non-Carbon CFM:   not available
 *    CarbonLib:        not available
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API_C( CGDataProviderRef )
CGDataProviderCreateDirectAccess(
  void *                                       info,
  size_t                                       size,
  const CGDataProviderDirectAccessCallbacks *  callbacks);


/* Create a direct-access data provider using `data', an array of `size'
 * bytes.  `releaseData' is called when the data provider is freed, and is
 * passed `info' as its first argument. */
/*
 *  CGDataProviderCreateWithData()
 *  
 *  Availability:
 *    Non-Carbon CFM:   not available
 *    CarbonLib:        not available
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API_C( CGDataProviderRef )
CGDataProviderCreateWithData(
  void *                 info,
  const void *           data,
  size_t                 size,
  CGReleaseDataProcPtr   releaseData);


/* Create a data provider using `url'. */
/*
 *  CGDataProviderCreateWithURL()
 *  
 *  Availability:
 *    Non-Carbon CFM:   not available
 *    CarbonLib:        not available
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API_C( CGDataProviderRef )
CGDataProviderCreateWithURL(CFURLRef url);


/* Increment the retain count of `provider' and return it.  All data
 * providers are created with an initial retain count of 1. */
/*
 *  CGDataProviderRetain()
 *  
 *  Availability:
 *    Non-Carbon CFM:   not available
 *    CarbonLib:        not available
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API_C( CGDataProviderRef )
CGDataProviderRetain(CGDataProviderRef provider);


/* Decrement the retain count of `provider'.  If the retain count reaches
 * 0, then free `provider' and any associated resources. */
/*
 *  CGDataProviderRelease()
 *  
 *  Availability:
 *    Non-Carbon CFM:   not available
 *    CarbonLib:        not available
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API_C( void )
CGDataProviderRelease(CGDataProviderRef provider);



#if PRAGMA_STRUCT_ALIGN
    #pragma options align=reset
#elif PRAGMA_STRUCT_PACKPUSH
    #pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
    #pragma pack()
#endif

#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif

#ifdef __cplusplus
}
#endif

#endif /* CGDATAPROVIDER_H_ */