/* * Copyright (C) 2016 BlueKitchen GmbH * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the copyright holders nor the names of * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * 4. Any redistribution, use, or modification is done solely for * personal benefit and not for any commercial purpose or for * monetary gain. * * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * Please inquire about commercial licensing options at * contact@bluekitchen-gmbh.com * */ /* * avrcp_browsing_controller.h * * Audio/Video Remote Control Profile Browsing * */ #ifndef AVRCP_BROWSING_CONTROLLER_H #define AVRCP_BROWSING_CONTROLLER_H #include #include "classic/avrcp.h" #if defined __cplusplus extern "C" { #endif /* API_START */ typedef enum { AVRCP_BROWSING_MEDIA_PLAYER_ITEM = 0x01, AVRCP_BROWSING_FOLDER_ITEM, AVRCP_BROWSING_MEDIA_ELEMENT_ITEM, AVRCP_BROWSING_MEDIA_ROOT_FOLDER, AVRCP_BROWSING_MEDIA_ELEMENT_ITEM_ATTRIBUTE } avrcp_browsing_item_type_t; typedef enum { AVRCP_BROWSING_MEDIA_PLAYER_MAJOR_TYPE_AUDIO = 1, AVRCP_BROWSING_MEDIA_PLAYER_MAJOR_TYPE_VIDEO = 2, AVRCP_BROWSING_MEDIA_PLAYER_MAJOR_TYPE_BROADCASTING_AUDIO = 4, AVRCP_BROWSING_MEDIA_PLAYER_MAJOR_TYPE_BROADCASTING_VIDEO = 8 } avrcp_browsing_media_player_major_type_t; typedef enum { AVRCP_BROWSING_MEDIA_PLAYER_SUBTYPE_AUDIO_BOOK = 1, AVRCP_BROWSING_MEDIA_PLAYER_SUBTYPE_POADCAST = 2 } avrcp_browsing_media_player_subtype_t; typedef enum { AVRCP_BROWSING_MEDIA_PLAYER_STATUS_STOPPED = 0, AVRCP_BROWSING_MEDIA_PLAYER_STATUS_PLAYING, AVRCP_BROWSING_MEDIA_PLAYER_STATUS_PAUSED, AVRCP_BROWSING_MEDIA_PLAYER_STATUS_FWD_SEEK, AVRCP_BROWSING_MEDIA_PLAYER_STATUS_REV_SEEK, AVRCP_BROWSING_MEDIA_PLAYER_STATUS_ERROR = 0xFF } avrcp_browsing_media_player_status_t; typedef enum { AVRCP_BROWSING_FOLDER_TYPE_MIXED = 0x00, AVRCP_BROWSING_FOLDER_TYPE_TITLES, AVRCP_BROWSING_FOLDER_TYPE_ALBUMS, AVRCP_BROWSING_FOLDER_TYPE_ARTISTS, AVRCP_BROWSING_FOLDER_TYPE_GENRES, AVRCP_BROWSING_FOLDER_TYPE_PLAYLISTS, AVRCP_BROWSING_FOLDER_TYPE_YEARS } avrcp_browsing_folder_type_t; typedef enum { AVRCP_BROWSING_MEDIA_TYPE_AUDIO = 0x00, AVRCP_BROWSING_MEDIA_TYPE_VIDEO } avrcp_browsing_media_type_t; /** * @brief Set up AVRCP Browsing Controller device. */ void avrcp_browsing_controller_init(void); /** * @brief Register callback for the AVRCP Browsing Controller client. * @param callback */ void avrcp_browsing_controller_register_packet_handler(btstack_packet_handler_t callback); /** * @brief Retrieve a list of media players. * @param avrcp_browsing_cid * @param start_item * @param end_item * @param attr_bitmap Use AVRCP_MEDIA_ATTR_ALL for all, and AVRCP_MEDIA_ATTR_NONE for none. Otherwise, see avrcp_media_attribute_id_t for the bitmap position of attrs. **/ uint8_t avrcp_browsing_controller_get_media_players(uint16_t avrcp_browsing_cid, uint32_t start_item, uint32_t end_item, uint32_t attr_bitmap); /** * @brief Retrieve a list of folders and media items of the browsed player. * @param avrcp_browsing_cid * @param start_item * @param end_item * @param attr_bitmap Use AVRCP_MEDIA_ATTR_ALL for all, and AVRCP_MEDIA_ATTR_NONE for none. Otherwise, see avrcp_media_attribute_id_t for the bitmap position of attrs. **/ uint8_t avrcp_browsing_controller_browse_file_system(uint16_t avrcp_browsing_cid, uint32_t start_item, uint32_t end_item, uint32_t attr_bitmap); /** * @brief Retrieve a list of media items of the browsed player. * @param avrcp_browsing_cid * @param start_item * @param end_item * @param attr_bitmap Use AVRCP_MEDIA_ATTR_ALL for all, and AVRCP_MEDIA_ATTR_NONE for none. Otherwise, see avrcp_media_attribute_id_t for the bitmap position of attrs. **/ uint8_t avrcp_browsing_controller_browse_media(uint16_t avrcp_browsing_cid, uint32_t start_item, uint32_t end_item, uint32_t attr_bitmap); /** * @brief Retrieve a list of folders and media items of the addressed player. * @param avrcp_browsing_cid * @param start_item * @param end_item * @param attr_bitmap Use AVRCP_MEDIA_ATTR_ALL for all, and AVRCP_MEDIA_ATTR_NONE for none. Otherwise, see avrcp_media_attribute_id_t for the bitmap position of attrs. **/ uint8_t avrcp_browsing_controller_browse_now_playing_list(uint16_t avrcp_browsing_cid, uint32_t start_item, uint32_t end_item, uint32_t attr_bitmap); /** * @brief Set browsed player. Calling this command is required prior to browsing the player's file system. Some players may support browsing only when set as the Addressed Player. * @param avrcp_browsing_cid * @param browsed_player_id */ uint8_t avrcp_browsing_controller_set_browsed_player(uint16_t avrcp_browsing_cid, uint16_t browsed_player_id); /** * @brief Get total num attributes * @param avrcp_browsing_cid * @param scope */ uint8_t avrcp_browsing_controller_get_total_nr_items_for_scope(uint16_t avrcp_browsing_cid, avrcp_browsing_scope_t scope); /** * @brief Navigate one level up or down in thhe virtual filesystem. Requires that s browsed player is set. * @param avrcp_browsing_cid * @param direction 0-folder up, 1-folder down * @param folder_uid 8 bytes long **/ uint8_t avrcp_browsing_controller_change_path(uint16_t avrcp_browsing_cid, uint8_t direction, uint8_t * folder_uid); uint8_t avrcp_browsing_controller_go_up_one_level(uint16_t avrcp_browsing_cid); uint8_t avrcp_browsing_controller_go_down_one_level(uint16_t avrcp_browsing_cid, uint8_t * folder_uid); /** * @brief Retrives metadata information (title, artist, album, ...) about a media element with given uid. * @param avrcp_browsing_cid * @param uid media element uid * @param uid_counter Used to detect change to the media database on target device. A TG device that supports the UID Counter shall update the value of the counter on each change to the media database. * @param attr_bitmap 0x00000000 - retrieve all, chek avrcp_media_attribute_id_t in avrcp.h for detailed bit position description. * @param scope check avrcp_browsing_scope_t in avrcp.h **/ uint8_t avrcp_browsing_controller_get_item_attributes_for_scope(uint16_t avrcp_browsing_cid, uint8_t * uid, uint16_t uid_counter, uint32_t attr_bitmap, avrcp_browsing_scope_t scope); /** * @brief Searches are performed from the current folder in the Browsed Players virtual filesystem. The search applies to the current folder and all folders below that. * @param avrcp_browsing_cid * @param search_str_len * @param search_str * @return status **/ uint8_t avrcp_browsing_controller_search(uint16_t avrcp_browsing_cid, uint16_t search_str_len, char * search_str); /** * @brief De-Init AVRCP Browsing Controller */ void avrcp_browsing_controller_deinit(void); /* API_END */ #if defined __cplusplus } #endif #endif // AVRCP_BROWSING_CONTROLLER_H