xref: /btstack/src/classic/avrcp_media_item_iterator.h (revision 0561b2d8d5dba972c7daa57d5e677f7a1327edfd)
1 /*
2  * Copyright (C) 2017 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 // *****************************************************************************
39 //
40 // AVRCP Media Item Iterator
41 //
42 // *****************************************************************************
43 
44 #ifndef AVRCP_MEDIA_ITEM_ITERATOR_H
45 #define AVRCP_MEDIA_ITEM_ITERATOR_H
46 
47 #include "btstack_config.h"
48 #include <stdint.h>
49 
50 #if defined __cplusplus
51 extern "C" {
52 #endif
53 
54 /* API_START */
55 
56 typedef struct avrcp_media_item_context {
57      const uint8_t * data;
58      uint16_t   offset;
59      uint16_t   length;
60 } avrcp_media_item_context_t;
61 
62 // Media item data iterator
63 void avrcp_media_item_iterator_init(avrcp_media_item_context_t *context, uint16_t avrcp_media_item_len, const uint8_t * avrcp_media_item_data);
64 int  avrcp_media_item_iterator_has_more(const avrcp_media_item_context_t * context);
65 void avrcp_media_item_iterator_next(avrcp_media_item_context_t * context);
66 
67 // Access functions
68 uint32_t          avrcp_media_item_iterator_get_attr_id(const avrcp_media_item_context_t * context);
69 uint16_t         avrcp_media_item_iterator_get_attr_charset(const avrcp_media_item_context_t * context);
70 uint16_t         avrcp_media_item_iterator_get_attr_value_len(const avrcp_media_item_context_t * context);
71 const uint8_t *  avrcp_media_item_iterator_get_attr_value(const avrcp_media_item_context_t * context);
72 
73 /* API_END */
74 
75 #if defined __cplusplus
76 }
77 #endif
78 #endif // AVRCP_MEDIA_ITEM_ITERATOR_H
79