blob: a4c7d8899b8328a46acc24ae829caa73bb961891 [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CC_RASTER_TILE_TASK_RUNNER_H_
#define CC_RASTER_TILE_TASK_RUNNER_H_
#include <bitset>
#include <vector>
#include "base/callback.h"
#include "cc/raster/task_graph_runner.h"
#include "cc/resources/resource_format.h"
namespace cc {
class ImageDecodeTask;
class RasterTask;
class Resource;
class RasterBuffer;
class CC_EXPORT TileTaskClient {
public:
virtual scoped_ptr<RasterBuffer> AcquireBufferForRaster(
const Resource* resource,
uint64_t resource_content_id,
uint64_t previous_content_id) = 0;
virtual void ReleaseBufferForRaster(scoped_ptr<RasterBuffer> buffer) = 0;
protected:
virtual ~TileTaskClient() {}
};
class CC_EXPORT TileTask : public Task {
public:
typedef std::vector<scoped_refptr<TileTask>> Vector;
virtual void ScheduleOnOriginThread(TileTaskClient* client) = 0;
virtual void CompleteOnOriginThread(TileTaskClient* client) = 0;
virtual void RunReplyOnOriginThread() = 0;
// Type-checking downcast routines.
virtual ImageDecodeTask* AsImageDecodeTask();
virtual RasterTask* AsRasterTask();
void WillSchedule();
void DidSchedule();
bool HasBeenScheduled() const;
void WillComplete();
void DidComplete();
bool HasCompleted() const;
protected:
TileTask();
~TileTask() override;
bool did_schedule_;
bool did_complete_;
};
class CC_EXPORT ImageDecodeTask : public TileTask {
public:
typedef std::vector<scoped_refptr<ImageDecodeTask>> Vector;
// Overridden from TileTask:
ImageDecodeTask* AsImageDecodeTask() override;
protected:
ImageDecodeTask();
~ImageDecodeTask() override;
};
class CC_EXPORT RasterTask : public TileTask {
public:
typedef std::vector<scoped_refptr<RasterTask>> Vector;
// Overridden from TileTask:
RasterTask* AsRasterTask() override;
const Resource* resource() const { return resource_; }
const ImageDecodeTask::Vector& dependencies() const { return dependencies_; }
protected:
RasterTask(const Resource* resource, ImageDecodeTask::Vector* dependencies);
~RasterTask() override;
private:
const Resource* resource_;
ImageDecodeTask::Vector dependencies_;
};
// kNumberOfTaskSets must be greater or equal to the number of values in
// TileManager::NamedTaskSet.
// TODO(reveman): Use template specialization to make it easy for client code to
// check at compile time that the number of supported task sets is correct.
static const size_t kNumberOfTaskSets = 3;
typedef size_t TaskSet;
typedef std::bitset<kNumberOfTaskSets> TaskSetCollection;
class CC_EXPORT TileTaskRunnerClient {
public:
virtual void DidFinishRunningTileTasks(TaskSet task_set) = 0;
virtual TaskSetCollection TasksThatShouldBeForcedToComplete() const = 0;
protected:
virtual ~TileTaskRunnerClient() {}
};
struct CC_EXPORT TileTaskQueue {
struct CC_EXPORT Item {
class TaskComparator {
public:
explicit TaskComparator(const RasterTask* task) : task_(task) {}
bool operator()(const Item& item) const { return item.task == task_; }
private:
const RasterTask* task_;
};
typedef std::vector<Item> Vector;
Item(RasterTask* task, const TaskSetCollection& task_sets);
~Item();
RasterTask* task;
TaskSetCollection task_sets;
};
TileTaskQueue();
~TileTaskQueue();
void Swap(TileTaskQueue* other);
void Reset();
Item::Vector items;
};
// This interface can be used to schedule and run tile tasks. The client will
// be notified asynchronously when the set of tasks marked as "required for
// activation" have finished running, when tasks marked "required for draw"
// have finished running, and when all scheduled tasks have finished running.
// The client can call CheckForCompletedTasks() at any time to dispatch
// pending completion callbacks for all tasks that have finished running.
class CC_EXPORT TileTaskRunner {
public:
// Set the client instance to be notified when finished running tasks.
virtual void SetClient(TileTaskRunnerClient* client) = 0;
// Tells the worker pool to shutdown after canceling all previously scheduled
// tasks. Reply callbacks are still guaranteed to run when
// CheckForCompletedTasks() is called.
virtual void Shutdown() = 0;
// Schedule running of tile tasks in |queue| and all dependencies.
// Previously scheduled tasks that are not in |queue| will be canceled unless
// already running. Once scheduled, reply callbacks are guaranteed to run for
// all tasks even if they later get canceled by another call to
// ScheduleTasks().
virtual void ScheduleTasks(TileTaskQueue* queue) = 0;
// Check for completed tasks and dispatch reply callbacks.
virtual void CheckForCompletedTasks() = 0;
// Returns the format to use for the tiles.
virtual ResourceFormat GetResourceFormat() = 0;
protected:
virtual ~TileTaskRunner() {}
};
} // namespace cc
#endif // CC_RASTER_TILE_TASK_RUNNER_H_