data.c revision 5793033ccaeb30cc4936497f64dfa2cfe2cc405f 
1/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
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
17/** Data locator, data format, data source, and data sink support */
18
19#include "sles_allinclusive.h"
20
21
22/** \brief Check a data locator and make local deep copy */
23
24static SLresult checkDataLocator(const char *name, void *pLocator, DataLocator *pDataLocator,
25        SLuint32 allowedDataLocatorMask)
26{
27    assert(NULL != name && NULL != pDataLocator);
28    SLresult result = SL_RESULT_SUCCESS;
29
30    SLuint32 locatorType;
31    if (NULL == pLocator) {
32        pDataLocator->mLocatorType = locatorType = SL_DATALOCATOR_NULL;
33    } else {
34        locatorType = *(SLuint32 *)pLocator;
35        switch (locatorType) {
36
37        case SL_DATALOCATOR_ADDRESS:
38            pDataLocator->mAddress = *(SLDataLocator_Address *)pLocator;
39            // if length is greater than zero, then the address must be non-NULL
40            if ((0 < pDataLocator->mAddress.length) && (NULL == pDataLocator->mAddress.pAddress)) {
41                SL_LOGE("%s: pAddress=NULL", name);
42                result = SL_RESULT_PARAMETER_INVALID;
43            }
44            break;
45
46        case SL_DATALOCATOR_BUFFERQUEUE:
47#ifdef ANDROID
48        // This is an alias that is _not_ converted; the rest of the code must check for both
49        // locator types. That's because it is only an alias for audio players, not audio recorder
50        // objects so we have to remember the distinction.
51        case SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE:
52#endif
53            pDataLocator->mBufferQueue = *(SLDataLocator_BufferQueue *)pLocator;
54            // number of buffers must be specified, there is no default value, and can't be too big
55            if (!((1 <= pDataLocator->mBufferQueue.numBuffers) &&
56                (pDataLocator->mBufferQueue.numBuffers <= 255))) {
57                SL_LOGE("%s: numBuffers=%u", name, pDataLocator->mBufferQueue.numBuffers);
58                result = SL_RESULT_PARAMETER_INVALID;
59            }
60            break;
61
62        case SL_DATALOCATOR_IODEVICE:
63            {
64            pDataLocator->mIODevice = *(SLDataLocator_IODevice *)pLocator;
65            SLuint32 deviceType = pDataLocator->mIODevice.deviceType;
66            SLObjectItf device = pDataLocator->mIODevice.device;
67            if (NULL != device) {
68                pDataLocator->mIODevice.deviceID = 0;
69                SLuint32 expectedObjectID;
70                switch (deviceType) {
71                case SL_IODEVICE_LEDARRAY:
72                    expectedObjectID = SL_OBJECTID_LEDDEVICE;
73                    break;
74                case SL_IODEVICE_VIBRA:
75                    expectedObjectID = SL_OBJECTID_VIBRADEVICE;
76                    break;
77                case XA_IODEVICE_CAMERA:
78                    expectedObjectID = XA_OBJECTID_CAMERADEVICE;
79                    break;
80                case XA_IODEVICE_RADIO:
81                    expectedObjectID = XA_OBJECTID_RADIODEVICE;
82                    break;
83                // audio input and audio output cannot be specified via objects
84                case SL_IODEVICE_AUDIOINPUT:
85                // case SL_IODEVICE_AUDIOOUTPUT:   // does not exist in 1.0.1, added in 1.1
86                default:
87                    SL_LOGE("%s: deviceType=%u", name, deviceType);
88                    pDataLocator->mIODevice.device = NULL;
89                    expectedObjectID = 0;
90                    result = SL_RESULT_PARAMETER_INVALID;
91                }
92                if (result == SL_RESULT_SUCCESS) {
93                    // check that device has the correct object ID and is realized,
94                    // and acquire a strong reference to it
95                    result = AcquireStrongRef((IObject *) device, expectedObjectID);
96                    if (SL_RESULT_SUCCESS != result) {
97                        SL_LOGE("%s: locatorType=IODEVICE, but device field %p has wrong " \
98                            "object ID or is not realized", name, device);
99                        pDataLocator->mIODevice.device = NULL;
100                    }
101                }
102            } else {
103                SLuint32 deviceID = pDataLocator->mIODevice.deviceID;
104                switch (deviceType) {
105                case SL_IODEVICE_LEDARRAY:
106                    if (SL_DEFAULTDEVICEID_LED != deviceID) {
107                        SL_LOGE("%s: invalid LED deviceID=%u", name, deviceID);
108                        result = SL_RESULT_PARAMETER_INVALID;
109                    }
110                    break;
111                case SL_IODEVICE_VIBRA:
112                    if (SL_DEFAULTDEVICEID_VIBRA != deviceID) {
113                        SL_LOGE("%s: invalid vibra deviceID=%u", name, deviceID);
114                        result = SL_RESULT_PARAMETER_INVALID;
115                    }
116                    break;
117                case SL_IODEVICE_AUDIOINPUT:
118                    if (SL_DEFAULTDEVICEID_AUDIOINPUT != deviceID) {
119                        SL_LOGE("%s: invalid audio input deviceID=%u", name, deviceID);
120                        result = SL_RESULT_PARAMETER_INVALID;
121                    }
122                    break;
123                case XA_IODEVICE_RADIO:
124                    // no default device ID for radio; see Khronos bug XXXX
125                    break;
126                case XA_IODEVICE_CAMERA:
127                    if (XA_DEFAULTDEVICEID_CAMERA != deviceID) {
128                        SL_LOGE("%s: invalid audio input deviceID=%u", name, deviceID);
129                        result = XA_RESULT_PARAMETER_INVALID;
130                    }
131                    break;
132                // case SL_IODEVICE_AUDIOOUTPUT:
133                    // does not exist in 1.0.1, added in 1.1
134                    // break;
135                default:
136                    SL_LOGE("%s: deviceType=%u is invalid", name, deviceType);
137                    result = SL_RESULT_PARAMETER_INVALID;
138                }
139            }
140            }
141            break;
142
143        case SL_DATALOCATOR_MIDIBUFFERQUEUE:
144            pDataLocator->mMIDIBufferQueue = *(SLDataLocator_MIDIBufferQueue *)pLocator;
145            if (0 == pDataLocator->mMIDIBufferQueue.tpqn) {
146                pDataLocator->mMIDIBufferQueue.tpqn = 192;
147            }
148            // number of buffers must be specified, there is no default value, and can't be too big
149            if (!((1 <= pDataLocator->mMIDIBufferQueue.numBuffers) &&
150                (pDataLocator->mMIDIBufferQueue.numBuffers <= 255))) {
151                SL_LOGE("%s: SLDataLocator_MIDIBufferQueue.numBuffers=%d", name,
152                        pDataLocator->mMIDIBufferQueue.numBuffers);
153                result = SL_RESULT_PARAMETER_INVALID;
154            }
155            break;
156
157        case SL_DATALOCATOR_OUTPUTMIX:
158            pDataLocator->mOutputMix = *(SLDataLocator_OutputMix *)pLocator;
159            // check that output mix object has the correct object ID and is realized,
160            // and acquire a strong reference to it
161            result = AcquireStrongRef((IObject *) pDataLocator->mOutputMix.outputMix,
162                SL_OBJECTID_OUTPUTMIX);
163            if (SL_RESULT_SUCCESS != result) {
164                SL_LOGE("%s: locatorType=SL_DATALOCATOR_OUTPUTMIX, but outputMix field %p does " \
165                    "not refer to an SL_OBJECTID_OUTPUTMIX or the output mix is not realized", \
166                    name, pDataLocator->mOutputMix.outputMix);
167                pDataLocator->mOutputMix.outputMix = NULL;
168            }
169            break;
170
171        case XA_DATALOCATOR_NATIVEDISPLAY:
172            pDataLocator->mNativeDisplay = *(XADataLocator_NativeDisplay *)pLocator;
173            // hWindow is NDK C ANativeWindow * and hDisplay must be NULL
174            if (pDataLocator->mNativeDisplay.hWindow == NULL) {
175                SL_LOGE("%s: hWindow must be non-NULL ANativeWindow *", name);
176                result = SL_RESULT_PARAMETER_INVALID;
177            }
178            if (pDataLocator->mNativeDisplay.hDisplay != NULL) {
179                SL_LOGE("%s: hDisplay must be NULL, but is %p", name,
180                        pDataLocator->mNativeDisplay.hDisplay);
181                result = SL_RESULT_PARAMETER_INVALID;
182            }
183            break;
184
185        case SL_DATALOCATOR_URI:
186            {
187            pDataLocator->mURI = *(SLDataLocator_URI *)pLocator;
188            if (NULL == pDataLocator->mURI.URI) {
189                SL_LOGE("%s: invalid URI=NULL", name);
190                result = SL_RESULT_PARAMETER_INVALID;
191            } else {
192                // NTH verify URI address for validity
193                size_t len = strlen((const char *) pDataLocator->mURI.URI);
194                SLchar *myURI = (SLchar *) malloc(len + 1);
195                if (NULL == myURI) {
196                    result = SL_RESULT_MEMORY_FAILURE;
197                } else {
198                    memcpy(myURI, pDataLocator->mURI.URI, len + 1);
199                    // Verify that another thread didn't change the NUL-terminator after we used it
200                    // to determine length of string to copy. It's OK if the string became shorter.
201                    if ('\0' != myURI[len]) {
202                        free(myURI);
203                        myURI = NULL;
204                        result = SL_RESULT_PARAMETER_INVALID;
205                    }
206                }
207                pDataLocator->mURI.URI = myURI;
208            }
209            }
210            break;
211
212#ifdef ANDROID
213        case SL_DATALOCATOR_ANDROIDFD:
214        {
215            pDataLocator->mFD = *(SLDataLocator_AndroidFD *)pLocator;
216            SL_LOGV("%s: fd=%d offset=%lld length=%lld", name, pDataLocator->mFD.fd,
217                    pDataLocator->mFD.offset, pDataLocator->mFD.length);
218            // NTH check against process fd limit
219            if (0 > pDataLocator->mFD.fd) {
220                SL_LOGE("%s: fd=%d\n", name, pDataLocator->mFD.fd);
221                result = SL_RESULT_PARAMETER_INVALID;
222            }
223            break;
224        }
225        case SL_DATALOCATOR_ANDROIDBUFFERQUEUE:
226        {
227            pDataLocator->mABQ = *(SLDataLocator_AndroidBufferQueue*)pLocator;
228            // number of buffers must be specified, there is no default value, and can't be too big
229            if (!((1 <= pDataLocator->mBufferQueue.numBuffers) &&
230                    (pDataLocator->mBufferQueue.numBuffers <= 255))) {
231                SL_LOGE("%s: numBuffers=%u", name, pDataLocator->mABQ.numBuffers);
232                result = SL_RESULT_PARAMETER_INVALID;
233            }
234            break;
235        }
236#endif
237
238        case SL_DATALOCATOR_NULL:   // a NULL pointer is allowed, but not a pointer to NULL
239        default:
240            SL_LOGE("%s: locatorType=%u", name, locatorType);
241            result = SL_RESULT_PARAMETER_INVALID;
242        }
243
244        // Verify that another thread didn't change the locatorType field after we used it
245        // to determine sizeof struct to copy.
246        if ((SL_RESULT_SUCCESS == result) && (locatorType != pDataLocator->mLocatorType)) {
247            SL_LOGE("%s: locatorType changed from %u to %u", name, locatorType,
248                    pDataLocator->mLocatorType);
249            result = SL_RESULT_PRECONDITIONS_VIOLATED;
250        }
251
252    }
253
254    // Verify that the data locator type is allowed in this context
255    if (SL_RESULT_SUCCESS == result) {
256        SLuint32 actualMask;
257        switch (locatorType) {
258        case SL_DATALOCATOR_NULL:
259        case SL_DATALOCATOR_URI:
260        case SL_DATALOCATOR_ADDRESS:
261        case SL_DATALOCATOR_IODEVICE:
262        case SL_DATALOCATOR_OUTPUTMIX:
263        case XA_DATALOCATOR_NATIVEDISPLAY:
264        case SL_DATALOCATOR_BUFFERQUEUE:
265        case SL_DATALOCATOR_MIDIBUFFERQUEUE:
266            actualMask = 1L << locatorType;
267            break;
268#ifdef ANDROID
269        case SL_DATALOCATOR_ANDROIDFD:
270        case SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE:
271        case SL_DATALOCATOR_ANDROIDBUFFERQUEUE:
272            actualMask = 0x100L << (locatorType - SL_DATALOCATOR_ANDROIDFD);
273            break;
274#endif
275        default:
276            assert(false);
277            actualMask = 0L;
278            break;
279        }
280        if (!(allowedDataLocatorMask & actualMask)) {
281            SL_LOGE("%s: data locator type 0x%x not allowed", name, locatorType);
282            result = SL_RESULT_CONTENT_UNSUPPORTED;
283        }
284    }
285
286    return result;
287}
288
289
290/** \brief Free the local deep copy of a data locator */
291
292static void freeDataLocator(DataLocator *pDataLocator)
293{
294    switch (pDataLocator->mLocatorType) {
295    case SL_DATALOCATOR_NULL:
296    case SL_DATALOCATOR_ADDRESS:
297    case SL_DATALOCATOR_BUFFERQUEUE:
298    case SL_DATALOCATOR_MIDIBUFFERQUEUE:
299    case XA_DATALOCATOR_NATIVEDISPLAY:
300        break;
301    case SL_DATALOCATOR_URI:
302        if (NULL != pDataLocator->mURI.URI) {
303            free(pDataLocator->mURI.URI);
304            pDataLocator->mURI.URI = NULL;
305        }
306        pDataLocator->mURI.URI = NULL;
307        break;
308    case SL_DATALOCATOR_IODEVICE:
309        if (NULL != pDataLocator->mIODevice.device) {
310            ReleaseStrongRef((IObject *) pDataLocator->mIODevice.device);
311            pDataLocator->mIODevice.device = NULL;
312        }
313        break;
314    case SL_DATALOCATOR_OUTPUTMIX:
315        if (NULL != pDataLocator->mOutputMix.outputMix) {
316            ReleaseStrongRef((IObject *) pDataLocator->mOutputMix.outputMix);
317            pDataLocator->mOutputMix.outputMix = NULL;
318        }
319        break;
320#ifdef ANDROID
321    case SL_DATALOCATOR_ANDROIDBUFFERQUEUE:
322    case SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE:
323    case SL_DATALOCATOR_ANDROIDFD:
324        break;
325#endif
326    default:
327        // an invalid data locator is caught earlier when making the copy
328        assert(false);
329        break;
330    }
331}
332
333
334/** \brief Check a data format and make local deep copy */
335
336static SLresult checkDataFormat(const char *name, void *pFormat, DataFormat *pDataFormat,
337        SLuint32 allowedDataFormatMask)
338{
339    assert(NULL != name && NULL != pDataFormat);
340    SLresult result = SL_RESULT_SUCCESS;
341
342    SLuint32 formatType;
343    if (NULL == pFormat) {
344        pDataFormat->mFormatType = formatType = SL_DATAFORMAT_NULL;
345    } else {
346        formatType = *(SLuint32 *)pFormat;
347        switch (formatType) {
348
349        case SL_DATAFORMAT_PCM:
350            pDataFormat->mPCM = *(SLDataFormat_PCM *)pFormat;
351            do {
352
353                // check the channel count
354                switch (pDataFormat->mPCM.numChannels) {
355                case 1:     // mono
356                case 2:     // stereo
357                    break;
358                case 0:     // unknown
359                    result = SL_RESULT_PARAMETER_INVALID;
360                    break;
361                default:    // multi-channel
362                    result = SL_RESULT_CONTENT_UNSUPPORTED;
363                    break;
364                }
365                if (SL_RESULT_SUCCESS != result) {
366                    SL_LOGE("%s: numChannels=%u", name, (unsigned) pDataFormat->mPCM.numChannels);
367                    break;
368                }
369
370                // check the sampling rate
371                switch (pDataFormat->mPCM.samplesPerSec) {
372                case SL_SAMPLINGRATE_8:
373                case SL_SAMPLINGRATE_11_025:
374                case SL_SAMPLINGRATE_12:
375                case SL_SAMPLINGRATE_16:
376                case SL_SAMPLINGRATE_22_05:
377                case SL_SAMPLINGRATE_24:
378                case SL_SAMPLINGRATE_32:
379                case SL_SAMPLINGRATE_44_1:
380                case SL_SAMPLINGRATE_48:
381                case SL_SAMPLINGRATE_64:
382                case SL_SAMPLINGRATE_88_2:
383                case SL_SAMPLINGRATE_96:
384                case SL_SAMPLINGRATE_192:
385                    break;
386                case 0:
387                    result = SL_RESULT_PARAMETER_INVALID;
388                    break;
389                default:
390                    result = SL_RESULT_CONTENT_UNSUPPORTED;
391                    break;
392                }
393                if (SL_RESULT_SUCCESS != result) {
394                    SL_LOGE("%s: samplesPerSec=%u", name, pDataFormat->mPCM.samplesPerSec);
395                    break;
396                }
397
398                // check the sample bit depth
399                switch (pDataFormat->mPCM.bitsPerSample) {
400                case SL_PCMSAMPLEFORMAT_FIXED_8:
401                case SL_PCMSAMPLEFORMAT_FIXED_16:
402                    break;
403                case SL_PCMSAMPLEFORMAT_FIXED_20:
404                case SL_PCMSAMPLEFORMAT_FIXED_24:
405                case SL_PCMSAMPLEFORMAT_FIXED_28:
406                case SL_PCMSAMPLEFORMAT_FIXED_32:
407                    result = SL_RESULT_CONTENT_UNSUPPORTED;
408                    break;
409                default:
410                    result = SL_RESULT_PARAMETER_INVALID;
411                    break;
412                }
413                if (SL_RESULT_SUCCESS != result) {
414                    SL_LOGE("%s: bitsPerSample=%u", name, pDataFormat->mPCM.bitsPerSample);
415                    break;
416                }
417
418                // check the container bit depth
419                if (pDataFormat->mPCM.containerSize < pDataFormat->mPCM.bitsPerSample) {
420                    result = SL_RESULT_PARAMETER_INVALID;
421                } else if (pDataFormat->mPCM.containerSize != pDataFormat->mPCM.bitsPerSample) {
422                    result = SL_RESULT_CONTENT_UNSUPPORTED;
423                }
424                if (SL_RESULT_SUCCESS != result) {
425                    SL_LOGE("%s: containerSize=%u, bitsPerSample=%u", name,
426                            (unsigned) pDataFormat->mPCM.containerSize,
427                            (unsigned) pDataFormat->mPCM.bitsPerSample);
428                    break;
429                }
430
431                // check the channel mask
432                switch (pDataFormat->mPCM.channelMask) {
433                case SL_SPEAKER_FRONT_LEFT | SL_SPEAKER_FRONT_RIGHT:
434                    if (2 != pDataFormat->mPCM.numChannels) {
435                        result = SL_RESULT_PARAMETER_INVALID;
436                    }
437                    break;
438                case SL_SPEAKER_FRONT_LEFT:
439                case SL_SPEAKER_FRONT_RIGHT:
440                case SL_SPEAKER_FRONT_CENTER:
441                    if (1 != pDataFormat->mPCM.numChannels) {
442                        result = SL_RESULT_PARAMETER_INVALID;
443                    }
444                    break;
445                case 0:
446                    pDataFormat->mPCM.channelMask = pDataFormat->mPCM.numChannels == 2 ?
447                        SL_SPEAKER_FRONT_LEFT | SL_SPEAKER_FRONT_RIGHT : SL_SPEAKER_FRONT_CENTER;
448                    break;
449                default:
450                    result = SL_RESULT_PARAMETER_INVALID;
451                    break;
452                }
453                if (SL_RESULT_SUCCESS != result) {
454                    SL_LOGE("%s: channelMask=0x%x numChannels=%u", name,
455                        pDataFormat->mPCM.channelMask, pDataFormat->mPCM.numChannels);
456                    break;
457                }
458
459                // check the endianness / byte order
460                switch (pDataFormat->mPCM.endianness) {
461                case SL_BYTEORDER_LITTLEENDIAN:
462                case SL_BYTEORDER_BIGENDIAN:
463                    break;
464                // native is proposed but not yet in spec
465                default:
466                    result = SL_RESULT_PARAMETER_INVALID;
467                    break;
468                }
469                if (SL_RESULT_SUCCESS != result) {
470                    SL_LOGE("%s: endianness=%u", name, (unsigned) pDataFormat->mPCM.endianness);
471                    break;
472                }
473
474                // here if all checks passed successfully
475
476            } while(0);
477            break;
478
479        case SL_DATAFORMAT_MIME:
480            pDataFormat->mMIME = *(SLDataFormat_MIME *)pFormat;
481            if (NULL != pDataFormat->mMIME.mimeType) {
482                // NTH check address for validity
483                size_t len = strlen((const char *) pDataFormat->mMIME.mimeType);
484                SLchar *myMIME = (SLchar *) malloc(len + 1);
485                if (NULL == myMIME) {
486                    result = SL_RESULT_MEMORY_FAILURE;
487                } else {
488                    memcpy(myMIME, pDataFormat->mMIME.mimeType, len + 1);
489                    // make sure MIME string was not modified asynchronously
490                    if ('\0' != myMIME[len]) {
491                        free(myMIME);
492                        myMIME = NULL;
493                        result = SL_RESULT_PRECONDITIONS_VIOLATED;
494                    }
495                }
496                pDataFormat->mMIME.mimeType = myMIME;
497            }
498            break;
499
500        case XA_DATAFORMAT_RAWIMAGE:
501            pDataFormat->mRawImage = *(XADataFormat_RawImage *)pFormat;
502            switch (pDataFormat->mRawImage.colorFormat) {
503            case XA_COLORFORMAT_MONOCHROME:
504            case XA_COLORFORMAT_8BITRGB332:
505            case XA_COLORFORMAT_12BITRGB444:
506            case XA_COLORFORMAT_16BITARGB4444:
507            case XA_COLORFORMAT_16BITARGB1555:
508            case XA_COLORFORMAT_16BITRGB565:
509            case XA_COLORFORMAT_16BITBGR565:
510            case XA_COLORFORMAT_18BITRGB666:
511            case XA_COLORFORMAT_18BITARGB1665:
512            case XA_COLORFORMAT_19BITARGB1666:
513            case XA_COLORFORMAT_24BITRGB888:
514            case XA_COLORFORMAT_24BITBGR888:
515            case XA_COLORFORMAT_24BITARGB1887:
516            case XA_COLORFORMAT_25BITARGB1888:
517            case XA_COLORFORMAT_32BITBGRA8888:
518            case XA_COLORFORMAT_32BITARGB8888:
519            case XA_COLORFORMAT_YUV411PLANAR:
520            case XA_COLORFORMAT_YUV420PLANAR:
521            case XA_COLORFORMAT_YUV420SEMIPLANAR:
522            case XA_COLORFORMAT_YUV422PLANAR:
523            case XA_COLORFORMAT_YUV422SEMIPLANAR:
524            case XA_COLORFORMAT_YCBYCR:
525            case XA_COLORFORMAT_YCRYCB:
526            case XA_COLORFORMAT_CBYCRY:
527            case XA_COLORFORMAT_CRYCBY:
528            case XA_COLORFORMAT_YUV444INTERLEAVED:
529            case XA_COLORFORMAT_RAWBAYER8BIT:
530            case XA_COLORFORMAT_RAWBAYER10BIT:
531            case XA_COLORFORMAT_RAWBAYER8BITCOMPRESSED:
532            case XA_COLORFORMAT_L2:
533            case XA_COLORFORMAT_L4:
534            case XA_COLORFORMAT_L8:
535            case XA_COLORFORMAT_L16:
536            case XA_COLORFORMAT_L24:
537            case XA_COLORFORMAT_L32:
538            case XA_COLORFORMAT_18BITBGR666:
539            case XA_COLORFORMAT_24BITARGB6666:
540            case XA_COLORFORMAT_24BITABGR6666:
541                break;
542            case XA_COLORFORMAT_UNUSED:
543            default:
544                result = XA_RESULT_PARAMETER_INVALID;
545                SL_LOGE("%s: unsupported color format %d", name,
546                    pDataFormat->mRawImage.colorFormat);
547                break;
548            }
549            // no checks for height, width, or stride
550            break;
551
552        default:
553            result = SL_RESULT_PARAMETER_INVALID;
554            SL_LOGE("%s: formatType=%u", name, (unsigned) formatType);
555            break;
556
557        }
558
559        // make sure format type was not modified asynchronously
560        if ((SL_RESULT_SUCCESS == result) && (formatType != pDataFormat->mFormatType)) {
561            SL_LOGE("%s: formatType changed from %u to %u", name, formatType,
562                    pDataFormat->mFormatType);
563            result = SL_RESULT_PRECONDITIONS_VIOLATED;
564        }
565
566    }
567
568    // Verify that the data format type is allowed in this context
569    if (SL_RESULT_SUCCESS == result) {
570        SLuint32 actualMask;
571        switch (formatType) {
572        case SL_DATAFORMAT_NULL:
573        case SL_DATAFORMAT_MIME:
574        case SL_DATAFORMAT_PCM:
575        case XA_DATAFORMAT_RAWIMAGE:
576            actualMask = 1L << formatType;
577            break;
578        default:
579            assert(false);
580            actualMask = 0L;
581            break;
582        }
583        if (!(allowedDataFormatMask & actualMask)) {
584            SL_LOGE("%s: data format %d not allowed", name, formatType);
585            result = SL_RESULT_CONTENT_UNSUPPORTED;
586        }
587    }
588
589    return result;
590}
591
592
593/** \brief Check interface ID compatibility with respect to a particular source
594 *         and sink data locator format
595 */
596
597SLresult checkSourceSinkVsInterfacesCompatibility(const DataLocatorFormat *pSrcDataLocatorFormat,
598        const DataLocatorFormat *pSinkDataLocatorFormat,
599        const ClassTable *clazz, unsigned exposedMask) {
600    int index;
601    switch (pSrcDataLocatorFormat->mLocator.mLocatorType) {
602    case SL_DATALOCATOR_URI:
603#ifdef ANDROID
604    case SL_DATALOCATOR_ANDROIDFD:
605#endif
606        // URIs and FD can be sources when "playing" to an OutputMix or a Buffer Queue for decode
607        // so we don't prevent the retrieval of the BufferQueue interfaces for those sources
608        switch (pSinkDataLocatorFormat->mLocator.mLocatorType) {
609        case SL_DATALOCATOR_BUFFERQUEUE:
610#ifdef ANDROID
611        case SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE:
612#endif
613            break;
614        default:
615            // can't request SLBufferQueueItf or its alias SLAndroidSimpleBufferQueueItf
616            // if the data sink is not a buffer queue
617            index = clazz->mMPH_to_index[MPH_BUFFERQUEUE];
618#ifdef ANDROID
619            assert(index == clazz->mMPH_to_index[MPH_ANDROIDSIMPLEBUFFERQUEUE]);
620#endif
621            if (0 <= index) {
622                if (exposedMask & (1 << index)) {
623                    SL_LOGE("can't request SL_IID_BUFFERQUEUE "
624#ifdef ANDROID
625                            "or SL_IID_ANDROIDSIMPLEBUFFERQUEUE "
626#endif
627                            "with a non-buffer queue data sink");
628                    return SL_RESULT_FEATURE_UNSUPPORTED;
629                }
630            }
631            break;
632        }
633        break;
634
635    case SL_DATALOCATOR_BUFFERQUEUE:
636#ifdef ANDROID
637    case SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE:
638#endif
639        // can't request SLSeekItf if data source is a buffer queue
640        index = clazz->mMPH_to_index[MPH_SEEK];
641        if (0 <= index) {
642            if (exposedMask & (1 << index)) {
643                SL_LOGE("can't request SL_IID_SEEK with a buffer queue data source");
644                return SL_RESULT_FEATURE_UNSUPPORTED;
645            }
646        }
647        // can't request SLMuteSoloItf if data source is a mono buffer queue
648        index = clazz->mMPH_to_index[MPH_MUTESOLO];
649        if (0 <= index) {
650            if ((exposedMask & (1 << index)) &&
651                    (SL_DATAFORMAT_PCM == pSrcDataLocatorFormat->mFormat.mFormatType) &&
652                    (1 == pSrcDataLocatorFormat->mFormat.mPCM.numChannels)) {
653                SL_LOGE("can't request SL_IID_MUTESOLO with a mono buffer queue data source");
654                return SL_RESULT_FEATURE_UNSUPPORTED;
655            }
656        }
657        break;
658
659#ifdef ANDROID
660    case SL_DATALOCATOR_ANDROIDBUFFERQUEUE:
661#endif
662    case SL_DATALOCATOR_ADDRESS:
663    case SL_DATALOCATOR_MIDIBUFFERQUEUE:
664    case XA_DATALOCATOR_NATIVEDISPLAY:
665        // any special checks here???
666    default:
667        // can't request SLBufferQueueItf or its alias SLAndroidSimpleBufferQueueItf
668        // if the data source is not a buffer queue
669        index = clazz->mMPH_to_index[MPH_BUFFERQUEUE];
670#ifdef ANDROID
671        assert(index == clazz->mMPH_to_index[MPH_ANDROIDSIMPLEBUFFERQUEUE]);
672#endif
673        if (0 <= index) {
674            if (exposedMask & (1 << index)) {
675                SL_LOGE("can't request SL_IID_BUFFERQUEUE "
676#ifdef ANDROID
677                        "or SL_IID_ANDROIDSIMPLEBUFFERQUEUE "
678#endif
679                        "with a non-buffer queue data source");
680                return SL_RESULT_FEATURE_UNSUPPORTED;
681            }
682        }
683        break;
684    }
685    return SL_RESULT_SUCCESS;
686}
687
688
689/** \brief Free the local deep copy of a data format */
690
691static void freeDataFormat(DataFormat *pDataFormat)
692{
693    switch (pDataFormat->mFormatType) {
694    case SL_DATAFORMAT_MIME:
695        if (NULL != pDataFormat->mMIME.mimeType) {
696            free(pDataFormat->mMIME.mimeType);
697            pDataFormat->mMIME.mimeType = NULL;
698        }
699        break;
700    case SL_DATAFORMAT_PCM:
701    case XA_DATAFORMAT_RAWIMAGE:
702    case SL_DATAFORMAT_NULL:
703        break;
704    default:
705        // an invalid data format is caught earlier during the copy
706        assert(false);
707        break;
708    }
709}
710
711
712/** \brief Check a data source and make local deep copy */
713
714SLresult checkDataSource(const char *name, const SLDataSource *pDataSrc,
715        DataLocatorFormat *pDataLocatorFormat, SLuint32 allowedDataLocatorMask,
716        SLuint32 allowedDataFormatMask)
717{
718    assert(NULL != name && NULL != pDataLocatorFormat);
719    pDataLocatorFormat->u.mSource.pLocator = &pDataLocatorFormat->mLocator;
720    pDataLocatorFormat->u.mSource.pFormat = &pDataLocatorFormat->mFormat;
721
722    if (NULL == pDataSrc) {
723        pDataLocatorFormat->mLocator.mLocatorType = SL_DATALOCATOR_NULL;
724        pDataLocatorFormat->mFormat.mFormatType = SL_DATAFORMAT_NULL;
725        if ((allowedDataLocatorMask & DATALOCATOR_MASK_NULL) &&
726                (allowedDataFormatMask & DATAFORMAT_MASK_NULL)) {
727            return SL_RESULT_SUCCESS;
728        }
729        SL_LOGE("%s: data source cannot be NULL", name);
730        return SL_RESULT_PARAMETER_INVALID;
731    }
732    SLDataSource myDataSrc = *pDataSrc;
733    SLresult result;
734    result = checkDataLocator(name, myDataSrc.pLocator, &pDataLocatorFormat->mLocator,
735            allowedDataLocatorMask);
736    if (SL_RESULT_SUCCESS != result) {
737        return result;
738    }
739
740    switch (pDataLocatorFormat->mLocator.mLocatorType) {
741    case SL_DATALOCATOR_URI:
742        allowedDataFormatMask &= DATAFORMAT_MASK_MIME;
743        break;
744    case SL_DATALOCATOR_ADDRESS:
745    case SL_DATALOCATOR_BUFFERQUEUE:
746        allowedDataFormatMask &= DATAFORMAT_MASK_PCM;
747        break;
748    // Per the spec, the pFormat field is ignored in some cases
749    case SL_DATALOCATOR_IODEVICE:
750        myDataSrc.pFormat = NULL;
751        // fall through
752    case SL_DATALOCATOR_NULL:
753    case SL_DATALOCATOR_MIDIBUFFERQUEUE:
754        allowedDataFormatMask &= DATAFORMAT_MASK_NULL;
755        break;
756    case SL_DATALOCATOR_OUTPUTMIX:
757    case XA_DATALOCATOR_NATIVEDISPLAY:
758        allowedDataFormatMask = DATAFORMAT_MASK_NONE;
759        break;
760#ifdef ANDROID
761    case SL_DATALOCATOR_ANDROIDFD:
762        allowedDataFormatMask &= DATAFORMAT_MASK_MIME;
763        break;
764    case SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE:
765        allowedDataFormatMask &= DATAFORMAT_MASK_PCM;
766        break;
767    case SL_DATALOCATOR_ANDROIDBUFFERQUEUE:
768        allowedDataFormatMask &= DATAFORMAT_MASK_MIME;;
769        break;
770#endif
771    default:
772        // invalid data locator type is caught earlier
773        assert(false);
774        allowedDataFormatMask = DATAFORMAT_MASK_NONE;
775        break;
776    }
777
778    result = checkDataFormat(name, myDataSrc.pFormat, &pDataLocatorFormat->mFormat,
779            allowedDataFormatMask);
780    if (SL_RESULT_SUCCESS != result) {
781        freeDataLocator(&pDataLocatorFormat->mLocator);
782        return result;
783    }
784
785    return SL_RESULT_SUCCESS;
786}
787
788
789/** \brief Check a data sink and make local deep copy */
790
791SLresult checkDataSink(const char *name, const SLDataSink *pDataSink,
792        DataLocatorFormat *pDataLocatorFormat, SLuint32 allowedDataLocatorMask,
793        SLuint32 allowedDataFormatMask)
794{
795    assert(NULL != name && NULL != pDataLocatorFormat);
796    pDataLocatorFormat->u.mSink.pLocator = &pDataLocatorFormat->mLocator;
797    pDataLocatorFormat->u.mSink.pFormat = &pDataLocatorFormat->mFormat;
798
799    if (NULL == pDataSink) {
800        pDataLocatorFormat->mLocator.mLocatorType = SL_DATALOCATOR_NULL;
801        pDataLocatorFormat->mFormat.mFormatType = SL_DATAFORMAT_NULL;
802        if ((allowedDataLocatorMask & DATALOCATOR_MASK_NULL) &&
803                (allowedDataFormatMask & DATAFORMAT_MASK_NULL)) {
804            return SL_RESULT_SUCCESS;
805        }
806        SL_LOGE("%s: data sink cannot be NULL", name);
807        return SL_RESULT_PARAMETER_INVALID;
808    }
809    SLDataSink myDataSink = *pDataSink;
810    SLresult result;
811    result = checkDataLocator(name, myDataSink.pLocator, &pDataLocatorFormat->mLocator,
812            allowedDataLocatorMask);
813    if (SL_RESULT_SUCCESS != result) {
814        return result;
815    }
816
817    switch (pDataLocatorFormat->mLocator.mLocatorType) {
818    case SL_DATALOCATOR_URI:
819        allowedDataFormatMask &= DATAFORMAT_MASK_MIME;
820        break;
821    case SL_DATALOCATOR_ADDRESS:
822    case SL_DATALOCATOR_BUFFERQUEUE:
823        allowedDataFormatMask &= DATAFORMAT_MASK_PCM;
824        break;
825    // Per the spec, the pFormat field is ignored in some cases
826    case SL_DATALOCATOR_IODEVICE:
827    case SL_DATALOCATOR_OUTPUTMIX:
828    case XA_DATALOCATOR_NATIVEDISPLAY:
829        myDataSink.pFormat = NULL;
830        // fall through
831    case SL_DATALOCATOR_NULL:
832    case SL_DATALOCATOR_MIDIBUFFERQUEUE:
833        allowedDataFormatMask &= DATAFORMAT_MASK_NULL;
834        break;
835#ifdef ANDROID
836    case SL_DATALOCATOR_ANDROIDFD:
837        allowedDataFormatMask = DATAFORMAT_MASK_NONE;
838        break;
839    case SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE:
840        allowedDataFormatMask &= DATAFORMAT_MASK_PCM;
841        break;
842    case SL_DATALOCATOR_ANDROIDBUFFERQUEUE:
843        allowedDataFormatMask = DATAFORMAT_MASK_NONE;
844        break;
845#endif
846    default:
847        // invalid data locator type is caught earlier
848        assert(false);
849        allowedDataFormatMask = DATAFORMAT_MASK_NONE;
850        break;
851    }
852
853    result = checkDataFormat(name, myDataSink.pFormat, &pDataLocatorFormat->mFormat,
854            allowedDataFormatMask);
855    if (SL_RESULT_SUCCESS != result) {
856        freeDataLocator(&pDataLocatorFormat->mLocator);
857        return result;
858    }
859
860    return SL_RESULT_SUCCESS;
861}
862
863
864/** \brief Free the local deep copy of a data locator format */
865
866void freeDataLocatorFormat(DataLocatorFormat *dlf)
867{
868    assert(NULL != dlf);
869    freeDataLocator(&dlf->mLocator);
870    freeDataFormat(&dlf->mFormat);
871}
872