diff options
| author | asanoaozora <fifitaneki@hotmail.com> | 2016-12-15 17:37:28 +0100 |
|---|---|---|
| committer | asanoaozora <fifitaneki@hotmail.com> | 2016-12-15 17:37:28 +0100 |
| commit | 3c6e487547e7692fe7e7fd30d4531a496680ee7d (patch) | |
| tree | b481a5ae00885fba36c8edff3f61f33ca05f1a3c | |
| parent | 5620ee809fc37bf862bf504fc9ed5f05e9a12fba (diff) | |
| download | poi-service-3c6e487547e7692fe7e7fd30d4531a496680ee7d.tar.gz | |
apply patch for layer manager update
| -rw-r--r--[-rwxr-xr-x] | api/franca/navigation/freetextsearchservice/FreeTextSearch.fidl | 1084 | ||||
| -rw-r--r-- | api/freetextsearch-service/genivi-freetextsearchservice-constants.xml | 50 | ||||
| -rw-r--r-- | api/freetextsearch-service/genivi-freetextsearchservice.xml | 416 | ||||
| -rw-r--r-- | src/navigation/map-viewer/mapviewercontrol-plugin/genivi_mapviewer_mapviewercontrol.cxx | 79 | ||||
| -rw-r--r-- | src/navigation/map-viewer/mapviewercontrol-server-plugin/genivi_mapviewer_mapviewercontrol.cxx | 78 | ||||
| -rw-r--r-- | src/speech/CMakeLists.txt | 4 | ||||
| -rw-r--r-- | src/speech/README.md | 45 | ||||
| -rwxr-xr-x | src/speech/build.sh | 69 | ||||
| -rw-r--r-- | src/speech/main.cpp | 24 | ||||
| -rwxr-xr-x | src/speech/run.sh | 3 | ||||
| -rwxr-xr-x | src/speech/test-speech-capi.py | 15 | ||||
| -rw-r--r-- | test/navigation/src/.gitignore | 1 |
12 files changed, 1404 insertions, 464 deletions
diff --git a/api/franca/navigation/freetextsearchservice/FreeTextSearch.fidl b/api/franca/navigation/freetextsearchservice/FreeTextSearch.fidl index 7cb8fe4..e4e1842 100755..100644 --- a/api/franca/navigation/freetextsearchservice/FreeTextSearch.fidl +++ b/api/franca/navigation/freetextsearchservice/FreeTextSearch.fidl @@ -5,13 +5,13 @@ // This Source Code Form is subject to the terms of the // Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with // this file, you can obtain one at http://mozilla.org/MPL/2.0/. - package org.genivi.navigation.freetextsearchservice import org.genivi.CommonTypes.* from "../../CommonTypes.fidl" import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl" -<** @description : This interface allows a user to find locations by entering a single text string. +<** +@description : This interface allows a user to find locations by entering a single text string. A user of a navigation system needs to find a location on a map, e.g. to use as a destination of a route. Locations can be identified by different means, for example: - An address, e.g. '2400 Camino Ramon, San Ramon, California, USA.' @@ -32,311 +32,552 @@ The order in which the results will be received is not defined. The search engin If there are no matches found in a certain type of result, then no response for that type will be sent. E.g. if the user input only matches an address but not POIs, then no FtsResultPois response will be sent. To indicate that the search has finished an FtsDone signal is sent. + **> interface FreeTextSearch { - version { - major 4 - minor 0 - } - - <** @description: A requestId is an identifier used to match a response to a request. + version { + major 0 + minor 1 + } + + <** + @description: A requestId is an identifier used to match a response to a request. Range[0x1:0x7fff] notSpecifiedValue = 0x0 + **> typedef RequestId is Int16 - <** @description: Handle for a single Free Text Search session. - **> - typedef FreeTextSearchHandle is Handle - - <** @description: Type to represent most texts in this interface.. + <** + @description: Handle for a single Free Text Search session. + **> + typedef FreeTextSearchHandle is Handle + + <** + @description: Type to represent most texts in this interface.. Character set = UNICODE Maximum length = 4095 + **> typedef FtsString is String - - <** @description: A list of strings + <** + @description: A list of strings maximum length = 100 **> array FtsStringList of FtsString - - <** @description: A union to contain any of the possble search shapes. **> + <** + @description: A route corridor + **> + struct RouteCorridor { + + <** + @description: Route handle used to select a route. + Can be 0 to use the route for which guidance is started with startGuidance + from Guidance interface. + **> + Handle routeHandle + + <** + @description: Offset on route from the start of the route, in meters. + **> + DistanceInMeters startOffset + + <** + @description: Width of the corridor, in meters. + **> + DistanceInMeters corridorWidth + + <** + @description: Length of the corridor, in meters. + Can be 0 to search until the end of the route. + **> + DistanceInMeters corridorLength + } + + <** + @description: A union to contain any of the possible search shapes. + The search can be limited to the area of a circle or rectangle or to a route corridor + around a planned route. + **> union Shape { Circle circle Rectangle rectangle + RouteCorridor routeCorridor } - - <** @description: A list of shapes. + <** + @description: A list of shapes. maximum length = 31 + **> array ShapeList of Shape - - <** @description: A maximum number of results to be returned. + <** + @description: A maximum number of results to be returned. Range[0:1000] **> typedef PageSize is UInt16 - - <** @description: Search options for a search request. + <** + @description: Search options for a search request. The options are flags which can be OR-ed together to create SearchOptions. **> enumeration SearchOption { - <** @description: Search addresses. **> - ADDRESS = 1 - <** @description: Search POIs. **> - POI = 2 - <** @description: Get POI suggestions. **> - POI_SUGGESTION = 4 - <** @description: Do not search places when doing an address search. **> - NO_PLACES = 65536 - <** @description: Do not search streets when doing an address search. **> - NO_STREETS = 131072 - <** @description: Do not make assumptions on POI categories. **> - NO_POI_CATEGORY_ASSUMPTIONS = 262144 + + <** + @description: Search addresses. + **> + ADDRESS = 1 + + <** + @description: Search POIs. + **> + POI = 2 + + <** + @description: Get POI suggestions. + **> + POI_SUGGESTION = 4 + + <** + @description: Do not search places when doing an address search. + **> + NO_PLACES = 65536 + + <** + @description: Do not search streets when doing an address search. + **> + NO_STREETS = 131072 + + <** + @description: Do not make assumptions on POI categories. + **> + NO_POI_CATEGORY_ASSUMPTIONS = 262144 + + <** + @description: Do not search political divisions when doing an address search. + **> + NO_POLITICAL_DIVISIONS = 524288 + + <** + @description: Indicate POI links. + If this option is set in the query, POI results will be marked appropriately + if they are parents or children. + **> + POI_INDICATE_LINKS = 1048576 } - - <** @description: An OR-ed combination of SearchOption flags. + + <** + @description: An OR-ed combination of SearchOption flags. Range[0:0xffffffff] **> typedef SearchOptions is UInt32 - - <** @description: Search request status. **> + <** + @description: Search request status. + **> enumeration FtsStatus { - <** @description: No problem. **> - OK - <** @description: User aborted search. **> - ABORTED - <** @description: Search string is too short to evaluate. **> - PREFIX_TOO_SHORT - <** @description: An internal error occurred in the FTS engine. **> - INTERNAL_ERROR - <** @description: No FTS index for the current map. **> - INDEX_MISSING - <** @description: The FTS index format is not supported. **> - BAD_VERSION - <** @description: An invalid freeTextSearchHandle is passed to the FTS engine. **> - INVALID_PARAMETER_SEARCH_HANDLE - <** @description: A search query not supported by the FTS engine. **> - INVALID_PARAMETER_QUERY - <** @description: A search location not on this earth. **> - INVALID_PARAMETER_SEARCH_LOCATION - <** @description: An invalid page size. **> - INVALID_PARAMETER_PAGE_SIZE - <** @description: Invalid search options passed to the FTS engine. **> - INVALID_PARAMETER_SEARCH_OPTIONS - <** @description: Invalid search conditions passed to the FTS engine. **> - INVALID_PARAMETER_SEARCH_CONDITIONS - <** @description: One or more of the search shapes are invalid. **> - INVALID_PARAMETER_SEARCH_SHAPES + + <** + @description: No problem. + **> + OK = 0 + + <** + @description: User aborted search. + **> + ABORTED = 1 + + <** + @description: Search string is too short to evaluate. + **> + PREFIX_TOO_SHORT = 2 + + <** + @description: There is no search for which a next page can be requested. + **> + NO_SEARCH_TO_CONTINUE = 3 + + <** + @description: An internal error occurred in the FTS engine. + **> + INTERNAL_ERROR = 4 + + <** + @description: No FTS index for the current map. + **> + INDEX_MISSING = 5 + + <** + @description: The FTS index format is not supported. + **> + BAD_VERSION = 6 + + <** + @description: An invalid freeTextSearchHandle is passed to the FTS engine. + **> + INVALID_PARAMETER_SEARCH_HANDLE = 7 + + <** + @description: A search query not supported by the FTS engine. + **> + INVALID_PARAMETER_QUERY = 8 + + <** + @description: A search location not on this earth. + **> + INVALID_PARAMETER_SEARCH_LOCATION = 9 + + <** + @description: An invalid page size. + **> + INVALID_PARAMETER_PAGE_SIZE = 10 + + <** + @description: Invalid search options passed to the FTS engine. + **> + INVALID_PARAMETER_SEARCH_OPTIONS = 11 + + <** + @description: Invalid search conditions passed to the FTS engine. + **> + INVALID_PARAMETER_SEARCH_CONDITIONS = 12 + + <** + @description: One or more of the search shapes are invalid. + **> + INVALID_PARAMETER_SEARCH_SHAPES = 13 + + <** + @description: The fuzzy level is not in the allowed range: [0,5]. + **> + INVALID_PARAMETER_FUZZY_LEVEL =14 + + <** + @description: The input consisted of invalid geographic coordinates. + **> + INVALID_COORDINATES_INPUT = 15 } - - - <** @description: Handle to a location. + + <** + @description: Handle to a location. Range[0:0xffffffff] + **> typedef LocationHandle is UInt32 - - <** @description: A list of LocationHandles. + <** + @description: A list of LocationHandles. maximum length = 4096 + **> array LocationHandleList of LocationHandle + <** + @description: If a user entered a non-existing house number then the closest existing + number is returned. The houseNumberFromInput will contain the house + number from the user input, the houseNumber will contain closest house number. + If the map does not contain house numbers for the street, but the user + input seems to have a house number, then houseNumber will be empty and + houseNumberFromInput will contain the number from the input. + **> + struct StreetDetails { + FtsString streetName + + <** + @description: If a user entered a non-existing house number then the closest existing + number is returned. The houseNumberFromInput will contain the house + number from the user input, the houseNumber will contain closest house number. + If the map does not contain house numbers for the street, but the user + input seems to have a house number, then houseNumber will be empty and + houseNumberFromInput will contain the number from the input. + **> + FtsString houseNumber + + <** + @description: The house number that the search engine recognized in the user input. + Can be empty. + **> + FtsString houseNumberFromInput + } + + enumeration PlaceType { - <** @description: If a user entered a non-existing house number then the closest existing - number is returned. The houseNumberFromInput will contain the house - number from the user input, the houseNumber will contain closest house number. - If the map does not contain house numbers for the street, but the user - input seems to have a house number, then houseNumber will be empty and - houseNumberFromInput will contain the number from the input. - **> - struct StreetDetails { - FtsString streetName - <** @description: If a user entered a non-existing house number then the closest existing - number is returned. The houseNumberFromInput will contain the house - number from the user input, the houseNumber will contain closest house number. - If the map does not contain house numbers for the street, but the user - input seems to have a house number, then houseNumber will be empty and - houseNumberFromInput will contain the number from the input. - **> - FtsString houseNumber - <** @description: The house number that the search engine recognized in the user input. - Can be empty. - **> - FtsString houseNumberFromInput - } + <** + @description: a place of unknown type. + **> + OTHER = 0 + <** + @description: a center of a settlement. + **> + SETTLEMENT = 1 + } - enumeration PlaceType { - <** @description: a place of unknown type. **> - OTHER - <** @description: a center of a settlement. **> - SETTLEMENT = 2 + <** + @description: Place details. + **> + struct PlaceDetails { + PlaceType placeType + FtsString placeName + + <** + @description: The bounding box of this place (an estimate). + **> + Rectangle placeBoundingBox + } + + <** + @description: Mapcode details. + **> + struct MapCodeDetails { + + <** + @description: If the location of the mapcode is close to a street, this field + contains the name of that street, otherwise this field is left empty. + **> + FtsString closestStreetName + } + + <** + @description: Political division details (country or state). + **> + struct PoliticalDivisionDetails { + <** + @description: The bounding box of the political division. + **> + Rectangle boundingBox } - - - <** @description: Place details. **> - struct PlaceDetails { - PlaceType placeType - FtsString placeName - <** @description: The bounding box of this place (an estimate). **> - Rectangle placeBoundingBox - } - - - <** @description: Mapcode details. **> - struct MapCodeDetails { - <** @description: If the location of the mapcode is close to a street, this field - contains the name of that street, otherwise this field is left empty. - **> - FtsString closestStreetName - } - - - <** @description: A union to contain any of the specific types of address details. **> + + <** + @description: Geographic coordinate pair details. + **> + struct CoordinatesDetails + { + <** + @description: This field contains the name of the street that is closest + to the coordinates, as long as the straight line distance to + the closest street location is less than 25 meters. + **> + FtsString closestStreetName + } + + + <** + @description: A union to contain any of the specific types of address details. + **> union AddressDetails { StreetDetails streetDetails PlaceDetails placeDetails MapCodeDetails mapCodeDetails + PoliticalDivisionDetails politicalDivisionDetails + CoordinatesDetails coordinatesDetails } - - <** @description: A higher score means a better match. + <** + @description: A higher score means a better match. Range[0:0xffff] + **> typedef Score is UInt16 - - <** @description: Address information. **> - struct Address { - LocationHandle locationHandle - FtsString countryCode - <** @description: Optional state code. **> - FtsString stateCode - <** @description: There can be multiple place names. **> - FtsStringList places - <** @description: There can be multiple postal codes assigned to a street. **> - FtsStringList postalCodes - <** @description: Mapcode of the coordinate. - A mapcode represents a location. Every location on Earth can be represented by a mapcode. - Mapcodes were designed to be short, easy to recognize, remember and communicate. - They are precise to a few meters. For details see http://www.mapcode.com. - **> - FtsString mapCode - AddressDetails addressDetails - Coordinate2D coordinate - <** @description: Distance in meters from the search location. - -1 if no search location is given. - **> - DistanceInMeters distance - <** @description: A higher score means a better match. **> - Score score - <** @description: Indicates whether this match is fuzzy, i.e. it was matched with misspellings. **> - Boolean fuzzyMatch - } - - - <** @description: A list of addresses. + <** + @description: Address information. + **> + struct Address { + LocationHandle locationHandle + FtsString countryCode + + <** + @description: Optional state code. + **> + FtsString stateCode + + <** + @description: There can be multiple place names. + **> + FtsStringList places + + <** + @description: There can be multiple postal codes assigned to a street. + **> + FtsStringList postalCodes + + <** + @description: Mapcode of the coordinate. + A mapcode represents a location. Every location on Earth can be represented by a mapcode. + Mapcodes were designed to be short, easy to recognize, remember and communicate. + They are precise to a few meters. For details see http://www.mapcode.com. + **> + FtsString mapCode + AddressDetails addressDetails + Coordinate2D coordinate + + <** + @description: Distance in meters from the search location. + -1 if no search location is given. + **> + DistanceInMeters distance + + <** + @description: A higher score means a better match. + **> + Score score + + <** + @description: Indicates whether this match is fuzzy, i.e. it was matched with misspellings. + **> + Boolean fuzzyMatch + } + + <** + @description: A list of addresses. maximum length = 500 **> array Addresses of Address - - <** @description: Numerical POI category code. + <** + @description: Numerical POI category code. Range[0:0xffffffff] **> typedef POICategoryCode is UInt32 - - <** @description: POI information. **> - struct POI { - LocationHandle locationHandle - POICategoryCode categoryCode - FtsStringList brandNames - FtsString poiName - FtsString address - FtsStringList place - FtsStringList postalCode - FtsString mapCode - FtsString countryCode - FtsString stateCode - FtsString telephone - Coordinate2D coordinate - <** @description: Distance in meters from the search location. - -1 if no search location is given. - **> - DistanceInMeters distance - <** @description: A higher score means a better match. **> - Score score - <** @description: Indicates whether this match is fuzzy, i.e. it was matched with misspellings. **> - Boolean fuzzyMatch - } - - <** @description: A list of POIs. + <** + @description: POI information. + **> + struct POI { + LocationHandle locationHandle + POICategoryCode categoryCode + FtsStringList brandNames + FtsString poiName + FtsString address + FtsStringList place + FtsStringList postalCode + FtsString mapCode + FtsString countryCode + FtsString stateCode + FtsString telephone + Coordinate2D coordinate + + <** + @description: Distance in meters from the search location. + -1 if no search location is given. + **> + DistanceInMeters distance + + <** + @description: A higher score means a better match. + **> + Score score + + <** + @description: Indicates whether this match is fuzzy, i.e. it was matched with misspellings. + **> + Boolean fuzzyMatch + + <** + @description: Indicates that POI has parents. + **> + Boolean hasParents + + <** + @description: Indicates that POI has children. + **> + Boolean hasChildren + + <** + @description: For searches along route, this value is the the detour distance, + in meters, expresses how much longer the total route will be if the POI is visited. + The detour distance will be -1 for all searches that don’t use a route corridor + (searches in all map, in circle or rectangle). + **> + DistanceInMeters detourDistance + + <** + @description: For searches along route, this value is the detour time, in seconds, + expresses what’s the delay at the destination if the POI is visited. + The detour time will be -1 for all searches that don’t use a route corridor + (searches in all map, in circle or rectangle). + **> + Int32 detourTime + } + + <** + @description: A list of POIs. maximum length = 500 + **> array POIs of POI - - <** @description: Data type for POI category suggestions. **> - struct POICategory { - POICategoryCode categoryCode - FtsString categoryName - <** @description: The search engine recognizes synonyms and names associated with a - POI category. If a match on such a name is found, then this attribute is set to that name. - **> - FtsString matchedName - <** @description: Text that can be used for a suggestion like: "<categoryName> <searchTextSuggestion>" - Typically this contains the original query text, where the recognized - category name or synonym has been removed. - **> - FtsString searchTextSuggestion - <** @description: A list of addresses that can be used for suggestions like: "<categoryName> near <address> - Note the addresses in this list do not have a valid location handle - as the address is only needed to be displayed as a suggestion. - The coordinates of an address can be used for a POI window query if the - user picks a suggestion. - **> - Addresses nearAddressSuggestions - <** @description: A higher score means a better match. **> - Score score - } - - - <** @description: A list of POI categories. + <** + @description: Data type for POI category suggestions. + **> + struct POICategory { + POICategoryCode categoryCode + FtsString categoryName + + <** + @description: The search engine recognizes synonyms and names associated with a + POI category. If a match on such a name is found, then this attribute is set to that name. + **> + FtsString matchedName + + <** + @description: Text that can be used for a suggestion like: "<categoryName> <searchTextSuggestion>" + Typically this contains the original query text, where the recognized + category name or synonym has been removed. + **> + FtsString searchTextSuggestion + + <** + @description: A list of addresses that can be used for suggestions like: "<categoryName> near <address> + Note the addresses in this list do not have a valid location handle + as the address is only needed to be displayed as a suggestion. + The coordinates of an address can be used for a POI window query if the + user picks a suggestion. + **> + Addresses nearAddressSuggestions + + <** + @description: A higher score means a better match. + **> + Score score + } + + <** + @description: A list of POI categories. maximum length = 500 + **> array POICategories of POICategory - - <** @description: Indicates on a scale from 0 to 5 how fuzzy the search results can be. + <** + @description: Indicates on a scale from 0 to 5 how fuzzy the search results can be. 0 means only an exact search is performed, 1 is the lowest level of fuzzy search and 5 means a very fuzzy search. Range[0:5] + **> typedef FuzzyLevel is Int8 - - <** @description : This method returns the API version implemented by the content access module.**> - method getVersion { - in { - <** @description: Identifier to match responses to this request. **> - RequestId requestId - } - out { - <** @description: Identifier to match this response with a request. **> - RequestId responseId - <** @description: .**> - Version ^version - } - } - - <** @description: Perform a free text search. + + <** + @description : This method returns the API version implemented by the content access module. + **> + method getVersion { + out { + + <** + @description: . + **> + Version ^version + } + } + + <** + @description: Perform a free text search. A single search request will trigger zero or more FtsResultXxx responses followed by an FtsDone response. Each response will contain 1 page of results. A next page of results can be retrieved with the FtsNextPage request. @@ -345,164 +586,261 @@ interface FreeTextSearch { then the previous request will be canceled. You will still get a done response on the previous request. This way each request gets a response. + **> method ftsRequest { in { - <** @description: Identifier to match responses to this request. **> - RequestId requestId - <** @description: Text to match. **> - FtsString inputString - <** @description: Location for scoring the search results. - A result closer to this location gets a higher score than a result further away. - **> - Coordinate2D searchLocation - <** @description: Limit the search to the union of several shapes (each can be a circle or a rectangle). - Pass an empty list to search the whole map. - **> - ShapeList searchShapes - <** @description: The maximum number of addresses and POIs that will be returned. **> - PageSize pageSize - <** @description: Options to indicate what to search for. - One or more values of SearchOption can be added together. - **> - SearchOptions searchOptions - <** @description: Additional search conditions, space separated. - The string can be empty when the POI search is not limited by categories - and not limited by countries/states. - Supported conditions: - "category:nnnn" Limit the POI search to a one or more POI categories, - where 'nnnn' is a comma-separated list of numerical POI category ids. - "country:aaaaa" Limit the search to one or more countries (or states), - where 'aaaaa' is a comma-separated list of ISO-3166-1 alpha 3 - country code concatenated with an optional ISO-3166-2 state code. - Examples: - "category:9373,9374": limits the POI search to the union of categories 9373 and 9374. - "country:USACA": limits the search to the state of California. - "category:6315 country:USACA,MEX": limits the POI search to category 6315 - and limits the search to the union of California state and Mexico. - **> - FtsString searchConditions - <** @description: Indication of how fuzzy the search shall be performed. **> - FuzzyLevel fuzzyLevel - } - out { - <** @description: Identifier to match this response with a request. **> - RequestId responseId - <** @description: Handle to identify the Free Text Search session. - **> - Handle freeTextSearchHandle - } - error { - <** @description: Indicates that no new Free Text Search session can be started at the moment. - **> - NoMoreFtsHandles - } + + <** + @description: Identifier to match responses to this request. + **> + RequestId requestId + + <** + @description: Text to match. + **> + FtsString inputString + + <** + @description: Location for scoring the search results. + A result closer to this location gets a higher score than a result further away. + **> + Coordinate2D searchLocation + + <** + @description: Limit the search to the union of several shapes (each can be a circle or a rectangle + or a route corridor around a planned route). Pass an empty list to search the whole map. + **> + ShapeList searchShapes + + <** + @description: The maximum number of addresses and POIs that will be returned. + **> + PageSize pageSize + + <** + @description: Options to indicate what to search for. + One or more values of SearchOption can be added together. + **> + SearchOptions searchOptions + + <** + @description: Additional search conditions, space separated. + The string can be empty when the POI search is not limited by categories + and not limited by countries/states. + Supported conditions: + "category:nnnn" Limit the POI search to a one or more POI categories, + where 'nnnn' is a comma-separated list of numerical POI category ids. + "country:aaaaa" Limit the search to one or more countries (or states), + where 'aaaaa' is a comma-separated list of ISO-3166-1 alpha 3 + country code concatenated with an optional ISO-3166-2 state code. + Examples: + "category:9373,9374": limits the POI search to the union of categories 9373 and 9374. + "country:USACA": limits the search to the state of California. + "category:6315 country:USACA,MEX": limits the POI search to category 6315 + and limits the search to the union of California state and Mexico. + **> + FtsString searchConditions + + <** + @description: Indication of how fuzzy the search shall be performed. + **> + FuzzyLevel fuzzyLevel + } + out { + + <** + @description: Handle to identify the Free Text Search session. + **> + Handle freeTextSearchHandle + } + error { + + <** + @description: Indicates no error. + **> + OK + + <** + @description: Indicates that no new Free Text Search session can be started at the moment. + **> + NoMoreFtsHandles + + <** + @description: Indicates the request failed becuase of invalid request ID. + **> + InvalidRequestId + } } - - <** @description: Get next result page for the last performed search. + + <** + @description: Get next result page for the last performed search. This request will trigger zero or more FtsResultXxx responses followed by an FtsDone response. - If there is no search request done before or if a search request is still in progress - hen the FtsDone response will return a EStatusNoSearchToContinue status. + If there is no search request done before or if a search request is still in progress, + the FtsDone response will return a NO_SEARCH_TO_CONTINUE status. + **> method ftsNextPage { - in { - <** @description: Identifier to match responses to this request. **> - RequestId requestId - <** @description: Handle to identify the Free Text Search session. - **> - Handle freeTextSearchHandle - <** @description: Options to indicate what to search for. - One or more values of TFTSSearchOption can be added together. - You can only get results for options that have been passed to the initial FtsRequest. - **> - SearchOptions searchOptions - } - out { - <** @description: Identifier to match this response with a request. **> - RequestId responseId - } + in { + + <** + @description: Identifier to match responses to this request. + **> + RequestId requestId + + <** + @description: Handle to identify the Free Text Search session. + **> + Handle freeTextSearchHandle + + <** + @description: Options to indicate what to search for. + One or more values of SearchOption can be added together. + You can only get results for options that have been passed to the initial FtsRequest. + **> + SearchOptions searchOptions + } + error { + + <** + @description: Indicates no error. + **> + OK + + <** + @description: Indicates that freeTextSearchHandle is unknown. + **> + UnknownHandle + + <** + @description: Indicates the request failed becuase of invalid request ID. + **> + InvalidRequestId + } } - <** @description: Cancel an FTS session. **> + <** + @description: Cancel an FTS session. + **> method ftsCancel { - in { - <** @description: Identifier to match responses to this request. **> - RequestId requestId - <** @description: Handle to identify the Free Text Search session to be cancelled. - **> - Handle freeTextSearchHandle - } - out { - <** @description: Identifier to match this response with a request. **> - RequestId responseId - } + in { + + <** + @description: Handle to identify the Free Text Search session to be cancelled. + **> + Handle freeTextSearchHandle + } + error { + + <** + @description: Indicates no error. + **> + OK + + <** + @description: Indicates that freeTextSearchHandle is unknown. + **> + UnknownHandle + } + } + + <** + @description : Response indicating that the search is done. + **> + broadcast ftsDone selective { + out { + + <** + @description: Identifier to match this response with a request. + **> + RequestId responseId + + <** + @description: Status of the search request. + **> + FtsStatus ftsStatus + } + } + + <** + @description : Response with address results. + **> + broadcast ftsResultAddresses selective { + out { + + <** + @description: Identifier to match this response with a request. + **> + RequestId responseId + + <** + @description: Matching addresses. + The order of the addresses is the order of matching relevance. + The first address is a better match than the last result. + **> + Addresses addresses + + <** + @description: Flag to indicate if more addresses might be available in a next page. + **> + Boolean moreAvailable + } + } + + <** + @description : Response with POI results. + **> + broadcast ftsResultPois selective { + out { + + <** + @description: Identifier to match this response with a request. + **> + RequestId responseId + + <** + @description: Matching POIs. + The order of the POIs is the order of matching relevance. + The first POI is a better match than the last result. + **> + POIs pois + + <** + @description: Flag to indicate if more POIs might be available in a next page. + **> + Boolean moreAvailable + } + } + + <** + @description : Response with POI category suggestions. + **> + broadcast ftsResultPoiSuggestions selective { + out { + + <** + @description: Identifier to match this response with a request. + **> + RequestId responseId + + <** + @description: POI category suggestions. + **> + POICategories poiCategories + } + } + + <** + @description : Release handle(s) if they are not used anymore. + **> + method deleteLocationHandles { + in { + + <** + @description: list of handles to release. + **> + LocationHandleList locationHandleList + } } - - <** @description : Response indicating that the search is done. **> - broadcast ftsDone selective { - out { - <** @description: Identifier to match this response with a request. **> - RequestId responseId - <** @description: Status of the search request. **> - FtsStatus ftsStatus - } - } - - - <** @description : Response with address results. **> - broadcast ftsResultAddresses selective { - out { - <** @description: Identifier to match this response with a request. **> - RequestId responseId - <** @description: Matching addresses. - The order of the addresses is the order of matching relevance. - The first address is a better match than the last result. - **> - Addresses addresses - <** @description: Flag to indicate if more addresses might be available in a next page. **> - Boolean moreAvailable - } - } - - <** @description : Response with POI results. **> - broadcast ftsResultPois selective { - out { - <** @description: Identifier to match this response with a request. **> - RequestId responseId - <** @description: Matching POIs. - The order of the POIs is the order of matching relevance. - The first POI is a better match than the last result. - **> - POIs pois - <** @description: Flag to indicate if more POIs might be available in a next page. **> - Boolean moreAvailable - } - } - - - <** @description : Response with POI category suggestions. **> - broadcast ftsResultPoiSuggestions selective { - out { - <** @description: Identifier to match this response with a request. **> - RequestId responseId - <** @description: POI category suggestions. **> - POICategories poiCategories - } - } - - - <** @description : Release handle(s) if they are not used anymore. **> - method deleteLocationHandles { - in { - <** @description: Identifier to match responses to this request. **> - RequestId requestId - <** @description: list of handles to release. **> - LocationHandleList locationHandleList - } - out { - <** @description: Identifier to match this response with a request. **> - RequestId responseId - } - } -}
\ No newline at end of file +} diff --git a/api/freetextsearch-service/genivi-freetextsearchservice-constants.xml b/api/freetextsearch-service/genivi-freetextsearchservice-constants.xml new file mode 100644 index 0000000..dbfc471 --- /dev/null +++ b/api/freetextsearch-service/genivi-freetextsearchservice-constants.xml @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?xml-stylesheet type="text/xsl" href="constants.xsl"?> +<!-- SPDX-License-Identifier: MPL-2.0 + Copyright (C) 2014, BMW Car IT GmbH, Continental Automotive GmbH, PCA Peugeot Citroën, XS Embedded GmbH, TomTom International B.V., Alpine Electronics R&D Europe GmbH, AISIN AW CO., LTD., Neusoft Technology Solutions GmbH, Jaguar Land Rover Limited, Visteon Corporation + This Source Code Form is subject to the terms of the + Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with + this file, you can obtain one at http://mozilla.org/MPL/2.0/. +--> + +<constants name="FreeTextSearchService"> + <version>0.1.0 (16-11-2016)</version> + <doc> + <line>This document defines the constants used in the FreeTextSearchService APIs</line> + </doc> + + <id name="MAX_SHAPE_COUNT" value="0x1F" /> + + <id name="MIN_FUZZY_LEVEL" value="0x0" /> + <id name="MAX_FUZZY_LEVEL" value="0x5" /> + + <id name="SEARCH_OPTION_ADDRESS" value="0x1" /> + <id name="SEARCH_OPTION_POI" value="0x2" /> + <id name="SEARCH_OPTION_POI_SUGGESTION" value="0x4" /> + <id name="SEARCH_OPTION_NO_PLACES" value="0x10000" /> + <id name="SEARCH_OPTION_NO_STREETS" value="0x20000" /> + <id name="SEARCH_OPTION_NO_POI_CATEGORY_ASSUMPTIONS" value="0x40000" /> + <id name="SEARCH_OPTION_NO_POLITICAL_DIVISIONS" value="0x80000" /> + <id name="SEARCH_OPTION_POI_INDICATE_LINKS" value="0x100000" /> + + <id name="FTS_STATUS_OK" value="0x0" /> + <id name="FTS_STATUS_ABORTED" value="0x1" /> + <id name="FTS_STATUS_PREFIX_TOO_SHORT" value="0x2" /> + <id name="FTS_STATUS_NO_SEARCH_TO_CONTINUE" value="0x3" /> + <id name="FTS_STATUS_INTERNAL_ERROR" value="0x4" /> + <id name="FTS_STATUS_INDEX_MISSING" value="0x5" /> + <id name="FTS_STATUS_BAD_VERSION" value="0x6" /> + <id name="FTS_STATUS_INVALID_PARAMETER_SEARCH_HANDLE" value="0x7" /> + <id name="FTS_STATUS_INVALID_PARAMETER_QUERY" value="0x8" /> + <id name="FTS_STATUS_INVALID_PARAMETER_SEARCH_LOCATION" value="0x9" /> + <id name="FTS_STATUS_INVALID_PARAMETER_PAGE_SIZE" value="0xA" /> + <id name="FTS_STATUS_INVALID_PARAMETER_SEARCH_OPTIONS" value="0xB" /> + <id name="FTS_STATUS_INVALID_PARAMETER_SEARCH_CONDITIONS" value="0xC" /> + <id name="FTS_STATUS_INVALID_PARAMETER_SEARCH_SHAPES" value="0xD" /> + <id name="FTS_STATUS_INVALID_PARAMETER_FUZZY_LEVEL" value="0xE" /> + <id name="FTS_STATUS_INVALID_COORDINATES_INPUT" value="0xF" /> + + <id name="PLACE_TYPE_OTHER" value="0x0" /> + <id name="PLACE_TYPE_SETTLEMENT" value="0x1" /> + +</constants>
\ No newline at end of file diff --git a/api/freetextsearch-service/genivi-freetextsearchservice.xml b/api/freetextsearch-service/genivi-freetextsearchservice.xml new file mode 100644 index 0000000..8266ad9 --- /dev/null +++ b/api/freetextsearch-service/genivi-freetextsearchservice.xml @@ -0,0 +1,416 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?xml-stylesheet type="text/xsl" href="introspect.xsl"?> +<!-- SPDX-License-Identifier: MPL-2.0 + Copyright (C) 2014, BMW Car IT GmbH, Continental Automotive GmbH, PCA Peugeot Citroën, XS Embedded GmbH, TomTom International B.V., Alpine Electronics R&D Europe GmbH, AISIN AW CO., LTD., Neusoft Technology Solutions GmbH, Jaguar Land Rover Limited, Visteon Corporation + This Source Code Form is subject to the terms of the + Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with + this file, you can obtain one at http://mozilla.org/MPL/2.0/. +--> +<node xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="/org/genivi/navigation/freetextsearchservice" xsi:noNamespaceSchemaLocation="introspect.xsd" > + <interface name="org.genivi.navigation.freetextsearchservice.FreeTextSearch"> + <version>0.1.0 (16-11-2016)</version> + <doc> + <line>FreeTextSearch = This interface allows a user to find locations by entering a single text string.</line> + <line>A user of a navigation system needs to find a location on a map, e.g. to use as a destination of a route.</line> + <line>Locations can be identified by different means, for example:</line> + <line>- An address, e.g. '2400 Camino Ramon, San Ramon, California, USA.'</line> + <line>- A point of interest, e.g. 'Eiffel Tower'.</line> + <line>- A named place, .e.g. 'Amsterdam'</line> + <line>This interface allows a user to find these locations by entering a single text string.</line> + <line>The system will respond with locations that match the given text string.</line> + <line>For each location, a location handle will be returned that can be used as input to other interfaces,</line> + <line>for example to plan a route, or to get more attributes of a point of interest.</line> + <line>A free text search is initiated by sending a free text search request (Method FtsRequest) containing the search text and search options input by the user.</line> + <line>Depending on search options both addresses and POIs are searched for matches. A single request may get multiple result responses (via Signals):</line> + <line>- FtsResultAddresses to report address matches</line> + <line>- FtsResultPois to report POI matches</line> + <line>- FtsResultPoiSuggestions to give suggestions for doing specific POI queries</line> + <line>Each response comes as soon as the results are available, so address results may be received while the search process continues looking for POI matches.</line> + <line>The order in which the results will be received is not defined. The search engine determines which results to return first based on the user input.</line> + <line>If there are no matches found in a certain type of result, then no response for that type will be sent.</line> + <line>E.g. if the user input only matches an address but not POIs, then no FtsResultPois response will be sent.</line> + <line>To indicate that the search has finished an FtsDone signal is sent.</line> + </doc> + <method name="getVersion"> + <doc> + <line>getVersion = This method returns the API version implemented by the content access module.</line> + </doc> + <arg direction="out" name="version" type="(qqqs)"> + <doc> + <line>version Version - </line> + <line>Version struct[versionMajor, versionMinor, versionMicro, date] = version.</line> + <line>Version.versionMajor UInt16 - when the major changes, then backward compatibility with previous releases is not granted.</line> + <line>Version.versionMinor UInt16 - when the minor changes, then backward compatibility with previous releases is granted, but something changed in the implementation of the API (e.g. new methods may have been added).</line> + <line>Version.versionMicro UInt16 - when the micro changes, then backward compatibility with previous releases is granted (bug fixes or documentation modifications).</line> + <line>Version.date String - release date (e.g. 21-06-2011).</line> + </doc> + </arg> + </method> + <method name="ftsRequest"> + <doc> + <line>ftsRequest = Perform a free text search.</line> + <line>A single search request will trigger zero or more FtsResultXxx responses followed by an FtsDone response.</line> + <line>Each response will contain 1 page of results.</line> + <line>A next page of results can be retrieved with the FtsNextPage request.</line> + <line></line> + <line>When you send a new request before receiving a done response on the previous request,</line> + <line>then the previous request will be canceled.</line> + <line>You will still get a done response on the previous request.</line> + <line>This way each request gets a response.</line> + </doc> + <arg direction="in" name="requestId" type="n"> + <doc> + <line>requestId RequestId - Identifier to match responses to this request.</line> + <line>RequestId Int16 - Range[0x1:0x7fff]. notSpecifiedValue = 0x0.</line> + </doc> + </arg> + <arg direction="in" name="inputString" type="s"> + <doc> + <line>inputString FtsString - Text to match.</line> + <line>FtsString String - Type to represent most texts in this interface. Character set = UNICODE.</line> + </doc> + </arg> + <arg direction="in" name="searchLocation" type="(dd)"> + <doc> + <line>searchLocation Coordinate2D - Location for scoring the search results.</line> + <line>A result closer to this location gets a higher score than a result further away.</line> + <line>Coordinate2D struct(latitude,longitude).</line> + <line>Coordinate2D.latitude Double - Latitude of the current position (according WGS84). Range [-90:+90]. Example: 48.053250.</line> + <line>Coordinate2D.longitude Double - Longitude of the current position (according WGS84). Range [-180:+180]. Example: 8.324500. </line> + </doc> + </arg> + <arg direction="in" name="searchShapes" type="a(yv)"> + <doc> + <line>searchShapes ShapeList - Limit the search to the union of several shapes (each can be a circle or a rectangle</line> + <line>or a route corridor around a planned route). Pass an empty list to search the whole map.</line> + <line>ShapeList array[Shape] - </line> + <line>Shape variant[circle, rectangle, routeCorridor] - A union to contain any of the possible search shapes.</line> + <line>Shape.circle Circle - </line> + <line>Shape.rectangle Rectangle - </line> + <line>Shape.routeCorridor RouteCorridor - </line> + <line>Circle struct(center, radius) - A circle given as center and radius.</line> + <line>Circle.center Coordinate2D - </line> + <line>Circle.radius DistanceInMeters - </line> + <line>DistanceInMeters Int32 - </line> + <line>Rectangle struct(topLeft,bottomRight) - </line> + <line>topLeft Coordinate2D - </line> + <line>bottomRight Coordinate2D - </line> + <line>RouteCorridor struct(routeHandle, startOffset, corridorWidth, corridorLength)</line> + <line>RouteCorridor.routeHandle Handle - Route handle used to select a route. </line> + <line>Can be 0 to use the route for which guidance is started with startGuidance from Guidance interface.</line> + <line>RouteCorridor.startOffset DistanceInMeters - Offset on route from the start of the route, in meters.</line> + <line>RouteCorridor.corridorWidth DistanceInMeters - Width of the corridor, in meters.</line> + <line>RouteCorridor.corridorLength DistanceInMeters - Length of the corridor, in meters. Can be 0 to search until the end of the route.</line> + </doc> + </arg> + <arg direction="in" name="pageSize" type="q"> + <doc> + <line>pageSize PageSize - The maximum number of addresses and POIs that will be returned.</line> + <line>PageSize UInt16 - A maximum number of results to be returned. Range[0:1000].</line> + </doc> + </arg> + <arg direction="in" name="searchOptions" type="u"> + <doc> + <line>searchOptions SearchOptions - Options to indicate what to search for.</line> + <line>One or more values of SearchOption can be added together.</line> + <line>SearchOptions UInt32 - An OR-ed combination of SearchOption flags. Range[0:0xffffffff]</line> + <line>SearchOption enum[ADDRESS=0x1, POI=0x2, POI_SUGGESTION=0x4,</line> + <line>NO_PLACES=0x10000, NO_STREETS=0x20000, NO_POI_CATEGORY_ASSUMPTIONS=0x40000,</line> + <line>NO_POLITICAL_DIVISIONS=0x80000, POI_INDICATE_LINKS=0x100000]</line> + </doc> + </arg> + <arg direction="in" name="searchConditions" type="s"> + <doc> + <line>searchConditions FtsString - Additional search conditions, space separated.</line> + <line>The string can be empty when the POI search is not limited by categories</line> + <line>and not limited by countries/states.</line> + <line>Supported conditions:</line> + <line>"category:nnnn" Limit the POI search to a one or more POI categories,</line> + <line>where 'nnnn' is a comma-separated list of numerical POI category ids.</line> + <line>"country:aaaaa" Limit the search to one or more countries (or states),</line> + <line>where 'aaaaa' is a comma-separated list of ISO-3166-1 alpha 3</line> + <line>country code concatenated with an optional ISO-3166-2 state code.</line> + <line>Examples:</line> + <line>"category:9373,9374": limits the POI search to the union of categories 9373 and 9374.</line> + <line>"country:USACA": limits the search to the state of California.</line> + <line>"category:6315 country:USACA,MEX": limits the POI search to category 6315</line> + <line>and limits the search to the union of California state and Mexico.</line> + </doc> + </arg> + <arg direction="in" name="fuzzyLevel" type="y"> + <doc> + <line>fuzzyLevel FuzzyLevel - Indication of how fuzzy the search shall be performed.</line> + <line>FuzzyLevel Int8 - Indicates on a scale from 0 to 5 how fuzzy the search results can be. </line> + <line>0 means only an exact search is performed, 1 is the lowest level of fuzzy search</line> + <line>and 5 means a very fuzzy search. Range[0:5]</line> + </doc> + </arg> + <arg direction="out" name="error" type="i"> + <doc> + <line>OK = Indicates no error.</line> + <line>NoMoreFtsHandles = Indicates that no new Free Text Search session can be started at the moment.</line> + <line>InvalidRequestId = Indicates the request failed becuase of invalid request ID.</line> + </doc> + </arg> + <arg direction="out" name="freeTextSearchHandle" type="u"> + <doc> + <line>freeTextSearchHandle Handle. Handle to identify the Free Text Search session.</line> + <line>Handle UInt32. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value.</line> + </doc> + </arg> + </method> + <method name="ftsNextPage"> + <doc> + <line>ftsNextPage = Get next result page for the last performed search.</line> + <line>This request will trigger zero or more FtsResultXxx responses followed by an FtsDone response.</line> + <line>If there is no search request done before or if a search request is still in progress</line> + <line>then the FtsDone response will return a NO_SEARCH_TO_CONTINUE status.</line> + </doc> + <arg direction="in" name="requestId" type="n"> + <doc> + <line>requestId RequestId - Identifier to match responses to this request.</line> + </doc> + </arg> + <arg direction="in" name="freeTextSearchHandle" type="u"> + <doc> + <line>freeTextSearchHandle Handle - Handle to identify the Free Text Search session.</line> + </doc> + </arg> + <arg direction="in" name="searchOptions" type="u"> + <doc> + <line>searchOptions SearchOptions - Options to indicate what to search for.</line> + <line>One or more values of SearchOption can be added together.</line> + <line>You can only get results for options that have been passed to the initial FtsRequest.</line> + </doc> + </arg> + <arg direction="out" name="error" type="i"> + <doc> + <line>OK = Indicates no error.</line> + <line>UnknownHandle = Indicates that freeTextSearchHandle is unknown.</line> + <line>InvalidRequestId = Indicates the request failed becuase of invalid request ID.</line> + </doc> + </arg> + </method> + <method name="ftsCancel"> + <doc> + <line>ftsCancel = Cancel an FTS session.</line> + </doc> + <arg direction="in" name="freeTextSearchHandle" type="u"> + <doc> + <line>freeTextSearchHandle Handle - Handle to identify the Free Text Search session to be cancelled.</line> + </doc> + </arg> + <arg direction="out" name="error" type="i"> + <doc> + <line>OK = Indicates no error.</line> + <line>UnknownHandle = Indicates that freeTextSearchHandle is unknown.</line> + </doc> + </arg> + </method> + <method name="deleteLocationHandles"> + <doc> + <line>deleteLocationHandles = Release handle(s) if they are not used anymore.</line> + </doc> + <arg direction="in" name="locationHandleList" type="au"> + <doc> + <line>locationHandleList LocationHandleList - list of handles to release.</line> + <line>LocationHandleList array[LocationHandle] - A list of LocationHandles. maximum length = 4096.</line> + <line>LocationHandle UInt32 - Handle to a location. Range[0:0xffffffff].</line> + </doc> + </arg> + </method> + <method name="subscribeForftsDoneSelective"> + <arg direction="out" name="status" type="b"> + </arg> + </method> + <method name="unsubscribeFromftsDoneSelective"> + </method> + <signal name="ftsDone"> + <doc> + <line>ftsDone = Response indicating that the search is done.</line> + </doc> + <arg direction="out" name="responseId" type="n"> + <doc> + <line>responseId RequestId - Identifier to match this response with a request.</line> + </doc> + </arg> + <arg direction="out" name="ftsStatus" type="i"> + <doc> + <line>ftsStatus FtsStatus - Status of the search request.</line> + <line>FtsStatus enum[OK, ABORTED, PREFIX_TOO_SHORT, NO_SEARCH_TO_CONTINUE, INTERNAL_ERROR, INDEX_MISSING, BAD_VERSION,</line> + <line>INVALID_PARAMETER_SEARCH_HANDLE, INVALID_PARAMETER_QUERY, INVALID_PARAMETER_SEARCH_LOCATION,</line> + <line>INVALID_PARAMETER_PAGE_SIZE, INVALID_PARAMETER_SEARCH_OPTIONS, INVALID_PARAMETER_SEARCH_CONDITIONS,</line> + <line>INVALID_PARAMETER_SEARCH_SHAPES, INVALID_PARAMETER_FUZZY_LEVEL, INVALID_COORDINATES_INPUT]</line> + </doc> + </arg> + </signal> + <method name="subscribeForftsResultAddressesSelective"> + <arg direction="out" name="status" type="b"> + </arg> + </method> + <method name="unsubscribeFromftsResultAddressesSelective"> + </method> + <signal name="ftsResultAddresses"> + <doc> + <line>ftsResultAddresses = Response with address results.</line> + </doc> + <arg direction="out" name="responseId" type="n"> + <doc> + <line>responseId RequestId - Identifier to match this response with a request.</line> + </doc> + </arg> + <arg direction="out" name="addresses" type="a(ussasass(yv)(dd)iqb)"> + <doc> + <line>addresses Addresses - Matching addresses.</line> + <line>The order of the addresses is the order of matching relevance.</line> + <line>The first address is a better match than the last result.</line> + <line>Addresses array[Address] - A list of addresses. maximum length = 500.</line> + <line>Address struct[locationHandle, countryCode, stateCode, places, postalCodes,</line> + <line>mapCode, addressDetails, coordinate, distance, score, fuzzyMatch] - Address information.</line> + <line>Address.locationHandle LocationHandle - </line> + <line>Address.countryCode FtsString - </line> + <line>Address.stateCode FtsString - </line> + <line>Address.places FtsStringList - There can be multiple place names.</line> + <line>Address.postalCodes FtsStringList - There can be multiple postal codes assigned to a street.</line> + <line>Address.mapCode FtsString - Mapcode of the coordinate.</line> + <line>A mapcode represents a location. Every location on Earth can be represented by a mapcode.</line> + <line>Mapcodes were designed to be short, easy to recognize, remember and communicate.</line> + <line>They are precise to a few meters. For details see http://www.mapcode.com.</line> + <line>Address.addressDetails AddressDetails - </line> + <line>Address.coordinate Coordinate2D - </line> + <line>Address.distance DistanceInMeters - Distance in meters from the search location. -1 if no search location is given.</line> + <line>Address.score Score - A higher score means a better match.</line> + <line>Address.fuzzyMatch Boolean - Indicates whether this match is fuzzy, i.e. it was matched with misspellings.</line> + <line>FtsStringList array(FtsString) - A list of strings. maximum length = 100</line> + <line>AddressDetails union[streetDetails, placeDetails, mapCodeDetails, politicalDivisionDetails, coordinatesDetails] - A union to contain any of the specific types of address details.</line> + <line>AddressDetails.streetDetails StreetDetails - </line> + <line>AddressDetails.placeDetails PlaceDetails - </line> + <line>AddressDetails.mapCodeDetails MapCodeDetails - </line> + <line>AddressDetails.politicalDivisionDetails PoliticalDivisionDetails - </line> + <line>AddressDetails.coordinatesDetails CoordinatesDetails - </line> + <line>StreetDetails struct[streetName, houseNumber, houseNumberFromInput] - If a user entered a non-existing house number then the closest existing</line> + <line>number is returned. The houseNumberFromInput will contain the house</line> + <line>number from the user input, the houseNumber will contain closest house number.</line> + <line>If the map does not contain house numbers for the street, but the user</line> + <line>input seems to have a house number, then houseNumber will be empty and</line> + <line>houseNumberFromInput will contain the number from the input.</line> + <line>StreetDetails.streetName FtsString - </line> + <line>StreetDetails.houseNumber FtsString - If a user entered a non-existing house number then the closest existing</line> + <line>number is returned. The houseNumberFromInput will contain the house</line> + <line>number from the user input, the houseNumber will contain closest house number.</line> + <line>If the map does not contain house numbers for the street, but the user</line> + <line>input seems to have a house number, then houseNumber will be empty and</line> + <line>houseNumberFromInput will contain the number from the input.</line> + <line>StreetDetails.houseNumberFromInput FtsString - The house number that the search engine recognized in the user input. Can be empty.</line> + <line>PlaceDetails struct[placeType, placeName, placeBoundingBox] - Place details.</line> + <line>PlaceDetails.placeType enum[OTHER, SETTLEMENT]- </line> + <line>PlaceDetails.placeName FtsString</line> + <line>PlaceDetails.placeBoundingBox Rectangle - The bounding box of this place (an estimate).</line> + <line>MapCodeDetails struct[closestStreetName]- Mapcode details.</line> + <line>MapCodeDetails.closestStreetName FtsString - If the location of the mapcode is close to a street, this field</line> + <line>contains the name of that street, otherwise this field is left empty.</line> + <line>PoliticalDivisionDetails struct[boundingBox]- Political division details (country or state). </line> + <line>PoliticalDivisionDetails.boundingBox Rectangle - The bounding box of the political division. </line> + <line>CoordinatesDetails - struct[closestStreetName] - Geographic coordinate pair details.</line> + <line>CoordinatesDetails.closestStreetName FtsString - This field contains the name of the street that is closest</line> + <line>to the coordinates, as long as the straight line distance to</line> + <line>the closest street location is less than 25 meters.</line> + <line>Score UInt16 - A higher score means a better match. Range[0:0xffff]</line> + </doc> + </arg> + <arg direction="out" name="moreAvailable" type="b"> + <doc> + <line>moreAvailable Boolean - Flag to indicate if more addresses might be available in a next page.</line> + </doc> + </arg> + </signal> + <method name="subscribeForftsResultPoisSelective"> + <arg direction="out" name="status" type="b"> + </arg> + </method> + <method name="unsubscribeFromftsResultPoisSelective"> + </method> + <signal name="ftsResultPois"> + <doc> + <line>ftsResultPois = Response with POI results.</line> + </doc> + <arg direction="out" name="responseId" type="n"> + <doc> + <line>responseId RequestId - Identifier to match this response with a request.</line> + </doc> + </arg> + <arg direction="out" name="pois" type="a(uuasssasasssss(dd)iqb)"> + <doc> + <line>pois POIs - Matching POIs.</line> + <line>The order of the POIs is the order of matching relevance.</line> + <line>The first POI is a better match than the last result.</line> + <line>POIs = array[POI]. A list of POIs. maximum length = 500</line> + <line>POI struct[locationHandle, categoryCode, brandNames, poiName, address, place, postalCode, mapCode, countryCode, stateCode,</line> + <line>telephone, coordinate, distance, score, fuzzyMatch, hasParents, hasChildren, detourDistance, detourTime] = POI information.</line> + <line>POI.locationHandle LocationHandle - </line> + <line>POI.categoryCode POICategoryCode - </line> + <line>POI.brandNames FtsStringList - </line> + <line>POI.poiName FtsString - </line> + <line>POI.address FtsString - </line> + <line>POI.place FtsStringList - </line> + <line>POI.postalCode FtsStringList - </line> + <line>POI.mapCode FtsString - </line> + <line>POI.countryCode FtsString - </line> + <line>POI.stateCode FtsString - </line> + <line>POI.telephone FtsString - </line> + <line>POI.coordinate Coordinate2D - </line> + <line>POI.distance DistanceInMeters - Distance in meters from the search location. -1 if no search location is given.</line> + <line>POI.score Score - A higher score means a better match.</line> + <line>POI.fuzzyMatch Boolean - Indicates whether this match is fuzzy, i.e. it was matched with misspellings.</line> + <line>POI.hasParents Boolean - Indicates that POI has parents.</line> + <line>POI.hasChildren Boolean - Indicates that POI has children.</line> + <line>POI.detourDistance DistanceInMeters - For searches along route, this value is the the detour distance,</line> + <line>in meters, expresses how much longer the total route will be if the POI is visited.</line> + <line>The detour distance will be -1 for all searches that don’t use a route corridor (searches in all map, in circle or rectangle)</line> + <line>POI.detourTime Int32 - For searches along route, this value is the detour time, in seconds, </line> + <line>expresses what’s the delay at the destination if the POI is visited. </line> + <line>The detour time will be -1 for all searches that don’t use a route corridor (searches in all map, in circle or rectangle)</line> + <line>POICategoryCode UInt32 - Numerical POI category code. Range[0:0xffffffff].</line> + </doc> + </arg> + <arg direction="out" name="moreAvailable" type="b"> + <doc> + <line>moreAvailable Boolean - Flag to indicate if more POIs might be available in a next page.</line> + </doc> + </arg> + </signal> + <method name="subscribeForftsResultPoiSuggestionsSelective"> + <arg direction="out" name="status" type="b"> + </arg> + </method> + <method name="unsubscribeFromftsResultPoiSuggestionsSelective"> + </method> + <signal name="ftsResultPoiSuggestions"> + <doc> + <line>ftsResultPoiSuggestions = Response with POI category suggestions.</line> + </doc> + <arg direction="out" name="responseId" type="n"> + <doc> + <line>responseId RequestId - Identifier to match this response with a request.</line> + </doc> + </arg> + <arg direction="out" name="poiCategories" type="a(usssa(ussasass(yv)(dd)iqb)q)"> + <doc> + <line>poiCategories POICategories - POI category suggestions.</line> + <line>POICategories array[POICategory] - A list of POI categories. maximum length = 500.</line> + <line>POICategory struct[categoryCode, categoryName, matchedName, searchTextSuggestion, nearAddressSuggestions, score] - Data type for POI category suggestions.</line> + <line>POICategory.categoryCode POICategoryCode - </line> + <line>POICategory.categoryName FtsString - </line> + <line>POICategory.matchedName FtsString - The search engine recognizes synonyms and names associated with a POI category.</line> + <line>If a match on such a name is found, then this attribute is set to that name.</line> + <line>POICategory.searchTextSuggestion FtsString - Text that can be used for a suggestion like: "<categoryName> <searchTextSuggestion>"</line> + <line>Typically this contains the original query text, where the recognized category name or synonym has been removed.</line> + <line>POICategory.nearAddressSuggestions Addresses - A list of addresses that can be used for suggestions like: "<categoryName> near <address>"</line> + <line>Note the addresses in this list do not have a valid location handle as the address is only needed to be displayed as a suggestion.</line> + <line>The coordinates of an address can be used for a POI window query if the user picks a suggestion.</line> + <line>POICategory.score Score - A higher score means a better match.</line> + </doc> + </arg> + </signal> + </interface> +</node> diff --git a/src/navigation/map-viewer/mapviewercontrol-plugin/genivi_mapviewer_mapviewercontrol.cxx b/src/navigation/map-viewer/mapviewercontrol-plugin/genivi_mapviewer_mapviewercontrol.cxx index e7db76f..b1c2f76 100644 --- a/src/navigation/map-viewer/mapviewercontrol-plugin/genivi_mapviewer_mapviewercontrol.cxx +++ b/src/navigation/map-viewer/mapviewercontrol-plugin/genivi_mapviewer_mapviewercontrol.cxx @@ -32,9 +32,10 @@ #include <ilm/ilm_client.h> #include <ilm/ilm_client.h> #include <ilm/ilm_control.h> -#ifndef FSA_LAYER -#define FSA_LAYER 600 -#define HMI_LAYER 700 +//Align with Qt Surfaces = 8000 + Layer. +#ifndef FSA_SURFACE +#define SURFACE_OFFSET 8000 +#define FSA_SURFACE SURFACE_OFFSET + getpid() #endif #endif @@ -1432,24 +1433,49 @@ static void callbackFunction(ilmObjectType object, t_ilm_uint surfaceId, t_ilm_b (void)user_data; struct ilmSurfaceProperties sp; + t_ilm_int pLength = 0; + t_ilm_layer* ppArray = NULL; + struct ilmSurfaceProperties pSurfaceProperties; + t_ilm_layer renderOrder[2]; + if (object == ILM_SURFACE) { if (created) { - //m_handle not propageted here but it is m_handle=1. - if (surfaceId == FSA_LAYER+1) { + if (surfaceId == FSA_SURFACE) { //Configure map surface if (ilm_getPropertiesOfSurface(surfaceId, &sp) != ILM_SUCCESS) { dbg(lvl_error,"error on ilm_getPropertiesOfSurface\n"); } - if (ilm_layerAddSurface(FSA_LAYER, surfaceId) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_layerAddSurface\n"); - } - if (ilm_surfaceSetSourceRectangle(surfaceId, 0, 0, sp.origSourceWidth, sp.origSourceHeight) != ILM_SUCCESS) { dbg(lvl_error,"error on ilm_surfaceSetSourceRectangle\n"); } - if (ilm_surfaceSetDestinationRectangle(surfaceId, 0, 0, sp.origSourceWidth, sp.origSourceHeight) != ILM_SUCCESS) { + //RenderOrder with the hmi-launcher Qt surface + /* + * ilm_getLayerIDsOnScreen will give the layer attached + * to the hmi-launcher Qt surface following hmi-launcher Qt surface + */ + if (ilm_getLayerIDsOnScreen(0, &pLength, &ppArray) != ILM_SUCCESS) { + dbg(lvl_error, "error on ilm_getLayerIDsOnScreen\n"); + } + + /* The last one is the hmi-launcher layer and thus surface. + * Then hmi-launcher surface toped the map surface into the hmi-launcher layer. + */ + renderOrder[1] = SURFACE_OFFSET + ppArray[pLength - 1]; + renderOrder[0] = FSA_SURFACE; + + if (ilm_layerSetRenderOrder(ppArray[pLength - 1],renderOrder,2) != ILM_SUCCESS) { + dbg(lvl_error,"error on ilm_layerSetRenderOrder\n"); + } + + //Put the map at the same resolution as the hmi-launcher + if (ilm_getPropertiesOfSurface(SURFACE_OFFSET + ppArray[pLength - 1], &pSurfaceProperties) != ILM_SUCCESS) { + dbg(lvl_error,"error on ilm_getPropertiesOfSurface\n"); + } + + if (ilm_surfaceSetDestinationRectangle(surfaceId, pSurfaceProperties.destX, pSurfaceProperties.destY, + pSurfaceProperties.destWidth, pSurfaceProperties.destHeight) != ILM_SUCCESS) { dbg(lvl_error,"error on ilm_surfaceSetDestinationRectangle\n"); } @@ -1537,6 +1563,7 @@ MapViewerControlObj::MapViewerControlObj(MapViewerControl *mapviewercontrol, uin navit_init(m_navit.u.navit); graphics_get_data(m_graphics.u.graphics,"window"); + struct transformation *trans=navit_get_trans(m_navit.u.navit); struct map_selection sel; memset(&sel, 0, sizeof(sel)); @@ -1552,29 +1579,7 @@ MapViewerControlObj::MapViewerControlObj(MapViewerControl *mapviewercontrol, uin } t_ilm_nativehandle nativehandle=(t_ilm_nativehandle)graphics_get_data(m_graphics.u.graphics,"xwindow_id"); - t_ilm_surface surfaceId=FSA_LAYER+m_handle; - t_ilm_layer layerId=FSA_LAYER; - - //Configure Screen for FSA - t_ilm_layer renderOrder[1]; - renderOrder[0] = FSA_LAYER; - renderOrder[1] = HMI_LAYER; - if (ilm_displaySetRenderOrder(0,renderOrder,2) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_displaySetRenderOrder\n"); - } - - //Configure the FSA layer dimensions & visibility - if (ilm_layerSetSourceRectangle(layerId, 0, 0, MapViewSize._1, MapViewSize._2) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_layerSetSourceRectangle\n"); - } - - if (ilm_layerSetDestinationRectangle(layerId, 0, 0, MapViewSize._1, MapViewSize._2) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_layerSetDestinationRectangle\n"); - } - - if (ilm_layerSetVisibility(layerId, ILM_TRUE) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_layerSetVisibility\n"); - } + t_ilm_surface surfaceId=FSA_SURFACE; //Register Notification if (ilm_registerNotification(callbackFunction, NULL) != ILM_SUCCESS) { @@ -1597,14 +1602,12 @@ MapViewerControlObj::MapViewerControlObj(MapViewerControl *mapviewercontrol, uin MapViewerControlObj::~MapViewerControlObj() { #if LM - t_ilm_surface surfaceId=FSA_LAYER+m_handle; - t_ilm_layer layerId=FSA_LAYER; + t_ilm_surface surfaceId=FSA_SURFACE; + if (ilm_surfaceRemove(surfaceId) != ILM_SUCCESS) { dbg(lvl_error,"error on ilm_surfaceRemove\n"); } - if (ilm_layerRemoveSurface(layerId, surfaceId) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_layerAddSurface\n"); - } + if (ilm_commitChanges() != ILM_SUCCESS) { dbg(lvl_error,"error on ilm_commitChanges\n"); } diff --git a/src/navigation/map-viewer/mapviewercontrol-server-plugin/genivi_mapviewer_mapviewercontrol.cxx b/src/navigation/map-viewer/mapviewercontrol-server-plugin/genivi_mapviewer_mapviewercontrol.cxx index e538be1..62a7b0f 100644 --- a/src/navigation/map-viewer/mapviewercontrol-server-plugin/genivi_mapviewer_mapviewercontrol.cxx +++ b/src/navigation/map-viewer/mapviewercontrol-server-plugin/genivi_mapviewer_mapviewercontrol.cxx @@ -31,9 +31,10 @@ #include <ilm/ilm_client.h> #include <ilm/ilm_client.h> #include <ilm/ilm_control.h> -#ifndef FSA_LAYER -#define FSA_LAYER 600 -#define HMI_LAYER 700 +//Align with Qt Surfaces = 8000 + Layer. +#ifndef FSA_SURFACE +#define SURFACE_OFFSET 8000 +#define FSA_SURFACE SURFACE_OFFSET + getpid() #endif #endif @@ -1582,24 +1583,49 @@ static void callbackFunction(ilmObjectType object, t_ilm_uint surfaceId, t_ilm_b (void)user_data; struct ilmSurfaceProperties sp; + t_ilm_int pLength = 0; + t_ilm_layer* ppArray = NULL; + struct ilmSurfaceProperties pSurfaceProperties; + t_ilm_layer renderOrder[2]; + if (object == ILM_SURFACE) { if (created) { - //m_handle not propageted here but it is m_handle=1. - if (surfaceId == FSA_LAYER+1) { + if (surfaceId == FSA_SURFACE) { //Configure map surface if (ilm_getPropertiesOfSurface(surfaceId, &sp) != ILM_SUCCESS) { dbg(lvl_error,"error on ilm_getPropertiesOfSurface\n"); } - if (ilm_layerAddSurface(FSA_LAYER, surfaceId) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_layerAddSurface\n"); - } - if (ilm_surfaceSetSourceRectangle(surfaceId, 0, 0, sp.origSourceWidth, sp.origSourceHeight) != ILM_SUCCESS) { dbg(lvl_error,"error on ilm_surfaceSetSourceRectangle\n"); } - if (ilm_surfaceSetDestinationRectangle(surfaceId, 0, 0, sp.origSourceWidth, sp.origSourceHeight) != ILM_SUCCESS) { + //RenderOrder with the hmi-launcher Qt surface + /* + * ilm_getLayerIDsOnScreen will give the layer attached + * to the hmi-launcher Qt surface following hmi-launcher Qt surface + */ + if (ilm_getLayerIDsOnScreen(0, &pLength, &ppArray) != ILM_SUCCESS) { + dbg(lvl_error, "error on ilm_getLayerIDsOnScreen\n"); + } + + /* The last one is the hmi-launcher layer and thus surface. + * Then hmi-launcher surface toped the map surface into the hmi-launcher layer. + */ + renderOrder[1] = SURFACE_OFFSET + ppArray[pLength - 1]; + renderOrder[0] = FSA_SURFACE; + + if (ilm_layerSetRenderOrder(ppArray[pLength - 1],renderOrder,2) != ILM_SUCCESS) { + dbg(lvl_error,"error on ilm_layerSetRenderOrder\n"); + } + + //Put the map at the same resolution as the hmi-launcher + if (ilm_getPropertiesOfSurface(SURFACE_OFFSET + ppArray[pLength - 1], &pSurfaceProperties) != ILM_SUCCESS) { + dbg(lvl_error,"error on ilm_getPropertiesOfSurface\n"); + } + + if (ilm_surfaceSetDestinationRectangle(surfaceId, pSurfaceProperties.destX, pSurfaceProperties.destY, + pSurfaceProperties.destWidth, pSurfaceProperties.destHeight) != ILM_SUCCESS) { dbg(lvl_error,"error on ilm_surfaceSetDestinationRectangle\n"); } @@ -1709,29 +1735,7 @@ MapViewerControlObj::MapViewerControlObj(MapViewerControlServerStub *mapviewerco } t_ilm_nativehandle nativehandle=(t_ilm_nativehandle)graphics_get_data(m_graphics.u.graphics,"xwindow_id"); - t_ilm_surface surfaceId=FSA_LAYER+m_handle; - t_ilm_layer layerId=FSA_LAYER; - - //Configure Screen for FSA - t_ilm_layer renderOrder[1]; - renderOrder[0] = FSA_LAYER; - renderOrder[1] = HMI_LAYER; - if (ilm_displaySetRenderOrder(0,renderOrder,2) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_displaySetRenderOrder\n"); - } - - //Configure the FSA layer dimensions & visibility - if (ilm_layerSetSourceRectangle(layerId, 0, 0, MapViewSize._1, MapViewSize._2) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_layerSetSourceRectangle\n"); - } - - if (ilm_layerSetDestinationRectangle(layerId, 0, 0, MapViewSize._1, MapViewSize._2) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_layerSetDestinationRectangle\n"); - } - - if (ilm_layerSetVisibility(layerId, ILM_TRUE) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_layerSetVisibility\n"); - } + t_ilm_surface surfaceId=FSA_SURFACE; //Register Notification if (ilm_registerNotification(callbackFunction, NULL) != ILM_SUCCESS) { @@ -1754,14 +1758,12 @@ MapViewerControlObj::MapViewerControlObj(MapViewerControlServerStub *mapviewerco MapViewerControlObj::~MapViewerControlObj() { #if LM - t_ilm_surface surfaceId=FSA_LAYER+m_handle; - t_ilm_layer layerId=FSA_LAYER; + t_ilm_surface surfaceId=FSA_SURFACE; + if (ilm_surfaceRemove(surfaceId) != ILM_SUCCESS) { dbg(lvl_error,"error on ilm_surfaceRemove\n"); } - if (ilm_layerRemoveSurface(layerId, surfaceId) != ILM_SUCCESS) { - dbg(lvl_error,"error on ilm_layerAddSurface\n"); - } + if (ilm_commitChanges() != ILM_SUCCESS) { dbg(lvl_error,"error on ilm_commitChanges\n"); } diff --git a/src/speech/CMakeLists.txt b/src/speech/CMakeLists.txt index 5e092ba..f8d73ab 100644 --- a/src/speech/CMakeLists.txt +++ b/src/speech/CMakeLists.txt @@ -40,8 +40,8 @@ endif() # Packages find_package(PkgConfig REQUIRED) -find_package(CommonAPI 3.1.5 REQUIRED) -find_package(CommonAPI-DBus 3.1.5 REQUIRED) +find_package(CommonAPI) +find_package(CommonAPI) #pkg_check_modules(DBUS "dbus-1 >= 1.8.4") // #to be fixed, it doesn't work so the paths are set manually (see above) pkg_check_modules(COMMONAPI "CommonAPI >= 3.1.5") diff --git a/src/speech/README.md b/src/speech/README.md new file mode 100644 index 0000000..4d64503 --- /dev/null +++ b/src/speech/README.md @@ -0,0 +1,45 @@ +# Speech Output Service middleware: CommonAPI based POC + +## Synopsis +This folder contains the server part of the proof of concepts (POC) for the Speech Output Service interfaces, based on CommonAPI + +##Tested targets +Desktop: Tested under Ubuntu 16.04 LTS 64 bits + +## Prerequisites +You need CommonAPI 3.1.9 and Franca 0.9.1 installed +For the Ubuntu 64 bits, due to the use of symbol versioning LIBDBUS_1_0 by CommonAPI-DBus, the patched version of DBus has to be >= 1.10.0 +NB: In case you migrate from 3.1.5 to 3.1.9, due to a cmake issue (wrong management of micro version), it's necessary to do: +``` +sudo mv /usr/local/lib/cmake/CommonAPI-3.1.5 /usr/local/lib/cmake/oldCommonAPI-3.1.5 +``` +Symbolic links are also not well managed, so you need to fix it: +``` +sudo ln -sfn /usr/local/lib/libCommonAPI.so.3.1.9 /usr/local/lib/libCommonAPI.so.3 +sudo ln -sfn /usr/local/lib/libCommonAPI-DBus.so.3.1.9 /usr/local/lib/libCommonAPI-DBus.so.3 +``` + +NB: the patch common-api-dbus-runtime/src/dbus-patches/capi-dbus-add-support-for-custom-marshalling.patch may fail a little bit, in that case it's needed to update the dbus/dbus-string.h manually + +## How to build +First it's required to set some paths: +``` +export DBUS_LIB_PATH=<path to the patched version of the DBus lib> +export COMMONAPI_DBUS_TOOL_DIR=<path to the common-api-dbus-tools folder> +export COMMONAPI_TOOL_DIR=<path to the common-api-tools folder> +``` +A script allows either: +to clean and rebuild all (including invoking cmake) +```./build.sh -c``` +or to build updated parts +```./build.sh``` + +## How To Run +```./run.sh &``` + +## How To Test +```./test-speech-capi.py``` + +## License + +Mozilla Public License Version 2.0 diff --git a/src/speech/build.sh b/src/speech/build.sh new file mode 100755 index 0000000..0533402 --- /dev/null +++ b/src/speech/build.sh @@ -0,0 +1,69 @@ +#!/bin/bash + +commonapi_tools_option="" +clean=0 + +while getopts cdh opt +do + case $opt in + c) + clean=1 + ;; + d) + debug="ON" + ;; + h) + echo "Usage:" + echo "$0 [-cd]" + echo "-c: Rebuild with clean" + echo "-d: Enable the debug messages" + exit 1 + esac +done +set -e + +if [ ! $COMMONAPI_TOOL_DIR ] +then + echo 'Set the dir of the common api tools' + echo 'export COMMONAPI_TOOL_DIR=<path>' + exit 1 +fi + +if [ ! $COMMONAPI_DBUS_TOOL_DIR ] +then + echo 'Set the dir of the common api dbus tools' + echo 'export COMMONAPI_DBUS_TOOL_DIR=<path>' + exit 1 +fi + +if [ ! $DBUS_LIB_PATH ] +then + echo 'Set the dir of the patched dbus' + echo 'export DBUS_LIB_PATH=<path>' + exit 1 +fi + +commonapi_tools_option="-DDBUS_LIB_PATH="$DBUS_LIB_PATH" -DCOMMONAPI_DBUS_TOOL_DIR="$COMMONAPI_DBUS_TOOL_DIR" -DCOMMONAPI_TOOL_DIR="$COMMONAPI_TOOL_DIR + + +if [ "$clean" = 1 ] +then + echo 'clean up the build folder' + if [ -d "./build" ] + then + find ./build ! -name '*.cbp' -type f -exec rm -f {} + + fi +fi + + +mkdir -p build +cd build + +echo 'build speech-output-server' +if [ "$clean" = 1 ] +then + cmake $commonapi_tools_option -DWITH_DEBUG=$debug ../ +fi +make + + diff --git a/src/speech/main.cpp b/src/speech/main.cpp index bddada8..261cd5a 100644 --- a/src/speech/main.cpp +++ b/src/speech/main.cpp @@ -2,13 +2,15 @@ * @licence app begin@ * SPDX-License-Identifier: MPL-2.0 * -* \copyright Copyright (C) 2013-2014, PCA Peugeot Citroen +* \copyright Copyright (C) 2013-2017, PCA Peugeot Citroen * * \file main.cpp * * \brief This file is part of the speech proof of concept. * * \author Philippe Colliot <philippe.colliot@mpsa.com> +* \brief Some parts of the code has been inspired by the following people: +* \brief Mario Thielert, David Kämpf, Dominique Massonie * * \version 1.1 * @@ -97,6 +99,22 @@ static std::string m_chunkBuffer; /** max size = MAX_CHUNK_SIZE*MAX_SLOT_COUNT * int last, cst_audio_streaming_info_struct *asi) { printf("\n>>> [server] fliteCallback()\n"); + printf("start: %d size: %d last: %d \n",start,size,last); + static cst_audiodev *ad = 0; + + if (start == 0) + ad = audio_open(w->sample_rate,w->num_channels,CST_AUDIO_LINEAR16); + + audio_write(ad,&w->samples[start],size*sizeof(short)); + + if (last == 1) + { + audio_close(ad); + ad = NULL; + } + + /* if you want to stop return CST_AUDIO_STREAM_STOP */ + return CST_AUDIO_STREAM_CONT; } class SpeechOutputServerStub @@ -117,11 +135,11 @@ public: flite_init(); mp_voice = register_cmu_us_kal(NULL); -/* mp_asi = new_audio_streaming_info(); + mp_asi = new_audio_streaming_info(); mp_asi->asc = fliteCallback; feat_set(mp_voice->features,"streaming_info",audio_streaming_info_val(mp_asi)); -*/ + } ~SpeechOutputServerStub() { diff --git a/src/speech/run.sh b/src/speech/run.sh new file mode 100755 index 0000000..6a6126d --- /dev/null +++ b/src/speech/run.sh @@ -0,0 +1,3 @@ +#!/bin/bash +./bin/speech-output-server + diff --git a/src/speech/test-speech-capi.py b/src/speech/test-speech-capi.py index 3ed92e1..7fc4bb0 100755 --- a/src/speech/test-speech-capi.py +++ b/src/speech/test-speech-capi.py @@ -33,9 +33,6 @@ import time import pdb; #pdb.set_trace() #constants as defined in the Navigation API -GENIVI_Configuration_Settings_LOCALE = 37 -GENIVI_SearchStatusState_FINISHED = 1298 -GENIVI_SearchStatusState_NOT_STARTED = 1296 #constants used into the script TIME_OUT = 10000 @@ -65,20 +62,20 @@ if __name__ == '__main__': bus = dbus.SessionBus() bus.add_signal_receiver(catch_speech_notifyConnectionStatus_signal_handler, \ - dbus_interface = "org.genivi.hmi.speechoutputservice.SpeechOutput", \ + dbus_interface = "org.genivi.hmi.speechoutputservice.SpeechOutput.v4_0", \ signal_name = "notifyConnectionStatus") bus.add_signal_receiver(catch_speech_notifyMarkerReached_signal_handler, \ - dbus_interface = "org.genivi.hmi.speechoutputservice.SpeechOutput", \ + dbus_interface = "org.genivi.hmi.speechoutputservice.SpeechOutput.v4_0", \ signal_name = "notifyMarkerReached") bus.add_signal_receiver(catch_speech_notifyQueueStatus_signal_handler, \ - dbus_interface = "org.genivi.hmi.speechoutputservice.SpeechOutput", \ + dbus_interface = "org.genivi.hmi.speechoutputservice.SpeechOutput.v4_0", \ signal_name = "notifyQueueStatus") bus.add_signal_receiver(catch_speech_notifyTTSStatus_signal_handler, \ - dbus_interface = "org.genivi.hmi.speechoutputservice.SpeechOutput", \ + dbus_interface = "org.genivi.hmi.speechoutputservice.SpeechOutput.v4_0", \ signal_name = "notifyTTSStatus") -speech = bus.get_object('org.genivi.hmi.speechoutputservice.SpeechOutput_SpeechOutput','/SpeechOutput') -g_speech_interface = dbus.Interface(speech, dbus_interface='org.genivi.hmi.speechoutputservice.SpeechOutput') +speech = bus.get_object('org.genivi.hmi.speechoutputservice.SpeechOutput.v4_0_SpeechOutput','/SpeechOutput') +g_speech_interface = dbus.Interface(speech, dbus_interface='org.genivi.hmi.speechoutputservice.SpeechOutput.v4_0') g_speech_interface.addTextChunk(dbus.String("Hello")) diff --git a/test/navigation/src/.gitignore b/test/navigation/src/.gitignore deleted file mode 100644 index 65b0628..0000000 --- a/test/navigation/src/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/bustle |